clasp-ruby 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 476b60beb87db0936ad2bf1d5562cd68d2ba41fe
-  data.tar.gz: ce781faefb3d24a1d431b48337fea7c1ebf2a0fb
+  metadata.gz: 119fcad10a9c01d575d47bc9f495fda5bb1869d1
+  data.tar.gz: 3a4c4edbf579ce92c968833ba2f13a857a7f69dd
 SHA512:
-  metadata.gz: 95926ccb787ca5b0dd1d6920783d103e0e4bf91b21c14763e9ae4c62ef872718fe41fd868c2e1d3fc7a5b764da5e831b02d73d0794486a3acabaa82edf2cf11f
-  data.tar.gz: e335964cf459fab293d7b9a790d7c66f34572844e8c5b544b0733283c5b37436ece225ddc5e845609dc422f7eb37ac90e928f59ad838bbdec29d7841e67e6e3d
+  metadata.gz: e7aa695f6ef62302ac3fb64a815017e8f256130c29abcbf9b81aeb82f378cd4233f8435b0355acc91d2c24c35107809c6fa9fbcfb171f28c50b5ed5aa3018277
+  data.tar.gz: f0347ac65f0a4ba087c486ba2d5492890fd3f69240e547c1c3b7371d59c5c178417179fa86592a786b9816bc5b296af17bc23a23adba5d3ff85830c473751d66

data/README.md

@@ -96,7 +96,7 @@ like the following:
 
 PROGRAM_VERSION = '0.1.2'
 
