cli 1.3.0 → 1.3.1

data/README.md

@@ -15,26 +15,26 @@ It will use HTTPClient to connect to server that address and port can be specifi
 It expects at least one argument specifying the URL (that needs to start with `/`) and optional set of POST arguments.
 
 ```ruby
-re 'rubygems'
+require 'rubygems'
 require 'cli'
 require 'httpclient'
 
-options = CLI.new do
+settings = CLI.new do
     option :server, :description => 'server address', :default => 'www.google.com'
     option :port,	:description => 'server port', :cast => Integer, :default => 80
     argument :url,	:description => 'URL to GET or POST to if arguments are given'
     arguments :post_arguments, :required => false
-end.parse! do |options|
-    fail "invalid URL '#{options.url}', URL has to start with '/'" unless options.url =~ /^\//
+end.parse! do |settings|
+    fail "invalid URL '#{settings.url}', URL has to start with '/'" unless settings.url =~ /^\//
 end
 
 c = HTTPClient.new
 
 begin
-    if options.post_arguments.empty?
-        puts c.get_async("http://#{options.server}:#{options.port}#{options.url}").pop.content.read
+    if settings.post_arguments.empty?
+        puts c.get_async("http://#{settings.server}:#{settings.port}#{settings.url}").pop.content.read
     else
-        puts c.post_async("http://#{options.server}:#{options.port}#{options.url}", options.post_arguments.join("\n")).pop.content.read
+        puts c.post_async("http://#{settings.server}:#{settings.port}#{settings.url}", settings.post_arguments.join("\n")).pop.content.read
     end 
 rescue SocketError, Errno::ECONNREFUSED => e
     puts "Falied to connect: #{e}"
@@ -92,7 +92,7 @@ require 'rubygems'
 require 'cli'
 require 'ip'
 
-options = CLI.new do
+settings = CLI.new do
 	description 'Example CLI usage for Sinatra server application'
 	version "1.0.0"
 	switch :no_bind,			:description => "Do not bind to TCP socket - useful with -s fastcgi option"
@@ -113,15 +113,15 @@ require 'sinatra/base'
 sinatra = Sinatra.new
 
 sinatra.set :environment, 'production'
-sinatra.set :server, options.server
+sinatra.set :server, settings.server
 sinatra.set :lock, true
 sinatra.set :boundary, "thumnail image data"
-sinatra.set :logging, (not options.no_logging)
-sinatra.set :debug, options.debug
-sinatra.set :optimization, (not options.no_optimization)
-sinatra.set :limit_memory, options.limit_memory
-sinatra.set :limit_map, options.limit_map
-sinatra.set :limit_disk, options.limit_disk
+sinatra.set :logging, (not settings.no_logging)
+sinatra.set :debug, settings.debug
+sinatra.set :optimization, (not settings.no_optimization)
+sinatra.set :limit_memory, settings.limit_memory
+sinatra.set :limit_map, settings.limit_map
+sinatra.set :limit_disk, settings.limit_disk
 
 # set up your application
 
@@ -167,18 +167,18 @@ require 'cli'
 require 'pathname'
 require 'yaml'
 
-options = CLI.new do
+settings = CLI.new do
 	description 'Generate blog posts in given Jekyll directory from input statistics'
 	stdin :log_data,        :cast => YAML, :description => 'statistic data in YAML format'
 	option :location,       :short => :l, :description => 'location name (ex. Dublin, Singapore, Califorina)'
 	option :csv_dir,        :short => :c, :cast => Pathname, :default => 'csv', :description => 'directory name where CSV file will be storred (relative to jekyll-dir)'
 	argument :jekyll_dir,   :cast => Pathname, :default => '/var/lib/vhs/jekyll', :description => 'directory where site source is located'
-end.parse! do |options|
-	fail 'jekyll-dir is not a directory' unless options.jekyll_dir.directory?
-	fail '--csv-dir is not a directory (relative to jekyll-dir)' unless (options.jekyll_dir + options.csv_dir).directory?
+end.parse! do |settings|
+	fail 'jekyll-dir is not a directory' unless settings.jekyll_dir.directory?
+	fail '--csv-dir is not a directory (relative to jekyll-dir)' unless (settings.jekyll_dir + settings.csv_dir).directory?
 end
 
-p options
+p settings
 
 # do your stuff
 ```
@@ -205,7 +205,7 @@ With this example usage (assuming /var/lib/vhs/jekyll/csv dir exist):
       :failures: 0
     EOF
 
-The `options` variable will contain:
+The `settings` variable will contain:
 
     #<CLI::Values stdin={:parser=>{:successes=>41, :failures=>0}}, jekyll_dir=#<Pathname:/var/lib/vhs/jekyll>, csv_dir=#<Pathname:csv>, help=nil, location="Singapore">
 
@@ -238,20 +238,20 @@ require 'rubygems'
 require 'cli'
 require 'pathname'
 
-values = CLI.new do
+settings = CLI.new do
 	description 'Lists content of directories'
 	switch :long, :short => :l, :description => 'use long listing'
 	options :exclude, :short => :e, :description => 'exclude files from listing'
 	arguments :directories, :cast => Pathname, :default => '.', :description => 'directories to list content of'
 end.parse!
 
-values.directories.each do |dir|
+settings.directories.each do |dir|
 	next unless dir.directory?
 	dir.each_entry do |e|
 		next if e.to_s == '.' or e.to_s == '..'
 		e = dir + e
-		next if values.exclude.include? e.to_s
-		if values.long
+		next if settings.exclude.include? e.to_s
+		if settings.long
 			puts "#{e.stat.uid}:#{e.stat.gid} #{e}"
 		else
 			puts e

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.3.1

data/cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cli"
-  s.version = "1.3.0"
+  s.version = "1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2012-11-11"
+  s.date = "2012-11-16"
   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 = [
@@ -51,7 +51,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/jpastuszek/cli"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.24"
   s.summary = "Command line argument parser with stdin handling and usage generator"
 
   if s.respond_to? :specification_version then

data/examples/httpclient

@@ -3,22 +3,22 @@ require 'rubygems'
 require 'cli'
 require 'httpclient'
 
-options = CLI.new do
+settings = CLI.new do
     option :server, :description => 'server address', :default => 'www.google.com'
     option :port, :description => 'server port', :cast => Integer, :default => 80
     argument :url, :description => 'URL to GET or POST to if arguments are given'
     arguments :post_arguments, :required => false
-end.parse! do |options|
-    fail "invalid URL '#{options.url}', URL has to start with '/'" unless options.url =~ /^\//
+end.parse! do |settings|
+    fail "invalid URL '#{settings.url}', URL has to start with '/'" unless settings.url =~ /^\//
 end
 
 c = HTTPClient.new
 
 begin
-    if options.post_arguments.empty?
-        puts c.get_async("http://#{options.server}:#{options.port}#{options.url}").pop.content.read
+    if settings.post_arguments.empty?
+        puts c.get_async("http://#{settings.server}:#{settings.port}#{settings.url}").pop.content.read
     else
-        puts c.post_async("http://#{options.server}:#{options.port}#{options.url}", options.post_arguments.join("\n")).pop.content.read
+        puts c.post_async("http://#{settings.server}:#{settings.port}#{settings.url}", settings.post_arguments.join("\n")).pop.content.read
     end 
 rescue SocketError, Errno::ECONNREFUSED => e
     puts "Falied to connect: #{e}"

data/examples/ls

@@ -3,20 +3,20 @@ require 'rubygems'
 require 'cli'
 require 'pathname'
 
-values = CLI.new do
+settings = CLI.new do
 	description 'Lists content of directories'
 	switch :long, :short => :l, :description => 'use long listing'
 	options :exclude, :short => :e, :description => 'exclude files from listing'
 	arguments :directories,	:cast => Pathname, :default => '.', :description => 'directories to list content of'
 end.parse!
 
-values.directories.each do |dir|
+settings.directories.each do |dir|
 	next unless dir.directory?
 	dir.each_entry do |e|
 		next if e.to_s == '.' or e.to_s == '..'
 		e = dir + e
-		next if values.exclude.include? e.to_s
-		if values.long
+		next if settings.exclude.include? e.to_s
+		if settings.long
 			puts "#{e.stat.uid}:#{e.stat.gid} #{e}"
 		else
 			puts e

data/examples/processor

@@ -4,16 +4,16 @@ require 'cli'
 require 'pathname'
 require 'yaml'
 
-options = CLI.new do
+settings = CLI.new do
 	description 'Generate blog posts in given Jekyll directory from input statistics'
 	stdin :log_data,		:cast => YAML, :description => 'statistic data in YAML format'
 	option :location,		:short => :l, :description => 'location name (ex. Dublin, Singapore, Califorina)'
 	option :csv_dir,		:short => :c, :cast => Pathname, :default => 'csv', :description => 'directory name where CSV file will be storred (relative to jekyll-dir)'
 	argument :jekyll_dir,	:cast => Pathname, :default => '/var/lib/vhs/jekyll', :description => 'directory where site source is located'
-end.parse! do |options|
-	fail 'jekyll-dir is not a directory' unless options.jekyll_dir.directory?
-	fail '--csv-dir is not a directory (relative to jekyll-dir)' unless (options.jekyll_dir + options.csv_dir).directory?
+end.parse! do |settings|
+	fail 'jekyll-dir is not a directory' unless settings.jekyll_dir.directory?
+	fail '--csv-dir is not a directory (relative to jekyll-dir)' unless (settings.jekyll_dir + settings.csv_dir).directory?
 end
 
-p options
+p settings
 

data/examples/sinatra

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'cli'
 require 'ip'
 
-options = CLI.new do
+settings = CLI.new do
 	description 'Example CLI usage for Sinatra server application'
 	version "1.0.0"
 	switch :no_bind,			:description => "Do not bind to TCP socket - useful with -s fastcgi option"
@@ -18,7 +18,7 @@ options = CLI.new do
 	option :limit_disk,			:default => 0, :cast => Integer, :description => "Image cache temporary file size limit in bytes - used when memory mapped file limit is used up"
 end.parse!
 
-p options
+p settings
 
 ## use to set sinatra settings
 #require 'sinatra/base'
@@ -26,13 +26,13 @@ p options
 #sinatra = Sinatra.new
 #
 #sinatra.set :environment, 'production'
-#sinatra.set :server, options.server
+#sinatra.set :server, settings.server
 #sinatra.set :lock, true
 #sinatra.set :boundary, "thumnail image data"
-#sinatra.set :logging, (not options.no_logging)
-#sinatra.set :debug, options.debug
-#sinatra.set :optimization, (not options.no_optimization)
-#sinatra.set :limit_memory, options.limit_memory
-#sinatra.set :limit_map, options.limit_map
-#sinatra.set :limit_disk, options.limit_disk
+#sinatra.set :logging, (not settings.no_logging)
+#sinatra.set :debug, settings.debug
+#sinatra.set :optimization, (not settings.no_optimization)
+#sinatra.set :limit_memory, settings.limit_memory
+#sinatra.set :limit_map, settings.limit_map
+#sinatra.set :limit_disk, settings.limit_disk
 

data/lib/cli/dsl.rb

@@ -37,7 +37,7 @@ class CLI
 						end
 					end
 				rescue => e
-					raise ParsingError::CastError.new(@name, @options[:cast].name, e)
+					raise ParsingError::CastError.new(@name, @options[:cast].respond_to?(:name) ? @options[:cast].name : @options[:cast], e)
 				end
 			end
 		end

data/spec/argument_spec.rb

@@ -48,6 +48,14 @@ describe CLI do
 			}.should raise_error(CLI::ParsingError::CastError)
 		end
 
