Przekaż zmienne do skryptu Ruby za pomocą wiersza polecenia

275

Zainstalowałem RubyInstaller na Windowsie i korzystam z IMAP Sync, ale muszę go użyć do synchronizacji setek kont. Gdybym mógł przekazać te zmienne za pomocą wiersza poleceń, mógłbym lepiej zautomatyzować cały proces.

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

# Destination server connection info.
DEST_NAME = '[email protected]'
DEST_HOST = 'imap.gmail.com'
DEST_PORT = 993
DEST_SSL  = true
DEST_USER = '[email protected]'
DEST_PASS = 'password'
Błysk
źródło
1
Możesz rozważyć edycję tego popularnego pytania na rzeczywiste pytanie .
not2qubit

Odpowiedzi:

465

Coś takiego:

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

następnie

$ ./test.rb "test1 test2"

lub

v1 = ARGV[0]
v2 = ARGV[1]
puts v1       #prints test1
puts v2       #prints test2
demas
źródło
84
Chciałbym wyraźnie zaznaczyć, że ARGV [0] nie wskazuje nazwy programu, podobnie jak niektóre inne języki. Aby uzyskać nazwę programu, zobacz stackoverflow.com/questions/4834821/...
Sander Mertens
3
Czy „test1 test2” nie jest tylko jednym argumentem?
wuliwong
Musisz dodać #!/usr/bin/env rubyna górze .rbpliku, aby móc go uruchomić w następujący sposób:./test.rb
xamenrax
191

Nie wymyślaj koła ponownie; sprawdź fajną bibliotekę OptionParser Ruby .

Oferuje parsowanie flag / przełączników, parametrów z opcjonalnymi lub wymaganymi wartościami, może parsować listy parametrów w jedną opcję i może generować pomoc.

Ponadto, jeśli którakolwiek z przekazywanych informacji jest dość statyczna, co nie zmienia się między uruchomieniami, umieść ją w analizowanym pliku YAML. W ten sposób możesz mieć rzeczy, które zmieniają się za każdym razem w wierszu poleceń, i rzeczy, które zmieniają się czasami konfigurowane poza twoim kodem. To oddzielenie danych i kodu jest przyjemne w utrzymaniu.

Oto kilka próbek do zabawy:

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

To jest przykładowy plik YAML, jeśli miejsca docelowe są dość statyczne:

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

Umożliwi to łatwe wygenerowanie pliku YAML:

require 'yaml'

yaml = {
  'dest_name' => '[email protected]',
  'dest_host' => 'imap.gmail.com',
  'dest_port' => 993,
  'dest_ssl'  => true,
  'dest_user' => '[email protected]',
  'dest_pass' => 'password'
}

puts YAML.dump(yaml)
Blaszany Człowiek
źródło
2
Link OptParse nie działa. Spróbuj ruby-doc.org/stdlib-1.9.3/libdoc/optparse/rdoc/…
Casey
7
Doskonała odpowiedź; warto dodać, że po zakończeniu analizy opcji ARGVzawiera tylko ewentualne operandy (czyli pozostałe argumenty NIE-opcja).
mklement0
27

Niestety, Ruby nie obsługuje takiego mechanizmu przekazywania, jak np. AWK:

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

Oznacza to, że nie można przekazać nazwanych wartości bezpośrednio do skryptu.

Korzystanie z opcji cmd może pomóc:

> 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 przechowuje wszystkie argumenty cmd w ARGVtablicy, sama nazwa skryptu może zostać przechwycona za pomocą $PROGRAM_NAMEzmiennej.

Oczywistą wadą jest to, że zależy od kolejności wartości.

Jeśli potrzebujesz tylko przełączników boolowskich, skorzystaj z opcji -sinterpretera Ruby:

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

Zwróć uwagę na --przełącznik, w przeciwnym razie Ruby będzie narzekać na nieistniejącą opcję -agreed, więc przekaż go jako przełącznik do wywołania cmd. Nie potrzebujesz go w następującym przypadku:

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

Wadą jest to, że mieszasz zmienne globalne i masz tylko logiczne wartości prawda / fałsz.

Możesz uzyskać dostęp do wartości ze zmiennych środowiskowych:

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

Wadami są tutaj: musisz ustawić wszystkie zmienne przed wywołaniem skryptu (tylko dla twojego procesu ruby) lub wyeksportować je (powłoki jak BASH):

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

W tym drugim przypadku twoje dane będą czytelne dla wszystkich w tej samej sesji powłoki i dla wszystkich podprocesów, co może mieć poważne konsekwencje dla bezpieczeństwa.

