hiiro 0.1.220 → 0.1.221

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28013aa2de1c98ae4ecd1a166635b4444f0c2753fe830aeb94d796cddd607b45
-  data.tar.gz: 17ad399a86996122313f9fb3a78aad3ea732bc8ab1a04fb735ba0b001486e3ab
+  metadata.gz: de890107cb43e9b6f6cf34020f4c2c2083d93e19336f30f8c78a0a14368a0b79
+  data.tar.gz: 18797bfa2b31b7d162a03ad1144228e320ba1ffc9e8d4377f77f51fa1efa06dd
 SHA512:
-  metadata.gz: 7e15908fda49530377d57b400f50439a2dd9a28b24820dc28a45e20e74df150011e981624308c271ea0dcff9f86249c68ad900c6909ed5ee61d5a6e8fe195352
-  data.tar.gz: c2ba6cb131f38b6aaa37655fc976e597e2fe1c1f0b605df431797ce4ffc2bd8f66ca086390d5691d0a1aafb2e9c4ea93ecb7a5ad581bda89f1388dfd57f8824a
+  metadata.gz: 133d7ca0775d50002b3f49f59fd75ed935f8eb2a0ba69747c49ada7ddb29eb52f32b319ee2aa24dccd693b6906a32c071f8128b563f5faace521f304b09c74b8
+  data.tar.gz: a6be7f17f45b6db61209c13b703a601044ec7a6d593ec8b8b418ce94cbda95e2aa4d5c6f1ec0f4cafcd467ff984ee7a157bba6110eb16c322f949b67f6d654ad

data/examples/bin-with-proposed-options

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'hiiro'
+
+Hiiro.run do
+  add_option(:group, short: :g, desc: 'group name')
+  add_option(:group2, short: :g, long: :group, desc: 'group name')
+  add_flag(:verbose, short: :v, desc: 'verbose output')
+
+  add_subcmd(
+    :subcmd_name,
+    :alias_name,
+    args: [:position1_arg_name, :second_arg],
+    opts: [:group, :verbose],
+  ) do
+    # ...
+  end
+
+  add_subcmd(
+    :subcmd_name,
+    :alias_name,
+    args: [:position1_arg_name, :second_arg],
+    opts: [:group2, :verbose],  # key is to differentiate between 2 options or
+                                # flags with the same long-name but different
+                                # description or other settings
+                                #
+                                # for example, one might be a flag, the other an
+                                # option
+  ) do
+    # ...
+  end
+end

data/lib/hiiro/options.rb

@@ -41,18 +41,35 @@ class Hiiro
       lines.join("\n")
     end
 
-    def flag(name, short: nil, default: false, desc: nil)
-      defn = Definition.new(name, short: short, type: :flag, default: default, desc: desc)
+    def hint
+      @definitions
+        .reject { |k, _| k == :help }
+        .map { |_, d| d.flag? ? d.long_form : "#{d.long_form} <val>" }
+        .map { |s| "[#{s}]" }
+        .join(' ')
+    end
+
+    def flag(name, long: nil, short: nil, default: false, desc: nil)
+      defn = Definition.new(name, long: long, short: short, type: :flag, default: default, desc: desc)
       @definitions[name.to_sym] = defn
       self
     end
 
-    def option(name, short: nil, type: :string, default: nil, desc: nil, multi: false)
-      defn = Definition.new(name, short: short, type: type, default: default, desc: desc, multi: multi)
+    def option(name, long: nil, short: nil, type: :string, default: nil, desc: nil, multi: false)
+      defn = Definition.new(name, long: long, short: short, type: type, default: default, desc: desc, multi: multi)
       @definitions[name.to_sym] = defn
       self
     end
 
+    def select(names)
+      subset = self.class.setup {}
+      names.each do |name|
+        defn = @definitions[name.to_sym]
+        subset.definitions[name.to_sym] = defn if defn
+      end
+      subset
+    end
+
     def parse(args)
       Args.new(@definitions, args.flatten.compact)
     end
@@ -146,19 +163,15 @@ class Hiiro
       end
 
       def parse_long_option(arg, args)
-        if arg.include?('=')
-          opt, value = arg.split('=', 2)
-          name = opt.sub(/^--/, '').tr('-', '_').to_sym
-        else
-          name = arg.sub(/^--/, '').tr('-', '_').to_sym
-          value = nil
-        end
+        parts     = arg.split('=', 2)
+        flag_part = parts[0]
+        value     = parts[1]
 
-        defn = @definitions[name]
+        defn = @definitions.values.find { |d| d.long_form == flag_part }
         return unless defn
 
         if defn.flag?
-          @values[name] = !defn.default
+          @values[defn.name] = !defn.default
         else
           value ||= args.shift
           store_value(defn, value)
@@ -194,11 +207,12 @@ class Hiiro
     end
 
     class Definition
-      attr_reader :name, :short, :type, :default, :desc, :multi
+      attr_reader :name, :short, :long, :type, :default, :desc, :multi
 
