commander-openflighthpc 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7fc6691e8844c97ef13db4d9b8eafca04d32920f1dd0cee917c16ad9af3d276
-  data.tar.gz: 17373b733f66051a671da4ae2f0137b6fc560806e0404ebeba0f392ed808ab7c
+  metadata.gz: 15b5727f3d10b876b81b223b19fcac47a56cf293a66b34305b96517976b04613
+  data.tar.gz: e047187d76098db98d240770dca013806512628ad1dcd54c613dc2627a7538d7
 SHA512:
-  metadata.gz: 5b7ba1a31614a256b4c4c61d39f4b7684ff6abdf07a75073b21284d3e62b8a9a24de4c85da756cd6063d1b88cb91a79a1cbdd8829cda3e7af30eec6f40ceb997
-  data.tar.gz: 811fbe363a0bb1f88f558b54bcfe1098c394da7f79219b71692b79a243733b64d1735ea3c9b6063d5c9202a7b1e0258136605574af99293a3d1e8d8fe82a2c76
+  metadata.gz: e5e8f5850885c9bf9540b82b7a7866fdb9a317c32c94501e51cef85d65711fe5037ffc7924f68c206ff4654e2f998ae237e5fbb36b9495f9619aaba3d95418a4
+  data.tar.gz: a6840ebf11d96c875e45a468ce492e2c748f20c3298121bc338b2f565d9b8f8c3dff6d278340d609f69ca98f8c0e8b52af3e40a4b93385d99dbc5fc4ae2c3c1c

data/README.md

@@ -43,39 +43,37 @@ features, and an elegant API.
 
 ## Example
 
-For more option examples view the `Commander::Command#option` method. Also
-an important feature to note is that action may be a class to instantiate,
-as well as an object, specifying a method to call, so view the RDoc for more information.
-
-### Classic style
-
 ```ruby
 require 'rubygems'
-require 'commander/import'
+require 'commander'
 
+class MyApplication
 # :name is optional, otherwise uses the basename of this executable
-program :name, 'Foo Bar'
-program :version, '1.0.0'
-program :description, 'Stupid command that prints foo or bar.'
-
-command :foo do |c|
-  c.syntax = 'foobar foo'
-  c.description = 'Displays foo'
-  c.action do |args, options|
-    say 'foo'
+  program :name, 'Foo Bar'
+  program :version, '1.0.0'
+  program :description, 'Stupid command that prints foo or bar.'
+
+  command :foo do |c|
+    c.syntax = 'foobar foo'
+    c.description = 'Displays foo'
+    c.action do |args, options|
+      say 'foo'
+    end
   end
-end
 
-command :bar do |c|
-  c.syntax = 'foobar bar [options]'
-  c.description = 'Display bar with optional prefix and suffix'
-  c.option '--prefix STRING', 'Adds a prefix to bar'
-  c.option '--suffix STRING', 'Adds a suffix to bar'
-  c.action do |args, options|
-    options.default :prefix => '(', :suffix => ')'
-    say "#{options.prefix}bar#{options.suffix}"
+  command :bar do |c|
+    c.syntax = 'foobar bar [options]'
+    c.description = 'Display bar with optional prefix and suffix'
+    c.slop.string '--prefix', 'Adds a prefix to bar'
+    c.slop.string '--suffix', 'Adds a suffix to bar', meta: 'CUSTOM_META'
+    c.action do |args, options, config|
+      options.default :prefix => '(', :suffix => ')'
+      say "#{options.prefix}bar#{options.suffix}"
+    end
   end
 end
+
+MyApplication.run!(ARGV) if $0 == __FILE__
 ```
 
 Example output:
