cli 0.0.4 → 0.1.0

data/spec/conflict_reporting_spec.rb

@@ -0,0 +1,69 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLI do
+	describe "name conflict reporting" do
+		it "raise error when long names configlict" do
+			lambda {
+				ps = CLI.new do
+					switch :location
+					switch :location
+				end
+			}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'switch location specified twice'
+
+			lambda {
+				ps = CLI.new do
+					option :location
+					option :location
+				end
+			}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'option location specified twice'
+
+			lambda {
+				ps = CLI.new do
+					switch :location
+					option :location
+				end
+			}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'switch and option location specified twice'
+
+			lambda {
+				ps = CLI.new do
+					option :location
+					switch :location
+				end
+			}.should raise_error CLI::ParserError::LongNameSpecifiedTwiceError, 'option and switch location specified twice'
+		end
+	end
+
+	describe "short name conflict reporting" do
+		it "raise error when short names configlict" do
+			lambda {
+				ps = CLI.new do
+					switch :location, :short => :l
+					switch :location2, :short => :l
+				end
+			}.should raise_error CLI::ParserError::ShortNameSpecifiedTwiceError, 'short switch l specified twice'
+
+			lambda {
+				ps = CLI.new do
+					option :location, :short => :l
+					option :location2, :short => :l
+				end
+			}.should raise_error CLI::ParserError::ShortNameSpecifiedTwiceError, 'short option l specified twice'
+
+			lambda {
+				ps = CLI.new do
+					switch :location, :short => :l
+					option :location2, :short => :l
+				end
+			}.should raise_error CLI::ParserError::ShortNameSpecifiedTwiceError, 'short switch and option l specified twice'
+
+			lambda {
+				ps = CLI.new do
+					option :location2, :short => :l
+					switch :location, :short => :l
+				end
+			}.should raise_error CLI::ParserError::ShortNameSpecifiedTwiceError, 'short option and switch l specified twice'
+		end
+	end
+end
+

data/spec/option_spec.rb

@@ -0,0 +1,155 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLI do
+	describe 'option handling' do
+		it "should handle long option names" do
+			ps = CLI.new do
+				option :location
+			end.parse(['--location', 'singapore'])
+			ps.location.should be_a String
+			ps.location.should == 'singapore'
+		end
+
+		it "should handle short option names" do
+			ps = CLI.new do
+				option :location, :short => :l
+			end.parse(['-l', 'singapore'])
+			ps.location.should be_a String
+			ps.location.should == 'singapore'
+		end
+
+		it "should support casting" do
+			ps = CLI.new do
+				option :size, :cast => Integer
+			end.parse(['--size', '24'])
+			ps.size.should be_a Integer
+			ps.size.should == 24
+		end
+
+		it "should support casting with lambda" do
+			ps = CLI.new do
+				option :size, :cast => lambda{|v| v.to_i + 2}
+			end.parse(['--size', '24'])
+			ps.size.should be_a Integer
+			ps.size.should == 26
+		end
+
+		it "should support casting with class" do
+			class Upcaser
+				def initialize(string)
+					@value = string.upcase
+				end
+				attr_reader :value
+			end
+
+			ps = CLI.new do
+				option :text, :cast => Upcaser
+			end.parse(['--text', 'hello world'])
+			ps.text.should be_a Upcaser
+			ps.text.value.should == 'HELLO WORLD'
+		end
+
+		it "should handle default values" do
+			ps = CLI.new do
+				option :location, :default => 'singapore'
+				option :size, :cast => Integer, :default => 23
+			end.parse([])
+			ps.location.should be_a String
+			ps.location.should == 'singapore'
+			ps.size.should be_a Integer
+			ps.size.should == 23
+		end
+
+		it "default value is casted" do
+			ps = CLI.new do
+				option :location, :default => 'singapore'
+				option :size, :cast => Integer, :default => 23.99
+			end.parse([])
+			ps.location.should be_a String
+			ps.location.should == 'singapore'
+			ps.size.should be_a Integer
+			ps.size.should == 23
+		end
+
+		it "not given and not defined options should be nil" do
+			ps = CLI.new do
+				option :size, :cast => Integer
+			end.parse([])
+			ps.size.should be_nil
+			ps.gold.should be_nil
+		end
+
+		it "should handle multiple long and short intermixed options" do
+			ps = CLI.new do
+				option :location, :short => :l
+				option :group, :default => 'red'
+				option :power_up, :short => :p
+				option :speed, :short => :s, :cast => Integer
+				option :not_given
+				option :size
+			end.parse(['-l', 'singapore', '--power-up', 'yes', '-s', '24', '--size', 'XXXL'])
+			ps.group.should == 'red'
+			ps.power_up.should == 'yes'
+			ps.speed.should == 24
+			ps.not_given.should be_nil
+			ps.size.should == 'XXXL'
+			ps.gold.should be_nil
+		end
+
+		it "should raise error if not symbol and optional hash is passed" do
+			lambda {
+				ps = CLI.new do
+					option 'number'
+				end
+			}.should raise_error CLI::ParserError::NameArgumetNotSymbolError, "option name has to be of type Symbol, got String"
+
+			lambda {
+				ps = CLI.new do
+					option :number, :test
+				end
+			}.should raise_error CLI::ParserError::OptionsArgumentNotHashError, "option options has to be of type Hash, got Symbol"
+		end
+
+		it "should raise error on missing option argument" do
+			ps = CLI.new do
+				option :location
+			end
+			
+			lambda {
+				ps.parse(['--location'])
+			}.should raise_error CLI::ParsingError::MissingOptionValueError, 'missing value for option --location'
+		end
+
+		it "should raise error on missing mandatory option" do
+			ps = CLI.new do
+				option :location
+				option :weight, :required => true
+				option :size, :required => true
+				option :group, :default => 'red'
+				option :speed, :short => :s, :cast => Integer
+			end
+			
+			lambda {
+				ps.parse([])
+			}.should raise_error CLI::ParsingError::MandatoryOptionsNotSpecifiedError, "mandatory options not specified: --size, --weight"
+		end
+
+		it "by default option value should be nil" do
+			ps = CLI.new do
+				option :location
+				option :speed, :short => :s, :cast => Integer
+				option :weight, :required => true
+				option :group, :default => 'red'
+			end
+			
+			o = ps.parse(['--weight', '123'])
+
+			o.location.should be_nil
+			o.speed.should be_nil
+
+			o.weight.should == '123'
+			o.group.should == 'red'
+		end
+	end
+end
+

