cmd.rb 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8ad36671b624aa1d94446930520fa7f61a5d88731328fa2c7f6bbf95d848a8
-  data.tar.gz: 93c450c987bbd04f0b20a068580f00e75cf41016edcc12d32dc2559eedfef6e8
+  metadata.gz: ae504e219feb435833aab29f7f826cb9f06ed900332b10e49d747d5dc490c8be
+  data.tar.gz: cb5ab27233e327950f636f645caf75dae18cf84892b3f18c6fa838df87ba65e1
 SHA512:
-  metadata.gz: c0cc266b825f3fda55713aa5967a03d239db5cbb445081d074b4293453e429aad3c2a59fe570b9fca513112ef35c34db820bb8b4a26d03a89be65d1c37d5f538
-  data.tar.gz: bf3ca72be9bb7b40ca34f5497dd33b0c7b80834756c5dc13add3963c4a3c5667117dc047ee7e6234f19b42a6baf47a8fef4cfb12ae30946b912f39c4b5397c88
+  metadata.gz: 90bbfee00e503bad9280a5c4ed0b7f361e6d99b6586c4c9663a1bd690a31dba1314c3507fa432c95a00212ee5ce5bbb6aef6bee9c3b0531c16eed51512de086b
+  data.tar.gz: f88b71a7c4a3eb4f0b8f30f23e32f76a067036967692860853fe93b02798fa3135d63135d2965d3e0753b4cac746c54d4fa83892db5cc53e5594db283d739d59

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

@@ -70,19 +70,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
-gem "cmd.rb", github: "0x1eef/cmd.rb"
-gem "ryo.rb", github: "0x1eef/ryo.rb"
+# Gemfile
+gem "cmd.rb", github: "0x1eef/cmd.rb", tag: "v0.4.0"
 ```
 
+**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.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 "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,7 +49,7 @@ module Cmd::OptionParser
     #
     # @return [void]
     def set_option(short, long, desc, as: String, default: nil)
-      option_parser.on(short, long, desc, as)
+      option_parser.on(short, long, desc, as) { _1 || true }
       set_default({ short => default, long => default })
     end
 
@@ -64,9 +64,9 @@ module Cmd::OptionParser
     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
@@ -89,6 +89,7 @@ module Cmd::OptionParser
   # 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,32 @@
+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'
+
+    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
+  end
+
+  def test_foo_no
+    options = Command.new([]).run
+    assert_equal nil, options.f
+    assert_equal nil, options.foo
+  end
+
+  def test_bar
+    options = Command.new(['-b', 'foobar']).run
+    assert_equal 'foobar', options.b
+    assert_equal 'foobar', options.bar
+  end
+end

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.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-01-30 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