cri 2.1.0 → 2.2.0

data/NEWS.md

@@ -1,6 +1,11 @@
 Cri News
 ========
 
+2.2.0
+-----
+
+* Allowed commands with subcommands to have a run block
+
 2.1.0
 -----
 

data/lib/cri.rb

@@ -17,7 +17,7 @@ module Cri
   end
 
   # The current Cri version.
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   autoload 'Command',           'cri/command'
   autoload 'CommandDSL',        'cri/command_dsl'

data/lib/cri/command.rb

@@ -226,7 +226,8 @@ module Cri
       end
     end
 
-    # Runs the command with the given commandline arguments.
+    # Runs the command with the given commandline arguments, possibly invoking
+    # subcommands and passing on the options and arguments.
     #
     # @param [Array<String>] opts_and_args A list of unparsed arguments
     #
@@ -235,42 +236,59 @@ module Cri
     #
     # @return [void]
     def run(opts_and_args, parent_opts={})
-      if subcommands.empty?
-        # Parse
-        parser = Cri::OptionParser.new(
-          opts_and_args, global_option_definitions)
-        self.handle_parser_errors_while { parser.run }
-        local_opts  = parser.options
-        global_opts = parent_opts.merge(parser.options)
-        args = parser.arguments
+      # Parse up to command name
+      stuff = partition(opts_and_args)
+      opts_before_subcmd, subcmd_name, opts_and_args_after_subcmd = *stuff
 
-        # Handle options
-        handle_options(local_opts)
-
-        # Execute
-        if @block.nil?
-          raise NotImplementedError,
-            "No implementation available for '#{self.name}'"
-        end
-        block.call(global_opts, args, self)
+      if subcommands.empty? || (subcmd_name.nil? && !self.block.nil?)
+        run_this(opts_and_args, parent_opts)
       else
-        # Parse up to command name
-        stuff = partition(opts_and_args)
-        opts_before_cmd, cmd_name, opts_and_args_after_cmd = *stuff
-
         # Handle options
-        handle_options(opts_before_cmd)
+        self.handle_options(opts_before_subcmd)
 
         # Get command
-        if cmd_name.nil?
+        if subcmd_name.nil?
           $stderr.puts "#{name}: no command given"
           exit 1
         end
-        command = command_named(cmd_name)
+        subcommand = self.command_named(subcmd_name)
 
         # Run
-        command.run(opts_and_args_after_cmd, opts_before_cmd)
+        subcommand.run(opts_and_args_after_subcmd, opts_before_subcmd)
+      end
+    end
+
+    # Runs the actual command with the given commandline arguments, not
+    # invoking any subcommands. If the command does not have an execution
+    # block, an error ir raised.
+    #
+    # @param [Array<String>] opts_and_args A list of unparsed arguments
+    #
+    # @param [Hash] parent_opts A hash of options already handled by the
+    #   supercommand
+    #
+    # @raise [NotImplementedError] if the command does not have an execution
+    #   block
+    #
+    # @return [void]
+    def run_this(opts_and_args, parent_opts={})
+      # Parse
+      parser = Cri::OptionParser.new(
+        opts_and_args, self.global_option_definitions)
+      self.handle_parser_errors_while { parser.run }
+      local_opts  = parser.options
+      global_opts = parent_opts.merge(parser.options)
+      args = parser.arguments
+
+      # Handle options
+      self.handle_options(local_opts)
+
+      # Execute
+      if self.block.nil?
+        raise NotImplementedError,
+          "No implementation available for '#{self.name}'"
       end
+      self.block.call(global_opts, args, self)
     end
 
     # @return [String] The help text for this command

data/test/test_command.rb

@@ -92,6 +92,33 @@ class Cri::CommandTestCase < Cri::TestCase
     super_cmd
   end
 
+  def nested_cmd_with_run_block
+    super_cmd = Cri::Command.define do
+      name        'super'
+      usage       'super [command] [options] [arguments]'
+      summary     'does super stuff'
+      description 'This command does super stuff.'
+
+      run do |opts, args|
+        $stdout.puts "super"
+      end
+    end
+
+    super_cmd.define_command do
+      name        'sub'
+      aliases     'sup'
+      usage       'sub [options]'
+      summary     'does subby stuff'
+      description 'This command does subby stuff.'
+
+      run do |opts, args|
+        $stdout.puts "sub"
+      end
+    end
+
+    super_cmd
+  end
+
   def test_invoke_simple_without_opts_or_args
     out, err = capture_io_while do
       simple_cmd.run(%w())
@@ -210,6 +237,22 @@ class Cri::CommandTestCase < Cri::TestCase
     assert_equal [ ], lines(err)
   end
 
+  def test_invoke_nested_with_run_block
+    out, err = capture_io_while do
+      nested_cmd_with_run_block.run(%w())
+    end
+
+    assert_equal [ 'super' ], lines(out)
+    assert_equal [ ], lines(err)
+
+    out, err = capture_io_while do
+      nested_cmd_with_run_block.run(%w( sub ))
+    end
+
+    assert_equal [ 'sub' ], lines(out)
+    assert_equal [ ], lines(err)
+  end
+
   def test_help_nested
     help = nested_cmd.subcommands.find { |cmd| cmd.name == 'sub' }.help
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-16 00:00:00.000000000 Z
+date: 2012-02-19 00:00:00.000000000 Z
 dependencies: []
 description: Cri allows building easy-to-use commandline interfaces with support for
   subcommands.
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: a library for building easy-to-use commandline tools