data/spec/separator_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLI do
+	describe "argument separator" do
+		it "should allow separating arguments from switches so that arguments can contain switch like elements" do
+			ps = CLI.new do
+				option :location, :short => :l
+				option :group, :default => 'red'
+				switch :debug
+				switch :verbose
+				argument :test
+			end.parse(['-l', 'singapore', '--debug', '--', '--verbose'])
+
+			ps.help.should be_nil
+			ps.location.should == 'singapore'
+			ps.group.should == 'red'
+			ps.debug.should be_true
+			ps.test.should == '--verbose'
+			ps.verbose.should be_nil
+
+			ps = CLI.new do
+				option :location, :short => :l
+				option :group, :default => 'red'
+				switch :debug
+				switch :verbose
+				argument :test
+			end.parse(['-l', 'singapore', '--debug', '--help'])
+
+			ps.location.should be_nil
+			ps.group.should be_nil
+			ps.debug.should be_nil
+			ps.verbose.should be_nil
+			ps.help.should_not be_nil
+
+			ps = CLI.new do
+				option :location, :short => :l
+				option :group, :default => 'red'
+				switch :debug
+				switch :merge, :short => :m
+				switch :verbose
+				argument :test
+				argument :test2
+				argument :test3
+			end.parse(['-l', 'singapore', '--debug', '--', '--help', '--version', '-m'])
+
+			ps.help.should be_nil
+			ps.location.should == 'singapore'
+			ps.group.should == 'red'
+			ps.debug.should be_true
+			ps.test.should == '--help'
+			ps.test2.should == '--version'
+			ps.test3.should == '-m'
+			ps.verbose.should be_nil
+		end
+	end
+end
+

data/spec/spec_helper.rb

@@ -9,3 +9,57 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   
 end
