argument_converters - Dokumentation für Ruby 4.0

Argument-Konverter

Eine Option kann angeben, dass ihr Argument vom Standardtyp String in eine Instanz einer anderen Klasse konvertiert werden soll.

Inhalt

Integrierte Argument-Konverter
- Date
- DateTime
- Time
- URI
- Shellwords
- Integer
- Float
- Numeric
- Dezimalzahl (Integer)
- Oktalzahl (Integer)
- Dezimalzahl (Numeric)
- TrueClass
- FalseClass
- Object
- String
- Array
- Regexp
Benutzerdefinierte Argument-Konverter

Integrierte Argument-Konverter

OptionParser verfügt über eine Reihe integrierter Argument-Konverter, die im Folgenden gezeigt werden.

`Date`

File date.rb definiert eine Option, deren Argument in ein Date-Objekt konvertiert werden soll. Das Argument wird durch die Methode Date#parse konvertiert.

require 'optparse/date'
parser = OptionParser.new
parser.on('--date=DATE', Date) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby date.rb --date 2001-02-03
[#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]
$ ruby date.rb --date 20010203
[#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]
$ ruby date.rb --date "3rd Feb 2001"
[#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]

`DateTime`

File datetime.rb definiert eine Option, deren Argument in ein DateTime-Objekt konvertiert werden soll. Das Argument wird durch die Methode DateTime#parse konvertiert.

require 'optparse/date'
parser = OptionParser.new
parser.on('--datetime=DATETIME', DateTime) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby datetime.rb --datetime 2001-02-03T04:05:06+07:00
[#<DateTime: 2001-02-03T04:05:06+07:00 ((2451943j,75906s,0n),+25200s,2299161j)>, DateTime]
$ ruby datetime.rb --datetime 20010203T040506+0700
[#<DateTime: 2001-02-03T04:05:06+07:00 ((2451943j,75906s,0n),+25200s,2299161j)>, DateTime]
$ ruby datetime.rb --datetime "3rd Feb 2001 04:05:06 PM"
[#<DateTime: 2001-02-03T16:05:06+00:00 ((2451944j,57906s,0n),+0s,2299161j)>, DateTime]

`Time`

File time.rb definiert eine Option, deren Argument in ein Time-Objekt konvertiert werden soll. Das Argument wird durch die Methode Time#httpdate oder Time#parse konvertiert.

require 'optparse/time'
parser = OptionParser.new
parser.on('--time=TIME', Time) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby time.rb --time "Thu, 06 Oct 2011 02:26:12 GMT"
[2011-10-06 02:26:12 UTC, Time]
$ ruby time.rb --time 2010-10-31
[2010-10-31 00:00:00 -0500, Time]

`URI`

File uri.rb definiert eine Option, deren Argument in ein URI-Objekt konvertiert werden soll. Das Argument wird durch die Methode URI#parse konvertiert.

require 'optparse/uri'
parser = OptionParser.new
parser.on('--uri=URI', URI) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby uri.rb --uri https://github.com
[#<URI::HTTPS https://github.com>, URI::HTTPS]
$ ruby uri.rb --uri http://github.com
[#<URI::HTTP http://github.com>, URI::HTTP]
$ ruby uri.rb --uri file://~/var
[#<URI::File file://~/var>, URI::File]

`Shellwords`

File shellwords.rb definiert eine Option, deren Argument durch die Methode Shellwords#shellwords in ein Array-Objekt konvertiert werden soll.

require 'optparse/shellwords'
parser = OptionParser.new
parser.on('--shellwords=SHELLWORDS', Shellwords) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby shellwords.rb --shellwords "ruby my_prog.rb | less"
[["ruby", "my_prog.rb", "|", "less"], Array]
$ ruby shellwords.rb --shellwords "here are 'two words'"
[["here", "are", "two words"], Array]

`Integer`

File integer.rb definiert eine Option, deren Argument in ein Integer-Objekt konvertiert werden soll. Das Argument wird durch die Methode Kernel#Integer konvertiert.

require 'optparse'
parser = OptionParser.new
parser.on('--integer=INTEGER', Integer) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby integer.rb --integer 100
[100, Integer]
$ ruby integer.rb --integer -100
[-100, Integer]
$ ruby integer.rb --integer 0100
[64, Integer]
$ ruby integer.rb --integer 0x100
[256, Integer]
$ ruby integer.rb --integer 0b100
[4, Integer]

`Float`

File float.rb definiert eine Option, deren Argument in ein Float-Objekt konvertiert werden soll. Das Argument wird durch die Methode Kernel#Float konvertiert.

require 'optparse'
parser = OptionParser.new
parser.on('--float=FLOAT', Float) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby float.rb --float 1
[1.0, Float]
$ ruby float.rb --float 3.14159
[3.14159, Float]
$ ruby float.rb --float 1.234E2
[123.4, Float]
$ ruby float.rb --float 1.234E-2
[0.01234, Float]

`Numeric`

File numeric.rb definiert eine Option, deren Argument in eine Instanz von Rational, Float oder Integer konvertiert werden soll. Das Argument wird durch die Methoden Kernel#Rational, Kernel#Float oder Kernel#Integer konvertiert.

require 'optparse'
parser = OptionParser.new
parser.on('--numeric=NUMERIC', Numeric) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby numeric.rb --numeric 1/3
[(1/3), Rational]
$ ruby numeric.rb --numeric 3.333E-1
[0.3333, Float]
$ ruby numeric.rb --numeric 3
[3, Integer]

`Dezimalzahl (Integer)`

File decimal_integer.rb definiert eine Option, deren Argument in ein Integer-Objekt konvertiert werden soll. Das Argument wird durch die Methode Kernel#Integer konvertiert.

require 'optparse'
include OptionParser::Acceptables
parser = OptionParser.new
parser.on('--decimal_integer=DECIMAL_INTEGER', DecimalInteger) do |value|
  p [value, value.class]
end
parser.parse!

Das Argument darf nicht im Binär- oder Hexadezimalformat vorliegen; eine führende Null wird ignoriert (nicht als Oktalzahl interpretiert).

Ausführungen

$ ruby decimal_integer.rb --decimal_integer 100
[100, Integer]
$ ruby decimal_integer.rb --decimal_integer -100
[-100, Integer]
$ ruby decimal_integer.rb --decimal_integer 0100
[100, Integer]
$ ruby decimal_integer.rb --decimal_integer -0100
[-100, Integer]

`Oktalzahl (Integer)`

File octal_integer.rb definiert eine Option, deren Argument in ein Integer-Objekt konvertiert werden soll. Das Argument wird durch die Methode Kernel#Integer konvertiert.

require 'optparse'
include OptionParser::Acceptables
parser = OptionParser.new
parser.on('--octal_integer=OCTAL_INTEGER', OctalInteger) do |value|
  p [value, value.class]
end
parser.parse!

Das Argument darf nicht im Binär- oder Hexadezimalformat vorliegen; es wird als Oktalzahl interpretiert, unabhängig davon, ob es eine führende Null hat.

Ausführungen

$ ruby octal_integer.rb --octal_integer 100
[64, Integer]
$ ruby octal_integer.rb --octal_integer -100
[-64, Integer]
$ ruby octal_integer.rb --octal_integer 0100
[64, Integer]

`Dezimalzahl (Numeric)`

File decimal_numeric.rb definiert eine Option, deren Argument in ein Integer-Objekt konvertiert werden soll. Das Argument wird durch die Methode Kernel#Integer konvertiert.

require 'optparse'
include OptionParser::Acceptables
parser = OptionParser.new
parser.on('--decimal_numeric=DECIMAL_NUMERIC', DecimalNumeric) do |value|
  p [value, value.class]
end
parser.parse!

Das Argument darf nicht im Binär- oder Hexadezimalformat vorliegen; eine führende Null führt dazu, dass das Argument als Oktalzahl interpretiert wird.

Ausführungen

$ ruby decimal_numeric.rb --decimal_numeric 100
[100, Integer]
$ ruby decimal_numeric.rb --decimal_numeric -100
[-100, Integer]
$ ruby decimal_numeric.rb --decimal_numeric 0100
[64, Integer]

`TrueClass`

File true_class.rb definiert eine Option, deren Argument in true oder false konvertiert werden soll. Das Argument wird durch die Methode Object#nil? ausgewertet.

require 'optparse'
parser = OptionParser.new
parser.on('--true_class=TRUE_CLASS', TrueClass) do |value|
  p [value, value.class]
end
parser.parse!

Das Argument kann eines der unten gezeigten Beispiele sein.

Ausführungen

$ ruby true_class.rb --true_class true
[true, TrueClass]
$ ruby true_class.rb --true_class yes
[true, TrueClass]
$ ruby true_class.rb --true_class +
[true, TrueClass]
$ ruby true_class.rb --true_class false
[false, FalseClass]
$ ruby true_class.rb --true_class no
[false, FalseClass]
$ ruby true_class.rb --true_class -
[false, FalseClass]
$ ruby true_class.rb --true_class nil
[false, FalseClass]

`FalseClass`

File false_class.rb definiert eine Option, deren Argument in true oder false konvertiert werden soll. Das Argument wird durch die Methode Object#nil? ausgewertet.

require 'optparse'
parser = OptionParser.new
parser.on('--false_class=FALSE_CLASS', FalseClass) do |value|
  p [value, value.class]
end
parser.parse!

Das Argument kann eines der unten gezeigten Beispiele sein.

Ausführungen

$ ruby false_class.rb --false_class false
[false, FalseClass]
$ ruby false_class.rb --false_class no
[false, FalseClass]
$ ruby false_class.rb --false_class -
[false, FalseClass]
$ ruby false_class.rb --false_class nil
[false, FalseClass]
$ ruby false_class.rb --false_class true
[true, TrueClass]
$ ruby false_class.rb --false_class yes
[true, TrueClass]
$ ruby false_class.rb --false_class +
[true, TrueClass]

`Object`

File object.rb definiert eine Option, deren Argument nicht von String konvertiert werden soll.

require 'optparse'
parser = OptionParser.new
parser.on('--object=OBJECT', Object) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby object.rb --object foo
["foo", String]
$ ruby object.rb --object nil
["nil", String]

`String`

File string.rb definiert eine Option, deren Argument nicht von String konvertiert werden soll.

require 'optparse'
parser = OptionParser.new
parser.on('--string=STRING', String) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby string.rb --string foo
["foo", String]
$ ruby string.rb --string nil
["nil", String]

`Array`

File array.rb definiert eine Option, deren Argument von String in ein Array von Strings konvertiert werden soll, basierend auf durch Kommas getrennten Teilstrings.

require 'optparse'
parser = OptionParser.new
parser.on('--array=ARRAY', Array) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby array.rb --array ""
[[], Array]
$ ruby array.rb --array foo,bar,baz
[["foo", "bar", "baz"], Array]
$ ruby array.rb --array "foo, bar, baz"
[["foo", " bar", " baz"], Array]

`Regexp`

File regexp.rb definiert eine Option, deren Argument in ein Regexp-Objekt konvertiert werden soll.

require 'optparse'
parser = OptionParser.new
parser.on('--regexp=REGEXP', Regexp) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby regexp.rb --regexp foo

Benutzerdefinierte Argument-Konverter

Sie können benutzerdefinierte Argument-Konverter erstellen. Um einen benutzerdefinierten Konverter zu erstellen, rufen Sie OptionParser#accept auf mit

Eine Kennung, die jedes Objekt sein kann.
Ein optionales Muster, das standardmäßig /.*/m ist.
Ein Block, der das Argument akzeptiert und den konvertierten Wert zurückgibt.

Dieser benutzerdefinierte Konverter akzeptiert jedes Argument und konvertiert es, wenn möglich, in ein Complex-Objekt.

require 'optparse/date'
parser = OptionParser.new
parser.accept(Complex) do |value|
  value.to_c
end
parser.on('--complex COMPLEX', Complex) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby custom_converter.rb --complex 0
[(0+0i), Complex]
$ ruby custom_converter.rb --complex 1
[(1+0i), Complex]
$ ruby custom_converter.rb --complex 1+2i
[(1+2i), Complex]
$ ruby custom_converter.rb --complex 0.3-0.5i
[(0.3-0.5i), Complex]

Dieser benutzerdefinierte Konverter akzeptiert jedes ein-Wort-Argument und großschreibt es, wenn möglich.

require 'optparse/date'
parser = OptionParser.new
parser.accept(:capitalize, /\w*/) do |value|
  value.capitalize
end
parser.on('--capitalize XXX', :capitalize) do |value|
  p [value, value.class]
end
parser.parse!

Ausführungen

$ ruby match_converter.rb --capitalize foo
["Foo", String]
$ ruby match_converter.rb --capitalize "foo bar"
match_converter.rb:9:in '<main>': invalid argument: --capitalize foo bar (OptionParser::InvalidArgument)