benry-cmdopt 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5cc6fe56fade46613abc3f6d3c7430ec0585a9c21535e478debe20500829c0
-  data.tar.gz: eeb5e6c9d78008b92a68662d55c6c45f9fbb4cacb983f66667db32fa537855f8
+  metadata.gz: 5e37b3eb5a8294bfae3627f384720f843e2c6ae9c79ec0cc704b732368d46437
+  data.tar.gz: 3a3b34226485ae5c0aaa3f3b90d6ba281b34f7843d5e03179235784af0fc2467
 SHA512:
-  metadata.gz: 84af5c4bc66e2066213dcc907c3fd2e1cb380278552a4e5e900c256e95fc10f6a1f2d2127a995fd5f1496f0bb239f1e1c68afe06536300d180c530a5196a0b89
-  data.tar.gz: dd51bc08bd53742b5556f47887bd9a80ffac505608b5d79a55aa53d4a5023d5472f9b7015bf3f6144456695edbe793e5fb80878432b25a59ed0b4dfa2885c782
+  metadata.gz: f1aae8384f952ddbc0ba5408e39e5b289d09c9b9e768a4cee237c723d7f0bef459b2ab7c8e3639705e8495790fb02bb6fced99bf9a3676e772d4b0c2d622961d
+  data.tar.gz: 737074f681fa450d2e0fc9b82b85aedba8088db313b522c32b1c01cae6a68ed091da08ca437f58e543b0a6d896618c42a078ded25bba9fba971c3e3ec90bc82f

data/CHANGES.md

@@ -2,6 +2,21 @@ CHANGES
 =======
 
 
+Release 2.1.0 (2023-10-15)
+--------------------------
+
+* [enhance] Add `hidden: true` keyword argument to `Benry::Schema#add()` and `Benry::Facade#add()`. This keyword argument makes the option as hidden option.
+* [change] Option which name stars with '_' is now not regarded as hidden option. Use `hidden: true` instead.
+* [enhance] Add `important: (true|false)` keyword argument to `Benry::Schema#add()` and `Benry::Facade#add()`. This keyword argument makes help message of the option printed in decorated format.
+
+
+Release 2.0.2 (2023-10-12)
+--------------------------
+
+* [change] remove unnecessary files from gem.
+* [bugfix] fix to add missing test cases.
+
+
 Release 2.0.1 (2023-10-11)
 --------------------------
 

data/README.md

@@ -1,6 +1,6 @@
 # Benry-CmdOpt
 
-($Release: 2.0.1 $)
+($Release: 2.1.0 $)
 
 
 
@@ -38,6 +38,7 @@ Benry-CmdOpt requires Ruby >= 2.3.
   * [Global Options with Sub-Commands](#global-options-with-sub-commands)
   * [Detailed Description of Option](#detailed-description-of-option)
   * [Option Tag](#option-tag)
+  * [Important Options](#important-options)
   * [Not Supported](#not-supported)
 * [Internal Classes](#internal-classes)
 * [License and Copyright](#license-and-copyright)
@@ -470,22 +471,20 @@ p options   #=> {:lib=>["foo", "bar", "baz"]}
 
 Benry-CmdOpt regards the following options as hidden.
 
-* Key name starts with `_` (for example `:_debug`).
+* Keyword argument `hidden: true` is passed to `.add()` method.
 * Or description is nil.
 
-The former is better than the latter, because even hidden option should have its own description.
-
-These hidden options are not included in help message.
+Hidden options are not included in help message.
 
 ```ruby
 require 'benry/cmdopt'
 cmdopt = Benry::CmdOpt.new
-cmdopt.add(:help , '-h', "help message")
-cmdopt.add(:debug, '-D', nil)       # hidden (because description is nil)
-cmdopt.add(:_log , '-L', "logging") # hidden (because key starts with '_')
+cmdopt.add(:help   , '-h', "help message")
+cmdopt.add(:logging, '-L', "logging", hidden: true)  # hidden
+cmdopt.add(:debug  , '-D', nil)                      # hidden (desc is nil)
 puts cmdopt.to_s()
 
-### output (neither '-D' nor '-L' is shown because hidden options)
+### output (neither '-L' nor '-D' is shown because hidden options)
 #  -h             : help message
 ```
 
@@ -497,8 +496,8 @@ puts cmdopt.to_s(all: true)   # or: cmdopt.to_s(nil, all: true)
 
 ### output
 #  -h             : help message
-#  -D             :
 #  -L             : logging
+#  -D             : 
 ```
 
 
@@ -613,11 +612,37 @@ end
 ```
 
 
+### Important Options
+
+You can specify that the option is important or not.
+Pass `important: true` or `important: false` keyword argument to `#add()` method of `Benry::CmdOpt` or `Benry::CmdOpt::Schema` object.
+
+The help message of options is decorated according to value of `important:` keyword argument.
+
+* Printed in bold font when `important: true` specified to the option.
+* Printed in gray color when `important: false` specified to the option.
+
+```ruby
+require 'benry/cmdopt'
+
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:help   , "-h", "help message")
+cmdopt.add(:verbose, "-v", "verbose mode", important: true)   # !!!
+cmdopt.add(:debug  , "-D", "debug mode"  , important: false)  # !!!
+puts cmdopt.option_help()
+
+## output:
+#  -h       : help message
+#  -v       : verbose mode      # bold font
+#  -D       : debug mode        # gray color
+```
+
+
 ### Not Supported
 
-* default value
+* default value when the option not specified in command-line
 * `--no-xxx` style option
-* bash/zsh completion
+* bash/zsh completion (may be supported in the future)
 * I18N of error message (may be supported in the future)
 
 

data/benry-cmdopt.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name            = "benry-cmdopt"
-  spec.version         = "$Release: 2.0.1 $".split()[1]
+  spec.version         = "$Release: 2.1.0 $".split()[1]
   spec.author          = "kwatch"
   spec.email           = "kwatch@gmail.com"
   spec.platform        = Gem::Platform::RUBY
@@ -16,10 +16,9 @@ END
   spec.license         = "MIT"
   spec.files           = Dir[
                            "README.md", "MIT-LICENSE", "CHANGES.md",
-                           "Rakefile.rb", "#{spec.name}.gemspec",
-                           "lib/**/*.rb", "test/**/*.rb", "task/**/*.rb",
-                           #"bin/*", "examples/**/*",
-                           "doc/*.html", "doc/css/*",
+                           "#{spec.name}.gemspec",
+                           "lib/**/*.rb", "test/**/*.rb", #"bin/*", "examples/**/*",
+                           "doc/*.html", "doc/css/*.css",
                          ]
   #spec.executables     = []
   spec.bindir          = "bin"

data/doc/benry-cmdopt.html

@@ -21,7 +21,7 @@
   <ul class="nav">
   </ul>
 </nav>
-<p>($Release: 2.0.1 $)</p>
+<p>($Release: 2.1.0 $)</p>
 <section class="section" id="whats-this">
 <h2>What's This?</h2>
 <p>Benry-CmdOpt is a command option parser library, like <code>optparse.rb</code>
@@ -53,6 +53,7 @@ and easy to understahnd.</p>
 <li><a href="#global-options-with-sub-commands">Global Options with Sub-Commands</a></li>
 <li><a href="#detailed-description-of-option">Detailed Description of Option</a></li>
 <li><a href="#option-tag">Option Tag</a></li>
+<li><a href="#important-options">Important Options</a></li>
 <li><a href="#not-supported">Not Supported</a></li>
 </ul></li>
 <li><a href="#internal-classes">Internal Classes</a></li>
@@ -462,20 +463,19 @@ p options   #=&gt; <strong>{:lib=&gt;["foo", "bar", "baz"]}</strong>
 <h3>Hidden Option</h3>
 <p>Benry-CmdOpt regards the following options as hidden.</p>
 <ul>
-<li>Key name starts with <code>_</code> (for example <code>:_debug</code>).</li>
+<li>Keyword argument <code>hidden: true</code> is passed to <code>.add()</code> method.</li>
 <li>Or description is nil.</li>
 </ul>
-<p>The former is better than the latter, because even hidden option should have its own description.</p>
-<p>These hidden options are not included in help message.</p>
+<p>Hidden options are not included in help message.</p>
 <pre class="language-ruby">
 require 'benry/cmdopt'
 cmdopt = Benry::CmdOpt.new
-cmdopt.add(:help , '-h', "help message")
-cmdopt.add(:debug, '-D', <strong>nil</strong>)       # hidden (because description is nil)
-cmdopt.add(<strong>:_log</strong> , '-L', "logging") # hidden (because key starts with '_')
+cmdopt.add(:help   , '-h', "help message")
+cmdopt.add(:logging, '-L', "logging", <strong>hidden: true</strong>)  # hidden
+cmdopt.add(:debug  , '-D', <strong>nil</strong>)                      # hidden (desc is nil)
 puts cmdopt.to_s()
 
-### output (neither '-D' nor '-L' is shown because hidden options)
+### output (neither '-L' nor '-D' is shown because hidden options)
 #  -h             : help message
 </pre>
 <p>To show all options including hidden ones, add <code>all: true</code> to <code>cmdopt.to_s()</code>.</p>
@@ -485,8 +485,8 @@ puts cmdopt.to_s(<strong>all: true</strong>)   # or: cmdopt.to_s(nil, all: true)
 
 ### output
 #  -h             : help message
-#  <strong>-D             :</strong>
 #  <strong>-L             : logging</strong>
+#  <strong>-D             : </strong>
 </pre>
 </section>
 <section class="subsection" id="global-options-with-sub-commands">
@@ -591,12 +591,36 @@ end
 #version: <strong>tag=nil</strong>
 </pre>
 </section>
+<section class="subsection" id="important-options">
+<h3>Important Options</h3>
+<p>You can specify that the option is important or not.
+Pass <code>important: true</code> or <code>important: false</code> keyword argument to <code>#add()</code> method of <code>Benry::CmdOpt</code> or <code>Benry::CmdOpt::Schema</code> object.</p>
+<p>The help message of options is decorated according to value of <code>important:</code> keyword argument.</p>
+<ul>
+<li>Printed in bold font when <code>important: true</code> specified to the option.</li>
+<li>Printed in gray color when <code>important: false</code> specified to the option.</li>
+</ul>
+<pre class="language-ruby">
+require 'benry/cmdopt'
+
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:help   , "-h", "help message")
+cmdopt.add(:verbose, "-v", "verbose mode", <strong>important: true</strong>)   # !!!
+cmdopt.add(:debug  , "-D", "debug mode"  , <strong>important: false</strong>)  # !!!
+puts cmdopt.option_help()
+
+## output:
+#  -h       : help message
+#  -v       : verbose mode      # bold font
+#  -D       : debug mode        # gray color
+</pre>
+</section>
 <section class="subsection" id="not-supported">
 <h3>Not Supported</h3>
 <ul>
-<li>default value</li>
+<li>default value when the option not specified in command-line</li>
 <li><code>--no-xxx</code> style option</li>
-<li>bash/zsh completion</li>
+<li>bash/zsh completion (may be supported in the future)</li>
 <li>I18N of error message (may be supported in the future)</li>
 </ul>
 </section>

data/lib/benry/cmdopt.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 ###
-### $Release: 2.0.1 $
+### $Release: 2.1.0 $
 ### $Copyright: copyright(c) 2021 kwatch@gmail.com $
 ### $License: MIT License $
 ###
@@ -23,7 +23,7 @@ end
 module Benry::CmdOpt
 
 
-  VERSION = '$Release: 2.0.1 $'.split()[1]
+  VERSION = '$Release: 2.1.0 $'.split()[1]
 
 
   def self.new()
@@ -40,11 +40,11 @@ module Benry::CmdOpt
 
     attr_reader :schema
 
-    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, detail: nil, tag: nil, &callback)
+    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
       rexp ||= pattern    # for backward compatibility
       #; [!vmb3r] defines command option.
       #; [!71cvg] type, rexp, enum, and range are can be passed as positional args as well as keyword args.
-      @schema.add(key, optdef, desc, *rest, type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, tag: tag, &callback)
+      @schema.add(key, optdef, desc, *rest, type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, hidden: hidden, important: important, tag: tag, &callback)
       #; [!tu4k3] returns self.
       self
     end
@@ -103,7 +103,7 @@ module Benry::CmdOpt
       self
     end
 
-    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, detail: nil, tag: nil, &callback)
+    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
       rexp ||= pattern    # for backward compatibility
       #; [!kuhf9] type, rexp, enum, and range are can be passed as positional args as well as keyword args.
       rest.each do |x|
@@ -120,7 +120,7 @@ module Benry::CmdOpt
       #; [!rhhji] raises SchemaError when key is not a Symbol.
       key.nil? || key.is_a?(Symbol)  or
         raise _error("add(#{key.inspect}, #{optdef.inspect}): The first arg should be a Symbol as an option key.")
-      #; [!vq6eq] raises SchemaError when help message is missing."
+      #; [!vq6eq] raises SchemaError when help message is missing.
       desc.nil? || desc.is_a?(String)  or
         raise _error("add(#{key.inspect}, #{optdef.inspect}): Help message required as 3rd argument.")
       #; [!7hi2d] takes command option definition string.
@@ -137,7 +137,7 @@ module Benry::CmdOpt
       end
       #; [!yht0v] keeps command option definitions.
       item = SchemaItem.new(key, optdef, desc, short, long, param, required,
-                 type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, tag: tag, &callback)
+                 type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, hidden: hidden, important: important, tag: tag, &callback)
       @items << item
       item
     end
@@ -157,10 +157,16 @@ module Benry::CmdOpt
       #; [!to1th] includes all option help when `all` is true.
       #; [!a4qe4] option should not be hidden if description is empty string.
       sb = []
-      width = nil; indent = nil
-      each_option_and_desc(all: all) do |opt, desc, detail|
-        sb << format % [opt, desc || ""] << "\n"
+      width = nil; indent = nil; color_p = $stdout.tty?
+      @items.each do |item|
+        next if ! all && item.hidden?
+        #; [!jrwb6] decorates help message according to `important:` value of option.
+        #; [!9nlfb] not decorate help message when stdout is not a tty.
+        s = format % [item.optdef, item.desc || ""]
+        s = _decorate_str(s, item.important?) if color_p
+        sb << s << "\n"
         #; [!848rm] supports multi-lines help message.
+        detail = item.detail
         if detail
           width  ||= (format % ['', '']).length
           indent ||= ' ' * width
@@ -276,12 +282,20 @@ module Benry::CmdOpt
       return short_p ? 8 : long_p ? 20 : 14
     end
 
+    def _decorate_str(str, important)
+      case important
+      when true  ; return "\e[1m#{str}\e[0m"  # bold
+      when false ; return "\e[2m#{str}\e[0m"  # gray
+      else       ; return str
+      end
+    end
+
   end
 
 
   class SchemaItem    # avoid Struct
 
-    def initialize(key, optdef, desc, short, long, param, required, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, detail: nil, value: nil, tag: nil, &callback)
+    def initialize(key, optdef, desc, short, long, param, required, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, detail: nil, value: nil, hidden: nil, important: nil, tag: nil, &callback)
       rexp ||= pattern    # for backward compatibility
       _init_validation(param, required, type, rexp, enum, range, value)
       @key      = key       unless nil == key
@@ -297,6 +311,8 @@ module Benry::CmdOpt
       @range    = range     unless nil == range
       @detail   = detail    unless nil == detail
       @value    = value     unless nil == value
+      @hidden   = hidden    unless nil == hidden
+      @important = important unless nil == important
       @tag      = tag       unless nil == tag
       @callback = callback  unless nil == callback
       #; [!nn4cp] freezes enum object.
@@ -324,10 +340,18 @@ module Benry::CmdOpt
     end
 
     def hidden?()
+      #; [!no6ov] returns true if @hidden is true.
+      #; [!ej8ot] returns false if @hidden is false.
+      return @hidden if @hidden != nil
       #; [!h0uxs] returns true if desc is nil.
-      #; [!su00g] returns true if key starts with '_'.
       #; [!28vzx] returns false if else.
-      return @desc == nil || @key.to_s.start_with?('_')
+      return @desc == nil
+    end
+
+    def important?()
+      #; [!ua8kt] returns true/false if `important:` kwarg passed to constructor.
+      #; [!hz9sx] returns nil if `important:` kwarg not passed to constructor.
+      return @important
     end
 
     def validate_and_convert(val, optdict)

data/test/cmdopt_test.rb

@@ -342,13 +342,49 @@ END
       spec "[!a4qe4] option should not be hidden if description is empty string." do
         sc = Benry::CmdOpt::Schema.new
         sc.add(:debug , "-D", nil)       # hidden
-        sc.add(:_trace, "-T", "trace")   # hidden
+        sc.add(:trace, "-T", "trace", hidden: true)   # hidden
         sc.add(:what  , "-W", "")        # NOT hidden!
         ok {sc.option_help()} == <<END
   -W             : 
 END
       end
 
+      fixture :schema_with_importance do
+        sc = Benry::CmdOpt::Schema.new
+        sc.add(:help  , "-h, --help" , "help message")
+        sc.add(:trace , "-T, --trace", "trace"      , important: true)
+        sc.add(:debug , "-D, --debug", "debug mode" , important: false)
+        sc.add(:quiet , "-q, --quiet", "quiet mode")
+        sc
+      end
+
+      spec "[!jrwb6] decorates help message according to `important:` value of option." do
+        |schema_with_importance|
+        sc = schema_with_importance
+        ok {sc.option_help()} == <<END
+  -h, --help     : help message
+\e[1m  -T, --trace    : trace\e[0m
+\e[2m  -D, --debug    : debug mode\e[0m
+  -q, --quiet    : quiet mode
+END
+      end
+
+      spec "[!9nlfb] not decorate help message when stdout is not a tty." do
+        |schema_with_importance|
+        sc = schema_with_importance
+        output = nil
+        capture_sio() {
+          ok {$stdout}.NOT.tty?
+          output = sc.option_help()
+        }
+        ok {output} == <<END
+  -h, --help     : help message
+  -T, --trace    : trace
+  -D, --debug    : debug mode
+  -q, --quiet    : quiet mode
+END
+      end
+
     end
 
 
@@ -445,7 +481,7 @@ END
         sc.add(:help, "-h, --help", "show help message")
         sc.add(:version, "    --version", "print version")
         sc.add(:debug  , "-d, --debug"  , nil)            # hidden
-        sc.add(:_DEBUG , "-D, --DEBUG"  , "debug mode")   # hidden
+        sc.add(:DEBUG  , "-D, --DEBUG"  , "debug mode", hidden: true)   # hidden
         @schema = sc
       end
 
@@ -532,7 +568,7 @@ END
       spec "[!icvm1] ignores hidden items if 'all: false' kwarg specified." do
         schema = Benry::CmdOpt::Schema.new
         schema.add(:debug , "-D", nil)
-        schema.add(:_trace, "-T", "trace")
+        schema.add(:trace, "-T", "trace", hidden: true)
         ok {schema.empty?()} == false
         ok {schema.empty?(all: true)} == false
         ok {schema.empty?(all: false)} == true
@@ -898,15 +934,19 @@ END
 
     topic '#hidden?()' do
 
-      spec "[!h0uxs] returns true if desc is nil." do
-        desc = nil
-        item = Benry::CmdOpt::SchemaItem.new(:debug, "-D", desc, "D", nil, nil, nil)
+      spec "[!no6ov] returns true if @hidden is true." do
+        item = Benry::CmdOpt::SchemaItem.new(:debug, "-D", "debug mode", "D", nil, nil, nil, hidden: true)
         ok {item.hidden?} == true
       end
 
-      spec "[!su00g] returns true if key starts with '_'." do
-        desc = "debug mode"
-        item = Benry::CmdOpt::SchemaItem.new(:_debug, "-D", desc, "D", nil, nil, nil)
+      spec "[!ej8ot] returns false if @hidden is false." do
+        item = Benry::CmdOpt::SchemaItem.new(:debug, "-D", "debug mode", "D", nil, nil, nil, hidden: false)
+        ok {item.hidden?} == false
+      end
+
+      spec "[!h0uxs] returns true if desc is nil." do
+        desc = nil
+        item = Benry::CmdOpt::SchemaItem.new(:debug, "-D", desc, "D", nil, nil, nil)
         ok {item.hidden?} == true
       end
 
@@ -919,6 +959,23 @@ END
     end
 
 
+    topic '#important?()' do
+
+      spec "[!ua8kt] returns true/false if `important:` kwarg passed to constructor." do
+        item1 = Benry::CmdOpt::SchemaItem.new(:debug, "-D", "debug mode", "D", nil, nil, nil, important: true)
+        ok {item1.important?} == true
+        item2 = Benry::CmdOpt::SchemaItem.new(:debug, "-D", "debug mode", "D", nil, nil, nil, important: false)
+        ok {item2.important?} == false
+      end
+
+      spec "[!hz9sx] returns nil if `important:` kwarg not passed to constructor." do
+        item3 = Benry::CmdOpt::SchemaItem.new(:debug, "-D", "debug mode", "D", nil, nil, nil)
+        ok {item3.important?} == nil
+      end
+
+    end
+
+
     topic '#validate_and_convert()' do
 
       def new_item(key, optstr, desc, short, long, param, required,
@@ -1471,6 +1528,12 @@ END
         ok {item.value} == 4
       end
 
+      spec "[!tu4k3] returns self." do
+        cmdopt = Benry::CmdOpt.new()
+        x = cmdopt.add(:version, "-v, --version", "version")
+        ok {x}.same?(cmdopt)
+      end
+
     end
 
 
@@ -1514,7 +1577,7 @@ END
         @cmdopt.add(:help   , "-h, --help"        , "show help message")
         @cmdopt.add(:version, "    --version"     , "print version")
         @cmdopt.add(:debug  , "-D"                , nil)       # hidden option
-        @cmdopt.add(:_trace , "-T"                , "trace")   # hidden option
+        @cmdopt.add(:trace  , "-T"                , "trace", hidden: true)  # hidden option
       end
 
       spec "[!bw9qx] yields each option definition string and help message." do
@@ -1569,6 +1632,17 @@ END
         @cmdopt.add(:debug, "-d, --debug[=<LEVEL>]", "debug", type: Integer)
       end
 
+      spec "[!7gc2m] parses command options." do
+        args = ["-d", "x", "y"]
+        @cmdopt.parse(args)
+        ok {args} == ["x", "y"]
+      end
+
+      spec "[!no4xu] returns option values as dict." do
+        args = ["-d", "x"]
+        ok {@cmdopt.parse(args)} == {:debug=>true}
+      end
+
       spec "[!areof] handles only OptionError when block given." do
         errmsg = nil
         errcls = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benry-cmdopt
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - kwatch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oktest
@@ -36,15 +36,10 @@ files:
 - CHANGES.md
 - MIT-LICENSE
 - README.md
-- Rakefile.rb
 - benry-cmdopt.gemspec
 - doc/benry-cmdopt.html
 - doc/css/style.css
 - lib/benry/cmdopt.rb
-- task/common-task.rb
-- task/package-task.rb
-- task/readme-task.rb
-- task/test-task.rb
 - test/cmdopt_test.rb
 homepage: https://kwatch.github.io/benry-ruby/benry-cmdopt.html
 licenses:

data/Rakefile.rb

@@ -1,11 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-PROJECT   = "benry-cmdopt"
-RELEASE   = ENV['RELEASE'] || "0.0.0"
-COPYRIGHT = "copyright(c) 2021 kwatch@gmail.com"
-LICENSE   = "MIT License"
-
-#RUBY_VERSIONS = ["3.2", "3.1", "3.0", "2.7", "2.6", "2.5", "2.4", "2.3"]
-
-Dir.glob('./task/*-task.rb').sort.each {|x| require x }

data/task/common-task.rb

@@ -1,139 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-defined? PROJECT    or abort "PROJECT required."
-defined? RELEASE    or abort "RELEASE required."
-defined? COPYRIGHT  or abort "COPYRIGHT required."
-defined? LICENSE    or abort "LICENSE required."
-
-RELEASE =~ /\A\d+\.\d+\.\d+/  or abort "RELEASE=#{RELEASE}: invalid release number."
-
-
-require 'rake/clean'
-CLEAN << "build"
-CLEAN.concat Dir.glob("#{PROJECT}-*.gem").collect {|x| x.sub(/\.gem$/, '') }
-CLOBBER.concat Dir.glob("#{PROJECT}-*.gem")
-
-
-task :default do
-  sh "rake -T", verbose: false
-end unless Rake::Task.task_defined?(:default)
-
-
-desc "show release guide"
-task :guide do
-  do_guide()
-end
-
-def do_guide()
-  RELEASE != '0.0.0'  or abort "** ERROR: 'RELEASE=X.X.X' required."
-  puts guide_message(PROJECT, RELEASE)
-end
-
-def guide_message(project, release)
-  target = "#{project}-#{release}"
-  tag    = "#{project}-#{release}"
-  puts <<END
-How to release:
-
-  $ git diff .
-  $ git status .
-  $ which ruby
-  $ rake test
-  $ rake test:all
-  $ rake readme:execute			# optional
-  $ rake readme:toc			# optional
-  $ rake package RELEASE=#{release}
-  $ rake package:extract		# confirm files in gem file
-  $ (cd #{target}/data; find . -type f)
-  $ gem install #{target}.gem	# confirm gem package
-  $ gem uninstall #{project}
-  $ gem push #{target}.gem	# publish gem to rubygems.org
-  $ git tag #{tag}		# or: git tag ruby-#{tag}
-  $ git push
-  $ git push --tags
-  $ rake clean
-  $ mv #{target}.gem archive/
-END
-end
-
-
-desc "create 'README.md' and 'doc/*.html'"
-task :doc do
-  x = PROJECT
-  cd "doc" do
-    sh "../../docs/md2 --md #{x}.mdx > ../README.md"
-    sh "../../docs/md2 #{x}.mdx > #{x}.html"
-  end
-end
-
-desc "copy 'doc/*.html' to '../docs/'"
-task 'doc:export' do
-  RELEASE != '0.0.0'  or abort "** ERROR: 'RELEASE=X.X.X' required."
-  x = PROJECT
-  cp "doc/#{x}.html", "../docs/"
-  edit_file!("../docs/#{x}.html")
-end
-
-
-desc "edit metadata in files"
-task :edit do
-  do_edit()
-end
-
-def do_edit()
-  target_files().each do |fname|
-    edit_file!(fname)
-  end
-end
-
-def target_files()
-  $_target_files ||= begin
-    spec_src = File.read("#{PROJECT}.gemspec", encoding: 'utf-8')
-    spec = eval spec_src
-    spec.name == PROJECT  or
-      abort "** ERROR: '#{PROJECT}' != '#{spec.name}' (project name in gemspec file)"
-    spec.files + Dir.glob("doc/*.mdx")
-  end
-  return $_target_files
-end
-
-def edit_file!(filename, verbose: true)
-  changed = edit_file(filename) do |s|
-    s = s.gsub(/\$Release[:].*?\$/,   "$"+"Release: #{RELEASE} $")
-    s = s.gsub(/\$Copyright[:].*?\$/, "$"+"Copyright: #{COPYRIGHT} $")
-    s = s.gsub(/\$License[:].*?\$/,   "$"+"License: #{LICENSE} $")
-    s
-  end
-  if verbose
-    puts "[C] #{filename}"     if changed
-    puts "[U] #{filename}" unless changed
-  end
-  return changed
-end
-
-def edit_file(filename)
-  File.open(filename, 'rb+') do |f|
-    s1 = f.read()
-    s2 = yield s1
-    if s1 != s2
-      f.rewind()
-      f.truncate(0)
-      f.write(s2)
-      true
-    else
-      false
-    end
-  end
-end
-
-
-desc nil
-task :'relink' do
-  Dir.glob("task/*.rb").each do |x|
-    src = "../" + x
-    next if File.identical?(src, x)
-    rm x
-    ln src, x
-  end
-end

data/task/package-task.rb

@@ -1,72 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-desc "create package (*.gem)"
-task :package do
-  do_package()
-end
-
-def do_package()
-  RELEASE != '0.0.0'  or abort "** ERROR: 'RELEASE=X.X.X' required."
-  ## copy
-  dir = "build"
-  rm_rf dir if File.exist?(dir)
-  mkdir dir
-  target_files().each do |file|
-    dest = File.join(dir, File.dirname(file))
-    mkdir_p dest, :verbose=>false unless File.exist?(dest)
-    cp file, "#{dir}/#{file}"
-  end
-  ## edit
-  Dir.glob("#{dir}/**/*").each do |file|
-    next unless File.file?(file)
-    edit_file!(file, verbose: false)
-  end
-  ## build
-  chdir dir do
-    sh "gem build #{PROJECT}.gemspec"
-  end
-  mv "#{dir}/#{PROJECT}-#{RELEASE}.gem", "."
-  rm_rf dir
-end
-
-
-desc "extract latest gem file"
-task :'package:extract' do
-  do_package_extract()
-end
-
-def do_package_extract()
-  gemfile = Dir.glob("#{PROJECT}-*.gem").sort_by {|x| File.mtime(x) }.last
-  dir = gemfile.sub(/\.gem$/, '')
-  rm_rf dir if File.exist?(dir)
-  mkdir dir
-  mkdir "#{dir}/data"
-  cd dir do
-    sh "tar xvf ../#{gemfile}"
-    sh "gunzip *.gz"
-    cd "data" do
-      sh "tar xvf ../data.tar"
-    end
-  end
-end
-
-
-desc "upload gem file to rubygems.org"
-task :publish do
-  do_publish()
-end
-
-def do_publish()
-  RELEASE != '0.0.0'  or abort "** ERROR: 'RELEASE=X.X.X' required."
-  gemfile = "#{PROJECT}-#{RELEASE}.gem"
-  print "** Are you sure to publish #{gemfile}? [y/N]: "
-  answer = $stdin.gets().strip()
-  if answer.downcase == "y"
-    sh "gem push #{gemfile}"
-    #sh "git tag ruby-#{PROJECT}-#{RELEASE}"
-    sh "git tag #{PROJECT}-#{RELEASE}"
-    sh "#git push"
-    sh "#git push --tags"
-  end
-end

data/task/readme-task.rb

@@ -1,125 +0,0 @@
-# -*- coding: utf-8 -*-
-
-README_FILE      = "README.md"       unless defined? README_FILE
-README_EXTRACT   = /^[Ff]ile: +(\S+)/ unless defined? README_EXTRACT
-README_CODESTART = /^```\w+$/        unless defined? README_CODESTART
-README_CODEEND   = /^```$/           unless defined? README_CODEEND
-README_DESTDIR   = "tmp/readme"      unless defined? README_DESTDIR
-
-require 'rake/clean'
-CLEAN << "README.html"
-
-
-def readme_extract_callback(filename, str)
-  return str
-end
-
-
-namespace :readme do
-
-
-  desc "retrieve scripts from #{README_FILE}"
-  task :retrieve do
-    do_readme_retrieve()
-  end
-
-  def do_readme_retrieve()
-    dir = README_DESTDIR
-    rm_rf dir if File.exist?(dir)
-    mkdir_p dir
-    s = File.read(README_FILE, encoding: 'utf-8')
-    filename = nil
-    buf = nil
-    s.each_line do |line|
-      case line
-      when README_EXTRACT
-        filename = $1
-        next
-      when README_CODESTART
-        if filename
-          buf = []
-        end
-        next
-      when README_CODEEND
-        if filename && buf
-          newfile = "#{dir}/#{filename}"
-          unless File.exist?(File.dirname(newfile))
-            mkdir_p File.dirname(newfile)
-          end
-          str = readme_extract_callback(filename, buf.join())
-          File.write(newfile, str, encoding: 'utf-8')
-          puts "[retrieve] #{newfile}"
-        end
-        filename = nil
-        buf = nil
-        next
-      end
-      #
-      if buf
-        buf << line
-      end
-    end
-  end
-
-
-  desc "execute code in readme file"
-  task :execute => :retrieve do
-    do_readme_execute()
-  end
-
-  def do_readme_execute()
-    Dir.glob(README_DESTDIR+'/**/*.rb').sort.each do |fpath|
-      puts "========================================"
-      sh "ruby -I lib #{fpath}" do end
-    end
-  end
-
-
-  desc "builds table of contents"
-  task :toc do
-    do_readme_toc()
-  end
-
-  def do_readme_toc()
-    url = ENV['README_URL']  or abort "$README_URL required."
-    mkdir "tmp" unless Dir.exist?("tmp")
-    htmlfile = "tmp/README.html"
-    sh "curl -s -o #{htmlfile} #{url}"
-    #rexp = /<h(\d) dir="auto"><a id="(.*?)" class="anchor".*><\/a>(.*)<\/h\1>/
-    rexp = /<h(\d) id="user-content-.*?" dir="auto"><a class="heading-link" href="#(.*?)">(.*)<svg/
-    html_str = File.read(htmlfile, encoding: 'utf-8')
-    buf = []
-    html_str.scan(rexp) do
-      level = $1.to_i
-      id = $2
-      title = $3
-      next if title =~ /Table of Contents/
-      title = title.gsub(/<\/?code>/, '`')
-      anchor = id.sub(/^user-content-/, '')
-      indent = "  " * (level - 1)
-      buf << "#{indent}* <a href=\"##{anchor}\">#{title}</a>\n"
-    end
-    buf.shift() if buf[0] && buf[0] =~ /^\* /
-    toc_str = buf.join()
-    #
-    mdfile = README_FILE
-    changed = File.open(mdfile, "r+", encoding: 'utf-8') do |f|
-      s1 = f.read()
-      s2 = s1.sub(/(<!-- TOC -->\n).*(<!-- \/TOC -->\n)/m) {
-        [$1, toc_str, $2].join("\n")
-      }
-      if s1 != s2
-        f.rewind()
-        f.truncate(0)
-        f.write(s2)
-        true
-      else
-        false
-      end
-    end
-    puts "[changed] #{mdfile}"          if changed
-    puts "[not changed] #{mdfile}"  unless changed
-  end
-
-
-end

data/task/test-task.rb

@@ -1,81 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-unless defined?(RUBY_VERSIONS)
-  RUBY_VERSIONS = (
-    if ENV['RUBY_VERSIONS']
-      ENV['RUBY_VERSIONS'].split()
-    else
-      ["3.2", "3.1", "3.0", "2.7", "2.6", "2.5", "2.4", "2.3"]
-    end
-  )
-end
-
-
-desc "run test"
-task :test do
-  do_test()
-end
-
-def do_test()
-  run_test()
-end
-
-def run_test(ruby=nil, &b)
-  run_oktest(ruby, &b)
-end
-
-def run_minitest(ruby=nil, &b)
-  files = File.exist?("test/run_all.rb") \
-          ? ["test/run_all.rb"] \
-          : Dir.glob("test/**/*_test.rb")
-  if ruby
-    sh(ruby, *files, &b)
-  else
-    ruby(*files, &b)
-  end
-end
-
-def run_oktest(ruby=nil, &b)
-  argstr = "-r oktest -e Oktest.main -- test -sp"
-  if ruby
-    sh("#{ruby} #{argstr}", &b)
-  else
-    ruby(argstr, &b)
-  end
-end
-
-
-desc "run test in different ruby versions"
-task :'test:all' do
-  do_test_all()
-end
-
-def do_test_all()
-  ENV['VS_HOME']  or
-    abort "[ERROR] rake test:all: '$VS_HOME' environment var required."
-  vs_home = ENV['VS_HOME'].split(/[:;]/).first
-  ruby_versions = RUBY_VERSIONS
-  test_all(vs_home, ruby_versions)
-end
-
-def test_all(vs_home, ruby_versions)
-  header = proc {|s| "\033[0;36m=============== #{s} ===============\033[0m" }
-  error  = proc {|s| "\033[0;31m** #{s}\033[0m" }
-  comp   = proc {|x, y| x.to_s.split('.').map(&:to_i) <=> y.to_s.split('.').map(&:to_i) }
-  ruby_versions.each do |ver|
-    dir = Dir.glob("#{vs_home}/ruby/#{ver}.*/").sort_by(&comp).last
-    puts ""
-    if dir
-      puts header.("#{ver} (#{dir})")
-      run_test("#{dir}/bin/ruby") do |ok, res|
-        $stderr.puts error.("test failed") unless ok
-      end
-      sleep 0.2
-    else
-      puts header.(ver)
-      $stderr.puts error.("ruby #{ver} not found")
-      sleep 1.0
-    end
-  end
-end