通过命令行将变量传递给Ruby脚本

我已经在Windows上安装了RubyInstaller,我正在运行IMAP同步,但我需要使用它来同步数百个帐户。如果我可以通过命令行将这些变量传递给它,我可以更好地自动化整个过程。

# 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'
284786 次浏览

就像这样:

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

不要白费力气;看看Ruby的酷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)

不幸的是,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变量捕获。

明显的缺点是依赖于值的顺序。

如果你只需要布尔开关,使用Ruby解释器的选项-s:

> 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这样的shell):

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

在后一种情况下,您的数据对于同一shell会话中的每个人以及所有子进程都是可读的,这可能是一个严重的安全隐患。

至少你可以使用getoptlongoptparse实现一个选项解析器。

黑客快乐!

你也可以尝试cliqr。它很新,正在积极发展中。但是有一些稳定的版本可以使用。这里是git回购:https://github.com/anshulverma/cliqr

查看示例文件夹以了解如何使用它。

在命令行上运行这段代码,并输入N的值:

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

除非是最琐碎的情况,否则在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>"=>[]}

享受吧!

你应该试试console_runner gem。这个宝石使您的纯Ruby代码可以从命令行执行。你所需要做的就是在你的代码中添加院子里注释:

# @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!

博士tl;

我知道这很老了,但这里没有提到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 < / p >

OP在做什么

在这种情况下,我认为最好的选择是使用YAML文件在这个答案中