clasp-ruby 0.18.2 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bfeb7de8319fee62e174f609591715f0910e1ad
-  data.tar.gz: cc60cc8e5ce0c2a841f024785cccc0d2c90a54ec
+  metadata.gz: 95ce67e26d5789cde25d8fd230f49933751f0c60
+  data.tar.gz: c8be483da241ea331f967af810dcb50338561886
 SHA512:
-  metadata.gz: 4e7ab5192e70f3b5dc243c81fc3d8a645fea11ae5cb64a7efed074460ec2339cac839b504917d6dc225a76899dcb726dd03078fa1bafd1b0251b4337521a3969
-  data.tar.gz: d502c1f31d0f13aad64e7e680288285d795ce5a0edb275a085be27c6bf0f2dc4b90c838425e6470a6d446f82721ac9fb818c1f8e8692ce9df7a60c52da987171
+  metadata.gz: 77474bb5bb8a963d0649888750eb7d563e8549ac0d81fffd08e938091d5d91d9d32e1a21744190b69787cca8af138696aaf4aee8547e409f6f28cd71444a6191
+  data.tar.gz: 38a535bc60563b48eff9df3bdf28516b99caea46505f7b2fe7b464ada7fdb5273a3921be571ad020214fb8c4bf79d77eed44c63e30cd0636f1b1b19284c10b56

data/lib/clasp/arguments.rb

@@ -6,7 +6,7 @@
 #               CLASP.Ruby
 #
 # Created:      14th February 2014
-# Updated:      12th April 2019
+# Updated:      13th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -63,9 +63,9 @@ class Arguments
 
 	#:stopdoc:
 	private
-	class FlagArgument #:nodoc: all
+	class FlagArgument # :nodoc: all
 
-		#:nodoc:
+		# :nodoc:
 		def initialize(arg, given_index, given_name, resolved_name, argument_alias, given_hyphens, given_label, extras)
 
 			@arg			=	arg
@@ -86,13 +86,13 @@ class Arguments
 		attr_reader :name
 		attr_reader :extras
 
-		#:nodoc:
+		# :nodoc:
 		def to_s
 
 			@name
 		end
 
-		#:nodoc:
+		# :nodoc:
 		def eql?(rhs)
 
 			return false if rhs.nil?
@@ -103,7 +103,7 @@ class Arguments
 			false
 		end
 
-		#:nodoc:
+		# :nodoc:
 		def ==(rhs)
 
 			return false if rhs.nil?
@@ -114,16 +114,16 @@ class Arguments
 			eql? rhs
 		end
 
-		#:nodoc:
+		# :nodoc:
 		def hash
 
 			@arg.hash
 		end
 	end
 
-	class OptionArgument #:nodoc: all
+	class OptionArgument # :nodoc: all
 
-		#:nodoc:
+		# :nodoc:
 		def initialize(arg, given_index, given_name, resolved_name, argument_alias, given_hyphens, given_label, value, extras)
 
 			@arg			=	arg
@@ -146,7 +146,7 @@ class Arguments
 		attr_reader :value
 		attr_reader :extras
 
-		#:nodoc:
+		# :nodoc:
 		def eql?(rhs)
 
 			return false if rhs.nil?
@@ -157,7 +157,7 @@ class Arguments
 			false
 		end
 
-		#:nodoc:
+		# :nodoc:
 		def ==(rhs)
 
 			return false if rhs.nil?
@@ -168,13 +168,13 @@ class Arguments
 			eql? rhs
 		end
 
-		#:nodoc:
+		# :nodoc:
 		def hash
 
 			@arg.hash
 		end
 
-		#:nodoc:
+		# :nodoc:
 		def to_s
 
 			"#{name}=#{value}"
@@ -194,15 +194,31 @@ class Arguments
 	#
 	# === Signature
 	#
-	# * *Parameters*:
-	#   - +argv+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
-	#   - +source+:: (+Hash+, +IO+) The arguments specification, either as a Hash or an instance of an IO-implementing type containing a YAML specification.
-	#   - +options+:: An options hash, containing any of the following options.
+	# * *Parameters:*
+	#   - +argv+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+
+	#   - +source+:: (+Hash+, +IO+) The arguments specification, either as a Hash or an instance of an IO-implementing type containing a YAML specification
+	#   - +options+:: An options hash, containing any of the following options
 	#
-	# * *Options*:
-	#   - +mutate_argv:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>.
+	# * *Options:*
+	#   - +mutate_argv:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>
 	#
-	def self.load(argv, source, options = {})
+	def self.load(argv, source, options = {}) # :yields: An instance of +CLASP::Arguments+
+
+		options ||= {}
+
+		specs = load_specifications(source, options)
+
+		self.new argv, specs, options
+	end
+
+	# Loads the specifications as specified by +source+, according to the given parameters
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +source+:: (+Hash+, +IO+) The arguments specification, either as a Hash or an instance of an IO-implementing type containing a YAML specification
+	#   - +options+:: An options hash, containing any of the following options
+	def self.load_specifications(source, options = {}) # :yields: An array of specification instances
 
 		options ||= {}
 
@@ -226,7 +242,7 @@ class Arguments
 			end
 		end
 
-		specifications	=	[]
+		specs	=	[]
 
 		_clasp	=	h['clasp'] or raise ArgumentError, "missing top-level 'clasp' element in load configuration"
 		::Hash === _clasp or raise ArgumentError, "top-level 'clasp' element must be a #{::Hash}"
@@ -257,7 +273,7 @@ class Arguments
 							_aliases	=	_details['aliases']
 							_help		=	_details['help'] || _details['description']
 
-							specifications << CLASP.Flag(_name, alias: _alias, aliases: _aliases, help: _help)
+							specs << CLASP.Flag(_name, alias: _alias, aliases: _aliases, help: _help)
 						end
 					when 'option', :option
 
@@ -276,7 +292,7 @@ class Arguments
 							_required_message	=	_details['required_message']
 							_values_range		=	_details['values_range'] || _details['values']
 
-							specifications << CLASP.Option(_name, alias: _alias, aliases: _aliases, default_value: _default_value, help: _help, required: _required, required_message: _required_message, values_range: _values_range)
+							specs << CLASP.Option(_name, alias: _alias, aliases: _aliases, default_value: _default_value, help: _help, required: _required, required_message: _required_message, values_range: _values_range)
 						end
 					when 'alias', :alias
 
@@ -295,7 +311,7 @@ class Arguments
 								warn "alias specification missing required 'alias' or 'aliases' field"
 							else
 
-								specifications << CLASP.Flag(_resolved, alias: _alias, aliases: _aliases)
+								specs << CLASP.Flag(_resolved, alias: _alias, aliases: _aliases)
 							end
 						end
 					else
@@ -309,7 +325,7 @@ class Arguments
 			end
 		end
 
-		self.new argv, specifications, options
+		specs
 	end
 
 	# Constructs an instance of the class, according to the given parameters
@@ -318,13 +334,13 @@ class Arguments
 	#
 	# === Signature
 	#
-	# * *Parameters*:
-	#   - +argv+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
-	#   - +specifications+:: (+Array+) The specifications array. Defaults to +nil+. If none supplied, no aliasing will be performed.
-	#   - +options+:: An options hash, containing any of the following options.
+	# * *Parameters:*
+	#   - +argv+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+
+	#   - +specifications+:: (+Array+) The specifications array. Defaults to +nil+. If none supplied, no aliasing will be performed
+	#   - +options+:: An options hash, containing any of the following options
 	#
-	# * *Options*:
-	#   - +mutate_argv:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>.
+	# * *Options:*
+	#   - +mutate_argv:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>
 	#
 	def initialize(argv = ARGV, specifications = nil, options = {})
 
@@ -598,7 +614,7 @@ class Arguments
 	#
 	# === Signature
 	#
-	# * *Parameters*:
+	# * *Parameters:*
 	#  - +id+:: (String, CLASP::Flag) The name of a flag, or the flag itself
 	def find_flag(id)
 
@@ -615,7 +631,7 @@ class Arguments
 	#
 	# === Signature
 	#
-	# * *Parameters*:
+	# * *Parameter:*
 	#  - +id+:: (String, CLASP::Flag) The name of a option, or the option itself
 	def find_option(id)
 

data/lib/clasp/cli.rb

@@ -5,7 +5,7 @@
 # Purpose:      Command-line interface
 #
 # Created:      27th July 2015
-# Updated:      11th April 2019
+# Updated:      12th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -113,11 +113,11 @@ end # module CLI_helpers_
 #
 # === Signature
 #
-# * *Parameters*:
+# * *Parameters:*
 #   - +specifications+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
 #   - +options+:: An options hash, containing any of the following options.
 #
-# * *Options*:
+# * *Options:*
 #   - +:exit+::                                 a program exit code; <tt>exit()</tt> not called if not specified (or +nil+).
 #   - +:program_name+::                         program name; inferred from <tt>$0</tt> if not specified.
 #   - +:stream+::                               output stream; <tt>$stdout</tt> if not specified.
@@ -254,11 +254,11 @@ end
 #
 # === Signature
 #
-# * *Parameters*:
+# * *Parameters:*
 #   - +specifications+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
 #   - +options+:: An options hash, containing any of the following options.
 #
