cmd.rb 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8ad36671b624aa1d94446930520fa7f61a5d88731328fa2c7f6bbf95d848a8
-  data.tar.gz: 93c450c987bbd04f0b20a068580f00e75cf41016edcc12d32dc2559eedfef6e8
+  metadata.gz: 34d12924cba02103e5b13c1581d948f3fc862a588b452aef90b9797ab7bd605b
+  data.tar.gz: c7a4aa7d0266f6c2ed91c6268189310462135b465d4d6a8cfcbb5b170b360480
 SHA512:
-  metadata.gz: c0cc266b825f3fda55713aa5967a03d239db5cbb445081d074b4293453e429aad3c2a59fe570b9fca513112ef35c34db820bb8b4a26d03a89be65d1c37d5f538
-  data.tar.gz: bf3ca72be9bb7b40ca34f5497dd33b0c7b80834756c5dc13add3963c4a3c5667117dc047ee7e6234f19b42a6baf47a8fef4cfb12ae30946b912f39c4b5397c88
+  metadata.gz: d98a6f7bcd51310076ec57fc8947f7d6922b5402a5e0aac5432174fb2db6cfc44e19e07b7e5f11f87eaffb31eb050774891f9f46cd1ab70a9102e36407c5abea
+  data.tar.gz: 7b4620b67fd778a0f01d61dffb5b5dfde52aa10e92fdf15feb655f132638a3a26d0339840543d50665ec128c8a4a28c5d50508c672d59dfb636ef738175a37fe

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: ".gems"

data/.projectile

@@ -1,2 +1,2 @@
--.localgems/
+-.gems/
 -doc/

data/Gemfile

@@ -1,6 +1,3 @@
 source "https://rubygems.org"
 gemspec
-gem "optparse", github: "ruby/optparse"
-gem "ryo.rb", "~> 0.4", github: "0x1eef/ryo.rb", tag: "v0.4.2"
-gem "test-cmd.rb", "~> 0.2", github: "0x1eef/test-cmd.rb"
 gem "webrick"

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**
 
@@ -70,19 +71,25 @@ Options:
 
 ## Install
 
