cmd.rb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae504e219feb435833aab29f7f826cb9f06ed900332b10e49d747d5dc490c8be
-  data.tar.gz: cb5ab27233e327950f636f645caf75dae18cf84892b3f18c6fa838df87ba65e1
+  metadata.gz: f520a73aaf3d0510069fb97555c4ec0510924906f7371bc205843ae27cdcdd27
+  data.tar.gz: 3e7b0ed7b8b0452ea9a1bab642aacd927fc1bfb3698e905b201020883ca3e364
 SHA512:
-  metadata.gz: 90bbfee00e503bad9280a5c4ed0b7f361e6d99b6586c4c9663a1bd690a31dba1314c3507fa432c95a00212ee5ce5bbb6aef6bee9c3b0531c16eed51512de086b
-  data.tar.gz: f88b71a7c4a3eb4f0b8f30f23e32f76a067036967692860853fe93b02798fa3135d63135d2965d3e0753b4cac746c54d4fa83892db5cc53e5594db283d739d59
+  metadata.gz: ca15e636c297e708d37a669f5508014915295a9aabccbc9d383916fc2534f8b209e12f0530c502a2c4732fc3caebe8a92722c7f4771ce960b64385fe48ae797d
+  data.tar.gz: df656157cf58c6bbc2b2a1abb65b1b9ca73641db17a70c25506b4a36c1e47062d86aaf73f5a1116075ee7ac994da09a9f2c031da1c430ac92e865c5586975034

data/README.md

@@ -12,7 +12,8 @@ option parsing implementation is delegated to
 
 The following example demonstrates a simple command that is
 implemented with `Dir.entries`. The command accepts two options
-that have fallback default values set:
+that have fallback default values set for when an option is not
+given:
 
 **Definition**
 
@@ -28,7 +29,7 @@ class Ls < Cmd
 
   def run
     options = parse_options(argv)
-    options.help ? show_help : run_command(options)
+    run_command(options)
   end
 
   private
@@ -80,7 +81,7 @@ are available as sources.
 
 ```ruby
 # Gemfile
-gem "cmd.rb", github: "0x1eef/cmd.rb", tag: "v0.4.0"
+gem "cmd.rb", github: "0x1eef/cmd.rb"
 ```
 
 **Rubygems.org**

data/VERSION

@@ -1 +1 @@
-v0.4.0
+v0.5.0

data/cmd.rb.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.summary = "A library for building command-line applications, in Ruby."
   gem.description = gem.summary
   gem.add_runtime_dependency "ryo.rb", "~> 0.4"
-  gem.add_runtime_dependency "cli-option_parser.rb", "~> 0.5"
+  gem.add_runtime_dependency "cli-option_parser.rb", "~> 0.6"
   gem.add_development_dependency "test-unit", "~> 3.5.7"
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"

data/lib/cmd/mixin/option_parser/finder.rb

@@ -0,0 +1,23 @@
+module Cmd::Mixin::OptionParser
+  module Finder
+    extend self
+    ##
+    # @param [CLI::OptionParser] option_parser
+    #  An instance of CLI::OptionParser.
+    #
+    # @param [String] short
+    #  Short option.
+    #
+    # @param [String] long
+    #  Long option.
+    #
+    # @return [CLI::OptionParser::Switch, nil]
+    #  Returns a Switch, or nil.
+    def find(option_parser, short:, long:)
+      option_parser.top.list.find do |s|
+        s.short[0] == short[/[^\s]*/] &&
+        s.long[0] == long[/[^\s*]*/]
+      end
+    end
+  end
+end

data/lib/cmd/mixin/option_parser.rb

@@ -6,6 +6,7 @@
 # [OptionParser](https://docs.ruby-lang.org/en/3.2/OptionParser.html)
 # class.
 module Cmd::Mixin::OptionParser
+  require_relative "option_parser/finder"
   require "cli-option_parser"
   require "ryo"
 
@@ -49,8 +50,16 @@ module Cmd::Mixin::OptionParser
     #
     # @return [void]
     def set_option(short, long, desc, as: String, default: nil)
-      option_parser.on(short, long, desc, as) { _1 || true }
-      set_default({ short => default, long => default })
+      option_parser.on(short, long, desc, as) do |v|
+        switch = Finder.find(option_parser, short:, long:)
+        is_optional = option_parser.optional_switches.any? { _1 === switch }
+        v || is_optional ? v : true
+      end
+      switch = option_parser.top.list[-1]
+      set_default({
+        switch.short[0][1..] => default,
+        switch.long[0][2..] => default
+      })
     end
 
     ##
