commander-openflighthpc 1.0.0.pre.alpha1

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+  t.rspec_opts = '--color --order random'
+end
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bin/commander

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+
+program :name, 'commander'
+program :version, Commander::VERSION
+program :description, 'Commander utility program.'
+
+command :init do |c|
+  c.syntax = 'commander init [option] <file>'
+  c.summary = 'Initialize a commander template'
+  c.description = 'Initialize an empty <file> with a commander template,
+    allowing very quick creation of commander executables.'
+  c.example 'Create a new classic style template file.', 'commander init bin/my_executable'
+  c.example 'Create a new modular style template file.', 'commander init --modular bin/my_executable'
+  c.option '-m', '--modular', 'Initialize a modular style template'
+  c.action do |args, options|
+    file = args.shift || abort('file argument required.')
+    name = ask 'Machine name of program: '
+    description = ask 'Describe your program: '
+    commands = ask_for_array 'List the commands you wish to create: '
+    begin
+      if options.modular
+        File.open(file, 'w') do |f|
+          f.write <<-"...".gsub!(/^ {10}/, '')
+          #!/usr/bin/env ruby
+
+          require 'rubygems'
+          require 'commander'
+
+          class MyApplication
+            include Commander::Methods
+            # include whatever modules you need
+
+            def run
+              program :name, '#{name}'
+              program :version, '0.0.1'
+              program :description, '#{description}'
+
+          ...
+          commands.each do |command|
+            f.write <<-"...".gsub!(/^ {12}/, '')
+                command :#{command} do |c|
+                  c.syntax = '#{name} #{command} [options]'
+                  c.summary = ''
+                  c.description = ''
+                  c.example 'description', 'command example'
+                  c.option '--some-switch', 'Some switch that does something'
+                  c.action do |args, options|
+                    # Do something or c.when_called #{name.capitalize}::Commands::#{command.capitalize}
+                  end
+                end
+
+            ...
+          end
+          f.write <<-"...".gsub!(/^ {12}/, '')
+                run!
+              end
+            end
+
+            MyApplication.new.run if $0 == __FILE__
+          ...
+        end
+
+        File.chmod(0755, file)
+        say "Initialized modular template in #{file}"
+      else
+        File.open(file, 'w') do |f|
+          f.write <<-"...".gsub!(/^ {10}/, '')
+          #!/usr/bin/env ruby
+
+          require 'rubygems'
+          require 'commander/import'
+
+          program :name, '#{name}'
+          program :version, '0.0.1'
+          program :description, '#{description}'
+
+          ...
+          commands.each do |command|
+            f.write <<-"...".gsub!(/^ {12}/, '')
+            command :#{command} do |c|
+              c.syntax = '#{name} #{command} [options]'
+              c.summary = ''
+              c.description = ''
+              c.example 'description', 'command example'
+              c.option '--some-switch', 'Some switch that does something'
+              c.action do |args, options|
+                # Do something or c.when_called #{name.capitalize}::Commands::#{command.capitalize}
+              end
+            end
+
+            ...
+          end
+        end
+        File.chmod 0755, file
+        say "Initialized template in #{file}"
+      end
+    rescue => e
+      abort e
+    end
+  end
+end

data/commander-openflighthpc.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'commander/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'commander-openflighthpc'
+  s.version     = Commander::VERSION
+  s.authors     = ['Alces Flight Ltd', 'TJ Holowaychuk', 'Gabriel Gilder']
+  s.email       = ['flight@openflighthpc.org']
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/openflighthpc/commander-openflighthpc'
+  s.summary     = 'The complete solution for Ruby command-line executables'
+  s.description = 'The complete solution for Ruby command-line executables. Commander bridges the gap between other terminal related libraries you know and love (OptionParser, HighLine), while providing many new features, and an elegant API.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('highline', '~> 1.7.2')
+
+  s.add_development_dependency('rspec', '~> 3.2')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('simplecov')
+  if RUBY_VERSION < '2.0'
+    s.add_development_dependency('rubocop', '~> 0.41.1')
+    s.add_development_dependency('json', '< 2.0')
+  else
+    s.add_development_dependency('rubocop', '~> 0.49.1')
+  end
+end

data/lib/commander.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2008-2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+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'

data/lib/commander/blank.rb

@@ -0,0 +1,7 @@
+module Blank
+  def self.included(base)
+    base.class_eval do
+      instance_methods.each { |m| undef_method m unless m =~ /^__|object_id/ }
+    end
+  end
+end

data/lib/commander/command.rb

@@ -0,0 +1,263 @@
+require 'optparse'
+require 'commander/patches/implicit-short-tags'
+require 'commander/patches/decimal-integer'
+require 'commander/patches/validate_inputs'
+require 'commander/patches/option_defaults'
+require 'commander/patches/help_formatter_binding'
+
+OptionParser.prepend Commander::Patches::ImplicitShortTags
+OptionParser.prepend Commander::Patches::DecimalInteger
+
+module Commander
+  class Command
+    prepend Patches::ValidateInputs
+
+    attr_accessor :name, :examples, :syntax, :description
+    attr_accessor :summary, :proxy_options, :options, :hidden
+    attr_reader :sub_command_group
+
+    alias sub_command= hidden=
+    alias sub_command hidden
+
+    ##
+    # Options struct.
+
+    class Options
+      include Blank
+
+      def initialize
+        @table = {}
+      end
+
+      def __hash__
+        @table
+      end
+
+      def method_missing(meth, *args)
+        meth.to_s =~ /=$/ ? @table[meth.to_s.chop.to_sym] = args.first : @table[meth]
+      end
+
+      def default(defaults = {})
+        @table = defaults.merge! @table
+      end
+
+      def inspect
+        "<Commander::Command::Options #{ __hash__.map { |k, v| "#{k}=#{v.inspect}" }.join(', ') }>"
+      end
+    end
+
+    ##
+    # Initialize new command with specified _name_.
+
+    def initialize(name)
+      @name, @examples, @when_called = name.to_s, [], []
+      @options, @proxy_options = [], []
+    end
+
+    ##
+    # Add a usage example for this command.
+    #
+    # Usage examples are later displayed in help documentation
+    # created by the help formatters.
+    #
+    # === Examples
+    #
+    #   command :something do |c|
+    #     c.example "Should do something", "my_command something"
+    #   end
+    #
+
+    def example(description, command)
+      @examples << [description, command]
+    end
+
+    ##
+    # Add an option.
+    #
+    # Options are parsed via OptionParser so view it
+    # for additional usage documentation. A block may optionally be
+    # passed to handle the option, otherwise the _options_ struct seen below
+    # contains the results of this option. This handles common formats such as:
+    #
+    #   -h, --help          options.help           # => bool
+    #   --[no-]feature      options.feature        # => bool
+    #   --large-switch      options.large_switch   # => bool
+    #   --file FILE         options.file           # => file passed
+    #   --list WORDS        options.list           # => array
+    #   --date [DATE]       options.date           # => date or nil when optional argument not set
+    #
+    # === Examples
+    #
+    #   command :something do |c|
+    #     c.option '--recursive', 'Do something recursively'
+    #     c.option '--file FILE', 'Specify a file'
+    #     c.option('--info', 'Display info') { puts "handle with block" }
+    #     c.option '--[no-]feature', 'With or without feature'
+    #     c.option '--list FILES', Array, 'List the files specified'
+    #
+    #     c.when_called do |args, options|
+    #       do_something_recursively if options.recursive
+    #       do_something_with_file options.file if options.file
+    #     end
+    #   end
+    #
+    # === Help Formatters
+    #
+    # This method also parses the arguments passed in order to determine
+    # which were switches, and which were descriptions for the
+    # option which can later be used within help formatters
+    # using option[:switches] and option[:description].
+    #
+    # === Input Parsing
+    #
+    # Since Commander utilizes OptionParser you can pre-parse and evaluate
+    # option arguments. Simply require 'optparse/time', or 'optparse/date', as these
+    # objects must respond to #parse.
+    #
+    #   c.option '--time TIME', Time
+    #   c.option '--date [DATE]', Date
+    #
+
+    # NOTE: This method is being patched to handle defaults differently
+    prepend Patches::OptionDefaults
+    def option(*args, &block)
+      switches, description = Runner.separate_switches_from_description(*args)
+      proc = block || option_proc(switches)
+      @options << {
+        args: args,
+        proc: proc,
+        switches: switches,
+        description: description,
+      }
+    end
+
+    ##
+    # Handle execution of command. The handler may be a class,
+    # object, or block (see examples below).
+    #
+    # === Examples
+    #
+    #   # Simple block handling
+    #   c.when_called do |args, options|
+    #      # do something
+    #   end
+    #
+    #   # Create inst of Something and pass args / options
+    #   c.when_called MyLib::Command::Something
+    #
+    #   # Create inst of Something and use arbitrary method
+    #    c.when_called MyLib::Command::Something, :some_method
+    #
+    #   # Pass an object to handle callback (requires method symbol)
+    #   c.when_called SomeObject, :some_method
+    #
+
+    def when_called(*args, &block)
+      fail ArgumentError, 'must pass an object, class, or block.' if args.empty? && !block
+      @when_called = block ? [block] : args
+    end
+    alias action when_called
+
+    ##
+    # Handles displaying subcommand help. By default it will set the action to 
+    # display the subcommand if the action hasn't already been set
+
+    def sub_command_group?
+      !!@sub_command_group
+    end
+
+    def sub_command_group=(value)
+      @sub_command_group = value
+      if @when_called.empty?
+        self.action {
+          exec("#{$0} #{ARGV.join(" ")} --help")
+        }
+      end
+    end
+
+    def configure_sub_command(runner)
+      @sub_command_group = true
+      if @when_called.empty?
+        action do |args, opts|
+          unless args.empty?
+            raise Commander::Runner::InvalidCommandError,
+                  "unrecognized subcommand '#{args[0]}'"
+          end
+          runner.command('help').run(ARGV[0])
+        end
+      end
+    end
+
+    ##
+    # Run the command with _args_.
+    #
+    # * parses options, call option blocks
+    # * invokes when_called proc
+    #
+
+    def run(*args)
+      call parse_options_and_call_procs(*args)
+    end
+
+    #:stopdoc:
+
+    ##
+    # Parses options and calls associated procs,
+    # returning the arguments remaining.
+
+    def parse_options_and_call_procs(*args)
+      opt = @options.each_with_object(OptionParser.new) do |option, opts|
+        opts.on(*option[:args], &option[:proc])
+        opts
+      end
+      default_opt = @options.each_with_object([]) do |h, arr|
+        if h.key?(:default)
+          arr.push(h[:switches][0].split[0])
+          arr.push(h[:default].to_s)
+        end
+      end
+      opt.parse! default_opt
+      opt.parse! args
+    end
+
+    ##
+    # Call the commands when_called block with _args_.
+
+    def call(args = [])
+      object = @when_called.shift
+      meth = @when_called.shift || :call
+      options = proxy_option_struct
+      case object
+      when Proc then object.call(args, options)
+      when Class then meth != :call ? object.new.send(meth, args, options) : object.new(args, options)
+      else object.send(meth, args, options) if object
+      end
+    end
+
+    ##
+    # Creates an Options instance populated with the option values
+    # collected by the #option_proc.
+
+    def proxy_option_struct
+      proxy_options.each_with_object(Options.new) do |(option, value), options|
+        # options that are present will evaluate to true
+        value = true if value.nil?
+        options.__send__ :"#{option}=", value
+        options
+      end
+    end
+
+    ##
+    # Option proxy proc used when a block is not explicitly passed
+    # via the #option method. This allows commander to auto-populate
+    # and work with option values.
+
+    def option_proc(switches)
+      ->(value) { proxy_options << [Runner.switch_to_sym(switches.last), value] }
+    end
+
+    def inspect
+      "<Commander::Command:#{name}>"
+    end
+  end
+end