cli 0.0.4 → 0.1.0

data/spec/usage_spec.rb

@@ -0,0 +1,303 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLI do
+	describe "usage and description" do
+		describe "help switch" do
+			it "parse should set help variable if -h or --help specified in the argument list and not parse the input" do
+				ss = CLI.new do
+					option :location, :short => :l
+					option :group, :default => 'red'
+					option :power_up, :short => :p
+					option :speed, :short => :s, :cast => Integer
+					option :size
+					switch :debug
+
+					argument :log, :cast => Pathname
+					argument :magick, :default => 'word'
+					argument :test
+					argument :code, :cast => Integer, :default => '123'
+				end
+				
+				ps = ss.parse(['-l', 'singapore', '--power-up', 'yes', '-s', '24', '--size', 'XXXL', '/tmp', 'hello'])
+				ps.help.should be_nil
+				ps.location.should == 'singapore'
+
+				ps = ss.parse(['-h', '-l', 'singapore', '--power-up'])
+				ps.help.should be_a String
+				ps.location.should be_nil
+
+				ps = ss.parse(['-l', 'singapore', '--power-up', '-h', 'yes', '-s', '24', '--size', 'XXXL', '/tmp', 'hello'])
+				ps.help.should be_a String
+				ps.location.should be_nil
+
+				ps = ss.parse(['-l', 'singapore', '--power-up', '--help'])
+				ps.help.should be_a String
+				ps.location.should be_nil
+
+				ps = ss.parse(['--help', '-l', 'singapore', '--power-up', 'yes', '-s', '24', '--size', 'XXXL', '/tmp', 'hello'])
+				ps.help.should be_a String
+				ps.location.should be_nil
+
+				ps = ss.parse(['-l', 'singapore', '--power-up', 'yes', '-s', '24', '--size', 'XXXL', '/tmp', 'hello'])
+				ps.help.should be_nil
+				ps.location.should == 'singapore'
+			end
+
+			it "parse! should cause program to exit and display help message on --help or -h switch" do
+				stdout_read do
+					lambda {
+						ps = CLI.new do
+						end.parse!(['--help'])
+					}.should raise_error SystemExit
+				end.should include('Usage:')
+
+				stdout_read do
+					lambda {
+						ps = CLI.new do
+						end.parse!(['-h'])
+					}.should raise_error SystemExit
+				end.should include('Usage:')
+			end
+
+			it "should reserve --help and -h switches" do
+				lambda {
+					ps = CLI.new do
+						switch :help
+					end
+				}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'switch help specified twice'
+
+				lambda {
+					ps = CLI.new do
+						switch :help2, :short => :h
+					end
+				}.should raise_error CLI::ParserError::ShortNameSpecifiedTwiceError, 'short switch h specified twice'
+			end
+
+			it "should display help switch in the help message as the last entry" do
+					CLI.new do
+						switch :test
+					end.usage.should include("--test\n   --help (-h) - display this help message")
+			end
+		end
+
+		describe "version" do
+			it "should allow specifing version number that will be accessibel via --version switch" do
+					ps = CLI.new do
+						version '1.0.2'
+					end.parse(['--version'])
+					ps.version.should == "rspec version \"1.0.2\"\n"
+			end
+
+			it "parse! should cause program to exit displyaing version on --version switch" do
+				stdout_read do
+					lambda {
+						ps = CLI.new do
+							version "1.2.3"
+						end.parse!(['--version'])
+					}.should raise_error SystemExit
+				end.should == "rspec version \"1.2.3\"\n"
+			end
+
+			it "should display version switch in the help message as the last entry when version is specified" do
+					CLI.new do
+					end.usage.should_not include("--version")
+
+					CLI.new do
+						version '1.0.2'
+					end.usage.should include("--help (-h) - display this help message\n   --version - display version string")
+			end
+
+			it "should reserve --version switch" do
+				lambda {
+					ps = CLI.new do
+						switch :version
+					end
+				}.should_not raise_error
+
+				lambda {
+					ps = CLI.new do
+						version '1.0.2'
+						switch :version
+					end
+				}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'switch version specified twice'
+
+				lambda {
+					ps = CLI.new do
+						version '1.0.2'
+						option :version
+					end
+				}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'option and switch version specified twice'
+			end
+		end
+
+		it "should allow describing switches" do
+			ss = CLI.new do
+				switch :debug, :short => :d, :description => "enable debugging"
+				switch :logging
+			end
+
+			ss.usage.should include("enable debugging")
+		end
+
+		it "switch description should be casted to string" do
+			ss = CLI.new do
+				switch :debug, :short => :d, :description => 2 + 2
+				switch :logging
+			end
+
+			ss.usage.should include("4")
+		end
+
+		it "should allow describing options" do
+			ss = CLI.new do
+				option :location, :short => :l, :description => "place where server is located"
+				option :group, :default => 'red'
+			end
+
+			ss.usage.should include("place where server is located")
+		end
+
+		it "option description should be casted to string" do
+			ss = CLI.new do
+				option :location, :short => :l, :description => 2 + 2
+				option :group, :default => 'red'
+			end
+
+			ss.usage.should include("4")
+		end
+
+		it "should allow describing arguments" do
+			ss = CLI.new do
+				option :group, :default => 'red'
+				argument :log, :cast => Pathname, :description => "log file to process"
+			end
+
+			ss.usage.should include("log file to process")
+		end
+
+		it "argument description should be casted to string" do
+			ss = CLI.new do
+				option :group, :default => 'red'
+				argument :log, :cast => Pathname, :description => 2 + 2
+			end
+
+			ss.usage.should include("4")
+		end
+
+		it "should suggest that arguments can be used in usage line" do
+			ss = CLI.new do
+				argument :location
+			end
+
+			# switches will always be there due to implicit --help switch
+			ss.usage.first.should == "Usage: rspec [switches] [--] location\n"
+		end
+
+		it "should suggest that switches can be used in usage line" do
+			ss = CLI.new do
+				switch :location, :short => :l
+			end
+
+			ss.usage.first.should == "Usage: rspec [switches]\n"
+		end
+
+		it "should suggest that options can be used in usage line" do
+			ss = CLI.new do
+				option :location, :short => :l
+			end
+
+			# switches will always be there due to implicit --help switch
+			ss.usage.first.should == "Usage: rspec [switches|options]\n"
+		end
+
+		it "should suggest that switches or options can be used in usage line" do
+			ss = CLI.new do
+				switch :location, :short => :l
+				option :size, :short => :s
+			end
+
+			ss.usage.first.should == "Usage: rspec [switches|options]\n"
+		end
+
+		it "should allow describing whole script" do
+			ss = CLI.new do
+				description 'Log file processor'
+				option :group, :default => 'red'
+				argument :log, :cast => Pathname
+			end
+
+			ss.usage.should include("Log file processor")
+		end
+
+		it "should provide stdin usage information" do
+			CLI.new do
+				stdin
+			end.usage.should include(" < data")
+
+			CLI.new do
+				stdin :log_file
+			end.usage.should include(" < log-file")
+
+			u = CLI.new do
+				stdin :log_file, :description => 'log file to process'
+			end.usage
+			u.should include(" < log-file")
+			u.should include("log file to process")
+
+			u = CLI.new do
+				stdin :log_data, :cast => YAML, :description => 'log data to process'
+			end.usage
+			u.should include(" < log-data")
+			u.should include("log data to process")
+		end
+
+		it "should provide formated usage with optional message" do
+			u = CLI.new do
+				description 'Log file processor'
+				version '1.0'
+				stdin :log_data, :cast => YAML, :description => "YAML formatted log data"
+				switch :debug, :short => :d, :description => "enable debugging"
+				switch :logging, :short => :l
+				switch :run
+				option :location, :short => :r, :description => "place where server is located"
+				option :group, :default => 'red'
+				option :power_up, :short => :p
+				option :speed, :short => :s, :cast => Integer
+				option :the_number_of_the_beast, :short => :b, :cast => Integer, :default => 666, :description => "The number of the beast"
+				option :size
+
+				argument :log, :cast => Pathname, :description => "log file to process"
+				argument :magick, :default => 'word'
+				argument :string
+				argument :number, :cast => Integer
+				argument :code, :cast => Integer, :default => '123', :description => "secret code"
+				argument :illegal_prime, :cast => Integer, :description => "prime number that represents information that it is forbidden to possess or distribute"
+			end.usage
+
+			u.should == <<EOS
+Usage: rspec [switches|options] [--] log magick string number code illegal-prime < log-data
+Log file processor
+Input:
+   log-data - YAML formatted log data
+Switches:
+   --debug (-d) - enable debugging
+   --logging (-l)
+   --run
+   --help (-h) - display this help message
+   --version - display version string
+Options:
+   --location (-r) - place where server is located
+   --group [red]
+   --power-up (-p)
+   --speed (-s)
+   --the-number-of-the-beast (-b) [666] - The number of the beast
+   --size
+Arguments:
+   log - log file to process
+   code - secret code
+   illegal-prime - prime number that represents information that it is forbidden to possess or distribute
+EOS
+		end
+	end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cli
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-15 00:00:00 Z
+date: 2011-12-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -131,17 +131,19 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - cli.gemspec
+- examples/processor
+- examples/sinatra
 - features/cli.feature
 - features/step_definitions/cli_steps.rb
 - features/support/env.rb
@@ -150,8 +152,15 @@ files:
 - lib/cli/dsl.rb
 - lib/cli/options.rb
 - lib/cli/switches.rb
+- spec/argument_spec.rb
 - spec/cli_spec.rb
+- spec/conflict_reporting_spec.rb
+- spec/option_spec.rb
+- spec/separator_spec.rb
 - spec/spec_helper.rb
+- spec/stdin_spec.rb
+- spec/switch_spec.rb
+- spec/usage_spec.rb
 homepage: http://github.com/jpastuszek/cli
 licenses: 
 - MIT

data/README.rdoc

@@ -1,19 +0,0 @@
-= cli
-
-Description goes here.
-
-== Contributing to cli
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Jakub Pastuszek. See LICENSE.txt for
-further details.
-