cli 1.1.1 → 1.2.0

data/Gemfile

@@ -3,9 +3,9 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
+  gem "rspec", "~> 2.4"
   gem "cucumber", ">= 0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.2"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
   gem "rdoc", "~> 3.9"

data/Gemfile.lock

@@ -21,14 +21,14 @@ GEM
     rcov (0.9.11)
     rdoc (3.11)
       json (~> 1.4)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
     ruby-ip (0.9.0)
     term-ansicolor (1.0.7)
 
@@ -36,10 +36,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.2)
   cucumber
   jeweler (~> 1.6.4)
   rcov
   rdoc (~> 3.9)
-  rspec (~> 2.3.0)
+  rspec (~> 2.4)
   ruby-ip (~> 0.9)

data/README.md

@@ -389,6 +389,7 @@ The value after casting (if used) will be available from the `#parse` or `#parse
 In addition to *switch*, option hash can have following pairs:
 
 * **:default => value** - use default value of *value* if the option was not specified on the command argument list. The *value* will firstly be casted to string (with `#to_s`) and then it will be casted if casting is specified.
+* **:default_label => label** - display *label* in usage rather than default value - useful to descirbe default value if default value is generated if no value is provided
 * **:cast => cast specifier** - cast the provided value (or default) with given *cast specifier*. 
 The specifier can be a class constant (like `Integer` or `Float`); the value will be provided to `#new` method of the class and resulting object used as option value. When provided constant does not respond to `#new` (i.e. it is a module) the `#load` method will be tried. If provided specifier is a Proc (or `lambda {}`) the Proc will be called with the value and resulting value will be used. Otherwise `CLI::ParsingError::CastError` will be raised.
 * **:required => true** - if used and no *default* value is specified the `#parse` method will fail with `CLI::ParsingError::MissingOptionValueError` if the option was not specified in the command argument list. If `#parse!` method was used the program will exit with appropriate message.

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/cli.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{cli}
-  s.version = "1.1.1"
+  s.name = "cli"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = %q{2012-02-01}
-  s.description = %q{Command Line Interface gem allows you to quickly specify command argument parser that will automatically generate usage, handle stdin, switches, options and arguments with default values and value casting}
-  s.email = %q{jpastuszek@gmail.com}
+  s.date = "2012-11-11"
+  s.description = "Command Line Interface gem allows you to quickly specify command argument parser that will automatically generate usage, handle stdin, switches, options and arguments with default values and value casting"
+  s.email = "jpastuszek@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -48,37 +48,36 @@ Gem::Specification.new do |s|
     "spec/switch_spec.rb",
     "spec/usage_spec.rb"
   ]
-  s.homepage = %q{http://github.com/jpastuszek/cli}
+  s.homepage = "http://github.com/jpastuszek/cli"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Command line argument parser with stdin handling and usage generator}
+  s.rubygems_version = "1.8.15"
+  s.summary = "Command line argument parser with stdin handling and usage generator"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.4"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.9"])
       s.add_development_dependency(%q<ruby-ip>, ["~> 0.9"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.4"])
       s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.2"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.9"])
       s.add_dependency(%q<ruby-ip>, ["~> 0.9"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.4"])
     s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.2"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.9"])

data/lib/cli.rb

@@ -354,7 +354,11 @@ class CLI
 				end
 				out.print " (#{o.switch_short})" if o.has_short?
 				out.print ' (mandatory)' if o.mandatory?
-				out.print " [%s]" % o.default if o.has_default?
+				if o.has_default_label?
+					out.print " [#{o.default_label}]"
+				elsif o.has_default?
+					out.print " [%s]" % o.default
+				end
 				out.print " - #{o.description}" if o.description?
 				out.puts
 			end
@@ -369,7 +373,11 @@ class CLI
 					out.print "   #{a}*"
 				end
 				out.print ' (optional)' if not a.mandatory? and not a.has_default?
