コマンドライン引数をrakeタスクに渡す方法
-
05-07-2019 - |
質問
複数のデータベースに値を挿入する必要があるrakeタスクがあります。
この値をコマンドラインから、または別の rakeタスクからrakeタスクに渡します。
これを行うにはどうすればよいですか
解決
オプションと依存関係は配列内にある必要があります:
namespace :thing do
desc "it does a thing"
task :work, [:option, :foo, :bar] do |task, args|
puts "work", args
end
task :another, [:option, :foo, :bar] do |task, args|
puts "another #{args}"
Rake::Task["thing:work"].invoke(args[:option], args[:foo], args[:bar])
# or splat the args
# Rake::Task["thing:work"].invoke(*args)
end
end
その後
rake thing:work[1,2,3]
=> work: {:option=>"1", :foo=>"2", :bar=>"3"}
rake thing:another[1,2,3]
=> another {:option=>"1", :foo=>"2", :bar=>"3"}
=> work: {:option=>"1", :foo=>"2", :bar=>"3"}
注:変数
task
はタスクオブジェクトであり、Rakeの内部構造を知っているか気にしない限り、あまり役に立ちません。
レール注:
Railsからタスクを実行する場合、
=> [:environment]
を追加して環境をプリロードするのが最善です。これは依存タスクをセットアップする方法です。
task :work, [:option, :foo, :bar] => [:environment] do |task, args|
puts "work", args
end
他のヒント
タスク引数にシンボル引数を追加することにより、rakeで仮引数を指定できます。例:
require 'rake'
task :my_task, [:arg1, :arg2] do |t, args|
puts "Args were: #{args}"
end
task :invoke_my_task do
Rake.application.invoke_task("my_task[1, 2]")
end
# or if you prefer this syntax...
task :invoke_my_task_2 do
Rake::Task[:my_task].invoke(3, 4)
end
# a task with prerequisites passes its
# arguments to it prerequisites
task :with_prerequisite, [:arg1, :arg2] => :my_task #<- name of prerequisite task
# to specify default values,
# we take advantage of args being a Rake::TaskArguments object
task :with_defaults, :arg1, :arg2 do |t, args|
args.with_defaults(:arg1 => :default_1, :arg2 => :default_2)
puts "Args with defaults were: #{args}"
end
次に、コマンドラインから:
> rake my_task[1,2] Args were: {:arg1=>"1", :arg2=>"2"} > rake "my_task[1, 2]" Args were: {:arg1=>"1", :arg2=>"2"} > rake invoke_my_task Args were: {:arg1=>"1", :arg2=>"2"} > rake invoke_my_task_2 Args were: {:arg1=>3, :arg2=>4} > rake with_prerequisite[5,6] Args were: {:arg1=>"5", :arg2=>"6"} > rake with_defaults Args with defaults were: {:arg1=>:default_1, :arg2=>:default_2} > rake with_defaults['x','y'] Args with defaults were: {:arg1=>"x", :arg2=>"y"}
2番目の例で示したように、スペースを使用する場合は、シェルがスペースで引数を分割しないようにターゲット名を囲む引用符が必要です。
rake.rb のコードを見ると、rakeはタスク文字列を解析して前提条件の引数を抽出していないため、task :t1 => "dep[1,2]"
を実行できないようです。前提条件に異なる引数を指定する唯一の方法は、:invoke_my_task
および:invoke_my_task_2
のように、依存タスクアクション内で明示的に呼び出すことです。
一部のシェル(zshなど)では、括弧をエスケープする必要があることに注意してください:rake my_task\['arg1'\]
kchによる回答に加えて(コメントを残す方法が見つかりませんでした、申し訳ありません):
ENV
コマンドの前に変数をrake
変数として指定する必要はありません。次のような通常のコマンドラインパラメーターとして設定することができます。
rake mytask var=foo
次のようなENV変数として、rakeファイルからこれらにアクセスします。
p ENV['var'] # => "foo"
名前付き引数を渡す場合(たとえば、標準のOptionParser
を使用)、次のようなものを使用できます:
$ rake user:create -- --user test@example.com --pass 123
--
に注意してください。これは、標準のRake引数をバイパスするために必要です。 Rake 0.9.x 、 <!> lt; = 10.3.x で動作するはずです。
新しいRakeはOptionParser#parse
の解析を変更したため、たとえばparser.parse!(ARGV[2..-1])
exit
メソッドに渡されないようにする必要があります
require 'rake'
require 'optparse'
# Rake task for creating an account
namespace :user do |args|
desc 'Creates user account with given credentials: rake user:create'
# environment is required to have access to Rails models
task :create do
options = {}
OptionParser.new(args) do |opts|
opts.banner = "Usage: rake user:create [options]"
opts.on("-u", "--user {username}","User's email address", String) do |user|
options[:user] = user
end
opts.on("-p", "--pass {password}","User's password", String) do |pass|
options[:pass] = pass
end
end.parse!
puts "creating user account..."
u = Hash.new
u[:email] = options[:user]
u[:password] = options[:pass]
# with some DB layer like ActiveRecord:
# user = User.new(u); user.save!
puts "user: " + u.to_s
puts "account created."
exit 0
end
end
最後の<=>は、余分な引数がRakeタスクとして解釈されないようにします。
また、引数のショートカットが機能するはずです:
rake user:create -- -u test@example.com -p 123
rakeスクリプトがこのようになったら、これをそのまま使用できる別のツールを探すときが来たのかもしれません。
次の2つのWebサイトから回答を見つけました。 Net Maniac および Aimred 。
バージョン<!> gtが必要です。このテクニックを使用するレーキの0.8
通常のrakeタスクの説明は次のとおりです。
desc 'Task Description'
task :task_name => [:depends_on_taskA, :depends_on_taskB] do
#interesting things
end
引数を渡すには、次の3つのことを行います。
- タスク名の後にコンマで区切って引数名を追加します。
- :needs = <!> gt;を使用して、最後に依存関係を配置します。 [...]
- 場所| t、args |後。 (tはこのタスクのオブジェクトです)
スクリプト内の引数にアクセスするには、args.arg_nameを使用します
desc 'Takes arguments task'
task :task_name, :display_value, :display_times, :needs => [:depends_on_taskA, :depends_on_taskB] do |t, args|
args.display_times.to_i.times do
puts args.display_value
end
end
コマンドラインからこのタスクを呼び出すには、[] sに引数を渡します
rake task_name['Hello',4]
出力します
Hello
Hello
Hello
Hello
このタスクを別のタスクから呼び出して引数を渡したい場合は、invokeを使用します
task :caller do
puts 'In Caller'
Rake::Task[:task_name].invoke('hi',2)
end
次にコマンド
rake caller
出力します
In Caller
hi
hi
次のコードが壊れているため、依存関係の一部として引数を渡す方法が見つかりませんでした:
task :caller => :task_name['hi',2]' do
puts 'In Caller'
end
別の一般的に使用されるオプションは、環境変数を渡すことです。コードでは、ENV['VAR']
を介してそれらを読み取り、
rake
コマンドの直前に渡すことができます
$ VAR=foo rake mytask
実際、@ Nick Desjardinsは完璧に答えました。しかし、単に教育のために:あなたはダーティアプローチを使用することができます:ENV
引数を使用して
task :my_task do
myvar = ENV['myvar']
puts "myvar: #{myvar}"
end
rake my_task myvar=10
#=> myvar: 10
これを解決するまで、引数と:environmentを渡す方法がわかりませんでした:
namespace :db do
desc 'Export product data'
task :export, [:file_token, :file_path] => :environment do |t, args|
args.with_defaults(:file_token => "products", :file_path => "./lib/data/")
#do stuff [...]
end
end
そして、次のように呼び出します:
rake db:export['foo, /tmp/']
desc 'an updated version'
task :task_name, [:arg1, :arg2] => [:dependency1, :dependency2] do |t, args|
puts args[:arg1]
end
実行できるようにしたいだけです:
$ rake some:task arg1 arg2
簡単ですか? (いいえ!)
Rakeはarg1
およびarg2
をタスクとして解釈し、それらを実行しようとします。したがって、実行する前に中断します。
namespace :some do
task task: :environment do
arg1, arg2 = ARGV
# your task...
exit
end
end
大丈夫!
免責事項:かなり小さなペットプロジェクトでこれを行えるようにしたかった。 <!> quot; real world <!> quot;向けではありません。レーキタスクをチェーンする機能を失うため(つまり、rake task1 task2 task3
)。 IMOは価値がありません。 Justいrake task[arg1,arg2]
を使用してください。
rakeファイルで通常のruby引数を使用しています:
DB = ARGV[1]
次に、ファイルの下部にあるrakeタスクをスタブします(rakeはその引数名に基づいてタスクを探すためです)。
task :database_name1
task :database_name2
コマンドライン:
rake mytask db_name
これは、var = foo ENV varおよびタスクargs [blah、blah2]のソリューションよりもわかりやすいです。
スタブは少しぎくしゃくしていますが、1回限りのセットアップである環境がいくつかある場合でもそれほど悪くはありません
上記の回答では、引数を渡す方法は正しいです。ただし、引数を使用してrakeタスクを実行するには、新しいバージョンのRailsにわずかな技術が必要です
rake <!> quot; namespace:taskname ['argument1'] <!> quot;
で動作しますコマンドラインからタスクを実行する際の引用符に注意してください。
<!> quot; querystring <!> quot;が好きです。特に渡す引数がたくさんある場合は、引数を渡すための構文。
例:
rake "mytask[width=10&height=20]"
<!> quot; querystring <!> quot;存在:
width=10&height=20
警告:構文はrake "mytask[foo=bar]"
および NOT rake mytask["foo=bar"]
Rack::Utils.parse_nested_query
を使用してrakeタスク内で解析すると、Hash
:
=> {"width"=>"10", "height"=>"20"}
(クールなことは、ハッシュと配列を渡すことができるということです、詳細は下記)
これはこれを達成する方法です:
require 'rack/utils'
task :mytask, :args_expr do |t,args|
args.with_defaults(:args_expr => "width=10&height=10")
options = Rack::Utils.parse_nested_query(args[:args_expr])
end
delayed_job_active_record_threaded gemでRailsを使用している、より拡張された例を次に示します。 >
bundle exec rake "dj:start[ebooks[workers_number]=16&ebooks[worker_timeout]=60&albums[workers_number]=32&albums[worker_timeout]=120]"
上記と同じように解析され、環境に依存しています(Rails環境をロードするため)
namespace :dj do
task :start, [ :args_expr ] => :environment do |t, args|
# defaults here...
options = Rack::Utils.parse_nested_query(args[:args_expr])
end
end
options
=> {"ebooks"=>{"workers_number"=>"16", "worker_timeout"=>"60"}, "albums"=>{"workers_number"=>"32", "worker_timeout"=>"120"}}
デフォルトのタスクに引数を渡すには、次のようなことができます。たとえば、 <!> quot; version <!> quot;あなたの議論です:
task :default, [:version] => [:build]
task :build, :version do |t,args|
version = args[:version]
puts version ? "version is #{version}" : "no version passed"
end
次のように呼び出すことができます:
$ rake
no version passed
または
$ rake default[3.2.1]
version is 3.2.1
または
$ rake build[3.2.1]
version is 3.2.1
ただし、引数を渡す際にタスク名(デフォルトまたはビルド)を指定しないようにする方法は見つかりませんでした。誰かが方法を知っているなら聞いてみたいです。
上記の方法のほとんどは、私にとってはうまくいきませんでした。おそらく、新しいバージョンでは非推奨です。 最新のガイドはここにあります: http://guides.rubyonrails .org / command_line.html#custom-rake-tasks
ガイドのコピーアンドペーストansはこちらです:
task :task_name, [:arg_1] => [:pre_1, :pre_2] do |t, args|
# You can use args from here
end
このように呼び出します
bin/rake "task_name[value 1]" # entire argument string should be quoted
引数の位置が何のためにあるのかわからず、ルビ引数ハッシュのようなことをしたい場合。 1つの引数を使用して文字列を渡し、その文字列をオプションハッシュに正規表現できます。
namespace :dummy_data do
desc "Tests options hash like arguments"
task :test, [:options] => :environment do |t, args|
arg_options = args[:options] || '' # nil catch incase no options are provided
two_d_array = arg_options.scan(/\W*(\w*): (\w*)\W*/)
puts two_d_array.to_s + ' # options are regexed into a 2d array'
string_key_hash = two_d_array.to_h
puts string_key_hash.to_s + ' # options are in a hash with keys as strings'
options = two_d_array.map {|p| [p[0].to_sym, p[1]]}.to_h
puts options.to_s + ' # options are in a hash with symbols'
default_options = {users: '50', friends: '25', colour: 'red', name: 'tom'}
options = default_options.merge(options)
puts options.to_s + ' # default option values are merged into options'
end
end
そして、コマンドラインで取得します。
$ rake dummy_data:test["users: 100 friends: 50 colour: red"]
[["users", "100"], ["friends", "50"], ["colour", "red"]] # options are regexed into a 2d array
{"users"=>"100", "friends"=>"50", "colour"=>"red"} # options are in a hash with keys as strings
{:users=>"100", :friends=>"50", :colour=>"red"} # options are in a hash with symbols
{:users=>"100", :friends=>"50", :colour=>"red", :name=>"tom"} # default option values are merged into options
従来の引数スタイルでrakeタスクを実行するには:
rake task arg1 arg2
そして使用:
task :task do |_, args|
puts "This is argument 1: #{args.first}"
end
次のrake gemのパッチを追加します。
Rake::Application.class_eval do
alias origin_top_level top_level
def top_level
@top_level_tasks = [top_level_tasks.join(' ')]
origin_top_level
end
def parse_task_string(string) # :nodoc:
parts = string.split ' '
return parts.shift, parts
end
end
Rake::Task.class_eval do
def invoke(*args)
invoke_with_call_chain(args, Rake::InvocationChain::EMPTY)
end
end
パラメータを渡す間は、入力ファイルがより良いオプションです。これはjsonまたは必要なものであれば何でもかまいません。そこから、必要に応じて変数名を含むデータ構造と変数を読み取ります。 ファイルを読み取るには、次の構造を使用できます。
namespace :name_sapace_task do
desc "Description task...."
task :name_task => :environment do
data = ActiveSupport::JSON.decode(File.read(Rails.root+"public/file.json")) if defined?(data)
# and work whit yoour data, example is data["user_id"]
end
end
jsonの例
{
"name_task": "I'm a task",
"user_id": 389,
"users_assigned": [389,672,524],
"task_id": 3
}
実行
rake :name_task