cri 2.3.0 → 2.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWExM2ZhMjgwODJmMmVhMGU5ZTg2YTQzN2EwYTgwYjI2NzM3MzRhYw==
+  data.tar.gz: !binary |-
+    NTJjOWQ4ZDZjOGEzZmUzMDg4ZGQ4NzIyMWQ4NDQ5MTcyZjI4NWNkOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjU3YTNjYWMyZDI3ZTM5Y2FkMGY1NDQ4YTcxYWU1YWNlYmEwNDg1YWE2ODhi
+    OGNhZjdiOGMyZGQ2MzUwOWZjMmQxNDVjYjAyYWM3ZTFhYjE4NzEwNzUzYjk4
+    N2RlMDdkM2IzYWU4MGRhNDExMTFkZmY5NWYzYWNhNmM1OTgzMGE=
+  data.tar.gz: !binary |-
+    NjUzMWY0NjY2ZTU5ZmE3ZGZjMWMzMjQ0OGE2ZGRlMzFkOTE4NTIyODcwNDU4
+    MTkyZGRlMjNmNmY1MzVmMmJlNzVhZmQ0N2E2ZmYyMjcxYmU2M2NhYzVhMWU2
+    MmI1ZGQyNWQ0NjU1ZmU0NDEzNjdhMjA0ZTEwMjFkYTM4YTQ0MDg=

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    cri (2.4.0)
+      colored (>= 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    minitest (5.0.6)
+    rake (10.1.0)
+    yard (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cri!
+  minitest
+  rake
+  yard

data/NEWS.md

@@ -1,6 +1,13 @@
 Cri News
 ========
 
+2.4.0
+-----
+
+* Allowed either short or long option to be, eh, optional [Ken Coar]
+* Fixed wrap-and-indent behavior [Ken Coar]
+* Moved version information into `cri/version`
+
 2.3.0
 -----
 

data/README.md

@@ -20,12 +20,12 @@ Here’s a sample command definition:
 	  summary     'does stuff'
 	  description 'This command does a lot of stuff. I really mean a lot.'
 
-	  flag   :h, :help,  'show help for this command' do |value, cmd|
+	  flag   :h,  :help,  'show help for this command' do |value, cmd|
 	    puts cmd.help
 	    exit 0
 	  end
-	  flag   :m, :more,  'do even more stuff'
-	  option :s, :stuff, 'specify stuff to do', :argument => :required
+	  flag   nil, :more,  'do even more stuff'
+	  option :s,  :stuff, 'specify stuff to do', :argument => :required
 
 	  run do |opts, args, cmd|
 	    stuff = opts[:stuff] || 'generic stuff'
@@ -55,7 +55,7 @@ Each command has automatically generated help. This help can be printed using
 	options:
 
 	    -h --help      show help for this command
-	    -m --more      do even more stuff
+	       --more      do even more stuff
 	    -s --stuff     specify stuff to do
 
 Let’s disect the command definition and start with the first five lines:
@@ -76,12 +76,12 @@ Aliases don’t make sense for root commands, but for subcommands they do.
 
 The next few lines contain the command’s option definitions:
 
-	flag   :h, :help,  'show help for this command' do |value, cmd|
+	flag   :h,  :help,  'show help for this command' do |value, cmd|
 	  puts cmd.help
 	  exit 0
 	end
-	flag   :m, :more,  'do even more stuff'
-	option :s, :stuff, 'specify stuff to do', :argument => :required
+	flag   nil, :more,  'do even more stuff'
+	option :s,  :stuff, 'specify stuff to do', :argument => :required
 
 Options can be defined using the following methods:
 
@@ -90,6 +90,11 @@ Options can be defined using the following methods:
 * {Cri::CommandDSL#required} (implies required argument)
 * {Cri::CommandDSL#optional} (implies optional argument)
 
+All these methods take the short option form as their first argument, and a
+long option form as their second argument. Either the short or the long form
+can be nil, but not both (because that would not make any sense). In the
+example above, the `--more` option has no short form.
+
 Each of the above methods also take a block, which will be executed when the
 option is found. The argument to the block are the option value (`true` in
 case the option does not have an argument) and the command.
@@ -125,9 +130,8 @@ To add a command as a subcommand to another command, use the {Cri::Command#add_c
 Contributors
 ------------
 
-(In alphabetical order)
-
 * Toon Willems
+* Ken Coar
 
 Thanks for Lee “injekt” Jarvis for [Slop][1], which has inspired the design of Cri 2.0.
 

data/Rakefile

@@ -4,6 +4,7 @@
 
 # Rake etc
 require 'rake'
+require 'minitest'
 require 'minitest/unit'
 
 # Cri itself
@@ -32,7 +33,7 @@ task :test do
 
   $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
-  MiniTest::Unit.autorun
+  MiniTest.autorun
 
   require 'test/helper.rb'
 

data/cri.gemspec

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 $LOAD_PATH.unshift(File.expand_path('../lib/', __FILE__))
-require 'cri'
+require 'cri/version'
 
 Gem::Specification.new do |s|
   s.name        = 'cri'
@@ -20,6 +20,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency('colored', '>= 1.2')
 
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('yard')
+
   s.rdoc_options     = [ '--main', 'README.md' ]
   s.extra_rdoc_files = [ 'ChangeLog', 'LICENSE', 'README.md', 'NEWS.md' ]
 end

data/lib/cri.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'cri/version'
 
 module Cri
 
@@ -16,9 +17,6 @@ module Cri
   class NoHelpAvailableError < Error
   end
 
-  # The current Cri version.
-  VERSION = '2.3.0'
-
   autoload 'Command',           'cri/command'
   autoload 'CommandDSL',        'cri/command_dsl'
   autoload 'CommandRunner',     'cri/command_runner'

data/lib/cri/command.rb

@@ -371,17 +371,18 @@ module Cri
       if self.supercommand
         groups["options for #{self.supercommand.name}"] = self.supercommand.global_option_definitions
       end
-      length = groups.values.inject(&:+).map { |o| o[:long].size }.max
+      length = groups.values.inject(&:+).map { |o| o[:long].to_s.size }.max
       groups.each_pair do |name, defs|
         unless defs.empty?
           text << "\n"
           text << "#{name}".formatted_as_title
           text << "\n"
-          defs.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          ordered_defs = defs.sort_by { |x| x[:short] || x[:long] }
+          ordered_defs.each do |opt_def|
             text << sprintf(
-              "    -%1s --%-#{length+4}s",
-              opt_def[:short],
-              opt_def[:long]).formatted_as_option
+              "    %-2s %-#{length+6}s",
+              opt_def[:short] ? ('-' + opt_def[:short]) : '',
+              opt_def[:long] ? ('--' + opt_def[:long]) : '').formatted_as_option
 
             text << opt_def[:desc] << "\n"
           end
@@ -400,7 +401,7 @@ module Cri
 
     def handle_options(opts)
       opts.each_pair do |key, value|
-        opt_def = global_option_definitions.find { |o| o[:long] == key.to_s }
+        opt_def = global_option_definitions.find { |o| (o[:long] || o[:short]) == key.to_s }
         block = opt_def[:block]
         block.call(value, self) if block
       end

data/lib/cri/command_dsl.rb

@@ -92,9 +92,9 @@ module Cri
     # Adds a new option to the command. If a block is given, it will be
     # executed when the option is successfully parsed.
     #
-    # @param [String, Symbol] short The short option name
+    # @param [String, Symbol, nil] short The short option name
     #
-    # @param [String, Symbol] long The long option name
+    # @param [String, Symbol, nil] long The long option name
     #
     # @param [String] desc The option description
     #
@@ -111,9 +111,9 @@ module Cri
     # Adds a new option with a required argument to the command. If a block is
     # given, it will be executed when the option is successfully parsed.
     #
-    # @param [String, Symbol] short The short option name
+    # @param [String, Symbol, nil] short The short option name
     #
-    # @param [String, Symbol] long The long option name
+    # @param [String, Symbol, nil] long The long option name
     #
     # @param [String] desc The option description
     #
@@ -127,9 +127,9 @@ module Cri
     # Adds a new option with a forbidden argument to the command. If a block
     # is given, it will be executed when the option is successfully parsed.
     #
-    # @param [String, Symbol] short The short option name
+    # @param [String, Symbol, nil] short The short option name
     #
-    # @param [String, Symbol] long The long option name
+    # @param [String, Symbol, nil] long The long option name
     #
     # @param [String] desc The option description
     #
@@ -144,9 +144,9 @@ module Cri
     # Adds a new option with an optional argument to the command. If a block
     # is given, it will be executed when the option is successfully parsed.
     #
-    # @param [String, Symbol] short The short option name
+    # @param [String, Symbol, nil] short The short option name
     #
-    # @param [String, Symbol] long The long option name
+    # @param [String, Symbol, nil] long The long option name
     #
     # @param [String] desc The option description
     #
@@ -189,9 +189,13 @@ module Cri
   protected
 
     def add_option(short, long, desc, argument, block)
+      if short.nil? && long.nil?
+        raise ArgumentError, "short and long options cannot both be nil"
+      end
+
       @command.option_definitions << {
-        :short    => short.to_s,
-        :long     => long.to_s,
+        :short    => short.nil? ? nil : short.to_s,
+        :long     => long.nil? ? nil : long.to_s,
         :desc     => desc,
         :argument => argument,
         :block    => block }

data/lib/cri/core_ext/string.rb

@@ -33,6 +33,8 @@ module Cri::CoreExtensions
     #
     # @return [String] The word-wrapped and indented string
     def wrap_and_indent(width, indentation)
+      indented_width = width - indentation
+      indent = ' ' * indentation
       # Split into paragraphs
       paragraphs = self.to_paragraphs
 
@@ -45,7 +47,7 @@ module Cri::CoreExtensions
         # Split into words
         paragraph.split(/\s/).each do |word|
           # Begin new line if it's too long
-          if (line + ' ' + word).length >= width
+          if (line + ' ' + word).length >= indented_width
             lines << line
             line = ''
           end
@@ -56,7 +58,7 @@ module Cri::CoreExtensions
         lines << line
 
         # Join lines
-        lines.map { |l| ' '*indentation + l }.join("\n")
+        lines.map { |l| indent + l }.join("\n")
       end.join("\n\n")
     end
 

data/lib/cri/option_parser.rb

@@ -194,10 +194,10 @@ module Cri
             end
 
             # Store option
-            add_option(definition[:long].to_sym, option_value)
+            add_option(definition, option_value)
           else
             # Store option
-            add_option(definition[:long].to_sym, true)
+            add_option(definition, true)
           end
         # Handle -xyz options
         elsif e =~ /^-./ and !@no_more_options
@@ -226,10 +226,10 @@ module Cri
               end
 
               # Store option
-              add_option(definition[:long].to_sym, option_value)
+              add_option(definition, option_value)
             else
               # Store option
-              add_option(definition[:long].to_sym, true)
+              add_option(definition, true)
             end
           end
         # Handle normal arguments
@@ -244,7 +244,8 @@ module Cri
 
   private
 
-    def add_option(key, value)
+    def add_option(definition, value)
+      key = (definition[:long] || definition[:short]).to_sym
       options[key] = value
       delegate.option_added(key, value, self) unless delegate.nil?
     end

data/lib/cri/version.rb

@@ -0,0 +1,6 @@
+module Cri
+
+  # The current Cri version.
+  VERSION = '2.4.0'
+
+end

data/test/helper.rb

@@ -2,7 +2,7 @@
 
 require 'stringio'
 
-class Cri::TestCase < MiniTest::Unit::TestCase
+class Cri::TestCase < Minitest::Test
 
   def setup
     @orig_io = capture_io

data/test/test_command.rb

@@ -263,6 +263,19 @@ class Cri::CommandTestCase < Cri::TestCase
     bare_cmd.help
   end
 
+  def test_help_with_optional_options
+    cmd = Cri::Command.define do
+      name 'build'
+      flag :s,  nil,   'short'
+      flag nil, :long, 'long'
+    end
+    help = cmd.help
+
+    assert_match(/--long.*-s/m,                           help)
+    assert_match(/^\e\[33m       --long    \e\[0mlong$/,  help)
+    assert_match(/^\e\[33m    -s           \e\[0mshort$/, help)
+  end
+
   def test_modify_with_block_argument
     cmd = Cri::Command.define do |c|
       c.name 'build'

data/test/test_command_dsl.rb

@@ -46,6 +46,48 @@ class Cri::CommandDSLTestCase < Cri::TestCase
     assert_equal expected_option_definitions, actual_option_definitions
   end
 
+  def test_optional_options
+    # Define
+    dsl = Cri::CommandDSL.new
+    dsl.instance_eval do
+      name        'moo'
+      usage       'dunno whatever'
+      summary     'does stuff'
+      description 'This command does a lot of stuff.'
+
+      flag :s,  nil,   'short'
+      flag nil, :long, 'long'
+
+      run do |opts, args|
+        $did_it_work = :probably
+      end
+    end
+    command = dsl.command
+
+    # Run
+    $did_it_work = :sadly_not
+    command.run(%w( -s --long ))
+    assert_equal :probably, $did_it_work
+
+    # Check options
+    expected_option_definitions = Set.new([
+      { :short => 's', :long => nil,    :desc => 'short', :argument => :forbidden, :block => nil },
+      { :short => nil, :long => 'long', :desc => 'long',  :argument => :forbidden, :block => nil }
+      ])
+    actual_option_definitions = Set.new(command.option_definitions)
+    assert_equal expected_option_definitions, actual_option_definitions
+  end
+
+  def test_optional_options
+    # Define
+    dsl = Cri::CommandDSL.new
+    assert_raises ArgumentError do
+      dsl.instance_eval do
+        flag nil, nil, 'meh'
+      end
+    end
+  end
+
   def test_subcommand
     # Define
     dsl = Cri::CommandDSL.new

data/test/test_core_ext.rb

@@ -15,7 +15,7 @@ class Cri::CoreExtTestCase < Cri::TestCase
 
   def test_string_wrap_and_indent_without_indent
     original = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " +
-               "sed do eiusmod tempor incididunt ut labore et dolore " + 
+               "sed do eiusmod tempor incididunt ut labore et dolore " +
                "magna aliqua."
 
     expected = "Lorem ipsum dolor sit amet, consectetur\n" +
@@ -29,27 +29,51 @@ class Cri::CoreExtTestCase < Cri::TestCase
 
   def test_string_wrap_and_indent_with_indent
     original = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " +
-               "sed do eiusmod tempor incididunt ut labore et dolore " + 
+               "sed do eiusmod tempor incididunt ut labore et dolore " +
                "magna aliqua."
 
     expected = "    Lorem ipsum dolor sit amet,\n" +
-               "    consectetur adipisicing elit, sed\n" +
-               "    do eiusmod tempor incididunt ut\n" +
-               "    labore et dolore magna aliqua."
+               "    consectetur adipisicing elit,\n" +
+               "    sed do eiusmod tempor\n" +
+               "    incididunt ut labore et dolore\n" +
+               "    magna aliqua."
 
     actual = original.wrap_and_indent(36, 4)
     assert_equal expected, actual
   end
 
+  def test_string_wrap_and_indent_with_large_indent
+    original = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " +
+               "sed do eiusmod tempor incididunt ut labore et dolore " +
+               "magna aliqua."
+
+    expected = "                              Lorem ipsum\n" +
+               "                              dolor sit\n" +
+               "                              amet,\n" +
+               "                              consectetur\n" +
+               "                              adipisicing\n" +
+               "                              elit, sed do\n" +
+               "                              eiusmod\n" +
+               "                              tempor\n" +
+               "                              incididunt ut\n" +
+               "                              labore et\n" +
+               "                              dolore magna\n" +
+               "                              aliqua."
+
+    actual = original.wrap_and_indent(44, 30)
+    assert_equal expected, actual
+  end
+
   def test_string_wrap_and_indent_with_multiple_lines
     original = "Lorem ipsum dolor sit\namet, consectetur adipisicing elit, " +
-               "sed do\neiusmod tempor incididunt ut\nlabore et dolore " + 
+               "sed do\neiusmod tempor incididunt ut\nlabore et dolore " +
                "magna\naliqua."
 
     expected = "    Lorem ipsum dolor sit amet,\n" +
-               "    consectetur adipisicing elit, sed\n" +
-               "    do eiusmod tempor incididunt ut\n" +
-               "    labore et dolore magna aliqua."
+               "    consectetur adipisicing elit,\n" +
+               "    sed do eiusmod tempor\n" +
+               "    incididunt ut labore et dolore\n" +
+               "    magna aliqua."
 
     actual = original.wrap_and_indent(36, 4)
     assert_equal expected, actual

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.3.0
-  prerelease: 
+  version: 2.4.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2013-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,11 +20,52 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Cri allows building easy-to-use commandline interfaces with support for
   subcommands.
 email: denis.defreyne@stoneship.org
@@ -39,6 +78,8 @@ extra_rdoc_files:
 - NEWS.md
 files:
 - ChangeLog
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - NEWS.md
 - Rakefile
@@ -51,6 +92,7 @@ files:
 - lib/cri/core_ext/string.rb
 - lib/cri/core_ext.rb
 - lib/cri/option_parser.rb
+- lib/cri/version.rb
 - lib/cri.rb
 - test/helper.rb
 - test/test_base.rb
@@ -64,6 +106,7 @@ files:
 - .gemtest
 homepage: http://stoneship.org/software/cri/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -71,22 +114,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a library for building easy-to-use commandline tools
 test_files: []
 has_rdoc: