commander-openflighthpc 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2bd1303f7a91cad5cadac934d35ee270a9b2441db7c37685a669b000f8782b5
-  data.tar.gz: '004078c3f1ee373463a37430dbc18207747907e12bc2d4b479903e1f08d1f200'
+  metadata.gz: 2f44f3e008d2afe4767d93545e1f96bee55eb972e1b8558f6ed214bf18290079
+  data.tar.gz: fc44c6aa1a350fe8be8d8ea1a79cd3841dc82b59fb5fab14040f4eaac2e199cd
 SHA512:
-  metadata.gz: d2a0c2e988bcec7ce6d0a811777588684652b762c3886a4b7bbb25a79443fe924b8d726e6e576734769cbcf852f0bb1200717a5a509c3e25303846228ef28b7e
-  data.tar.gz: b62447900fdf781e69886d657c5470dc59ca935daeee043c08308689f5b7f24375535261f3f28f311754943a8ce8efbaf75d04ac4a0e53430f7dfa9cafeca424
+  metadata.gz: 2b9a7db7d0cc5f8b08c8e2d894ace171c8a7d8527142c8117eb1705fc563d9504d92ddbe6abb56abc94526a9d2a3fb11f226191aa1f629a9a72a42bd95bc8c98
+  data.tar.gz: 55004b7e9ff3f42cbdc5a5d99281d24f9eb88f441bfbc8465fe2ea8792fc817ec8c06ada2a2f0dd66f6820264507fda8ff575941b265faacefa7ab2be32b96e0

data/README.md

@@ -115,171 +115,22 @@ require 'rubygems'
 require 'commander'
 
 class MyApplication
-  include Commander::Methods
-
-  def run
-    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
-
-    run!
-  end
-end
+  extend Commander::CLI
 
-MyApplication.new.run if $0 == __FILE__
-```
-
-### Block style
-
-```ruby
-require 'rubygems'
-require 'commander'
-
-Commander.configure do
   program :name, 'Foo Bar'
   program :version, '1.0.0'
   program :description, 'Stupid command that prints foo or bar.'
 
-  # see classic style example for options
-end
-```
-
-## HighLine
-
-As mentioned above, the highline gem is imported into the global scope. Here
-are some quick examples for how to utilize highline in your commands:
-
-```ruby
-# Ask for password masked with '*' character
-ask("Password:  ") { |q| q.echo = "*" }
-
-# Ask for password
-ask("Password:  ") { |q| q.echo = false }
-
-# Ask if the user agrees (yes or no)
-agree("Do something?")
-
-# Asks on a single line (note the space after ':')
-ask("Name: ")
-
-# Asks with new line after "Description:"
-ask("Description:")
-
-# Calls Date#parse to parse the date string passed
-ask("Birthday? ", Date)
-
-# Ensures Integer is within the range specified
-ask("Age? ", Integer) { |q| q.in = 0..105 }
-
-# Asks for a list of strings, converts to array
-ask("Fav colors?", Array)
-```
-
-## HighLine & Interaction Additions
-
-In addition to highline's fantastic choice of methods, commander adds the
-following methods to simplify common tasks:
-
-```ruby
-# Ask for password
-password
-
-# Ask for password with specific message and mask character
-password "Enter your password please:", '-'
-
-# Ask for CLASS, which may be any valid class responding to #parse. Date, Time, Array, etc
-names = ask_for_array 'Names: '
-bday = ask_for_date 'Birthday?: '
-
-# Simple progress bar (Commander::UI::ProgressBar)
-uris = %w[
-  http://vision-media.ca
-  http://google.com
-  http://yahoo.com
-]
-progress uris do |uri|
-  res = open uri
-  # Do something with response
-end
-
-# 'Log' action to stdout
-log "create", "path/to/file.rb"
-
-# Enable paging of output after this point
-enable_paging
-
-# Ask editor for input (EDITOR environment variable or whichever is available: TextMate, vim, vi, emacs, nano, pico)
-ask_editor
-
-# Ask editor, supplying initial text
-ask_editor 'previous data to update'
-
-# Ask editor, preferring a specific editor
-ask_editor 'previous data', 'vim'
-
-# Choose from an array of elements
-choice = choose("Favorite language?", :ruby, :perl, :js)
-
-# Alter IO for the duration of the block
-io new_input, new_output do
-  new_input_contents = $stdin.read
-  puts new_input_contents # outputs to new_output stream
-end
-# $stdin / $stdout reset back to original streams
-
-# Speech synthesis
-speak 'What is your favorite food? '
-food = ask 'favorite food?: '
-speak "Wow, I like #{food} too. We have so much in common."
-speak "I like #{food} as well!", "Victoria", 190
-
-# Execute arbitrary applescript
-applescript 'foo'
-
-# Converse with speech recognition server
-case converse 'What is the best food?', :cookies => 'Cookies', :unknown => 'Nothing'
-when :cookies
-  speak 'o.m.g. you are awesome!'
-else
-  case converse 'That is lame, shall I convince you cookies are the best?', :yes => 'Ok', :no => 'No', :maybe => 'Maybe another time'
-  when :yes
-    speak 'Well you see, cookies are just fantastic, they melt in your mouth.'
-  else
-    speak 'Ok then, bye.'
+  command :foo do |c|
+    c.syntax = 'foobar foo'
+    c.description = 'Displays foo'
+    c.action do |args, options|
+      say 'foo'
+    end
   end
 end