+		it "casting should fail if there is error in cast lambda" do
+			lambda {
+				ps = CLI.new do
+					argument :size, :cast => lambda{|v| fail 'test'}
+				end.parse(['24.99x'])
+			}.should raise_error(CLI::ParsingError::CastError)
+		end
+
 		it "should cast default value" do
 			ps = CLI.new do
 				argument :number, :cast => Integer, :default => '123'

data/spec/option_spec.rb

@@ -42,6 +42,14 @@ describe CLI do
 			}.should raise_error(CLI::ParsingError::CastError)
 		end
 
+		it "casting should fail if there is error in cast lambda" do
+			lambda {
+				ps = CLI.new do
+					option :size, :cast => lambda{|v| fail 'test'}
+				end.parse(['--size', '24.99x'])
+			}.should raise_error(CLI::ParsingError::CastError)
+		end
+
 		it "should support casting of multiple options" do
 			ps = CLI.new do
 				options :size, :cast => Integer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-11 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70249594753380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70249594753380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70249594752900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249594752900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70249594752320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70249594752320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70249594751660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70249594751660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70249594751120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249594751120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70249594750500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *70249594750500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: ruby-ip
-  requirement: &70249594750020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +117,12 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70249594750020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 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
@@ -143,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2443358638840763179
+      hash: 4581396442984806674
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Command line argument parser with stdin handling and usage generator