it-swarm.com.ru

Как передать аргументы командной строки в задачу rake

У меня есть грабли задача, которая должна вставить значение в несколько баз данных. 

Я хотел бы передать это значение в задачу rake из командной строки или из другой rake задачи.

Как я могу это сделать?

998
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, лучше всего предварительно загрузить среду, добавив => [:environment], который является способом настройки зависимых задач. 

  task :work, [:option, :foo, :bar] => [:environment] do |task, args|
    puts "work", args
  end
282
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 
 Аргументы со значениями по умолчанию были: {: arg1 =>: default_1,: arg2 =>: default_2} 

> rake with_defaults ['x', 'y'] 
 Аргументы со значениями по умолчанию: {: arg1 => "x",: arg2 => "y"} 

Как показано во втором примере, если вы хотите использовать пробелы, кавычки вокруг целевого имени необходимы, чтобы не допустить разбиения командной оболочки аргументов в пробеле.

Глядя на код в rake.rb , выясняется, что rake не анализирует строки задач для извлечения аргументов для предварительных условий, поэтому вы не можете выполнить task :t1 => "dep[1,2]". Единственный способ указать различные аргументы для предварительного условия - это явно вызвать его в зависимом действии задачи, как в :invoke_my_task и :invoke_my_task_2.

Обратите внимание, что некоторые оболочки (например, zsh) требуют, чтобы вы выходили за скобки: rake my_task\['arg1'\]

1095
Nick Desjardins

В дополнение к ответу по kch (я не нашел, как оставить комментарий к этому, извините):

Вам не нужно указывать переменные как переменные ENV перед командой rake. Вы можете просто установить их как обычные параметры командной строки:

rake mytask var=foo

и получить доступ к ним из вашего файла rake как переменные ENV, например:

p ENV['var'] # => "foo"
307
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

Когда rake-скрипты выглядят так, возможно, пришло время искать другой инструмент, который позволил бы это просто из коробки.

102
Tombart

Я нашел ответ на этих двух веб-сайтах: Net Maniac и Aimred .

Вы должны иметь версию> 0.8 рейка, чтобы использовать эту технику

Обычное описание граблей:

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

Чтобы передать аргументы, сделайте три вещи:

  1. Добавьте имена аргументов после имени задачи, разделяя их запятыми.
  2. Поместите зависимости в конце, используя: needs => [...]
  3. Place | t, args | после того как (т является объектом для этой задачи)

Чтобы получить доступ к аргументам в сценарии, используйте 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
57
Tilendor

Другим часто используемым вариантом является передача переменных среды. В вашем коде вы читаете их через 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/']
25
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). ИМО не стоит. Просто используйте уродливый rake task[arg1,arg2].

16
jassa

Я использую обычный аргумент Ruby в файле rake:

DB = ARGV[1]

затем я заглушаю задачи rake внизу файла (поскольку rake будет искать задачу по имени этого аргумента).

task :database_name1
task :database_name2

командная строка:

rake mytask db_name

это кажется мне чище, чем var = foo ENV var и args [blah, blah2].
заглушка немного дрянная, но не слишком плохая, если у вас есть несколько сред, которые являются одноразовыми

12
djburdick

Способы передачи аргумента верны в ответе выше. Однако, чтобы запустить грабли с аргументами, есть небольшая техническая часть, связанная с более новой версией Rails

Он будет работать с граблями "namespace: taskname ['arguments1']"

Обратите внимание на перевернутые кавычки при запуске задачи из командной строки. 

5
Asim Mushtaq

Мне нравится синтаксис querystring для передачи аргументов, особенно когда нужно передать много аргументов. 

Пример:

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

«Строка запроса»:

width=10&height=20

Предупреждение: обратите внимание, что синтаксис rake "mytask[foo=bar]" и НЕrake mytask["foo=bar"]

При анализе внутри задачи rake с использованием Rack::Utils.parse_nested_query мы получаем 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

Вот более расширенный пример, который я использую с Rails в моем delayed_job_active_record_threaded gem:

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. Вы можете использовать один аргумент, чтобы передать строку, а затем пересмотреть эту строку в хэш опций. 

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
Dan Key