コマンドラインを介して変数をRubyスクリプトに渡す


275

WindowsにRubyInstallerをインストールし、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 2018

回答:


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 "は単一の引数ではありませんか?
wuliwong

あなたは追加する必要がある#!/usr/bin/env rubyの上に.rb、このようにそれを実行できるようにするファイル:./test.rb
xamenrax

191

車輪を再発明しないでください。Rubyのway-cool 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/…を
Casey

7
すばらしい答え。オプションの解析が行われた後ARGV、オペランド(ある場合)のみが含まれる(つまり、残りの非オプション引数)ことを追加する価値があるかもしれません。
mklement0 2015

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配列に格納します。scriptname自体は$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!

不利な点は、グローバル変数をいじって、論理的な真/偽の値しか持たないことです。

環境変数から値にアクセスできます。

> 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"]'

後者の場合、データは同じシェルセッションのすべてのユーザーとすべてのサブプロセスで読み取り可能になるため、セキュリティに深刻な影響を与える可能性があります。

そして、少なくともgetoptlongoptparseを使用してオプションパーサーを実装できます。

ハッキングハッピー!


1

試してみることもできcliqrます。そのかなり新しく活発な開発中です。しかし、すぐに使用できる安定したリリースがあります。これがgitリポジトリです:https : //github.com/anshulverma/cliqr

サンプルフォルダーを調べて、それをどのように使用できるかを理解してください。


0

コマンドラインでこのコードを実行し、Nの値を入力します。

N  = gets; 1.step(N.to_i, 1) { |i| print "hello world\n" }

0

最も些細な場合を除いて、Rubyでコマンドラインオプションを使用する方法は1つしかありません。docoptと呼ばれ、ここに記載されています

それで驚くべきことは、それがシンプルであることです。あなたがしなければならないすべては、あなたのコマンドの「ヘルプ」テキストを指定することです。そこに書き込んだものは、スタンドアロン(!)ルビライブラリによって自動的に解析されます。

から:

#!/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>"=>[]}

楽しい!


0

console_runner gem を試してみてください。このgemは、コマンドラインから純粋な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

tl; dr

これは古いことはわかっていますが、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

OPが実行しようとしていること

この場合、私はこの回答で提案さているようにYAMLファイルを使用するのが最良のオプションだと思います

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.