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

cccb28e0de

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!

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!

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!

doc/optparse/ruby/argv.rb

@@ -0,0 +1,2 @@
+p ARGV
+

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!

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!

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

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!

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!

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!

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!

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!

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

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!

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!

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!

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!

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!

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!

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!

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!

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!

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!

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!

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!

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!

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

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!

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!

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!

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!

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!

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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/ruby/required_argument.rb

@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x XXX', '--xxx', 'Required argument via short name') do |value|
+  p ['--xxx', value]
+end
+parser.on('-y', '--y YYY', 'Required argument via long name') do |value|
+  p ['--yyy', value]
+end
+parser.parse!

doc/optparse/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!

doc/optparse/ruby/short_names.rb

@@ -0,0 +1,9 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('-x', 'Short name') do |value|
+  p ['x', value]
+end
+parser.on('-1', '-%', 'Two short names') do |value|
+  p ['-1 or -%', value]
+end
+parser.parse!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!

doc/optparse/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!