cri 2.0.2 → 2.1.0

data/NEWS.md

@@ -1,6 +1,12 @@
 Cri News
 ========
 
+2.1.0
+-----
+
+* Added support for runners
+* Split up local/global command options
+
 2.0.2
 -----
 

data/README.md

@@ -109,6 +109,11 @@ The {Cri::CommandDSL#run} method takes a block with the actual code to
 execute. This block takes three arguments: the options, any arguments passed
 to the command, and the command itself.
 
+Instead of defining a run block, it is possible to declare a class, the
+_command runner_ class ({Cri::CommandRunner}) that will perform the actual
+execution of the command. This makes it easier to break up large run blocks
+into manageable pieces.
+
 Commands can have subcommands. For example, the `git` commandline tool would be represented by a command that has subcommands named `commit`, `add`, and so on. Commands with subcommands do not use a run block; execution will always be dispatched to a subcommand (or none, if no subcommand is found).
 
 To add a command as a subcommand to another command, use the {Cri::Command#add_command} method, like this:

data/lib/cri.rb

@@ -17,10 +17,11 @@ module Cri
   end
 
   # The current Cri version.
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 
   autoload 'Command',           'cri/command'
   autoload 'CommandDSL',        'cri/command_dsl'
+  autoload 'CommandRunner',     'cri/command_runner'
   autoload 'OptionParser',      'cri/option_parser'
 
 end

data/lib/cri/command.rb

@@ -317,18 +317,23 @@ module Cri
       end
 
       # Append options
-      defs = global_option_definitions.sort { |x,y| x[:long] <=> y[:long] }
-      unless defs.empty?
-        text << "\n"
-        text << "options:\n"
-        text << "\n"
-        length = defs.inject(0) { |m,o| [ m, o[:long].size ].max }
-        defs.each do |opt_def|
-          text << sprintf(
-            "    -%1s --%-#{length+4}s %s\n",
-            opt_def[:short],
-            opt_def[:long],
-            opt_def[:desc])
+      groups = { 'options' => self.option_definitions }
+      if self.supercommand
+        groups["options for #{self.supercommand.name}"] = self.supercommand.global_option_definitions
+      end
+      length = groups.values.inject(&:+).inject(0) { |m,o| [ m, o[:long].size ].max }
+      groups.each_pair do |name, defs|
+        unless defs.empty?
+          text << "\n"
+          text << "#{name}:\n"
+          text << "\n"
+          defs.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+            text << sprintf(
+              "    -%1s --%-#{length+4}s %s\n",
+              opt_def[:short],
+              opt_def[:long],
+              opt_def[:desc])
+          end
         end
       end
 

data/lib/cri/command_dsl.rb

@@ -149,6 +149,8 @@ module Cri
 
     # Sets the run block to the given block. The given block should have two
     # or three arguments (options, arguments, and optionally the command).
+    # Calling this will override existing run block or runner declarations
+    # (using {#run} and {#runner}, respectively).
     #
     # @return [void]
     def run(&block)
@@ -160,6 +162,20 @@ module Cri
       @command.block = block
     end
 
+    # Defines the runner class for this command. Calling this will override
+    # existing run block or runner declarations (using {#run} and {#runner},
+    # respectively).
+    #
+    # @param [Class<CommandRunner>] klass The command runner class (subclass
+    #   of {CommandRunner}) that is used for executing this command.
+    #
+    # @return [void]
+    def runner(klass)
+      run do |opts, args, cmd|
+        klass.new(opts, args, cmd).call
+      end
+    end
+
   protected
 
     def add_option(short, long, desc, argument, block)

data/lib/cri/command_runner.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module Cri
+
+  # A command runner is responsible for the execution of a command. Using it
+  # is optional, but it is useful for commands whose execution block is large.
+  class CommandRunner
+
+    # @return [Hash] A hash contain the options and their values
+    attr_reader :options
+
+    # @return [Array] The list of arguments
+    attr_reader :arguments
+
+    # @return [Command] The command
+    attr_reader :command
+
+    # @param [Hash] options A hash contain the options and their values
+    #
+    # @param [Array] arguments The list of arguments
+    #
+    # @param [Cri::Command] command The Cri command
+    def initialize(options, arguments, command)
+      @options   = options
+      @arguments = arguments
+      @command   = command
+    end
+
+    # Runs the command. By default, this simply does the actual execution, but
+    # subclasses may choose to add error handling around the actual execution.
+    #
+    # @return [void]
+    def call
+      self.run
+    end
+
+    # Performs the actual execution of the command.
+    #
+    # @return [void]
+    #
+    # @abstract
+    def run
+      raise NotImplementedError, 'Cri::CommandRunner subclasses must implement #run'
+    end
+
+  end
+
+end

data/test/test_command_dsl.rb

@@ -75,4 +75,24 @@ class Cri::CommandDSLTestCase < Cri::TestCase
     assert_equal %w( aah moo ), command.aliases.sort
   end
 
+  def test_runner
+    # Define
+    dsl = Cri::CommandDSL.new
+    dsl.instance_eval <<-EOS
+      class Cri::CommandDSLTestCaseCommandRunner < Cri::CommandRunner
+        def run
+          $works = arguments[0]
+        end
+      end
+
+      runner Cri::CommandDSLTestCaseCommandRunner
+EOS
+    command = dsl.command
+
+    # Check
+    $works = false
+    command.run(%w( certainly ))
+    assert_equal 'certainly', $works
+  end
+
 end

metadata

@@ -1,30 +1,27 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cri
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.1.0
   prerelease: 
-  version: 2.0.2
 platform: ruby
-authors: 
+authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-17 00:00:00 Z
+date: 2012-01-16 00:00:00.000000000 Z
 dependencies: []
-
-description: Cri allows building easy-to-use commandline interfaces with support for subcommands.
+description: Cri allows building easy-to-use commandline interfaces with support for
+  subcommands.
 email: denis.defreyne@stoneship.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - ChangeLog
 - LICENSE
 - README.md
 - NEWS.md
-files: 
+files:
 - ChangeLog
 - LICENSE
 - NEWS.md
@@ -32,6 +29,7 @@ files:
 - README.md
 - lib/cri/command.rb
 - lib/cri/command_dsl.rb
+- lib/cri/command_runner.rb
 - lib/cri/commands/basic_help.rb
 - lib/cri/commands/basic_root.rb
 - lib/cri/core_ext/string.rb
@@ -49,31 +47,29 @@ files:
 - .gemtest
 homepage: http://stoneship.org/software/cri/
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: a library for building easy-to-use commandline tools
 test_files: []
-
+has_rdoc: