commander-openflighthpc 1.0.0.pre.alpha1

data/lib/commander/configure.rb

@@ -0,0 +1,14 @@
+module Commander
+  def configure(*configuration_opts, &configuration_block)
+    configuration_module = Module.new
+    configuration_module.extend Commander::Methods
+
+    configuration_module.class_exec(*configuration_opts, &configuration_block)
+
+    configuration_module.class_exec do
+      run!
+    end
+  end
+
+  module_function :configure
+end

data/lib/commander/core_ext.rb

@@ -0,0 +1,2 @@
+require 'commander/core_ext/array'
+require 'commander/core_ext/object'

data/lib/commander/core_ext/array.rb

@@ -0,0 +1,24 @@
+class Array
+  ##
+  # Split _string_ into an array. Used in
+  # conjunction with Highline's #ask, or #ask_for_array
+  # methods, which must respond to #parse.
+  #
+  # This method allows escaping of whitespace. For example
+  # the arguments foo bar\ baz will become ['foo', 'bar baz']
+  #
+  # === Example
+  #
+  #   # ask invokes Array#parse
+  #   list = ask 'Favorite cookies:', Array
+  #
+  #   # or use ask_for_CLASS
+  #   list = ask_for_array 'Favorite cookies: '
+  #
+
+  def self.parse(string)
+    # Using reverse + lookahead to work around Ruby 1.8's lack of lookbehind
+    # TODO: simplify now that we don't support Ruby 1.8
+    string.reverse.split(/\s(?!\\)/).reverse.map { |s| s.reverse.gsub('\\ ', ' ') }
+  end
+end

data/lib/commander/core_ext/object.rb

@@ -0,0 +1,8 @@
+class Object
+  ##
+  # Return the current binding.
+
+  def get_binding
+    binding
+  end
+end

data/lib/commander/delegates.rb

@@ -0,0 +1,27 @@
+module Commander
+  module Delegates
+    %w(
+      add_command
+      command
+      program
+      error_handler
+      run!
+      global_option
+      alias_command
+      default_command
+      always_trace!
+      never_trace!
+      silent_trace!
+    ).each do |meth|
+      eval <<-END, binding, __FILE__, __LINE__
+        def #{meth}(*args, &block)
+          ::Commander::Runner.instance.#{meth}(*args, &block)
+        end
+      END
+    end
+
+    def defined_commands(*args, &block)
+      ::Commander::Runner.instance.commands(*args, &block)
+    end
+  end
+end

data/lib/commander/help_formatters.rb

@@ -0,0 +1,52 @@
+module Commander
+  module HelpFormatter
+    autoload :Base, 'commander/help_formatters/base'
+    autoload :Terminal, 'commander/help_formatters/terminal'
+    autoload :TerminalCompact, 'commander/help_formatters/terminal_compact'
+
+    class Context
+      def initialize(target)
+        @target = target
+      end
+
+      # NOTE: `get_binding` has been stubbed! This version will be ignored
+      # See patch for actual version
+      prepend Patches::HelpFormatterBinding
+      def get_binding
+        @target.instance_eval { binding }.tap do |bind|
+          decorate_binding(bind)
+        end
+      end
+
+      # No-op, override in subclasses.
+      def decorate_binding(_bind)
+      end
+    end
+
+    class ProgramContext < Context
+      def decorate_binding(bind)
+        bind.eval("max_command_length = #{max_command_length(bind)}")
+        bind.eval("max_aliases_length = #{max_aliases_length(bind)}")
+      end
+
+      def max_command_length(bind)
+        max_key_length(bind.eval('@commands'))
+      end
+
+      def max_aliases_length(bind)
+        max_key_length(bind.eval('@aliases'))
+      end
+
+      def max_key_length(hash, default = 20)
+        longest = hash.keys.max_by(&:size)
+        longest ? longest.size : default
+      end
+    end
+
+    module_function
+
+    def indent(amount, text)
+      text.to_s.gsub("\n", "\n" + (' ' * amount))
+    end
+  end
+end

data/lib/commander/help_formatters/base.rb

@@ -0,0 +1,24 @@
+module Commander
+  ##
+  # = Help Formatter
+  #
+  # Commander's help formatters control the output when
+  # either the help command, or --help switch are called.
+  # The default formatter is Commander::HelpFormatter::Terminal.
+
+  module HelpFormatter
+    class Base
+      def initialize(runner)
+        @runner = runner
+      end
+
+      def render
+        'Implement global help here'
+      end
+
+      def render_command(command)
+        "Implement help for #{command.name} here"
+      end
+    end
+  end
+end

data/lib/commander/help_formatters/terminal.rb

@@ -0,0 +1,24 @@
+require 'erb'
+
+module Commander
+  module HelpFormatter
+    class Terminal < Base
+      def render
+        template(:help).result(ProgramContext.new(@runner).get_binding)
+      end
+
+      def render_command(command)
+        template(:command_help).result(Context.new(command).get_binding)
+      end
+
+      def render_subcommand(command)
+        bind = ProgramContext.new(@runner).get_binding({cmd: command})
+        template(:subcommand_help).result(bind)
+      end
+
+      def template(name)
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), nil, '-')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+<% if !@syntax -%>
+  <%= $terminal.color "NAME", :bold %>:
+
+    <%= @name %>
+<% else -%>
+  <%= $terminal.color "SYNOPSIS", :bold %>:
+
+    <%= @syntax -%>
+
+<% end -%>
+
+  <%= $terminal.color "DESCRIPTION", :bold %>:
+
+    <%= Commander::HelpFormatter.indent 4, (@description || @summary || 'No description.') -%>
+
+<% unless @examples.empty? -%>
+
+  <%= $terminal.color "EXAMPLES", :bold %>:
+	<% for description, command in @examples -%>
+
+    # <%= description %>
+    <%= command %>
+	<% end -%>
+<% end -%>
+<% unless @options.empty? -%>
+
+  <%= $terminal.color "OPTIONS", :bold %>:
+	<% for option in @options -%>
+
+    <%= option[:switches].join ', ' %> 
+        <%= Commander::HelpFormatter.indent 8, option[:description] %><% if option[:default] %>
+        <%= $terminal.color "Default", :bold %>: <%= option[:default] %><% end %>
+  <% end -%>
+<% end -%>
+

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

@@ -0,0 +1,36 @@
+  <%= $terminal.color "NAME", :bold %>:
+
+    <%= program :name %>
+
+  <%= $terminal.color "DESCRIPTION", :bold %>:
+
+    <%= Commander::HelpFormatter.indent 4, program(:description) %>
+
+  <%= $terminal.color "COMMANDS", :bold %>:
+<% for name, command in @help_commands.sort -%>
+	<% unless alias? name %>
+    <%= "%-#{max_command_length}s %s" % [command.name, command.summary || command.description] -%>
+	<% end -%>
+<% end %>
+<% unless @aliases.empty? %>
+  <%= $terminal.color "ALIASES", :bold %>:
+  <% for alias_name, args in @aliases.sort %>
+    <%= "%-#{max_aliases_length}s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] -%>
+  <% end %>
+<% end %>
+<% unless @help_options.empty? -%>
+  <%= $terminal.color "GLOBAL OPTIONS", :bold %>:
+	<% for option in @help_options -%>
+
+    <%= option[:switches].join ', ' %> 
+        <%= option[:description] %>
+	<% end -%>
+<% end -%>
+<% if program :help -%>
+  <% for title, body in program(:help) %>
+  <%= $terminal.color title.to_s.upcase, :bold %>:
+
+    <%= body %>
+  <% end -%>
+<% end -%>
+

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

@@ -0,0 +1,23 @@
+<% if !cmd.syntax %>
+  <%= $terminal.color "NAME", :bold %>:
+
+    <%= cmd.name %>
+<% else -%>
+  <%= $terminal.color "SYNOPSIS", :bold %>:
+
+    <%= cmd.syntax -%>
+
+<% end -%>
+
+  <%= $terminal.color "DESCRIPTION", :bold %>:
+
+    <%= Commander::HelpFormatter.indent 4, (cmd.description || cmd.summary || 'No description.') -%>
+
+
+  <%= $terminal.color "SUBCOMMANDS", :bold %>:
+<% for name, command in @commands.sort -%>
+  <% unless alias? name %>
+    <%= "%-#{max_command_length}s %s" % [command.name, command.summary || command.description] -%>
+  <% end -%>
+<% end %>
+

data/lib/commander/help_formatters/terminal_compact.rb

@@ -0,0 +1,11 @@
+require 'erb'
+
+module Commander
+  module HelpFormatter
+    class TerminalCompact < Terminal
+      def template(name)
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), nil, '-')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+  <%= @name %>
+<% if @syntax -%>
+
+  Usage: <%= @syntax %>
+<% end -%>
+<% if @description || @summary -%>
+
+  <%= @description || @summary %>
+<% end -%>
+<% unless @examples.empty? -%>
+
+  Examples:
+	<% for description, command in @examples -%>
+
+    # <%= description %>
+    <%= command %>
+	<% end -%>
+<% end -%>
+<% unless @options.empty? -%>
+
+  Options:
+<% for option in @options -%>
+    <%= "%-20s %s" % [option[:switches].join(', '), option[:description]] %><% if option[:default] %> <%= option[:default] %><% end %>
+<% end -%>
+<% end -%>
+

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

@@ -0,0 +1,29 @@
+  <%= program :name %>
+
+  <%= program :description %>
+
+  Commands:
+<% for name, command in @help_commands.sort -%>
+<% unless alias? name -%>
+    <%= "%-#{max_command_length}s %s" % [command.name, command.summary || command.description] %>
+<% end -%>
+<% end -%>
+<% unless @aliases.empty? %>
+  Aliases:
+<% for alias_name, args in @aliases.sort -%>
+    <%= "%-#{max_aliases_length}s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] %>
+<% end -%>
+<% end %>
+<% unless @help_options.empty? -%>
+  Global Options:
+<% for option in @help_options -%>
+    <%= "%-20s %s" % [option[:switches].join(', '), option[:description]] -%> 
+<% end -%>
+<% end -%>
+<% if program :help -%>
+  <% for title, body in program(:help) %>
+  <%= title %>:
+    <%= body %>
+  <% end %>
+<% end -%>
+

data/lib/commander/help_formatters/terminal_compact/subcommand_help.erb

@@ -0,0 +1,15 @@
+  <%= cmd.name %>
+<% if cmd.syntax -%>
+
+  Usage: <%= cmd.syntax %>
+<% end -%>
+<% if cmd.description || cmd.summary -%>
+
+  <%= cmd.description || cmd.summary %>
+<% end -%>
+
+<% for name, command in @commands.sort -%>
+<% unless alias? name -%>
+    <%= "%-#{max_command_length}s %s" % [command.name, command.summary || command.description] %>
+<% end -%>
+<% end -%>

data/lib/commander/import.rb

@@ -0,0 +1,5 @@
+require 'commander'
+
+include Commander::Methods
+
+at_exit { run! }

data/lib/commander/methods.rb

@@ -0,0 +1,11 @@
+module Commander
+  module Methods
+    include Commander::UI
+    include Commander::UI::AskForClass
+    include Commander::Delegates
+
+    if $stdin.tty? && (cols = $terminal.output_cols) >= 40
+      $terminal.wrap_at = cols - 5
+    end
+  end
+end

data/lib/commander/patches/decimal-integer.rb

@@ -0,0 +1,17 @@
+# Patches the underling OptionParser DecimalInteger type so that it doesn't
+# convert numbers starting with a '0' as if they are an Octal number
+module Commander
+  module Patches
+    module DecimalInteger
+      decimal = '\d+(?:_\d+)*'
+      DecimalInteger = /\A[-+]?#{decimal}\z/io
+      ::OptionParser::accept(DecimalInteger, DecimalInteger) {|s,|
+        begin
+          Integer(s, 10)
+        rescue ArgumentError
+          raise ::OptionParser::InvalidArgument, s
+        end if s
+      }
+    end
+  end
+end

data/lib/commander/patches/help_formatter_binding.rb

@@ -0,0 +1,15 @@
+module Commander
+  module Patches
+    module HelpFormatterBinding
+      def get_binding(additional = {})
+        bnd = @target.instance_eval { binding }.tap do |bind|
+          decorate_binding(bind)
+        end
+        additional.each do |k, v|
+          bnd.local_variable_set(k, v)
+        end
+        bnd
+      end
+    end
+  end
+end

data/lib/commander/patches/implicit-short-tags.rb

@@ -0,0 +1,75 @@
+# Patches the underling ruby OptionParser to prevent it from automatically
+# generating short tags for options
+module Commander
+  module Patches
+    module ImplicitShortTags
+      def parse_in_order(argv = default_argv, setter = nil, &nonopt)  # :nodoc:
+        opt, arg, val, rest = nil
+        nonopt ||= proc {|a| throw :terminate, a}
+        argv.unshift(arg) if arg = catch(:terminate) {
+          while arg = argv.shift
+            case arg
+            # long option
+            when /\A--([^=]*)(?:=(.*))?/m
+              opt, rest = $1, $2
+              opt.tr!('_', '-')
+              begin
+                sw, = complete(:long, opt, true)
+              rescue ::OptionParser::ParseError
+                raise $!.set_option(arg, true)
+              end
+              begin
+                opt, cb, val = sw.parse(rest, argv) {|*exc| raise(*exc)}
+                val = cb.call(val) if cb
+                setter.call(sw.switch_name, val) if setter
+              rescue ::OptionParser::ParseError
+                raise $!.set_option(arg, rest)
+              end
+
+            # short option
+            when /\A-(.)((=).*|.+)?/m
+              eq, rest, opt = $3, $2, $1
+              has_arg, val = eq, rest
+              begin
+                sw, = search(:short, opt)
+                unless sw
+                  sw, = complete(:short, opt)
+                  # short option matched.
+                  val = arg.sub(/\A-/, '')
+                  has_arg = true
+                end
+              rescue ::OptionParser::ParseError
+                raise $!.set_option(arg, true)
+              end
+              begin
+                opt, cb, val = sw.parse(val, argv) {|*exc| raise(*exc) if eq}
+                raise InvalidOption, arg if has_arg and !eq and arg == "-#{opt}"
+                argv.unshift(opt) if opt and (!rest or (opt = opt.sub(/\A-*/, '-')) != '-')
+                val = cb.call(val) if cb
+                setter.call(sw.switch_name, val) if setter
+              rescue ::OptionParser::ParseError
+                raise $!.set_option(arg, arg.length > 2)
+              end
+
+            # non-option argument
+            else
+              catch(:prune) do
+                visit(:each_option) do |sw0|
+                  sw = sw0
+                  sw.block.call(arg) if ::OptionParser::Switch === sw and sw.match_nonswitch?(arg)
+                end
+                nonopt.call(arg)
+              end
+            end
+          end
+
+          nil
+        }
+
+        visit(:search, :short, nil) {|sw| sw.block.call(*argv) if !sw.pattern}
+
+        argv
+      end
+    end
+  end
+end