-# * *Options*:
+# * *Options:*
 #   - +:exit+::                 a program exit code; <tt>exit()</tt> not called if not specified (or +nil+).
 #   - +:program_name+::         program name; inferred from <tt>$0</tt> if not specified.
 #   - +:stream+::               output stream; <tt>$stdout</tt> if not specified.

data/lib/clasp/specifications.rb

@@ -5,7 +5,7 @@
 # Purpose:      Argument specification classes
 #
 # Created:      25th October 2014
-# Updated:      10th April 2019
+# Updated:      13th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -65,10 +65,10 @@ class FlagSpecification
 	# === Signature
 	#
 	# * *Parameters*
-	#   - +name+:: (+String+) The name, or long-form, of the flag.
-	#   - +aliases+:: (+Array+) 0 or more strings specifying short-form or option-value aliases.
-	#   - +help+:: (+String+) The help string, which may be +nil+.
-	#   - +extras+:: An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+.
+	#   - +name+:: (+String+) The name, or long-form, of the flag
+	#   - +aliases+:: (+Array+) 0 or more strings specifying short-form or option-value aliases
+	#   - +help+:: (+String+) The help string, which may be +nil+
+	#   - +extras+:: An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+
 	def initialize(name, aliases, help, extras = nil)
 
 		@name			=	name
@@ -92,6 +92,41 @@ class FlagSpecification
 		"{#{name}; aliases=#{aliases.join(', ')}; help='#{help}'; extras=#{extras}}"
 	end
 
+	def eql? rhs # :nodoc:
+
+		case rhs
+		when self.class
+
+			;
+		else
+
+			return false
+		end
+
+		return false unless name == rhs.name
+		return false unless aliases == rhs.aliases
+		return false unless help == rhs.help
+		return false unless extras == rhs.extras
+
+		return true
+	end
+
+	# Compares instance against another FlagSpecification or against a name (String)
+	def == rhs
+
+		case rhs
+		when self.class
+
+			return self.eql? rhs
+		when String
+
+			return name == rhs
+		else
+
+			false
+		end
+	end
+
   private
 	@@Help_		=	self.new('--help', [], 'shows this help and terminates')
 	@@Version_	=	self.new('--version', [], 'shows version and terminates')
@@ -126,11 +161,11 @@ class OptionSpecification
 	# === Signature
 	#
 	# * *Parameters*
-	#   - +name+:: (+String+) The name, or long-form, of the option.
-	#   - +aliases+:: (+Array+) 0 or more strings specifying short-form or option-value aliases.
-	#   - +help+:: (+String+) The help string, which may be +nil+.
-	#   - +values_range+:: (+Array+) 0 or more strings specifying values supported by the option.
-	#   - +default_value+:: (+String+) The default value of the option. May be +nil+.
+	#   - +name+:: (+String+) The name, or long-form, of the option
+	#   - +aliases+:: (+Array+) 0 or more strings specifying short-form or option-value aliases
+	#   - +help+:: (+String+) The help string, which may be +nil+
+	#   - +values_range+:: (+Array+) 0 or more strings specifying values supported by the option
+	#   - +default_value+:: (+String+) The default value of the option. May be +nil+
 	#   - +required+:: [boolean] Whether the option is required. May be
 	#     +nil+
 	#   - +required_message+:: [::String] Message to be used when reporting
@@ -139,7 +174,7 @@ class OptionSpecification
 	#     usage". If begins with the nul character ("\0"), then is used in
 	#     the place of the <option-name> and placed into the rest of the
 	#     standard form message
-	#   - +extras+:: An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+.
+	#   - +extras+:: An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+
 	def initialize(name, aliases, help, values_range, default_value, required, required_message, extras = nil)
 
 		@name				=	name
@@ -195,6 +230,45 @@ class OptionSpecification
 
 		"{#{name}; aliases=#{aliases.join(', ')}; values_range=[ #{values_range.join(', ')} ]; default_value='#{default_value}'; help='#{help}'; required?=#{required?}; extras=#{extras}}"
 	end
+
+	def eql? rhs # :nodoc:
+
+		case rhs
+		when self.class
+
+			;
+		else
+
+			return false
+		end
+
+		return false unless name == rhs.name
+		return false unless aliases == rhs.aliases
+		return false unless help == rhs.help
+		return false unless values_range == rhs.values_range
+		return false unless default_value == rhs.default_value
+		return false unless required == rhs.required
+		return false unless required_message == rhs.required_message
+		return false unless extras == rhs.extras
+
+		return true
+	end
+
+	# Compares instance against another OptionSpecification or against a name (String)
+	def == rhs
+
+		case rhs
+		when self.class
+
+			return self.eql? rhs
+		when String
+
+			return name == rhs
+		else
+
+			false
+		end
+	end
 end
 
 # A class that represents an explicit alias for a flag or an option

