rubikon 0.5.2 → 0.5.3

data/lib/rubikon/application/instance_methods.rb

@@ -51,7 +51,6 @@ module Rubikon
         @parameters           = []
         @sandbox              = Sandbox.new(self)
         @settings             = {
-          :autohelp        => true,
           :autorun         => true,
           :colors          => true,
           :config_file     => "#{self.class.to_s.downcase}.yml",
@@ -110,14 +109,9 @@ module Rubikon
         rescue
           raise $! if @settings[:raise_errors]
 
-          if @settings[:autohelp] && @commands.key?(:help) &&
-             $!.is_a?(UnknownCommandError)
-            call :help, $!.command
-          else
-            puts "r{Error:}\n    #{$!.message}"
-            debug "     at #{$!.backtrace.join("\n     at ")}"
-            exit 1
-          end
+          puts "r{Error:}\n    #{$!.message}"
+          puts "     at #{$!.backtrace.join("\n     at ")}" if $DEBUG
+          exit 1
         ensure
           InstanceMethods.instance_method(:reset).bind(self).call
         end
@@ -155,38 +149,6 @@ module Rubikon
         global_flag :d => :debug
       end
 
-      # Prints a help screen for this application
-      #
-      # @param [String] info A additional information string to be displayed
-      #        right after usage information
-      # @since 0.6.0
-      def help(info = nil)
-        help = {}
-        @commands.each_value do |command|
-          help[command.name.to_s] = command.description
-        end
-        help.delete('__default')
-
-        if @commands.key? :__default
-          puts " [command] [args]\n\n"
-        else
-          puts " command [args]\n\n"
-        end
-
-        puts "#{info}\n\n" unless info.nil?
-
-        puts 'Commands:'
-        max_command_length = help.keys.max_by { |a| a.size }.size
-        help.sort_by { |name, description| name }.each do |name, description|
-          puts "  #{name.ljust(max_command_length)}    #{description}"
-        end
-
-        if @commands.key?(:__default) && @commands[:__default].description != :hidden
-          put "\nYou can also call this application without a command:"
-          puts @commands[:__default].help(false) + "\n"
-        end
-      end
-
       # Defines a command for displaying a help screen
       #
       # This takes any defined commands and it's corresponding options and
@@ -196,11 +158,16 @@ module Rubikon
         global_parameters = @global_parameters
         settings = @settings
 
-        command :help, 0..1, 'Show help for the application or a single command' do
+        command :help, nil, 'Display this help screen' do
           put settings[:help_banner]
 
+          help = {}
+          commands.each_value do |command|
+            help[command.name.to_s] = command.description
+          end
+
           global_params = ''
-          global_parameters.values.uniq.sort_by { |a| a.name.to_s }.each do |param|
+          global_parameters.values.uniq.sort {|a,b| a.name.to_s <=> b.name.to_s }.each do |param|
             global_params << ' ['
             ([param.name] + param.aliases).each_with_index do |name, index|
               name = name.to_s
@@ -211,19 +178,19 @@ module Rubikon
             global_params << ' ...' if param.is_a?(Option)
             global_params << ']'
           end
-          put global_params
 
-          app_help = lambda { |info| @__app__.instance_eval { help(info) } }
-
-          unless args.first.nil?
-            command = args.first.to_sym
-            if commands.keys.include?(command)
-              puts commands[command].help
-            else
-              app_help.call("The command \"#{command}\" is undefined. The following commands are available:")
-            end
+          default_description = help.delete('__default')
+          if default_description.nil?
+            puts "#{global_params} command [args]\n\n"
           else
-            app_help.call(nil)
+            puts "#{global_params} [command] [args]\n\n"
+            puts "Without command: #{default_description}\n\n"
+          end
+
+          puts 'Commands:'
+          max_command_length = help.keys.max { |a, b| a.size <=> b.size }.size
+          help.sort_by { |name, description| name }.each do |name, description|
+            puts "  #{name.ljust(max_command_length)}    #{description}"
           end
         end
       end
@@ -273,8 +240,7 @@ module Rubikon
         InstanceMethods.instance_method(:help_command).bind(self).call
         InstanceMethods.instance_method(:verbose_flag).bind(self).call
 
-        if @settings[:help_as_default] && @commands.key?(:help) &&
-           !@commands.key?(:__default)
+        if @settings[:help_as_default] && !@commands.keys.include?(:__default)
           default :help
         end
 

data/lib/rubikon/colored_io.rb

@@ -64,7 +64,8 @@ module Rubikon
         const_set :COLORS, COLORS
 
         def puts(text = '')
-          super color_filter(text.to_s)
+          self.class.
+            instance_method(:puts).bind(self).call color_filter(text.to_s)
         end
       end
 

data/lib/rubikon/command.rb

@@ -58,66 +58,6 @@ module Rubikon
       end
     end
 
-    # Generate help for this command
-    #
-    # @param [Boolean] show_usage If +true+, the returned String will also
-    #        include usage information
-    # @return [String] The contents of the help screen for this command
-    # @since 0.6.0
-    def help(show_usage = true)
-      help = ''
-
-      if show_usage
-        help << " #{name}" if name != :__default
-
-        @params.values.uniq.sort_by {|a| a.name.to_s }.each do |param|
-          help << ' ['
-          ([param.name] + param.aliases).each_with_index do |name, index|
-            name = name.to_s
-            help << '|' if index > 0
-            help << '-' if name.size > 1
-            help << "-#{name}"
-          end
-          help << ' ...' if param.is_a?(Option)
-          help << ']'
-        end
-      end
-
-      help << "\n\n#{description}" unless description.nil?
-
-      help_flags = {}
-      help_options = {}
-      params.each_value do |param|
-        if param.is_a? Flag
-          help_flags[param.name.to_s] = param
-        else
-          help_options[param.name.to_s] = param
-        end
-      end
-
-      param_name = lambda { |name| "#{name.size > 1 ? '-' : ' '}-#{name}" }
-      unless help_flags.empty? && help_options.empty?
-        max_param_length = (help_flags.keys + help_options.keys).
-          max_by { |a| a.size }.size + 2
-      end
-
-      unless help_flags.empty?
-        help << "\n\nFlags:"
-        help_flags.sort_by { |name, param| name }.each do |name, param|
-          help << "\n  #{param_name.call(name).ljust(max_param_length)}"
-        end
-      end
-
-      unless help_options.empty?
-      help << "\n\nOptions:\n"
-        help_options.sort_by { |name, param| name }.each do |name, param|
-          help << "  #{param_name.call(name).ljust(max_param_length)} ...\n"
-        end
-      end
-
-      help
-    end
-
     private
 
     # Add a new parameter for this command

data/lib/rubikon/exceptions.rb

@@ -62,16 +62,8 @@ module Rubikon
   # @since 0.3.0
   class UnknownCommandError < ArgumentError
 
-    # @return [Symbol] The name of the command that has been tried to access
-    attr_reader :command
-
-    # Creates a new error and stores the name of the command that could not be
-    # found
-    #
-    # @param [Symbol] name The name of the unknown command
     def initialize(name)
       super "Unknown command: #{name}"
-      @command = name
     end
 
   end

data/lib/rubikon.rb

@@ -24,6 +24,6 @@ require 'rubikon/application/base'
 module Rubikon
 
   # This is the current version of the Rubikon gem
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 
 end

data/samples/helloworld/hello_world.rb

@@ -38,7 +38,7 @@ class HelloWorld < Rubikon::Application::Base
   # Ask the user for his name and greet him
   command :interactive, 'Greet interactively' do
     name = input 'Please enter your name'
-    call :'__default', '--name', name
+    call :__default, '--name', name
   end
 
   # Show a progress bar while iterating through a loop

data/test/test_application.rb

@@ -120,7 +120,7 @@ class TestApplication < Test::Unit::TestCase
 
     should 'have a working help command' do
       @app.run(%w{help})
-      assert_match /Usage: [^ ]* \[--debug\|-d\] \[--gflag\|--gf1\|--gf2\] \[--gopt\|--go1\|--go2 \.\.\.\] \[--verbose\|-v\] \[command\] \[args\]\n\nCommands:\n  arguments      \n  globalopt      \n  help           Show help for the application or a single command\n  input          \n  object_id      \n  parameters     \n  progressbar    \n  sandbox        \n  throbber       \n/, @ostream.string
+      assert_match /Usage: [^ ]* \[--debug\|-d\] \[--gflag\|--gf1\|--gf2\] \[--gopt\|--go1\|--go2 \.\.\.\] \[--verbose\|-v\] command \[args\]\n\nCommands:\n  arguments      \n  globalopt      \n  help           Display this help screen\n  input          \n  object_id      \n  parameters     \n  progressbar    \n  sandbox        \n  throbber       \n/, @ostream.string
     end
 
     should 'have a working DSL for command parameters' do
@@ -167,6 +167,64 @@ class TestApplication < Test::Unit::TestCase
       $VERBOSE = false
     end
 
+    should 'parse arguments correctly' do
+      cmd, global_params, args = @app.parse_arguments(%w{})
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :__default
+      assert_equal [], global_params
+      assert_equal [], args
+
+      cmd, global_params, args = @app.parse_arguments(%w{-d -v})
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :__default
+      assert_instance_of Array, global_params
+      assert_equal 2, global_params.size
+      assert_instance_of Flag, global_params[0]
+      assert_equal :debug, global_params[0].name
+      assert_instance_of Flag, global_params[1]
+      assert_equal :verbose, global_params[1].name
+      assert_equal [], args
+
+      cmd, global_params, args = @app.parse_arguments(%w{-dv})
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :__default
+      assert_instance_of Array, global_params
+      assert_equal 2, global_params.size
+      assert_instance_of Flag, global_params[0]
+      assert_equal :debug, global_params[0].name
+      assert_instance_of Flag, global_params[1]
+      assert_equal :verbose, global_params[1].name
+      assert_equal [], args
+
+      cmd, global_params, args = @app.parse_arguments(%w{-x})
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :__default
+      assert_instance_of Array, global_params
+      assert_equal 0, global_params.size
+      assert_equal %w{-x}, args
+
+      cmd, global_params, args = @app.parse_arguments(%w{-d -v object_id})
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :object_id
+      assert_instance_of Array, global_params
+      assert_equal 2, global_params.size
+      assert_instance_of Flag, global_params[0]
+      assert_equal :debug, global_params[0].name
+      assert_instance_of Flag, global_params[1]
+      assert_equal :verbose, global_params[1].name
+      assert_equal [], args
+
+      cmd, global_params, args = @app.parse_arguments(%w{sandbox --gopt test puts})
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :sandbox
+      assert_instance_of Array, global_params
+      assert_equal 1, global_params.size
+      assert_instance_of Option, global_params[0]
+      assert_equal :gopt, global_params[0].name
+      assert_equal %w{test}, global_params[0].args
+      assert_equal %w{puts}, args
+    end
+
   end
 
 end

data/test/test_has_arguments.rb

@@ -10,6 +10,7 @@ class HasArg
   include HasArguments
 
   attr_reader :arg_names
+  public :<<, :active!, :arg_count, :args_full?, :check_args, :more_args?
 
   def initialize(arg_count)
      super(DummyApp.instance, 'dummy', arg_count)
@@ -22,71 +23,71 @@ class TestHasArguments < Test::Unit::TestCase
 
     should 'allow a Numeric as argument count' do
       has_arg = HasArg.new(1)
-      assert_equal 1..1, has_arg.send(:arg_count)
+      assert_equal 1..1, has_arg.arg_count
       assert_nil has_arg.arg_names
     end
 
     should 'allow a Range as argument count' do
       has_arg = HasArg.new(1..3)
-      assert_equal 1..3, has_arg.send(:arg_count)
+      assert_equal 1..3, has_arg.arg_count
       assert_nil has_arg.arg_names
     end
 
     should 'allow an Array as argument count' do
       has_arg = HasArg.new([2, 5, 6])
-      assert_equal 2..6, has_arg.send(:arg_count)
+      assert_equal 2..6, has_arg.arg_count
       assert_nil has_arg.arg_names
     end
 
     should 'allow a Symbol Array as argument names' do
       has_arg = HasArg.new([:arg1, :arg2, :arg3])
-      assert_equal 3..3, has_arg.send(:arg_count)
+      assert_equal 3..3, has_arg.arg_count
       assert_equal [:arg1, :arg2, :arg3], has_arg.arg_names
     end
 
     should 'only have required arguments if argument count is > 0' do
       has_arg = HasArg.new(2)
-      assert !has_arg.send(:args_full?)
-      assert has_arg.send(:more_args?)
-      has_arg.send(:<<, 'argument')
+      assert !has_arg.args_full?
+      assert has_arg.more_args?
+      has_arg << 'argument'
       assert_equal %w{argument}, has_arg.args
       assert_raise MissingArgumentError do
-        has_arg.send :check_args
+        has_arg.check_args
       end
-      has_arg.send(:<<, 'argument')
-      assert has_arg.send(:args_full?)
-      assert !has_arg.send(:more_args?)
+      has_arg << 'argument'
+      assert has_arg.args_full?
+      assert !has_arg.more_args?
       assert_equal %w{argument argument}, has_arg.args
       assert_raise ExtraArgumentError do
-        has_arg.send(:<<, 'argument')
+        has_arg << 'argument'
       end
       assert_equal %w{argument argument}, has_arg.args
     end
 
     should 'have required and optional arguments if argument count is < 0' do
       has_arg = HasArg.new(-1)
-      assert !has_arg.send(:args_full?)
-      assert has_arg.send(:more_args?)
+      assert !has_arg.args_full?
+      assert has_arg.more_args?
       assert_raise MissingArgumentError do
-        has_arg.send :check_args
+        has_arg.check_args
       end
-      has_arg.send(:<<, 'argument')
-      assert has_arg.send(:args_full?)
-      assert has_arg.send(:more_args?)
+      has_arg << 'argument'
+      assert has_arg.args_full?
+      assert has_arg.more_args?
       assert_equal %w{argument}, has_arg.args
     end
 
     should 'only have optional arguments if argument count is 0' do
       has_arg = HasArg.new(0)
-      assert has_arg.send(:args_full?)
-      assert has_arg.send(:more_args?)
-      has_arg.send(:<<, 'argument')
+      assert has_arg.args_full?
+      assert has_arg.more_args?
+      has_arg << 'argument'
       assert_equal %w{argument}, has_arg.args
     end
 
     should 'provide named arguments' do
       has_arg = HasArg.new([:named])
-      has_arg.send(:<<, 'argument')
+      has_arg << 'argument'
       assert_equal 'argument', has_arg[:named]
       assert_equal 'argument', has_arg.named
       assert_raise NoMethodError do
@@ -99,8 +100,8 @@ class TestHasArguments < Test::Unit::TestCase
       has_arg = HasArg.new nil do
         block_run = true
       end
-      has_arg.send :active!
-      assert has_arg.send(:active?)
+      has_arg.active!
+      assert has_arg.active?
       assert block_run
     end
 

data/test/testapps.rb

@@ -13,7 +13,6 @@ end
 
 class TestApp < Application::Base
 
-  set :autohelp, false
   set :autorun, false
   set :name, 'Rubikon test application'
   set :raise_errors, true
@@ -30,7 +29,7 @@ class TestApp < Application::Base
   end
   global_option :go2 => :gopt
 
-  default nil, :hidden do
+  default do
     'default command'
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubikon
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 5
-  - 2
-  version: 0.5.2
+  - 3
+  version: 0.5.3
 platform: ruby
 authors: 
 - Sebastian Staudt
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-04 00:00:00 +01:00
+date: 2010-12-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,7 +74,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/core_ext/enumerable.rb
 - lib/core_ext/object.rb
 - lib/core_ext/string.rb
 - lib/rubikon.rb

data/lib/core_ext/enumerable.rb

@@ -1,31 +0,0 @@
-# This code is free software; you can redistribute it and/or modify it under
-# the terms of the new BSD License.
-#
-# Copyright (c) 2010, Sebastian Staudt
-
-unless Enumerable.method_defined?(:max_by)
-
-  # Extends Ruby's own Enumrable module with method #max_by? for Ruby < 1.8.7
-  #
-  # @author Sebastian Staudt
-  # @since 0.5.0
-  module Enumerable
-
-    def find_index(obj)
-      
-    end
-
-    # Returns the object in enum that gives the maximum value from the given
-    # block.
-    #
-    # @yield [obj] The block to call on each element in the enum
-    # @yieldparam [Object] obj A single object in the enum
-    # @yieldreturn [Comparable] A value that can be compared (+<=>+) with the
-    #              values of the other objects in the enum
-    def max_by(&block)
-      max { |a , b| block.call(a) <=> block.call(b) }
-    end
-
-  end
-
-end