[ruby/optparse] Moved rdoc files to doc/optparse

https://github.com/ruby/optparse/commit/cccb28e0de
author: Nobuyoshi Nakada <[email protected]> 2021-04-11 09:03:07 +0900
committer: Nobuyoshi Nakada <[email protected]> 2021-04-11 09:03:36 +0900
commit: f89486965b64bc04ed49073fd5ef48390e0026d2 (patch)
tree: ecfcd779d8c3ea9cf479edd21865dff98aeec0b9 /doc/optparse/ruby
parent: cb01437c24ce3f819ef15947748e3c723b9c52c6 (diff)
47 files changed, 355 insertions, 0 deletions
diff --git a/doc/optparse/ruby/abbreviation.rb b/doc/optparse/ruby/abbreviation.rb
new file mode 100644
index 0000000000..b438c1b3dd
--- /dev/null
+++ b/doc/optparse/ruby/abbreviation.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-n', '--dry-run',) do |value|
+  p ['--dry-run', value]
+end
+parser.on('-d', '--draft',) do |value|
+  p ['--draft', value]
+end
+parser.parse!
diff --git a/doc/optparse/ruby/argument_keywords.rb b/doc/optparse/ruby/argument_keywords.rb
new file mode 100644
index 0000000000..8533257c67
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/argument_strings.rb b/doc/optparse/ruby/argument_strings.rb
new file mode 100644
index 0000000000..77861dda30
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/argv.rb b/doc/optparse/ruby/argv.rb
new file mode 100644
index 0000000000..12495cfa1f
--- /dev/null
+++ b/doc/optparse/ruby/argv.rb
@@ -0,0 +1,2 @@
+p ARGV
+
diff --git a/doc/optparse/ruby/array.rb b/doc/optparse/ruby/array.rb
new file mode 100644
index 0000000000..7c6c14fad4
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/block.rb b/doc/optparse/ruby/block.rb
new file mode 100644
index 0000000000..c4dfdeb31e
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/collected_options.rb b/doc/optparse/ruby/collected_options.rb
new file mode 100644
index 0000000000..2115e03a9a
--- /dev/null
+++ b/doc/optparse/ruby/collected_options.rb
@@ -0,0 +1,8 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx', 'Short and long, no argument')
+parser.on('-yYYY', '--yyy', 'Short and long, required argument')
+parser.on('-z [ZZZ]', '--zzz', 'Short and long, optional argument')
+options = {}
+parser.parse!(into: options)
+p options
diff --git a/doc/optparse/ruby/custom_converter.rb b/doc/optparse/ruby/custom_converter.rb
new file mode 100644
index 0000000000..029da08c46
--- /dev/null
+++ b/doc/optparse/ruby/custom_converter.rb
@@ -0,0 +1,9 @@
+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!
diff --git a/doc/optparse/ruby/date.rb b/doc/optparse/ruby/date.rb
new file mode 100644
index 0000000000..5994ad6a85
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/datetime.rb b/doc/optparse/ruby/datetime.rb
new file mode 100644
index 0000000000..b9b591d5f6
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/decimal_integer.rb b/doc/optparse/ruby/decimal_integer.rb
new file mode 100644
index 0000000000..360bd284f8
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/decimal_numeric.rb b/doc/optparse/ruby/decimal_numeric.rb
new file mode 100644
index 0000000000..954da13561
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/default_values.rb b/doc/optparse/ruby/default_values.rb
new file mode 100644
index 0000000000..24c26faea2
--- /dev/null
+++ b/doc/optparse/ruby/default_values.rb
@@ -0,0 +1,8 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx', 'Short and long, no argument')
+parser.on('-yYYY', '--yyy', 'Short and long, required argument')
+parser.on('-z [ZZZ]', '--zzz', 'Short and long, optional argument')
+options = {yyy: 'AAA', zzz: 'BBB'}
+parser.parse!(into: options)
+p options
diff --git a/doc/optparse/ruby/descriptions.rb b/doc/optparse/ruby/descriptions.rb
new file mode 100644
index 0000000000..9aec80aae2
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/explicit_array_values.rb b/doc/optparse/ruby/explicit_array_values.rb
new file mode 100644
index 0000000000..64f930a4bc
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/explicit_hash_values.rb b/doc/optparse/ruby/explicit_hash_values.rb
new file mode 100644
index 0000000000..9c9e6a48ed
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/false_class.rb b/doc/optparse/ruby/false_class.rb
new file mode 100644
index 0000000000..04fe335ede
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/float.rb b/doc/optparse/ruby/float.rb
new file mode 100644
index 0000000000..390df7f7bd
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/integer.rb b/doc/optparse/ruby/integer.rb
new file mode 100644
index 0000000000..f10656ff1a
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/long_names.rb b/doc/optparse/ruby/long_names.rb
new file mode 100644
index 0000000000..a49dbda69f
--- /dev/null
+++ b/doc/optparse/ruby/long_names.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--xxx', 'Long name') do |value|
+  p ['-xxx', value]
+end
+parser.on('--y1%', '--z2#', "Two long names") do |value|
+  p ['--y1% or --z2#', value]
+end
+parser.parse!
diff --git a/doc/optparse/ruby/long_optional.rb b/doc/optparse/ruby/long_optional.rb
new file mode 100644
index 0000000000..38dd82166b
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/long_required.rb b/doc/optparse/ruby/long_required.rb
new file mode 100644
index 0000000000..b76c997339
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/long_simple.rb b/doc/optparse/ruby/long_simple.rb
new file mode 100644
index 0000000000..4e489c43ed
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/long_with_negation.rb b/doc/optparse/ruby/long_with_negation.rb
new file mode 100644
index 0000000000..3f2913c361
--- /dev/null
+++ b/doc/optparse/ruby/long_with_negation.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--[no-]binary', 'Long name with negation') do |value|
+  p [value, value.class]
+end
+parser.parse!
diff --git a/doc/optparse/ruby/matched_values.rb b/doc/optparse/ruby/matched_values.rb
new file mode 100644
index 0000000000..f184ca8474
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/method.rb b/doc/optparse/ruby/method.rb
new file mode 100644
index 0000000000..3f02ff5798
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/missing_options.rb b/doc/optparse/ruby/missing_options.rb
new file mode 100644
index 0000000000..9428463cfd
--- /dev/null
+++ b/doc/optparse/ruby/missing_options.rb
@@ -0,0 +1,12 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx', 'Short and long, no argument')
+parser.on('-yYYY', '--yyy', 'Short and long, required argument')
+parser.on('-z [ZZZ]', '--zzz', 'Short and long, optional argument')
+options = {}
+parser.parse!(into: options)
+required_options = [:xxx, :zzz]
+missing_options = required_options - options.keys
+unless missing_options.empty?
+  fail "Missing required options: #{missing_options}"
+end
diff --git a/doc/optparse/ruby/mixed_names.rb b/doc/optparse/ruby/mixed_names.rb
new file mode 100644
index 0000000000..67f81e7e8d
--- /dev/null
+++ b/doc/optparse/ruby/mixed_names.rb
@@ -0,0 +1,12 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', '--xxx', 'Short and long, no argument') do |value|
+  p ['--xxx', value]
+end
+parser.on('-yYYY', '--yyy', 'Short and long, required argument') do |value|
+  p ['--yyy', value]
+end
+parser.on('-z [ZZZ]', '--zzz', 'Short and long, optional argument') do |value|
+  p ['--zzz', value]
+end
+parser.parse!
diff --git a/doc/optparse/ruby/no_abbreviation.rb b/doc/optparse/ruby/no_abbreviation.rb
new file mode 100644
index 0000000000..5464492705
--- /dev/null
+++ b/doc/optparse/ruby/no_abbreviation.rb
@@ -0,0 +1,10 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-n', '--dry-run',) do |value|
+  p ['--dry-run', value]
+end
+parser.on('-d', '--draft',) do |value|
+  p ['--draft', value]
+end
+parser.require_exact = true
+parser.parse!
diff --git a/doc/optparse/ruby/numeric.rb b/doc/optparse/ruby/numeric.rb
new file mode 100644
index 0000000000..d7021f154a
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/object.rb b/doc/optparse/ruby/object.rb
new file mode 100644
index 0000000000..0f5ae8b922
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/octal_integer.rb b/doc/optparse/ruby/octal_integer.rb
new file mode 100644
index 0000000000..b9644a076b
--- /dev/null
+++ b/doc/optparse/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/optparse/ruby/optional_argument.rb b/doc/optparse/ruby/optional_argument.rb
new file mode 100644
index 0000000000..456368a8ba
--- /dev/null
+++ b/doc/optparse/ruby/optional_argument.rb
@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x [XXX]', '--xxx', 'Optional argument via short  name') do |value|
+  p ['--xxx', value]
+end
+parser.on('-y', '--yyy [YYY]', 'Optional argument via long name') do |value|
+  p ['--yyy', value]
+end
+parser.parse!
diff --git a/doc/optparse/ruby/proc.rb b/doc/optparse/ruby/proc.rb
new file mode 100644
index 0000000000..9c669fdc92
--- /dev/null
+++ b/
author	Nobuyoshi Nakada <[email protected]>	2021-04-11 09:03:07 +0900
committer	Nobuyoshi Nakada <[email protected]>	2021-04-11 09:03:36 +0900
commit	f89486965b64bc04ed49073fd5ef48390e0026d2 (patch)
tree	ecfcd779d8c3ea9cf479edd21865dff98aeec0b9 /doc/optparse/ruby
parent	cb01437c24ce3f819ef15947748e3c723b9c52c6 (diff)