-      def initialize(name, short: nil, type: :string, default: nil, desc: nil, multi: false)
+      def initialize(name, short: nil, long: nil, type: :string, default: nil, desc: nil, multi: false)
         @name = name.to_sym
         @short = short&.to_s
+        @long = long&.to_sym
         @type = type
         @default = default
         @desc = desc
@@ -210,7 +224,7 @@ class Hiiro
       end
 
       def long_form
-        "--#{name.to_s.tr('_', '-')}"
+        "--#{(@long || @name).to_s.tr('_', '-')}"
       end
 
       def short_form

data/lib/hiiro/version.rb

@@ -1,3 +1,3 @@
 class Hiiro
-  VERSION = "0.1.220"
+  VERSION = "0.1.221"
 end

data/lib/hiiro.rb

@@ -237,6 +237,36 @@ class Hiiro
   end
   alias add_subcmd add_subcommand
 
+  def options
+    @options ||= Hiiro::Options.setup {}
+  end
+
+  def add_option(name, **kwargs)
+    options.option(name, **kwargs)
+  end
+
+  def add_flag(name, **kwargs)
+    options.flag(name, **kwargs)
+  end
+
+  def add_cmd(*names, args: [], opts: [], &block)
+    cmd_opts = options.select(opts)
+
+    wrapper = lambda do |*raw_args|
+      @opts = cmd_opts.parse(raw_args)
+      instance_eval(&block)
+    end
+
+    names.each do |name|
+      runners.add_subcommand(
+        name, wrapper,
+        subcmd_args: args,
+        subcmd_opts: cmd_opts,
+        **global_values
+      )
+    end
+  end
+
   def run_subcommand(name, *args)
     runners.run_subcommand(name, *args)
   end
@@ -300,6 +330,13 @@ class Hiiro
       puts
     end
 
+    global = @options
+    if global && global.definitions.any? { |k, _| k != :help }
+      puts "Options:"
+      puts global.help_text
+      puts
+    end
+
     if options
       puts "Options:"
       puts options.help_text
@@ -326,7 +363,9 @@ class Hiiro
       params     = r.params_string
       params_col = params ? params.ljust(max_params) : ''.ljust(max_params)
       location   = shorten_location(r.location, vars)
-      puts "  #{name}  #{params_col}  #{type}  #{location}"
+      hint       = r.respond_to?(:opts_hint) ? r.opts_hint : nil
+      hint_col   = hint && !hint.empty? ? "  #{hint}" : ""
+      puts "  #{name}  #{params_col}  #{type}  #{location}#{hint_col}"
     end
   end
 
@@ -459,8 +498,13 @@ class Hiiro
       Dir.glob(pattern).map { |path| Bin.new(bin_name, path) }
     end
 
-    def add_subcommand(name, handler, opts: nil, **values)
-      @subcommands[name] = Subcommand.new(bin_name, name, handler, values, opts: opts)
+    def add_subcommand(name, handler, opts: nil, subcmd_args: [], subcmd_opts: nil, **values)
+      @subcommands[name] = Subcommand.new(
+        bin_name, name, handler, values,
+        opts: opts,
+        subcmd_args: subcmd_args,
+        subcmd_opts: subcmd_opts
+      )
     end
 
     def run_subcommand(name, *args)
@@ -545,15 +589,17 @@ class Hiiro
     end
 
     class Subcommand
-      attr_reader :bin_name, :name, :handler, :values, :opts
+      attr_reader :bin_name, :name, :handler, :values, :opts, :subcmd_args, :subcmd_opts
       alias subcommand_name name
 
-      def initialize(bin_name, name, handler, values={}, opts: nil)
+      def initialize(bin_name, name, handler, values={}, opts: nil, subcmd_args: [], subcmd_opts: nil)
         @bin_name = bin_name
         @name = name.to_s
         @handler = handler
         @values = values || {}
         @opts = opts
+        @subcmd_args = subcmd_args || []
+        @subcmd_opts = subcmd_opts
       end
 
       def run(*args)
@@ -586,6 +632,10 @@ class Hiiro
       end
 
       def params_string
+        if subcmd_args.any?
+          return subcmd_args.map { |a| "<#{a}>" }.join(' ')
+        end
+
         return nil unless handler.respond_to?(:parameters)
 
         params = handler.parameters
@@ -604,6 +654,10 @@ class Hiiro
           end
         }.compact.join(' ')
       end
+
+      def opts_hint
+        subcmd_opts&.hint
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiiro
 version: !ruby/object:Gem::Version
-  version: 0.1.220
+  version: 0.1.221
 platform: ruby
 authors:
 - Joshua Toyota
@@ -128,6 +128,7 @@ files:
 - docs/h-session.md
 - docs/h-window.md
 - editboth
+- examples/bin-with-proposed-options
 - examples/services.sleepers.yml
 - examples/services.yml
 - examples/sparse_groups.yml