cli 0.0.2 → 0.0.3

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/cli.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cli"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]

data/lib/cli.rb

@@ -7,12 +7,25 @@ class CLI
 	end
 
 	class Parsed < OpenStruct
-		def set(argument, value)
+		def value(argument, value)
 			send((argument.name.to_s + '=').to_sym, argument.cast(value)) 
 		end
+
+		def set(argument)
+			send((argument.name.to_s + '=').to_sym, true) 
+		end
 	end
 
 	module Options
+		class Base
+			def initialize(name, options = {})
+				@name = name
+				@options = options
+			end
+
+			attr_reader :name
+		end
+		
 		module Cast
 			def cast(value)
 				begin
@@ -43,14 +56,23 @@ class CLI
 				@options[:description]
 			end
 		end
-	end
 
-	class STDINHandling
-		def initialize(name, options = {})
-			@name = name
-			@options = options
+		module Value
+			def default
+				@options[:default]
+			end
+
+			def has_default?
+				@options.member? :default
+			end
+
+			def optional?
+				has_default?
+			end
 		end
+	end
 
+	class STDINHandling < Options::Base
 		include Options::Cast
 		include Options::Description
 
@@ -59,40 +81,18 @@ class CLI
 		end
 	end
 
-	class Argument
-		def initialize(name, options = {})
-			@name = name
-			@options = {
-				:cast => String
-			}.merge(options)
-		end
-
-		attr_reader :name
-
+	class Argument < Options::Base
+		include Options::Value
 		include Options::Cast
 		include Options::Description
 
-		def default
-			@options[:default]
-		end
-
-		def has_default?
-			@options.member? :default
-		end
-
-		def optional?
-			has_default?
-		end
-		
 		def to_s
 			name.to_s.tr('_', '-')
 		end
 	end
 
-	class Option < Argument
-		def optional?
-			has_default? or not @options[:required]
-		end
+	class Switch < Options::Base
+		include Options::Description
 
 		def has_short?
 			@options.member? :short
@@ -115,11 +115,20 @@ class CLI
 		end
 	end
 
+	class Option < Switch
+		include Options::Value
+		include Options::Cast
+
+		def optional?
+			has_default? or not @options[:required]
+		end
+	end
+
 	def initialize(&block)
 		#TODO: optoins should be in own class?
-		@options = []
-		@optoins_long = {}
-		@optoins_short = {}
+		@switches = []
+		@switches_long = {}
+		@switches_short = {}
 		@options_default = []
 		@options_required = []
 		@arguments = []
@@ -139,11 +148,18 @@ class CLI
 		@arguments << Argument.new(name, options)
 	end
 
+	def switch(name, options = {})
+		o = Switch.new(name, options)
+		@switches << o
+		@switches_long[name] = o
+		@switches_short[o.short] = o if o.has_short?
+	end
+
 	def option(name, options = {})
 		o = Option.new(name, options)
-		@options << o
-		@optoins_long[name] = o
-		@optoins_short[o.short] = o if o.has_short?
+		@switches << o
+		@switches_long[name] = o
+		@switches_short[o.short] = o if o.has_short?
 		@options_default << o if o.has_default?
 		@options_required << o unless o.optional?
 	end
@@ -161,25 +177,27 @@ class CLI
 
 		# set defaults
 		@options_default.each do |o|
-			parsed.set(o, o.default)
+			parsed.value(o, o.default)
 		end
 
 		# process switches
 		options_required = @options_required.dup
 		while argv.first =~ /^-/
-			switch = argv.shift
-			option = if switch =~ /^--/
-				@optoins_long[switch.sub(/^--/, '').tr('-', '_').to_sym]
+			arg = argv.shift
+			switch = if arg =~ /^--/
+				@switches_long[arg.sub(/^--/, '').tr('-', '_').to_sym]
 			else
-				@optoins_short[switch.sub(/^-/, '').tr('-', '_').to_sym]
+				@switches_short[arg.sub(/^-/, '').tr('-', '_').to_sym]
 			end
 
-			if option
-				value = argv.shift or raise ParsingError, "missing option argument: #{option}"
-				parsed.set(option, value)
-				options_required.delete(option)
+			raise ParsingError, "unknonw switch: #{arg}" unless switch
+
+			if switch.kind_of? Option
+				value = argv.shift or raise ParsingError, "missing option argument: #{switch}"
+				parsed.value(switch, value)
+				options_required.delete(switch)
 			else
-				raise ParsingError, "unknonw switch: #{switch}"
+				parsed.set(switch)
 			end
 		end
 