-```
-
-## Growl Notifications
-
-Commander provides methods for displaying Growl notifications. To use these
-methods you need to install http://github.com/tj/growl which utilizes
-the [growlnotify](http://growl.info/extras.php#growlnotify) executable. Note that
-growl is auto-imported by Commander when available, no need to require.
-
-```ruby
-# Display a generic Growl notification
-notify 'Something happened'
-
-# Display an 'info' status notification
-notify_info 'You have #{emails.length} new email(s)'
 
-# Display an 'ok' status notification
-notify_ok 'Gems updated'
-
-# Display a 'warning' status notification
-notify_warning '1 gem failed installation'
-
-# Display an 'error' status notification
-notify_error "Gem #{name} failed"
+MyApplication.run!(ARGV) if $0 == __FILE__
 ```
 
 ## Commander Goodies
@@ -439,25 +290,7 @@ This abstraction could be utilized to generate HTML documentation for your execu
 
 ### Tracing
 
-By default the `-t` and `--trace` global options are provided to allow users to get a backtrace to aid debugging.
-
-You can disable these options:
-
-```ruby
-never_trace!
-```
-
-Or make it always on:
-
-```ruby
-always_trace!
-```
-
-Include the `--trace` global option but turn off the error message prompt:
-
-```ruby
-silent_trace!
-```
+WIP: Update OpenFlight --trace behaviour
 
 ## Tips
 

data/lib/commander.rb

@@ -25,12 +25,9 @@ require 'highline'
 $terminal = HighLine.new
 require 'commander/version'
 require 'commander/blank'
-require 'commander/user_interaction'
 require 'commander/core_ext'
 require 'commander/runner'
 require 'commander/command'
 require 'commander/help_formatters'
 require 'commander/platform'
-require 'commander/delegates'
-require 'commander/methods'
-require 'commander/configure'
+require 'commander/cli'

data/lib/commander/cli.rb

@@ -0,0 +1,180 @@
+module Commander
+  module CLI
+    ##
+    # Wrapper run command with error handling
+    def run!(*args)
+      instance = Runner.new(
+        @program, commands, default_command,
+        global_options, aliases, args
+      )
+      instance.run
+    rescue StandardError, Interrupt => e
+      $stderr.puts e.backtrace.reverse if args.include?('--trace')
+      error_handler(instance, e)
+    end
+
+    ##
+    # Assign program information.
+    #
+    # === Examples
+    #
+    #   # Set data
+    #   program :name, 'Commander'
+    #   program :version, Commander::VERSION
+    #   program :description, 'Commander utility program.'
+    #   program :help, 'Copyright', '2008 TJ Holowaychuk'
+    #   program :help, 'Anything', 'You want'
+    #   program :help_formatter, :compact
+    #   program :help_formatter, Commander::HelpFormatter::TerminalCompact
+    #
+    #   # Get data
+    #   program :name # => 'Commander'
+    #
+    # === Keys
+    #
+    #   :version         (required) Program version triple, ex: '0.0.1'
+    #   :description     (required) Program description
+    #   :name            Program name, defaults to basename of executable
+    #   :help_formatter  Defaults to Commander::HelpFormatter::Terminal
+    #   :help            Allows addition of arbitrary global help blocks
+    #   :help_paging     Flag for toggling help paging
+    #
+
+    def program(key, *args, &block)
+      @program ||= {
+        help_formatter: HelpFormatter::Terminal,
+        name: File.basename($PROGRAM_NAME),
+        help_paging: true,
+      }
+
+      if key == :help && !args.empty?
+        @program[:help] ||= {}
+        @program[:help][args.first] = args.at(1)
+      elsif key == :help_formatter && !args.empty?
+        @program[key] = (@help_formatter_aliases[args.first] || args.first)
+      elsif block
+        @program[key] = block
+      else
+        unless args.empty?
+          @program[key] = args.count == 1 ? args[0] : args
+        end
+        @program[key]
+      end
+    end
+
+    ##
+    # Default command _name_ to be used when no other
+    # command is found in the arguments.
+
+    def default_command(name = nil)
+      @default_command = name unless name.nil?
+      @default_command
+    end
+
+
+    ##
+    # Hash of Command objects
+    def commands
+      @commands ||= {}
+    end
+
+    ##
+    # Hash of Global Options
+    def global_options
+      @global_options ||= begin
+        @global_options = [] # Allows Recursive - Refactor
+        global_option('-h', '--help', 'Display help documentation') do
+          args = @args - %w(-h --help)
+          command(:help).run(*args)
+          exit 0
+        end
+        global_option('--version', 'Display version information') do
+          say version
+          exit 0
+        end
+      end
+    end
+
+    ##
+    # Add a global option; follows the same syntax as Command#option
+    # This would be used for switches such as --version
+    # NOTE: --trace is special and does not appear in the help
+    # It is intended for debugging purposes
+
+    def global_option(*args, &block)
+      switches, description = Runner.separate_switches_from_description(*args)
+      global_options << {
+        args: args,
+        proc: block,
+        switches: switches,
+        description: description,
+      }
+    end
+
+    ##
+    # Define and get a command by name
+    #
+    def command(name)
+      name = name.to_s
+      (commands[name] ||= Command.new(name)).tap do |cmd|
+        yield cmd if block_given?
+      end
+    end
+
+    # A hash of known aliases
+    def aliases
+      @aliases ||= {}
+    end
+
+    ##
+    # Alias command _name_ with _alias_name_. Optionally _args_ may be passed
+    # as if they were being passed straight to the original command via the command-line.
+
+    def alias_command(alias_name, name, *args)
+      commands[alias_name.to_s] = command name
+      aliases[alias_name.to_s] = args
+    end
+
+    def error_handler(runner, e)
+      error_msg = "#{Paint[runner.program(:name), '#2794d8']}: #{Paint[e.to_s, :red, :bright]}"
+      exit_code = e.respond_to?(:exit_code) ?  e.exit_code.to_i : 1
+      case e
+      when OptionParser::InvalidOption,
+           Commander::Runner::InvalidCommandError,
+           Commander::Patches::CommandUsageError
+        # Display the error message for a specific command. Most likely due to
+        # invalid command syntax
+        if cmd = runner.active_command
+          $stderr.puts error_msg
+          $stderr.puts "\nUsage:\n\n"
+          runner.command('help').run(cmd.name)
+        # Display the main app help text when called without `--help`
+        elsif runner.args_without_command_name.empty?
+          $stderr.puts "Usage:\n\n"
+          runner.command('help').run(:error)
+        # Display the main app help text when called with arguments. Mostly
+        # likely an invalid syntax error
+        else
+          $stderr.puts error_msg
+          $stderr.puts "\nUsage:\n\n"
+          runner.command('help').run(:error)
+        end
+        exit_code = 254
+      # Display the help text for sub command groups when called without `--help`
+      when SubCommandGroupError
+        if cmd = runner.active_command
+          $stderr.puts "Usage:\n\n"
+          runner.command('help').run(cmd.name)
+        end
+        exit_code = 254
+      when Interrupt
+        $stderr.puts 'Received Interrupt!'
+        exit_code = 255
+      # Catch all error message for all other issues
+      else
+        $stderr.puts error_msg
+      end
+      exit(exit_code)
+    end
+  end
+end

data/lib/commander/import.rb

@@ -1,5 +1,5 @@
 require 'commander'
 
-include Commander::Methods
+extend Commander::CLI
 
-at_exit { run! }
+at_exit { run!(ARGV) }

data/lib/commander/runner.rb

@@ -2,42 +2,6 @@ require 'paint'
 
 module Commander
   class Runner
-    DEFAULT_ERROR_HANDLER = lambda do |runner, e|
-      error_msg = "#{Paint[runner.program(:name), '#2794d8']}: #{Paint[e.to_s, :red, :bright]}"
-      case e
-      when OptionParser::InvalidOption,
-           Commander::Runner::InvalidCommandError,
-           Commander::Patches::CommandUsageError
-        # Display the error message for a specific command. Most likely due to
-        # invalid command syntax
-        if cmd = runner.active_command
-          $stderr.puts error_msg
-          $stderr.puts "\nUsage:\n\n"
-          runner.command('help').run(cmd.name)
-        # Display the main app help text when called without `--help`
-        elsif runner.args_without_command_name.empty?
-          $stderr.puts "Usage:\n\n"
-          runner.command('help').run(:error)
-        # Display the main app help text when called with arguments. Mostly
-        # likely an invalid syntax error
-        else
-          $stderr.puts error_msg
-          $stderr.puts "\nUsage:\n\n"
-          runner.command('help').run(:error)
-        end
-      # Display the help text for sub command groups when called without `--help`
-      when SubCommandGroupError
-        if cmd = runner.active_command
-          $stderr.puts "Usage:\n\n"
-          runner.command('help').run(cmd.name)
-        end
-      # Catch all error message for all other issues
-      else
-        $stderr.puts error_msg
-      end
-      exit(1)
-    end
-
     #--
     # Exceptions
     #++
@@ -63,67 +27,37 @@ module Commander
     # Initialize a new command runner. Optionally
     # supplying _args_ for mocking, or arbitrary usage.
 
-    def initialize(args = ARGV)
-      @args, @commands, @aliases, @options = args, {}, {}, []
-      @help_formatter_aliases = help_formatter_alias_defaults
-      @program = program_defaults
-      @always_trace = false
-      @never_trace = false
-      @silent_trace = false
-      @error_handler = DEFAULT_ERROR_HANDLER
-      create_default_commands
-    end
-
     ##
-    # Return singleton Runner instance.
+    # Display the backtrace in the event of an error
+    attr_accessor :trace
 
-    def self.instance
-      @singleton ||= new
+    def initialize(*inputs)
+      @program, @commands, @default_command, \
+        @options, @aliases, @args = inputs.map(&:dup)
+      @args.reject! { |a| a == '--trace' }
+      @commands['help'] ||= Command.new('help').tap do |c|
+        c.syntax = "#{program(:name)} help [command]"
+        c.description = 'Display global or [command] help documentation'
+        c.example 'Display global help', "#{program(:name)} help"
+        c.example "Display help for 'foo'", "#{program(:name)} help foo"
+        c.when_called do |help_args, _|
+          self.run_help_command(help_args)
+        end
+      end
+      @help_formatter_aliases = help_formatter_alias_defaults
     end
 
     ##
-    # Run command parsing and execution process.
+    # Run command parsing and execution process
+    # NOTE: This method does not have error handling, see: run!
 
-    def run!
-      trace = @always_trace || false
+    def run
       require_program :version, :description
-      trap('INT') { abort program(:int_message) } if program(:int_message)
-      trap('INT') { program(:int_block).call } if program(:int_block)
-      global_option('-h', '--help', 'Display help documentation') do
-        args = @args - %w(-h --help)
-        command(:help).run(*args)
-        return
-      end
-      global_option('--version', 'Display version information') do
-        say version
-        return
-      end
-      global_option('--trace', 'Display backtrace when an error occurs') { trace = true } unless @never_trace || @always_trace
+
       parse_global_options
       remove_global_options options, @args
-      if trace
-        run_active_command
-      else
-        begin
-          run_active_command
-        rescue InvalidCommandError => e
-          error_handler&.call(self, e) ||
-            abort("#{e}. Use --help for more information")
-        rescue \
-          OptionParser::InvalidOption,
-          OptionParser::InvalidArgument,
-          OptionParser::MissingArgument => e
-          error_handler&.call(self, e) ||
-            abort(e.to_s)
-        rescue => e
-          error_handler&.call(self, e) ||
-            if @never_trace || @silent_trace
-              abort("error: #{e}.")
-            else
-              abort("error: #{e}. Use --trace to view backtrace")
-            end
-        end
-      end
+
+      run_active_command
     end
 
     ##
@@ -134,83 +68,11 @@ module Commander
     end
 
     ##
-    # Enable tracing on all executions (bypasses --trace)
-
-    def always_trace!
-      @always_trace = true
-      @never_trace = false
-      @silent_trace = false
-    end
-
-    ##
-    # Hide the trace option from the help menus and don't add it as a global option
-
-    def never_trace!
-      @always_trace = false
-      @never_trace = true
-      @silent_trace = false
-    end
-
-    ##
-    # Includes the trace option in the help but not in the error message
-
-    def silent_trace!
-      @always_trace = false
-      @never_trace = false
-      @silent_trace = true
-    end
-
-    ##
-    # Set a handler to be used for advanced exception handling
-
-    def error_handler(&block)
-      @error_handler = block if block
-      @error_handler
-    end
-
-    ##
-    # Assign program information.
-    #
-    # === Examples
-    #
-    #   # Set data
-    #   program :name, 'Commander'
-    #   program :version, Commander::VERSION
-    #   program :description, 'Commander utility program.'
-    #   program :help, 'Copyright', '2008 TJ Holowaychuk'
-    #   program :help, 'Anything', 'You want'
-    #   program :int_message 'Bye bye!'
-    #   program :help_formatter, :compact
-    #   program :help_formatter, Commander::HelpFormatter::TerminalCompact
-    #
-    #   # Get data
-    #   program :name # => 'Commander'
+    # The hash of program variables
     #
-    # === Keys
-    #
-    #   :version         (required) Program version triple, ex: '0.0.1'
-    #   :description     (required) Program description
-    #   :name            Program name, defaults to basename of executable
-    #   :help_formatter  Defaults to Commander::HelpFormatter::Terminal
-    #   :help            Allows addition of arbitrary global help blocks
-    #   :help_paging     Flag for toggling help paging
-    #   :int_message     Message to display when interrupted (CTRL + C)
-    #
-
-    def program(key, *args, &block)
-      if key == :help && !args.empty?
-        @program[:help] ||= {}
-        @program[:help][args.first] = args.at(1)
-      elsif key == :help_formatter && !args.empty?
-        @program[key] = (@help_formatter_aliases[args.first] || args.first)
-      elsif block
-        @program[key] = block
-      else
-        unless args.empty?
-          @program[key] = args.count == 1 ? args[0] : args
-        end
-        @program[key]
-      end
+    def program(key, default = nil)
+      @program[key] ||= default if default
+      @program[key]
     end
 
     ##
@@ -227,49 +89,10 @@ module Commander
     #   end
     #
 
-    def command(name, &block)
-      yield add_command(Commander::Command.new(name)) if block
+    def command(name)
       @commands[name.to_s]
     end
 
-    ##
-    # Add a global option; follows the same syntax as Command#option
-    # This would be used for switches such as --version, --trace, etc.
-
-    def global_option(*args, &block)
-      switches, description = Runner.separate_switches_from_description(*args)
-      @options << {
-        args: args,
-        proc: block,
-        switches: switches,
-        description: description,
-      }
-    end
-
-    ##
-    # Alias command _name_ with _alias_name_. Optionally _args_ may be passed
-    # as if they were being passed straight to the original command via the command-line.
-
-    def alias_command(alias_name, name, *args)
-      @commands[alias_name.to_s] = command name
-      @aliases[alias_name.to_s] = args
-    end
-
-    ##
-    # Default command _name_ to be used when no other
-    # command is found in the arguments.
-
-    def default_command(name)
-      @default_command = name
-    end
-
-    ##
-    # Add a command object to this runner.
-
-    def add_command(command)
-      @commands[command.name] = command
-    end
-
     ##
     # Check if command _name_ is an alias.
 
@@ -336,17 +159,6 @@ module Commander
       }
     end
 
-    ##
-    # Returns hash of program defaults.
-
-    def program_defaults
-      {
-        help_formatter: HelpFormatter::Terminal,
-        name: File.basename($PROGRAM_NAME),
-        help_paging: true,
-      }
-    end
-
     ##
     # Limit commands to those which are subcommands of the one that is active
     def limit_commands_to_subcommands(command)
@@ -368,39 +180,25 @@ module Commander
     ##
     # Creates default commands such as 'help' which is
     # essentially the same as using the --help switch.
-
-    def create_default_commands
-      command :help do |c|
-        c.syntax = "#{program(:name)} help [command]"
-        c.description = 'Display global or [command] help documentation'
-        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? || 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(self, e) ||
-                abort("#{e}. Use --help for more information")
-            end
-            if command.sub_command_group?
-              limit_commands_to_subcommands(command)
-              say help_formatter.render_subcommand(command)
-            else
-              say help_formatter.render_command(command)
-            end
-          end
+    def run_help_command(args)
+      UI.enable_paging if program(:help_paging)
+      @help_commands = @commands.dup
+      if args.empty? || args[0] == :error
+        @help_options = @options
+        @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(' ')
+        require_valid_command command
+        if command.sub_command_group?
+          limit_commands_to_subcommands(command)
+          say help_formatter.render_subcommand(command)
+        else
+          say help_formatter.render_command(command)
         end
       end
     end
@@ -487,7 +285,9 @@ module Commander
         unless active_command.nil?
           active_command.proxy_options << [Runner.switch_to_sym(switches.last), value]
         end
-        yield value if block && !value.nil?
+        if block && !value.nil?
+          instance_exec(value, &block)
+        end
       end
     end