Передача переменных в скрипт Ruby через командную строку

275

Я установил RubyInstaller в Windows и запускаю IMAP Sync, но мне нужно использовать его для синхронизации сотен учетных записей. Если бы я мог передать эти переменные ему через командную строку, я бы лучше автоматизировал весь процесс.

# Source server connection info.
SOURCE_NAME = 'username@example.com'
SOURCE_HOST = 'mail.example.com'
SOURCE_PORT = 143
SOURCE_SSL  = false
SOURCE_USER = 'username'
SOURCE_PASS = 'password'

# Destination server connection info.
DEST_NAME = 'username@gmail.com'
DEST_HOST = 'imap.gmail.com'
DEST_PORT = 993
DEST_SSL  = true
DEST_USER = 'username@gmail.com'
DEST_PASS = 'password'
Вспышка
источник
1
Вы можете рассмотреть возможность редактирования этого популярного вопроса в реальном вопросе .
not2qubit

Ответы:

465

Что-то вроде этого:

ARGV.each do|a|
  puts "Argument: #{a}"
end

затем

$ ./test.rb "test1 test2"

или

v1 = ARGV[0]
v2 = ARGV[1]
puts v1       #prints test1
puts v2       #prints test2
Димас
источник
84
Я хотел бы прямо указать, что ARGV [0] не указывает на имя программы, как некоторые другие языки. Чтобы узнать название программы, см. Stackoverflow.com/questions/4834821/…
Сандер Мертенс,
3
Разве `" test1 test2 "не единственный аргумент?
Вуливонг
Вы должны добавить #!/usr/bin/env rubyв .rb./test.rb
начало
191

Не изобретай велосипед; проверить путь-прохладное Руби OptionParser библиотеки.

Он предлагает анализ флагов / переключателей, параметров с необязательными или обязательными значениями, может анализировать списки параметров в одну опцию и может генерировать вашу помощь для вас.

Кроме того, если передаваемая вами информация довольно статична, она не меняется между запусками, поместите ее в YAML-файл, который будет проанализирован. Таким образом, вы можете иметь вещи, которые меняются каждый раз в командной строке, и вещи, которые изменяются, время от времени конфигурируемые вне вашего кода. Такое разделение данных и кода хорошо для обслуживания.

Вот несколько примеров для игры:

require 'optparse'
require 'yaml'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on('-n', '--sourcename NAME', 'Source name') { |v| options[:source_name] = v }
  opts.on('-h', '--sourcehost HOST', 'Source host') { |v| options[:source_host] = v }
  opts.on('-p', '--sourceport PORT', 'Source port') { |v| options[:source_port] = v }

end.parse!

dest_options = YAML.load_file('destination_config.yaml')
puts dest_options['dest_name']

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

--- 
dest_name: username@gmail.com
dest_host: imap.gmail.com
dest_port: 993
dest_ssl: true
dest_user: username@gmail.com
dest_pass: password

Это позволит вам легко сгенерировать файл YAML:

require 'yaml'

yaml = {
  'dest_name' => 'username@gmail.com',
  'dest_host' => 'imap.gmail.com',
  'dest_port' => 993,
  'dest_ssl'  => true,
  'dest_user' => 'username@gmail.com',
  'dest_pass' => 'password'
}

puts YAML.dump(yaml)
жестяной человек
источник
2
Ссылка OptParse не работает. Попробуйте ruby-doc.org/stdlib-1.9.3/libdoc/optparse/rdoc/…
Кейси
7
Отличный ответ; может быть, стоит добавить, что после того, как опция-разбор завершена, она ARGVсодержит только операнды, если они есть (то есть оставшиеся аргументы без опции).
mklement0
27

К сожалению, Ruby не поддерживает такой механизм передачи, как, например, AWK:

> awk -v a=1 'BEGIN {print a}'
> 1

Это означает, что вы не можете передавать именованные значения в ваш скрипт напрямую.

Использование параметров cmd может помочь:

> ruby script.rb val_0 val_1 val_2

# script.rb
puts ARGV[0] # => val_0
puts ARGV[1] # => val_1
puts ARGV[2] # => val_2

Ruby хранит все аргументы cmd в ARGVмассиве, само имя сценария может быть записано с помощью $PROGRAM_NAMEпеременной.

Очевидным недостатком является то, что вы зависите от порядка значений.

Если вам нужны только булевы ключи, используйте опцию -sинтерпретатора Ruby:

> ruby -s -e 'puts "So do I!" if $agreed' -- -agreed
> So do I!

Обратите внимание на --переключатель, в противном случае Ruby будет жаловаться на несуществующий параметр -agreed, поэтому передайте его как переключатель для вызова cmd. Вам не нужно это в следующем случае:

> ruby -s script_with_switches.rb -agreed
> So do I!

Недостатком является то, что вы связываетесь с глобальными переменными и имеете только логические значения true / false.

Вы можете получить доступ к значениям из переменных среды:

> FIRST_NAME='Andy Warhol' ruby -e 'puts ENV["FIRST_NAME"]'
> Andy Warhol

Здесь есть недостатки, вам нужно установить все переменные перед вызовом скрипта (только для вашего процесса ruby) или экспортировать их (оболочки типа BASH):

> export FIRST_NAME='Andy Warhol'
> ruby -e 'puts ENV["FIRST_NAME"]'

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

И, по крайней мере, вы можете реализовать парсер опций, используя getoptlong и optparse .

Счастливого взлома!

Андрей Белянку
источник
1

Вы также можете попробовать cliqr. Это довольно новый и в активном развитии. Но есть стабильные релизы, готовые к использованию. Вот git репо: https://github.com/anshulverma/cliqr

Посмотрите в папку с примерами, чтобы понять, как ее можно использовать.

nuaavee
источник
0

Запустите этот код в командной строке и введите значение N:

N  = gets; 1.step(N.to_i, 1) { |i| print "hello world\n" }
олово олово
источник
0

Если это не самый простой случай, есть только один разумный способ использовать параметры командной строки в Ruby. Это называется docopt и задокументировано здесь .

Что удивительного в этом, так это простота. Все, что вам нужно сделать, это указать текст «справки» для вашей команды. То, что вы там пишете, будет автоматически проанализировано отдельной (!) Библиотекой ruby.

Из примера :

#!/usr/bin/env ruby
require 'docopt.rb'

doc = <<DOCOPT
Usage: #{__FILE__} --help
       #{__FILE__} -v...
       #{__FILE__} go [go]
       #{__FILE__} (--path=<path>)...
       #{__FILE__} <file> <file>

Try: #{__FILE__} -vvvvvvvvvv
     #{__FILE__} go go
     #{__FILE__} --path ./here --path ./there
     #{__FILE__} this.txt that.txt

DOCOPT

begin
  require "pp"
  pp Docopt::docopt(doc)
rescue Docopt::Exit => e
  puts e.message
end

Выход:

$ ./counted_example.rb -h
Usage: ./counted_example.rb --help
       ./counted_example.rb -v...
       ./counted_example.rb go [go]
       ./counted_example.rb (--path=<path>)...
       ./counted_example.rb <file> <file>

Try: ./counted_example.rb -vvvvvvvvvv
     ./counted_example.rb go go
     ./counted_example.rb --path ./here --path ./there
     ./counted_example.rb this.txt that.txt

$ ./counted_example.rb something else
{"--help"=>false,
 "-v"=>0,
 "go"=>0,
 "--path"=>[],
 "<file>"=>["something", "else"]}

$ ./counted_example.rb -v
{"--help"=>false, "-v"=>1, "go"=>0, "--path"=>[], "<file>"=>[]}

$ ./counted_example.rb go go
{"--help"=>false, "-v"=>0, "go"=>2, "--path"=>[], "<file>"=>[]}

Наслаждайтесь!

not2qubit
источник
0

Вы должны попробовать gem console_runner . Этот гем делает ваш чистый код Ruby исполняемым из командной строки. Все, что вам нужно, это добавить аннотации YARD в ваш код:

# @runnable This tool can talk to you. Run it when you are lonely.
#   Written in Ruby.  
class MyClass

    def initialize
      @hello_msg = 'Hello' 
      @bye_msg = 'Good Bye' 
    end

    # @runnable Say 'Hello' to you.
    # @param [String] name Your name
    # @param [Hash] options options
    # @option options [Boolean] :second_meet Have you met before?
    # @option options [String] :prefix Your custom prefix
    def say_hello(name, options = {})
      second_meet = nil
      second_meet = 'Nice to see you again!' if options['second_meet']
      prefix = options['prefix']
      message = @hello_msg + ', '
      message += "#{prefix} " if prefix
      message += "#{name}. "
      message += second_meet if second_meet
      puts message
    end

end

Затем запустите его из консоли:

$ c_run /projects/example/my_class.rb  say_hello -n John --second-meet --prefix Mr. 
-> Hello, Mr. John. Nice to see you again!
Юрий Карпович
источник
0

ТЛ; др

Я знаю, что это старо, но getoptlong здесь не упоминался, и это, вероятно, лучший способ для анализа аргументов командной строки сегодня.


Разбор аргументов командной строки

Я настоятельно рекомендую getoptlong . Он довольно прост в использовании и работает как шарм. Вот пример, извлеченный из ссылки выше

require 'getoptlong'

opts = GetoptLong.new(
    [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
    [ '--repeat', '-n', GetoptLong::REQUIRED_ARGUMENT ],
    [ '--name', GetoptLong::OPTIONAL_ARGUMENT ]
)

dir = nil
name = nil
repetitions = 1
opts.each do |opt, arg|
    case opt
        when '--help'
            puts <<-EOF
hello [OPTION] ... DIR

-h, --help:
     show help

--repeat x, -n x:
     repeat x times

--name [name]:
     greet user by name, if name not supplied default is John

DIR: The directory in which to issue the greeting.
            EOF
        when '--repeat'
            repetitions = arg.to_i
        when '--name'
            if arg == ''
                name = 'John'
            else
                name = arg
            end
    end
end

if ARGV.length != 1
    puts "Missing dir argument (try --help)"
    exit 0
end

dir = ARGV.shift

Dir.chdir(dir)
for i in (1..repetitions)
    print "Hello"
    if name
        print ", #{name}"
    end
    puts
end

Вы можете назвать это так ruby hello.rb -n 6 --name -- /tmp

Что ОП пытается сделать

В этом случае я думаю, что лучший вариант - использовать файлы YAML, как предлагается в этом ответе.

Redithion
источник