@@ -195,7 +213,7 @@ class CLI
 				argv.shift or raise ParsingError, "missing argument: #{argument}"
 			end
 
-			parsed.set(argument, value)
+			parsed.value(argument, value)
 		end
 
 		# process stdin
@@ -218,10 +236,15 @@ class CLI
 	end
 
 	def usage(msg = nil)
+		switches = @switches.select{|s| s.class == Switch}
+		options = @switches.select{|s| s.class == Option}
+
 		out = StringIO.new
 		out.puts msg if msg
 		out.print "Usage: #{File.basename $0}"
-		out.print ' [options]' unless @optoins_long.empty?
+		out.print ' [switches|options]' if not switches.empty? and not options.empty?
+		out.print ' [switches]' if not switches.empty? and options.empty?
+		out.print ' [options]' if switches.empty? and not options.empty?
 		out.print ' ' + @arguments.map{|a| a.to_s}.join(' ') unless @arguments.empty?
 		out.print " < #{@stdin_handling}" if @stdin_handling
 
@@ -233,9 +256,20 @@ class CLI
 			out.puts "   #{@stdin_handling} - #{@stdin_handling.description}"
 		end
 
-		unless @optoins_long.empty?
+		unless switches.empty?
+			out.puts "Switches:"
+			switches.each do |s|
+				out.print '   '
+				out.print s.switch
+				out.print " (#{s.switch_short})" if s.has_short?
+				out.print " - #{s.description}" if s.description?
+				out.puts
+			end
+		end
+
+		unless options.empty?
 			out.puts "Options:"
-			@options.each do |o|
+			options.each do |o|
 				out.print '   '
 				out.print o.switch
 				out.print " (#{o.switch_short})" if o.has_short?

data/spec/cli_spec.rb

@@ -149,6 +149,36 @@ EOF
 		end
 	end
 
+	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 on unrecognized switch" do
+			ps = CLI.new do
+				option :location
+			end
+			
+			lambda {
+				ps.parse(['--xxx'])
+			}.should raise_error CLI::ParsingError
+		end
+	end
+
 	describe 'option handling' do
 		it "should handle long option names" do
 			ps = CLI.new do
@@ -210,16 +240,6 @@ EOF
 			ps.gold.should be_nil
 		end
 
-		it "should raise error on unrecognized switch" do
-			ps = CLI.new do
-				option :location
-			end
-			
-			lambda {
-				ps.parse(['--xxx', 'singapore'])
-			}.should raise_error CLI::ParsingError
-		end
-
 		it "should raise error on missing option argument" do
 			ps = CLI.new do
 				option :location
@@ -244,19 +264,20 @@ EOF
 		end
 	end
 
-	it "should handle options and then arguments" do
+	it "should handle options, switches and then arguments" 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 :size
+			switch :debug
 
 			argument :log, :cast => Pathname
 			argument :magick, :default => 'word'
 			argument :test
 			argument :code, :cast => Integer, :default => '123'
-		end.parse(['-l', 'singapore', '--power-up', 'yes', '-s', '24', '--size', 'XXXL', '/tmp', 'hello'])
+		end.parse(['-l', 'singapore', '--power-up', 'yes', '-s', '24', '--debug', '--size', 'XXXL', '/tmp', 'hello'])
 
 		ps.group.should == 'red'
 		ps.power_up.should == 'yes'
@@ -267,6 +288,7 @@ EOF
 		ps.magick.should == 'word'
 		ps.test.should == 'hello'
 		ps.code.should == 123
+		ps.debug.should be_true
 	end
 
 	describe "usage and description" do
@@ -277,6 +299,7 @@ EOF
 				option :power_up, :short => :p
 				option :speed, :short => :s, :cast => Integer
 				option :size
+				switch :debug
 
 				argument :log, :cast => Pathname
 				argument :magick, :default => 'word'
@@ -309,6 +332,15 @@ EOF
 			ps.location.should == 'singapore'
 		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 "should allow describing options" do
 			ss = CLI.new do
 				option :location, :short => :l, :description => "place where server is located"
@@ -363,6 +395,9 @@ EOF
 			u = CLI.new do
 				description 'Log file processor'
 				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 => :l, :description => "place where server is located"
 				option :group, :default => 'red'
 				option :power_up, :short => :p
@@ -381,10 +416,14 @@ EOF
 			#puts u
 
 			u.should == <<EOS
-Usage: rspec [options] log magick string number code illegal-prime < log-data
+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
 Options:
    --location (-l) - place where server is located
    --group [red]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cli
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jakub Pastuszek