-				out.print " [%s]" % (a.default.is_a?(Array) ? a.default.join(' ') : a.default) if a.has_default?
+				if a.has_default_label?
+					out.print " [#{a.default_label}]"
+				elsif a.has_default?
+					out.print " [%s]" % (a.default.is_a?(Array) ? a.default.join(' ') : a.default)
+				end
 				out.print " - #{a.description}" if a.description?
 				out.puts
 			end

data/lib/cli/dsl.rb

@@ -65,6 +65,14 @@ class CLI
 				@options.member? :default
 			end
 
+			def default_label
+				@options[:default_label].to_s
+			end
+
+			def has_default_label?
+				@options.member? :default_label
+			end
+
 			def mandatory?
 				not has_default? and @options[:required]
 			end

data/spec/usage_spec.rb

@@ -184,6 +184,50 @@ describe CLI do
 			ss.usage.should include("4")
 		end
 
+		it "should show default value for option" do 
+			ss = CLI.new do
+				option :group, :default => 'red'
+			end
+			ss.usage.should include("[red]")
+		end
+
+		it "should show default label for option" do 
+			ss = CLI.new do
+				option :group, :default_label => 'blue'
+			end
+			ss.usage.should include("[blue]")
+		end
+
+		it "should show default label rather than default value if available for option" do 
+			ss = CLI.new do
+				option :group, :default_label => 'blue', :default => 'red'
+			end
+			ss.usage.should include("[blue]")
+			ss.usage.should_not include("[red]")
+		end
+
+		it "should show default value for argument" do 
+			ss = CLI.new do
+				argument :group, :default => 'red'
+			end
+			ss.usage.should include("[red]")
+		end
+
+		it "should show default label for argument" do 
+			ss = CLI.new do
+				argument :group, :default_label => 'blue'
+			end
+			ss.usage.should include("[blue]")
+		end
+
+		it "should show default label rather than default value if available for argument" do 
+			ss = CLI.new do
+				argument :group, :default_label => 'blue', :default => 'red'
+			end
+			ss.usage.should include("[blue]")
+			ss.usage.should_not include("[red]")
+		end
+
 		describe "usage line" do
 			it "should suggest that arguments can be used in usage line" do
 				ss = CLI.new do
@@ -191,7 +235,7 @@ describe CLI do
 				end
 
 				# switches will always be there due to implicit --help switch
-				ss.usage.first.should == "Usage: rspec [switches] [--] location\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches] [--] location\n"
 			end
 
 			it "should suggest that switches can be used in usage line" do
@@ -199,7 +243,7 @@ describe CLI do
 					switch :location, :short => :l
 				end
 
-				ss.usage.first.should == "Usage: rspec [switches]\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches]\n"
 			end
 
 			it "should suggest that options can be used in usage line" do
@@ -208,7 +252,7 @@ describe CLI do
 				end
 
 				# switches will always be there due to implicit --help switch
-				ss.usage.first.should == "Usage: rspec [switches|options]\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches|options]\n"
 			end
 
 			it "should suggest that switches or options can be used in usage line" do
@@ -217,7 +261,7 @@ describe CLI do
 					option :size, :short => :s
 				end
 
-				ss.usage.first.should == "Usage: rspec [switches|options]\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches|options]\n"
 			end
 
 			it "should suggest that option is mandatory" do
@@ -227,7 +271,7 @@ describe CLI do
 				end
 
 				# switches will always be there due to implicit --help switch
-				ss.usage.first.should == "Usage: rspec [switches] --size <value> --group <value>\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches] --size <value> --group <value>\n"
 
 				ss = CLI.new do
 					option :location, :short => :l
@@ -236,14 +280,14 @@ describe CLI do
 				end
 
 				# switches will always be there due to implicit --help switch
-				ss.usage.first.should == "Usage: rspec [switches|options] --size <value> --group <value>\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches|options] --size <value> --group <value>\n"
 
 				ss = CLI.new do
 					switch :location, :short => :l
 					option :size, :short => :s, :required => true
 				end
 
