summaryrefslogtreecommitdiff
path: root/doc/ruby
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ruby')
-rw-r--r--doc/ruby/argument_keywords.rb6
-rw-r--r--doc/ruby/argument_strings.rb6
-rw-r--r--doc/ruby/argv.rb2
-rw-r--r--doc/ruby/array.rb6
-rw-r--r--doc/ruby/block.rb9
-rw-r--r--doc/ruby/date.rb6
-rw-r--r--doc/ruby/datetime.rb6
-rw-r--r--doc/ruby/decimal_integer.rb7
-rw-r--r--doc/ruby/decimal_numeric.rb7
-rw-r--r--doc/ruby/descriptions.rb15
-rw-r--r--doc/ruby/explicit_array_values.rb9
-rw-r--r--doc/ruby/explicit_hash_values.rb9
-rw-r--r--doc/ruby/false_class.rb6
-rw-r--r--doc/ruby/float.rb6
-rw-r--r--doc/ruby/integer.rb6
-rw-r--r--doc/ruby/long_binary.rb6
-rw-r--r--doc/ruby/long_names.rb9
-rw-r--r--doc/ruby/long_optional.rb6
-rw-r--r--doc/ruby/long_required.rb6
-rw-r--r--doc/ruby/long_simple.rb9
-rw-r--r--doc/ruby/matched_values.rb6
-rw-r--r--doc/ruby/method.rb11
-rw-r--r--doc/ruby/mixed_names.rb9
-rw-r--r--doc/ruby/numeric.rb6
-rw-r--r--doc/ruby/object.rb6
-rw-r--r--doc/ruby/octal_integer.rb7
-rw-r--r--doc/ruby/optional_argument.rb9
-rw-r--r--doc/ruby/proc.rb13
-rw-r--r--doc/ruby/regexp.rb6
-rw-r--r--doc/ruby/required_argument.rb9
-rw-r--r--doc/ruby/shellwords.rb6
-rw-r--r--doc/ruby/short_names.rb9
-rw-r--r--doc/ruby/short_optional.rb6
-rw-r--r--doc/ruby/short_range.rb6
-rw-r--r--doc/ruby/short_required.rb6
-rw-r--r--doc/ruby/short_simple.rb9
-rw-r--r--doc/ruby/string.rb6
-rw-r--r--doc/ruby/terminator.rb6
-rw-r--r--doc/ruby/time.rb6
-rw-r--r--doc/ruby/true_class.rb6
-rw-r--r--doc/ruby/uri.rb6
41 files changed, 296 insertions, 0 deletions
diff --git a/doc/ruby/argument_keywords.rb b/doc/ruby/argument_keywords.rb
new file mode 100644
index 0000000000..8533257c67
--- /dev/null
+++ b/doc/ruby/argument_keywords.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx', :REQUIRED, 'Required argument') do |value|
+ p ['--xxx', value]
+end
+parser.parse!
diff --git a/doc/ruby/argument_strings.rb b/doc/ruby/argument_strings.rb
new file mode 100644
index 0000000000..77861dda30
--- /dev/null
+++ b/doc/ruby/argument_strings.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx', '=XXX', 'Required argument') do |value|
+ p ['--xxx', value]
+end
+parser.parse!
diff --git a/doc/ruby/argv.rb b/doc/ruby/argv.rb
new file mode 100644
index 0000000000..12495cfa1f
--- /dev/null
+++ b/doc/ruby/argv.rb
@@ -0,0 +1,2 @@
+p ARGV
+
diff --git a/doc/ruby/array.rb b/doc/ruby/array.rb
new file mode 100644
index 0000000000..7c6c14fad4
--- /dev/null
+++ b/doc/ruby/array.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--array=ARRAY', Array) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/block.rb b/doc/ruby/block.rb
new file mode 100644
index 0000000000..c4dfdeb31e
--- /dev/null
+++ b/doc/ruby/block.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx', 'Option with no argument') do |value|
+ p ['Handler block for -xxx called with value:', value]
+end
+parser.on('--yyy YYY', 'Option with required argument') do |value|
+ p ['Handler block for -yyy called with value:', value]
+end
+parser.parse!
diff --git a/doc/ruby/date.rb b/doc/ruby/date.rb
new file mode 100644
index 0000000000..5994ad6a85
--- /dev/null
+++ b/doc/ruby/date.rb
@@ -0,0 +1,6 @@
+require 'optparse/date'
+parser = OptionParser.new
+parser.on('--date=DATE', Date) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/datetime.rb b/doc/ruby/datetime.rb
new file mode 100644
index 0000000000..b9b591d5f6
--- /dev/null
+++ b/doc/ruby/datetime.rb
@@ -0,0 +1,6 @@
+require 'optparse/date'
+parser = OptionParser.new
+parser.on('--datetime=DATETIME', DateTime) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/decimal_integer.rb b/doc/ruby/decimal_integer.rb
new file mode 100644
index 0000000000..360bd284f8
--- /dev/null
+++ b/doc/ruby/decimal_integer.rb
@@ -0,0 +1,7 @@
+require 'optparse'
+include OptionParser::Acceptables
+parser = OptionParser.new
+parser.on('--decimal_integer=DECIMAL_INTEGER', DecimalInteger) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/decimal_numeric.rb b/doc/ruby/decimal_numeric.rb
new file mode 100644
index 0000000000..954da13561
--- /dev/null
+++ b/doc/ruby/decimal_numeric.rb
@@ -0,0 +1,7 @@
+require 'optparse'
+include OptionParser::Acceptables
+parser = OptionParser.new
+parser.on('--decimal_numeric=DECIMAL_NUMERIC', DecimalNumeric) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/descriptions.rb b/doc/ruby/descriptions.rb
new file mode 100644
index 0000000000..9aec80aae2
--- /dev/null
+++ b/doc/ruby/descriptions.rb
@@ -0,0 +1,15 @@
+require 'optparse'
+parser = OptionParser.new
+description = <<-EOT
+Lorem ipsum dolor sit amet, consectetuer
+adipiscing elit. Aenean commodo ligula eget.
+Aenean massa. Cum sociis natoque penatibus
+et magnis dis parturient montes, nascetur
+ridiculus mus. Donec quam felis, ultricies
+nec, pellentesque eu, pretium quis, sem.
+EOT
+descriptions = description.split($/)
+parser.on('--xxx', *descriptions) do |value|
+ p ['--xxx', value]
+end
+parser.parse!
diff --git a/doc/ruby/explicit_array_values.rb b/doc/ruby/explicit_array_values.rb
new file mode 100644
index 0000000000..64f930a4bc
--- /dev/null
+++ b/doc/ruby/explicit_array_values.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-xXXX', ['foo', 'bar'], 'Values for required argument' ) do |value|
+ p ['-x', value]
+end
+parser.on('-y [YYY]', ['baz', 'bat'], 'Values for optional argument') do |value|
+ p ['-y', value]
+end
+parser.parse!
diff --git a/doc/ruby/explicit_hash_values.rb b/doc/ruby/explicit_hash_values.rb
new file mode 100644
index 0000000000..9c9e6a48ed
--- /dev/null
+++ b/doc/ruby/explicit_hash_values.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-xXXX', {foo: 0, bar: 1}, 'Values for required argument' ) do |value|
+ p ['-x', value]
+end
+parser.on('-y [YYY]', {baz: 2, bat: 3}, 'Values for optional argument') do |value|
+ p ['-y', value]
+end
+parser.parse!
diff --git a/doc/ruby/false_class.rb b/doc/ruby/false_class.rb
new file mode 100644
index 0000000000..04fe335ede
--- /dev/null
+++ b/doc/ruby/false_class.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--false_class=FALSE_CLASS', FalseClass) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/float.rb b/doc/ruby/float.rb
new file mode 100644
index 0000000000..390df7f7bd
--- /dev/null
+++ b/doc/ruby/float.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--float=FLOAT', Float) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/integer.rb b/doc/ruby/integer.rb
new file mode 100644
index 0000000000..f10656ff1a
--- /dev/null
+++ b/doc/ruby/integer.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--integer=INTEGER', Integer) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/long_binary.rb b/doc/ruby/long_binary.rb
new file mode 100644
index 0000000000..8eccecaf3a
--- /dev/null
+++ b/doc/ruby/long_binary.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--[no-]binary') do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/long_names.rb b/doc/ruby/long_names.rb
new file mode 100644
index 0000000000..a34b3382c2
--- /dev/null
+++ b/doc/ruby/long_names.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx') do |value|
+ p ['-xxx', value]
+end
+parser.on('--y1%', '--z2#') do |value|
+ p ['--y1% or --z2#', value]
+end
+parser.parse!
diff --git a/doc/ruby/long_optional.rb b/doc/ruby/long_optional.rb
new file mode 100644
index 0000000000..38dd82166b
--- /dev/null
+++ b/doc/ruby/long_optional.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx [XXX]', 'Long name with optional argument') do |value|
+ p ['--xxx', value]
+end
+parser.parse!
diff --git a/doc/ruby/long_required.rb b/doc/ruby/long_required.rb
new file mode 100644
index 0000000000..b76c997339
--- /dev/null
+++ b/doc/ruby/long_required.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx XXX', 'Long name with required argument') do |value|
+ p ['--xxx', value]
+end
+parser.parse!
diff --git a/doc/ruby/long_simple.rb b/doc/ruby/long_simple.rb
new file mode 100644
index 0000000000..4e489c43ed
--- /dev/null
+++ b/doc/ruby/long_simple.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx', 'One long name') do |value|
+ p ['--xxx', value]
+end
+parser.on('--y1%', '--z2#', 'Two long names (aliases)') do |value|
+ p ['--y1% or --z2#', value]
+end
+parser.parse!
diff --git a/doc/ruby/matched_values.rb b/doc/ruby/matched_values.rb
new file mode 100644
index 0000000000..f184ca8474
--- /dev/null
+++ b/doc/ruby/matched_values.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx XXX', /foo/i, 'Matched values') do |value|
+ p ['--xxx', value]
+end
+parser.parse!
diff --git a/doc/ruby/method.rb b/doc/ruby/method.rb
new file mode 100644
index 0000000000..3f02ff5798
--- /dev/null
+++ b/doc/ruby/method.rb
@@ -0,0 +1,11 @@
+require 'optparse'
+parser = OptionParser.new
+def xxx_handler(value)
+ p ['Handler method for -xxx called with value:', value]
+end
+parser.on('--xxx', 'Option with no argument', method(:xxx_handler))
+def yyy_handler(value)
+ p ['Handler method for -yyy called with value:', value]
+end
+parser.on('--yyy YYY', 'Option with required argument', method(:yyy_handler))
+parser.parse!
diff --git a/doc/ruby/mixed_names.rb b/doc/ruby/mixed_names.rb
new file mode 100644
index 0000000000..e886049821
--- /dev/null
+++ b/doc/ruby/mixed_names.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx') do |value|
+ p ['--xxx', value]
+end
+parser.on('-y', '--y1%') do |value|
+ p ['--y1%', value]
+end
+parser.parse!
diff --git a/doc/ruby/numeric.rb b/doc/ruby/numeric.rb
new file mode 100644
index 0000000000..d7021f154a
--- /dev/null
+++ b/doc/ruby/numeric.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--numeric=NUMERIC', Numeric) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/object.rb b/doc/ruby/object.rb
new file mode 100644
index 0000000000..0f5ae8b922
--- /dev/null
+++ b/doc/ruby/object.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--object=OBJECT', Object) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/octal_integer.rb b/doc/ruby/octal_integer.rb
new file mode 100644
index 0000000000..b9644a076b
--- /dev/null
+++ b/doc/ruby/octal_integer.rb
@@ -0,0 +1,7 @@
+require 'optparse'
+include OptionParser::Acceptables
+parser = OptionParser.new
+parser.on('--octal_integer=OCTAL_INTEGER', OctalInteger) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/optional_argument.rb b/doc/ruby/optional_argument.rb
new file mode 100644
index 0000000000..ebff2f466d
--- /dev/null
+++ b/doc/ruby/optional_argument.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x [XXX]', '--xxx') do |value|
+ p ['--xxx', value]
+end
+parser.on('-y', '--yyy [YYY]') do |value|
+ p ['--yyy', value]
+end
+parser.parse!
diff --git a/doc/ruby/proc.rb b/doc/ruby/proc.rb
new file mode 100644
index 0000000000..9c669fdc92
--- /dev/null
+++ b/doc/ruby/proc.rb
@@ -0,0 +1,13 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on(
+ '--xxx',
+ 'Option with no argument',
+ ->(value) {p ['Handler proc for -xxx called with value:', value]}
+)
+parser.on(
+ '--yyy YYY',
+ 'Option with required argument',
+ ->(value) {p ['Handler proc for -yyy called with value:', value]}
+)
+parser.parse!
diff --git a/doc/ruby/regexp.rb b/doc/ruby/regexp.rb
new file mode 100644
index 0000000000..6aba45ce76
--- /dev/null
+++ b/doc/ruby/regexp.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--regexp=REGEXP', Regexp) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/required_argument.rb b/doc/ruby/required_argument.rb
new file mode 100644
index 0000000000..7a5a868265
--- /dev/null
+++ b/doc/ruby/required_argument.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x XXX', '--xxx') do |value|
+ p ['--xxx', value]
+end
+parser.on('-y', '--y YYY') do |value|
+ p ['--yyy', value]
+end
+parser.parse!
diff --git a/doc/ruby/shellwords.rb b/doc/ruby/shellwords.rb
new file mode 100644
index 0000000000..d181d4a4f6
--- /dev/null
+++ b/doc/ruby/shellwords.rb
@@ -0,0 +1,6 @@
+require 'optparse/shellwords'
+parser = OptionParser.new
+parser.on('--shellwords=SHELLWORDS', Shellwords) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/short_names.rb b/doc/ruby/short_names.rb
new file mode 100644
index 0000000000..6581dfe19a
--- /dev/null
+++ b/doc/ruby/short_names.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x') do |value|
+ p ['x', value]
+end
+parser.on('-1', '-%') do |value|
+ p ['-1 or -%', value]
+end
+parser.parse!
diff --git a/doc/ruby/short_optional.rb b/doc/ruby/short_optional.rb
new file mode 100644
index 0000000000..6eebf01c5f
--- /dev/null
+++ b/doc/ruby/short_optional.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x [XXX]', 'Short name with optional argument') do |value|
+ p ['-x', value]
+end
+parser.parse!
diff --git a/doc/ruby/short_range.rb b/doc/ruby/short_range.rb
new file mode 100644
index 0000000000..f5b870a4bd
--- /dev/null
+++ b/doc/ruby/short_range.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-[!-~]', 'Short names in (very large) range') do |name, value|
+ p ['!-~', name, value]
+end
+parser.parse!
diff --git a/doc/ruby/short_required.rb b/doc/ruby/short_required.rb
new file mode 100644
index 0000000000..867c02c9f5
--- /dev/null
+++ b/doc/ruby/short_required.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-xXXX', 'Short name with required argument') do |value|
+ p ['-x', value]
+end
+parser.parse!
diff --git a/doc/ruby/short_simple.rb b/doc/ruby/short_simple.rb
new file mode 100644
index 0000000000..d3d489e2dc
--- /dev/null
+++ b/doc/ruby/short_simple.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', 'One short name') do |value|
+ p ['-x', value]
+end
+parser.on('-1', '-%', 'Two short names (aliases)') do |value|
+ p ['-1 or -%', value]
+end
+parser.parse!
diff --git a/doc/ruby/string.rb b/doc/ruby/string.rb
new file mode 100644
index 0000000000..fee84a17ea
--- /dev/null
+++ b/doc/ruby/string.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--string=STRING', String) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/terminator.rb b/doc/ruby/terminator.rb
new file mode 100644
index 0000000000..c718ac1a97
--- /dev/null
+++ b/doc/ruby/terminator.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--my_option XXX') do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/time.rb b/doc/ruby/time.rb
new file mode 100644
index 0000000000..aa8b0cfa16
--- /dev/null
+++ b/doc/ruby/time.rb
@@ -0,0 +1,6 @@
+require 'optparse/time'
+parser = OptionParser.new
+parser.on('--time=TIME', Time) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/true_class.rb b/doc/ruby/true_class.rb
new file mode 100644
index 0000000000..40db9d07c5
--- /dev/null
+++ b/doc/ruby/true_class.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--true_class=TRUE_CLASS', TrueClass) do |value|
+ p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/uri.rb b/doc/ruby/uri.rb
new file mode 100644
index 0000000000..b492835b4f
--- /dev/null
+++ b/doc/ruby/uri.rb
@@ -0,0 +1,6 @@
+require 'optparse/uri'
+parser = OptionParser.new
+parser.on('--uri=URI', URI) do |value|
+ p [value, value.class]
+end
+parser.parse!