web-dev-qa-db-ja.com

レーキタスクにコマンドライン引数を渡す方法

値を複数のデータベースに挿入する必要があるレーキタスクがあります。

この値をコマンドライン、または another rakeタスクからrakeタスクに渡したいのですが。

これどうやってするの？

rubycommand-linerakecommand-line-arguments
1020
Tilendor

オプションと依存関係は配列の中にある必要があります。

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からタスクを実行する場合は、 dependent tasksを設定する方法である=> [:environment]を追加して環境をプリロードするのが最善です。

  task :work, [:option, :foo, :bar] => [:environment] do |task, args|
    puts "work", args
  end
299
Blair Anderson

タスク呼び出しにシンボル引数を追加することで、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] 
引数は次のとおりです。{：arg1 => "1"、：arg2 => "2"} 
 
> rake "my_task [1、2]" 
引数は{：arg1 => "1"、：arg2 => "2"} 
 
> rake invoke_my_task 
です。 ]引数は次のとおりです。{：arg1 => "1"、：arg2 => "2"} 
 
> rake invoke_my_task_2 
引数は次のとおりです。{：arg1 => 3、： arg2 => 4} 
 
> rake with_prerequisite [5,6] 
引数は次のとおりです：{：arg1 => "5"、：arg2 => "6"} [。 [：____] 
> rake with_defaults 
デフォルトのargsは次のとおりです。{：arg1 =>：default_1、：arg2 =>：default_2} 
 
> rake with_defaults [ 'x'、 'y'] 
デフォルトの引数は{：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'\]

1101
Nick Desjardins

Kchによる回答に加えて（コメントを残す方法がわかりませんでした、申し訳ありません）。

ENVコマンドの前に変数をrake変数として指定する必要はありません。そのような通常のコマンドラインパラメータとしてそれらを設定することができます：

rake mytask var=foo

そして、以下のようなENV変数としてあなたのレーキファイルからそれらにアクセスします：

p ENV['var'] # => "foo"
310
timurb

名前付き引数を渡したい場合（例えば標準のOptionParserを使用して）、次のようなものを使用できます。

$ rake user:create -- --user [email protected] --pass 123

--に注意してください。これは標準のRake引数を迂回するために必要です。 Rake 0.9.x 、 <= 10.3.x で動作します。

新しいRakeは--の解析を変更しました、そして今、あなたはそれがOptionParser#parseメソッドに渡されないことを確かめなければなりません、例えばparser.parse!(ARGV[2..-1])で

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

最後のexitは、余分な引数がRakeタスクとして解釈されないようにします。

引数のショートカットも機能するはずです。

 rake user:create -- -u [email protected] -p 123

すくいスクリプトがこのように見えるとき、多分それは箱から出してすぐこれを可能にするだろう別のツールを探す時が来たかもしれません。

103
Tombart

私はこれら二つのウェブサイトから答えを見つけた： Net Maniac そして Aimred 。

あなたはこのテクニックを使うためにrakeのバージョン> 0.8を持っている必要があります。

通常のレーキタスクの説明は次のとおりです。

desc 'Task Description'
task :task_name => [:depends_on_taskA, :depends_on_taskB] do
  #interesting things
end

引数を渡すには、3つのことをしてください。

  1. タスク名の後に、コンマで区切って引数名を追加してください。
  2. ：needs => [...]を使用して依存関係を最後に置きます。
  3. | 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

このタスクをコマンドラインから呼び出すには、[]に引数を渡します。

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
58
Tilendor

もう1つの一般的に使用されるオプションは環境変数を渡すことです。あなたのコードではENV['VAR']を介してそれらを読み、rakeコマンドの直前に渡すことができます。

$ VAR=foo rake mytask
29
kch

実は@Nick Desjardinsさんは完璧に答えました。しかし、教育だけのために：あなたは汚いアプローチを使うことができます：ENV引数を使う

task :my_task do
  myvar = ENV['myvar']
  puts "myvar: #{myvar}"
end 

rake my_task myvar=10
#=> myvar: 10
29
fl00r

私がこれを解決するまで、私は引数とどうやって：環境を渡すかを理解することができませんでした：

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/']
26
Nate Flink
desc 'an updated version'
task :task_name, [:arg1, :arg2] => [:dependency1, :dependency2] do |t, args|
    puts args[:arg1]
end
22
Feng

実行できるようにしたかっただけです。

$ rake some:task arg1 arg2

簡単でしょ？ （いや！）

Rakeはarg1とarg2をタスクとして解釈し、それらを実行しようとします。だから我々はそれが起こる前にただ打ち切ります。

namespace :some do
  task task: :environment do
    arg1, arg2 = ARGV

    # your task...

    exit
  end
end

角かっこ

免責事項 ：私はこれをかなり小さなペットプロジェクトでできるようにしたかった。レーキタスクをチェーニングする機能（つまりrake task1 task2 task3）を失うため、「現実世界」での使用は意図されていません。 IMOは価値がない。醜いrake task[arg1,arg2]を使うだけです。

18
jassa

私はレーキファイルで通常のRuby引数を使います。

DB = ARGV[1]

それから私はファイルの一番下にレーキタスクを書き出します（レーキはその引数名に基づいてタスクを探すので）。

task :database_name1
task :database_name2

コマンドライン：

rake mytask db_name

これは、var = foo ENV varやtask args [blah、blah2]の解よりも私にはきれいに感じられます。
スタブは少しぎくしゃくしていますが、1回限りのセットアップである環境がいくつかある場合はそれほど悪くありません。

12
djburdick

議論を渡す方法は上記の答えで正しいです。しかしながら、引数付きでrakeタスクを実行するためには、Railsの新しいバージョンに関連する小さな技術があります。

それはレーキ "namespace：taskname ['argument1']"で動作します。

コマンドラインからタスクを実行する際の逆引用符に注意してください。

5
Asim Mushtaq

私は引数を渡すための "クエリ文字列"構文が好きです、特に渡すべき引数がたくさんあるとき。

例：

rake "mytask[width=10&height=20]"

"クエリ文字列"は次のとおりです。

width=10&height=20

警告：構文はrake "mytask[foo=bar]"およびNOTrake 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"}}
4
Abdo

デフォルトのタスクに引数を渡すために、あなたはこのようなことをすることができます。たとえば、 "version"があなたの引数だとします。

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

しかし、引数を渡す際にタスク名（デフォルトまたはビルド）を指定しないようにする方法は見つかりませんでした。誰かが方法を知っていれば聞いてみたいです。

3
Gal

上記の方法の大部分は私にはうまくいきませんでした、おそらくそれらは新しいバージョンでは推奨されていません。最新のガイドはここにあります： http://guides.rubyonrails.org/command_line.html#custom-rake-tasks

ガイドからのコピー＆ペーストの回答はこちらです。

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
2
hexinpeter

引数の位置が何のためのものであるか覚えておくことに煩わされないなら、Rubyの引数ハッシュのようなことをしたいのです。 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
2
xander-miller

従来の引数スタイルでレーキタスクを実行するには：

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
0
Daniel