+**Git**
+
 cmd.rb is distributed as a RubyGem through its git repositories. <br>
 [GitHub](https://github.com/0x1eef/cmd.rb),
 and
 [GitLab](https://gitlab.com/0x1eef/cmd.rb)
 are available as sources.
 
-**Gemfile**
-
 ```ruby
+# Gemfile
 gem "cmd.rb", github: "0x1eef/cmd.rb"
-gem "ryo.rb", github: "0x1eef/ryo.rb"
 ```
 
+**Rubygems.org**
+
+cmd.rb can also be installed via rubygems.org.
+
+    gem install cmd.rb
+
 ## <a id="license"> License </a>
 
 [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).

data/Rakefile.rb

@@ -1,3 +1,4 @@
+require "bundler/setup"
 require "rake/testtask"
 
 Rake::TestTask.new do |t|

data/VERSION

@@ -1 +1 @@
-v0.3.3
+v0.4.1

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 "optparse", "~> 0.3"
+  gem.add_runtime_dependency "cli-option_parser.rb", "~> 0.5"
   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/{mixins → mixin}/argv.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 ##
-# The {Cmd::ARGV} module provides an initialize method, and an
-# attribute reader for an array of strings (usually ARGV). Classes
-# who include the {Cmd Cmd} module indirectly include this module as
-# well.
-module Cmd::ARGV
+# The {Cmd::Mixin::ARGV Cmd::Mixin::ARGV} module provides
+# an initialize method, and an attribute reader for an
+# array of strings (usually ARGV).
+module Cmd::Mixin::ARGV
   ##
   # @return [Array<String>]
   #  Returns an array of strings.

data/lib/cmd/{mixins → mixin}/help.rb

@@ -1,5 +1,5 @@
 
-module Cmd::Help
+module Cmd::Mixin::Help
   def show_help(io = $stdout)
     banner = self.class.banner
     io.puts "Usage: #{banner.usage}\n\n" \

data/lib/cmd/{mixins → mixin}/option_parser.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "optparse"
-require "ryo"
-
 ##
-# The {Cmd::OptionParser Cmd::OptionParser} module provides a light wrapper
-# around Ruby's
+# The {Cmd::Mixin::OptionParser Cmd::Mixin::OptionParser} module enhances
+# the functionality of Ruby's
 # [OptionParser](https://docs.ruby-lang.org/en/3.2/OptionParser.html)
 # class.
-module Cmd::OptionParser
+module Cmd::Mixin::OptionParser
+  require "cli-option_parser"
+  require "ryo"
+
   def self.included(klass)
     klass.extend(ClassMethods)
   end
@@ -49,8 +49,15 @@ module Cmd::OptionParser
     #
     # @return [void]
     def set_option(short, long, desc, as: String, default: nil)
-      option_parser.on(short, long, desc, as)
-      set_default({ short => default, long => default })
+      option_parser.on(short, long, desc, as) do |v|
+        switch = __switch_search(short, long)
+        v || __optional_switches.any? { _1 === switch } ? v : true
+      end
+      switch = option_parser.top.list[-1]
+      set_default({
+        switch.short[0][1..] => default,
+        switch.long[0][2..] => default
+      })
     end
 
     ##
@@ -60,13 +67,17 @@ module Cmd::OptionParser
     #
     # @return [void]
     def set_default(defaults)
-      @defaults = Ryo.from(defaults)
+      if @defaults
+        Ryo.assign(@defaults, defaults)
+      else
+        @defaults = Ryo.from(defaults)
+      end
     end
 
     ##
-    # (see Cmd::OptionParser#option_parser)
+    # (see Cmd::Mixin::OptionParser#option_parser)
     def option_parser
-      @option_parser ||= ::OptionParser.new(nil, 26, " " * 2).tap do
+      @option_parser ||= CLI::OptionParser.new(nil, 26, " " * 2).tap do
         _1.banner = ""
         _1.on("-h", "--help", "Show help")
       end
@@ -83,12 +94,31 @@ module Cmd::OptionParser
     def defaults
       @defaults ||= Ryo({})
     end
+
+    ##
+    # @private
+    def __switch_search(short, long)
+      option_parser.top.list.find do |s|
+        s.short[0] == short[/[^\s]*/] &&
+        s.long[0] == long[/[^\s*]*/]
+      end
+    end
+
+    ##
+    # @private
+    def __optional_switches
+      [
+        CLI::OptionParser::Switch::PlacedArgument,
+        CLI::OptionParser::Switch::OptionalArgument
+      ]
+    end
   end
 
   ##
   # Parses an array of strings with
   # [OptionParser#parse](https://docs.ruby-lang.org/en/3.2/OptionParser.html#method-i-parse).
   #
+
   # @param [Array<String>] argv
   #  An array of strings
   #

data/lib/cmd/mixin.rb

@@ -0,0 +1,5 @@
+module Cmd::Mixin
+  require_relative "mixin/help"
+  require_relative "mixin/argv"
+  require_relative "mixin/option_parser"
+end

data/lib/cmd.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
 class Cmd
-  require_relative "cmd/mixins/argv"
-  require_relative "cmd/mixins/help"
-  require_relative "cmd/mixins/option_parser"
+  require_relative "cmd/mixin"
 
-  include ARGV
-  include Help
+  include Mixin::ARGV
+  include Mixin::Help
 
   def self.inherited(klass)
-    klass.class_eval { include(OptionParser) }
+    klass.class_eval { include(Mixin::OptionParser) }
   end
 end

data/test/cmd_test.rb

@@ -0,0 +1,66 @@
+require_relative "setup"
+
+class CmdTest < Test::Unit::TestCase
+  class Command < Cmd
+    set_banner usage: "test [OPTIONS]",
+               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_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
+
+  ##
+  # 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_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

data/test/setup.rb

@@ -3,3 +3,4 @@
 require "bundler/setup"
 require "test-unit"
 require "test-cmd"
+require "cmd"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmd.rb
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ryo.rb
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: optparse
+  name: cli-option_parser.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -129,13 +129,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".projectile"
 - ".rubocop.yml"
-- ".yardoc-template/default/fulldoc/html/css/0x1eef.css"
-- ".yardoc-template/default/layout/html/setup.rb"
-- ".yardoc-template/default/module/setup.rb"
 - ".yardopts"
 - Gemfile
 - LICENSE
@@ -144,11 +142,13 @@ files:
 - VERSION
 - cmd.rb.gemspec
 - lib/cmd.rb
-- lib/cmd/mixins/argv.rb
-- lib/cmd/mixins/help.rb
-- lib/cmd/mixins/option_parser.rb
+- lib/cmd/mixin.rb
+- lib/cmd/mixin/argv.rb
+- lib/cmd/mixin/help.rb
+- lib/cmd/mixin/option_parser.rb
 - share/examples/cmd.rb/ls
 - share/examples/cmd.rb/setup.rb
+- test/cmd_test.rb
 - test/fakefs/.gitkeep
 - test/fakefs/dev/.gitkeep
 - test/fakefs/etc/.gitkeep
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A library for building command-line applications, in Ruby.

data/.yardoc-template/default/fulldoc/html/css/0x1eef.css

@@ -1,15 +0,0 @@
-#main #content #filecontents p, .discussion p {
-  max-width: 768px;
-}
-
-#toc {
-  position: fixed;
-  right: 25px;
-  display: none;
-}
-
-@media screen and (min-width: 1280px) {
-  #toc {
-    display: block;
-  }
-}

data/.yardoc-template/default/layout/html/setup.rb

@@ -1,5 +0,0 @@
-def stylesheets
-  s = super
-  s << "css/0x1eef.css"
-  s
-end

data/.yardoc-template/default/module/setup.rb

@@ -1,7 +0,0 @@
-##
-# Sort methods in ascending order based
-# on the line number where a method is
-# defined.
-def sort_listing(listing)
-  listing.sort_by { _1.files[1] }
-end