@@ -88,49 +86,27 @@ $ foobar bar --suffix '}' --prefix '{'
 # => {bar}
 ```
 
-### Modular style
+## Commander Goodies
 
-**NOTE:** Make sure to use `require 'commander'` rather than `require 'commander/import'`, otherwise Commander methods will still be imported into the global namespace.
+### Option Parsing
 
-```ruby
-require 'rubygems'
-require 'commander'
-
-class MyApplication
-  extend Commander::CLI
+Option parsing is done using [Simple Lightweight Option Parsing](https://github.com/leejarvis/slop) which provides a rich interface for different option types. The main three being:
 
-  program :name, 'Foo Bar'
-  program :version, '1.0.0'
-  program :description, 'Stupid command that prints foo or bar.'
-
-  command :foo do |c|
-    c.syntax = 'foobar foo'
-    c.description = 'Displays foo'
-    c.action do |args, options|
-      say 'foo'
-    end
-  end
-end
-
-MyApplication.run!(ARGV) if $0 == __FILE__
 ```
+command do |c|
+  # Boolean Flag
+  c.slop.bool '--boolean-flag', 'Sets the :boolean_flag option to true'
 
-## Commander Goodies
+  # String Value
+  c.slop.string '--string-value', 'Takes a string from the command line'
+  c.slop.string '--flag', 'Sets the meta variable to META', meta: 'META'
 
-### Option Defaults
+  # Interger Value
+  c.slop.integer '--integer-value', 'Takes the input and type casts it to an integer'
 
-The options struct passed to `#action` provides a `#default` method, allowing you
-to set defaults in a clean manner for options which have not been set.
-
-```ruby
-command :foo do |c|
-  c.option '--interval SECONDS', 'Interval in seconds'
-  c.option '--timeout SECONDS', 'Timeout in seconds'
-  c.action do |args, options|
-    options.default \
-      :interval => 2,
-      :timeout  => 60
-  end
+  # Legacy syntax (boolean and string values only)
+  c.option '--legacy-bool', 'A boolean flag using the legacy syntax'
+  c.option '--legacy-string LEGACY_STRING', 'A string flag using the legacy syntax'
 end
 ```
 
@@ -221,7 +197,18 @@ Which will output the rest of the help doc, along with:
 
 ### Global Options
 
-WIP: Update globals behaviour
+Global options work in a similar way to command level options. They both are configured using `Slop`. Global options are available on all commands. They are configure on the `global_slop` directive.
+
+```
+class MyApplication
+  program :name, 'Foo Bar'
+
+  ...
+
+  global_slop.string '--custom-global', 'Available on all commands'
+end
+
+```
 
 ### Tracing
 

data/lib/commander/command.rb

@@ -103,15 +103,6 @@ module Commander
     end
     alias action when_called
 
-    ##
-    # Causes the option parsing to be skipped. The flags will be passed
-    # down within the args instead
-    #
-
-    def skip_option_parsing(set = true)
-      @skip_option_parsing ||= set
-    end
-
     ##
     # Flags the command not to appear in general help text
     #

data/lib/commander/error_handler.rb

@@ -1,7 +1,7 @@
 module Commander
   ##
   # Internal error class to delay rendering help text
-  # This is required as the help command pints directly to stdout
+  # This is required as the help command points directly to stdout
   # In general this has a bit of a code smell to it, and should
   # not be used publicly
   class InternalCallableError < StandardError

data/lib/commander/help_formatters/terminal/command_help.erb

@@ -27,13 +27,15 @@
   <%= $terminal.color "OPTIONS", :bold %>:
 	<% slop.options.each do |option| -%>
 
-  <% tag = if [Slop::BoolOption, Slop::NullOption].include?(option.class)
-             nil
-           else
-             option.key.upcase
-           end
-  -%>
-  <%= option.flags.join ', ' %> <%= tag %>
+<% tag = if [Slop::BoolOption, Slop::NullOption].include?(option.class)
+           nil
+         elsif meta = option.config[:meta]
+           meta
+         else
+           option.key.upcase
+         end
+-%>
+    <%= option.flags.join ', ' %> <%= tag %>
         <%= Commander::HelpFormatter.indent 8, option.desc %><% if option.default_value %>
         <%= $terminal.color "Default", :bold %>: <%= option.default_value %><% end %>
   <% end -%>

data/lib/commander/help_formatters/terminal/help.erb

@@ -32,14 +32,16 @@
   <%= $terminal.color "GLOBAL OPTIONS", :bold %>:
 	<% global_slop.options.each do |global| -%>
 
-    <% tag = if [Slop::BoolOption, Slop::NullOption]
-               nil
-             else
-               option.key.upcase
-             end
-    -%>
+<% tag = if [Slop::BoolOption, Slop::NullOption]
+           nil
+         elsif meta = option.config[:meta]
+           meta
+         else
+           option.key.upcase
+         end
+-%>
     <%= global.flags.join ', ' %> <%= tag %>
-        <%= global.desc %>
+        <%= Commander::HelpFormatter.indent 8, global.desc %>
 	<% end -%>
 <% end -%>
 <% if program :help -%>

data/lib/commander/runner.rb

@@ -65,21 +65,17 @@ module Commander
         args_without_command_name
       end
 
-      # Parses the global slop options
-      global_parser = Slop::Parser.new(global_slop, suppress_errors: true)
-      global_opts = global_parser.parse(remaining_args)
-      remaining_args = global_parser.arguments
-
-      # Parse the command slop options
-      if active_command? && !active_command.skip_option_parsing(false)
-        local_parser = Slop::Parser.new(active_command.slop)
-        local_opts = local_parser.parse(remaining_args)
-        remaining_args = local_parser.arguments
-      end
-
-      # Format the config and opts
+      # Combines the global and command options into a single parser
+      global_opts = global_slop.options
+      command_opts = active_command? ? active_command.slop.options : []
+      opts = [*global_opts, *command_opts]
+      parser = Slop::Parser.new(opts)
+
+      # Parsers the arguments/opts and fetches the config
+      parser.parse(remaining_args)
+      opts = OpenStruct.new parser.parse(remaining_args).to_h
+      remaining_args = parser.arguments
       config = program(:config).dup
-      opts = OpenStruct.new global_opts.to_h.merge(local_opts.to_h)
 
       if opts.version
         # Return the version

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '2.1.1'.freeze
+  VERSION = '2.1.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander-openflighthpc
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Alces Flight Ltd
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline