commander-openflighthpc 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 972e4ca346bd62603e922f6b214e726ad122ff327d75f7fd4db2c632e7b3137c
-  data.tar.gz: 873b8b07429c76b48e82962c5bba7ef240a106d8a68bb31e78943f52447b99c6
+  metadata.gz: 9244a36a96cd23607e4b23d95d63cde73ccad177b578c6634399379532c3490d
+  data.tar.gz: e225760491eb6d17a4481500883ae97cf401adf4e65cc2a9f31d67b9b6efcd98
 SHA512:
-  metadata.gz: 7982f4e8104109bcb4b74e647e3a362890f94b10e0b4d7f9fec6d1d0085a1e11dd0b177f1867eb1d5b7c660d964fa3eadacab4cd4addd34d7e9debd9961bc59a
-  data.tar.gz: 07c5234d4d2dae8076a334916e1b89445e6697640e31da6ca655e3fd777de289d837e16c6a26acc91961ac497b7068803fdeaa0f721e840c42a7ab29f7f8af45
+  metadata.gz: b526cf9a75f0841eec29365ea8ebec7d256cc89801558e16e68c122149f0febec34b5419ab932551906c1422a8787c72ea5ca7faf9737c9bb523eefce7881026
+  data.tar.gz: ed26d596f553496191a3f9235cec46db82ba46143d5151ef4508812b4fdb9db7b560ef76608762d022f2b9ec110cfe9fd1e32aad1aeaf5efbda504f16ea4c3ff

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.1.0 / 2019-04-10
+
+ * Added banner handling.
+ * Added default error handling.
+ * Fixed help text for `help` command to use program name.
+ * Fixed bug in command calling that prevented commands being called twice.
+
 # 1.0.0 / 2019-04-03
 
  * Reset version numbering for this fork.

data/commander-openflighthpc.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency('highline', '~> 1.7.2')
+  s.add_runtime_dependency('paint', '~> 2.1.0')
 
   s.add_development_dependency('rspec', '~> 3.2')
   s.add_development_dependency('rake')

data/lib/commander/command.rb

@@ -224,8 +224,9 @@ module Commander
     # Call the commands when_called block with _args_.
 
     def call(args = [])
-      object = @when_called.shift
-      meth = @when_called.shift || :call
+      callee = @when_called.dup
+      object = callee.shift
+      meth = callee.shift || :call
       options = proxy_option_struct
       case object
       when Proc then object.call(args, options)

data/lib/commander/help_formatters/base.rb

@@ -12,7 +12,7 @@ module Commander
         @runner = runner
       end
 
-      def render
+      def render(opts = {})
         'Implement global help here'
       end
 

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

@@ -5,7 +5,7 @@
 <% else -%>
   <%= $terminal.color "SYNOPSIS", :bold %>:
 
-    <%= @syntax -%>
+    <%= syntax -%>
 
 <% end -%>
 

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

@@ -1,3 +1,13 @@
+<%=
+  if !program(:nobanner)
+    begin
+      require 'openflight/banner'
+      OpenFlight::Banner.render(title: program(:application), version: program(:version))
+    rescue LoadError
+      nil
+    end
+  end
+-%>
   <%= $terminal.color "NAME", :bold %>:
 
     <%= program :name %>

data/lib/commander/runner.rb

@@ -1,9 +1,29 @@
+require 'paint'
+
 module Commander
   class Runner
+    DEFAULT_ERROR_HANDLER = lambda do |runner, e|
+      $stderr.puts "#{Paint[runner.program(:name), '#2794d8']}: #{Paint[e.to_s, :red, :bright]}"
+      case e
+      when OptionParser::InvalidOption,
+           Commander::Runner::InvalidCommandError,
+           Commander::Patches::CommandUsageError
+        $stderr.puts "\nUsage:\n\n"
+        args = ARGV.reject{|o| o[0] == '-'}
+        if runner.command(topic = args[0..1].join(" "))
+          runner.command("help").run(topic)
+        elsif runner.command(args[0])
+          runner.command("help").run(args[0])
+        else
+          runner.command("help").run(:error)
+        end
+      end
+      exit(1)
+    end
+
     #--
     # Exceptions
     #++
-
     class CommandError < StandardError; end
     class InvalidCommandError < CommandError; end
 
@@ -33,7 +53,7 @@ module Commander
       @always_trace = false
       @never_trace = false
       @silent_trace = false
-      @error_handler = nil
+      @error_handler = DEFAULT_ERROR_HANDLER
       create_default_commands
     end
 
@@ -70,16 +90,16 @@ module Commander
         begin
           run_active_command
         rescue InvalidCommandError => e
-          error_handler&.call(e) ||
+          error_handler&.call(self, e) ||
             abort("#{e}. Use --help for more information")
         rescue \
           OptionParser::InvalidOption,
           OptionParser::InvalidArgument,
           OptionParser::MissingArgument => e
-          error_handler&.call(e) ||
+          error_handler&.call(self, e) ||
             abort(e.to_s)
         rescue => e
-          error_handler&.call(e) ||
+          error_handler&.call(self, e) ||
             if @never_trace || @silent_trace
               abort("error: #{e}.")
             else
@@ -324,23 +344,27 @@ module Commander
 
     def create_default_commands
       command :help do |c|
-        c.syntax = 'commander help [command]'
+        c.syntax = "#{program(:name)} help [command]"
         c.description = 'Display global or [command] help documentation'
-        c.example 'Display global help', 'command help'
-        c.example "Display help for 'foo'", 'command help foo'
+        c.example 'Display global help', "#{program(:name)} help"
+        c.example "Display help for 'foo'", "#{program(:name)} help foo"
         c.when_called do |args, _options|
           UI.enable_paging if program(:help_paging)
           @help_commands = @commands.dup
-          if args.empty?
+          if args.empty? || args[0] == :error
             @help_options = @options.reject {|o| o[:switches].first == '--trace'}
             @help_commands.reject! { |k, v| !!v.hidden }
+            old_wrap = $terminal.wrap_at
+            $terminal.wrap_at = nil
+            program(:nobanner, true) if args[0] == :error
             say help_formatter.render
+            $terminal.wrap_at = old_wrap
           else
             command = command args.join(' ')
             begin
               require_valid_command command
             rescue InvalidCommandError => e
-              error_handler&.call(e) ||
+              error_handler&.call(self, e) ||
                 abort("#{e}. Use --help for more information")
             end
             if command.sub_command_group?

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander-openflighthpc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alces Flight Ltd
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement