visionmedia-commander 1.2.2 → 2.4.2

data/lib/commander/help_generators/default.rb

@@ -1,126 +0,0 @@
-
-module Commander
-  module HelpGenerators
-    
-    # Default help generator.
-    #
-    # Example formatting:
-    #   
-    #   NAME:
-    #   
-    #       Commander-init 
-    #   
-    #   DESCRIPTION:
-    #   
-    #       Initialize an empty file with a commander skeleton.
-    #   
-    #   EXAMPLES:
-    #   
-    #       # Apply commander to a blank file.
-    #       commander init ./bin/my_executable
-    #   
-    #   OPTIONS:
-    #   
-    #       -r,  --recursive,  Do something recursively
-    #       -v,  --verbose,  Do something verbosely
-    #
-    class Default
-      
-      attr_reader :manager
-      
-      def initialize(manager)
-        $terminal.page_at = 22
-        @manager = manager
-        @command = @manager.user_command
-        render
-      end
-      
-      # -----------------------------------------------------------
-
-        protected
-
-      # -----------------------------------------------------------
-      
-      def render 
-        say(render_command(@command)) if @command
-        say(render_global) unless @command
-      end
-      
-      def render_global
-        %w[ name description command_list copyright ].collect { |v| send("render_#{v}") }.join
-      end
-      
-      def render_name
-        o = head 'name'
-        o += row 6, @manager.info[:name]
-        o += "\n"
-        o
-      end
-      
-      def render_description
-        o = head 'description'
-        o += row 6, @manager.info[:description] unless @manager.info[:description].nil?
-        o += "\n"
-        o
-      end
-      
-      def render_command_list
-        o = head 'sub-commands'
-        o += @manager.commands.collect { |c, command| row(6, c.to_s, command.description) }.join
-        o += row 6, "help", "Display this help information, or help for the trailing sub-command."
-        o += "\n"
-        o
-      end
-      
-      def render_command(command)
-        o = head 'name'
-        o += row 6, "#{@manager.info[:name]}-#{command.command}"
-        o += "\n"
-        
-        o += head 'description'
-        o += row 6, command.description
-        o += "\n"
-        
-        o += head('examples') unless command.examples.empty?
-        o += render_command_examples command
-        o += "\n"
-        
-        o += head('options') unless command.options.empty?
-        o += render_command_options command
-        o += "\n\n"
-        o
-      end
-      
-      def render_command_options(command)
-        command.options.collect { |option| row(6, option[:args].join(',  '))  }.join
-      end
-      
-      def render_command_examples(command)
-        command.examples.collect do |example|
-          o = row 6, "# #{example[:description]}"
-          o += row 6, "#{example[:code]}"
-        end.join "\n"
-      end
-            
-      def render_copyright
-        @manager.info[:copyright].nil? ? "\n" : head('copyright') + row(6, @manager.info[:copyright]) + "\n\n";
-      end
-      
-      def head(text)
-        "\n  <%= color('#{text.upcase}', BOLD) %>:\n"
-      end
-      
-      def row(lpad, *args)
-        "\n" + (' ' * lpad) + args.collect { |a| a.to_s.ljust(15, ' ') }.join 
-      end
-    end
-  end
-end
-
-class Hash
-  def collect(&block)
-    o = []
-    self.each_pair { |k, v| o << block.call(k, v)} 
-    o
-  end
-end

data/lib/commander/help_generators.rb

@@ -1,2 +0,0 @@
-
-require 'commander/help_generators/default'

data/lib/commander/manager.rb

@@ -1,129 +0,0 @@
-
-module Commander
-  
-  # = Manager
-  #
-  # Controls management and invocation of sub-commands.
-	class Manager
-				
-		attr_reader :command_options, :commands, :info
-		attr_reader :user_command, :user_args
-		
-		# Initialize commander singleton.
-    #
-    # == Keys:
-    #
-    #  * name (required)
-    #  * version (required)
-    #  * description
-    #  * copyright
-    #
-    # == Examples:
-    #    
-    #   init_commander(
-    #     :name => 'Commander', 
-    #     :version => Commander::VERSION, 
-    #     :description => 'Commander utility program.'
-    #   )
-    #
-		def self.instance(options = {})
-			@@instance ||= Commander::Manager.new options
-		end
-		
-		def self.kill_instance!
-		  @@instance = nil
-		end
-		
-		def initialize(options)
-			@info, @command_options = options, {}
-			@user_args = ARGV.dup
-			@info[:help_generator] ||= Commander::HelpGenerators::Default
-			init_version
-			at_exit { run }
-		end
-		
-		def add_command(command)
-			@commands ||= {} and @commands[command.command] = command
-		end
-		
-		def get_command(command)
-			@commands[command.to_sym]
-		end
-		
-		def execute_command
-		  abort "Invalid command." if not @user_command
-		  unless @user_command.options.empty?
-		    opts = OptionParser.new
-		    @user_command.options.each { |option| opts.on(*option[:args], &option[:proc]) }
-		    opts.parse! @user_args 
-	    end
-    rescue OptionParser::MissingArgument => e
-      debug_abort e
-    else
-		  @user_command.invoke(:when_called_proc, @user_args) 
-		end
-		
-		def valid_command?(command)
-			!@commands[command.to_sym].nil? unless command.nil?
-		end
-		alias :include? :valid_command?
-		
-		def empty?
-			@commands.empty?
-		end
-		
-		def length
-			@commands.length
-		end
-		alias :size :length
-		
-		def valid_version?(version)
-			version.split('.').length == 3 if version.is_a? String
-		end
-		
-		def parse_version(version)
-		  version.split('.').collect { |v| v.to_i } if version.is_a? String
-		end
-		
-		def debug_abort(msg, exception = nil)
-		  abort msg
-		end
-				
-		def init_version
-		  raise "Your program must have a version tuple ('x.x.x')." unless valid_version?(@info[:version])
-		  @info[:major], @info[:minor], @info[:tiny] = parse_version(@info[:version])
-		end
-		
-		def run
-		  parse_options!
-		  abort "Invalid arguments." if @user_args.empty?
-		  @command_options[:help] = true and @user_args.shift if @user_args[0] == 'help'
-		  set_user_command
-	    case 
-        when (@command_options[:help] and @user_args.empty?) then output_help
-        when @command_options[:help] then output_help
-        else execute_command
-      end
-		end
-		
-		def parse_options!
-		  opts = OptionParser.new
-		  opts.on('--help') { output_help; exit }
-		  opts.on('--version') { output_version; exit }
-		  opts.parse! @user_args rescue nil
-		end
-		
-		def set_user_command
-		  @user_command = get_command(@user_args[0]) unless @user_args.empty?
-		  @user_args.shift
-		end
-		
-		def output_help
-		  @info[:help_generator].new self
-		end
-		
-		def output_version
-		  puts "#{@info[:name]} #{@info[:version]}"
-		end
-	end
-end

data/spec/all_spec.rb

@@ -1,6 +0,0 @@
-
-require File.expand_path(File.dirname(__FILE__) + '/../lib/commander')
-
-Dir['./spec/**/*.rb'].each do |file|
-  require file unless file == './spec/all_spec.rb'
-end

data/spec/manager_spec.rb

@@ -1,19 +0,0 @@
-
-describe Commander::Manager do
-  before :each do
-    @manager = Commander::Manager.instance 
-  end
-  
-  it "should parse version numbers" do
-    @manager.parse_version('1.2.3').should == [1, 2, 3]
-  end
-  
-  it "should validate version numbers" do
-    @manager.valid_version?('1.2.3').should == true
-  end
-  
-  it "should invalidate version numbers" do
-    @manager.valid_version?('1.2').should_not == true
-  end
-
-end