A przynajmniej można wdrożyć parser opcji przy getoptlong i optparse .

Miłego hakowania!

Andrei Beliankou
źródło
1

Możesz także wypróbować cliqr. Jest całkiem nowy i aktywnie się rozwija. Ale są stabilne wersje gotowe do użycia. Oto repozytorium git: https://github.com/anshulverma/cliqr

Zajrzyj do przykładowego folderu, aby dowiedzieć się, jak go używać.

nuaavee
źródło
0

Uruchom ten kod w wierszu polecenia i wprowadź wartość N:

N  = gets; 1.step(N.to_i, 1) { |i| print "hello world\n" }
cyna cyna
źródło
0

O ile nie jest to najbardziej trywialny przypadek, istnieje tylko jeden rozsądny sposób użycia opcji wiersza poleceń w Ruby. Nazywa się to docopt i jest tutaj udokumentowane .

To, co jest niesamowite, to prostota. Wszystko, co musisz zrobić, to podać tekst „pomocy” dla swojego polecenia. To, co tam napiszesz, zostanie automatycznie przeanalizowane przez samodzielną (!) Bibliotekę ruby.

Z przykładu :

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

Wyjście:

$ ./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>"=>[]}

Cieszyć się!

not2qubit
źródło
0

Powinieneś spróbować klejnotu console_runner . Ten klejnot sprawia, że ​​Twój czysty kod Ruby jest wykonywalny z wiersza poleceń. Wystarczy dodać adnotacje YARD do swojego kodu:

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

Następnie uruchom go z konsoli:

$ c_run /projects/example/my_class.rb  say_hello -n John --second-meet --prefix Mr. 
-> Hello, Mr. John. Nice to see you again!
Jurij Karpowicz
źródło
0

tl; dr

Wiem, że to jest stare, ale getoptlong nie zostało tutaj wspomniane i jest to prawdopodobnie najlepszy sposób na analizę argumentów wiersza poleceń dzisiaj.


Parsowanie argumentów wiersza poleceń

Zdecydowanie polecam getoptlong . Jest dość łatwy w użyciu i działa jak urok. Oto przykład wyodrębniony z linku powyżej

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

Możesz to tak nazwać ruby hello.rb -n 6 --name -- /tmp

Co OP próbuje zrobić

W tym przypadku myślę, że najlepszą opcją jest użycie plików YAML, jak sugerowano w tej odpowiedzi

Redithion
źródło
0

Jak delikatnie zapytał @ Yunnosch, rozwinę trochę moją sugestię.

Argumenty przekazywane do skryptu są przechowywane w ARGV

# Calling my script from current directory with 3 arguments
./my_script username@example.com mail.exmaple.com 143

puts ARGV.inspect                  
#=> ['[email protected]', 'mail.example.com', '143']

Używanie flag eliminuje potrzebę argumentów pozycyjnych

./my_script --port 143 -h mail.example.com -n username@example.com 

Ale teraz musimy pobrać wartości na podstawie flag. Z Ruby można to zrobić w 1 linii:

SOURCE_HOST = ARGV[ARGV.index { |e| e =~ /-h|--source-host/ } + 1] rescue nil || 'default_source_host'

Dekonstruujmy składnię:

# value should be somewhere inside ARGV (Array)
ARGV[]

# "somewhere" is actually right after the flag. 
# We pass a block to :index to check if the elements from ARGV match our flag. 
ARGV.index { |e| e =~ /-h|--source-host/ } + 1

# If nothing match, rescue nil (instead of raising error from nil + 1)
rescue nil

# Use OR || operator to set default value
|| 'default_source_host'


# Returns the value after the index of the element which match '-h'
# or '--source-host'; or set the default value to 'default_source_host'
ARGV[ARGV.index { |e| e =~ /-h|--source-host/ } + 1] rescue nil || 'default_host'

Chociaż jeśli nie jest to odpowiednie rozwiązanie, chętnie dowiem się więcej o edgecases

Sumak
źródło
Tak, a co z tym? Czy to rozwiązanie, które proponujesz? Więc wyjaśnij to proszę. Czy masz z tym problem? Następnie wyjaśnij to proszę, ale w odpowiedzi na pytanie zamiast odpowiedzi. Czy to coś, co musisz wiedzieć, zanim będziesz mógł odpowiedzieć? Następnie użyj usuń proszę i użyj zamiast tego uprawnienia do komentowania.
Yunnosch