cli 0.3.0 → 0.4.0

data/README.md

@@ -103,11 +103,16 @@ require 'yaml'
 
 options = 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!
+	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
+
+p options
 
 # do your stuff
 ```
@@ -126,7 +131,7 @@ Example help message:
     Arguments:
        jekyll-dir - directory where site source is located
 
-With this example usage:
+With this example usage (assuming /var/lib/vhs/jekyll/csv dir exist):
 
     examples/processor --location Singapore <<EOF
     :parser: 
@@ -136,7 +141,22 @@ With this example usage:
 
 The `options` variable will contain:
 
-    #<CLI::Values location="Singapore", stdin={:parser=>{:failures=>0, :successes=>41}}, jekyll_dir=#<Pathname:/var/lib/vhs/jekyll>, csv_dir=#<Pathname:csv>>
+    #<CLI::Values stdin={:parser=>{:successes=>41, :failures=>0}}, jekyll_dir=#<Pathname:/var/lib/vhs/jekyll>, csv_dir=#<Pathname:csv>, help=nil, location="Singapore">
+
+Output if jekyll-dir does not exist:
+
+    Error: jekyll-dir is not a directory
+    Usage: processor [switches|options] [--] jekyll-dir < log-data
+    Generate blog posts in given Jekyll directory from input statistics
+    Input:
+       log-data - statistic data in YAML format
+    Switches:
+       --help (-h) - display this help message
+    Options:
+       --location (-l) - location name (ex. Dublin, Singapore, Califorina)
+       --csv-dir (-c) [csv] - directory name where CSV file will be storred (relative to jekyll-dir)
+    Arguments:
+       jekyll-dir [/var/lib/vhs/jekyll] - directory where site source is located
 
 ### Ls like utility
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cli"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2011-12-21"
+  s.date = "2011-12-30"
   s.description = "Provides DSL for command-line options, switches and arguments parser and stdin handling with generated usage printer"
   s.email = "jpastuszek@gmail.com"
   s.extra_rdoc_files = [

data/examples/processor

@@ -9,7 +9,10 @@ options = CLI.new do
 	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!
+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
 
 p options
 

data/lib/cli.rb

@@ -87,6 +87,9 @@ class CLI
 				super("failed to cast: '#{arg}' to type: #{cast_name}: #{error}")
 			end
 		end
+
+		class UsageError < ParsingError
+		end
 	end
 
 	class Values < OpenStruct
@@ -148,34 +151,19 @@ class CLI
 
 	def switch(name, options = {})
 		switch_dsl = DSL::Switch.new(name, options)
-
-		raise ParserError::LongNameSpecifiedTwiceError.new('switch', switch_dsl) if @switches.has_long?(switch_dsl) 
-		raise ParserError::LongNameSpecifiedTwiceError.new('option and switch', switch_dsl) if @options.has_long?(switch_dsl) 
-		raise ParserError::ShortNameSpecifiedTwiceError.new('switch', switch_dsl) if @switches.has_short?(switch_dsl) 
-		raise ParserError::ShortNameSpecifiedTwiceError.new('option and switch', switch_dsl) if @options.has_short?(switch_dsl) 
-
+		check_switch_collision!(switch_dsl)
 		@switches << switch_dsl
 	end
 
 	def option(name, options = {})
 		option_dsl = DSL::Option.new(name, options)
-
-		raise ParserError::LongNameSpecifiedTwiceError.new('option', option_dsl) if @options.has_long?(option_dsl) 
-		raise ParserError::LongNameSpecifiedTwiceError.new('switch and option', option_dsl) if @switches.has_long?(option_dsl) 
-		raise ParserError::ShortNameSpecifiedTwiceError.new('option', option_dsl) if @options.has_short?(option_dsl) 
-		raise ParserError::ShortNameSpecifiedTwiceError.new('switch and option', option_dsl) if @switches.has_short?(option_dsl) 
-
+		check_switch_collision!(option_dsl)
 		@options << option_dsl
 	end
 
 	def options(name, options = {})
 		option_dsl = DSL::Options.new(name, options)
-
-		raise ParserError::LongNameSpecifiedTwiceError.new('option', option_dsl) if @options.has_long?(option_dsl) 
-		raise ParserError::LongNameSpecifiedTwiceError.new('switch and option', option_dsl) if @switches.has_long?(option_dsl) 
-		raise ParserError::ShortNameSpecifiedTwiceError.new('option', option_dsl) if @options.has_short?(option_dsl) 
-		raise ParserError::ShortNameSpecifiedTwiceError.new('switch and option', option_dsl) if @switches.has_short?(option_dsl) 
-
+		check_switch_collision!(option_dsl)
 		@options << option_dsl
 	end
 
@@ -198,6 +186,15 @@ class CLI
 			end
 		end
 
+		# initialize values
+		@options.each do |o|
+			values.value(o, nil)
+		end
+
+		@switches.each do |o|
+			values.value(o, nil)
+		end
+
 		# initialize multi options
 		@options.multiple.each do |o|
 			values.value(o, [])
@@ -274,6 +271,14 @@ class CLI
 				stdout.write pp.version
 				exit 0
 			end
+
+			if block_given?
+				begin
+					yield pp
+				rescue RuntimeError => e
+					raise ParsingError::UsageError, e.message
+				end
+			end
 			pp
 		rescue ParsingError => pe
 			usage!(pe, stderr)
@@ -353,5 +358,20 @@ class CLI
 		io.write usage(msg)
 		exit 42
 	end
+
+	private
+
+	def check_switch_collision!(switch_dsl)
+		type = switch_dsl.class.name.downcase.sub(/.*::/, '')
+		{
+			'switch' => @switches, 
+			'option' => @options
+		}.each_pair do |collection_type, collection|
+			what = (type == collection_type ? type : collection_type + ' and ' + type)
+
+			raise ParserError::LongNameSpecifiedTwiceError.new(what, switch_dsl) if collection.has_long?(switch_dsl) 
+			raise ParserError::ShortNameSpecifiedTwiceError.new(what, switch_dsl) if collection.has_short?(switch_dsl) 
+		end
+	end
 end
 

data/spec/cli_spec.rb

@@ -41,6 +41,47 @@ describe CLI do
 			ps.code.should == 'hello'
 		end
 
+		it "should return value structure where all values are set" do
+			h = CLI.new do
+				option :location, :short => :l
+				switch :debug
+			end.parse!([]).marshal_dump
+
+			h.member?(:location).should be_true
+			h[:location].should be_nil
+
+			h.member?(:debug).should be_true
+			h[:debug].should be_nil
+		end
+
+		it "should take a block that can be used to verify passed values" do
+			lambda {
+				ps = CLI.new do
+					option :location, :short => :l
+					switch :debug
+					switch :verbose
+					argument :code
+				end.parse!(['-l', 'singapore', '--debug', 'hello']) do |values|
+					fail '--debug can not be used with --verbose' if values.debug and values.verbose
+				end
+			}.should_not raise_error
+
+			out = stderr_read do
+				lambda {
+					ps = CLI.new do
+						option :location, :short => :l
+						switch :debug
+						switch :verbose
+						argument :code
+					end.parse!(['-l', 'singapore', '--debug', '--verbose', 'hello']) do |values|
+						fail '--debug can not be used with --verbose' if values.debug and values.verbose
+					end
+					}.should raise_error SystemExit
+				end
+				out.should include('Error: --debug can not be used with --verbose')
+				out.should include('Usage:')
+		end
+
 		it "should exit displaying usage and error message on standard error on usage error" do
 				out = stderr_read do
 					lambda {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cli
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-21 00:00:00 Z
+date: 2011-12-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development