data/lib/clasp/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for CLASP.Ruby library
 #
 # Created:      16th November 2014
-# Updated:      12th April 2019
+# Updated:      13th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -51,7 +51,7 @@
 module CLASP
 
 	# Current version of the CLASP.Ruby library
-	VERSION				=	'0.18.2'
+	VERSION				=	'0.19.0'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_option_value_aliases.rb

@@ -0,0 +1,74 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_OptionValueAliases_1 < Test::Unit::TestCase
+
+	def test_option_with_two_flag_specifications
+
+		specifications	=	[
+
+			CLASP.Flag('--action=list', alias: '-l'),
+            CLASP.Flag('--action=change', alias: '-c'),
+			CLASP.Option('--action', alias: '-a'),
+		]
+
+		# With no arguments
+		begin
+
+			argv = []
+			args = CLASP::Arguments.new argv, specifications
+
+			assert_equal 0, args.flags.size
+			assert_equal 0, args.options.size
+			assert_equal 0, args.values.size
+		end
+
+		# With option
+		begin
+
+			argv = %w{ --action=action1 }
+			args = CLASP::Arguments.new argv, specifications
+
+			assert_equal 0, args.flags.size
+			assert_equal 1, args.options.size
+			assert_equal 0, args.values.size
+
+			assert_equal '--action', args.options[0].name
+			assert_equal 'action1', args.options[0].value
+		end
+
+		# With option alias
+		begin
+
+			argv = %w{ -a action2 }
+			args = CLASP::Arguments.new argv, specifications
+
+			assert_equal 0, args.flags.size
+			assert_equal 1, args.options.size
+			assert_equal 0, args.values.size
+
+			assert_equal '--action', args.options[0].name
+			assert_equal 'action2', args.options[0].value
+		end
+
+		# With flag alias
+		begin
+
+			argv = %w{ -c }
+			args = CLASP::Arguments.new argv, specifications
+
+			assert_equal 0, args.flags.size
+			assert_equal 1, args.options.size
+			assert_equal 0, args.values.size
+
+			assert_equal '--action', args.options[0].name
+			assert_equal 'change', args.options[0].value
+		end
+	end
+end
+

data/test/unit/tc_specifications.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 
@@ -8,68 +8,15 @@ require 'test/unit'
 
 class Test_Specifications_1 < Test::Unit::TestCase
 
-	def test_option_with_two_flag_specifications
+	def test_simple_Flag
 
-		specifications	=	[
-
-			CLASP.Flag('--action=list', alias: '-l'),
-            CLASP.Flag('--action=change', alias: '-c'),
-			CLASP.Option('--action', alias: '-a'),
-		]
-
-		# With no arguments
-		begin
-
-			argv = []
-			args = CLASP::Arguments.new argv, specifications
-
-			assert_equal 0, args.flags.size
-			assert_equal 0, args.options.size
-			assert_equal 0, args.values.size
-		end
-
-		# With option
-		begin
-
-			argv = %w{ --action=action1 }
-			args = CLASP::Arguments.new argv, specifications
-
-			assert_equal 0, args.flags.size
-			assert_equal 1, args.options.size
-			assert_equal 0, args.values.size
-
-			assert_equal '--action', args.options[0].name
-			assert_equal 'action1', args.options[0].value
-		end
-
-		# With option alias
-		begin
-
-			argv = %w{ -a action2 }
-			args = CLASP::Arguments.new argv, specifications
-
-			assert_equal 0, args.flags.size
-			assert_equal 1, args.options.size
-			assert_equal 0, args.values.size
-
-			assert_equal '--action', args.options[0].name
-			assert_equal 'action2', args.options[0].value
-		end
-
-		# With flag alias
-		begin
-
-			argv = %w{ -c }
-			args = CLASP::Arguments.new argv, specifications
-
-			assert_equal 0, args.flags.size
-			assert_equal 1, args.options.size
-			assert_equal 0, args.values.size
-
-			assert_equal '--action', args.options[0].name
-			assert_equal 'change', args.options[0].value
-		end
+		flag_debug	=	CLASP.Flag('--name')
+		flag_logged	=	CLASP.Flag('--logged')
 
+		assert_equal flag_debug, flag_debug
+		assert_equal flag_debug, '--name'
+		assert_not_equal flag_logged, flag_debug
 	end
 end
 
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -64,6 +64,7 @@ files:
 - test/unit/tc_examples_Arguments.rb
 - test/unit/tc_extras.rb
 - test/unit/tc_option_required.rb
+- test/unit/tc_option_value_aliases.rb
 - test/unit/tc_specifications.rb
 - test/unit/tc_usage.rb
 - test/unit/ts_all.rb