@@ -60,7 +69,11 @@ module Cmd::Mixin::OptionParser
     #
     # @return [void]
     def set_default(defaults)
-      @defaults = Ryo.from(defaults)
+      if @defaults
+        Ryo.assign(@defaults, defaults)
+      else
+        @defaults = Ryo.from(defaults)
+      end
     end
 
     ##

data/lib/cmd.rb

@@ -7,6 +7,14 @@ class Cmd
   include Mixin::Help
 
   def self.inherited(klass)
-    klass.class_eval { include(Mixin::OptionParser) }
+    klass.class_eval do
+      include Mixin::OptionParser
+      prepend Module.new {
+        def run(...)
+          options = parse_options(argv)
+          options.help ? show_help : super(...)
+        end
+      }
+    end
   end
 end

data/share/examples/cmd.rb/ls

@@ -11,7 +11,7 @@ class Ls < Cmd
 
   def run
     options = parse_options(argv)
-    options.help ? show_help : run_command(options)
+    run_command(options)
   end
 
   private

data/test/cmd_test.rb

@@ -3,30 +3,64 @@ require_relative "setup"
 class CmdTest < Test::Unit::TestCase
   class Command < Cmd
     set_banner usage: "test [OPTIONS]",
-               description: "..."
-    set_option '-f', '--foo', 'An option without an argument'
-    set_option '-b=ARG', '--bar=ARG', 'An option with an argument'
+               description: "A test program"
+    set_option '-x', '--xarg', 'An option without an argument'
+    set_option '-y ARG', '--yarg ARG', 'An option with a required argument'
+    set_option '-z [ARG]', '--zarg [ARG]', 'An option with an optional argument'
 
     def run
       parse_options(argv)
     end
   end
 
-  def test_foo_yes
-    options = Command.new(['-f']).run
-    assert_equal true, options.f
-    assert_equal true, options.foo
+  def test_none_given
+    options = Command.new([]).run
+    [options.x, options.xarg,
+     options.y, options.yarg,
+     options.z, options.zarg].each do
+      assert_equal nil, _1
+    end
   end
 
-  def test_foo_no
-    options = Command.new([]).run
-    assert_equal nil, options.f
-    assert_equal nil, options.foo
+  ##
+  # No argument option
+  # -x, --xarg
+
+  def test_xarg_given
+    options = Command.new(['-x']).run
+    assert_equal true, options.x
+    assert_equal true, options.xarg
+  end
+
+  ##
+  # Required argument option
+  # -y ARG, --yarg ARG
+
+  def test_yarg_given
+    options = Command.new(['-y', 'required-argument']).run
+    assert_equal 'required-argument', options.y
+    assert_equal 'required-argument', options.yarg
+  end
+
+  def test_yarg_missing_argument
+    assert_raises(CLI::OptionParser::MissingArgument) do
+      Command.new(['-y']).run
+    end
+  end
+
+  ##
+  # Optional argument option
+  # -z [ARG], --zarg [ARG]
+
+  def test_zarg_given
+    options = Command.new(['-z', 'optional-argument']).run
+    assert_equal 'optional-argument', options.z
+    assert_equal 'optional-argument', options.zarg
   end
 
-  def test_bar
-    options = Command.new(['-b', 'foobar']).run
-    assert_equal 'foobar', options.b
-    assert_equal 'foobar', options.bar
+  def test_zarg_missing_argument
+    options = Command.new(['-z']).run
+    assert_equal nil, options.z
+    assert_equal nil, options.zarg
   end
 end

data/test/readme_examples_test.rb

@@ -3,8 +3,6 @@
 require_relative "setup"
 
 class READMETest < Test::Unit::TestCase
-  include Test::Cmd
-
   def test_ls_command
     assert_equal "dev\netc\nhome\n",
                  run_example("ls --directory test/fakefs/ --grep [^.gitkeep]").stdout

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmd.rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ryo.rb
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +146,7 @@ files:
 - lib/cmd/mixin/argv.rb
 - lib/cmd/mixin/help.rb
 - lib/cmd/mixin/option_parser.rb
+- lib/cmd/mixin/option_parser/finder.rb
 - share/examples/cmd.rb/ls
 - share/examples/cmd.rb/setup.rb
 - test/cmd_test.rb