-Aliases = [
+Specifications = [
 
 	CLASP.Flag('--all', alias: '-a', help: 'processes all item types'),
 	CLASP.Flag('-c', help: 'count the processed items'),
@@ -109,7 +109,7 @@ Aliases = [
 ]
 
 # assuming the command-line `myprog -acv infile outfile`
-Args = CLASP::Arguments.new(ARGV, Aliases)
+Args = CLASP::Arguments.new(ARGV, Specifications)
 
 puts Args.flags.size                # => 2
 puts Args.flags[0].name             # => "--all"
@@ -136,10 +136,10 @@ Args.flags.each do |f|
 	case f.name
 	when CLASP::Flag.Help.name
 
-		CLASP.show_usage(Aliases, exit: 0, values: '<input-file> <output-file>')
+		CLASP.show_usage(Specifications, exit: 0, values: '<input-file> <output-file>')
 	when CLASP::Flag.Version.name
 
-		CLASP.show_version(Aliases, exit: 0, version: PROGRAM_VERSION)
+		CLASP.show_version(Specifications, exit: 0, version: PROGRAM_VERSION)
 	when '--all'
 
 		# do something appropriate to `--all`

data/examples/cr-example.rb

@@ -18,7 +18,7 @@ require 'clasp'
 
 PROGRAM_VERSION = '0.1.2'
 
-Aliases = [
+Specifications = [
 
 	CLASP.Flag('--all', alias: '-a', help: 'processes all item types'),
 	CLASP.Flag('-c', help: 'count the processed items'),
@@ -30,17 +30,17 @@ Aliases = [
 	CLASP::Flag.Version,
 ]
 
-Args = CLASP::Arguments.new(ARGV, Aliases)
+Args = CLASP::Arguments.new(ARGV, Specifications)
 
 Args.flags.each do |f|
 
 	case f.name
 	when CLASP::Flag.Help.name
 
-		CLASP.show_usage(Aliases, exit: 0, values: '<input-file> <output-file>')
+		CLASP.show_usage(Specifications, exit: 0, values: '<input-file> <output-file>')
 	when CLASP::Flag.Version.name
 
-		CLASP.show_version(Aliases, exit: 0, version: PROGRAM_VERSION)
+		CLASP.show_version(Specifications, exit: 0, version: PROGRAM_VERSION)
 	when '--all'
 
 		;

data/examples/flag_and_option_aliases.md

@@ -33,26 +33,26 @@ Flag_Debug = CLASP.Flag('--debug', alias: '-d', help: 'runs in Debug mode')
 Option_Verbosity = CLASP.Option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ])
 Flag_Chatty = CLASP.Flag('--verbosity=chatty', alias: '-c')
 
-Aliases = [
+Specifications = [
 
 	Flag_Debug,
 	Option_Verbosity,
 	Flag_Chatty,
 
-    CLASP::FlagAlias.Help,
-    CLASP::FlagAlias.Version,
+    CLASP::FlagSpecification.Help,
+    CLASP::FlagSpecification.Version,
 ]
 
-args = CLASP::Arguments.new ARGV, Aliases
+args = CLASP::Arguments.new ARGV, Specifications
 
-if args.flags.include?(CLASP::FlagAlias.Help)
+if args.flags.include?(CLASP::FlagSpecification.Help)
 
-    CLASP.show_usage(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
+    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
 end
 
 if args.flags.include?('--version')
 
-    CLASP.show_version(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout)
+    CLASP.show_version(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout)
 end
 
 

data/examples/flag_and_option_aliases.rb

@@ -24,26 +24,26 @@ Flag_Debug = CLASP.Flag('--debug', alias: '-d', help: 'runs in Debug mode')
 Option_Verbosity = CLASP.Option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ])
 Flag_Chatty = CLASP.Flag('--verbosity=chatty', alias: '-c')
 
-Aliases = [
+Specifications = [
 
 	Flag_Debug,
 	Option_Verbosity,
 	Flag_Chatty,
 
-    CLASP::FlagAlias.Help,
-    CLASP::FlagAlias.Version,
+    CLASP::FlagSpecification.Help,
+    CLASP::FlagSpecification.Version,
 ]
 
-args = CLASP::Arguments.new ARGV, Aliases
+args = CLASP::Arguments.new ARGV, Specifications
 
-if args.flags.include?(CLASP::FlagAlias.Help)
+if args.flags.include?(CLASP::FlagSpecification.Help)
 
-    CLASP.show_usage(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
+    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
 end
 
 if args.flags.include?('--version')
 
-    CLASP.show_version(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout)
+    CLASP.show_version(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout)
 end
 
 

data/examples/show_usage_and_version.md

@@ -29,22 +29,22 @@ InfoLines = [
 
 # Specify aliases, parse, and checking standard flags
 
-Aliases = [
+Specifications = [
 
-    CLASP::FlagAlias.Help,
-    CLASP::FlagAlias.Version,
+    CLASP::FlagSpecification.Help,
+    CLASP::FlagSpecification.Version,
 ]
 
-args = CLASP::Arguments.new ARGV, Aliases
+args = CLASP::Arguments.new ARGV, Specifications
 
 if args.flags.include?('--help')
 
-    CLASP.show_usage(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
+    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
 end
 
 if args.flags.include?('--version')
 
-    CLASP.show_version(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout)
+    CLASP.show_version(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout)
 end
 
 

data/examples/show_usage_and_version.rb

@@ -20,22 +20,22 @@ InfoLines = [
 
 # Specify aliases, parse, and checking standard flags
 
-Aliases = [
+Specifications = [
 
-    CLASP::FlagAlias.Help,
-    CLASP::FlagAlias.Version,
+    CLASP::FlagSpecification.Help,
+    CLASP::FlagSpecification.Version,
 ]
 
-args = CLASP::Arguments.new ARGV, Aliases
+args = CLASP::Arguments.new ARGV, Specifications
 
 if args.flags.include?('--help')
 
-    CLASP.show_usage(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
+    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
 end
 
 if args.flags.include?('--version')
 
-    CLASP.show_version(Aliases, exit_code: 0, version: ProgramVersion, stream: $stdout)
+    CLASP.show_version(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout)
 end
 
 

data/lib/clasp/aliases.rb

@@ -2,7 +2,7 @@
 # ######################################################################## #
 # File:         clasp/aliases.rb
 #
-# Purpose:      Alias classes
+# Purpose:      Argument specification classes
 #
 # Created:      25th October 2014
 # Updated:      10th April 2019
@@ -58,9 +58,9 @@ module CLASP
 # classes
 
 # A class that represents the specification for a command-line flag
-class FlagAlias
+class FlagSpecification
 
-	# Creates a FlagAlias instance from the given name, aliases, and help
+	# Creates a FlagSpecification instance from the given name, aliases, and help
 	#
 	# === Signature
 	#
@@ -96,7 +96,7 @@ class FlagAlias
 	@@Help_		=	self.new('--help', [], 'shows this help and terminates')
 	@@Version_	=	self.new('--version', [], 'shows version and terminates')
   public
-	# An instance of FlagAlias that provides default '--help' information
+	# An instance of FlagSpecification that provides default '--help' information
 	def self.Help(extras = nil)
 
 		h = @@Help_
@@ -106,7 +106,7 @@ class FlagAlias
 		h
 	end
 
-	# An instance of FlagAlias that provides default '--version' information
+	# An instance of FlagSpecification that provides default '--version' information
 	def self.Version(extras = nil)
 
 		h = @@Version_
@@ -118,9 +118,9 @@ class FlagAlias
 end
 
 # A class that represents the specification for a command-line option
-class OptionAlias
+class OptionSpecification
 
-	# Creates an OptionAlias instance from the given name, aliases, help,
+	# Creates an OptionSpecification instance from the given name, aliases, help,
 	# values_range, and default_value
 	#
 	# === Signature
@@ -198,7 +198,7 @@ class OptionAlias
 end
 
 # A class that represents an explicit alias for a flag or an option
-class Alias
+class Specification
 
 	def initialize(name, aliases)
 
@@ -227,7 +227,7 @@ end
 # ######################################################################## #
 # functions
 
-# Generator method that obtains a CLASP::FlagAlias according to the given
+# Generator method that obtains a CLASP::FlagSpecification according to the given
 # parameters
 #
 # === Signature
@@ -277,10 +277,10 @@ def CLASP.Flag(name, options = {})
 		end
 	end
 
-	CLASP::FlagAlias.new(name, aliases, help, extras)
+	CLASP::FlagSpecification.new(name, aliases, help, extras)
 end
 
-# Generator method that obtains a CLASP::OptionAlias according to the given
+# Generator method that obtains a CLASP::OptionSpecification according to the given
 # parameters
 #
 # === Signature
@@ -360,7 +360,7 @@ def CLASP.Option(name, options = {})
 		end
 	end
 
-	CLASP::OptionAlias.new(name, aliases, help, values_range, default_value, required, require_message, extras)
+	CLASP::OptionSpecification.new(name, aliases, help, values_range, default_value, required, require_message, extras)
 end
 
 def CLASP.Alias(name, *args)
@@ -379,14 +379,17 @@ def CLASP.Alias(name, *args)
 		aliases	=	args
 	end
 
-	CLASP::Alias.new name, aliases
+	CLASP::Specification.new name, aliases
 end
 
 # ######################################################################## #
 # backwards-compatible
 
-Flag	=	FlagAlias
-Option	=	OptionAlias
+Alias		=	Specification
+Flag		=	FlagSpecification
+FlagAlias	=	FlagSpecification
+Option		=	OptionSpecification
+OptionAlias	=	OptionSpecification
 
 # ######################################################################## #
 # module

data/lib/clasp/arguments.rb

@@ -226,13 +226,13 @@ class Arguments
 			end
 		end
 
-		aliases	=	[]
+		specifications	=	[]
 
 		_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}"
 
-		_specs	=	(_clasp['arg-specs'] || _clasp['aliases']) or raise ArgumentError, "missing element 'clasp/arg-specs'"
-		::Array === _specs or raise ArgumentError, "top-level 'arg-specs' element must be a #{::Hash}"
+		_specs	=	(_clasp['arg-specs'] || _clasp['specifications'] || _clasp['aliases']) or raise ArgumentError, "missing element 'clasp/specifications'"
+		::Array === _specs or raise ArgumentError, "top-level 'specifications' element must be a #{::Hash}"
 
 		_specs.each do |_spec|
 
@@ -250,14 +250,14 @@ class Arguments
 
 						unless _name
 
-							warn "flag arg-spec missing required 'name' field"
+							warn "flag specification missing required 'name' field"
 						else
 
 							_alias		=	_details['alias']
 							_aliases	=	_details['aliases']
 							_help		=	_details['help'] || _details['description']
 
-							aliases	<<	CLASP.Flag(_name, alias: _alias, aliases: _aliases, help: _help)
+							specifications << CLASP.Flag(_name, alias: _alias, aliases: _aliases, help: _help)
 						end
 					when 'option', :option
 
@@ -265,7 +265,7 @@ class Arguments
 
 						unless _name
 
-							warn "option arg-spec missing required 'name' field"
+							warn "option specification missing required 'name' field"
 						else
 
 							_alias				=	_details['alias']
@@ -276,7 +276,7 @@ class Arguments
 							_required_message	=	_details['required_message']
 							_values_range		=	_details['values_range'] || _details['values']
 
-							aliases	<<	CLASP.Option(_name, alias: _alias, aliases: _aliases, default_value: _default_value, help: _help, required: _required, required_message: _required_message, values_range: _values_range)
+							specifications << 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
 
@@ -284,7 +284,7 @@ class Arguments
 
 						unless _resolved
 
-							warn "alias arg-spec missing required 'resolved' field"
+							warn "alias specification missing required 'resolved' field"
 						else
 
 							_alias				=	_details['alias']
@@ -292,10 +292,10 @@ class Arguments
 
 							unless _alias || _aliases
 
-								warn "alias arg-spec missing required 'alias' or 'aliases' field"
+								warn "alias specification missing required 'alias' or 'aliases' field"
 							else
 
-								aliases << CLASP.Flag(_resolved, alias: _alias, aliases: _aliases)
+								specifications << CLASP.Flag(_resolved, alias: _alias, aliases: _aliases)
 							end
 						end
 					else
@@ -305,11 +305,11 @@ class Arguments
 				end
 			else
 
-				warn "non-#{::Hash} element in 'clasp/arg-specs': #{_spec} (of type #{_spec.class})"
+				warn "non-#{::Hash} element in 'clasp/specifications': #{_spec} (of type #{_spec.class})"
 			end
 		end
 
-		self.new argv, aliases, options
+		self.new argv, specifications, options
 	end
 
 	# Constructs an instance of the class, according to the given parameters
@@ -320,13 +320,13 @@ class Arguments
 	#
 	# * *Parameters*:
 	#   - +argv+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
-	#   - +aliases+:: (+Array+) The aliases array. Defaults to +nil+. If none supplied, no aliasing will be performed.
+	#   - +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>.
 	#
-	def initialize(argv = ARGV, aliases = nil, options = {})
+	def initialize(argv = ARGV, specifications = nil, options = {})
 
 		# have to do this name-swap, as 'options' has CLASP-specific
 		# meaning
@@ -340,11 +340,11 @@ class Arguments
 		argv				=	argv.dup
 		@argv_original_copy	=	argv.dup.freeze
 
-		@aliases	=	aliases
+		@specifications		=	specifications
 
-		aliases		=	nil if aliases and aliases.empty?
+		specifications		=	nil if specifications and specifications.empty?
 
-		flags, options, values = Arguments.parse(argv, aliases)
+		flags, options, values = Arguments.parse(argv, specifications)
 
 		[ flags, options, values ].each do |ar|
 
@@ -403,7 +403,7 @@ class Arguments
 		$0
 	end
 
-	def self.parse(argv, aliases)
+	def self.parse(argv, specifications)
 
 		flags	=	[]
 		options	=	[]
@@ -433,7 +433,7 @@ class Arguments
 					argument_alias	=	nil
 					resolved_name	=	nil
 
-					(aliases || []).each do |a|
+					(specifications || []).each do |a|
 
 						if a.name == given_name or a.aliases.include? given_name
 
@@ -454,7 +454,7 @@ class Arguments
 					end
 
 					# Here we intercept and (potentially) cater to grouped flags
-					if not argument_alias and not value and aliases and 1 == hyphens.size
+					if not argument_alias and not value and specifications and 1 == hyphens.size
 
 						# Must match all
 						flag_aliases = []
@@ -465,10 +465,10 @@ class Arguments
 							flag_alias	=	nil
 
 							# special case where the flag's actual name is short form and found here
-							flag_alias	||=	aliases.detect { |a| a.is_a?(CLASP::FlagAlias) && a.name == new_flag }
+							flag_alias	||=	specifications.detect { |a| a.is_a?(CLASP::FlagSpecification) && a.name == new_flag }
 
-							# if not found as a flag, look in each aliases' aliases
-							flag_alias	||=	aliases.detect { |a| a.aliases.include? new_flag }
+							# if not found as a flag, look in each specifications' aliases
+							flag_alias	||=	specifications.detect { |a| a.aliases.include? new_flag }
 
 							if not flag_alias
 
@@ -489,7 +489,7 @@ class Arguments
 							# convert to argv and invoke
 							flags_argv = flag_aliases.map { |a| a.name }
 
-							grp_flags, grp_options, grp_value = Arguments.parse flags_argv, aliases
+							grp_flags, grp_options, grp_value = Arguments.parse flags_argv, specifications
 
 							grp_flags.map! { |f| FlagArgument.new(arg, index, given_name, f.name, f.argument_alias, hyphens.size, given_label, argument_alias ? argument_alias.extras : nil) }
 							grp_options.map! { |o| OptionArgument.new(arg, index, given_name, o.name, o.argument_alias, hyphens.size, given_label, o.value, argument_alias ? argument_alias.extras : nil) }
@@ -502,7 +502,7 @@ class Arguments
 						end
 					end
 
-					if argument_alias and argument_alias.is_a? CLASP::OptionAlias and not value
+					if argument_alias and argument_alias.is_a? CLASP::OptionSpecification and not value
 
 						want_option_value = true
 						options << OptionArgument.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, nil, argument_alias ? argument_alias.extras : nil)
@@ -544,8 +544,11 @@ class Arguments
 	# Attributes
 
 	public
-	# an immutable array of aliases
-	attr_reader :aliases
+	# an immutable array of specifications
+	attr_reader :specifications
+
+	# [DEPRECATED] Instead refer to +specifications+
+	def aliases; @specifications; end
 
 	# an immutable array of flags
 	attr_reader :flags
@@ -572,18 +575,18 @@ class Arguments
 
 		raise ArgumentError, "options must be nil or Hash - #{option.class} given" unless options.is_a? ::Hash
 
-		aliases	=	options[:aliases] || @aliases
+		specifications	=	options[:aliases] || @specifications
 
-		raise ArgumentError, "aliases may not be nil" if aliases.nil?
+		raise ArgumentError, "specifications may not be nil" if specifications.nil?
 
 		flags.each do |f|
 
-			return f unless aliases.any? { |al| al.is_a?(::CLASP::FlagAlias) && al.name == f.name }
+			return f unless specifications.any? { |al| al.is_a?(::CLASP::FlagSpecification) && al.name == f.name }
 		end
 
 		self.options.each do |o|
 
-			return o unless aliases.any? { |al| al.is_a?(::CLASP::OptionAlias) && al.name == o.name }
+			return o unless specifications.any? { |al| al.is_a?(::CLASP::OptionSpecification) && al.name == o.name }
 		end
 
 		nil

data/lib/clasp/cli.rb

@@ -5,7 +5,7 @@
 # Purpose:      Command-line interface
 #
 # Created:      27th July 2015
-# Updated:      19th March 2019
+# Updated:      10th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -64,7 +64,7 @@ module CLI_helpers_
 
 	module Constants
 
-		VALID_ALIAS_TYPES			=	[ FlagAlias, OptionAlias, Alias ]
+		VALID_ALIAS_TYPES			=	[ FlagSpecification, OptionSpecification, Specification ]
 		VALID_ALIAS_TYPES_STRING	=	VALID_ALIAS_TYPES[0...-1].join(', ') + ', or ' + VALID_ALIAS_TYPES[-1].to_s
 	end # module Constants
 
@@ -109,12 +109,12 @@ end # module CLI_helpers_
 
 # :startdoc:
 
-# Displays usage for the program according to the given aliases and options
+# Displays usage for the program according to the given specifications and options
 #
 # === Signature
 #
 # * *Parameters*:
-#   - +aliases+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
+#   - +specifications+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
 #   - +options+:: An options hash, containing any of the following options.
 #
 # * *Options*:
@@ -125,18 +125,18 @@ end # module CLI_helpers_
 #   - +:values+::                               appends this string to USAGE line if specified.
 #   - +:flags_and_options+::                    inserts a custom string instead of the default string <tt>'[ ... flags and options ... ]'</tt>.
 #   - +:info_lines+::                           inserts 0+ information lines prior to the usage.
-def self.show_usage aliases, options={}
+def self.show_usage specifications, options={}
 
 	options	||=	{}
 
-	raise ArgumentError, "aliases may not be nil" if aliases.nil?
-	raise TypeError, "aliases must be an array or must respond to each, reject and select" unless ::Array === aliases || (aliases.respond_to?(:each) && aliases.respond_to?(:reject) && aliases.respond_to?(:select))
+	raise ArgumentError, "specifications may not be nil" if specifications.nil?
+	raise TypeError, "specifications must be an array or must respond to each, reject and select" unless ::Array === specifications || (specifications.respond_to?(:each) && specifications.respond_to?(:reject) && specifications.respond_to?(:select))
 
 	constants		=	CLI_helpers_::Constants
-	aliases.each { |a| raise ::TypeError, "each element in aliases array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === a } }
+	specifications.each { |a| raise ::TypeError, "each element in specifications array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === a } }
 
 	alias_dups = {}
-	aliases.each { |a| a.aliases.each { |aa| warn "WARNING: alias '#{aa}' is already used for alias '#{a}'" if alias_dups.has_key? aa; alias_dups[aa] = a; } }
+	specifications.each { |a| a.aliases.each { |aa| warn "WARNING: alias '#{aa}' is already used for alias '#{a}'" if alias_dups.has_key? aa; alias_dups[aa] = a; } }
 
 	suppress_blanks	=	options[:suppress_blank_lines_between_options] || ENV['SUPPRESS_BLANK_LINES_BETWEEN_OPTIONS']
 
@@ -173,11 +173,12 @@ def self.show_usage aliases, options={}
 	flags_and_options	=	options[:flags_and_options] || ' [ ... flags and options ... ]'
 	flags_and_options	=	" #{flags_and_options}" if !flags_and_options.empty? && ' ' != flags_and_options[0]
 
-	# sift the aliases to sort out which are value-option aliases (VOAs)
+	# sift the specifications to sort out which are value-option
+	# specifications (VOAs)
 
 	voas			=	{}
 
-	aliases.select { |a| a.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }.each do |a|
+	specifications.select { |a| a.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }.each do |a|
 
 		a.name =~ /^(-+[a-zA-Z0-3_-]+)[=:](.+)$/
 
@@ -187,30 +188,30 @@ def self.show_usage aliases, options={}
 
 	fas				=	{}
 
-	aliases.select { |a| Alias === a }.each do |a|
+	specifications.select { |a| Specification === a }.each do |a|
 
 		fas[a.name]	=	[] unless fas.has_key? $1
 		fas[a.name]	<<	a
 	end
 
-	aliases			=	aliases.reject { |a| a.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }
+	specifications	=	specifications.reject { |a| a.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }
 
 	info_lines.each { |info_line| stream.puts info_line } unless info_lines.empty?
 
 	stream.puts "USAGE: #{program_name}#{flags_and_options}#{values}"
 	stream.puts
 
-	unless aliases.empty?
+	unless specifications.empty?
 
 		stream.puts "flags/options:"
 		stream.puts
-		aliases.each do |a|
+		specifications.each do |a|
 
 			case a
-			when Alias
+			when Specification
 
 				next
-			when FlagAlias
+			when FlagSpecification
 
 				if fas.has_key? a.name
 
@@ -222,7 +223,7 @@ def self.show_usage aliases, options={}
 				a.aliases.each { |al| stream.puts "\t#{al}" }
 				stream.puts "\t#{a.name}"
 				stream.puts "\t\t#{a.help}"
-			when OptionAlias
+			when OptionSpecification
 
 				if voas.has_key? a.name
 
@@ -249,12 +250,12 @@ def self.show_usage aliases, options={}
 	exit exit_code if exit_code
 end
 
-# Displays version for the program according to the given aliases and options
+# Displays version for the program according to the given specifications and options
 #
 # === Signature
 #
 # * *Parameters*:
-#   - +aliases+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
+#   - +specifications+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
 #   - +options+:: An options hash, containing any of the following options.
 #
 # * *Options*:
@@ -267,15 +268,15 @@ end
 #   - +:version_revision+::     a number or string. Only considered if +:version+ is not.
 #   - +:version_build+::        a number or string. Only considered if +:version+ is not.
 #   - +:version_prefix+::       optional string to prefix the version number(s).
-def self.show_version aliases, options = {}
+def self.show_version specifications, options = {}
 
 	options	||=	{}
 
-	raise ArgumentError, "aliases may not be nil" if aliases.nil?
-	raise TypeError, "aliases must be an array or must respond to each, reject and select" unless ::Array === aliases || (aliases.respond_to?(:each) && aliases.respond_to?(:reject) && aliases.respond_to?(:select))
+	raise ArgumentError, "specifications may not be nil" if specifications.nil?
+	raise TypeError, "specifications must be an array or must respond to each, reject and select" unless ::Array === specifications || (specifications.respond_to?(:each) && specifications.respond_to?(:reject) && specifications.respond_to?(:select))
 
 	constants		=	CLI_helpers_::Constants
-	aliases.each { |a| raise ::TypeError, "each element in aliases array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === a } }
+	specifications.each { |a| raise ::TypeError, "each element in specifications array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === a } }
 
 	stream			=	options[:stream] || $stdout
 

data/lib/clasp/version.rb

@@ -51,7 +51,7 @@
 module CLASP
 
 	# Current version of the CLASP.Ruby library
-	VERSION				=	'0.17.0'
+	VERSION				=	'0.18.0'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/scratch/test_aliases.rb

@@ -4,27 +4,27 @@ $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
 
 require 'clasp'
 
-Aliases = [
+Specifications = [
 
 	CLASP.Flag('--help', help: 'shows this help and quits'),
 	CLASP.Flag('--version', alias: '-v', help: 'shows this version and quits'),
-	CLASP.Alias('--version', aliases: [ '-ver', '-V' ]),
+	CLASP.Specification('--version', aliases: [ '-ver', '-V' ]),
 
 	CLASP.Option('--directory', alias: '-d', help: 'a directory within which to process'),
 	CLASP.Option('--patterns', alias: '-p', help: "one or more patterns against which the entries will be matched, separated by '|' or the platform-specific separator - ':' UNIX, ';' Windows"),
 
 	CLASP.Option('--case-sensitive', alias: '-c', help: 'determines whether case sensitive', values_range: %W{ yes no true false }, default_value: false),
-	CLASP.Alias('--case-sensitive=false', alias: '-I'),
+	CLASP.Specification('--case-sensitive=false', alias: '-I'),
 ]
 
-Arguments	=	CLASP::Arguments.new(ARGV, Aliases)
+Arguments	=	CLASP::Arguments.new(ARGV, Specifications)
 Flags		=	Arguments.flags
 Options		=	Arguments.options
 Values		=	Arguments.values
 
 if Flags.include? '--help'
 
-	CLASP.show_usage Aliases, exit: 0
+	CLASP.show_usage Specifications, exit: 0
 end
 
 Flags.each do |f|

data/test/scratch/test_list_command_line.rb

@@ -4,7 +4,7 @@ $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
 
 require 'clasp'
 
-Aliases = [
+Specifications = [
 
 	CLASP.Flag('--help', help: 'shows this help and quits'),
 	CLASP.Flag('--version', alias: '-v', help: 'shows this version and quits'),
@@ -12,7 +12,7 @@ Aliases = [
 	CLASP.Option('--verbosity', aliases: %w{ -V --verbose }),
 ]
 
-Args = CLASP::Arguments.new(ARGV, Aliases)
+Args = CLASP::Arguments.new(ARGV, Specifications)
 
 puts
 puts "flags #{Args.flags.size}:"

data/test/scratch/test_usage.rb

@@ -4,7 +4,7 @@ $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
 
 require 'clasp'
 
-Aliases = [
+Specifications = [
 
 	CLASP.Flag('--version', alias: '-v', help: 'shows the program version and quits'),
 
@@ -14,17 +14,17 @@ Aliases = [
 	CLASP.Flag('--verbosity=verbose', alias: '--verbose'),
 ]
 
-Arguments	=	CLASP::Arguments.new(ARGV, Aliases)
+Arguments	=	CLASP::Arguments.new(ARGV, Specifications)
 
 puts
 puts '*' * 40
 puts 'usage:'
 puts
-CLASP.show_usage(Aliases)
+CLASP.show_usage(Specifications)
 puts '*' * 40
 
 puts 'version:'
 puts
-CLASP.show_version Aliases, version: [ 1, 2, 3 ]
+CLASP.show_version Specifications, version: [ 1, 2, 3 ]
 puts '*' * 40
 

data/test/scratch/test_usage_with_duplicate_aliases.rb

@@ -4,7 +4,7 @@ $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
 
 require 'clasp'
 
-Aliases = [
+Specifications = [
 
 	CLASP.Flag('--version', alias: '-v', help: 'shows the program version and quits'),
 
@@ -14,17 +14,17 @@ Aliases = [
 	CLASP.Flag('--verbosity=verbose', aliases: [ '--verbose', '-v' ]),
 ]
 
-Arguments	=	CLASP::Arguments.new(ARGV, Aliases)
+Arguments	=	CLASP::Arguments.new(ARGV, Specifications)
 
 puts
 puts '*' * 40
 puts 'usage:'
 puts
-CLASP.show_usage(Aliases)
+CLASP.show_usage(Specifications)
 puts '*' * 40
 
 puts 'version:'
 puts
-CLASP.show_version Aliases, version: [ 1, 2, 3 ]
+CLASP.show_version Specifications, version: [ 1, 2, 3 ]
 puts '*' * 40
 

data/test/unit/tc_aliases.rb

@@ -6,7 +6,7 @@ require 'clasp'
 
 require 'test/unit'
 
-class Test_Aliases_1 < Test::Unit::TestCase
+class Test_Specifications_1 < Test::Unit::TestCase
 
 	def test_option_with_two_flag_aliases
 

data/test/unit/tc_cli.rb

@@ -14,9 +14,9 @@ class Test_CLI < Test::Unit::TestCase
 
 	def test_invalid_aliases_types
 
-		assert_raise_with_message(::TypeError, 'each element in aliases array must be one of the types CLASP::FlagAlias, CLASP::OptionAlias, or CLASP::Alias') { CLASP.show_usage([ 'abc', :def ]) }
+		assert_raise_with_message(::TypeError, /each element in (?:aliases|specifications) array must be one of the types CLASP::FlagSpecification, CLASP::OptionSpecification, or CLASP::Specification/) { CLASP.show_usage([ 'abc', :def ]) }
 
-		assert_raise_with_message(::TypeError, 'each element in aliases array must be one of the types CLASP::FlagAlias, CLASP::OptionAlias, or CLASP::Alias') { CLASP.show_version([ 'abc', :def ]) }
+		assert_raise_with_message(::TypeError, /each element in (?:aliases|specifications) array must be one of the types CLASP::FlagSpecification, CLASP::OptionSpecification, or CLASP::Specification/) { CLASP.show_version([ 'abc', :def ]) }
 	end
 end
 

data/test/unit/tc_examples_Arguments.rb

@@ -8,7 +8,7 @@ require 'test/unit'
 
 class Test_Examples < Test::Unit::TestCase
 
-	def test_SimpleCommandLineNoAliases
+	def test_SimpleCommandLineNoSpecifications
 
 		argv = %w{ --show-all=true infile -c outfile }
 
@@ -116,7 +116,7 @@ class Test_Examples < Test::Unit::TestCase
 		assert_equal "outfile", args.values[1]
 	end
 
-	def test_UseOfFlagsAsAliasesForOption
+	def test_UseOfFlagsAsSpecificationsForOption
 
 		aliases = [
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Matt Wilson