-				ss.usage.first.should == "Usage: rspec [switches] --size <value>\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches] --size <value>\n"
 			end
 
 			it "should suggest that argument is optional" do
@@ -255,7 +299,7 @@ describe CLI do
 				end
 
 				# switches will always be there due to implicit --help switch
-				ss.usage.first.should == "Usage: rspec [switches] [--] location [size] [colour] group\n"
+				ss.usage.lines.first.should == "Usage: rspec [switches] [--] location [size] [colour] group\n"
 			end
 		end
 
@@ -300,7 +344,7 @@ describe CLI do
 				switch :logging, :short => :l
 				switch :run
 				option :location, :short => :r, :description => "place where server is located"
-				option :group, :default => 'red'
+				option :group, :default => 'red', :default_label => 'colour'
 				options :power_up, :short => :p, :required => true
 				option :speed, :short => :s, :cast => Integer
 				option :the_number_of_the_beast, :short => :b, :cast => Integer, :default => 666, :description => "The number of the beast"
@@ -311,7 +355,7 @@ describe CLI do
 				argument :string
 				argument :limit, :cast => Integer, :required => false, :description => "limit in seconds"
 				argument :unlock_code, :cast => Integer, :required => false
-				argument :code, :cast => Integer, :default => '123', :description => "secret code"
+				argument :code, :cast => Integer, :default => '123', :description => "secret code", :default_label => 'generated'
 				argument :illegal_prime, :cast => Integer, :description => "prime number that represents information that it is forbidden to possess or distribute"
 				arguments :files, :cast => Pathname, :default => ['test', '1', '2'], :description => "files to process"
 			end.usage
@@ -329,7 +373,7 @@ Switches:
    --version - display version string
 Options:
    --location (-r) - place where server is located
-   --group [red]
+   --group [colour]
    --power-up* (-p) (mandatory)
    --speed (-s)
    --the-number-of-the-beast (-b) [666] - The number of the beast
@@ -340,7 +384,7 @@ Arguments:
    string
    limit (optional) - limit in seconds
    unlock-code (optional)
-   code [123] - secret code
+   code [generated] - secret code
    illegal-prime - prime number that represents information that it is forbidden to possess or distribute
    files* [test 1 2] - files to process
 EOS

metadata

@@ -1,147 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cli
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 1
-  segments_generated: true
-  version: 1.1.1
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jakub Pastuszek
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-01 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70285351383820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
-        segments_generated: true
-        version: 2.3.0
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
-  name: rspec
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70285351383820
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70285351398720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        segments_generated: true
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: cucumber
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70285351398720
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70285351396880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        segments_generated: true
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
-  name: bundler
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70285351396880
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70285351395960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 6
-        - 4
-        segments_generated: true
+      - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
-  name: jeweler
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70285351395960
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70285351395440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        segments_generated: true
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rcov
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70285351395440
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70285351394160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 3
-        - 9
-        segments_generated: true
-        version: "3.9"
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
-  name: rdoc
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70285351394160
+- !ruby/object:Gem::Dependency
+  name: ruby-ip
+  requirement: &70285351393060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        segments_generated: true
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  name: ruby-ip
   prerelease: false
-  version_requirements: *id007
-description: Command Line Interface gem allows you to quickly specify command argument parser that will automatically generate usage, handle stdin, switches, options and arguments with default values and value casting
+  version_requirements: *70285351393060
+description: Command Line Interface gem allows you to quickly specify command argument
+  parser that will automatically generate usage, handle stdin, switches, options and
+  arguments with default values and value casting
 email: jpastuszek@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - .document
 - .rspec
 - Gemfile
@@ -172,41 +128,32 @@ files:
 - spec/stdin_spec.rb
 - spec/switch_spec.rb
 - spec/usage_spec.rb
-has_rdoc: true
 homepage: http://github.com/jpastuszek/cli
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      segments_generated: true
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3157849412785804189
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      segments_generated: true
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Command line argument parser with stdin handling and usage generator
 test_files: []
-