+
+def stdin_write(data)
+		r, w = IO.pipe
+		old_stdin = STDIN.clone
+		STDIN.reopen r
+		Thread.new do
+		 	w.write data
+			w.close
+		end
+		begin
+			yield
+		ensure
+			STDIN.reopen old_stdin
+		end
+end
+
+def stdout_read
+		r, w = IO.pipe
+		old_stdout = STDOUT.clone
+		STDOUT.reopen(w)
+		data = ''
+		t = Thread.new do
+			data << r.read
+		end
+		begin
+			yield
+		ensure
+			w.close
+			STDOUT.reopen(old_stdout)
+		end
+		t.join
+		data
+end
+
+def stderr_read
+		r, w = IO.pipe
+		old_stdout = STDERR.clone
+		STDERR.reopen(w)
+		data = ''
+		t = Thread.new do
+			data << r.read
+		end
+		begin
+			yield
+		ensure
+			w.close
+			STDERR.reopen(old_stdout)
+		end
+		t.join
+		data
+end
+
+require 'cli'
+

data/spec/stdin_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLI do
+	describe 'STDIN handling' do
+		before :all do
+			@yaml = <<EOF
+--- 
+:parser: 
+  :successes: 41
+  :failures: 0
+EOF
+		end
+
+		it "should be nil if not specified" do
+			ps = CLI.new.parse
+			ps.stdin.should be_nil
+		end
+
+		it "should return IO if stdin is defined" do
+			ps = CLI.new do
+				stdin
+			end.parse
+			ps.stdin.should be_a IO
+		end
+
+		it "should support casting to YAML" do
+			ps = nil
+			ss = CLI.new do
+				stdin :log_data, :cast => YAML, :description => 'log statistic data in YAML format'
+			end
+
+			stdin_write(@yaml) do
+				ps = ss.parse
+			end
+
+			ps.stdin.should == {:parser=>{:successes=>41, :failures=>0}}
+		end
+
+		it "should support casting with lambda" do
+			ps = nil
+			ss = CLI.new do
+				stdin :log_data, :cast => lambda{|sin| sin.read.upcase}, :description => 'log statistic data in YAML format'
+			end
+
+			stdin_write('hello world') do
+				ps = ss.parse
+			end
+
+			ps.stdin.should == 'HELLO WORLD'
+		end
+
+		it "should support casting with custom class" do
+			class Upcaser
+				def initialize(io)
+					@value = io.read.upcase
+				end
+				attr_reader :value
+			end
+
+			ps = nil
+			ss = CLI.new do
+				stdin :log_data, :cast => Upcaser, :description => 'log statistic data in YAML format'
+			end
+
+			stdin_write('hello world') do
+				ps = ss.parse
+			end
+
+			ps.stdin.should be_a Upcaser
+			ps.stdin.value.should == 'HELLO WORLD'
+		end
+	end
+end
+

data/spec/switch_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CLI do
+	describe 'switch handling' do
+		it "should handle long switch names" do
+			ps = CLI.new do
+				switch :location
+				switch :unset
+			end.parse(['--location'])
+			ps.location.should be_true
+			ps.unset.should be_nil
+		end
+
+		it "should handle short switch names" do
+			ps = CLI.new do
+				switch :location, :short => :l
+				switch :unset, :short => :u
+			end.parse(['-l'])
+			ps.location.should be_true
+			ps.unset.should be_nil
+		end
+
+		it "should raise error if not symbol and optional hash is passed" do
+			lambda {
+				ps = CLI.new do
+					switch 'number'
+				end.parse([])
+			}.should raise_error CLI::ParserError::NameArgumetNotSymbolError, "switch name has to be of type Symbol, got String"
+
+			lambda {
+				ps = CLI.new do
+					switch :number, :test
+				end
+			}.should raise_error CLI::ParserError::OptionsArgumentNotHashError, "switch options has to be of type Hash, got Symbol"
+		end
+
+		it "shoud raise error is short name is invalid" do
+			lambda {
+				ps = CLI.new do
+					switch :location, :short => "l"
+				end
+			}.should raise_error CLI::ParserError::ShortNameNotSymbolError, 'short name has to be of type Symbol, got String'
+
+			lambda {
+				ps = CLI.new do
+					switch :location, :short => :abc
+				end
+			}.should raise_error CLI::ParserError::ShortNameIsInvalidError, 'short name has to be one letter symbol, got abc'
+		end
+
+		it "should raise error on unrecognized switch" do
+			ps = CLI.new do
+				option :location
+			end
+			
+			lambda {
+				ps.parse(['--xxx'])
+			}.should raise_error CLI::ParsingError::UnknownSwitchError, 'unknown switch --xxx'
+		end
+	end
+end
+