Passare le variabili allo script Ruby tramite riga di comando


275

Ho installato RubyInstaller su Windows e sto eseguendo IMAP Sync ma devo usarlo per sincronizzare centinaia di account. Se potessi passare queste variabili ad esso tramite riga di comando, potrei automatizzare meglio l'intero processo.

# 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
Potresti voler considerare la modifica di questa domanda popolare in una domanda reale .
not2qubit,

Risposte:


465

Qualcosa come questo:

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

poi

$ ./test.rb "test1 test2"

o

v1 = ARGV[0]
v2 = ARGV[1]
puts v1       #prints test1
puts v2       #prints test2

84
Vorrei sottolineare esplicitamente che ARGV [0] non punta al nome del programma, come fanno altre lingue. Per ottenere il nome del programma, vedere stackoverflow.com/questions/4834821/…
Sander Mertens,

3
`" Test1 test2 "non è solo un singolo argomento?
wuliwong,

Devi aggiungere #!/usr/bin/env rubysopra il .rbfile per poterlo eseguire in questo modo:./test.rb
xamenrax

191

Non reinventare la ruota; controlla la libreria OptionParser di Ruby .

Offre l'analisi di flag / switch, parametri con valori opzionali o obbligatori, può analizzare elenchi di parametri in un'unica opzione e generare il tuo aiuto per te.

Inoltre, se una qualsiasi delle tue informazioni trasmesse è piuttosto statica, ciò non cambia tra le esecuzioni, inseriscile in un file YAML che viene analizzato. In questo modo puoi avere cose che cambiano ogni volta sulla riga di comando e cose che cambiano occasionalmente configurate al di fuori del tuo codice. Questa separazione di dati e codice è utile per la manutenzione.

Ecco alcuni esempi con cui giocare:

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

Questo è un file YAML di esempio se le tue destinazioni sono piuttosto statiche:

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

Ciò ti consentirà di generare facilmente un file 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
Il link OptParse è morto. Prova ruby-doc.org/stdlib-1.9.3/libdoc/optparse/rdoc/…
Casey

7
Risposta eccellente; può valere la pena aggiungere che dopo aver eseguito l'analisi delle opzioni, ARGVcontiene solo gli operandi, se presenti (ovvero gli argomenti NON-option rimanenti).
mklement0,

27

Sfortunatamente, Ruby non supporta questo meccanismo di passaggio come ad esempio AWK:

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

Significa che non puoi passare direttamente i valori nominati nel tuo script.

L'uso delle opzioni cmd può aiutare:

> 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 memorizza tutti gli argomenti cmd ARGVnell'array, lo scriptname stesso può essere catturato usando la $PROGRAM_NAMEvariabile.

L'ovvio svantaggio è che si dipende dall'ordine dei valori.

Se hai bisogno solo di switch booleani usa l'opzione -sdell'interprete Ruby:

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

Nota l' --interruttore, altrimenti Ruby si lamenterà di un'opzione inesistente -agreed, quindi passalo come interruttore al tuo invocazione cmd. Non è necessario nel seguente caso:

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

Lo svantaggio è che si scherza con le variabili globali e si hanno solo valori veri / falsi logici.

È possibile accedere ai valori dalle variabili di ambiente:

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

Gli svantaggi sono presenti qui a, devi impostare tutte le variabili prima dell'invocazione dello script (solo per il tuo processo ruby) o esportarle (shell come BASH):

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

In quest'ultimo caso, i tuoi dati saranno leggibili per tutti nella stessa sessione della shell e per tutti i sottoprocessi, il che può essere una seria conseguenza per la sicurezza.

E almeno puoi implementare un parser di opzioni usando getoptlong e optparse .

Happy hacking!


1

Puoi anche provare cliqr. È piuttosto nuovo e in fase di sviluppo attivo. Ma ci sono versioni stabili pronte per essere utilizzate. Ecco il repository git: https://github.com/anshulverma/cliqr

Guarda nella cartella di esempio per avere un'idea di come può essere utilizzata.


0

Esegui questo codice dalla riga di comando e inserisci il valore di N:

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

0

A meno che non sia il caso più banale, c'è solo un modo sano di usare le opzioni della riga di comando in Ruby. Si chiama docopt e documentato qui .

Ciò che è sorprendente è la sua semplicità. Tutto quello che devi fare è specificare il testo "aiuto" per il tuo comando. Ciò che scrivi lì verrà quindi analizzato automaticamente dalla libreria ruby standalone (!).

Dal Esempio :

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

Il risultato:

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

Godere!


0

Dovresti provare console_runner gem. Questa gemma rende il tuo codice Ruby puro eseguibile dalla riga di comando. Tutto ciò che serve è aggiungere annotazioni YARD al tuo codice:

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

Quindi eseguilo dalla console:

$ 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

So che questo è vecchio, ma getoptlong non è stato menzionato qui ed è probabilmente il modo migliore per analizzare gli argomenti della riga di comando oggi.


Analisi degli argomenti della riga di comando

Consiglio vivamente getoptlong . È abbastanza facile da usare e funziona come un fascino. Ecco un esempio estratto dal link sopra

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

Puoi chiamarlo così ruby hello.rb -n 6 --name -- /tmp

Cosa sta cercando di fare OP

In questo caso, penso che l'opzione migliore sia usare i file YAML come suggerito in questa risposta

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.