clasp-ruby 0.13.3 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c07b382022138ca0b59651dd4c3caed38fede09841da24233f80af67e346f5f8
-  data.tar.gz: 6dfacd4e8c76f6f8f9b0ff589e718dcac35b66d8db9c0d1f8c0fe50938c0bef3
+SHA1:
+  metadata.gz: 3f7f769b1c131cece4a31779001e4ffc049137a7
+  data.tar.gz: 5aada90053e599010596a966403341056ec9d793
 SHA512:
-  metadata.gz: 58c5e616aee6376b8021d603b99e0e0d11c6e6f4a2b8f819756407d8af2757e2db672ff5b710aa830ec043e2df973f84c273e8faefd677c792bc2243c8d02840
-  data.tar.gz: 40ec8642a2a1f516b6864473912182993b9a8b442c8839db0edd92638d66e860bf05c4800f6e8de2447c10c82457a46d7435b99afd343cf91c927645131cb152
+  metadata.gz: 0eb9f3f04abef57af05007a02c9797cc5b628862ea6cecbb350feb4ececcb9026e2f44498bc6fe73f375b296afc89ce45e05cdb1aa395a70cd2d5537a37ea554
+  data.tar.gz: 38e6c9bc1b26ebdeab1559cec077e031404d0b7c48b500c9665bbc9e40a91f97684d445478e71cc1b3da2444ee733b08ce27c38d4ede5f14ed66d11238b0883b

data/README.md

@@ -5,17 +5,29 @@ Command-Line Argument Sorting and Parsing for Ruby
 
 ## Installation & usage
 
-Install using `gem install clasp-ruby` or add it to your `Gemfile`.
+Install via **gem** as in:
+
+```
+	gem install clasp-ruby
+```
+
+or add it to your `Gemfile`.
+
+Use via **require***, as in:
+
+```Ruby
+require 'clasp-ruby'
+```
 
 ## Description
 
-**CLASP** stands for **C**\ommand-**L**\ine **A**\rgument **S**\orting and
-**P**\arsing. The first \CLASP library was a C library with a C++ wrapper. There
+**CLASP** stands for **C**ommand-**L**ine **A**rgument **S**orting and
+**P**arsing. The first CLASP library was a C library with a C++ wrapper. There
 have been several implementations in other languages. **CLASP.Ruby** is the
 Ruby version.
 
-All \CLASP libraries provide the following facilities to **C**\ommand **L**\ine
-**I**\nterface (**CLI**) programs:
+All CLASP libraries provide the following facilities to **C**ommand **L**ine
+**I**nterface (**CLI**) programs:
 
 ### Command-line parsing
 
@@ -27,7 +39,9 @@ All **CLASP** libraries discriminate between three types of command-line argumen
 
 For example, in the command line
 
-	`myprog --all -c --opt1=val1 infile outfile`
+```
+	myprog --all -c --opt1=val1 infile outfile
+```
 
 there are:
 
@@ -37,19 +51,27 @@ there are:
 
 *Flags* and *options* may have alias. If the alias for `--all` is `-a` and the alias for `--opt1` is `-o` then the following command-line is exactly equivalent to the previous one:
 
-	`myprog -a -c -o val1 infile outfile`
+```
+	myprog -a -c -o val1 infile outfile
+```
 
 One-letter *flags* may be combined. Hence, the following command-line is exactly equivalent to the previous ones:
 
-	`myprog -ac -o val1 infile outfile`
+```
+	myprog -ac -o val1 infile outfile
+```
 
 Option aliases may specify a value. If the alias `-v1` means `--opt1=val1` then the following command-line is exactly equivalent to the previous ones:
 
-	`myprog -ac -v1 infile outfile`
+```
+	myprog -ac -v1 infile outfile
+```
 
 Option aliases that are one letter may be combined with one-letter flags. If the alias `-v` means `--opt1=val1` then the following command-line is exactly equivalent to the previous ones:
 
-	`myprog -acv infile outfile`
+```
+	myprog -acv infile outfile
+```
 
 UNIX standard arguments confer specific meanings:
 
@@ -59,7 +81,7 @@ UNIX standard arguments confer specific meanings:
 
 ### Declarative specification of the flags and options for a CLI
 
-To support such above special processing, \CLASP libraries provide facilities
+To support such above special processing, CLASP libraries provide facilities
 for declarative specification of command-line *flags* and *options*, and
 aliases thereof. For the previous example, the **CLASP.Ruby** code would look
 like the following:
@@ -101,7 +123,7 @@ puts Args.values[1]                 # => "outfile"
 
 ### Utility functions for displaying usage and version information
 
-There are aspects common to all CLI programs, such as responding to `--help` and `--version`. All **\CLASP** libraries provide facilities to assist the programmer: **CLASP.Ruby** provides the two module methods CLASP.show_usage() and CLASP.show_version(), as shown in the following code extending the example above:
+There are aspects common to all CLI programs, such as responding to `--help` and `--version`. All **CLASP** libraries provide facilities to assist the programmer: **CLASP.Ruby** provides the two module methods CLASP.show_usage() and CLASP.show_version(), as shown in the following code extending the example above:
 
 ```ruby
 
@@ -124,7 +146,9 @@ Args.flags.each do |f|
 
 Given the command
 
-	`./cr-example.rb --help`
+```
+	./cr-example.rb --help
+```
 
 then the program will output the following
 
@@ -157,7 +181,9 @@ flags/options:
 
 and given the command
 
-	`./cr-example.rb --version`
+```
+	./cr-example.rb --version
+```
 
 then the program will output the following
 
@@ -177,7 +203,7 @@ Defect reports, feature requests, and pull requests are welcome on https://githu
 
 **CLASP.Ruby** is inspired by the [C/C++ CLASP library](https://github.com/synesissoftware/CLASP), which is documented in the articles:
 
- * _An Introduction to \CLASP_, Matthew Wilson, [CVu](http://accu.org/index.php/journals/c77/), January 2012;
+ * _An Introduction to CLASP_, Matthew Wilson, [CVu](http://accu.org/index.php/journals/c77/), January 2012;
  * _[Anatomy of a CLI Program written in C](http://synesis.com.au/publishing/software-anatomies/anatomy-of-a-cli-program-written-in-c.html)_, Matthew Wilson, [CVu](http://accu.org/index.php/journals/c77/), September 2012; and
  * _[Anatomy of a CLI Program written in C++](http://synesis.com.au/publishing/software-anatomies/anatomy-of-a-cli-program-written-in-c++.html)_, Matthew Wilson, [CVu](http://accu.org/index.php/journals/c77/), September 2015.
 

data/lib/clasp/aliases.rb

@@ -5,13 +5,13 @@
 # Purpose:      Alias classes
 #
 # Created:      25th October 2014
-# Updated:      7th February 2018
+# Updated:      14th February 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2014-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -58,9 +58,9 @@ module CLASP
 # classes
 
 # A class that represents the specification for a command-line flag
-class Flag
+class FlagAlias
 
-	# Creates a Flag instance from the given name, aliases, and help
+	# Creates a FlagAlias instance from the given name, aliases, and help
 	#
 	# === Signature
 	#
@@ -96,7 +96,7 @@ class Flag
 	@@Help_		=	self.new('--help', [], 'shows this help and terminates')
 	@@Version_	=	self.new('--version', [], 'shows version and terminates')
   public
-	# An instance of Flag that provides default '--help' information
+	# An instance of FlagAlias that provides default '--help' information
 	def self.Help(extras = nil)
 
 		h = @@Help_
@@ -106,7 +106,7 @@ class Flag
 		h
 	end
 
-	# An instance of Flag that provides default '--version' information
+	# An instance of FlagAlias that provides default '--version' information
 	def self.Version(extras = nil)
 
 		h = @@Version_
@@ -118,9 +118,9 @@ class Flag
 end
 
 # A class that represents the specification for a command-line option
-class Option
+class OptionAlias
 
-	# Creates an Option instance from the given name, aliases, help,
+	# Creates an OptionAlias instance from the given name, aliases, help,
 	# values_range, and default_value
 	#
 	# === Signature
@@ -227,7 +227,7 @@ end
 # ######################################################################## #
 # functions
 
-# Generator method that obtains a CLASP::Flag according to the given
+# Generator method that obtains a CLASP::FlagAlias according to the given
 # parameters
 #
 # === Signature
@@ -277,10 +277,10 @@ def CLASP.Flag(name, options = {})
 		end
 	end
 
-	CLASP::Flag.new(name, aliases, help, extras)
+	CLASP::FlagAlias.new(name, aliases, help, extras)
 end
 
-# Generator method that obtains a CLASP::Option according to the given
+# Generator method that obtains a CLASP::OptionAlias according to the given
 # parameters
 #
 # === Signature
@@ -352,15 +352,15 @@ def CLASP.Option(name, options = {})
 				extras	=	v
 			else
 
-				raise ArgumentError, "invalid option for flag: '#{k}' => '#{v}'"
+				raise ArgumentError, "invalid option for option: '#{k}' => '#{v}'"
 			end
 		else
 
-			raise ArgumentError, "invalid option type for flag: '#{k}' (#{k.class}) => '#{v}'"
+			raise ArgumentError, "invalid option type for option: '#{k}' (#{k.class}) => '#{v}'"
 		end
 	end
 
-	CLASP::Option.new(name, aliases, help, values_range, default_value, required, require_message, extras)
+	CLASP::OptionAlias.new(name, aliases, help, values_range, default_value, required, require_message, extras)
 end
 
 def CLASP.Alias(name, *args)
@@ -382,6 +382,12 @@ def CLASP.Alias(name, *args)
 	CLASP::Alias.new name, aliases
 end
 
+# ######################################################################## #
+# backwards-compatible
+
+Flag	=	FlagAlias
+Option	=	OptionAlias
+
 # ######################################################################## #
 # module
 

data/lib/clasp/arguments.rb

@@ -6,13 +6,13 @@
 #               CLASP.Ruby
 #
 # Created:      14th February 2014
-# Updated:      16th July 2016
+# Updated:      14th February 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2014-2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -46,8 +46,6 @@
 
 
 
-require 'clasp/util/immutable_array'
-
 =begin
 =end
 
@@ -61,7 +59,7 @@ class Arguments
 
 	#:stopdoc:
 	private
-	class Flag #:nodoc: all
+	class FlagArgument #:nodoc: all
 
 		#:nodoc:
 		def initialize(arg, given_index, given_name, resolved_name, argument_alias, given_hyphens, given_label, extras)
@@ -119,7 +117,7 @@ class Arguments
 		end
 	end
 
-	class Option #:nodoc: all
+	class OptionArgument #:nodoc: all
 
 		#:nodoc:
 		def initialize(arg, given_index, given_name, resolved_name, argument_alias, given_hyphens, given_label, value, extras)
@@ -181,23 +179,6 @@ class Arguments
 
 	#:startdoc:
 
-	class ImmutableArray < ::CLASP::Util::ImmutableArray
-
-		def initialize a
-
-			super a
-		end
-
-		# returns truthy if the given flag/option is found or the
-		# given block is truthy
-		def specified? id = nil
-
-			return find(id) { |o| yield o } if block_given?
-
-			find { |item| item == id }
-		end
-	end
-
 	# ######################
 	# Construction
 
@@ -226,7 +207,8 @@ class Arguments
 
 
 		@argv				=	argv
-		@argv_original_copy	=	ImmutableArray.new(argv.dup)
+		argv				=	argv.dup
+		@argv_original_copy	=	argv.dup.freeze
 
 		@aliases	=	aliases
 
@@ -234,9 +216,40 @@ class Arguments
 
 		flags, options, values = Arguments.parse(argv, aliases)
 
-		@flags		=	ImmutableArray.new(flags)
-		@options	=	ImmutableArray.new(options)
-		@values		=	ImmutableArray.new(values)
+		[ flags, options, values ].each do |ar|
+
+			class << ar
+
+				undef :inspect
+				undef :to_s
+
+				def to_s
+
+					s	=	''
+
+					s	+=	'['
+					s	+=	self.map { |v| %Q<"#{v}"> }.join(', ')
+					s	+=	']'
+
+					s
+				end
+
+				def inspect
+
+					s	=	''
+
+					s	+=	"#<#{self.class}:0x#{(object_id << 1).to_s(16)} ["
+					s	+=	self.map { |v| v.inspect }.join(', ')
+					s	+=	"]>"
+
+					s
+				end
+			end
+		end
+
+		@flags		=	flags.freeze
+		@options	=	options.freeze
+		@values		=	values.freeze
 
 
 		# do argv-mutation, if required
@@ -300,6 +313,7 @@ class Arguments
 								resolved_name	=	"#$1#$2"
 								value			||=	$'
 							end
+
 							break
 						end
 					end
@@ -316,7 +330,7 @@ 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::Flag) && a.name == new_flag }
+							flag_alias	||=	aliases.detect { |a| a.is_a?(CLASP::FlagAlias) && 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 }
@@ -342,8 +356,8 @@ class Arguments
 
 							grp_flags, grp_options, grp_value = Arguments.parse flags_argv, aliases
 
-							grp_flags.map! { |f| Flag.new(arg, index, given_name, f.name, f.argument_alias, hyphens.size, given_label, argument_alias ? argument_alias.extras : nil) }
-							grp_options.map! { |o| Option.new(arg, index, given_name, o.name, o.argument_alias, hyphens.size, given_label, o.value, argument_alias ? argument_alias.extras : nil) }
+							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) }
 
 							flags.push(*grp_flags)
 							options.push(*grp_options)
@@ -353,18 +367,18 @@ class Arguments
 						end
 					end
 
-					if argument_alias and argument_alias.is_a? CLASP::Option and not value
+					if argument_alias and argument_alias.is_a? CLASP::OptionAlias and not value
 
 						want_option_value = true
-						options << Option.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, nil, argument_alias ? argument_alias.extras : nil)
+						options << OptionArgument.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, nil, argument_alias ? argument_alias.extras : nil)
 					elsif value
 
 						want_option_value = false
-						options << Option.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, value, argument_alias ? argument_alias.extras : nil)
+						options << OptionArgument.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, value, argument_alias ? argument_alias.extras : nil)
 					else
 
 						want_option_value = false
-						flags << Flag.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, argument_alias ? argument_alias.extras : nil)
+						flags << FlagArgument.new(arg, index, given_name, resolved_name, argument_alias, hyphens.size, given_label, argument_alias ? argument_alias.extras : nil)
 					end
 
 					next
@@ -378,6 +392,11 @@ class Arguments
 				want_option_value = false
 			else
 
+				arg		=	arg.dup
+				arg_ix	=	::Integer === index ? index : index.dup
+
+				arg.define_singleton_method(:given_index) { arg_ix }
+
 				values << arg
 			end
 		end
@@ -422,16 +441,22 @@ class Arguments
 
 		flags.each do |f|
 
-			return f unless aliases.any? { |al| al.is_a?(::CLASP::Flag) && al.name == f.name }
+			return f unless aliases.any? { |al| al.is_a?(::CLASP::FlagAlias) && al.name == f.name }
 		end
 
 		options.each do |o|
 
-			return o unless aliases.any? { |al| al.is_a?(::CLASP::Option) && al.name == o.name }
+			return o unless aliases.any? { |al| al.is_a?(::CLASP::OptionAlias) && al.name == o.name }
 		end
 
 		nil
 	end
+
+	# #################################################################### #
+	# backwards-compatible
+
+	Flag	=	FlagArgument
+	Option	=	OptionArgument
 end
 
 # ######################################################################## #

data/lib/clasp/cli.rb

@@ -5,13 +5,13 @@
 # Purpose:      Command-line interface
 #
 # Created:      27th July 2015
-# Updated:      1st March 2018
+# Updated:      14th February 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -64,7 +64,7 @@ module CLI_helpers_
 
 	module Constants
 
-		VALID_ALIAS_TYPES			=	[ Flag, Option, Alias ]
+		VALID_ALIAS_TYPES			=	[ FlagAlias, OptionAlias, Alias ]
 		VALID_ALIAS_TYPES_STRING	=	VALID_ALIAS_TYPES[0...-1].join(', ') + ', or ' + VALID_ALIAS_TYPES[-1].to_s
 	end # module Constants
 
@@ -146,13 +146,16 @@ def self.show_usage aliases, options={}
 	info_lines		=	options[:info_lines]
 	case info_lines
 	when ::Array
+
 		;
 	when ::NilClass
+
 		info_lines	=	[]
 	else
+
 		info_lines = [ info_lines ] unless [ :each, :empty? ].all? { |m| info_lines.respond_to? m }
 	end
-	info_lines.map! do |line|
+	info_lines		=	info_lines.map do |line|
 
 		case line
 		when :version
@@ -207,7 +210,7 @@ def self.show_usage aliases, options={}
 			when Alias
 
 				next
-			when Flag
+			when FlagAlias
 
 				if fas.has_key? a.name
 
@@ -219,7 +222,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 Option
+			when OptionAlias
 
 				if voas.has_key? a.name
 

data/lib/clasp/doc_.rb

@@ -5,13 +5,13 @@
 # Purpose:      Documentation of the CLASP.Ruby modules
 #
 # Created:      11th June 2016
-# Updated:      11th June 2016
+# Updated:      14th February 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -58,9 +58,9 @@
 #     args = CLASP::Arguments.new(argv)
 #
 #     puts args.flags.size         # => 1
-#     puts args.flags[0]           # => "#<CLASP::Arguments::Flag:0x007fd23aa3aa98 @arg="-c", @given_index=1, @given_name="-c", @argument_alias=nil, @given_hyphens=1, @given_label="c", @name="-c", @extras={}>"
+#     puts args.flags[0]           # => "#<CLASP::Arguments::FlagArgument:0x007fd23aa3aa98 @arg="-c", @given_index=1, @given_name="-c", @argument_alias=nil, @given_hyphens=1, @given_label="c", @name="-c", @extras={}>"
 #     puts args.options.size       # => 1
-#     puts args.options[0]         # => "#<CLASP::Arguments::Option:0x007fd23aa3aca0 @arg="--show-all=true", @given_index=0, @given_name="--show-all", @argument_alias=nil, @given_hyphens=2, @given_label="show-all", @value="true", @name="--show-all", @extras={}>"
+#     puts args.options[0]         # => "#<CLASP::Arguments::OptionArgument:0x007fd23aa3aca0 @arg="--show-all=true", @given_index=0, @given_name="--show-all", @argument_alias=nil, @given_hyphens=2, @given_label="show-all", @value="true", @name="--show-all", @extras={}>"
 #     puts args.options[0].value   # => "true"
 #     puts args.values.size        # => 2
 #     puts args.values[0]          # => "infile"
@@ -74,7 +74,7 @@
 #
 #     puts args.flags.size         # => 0
 #     puts args.options.size       # => 1
-#     puts args.options[0]         # => "#<CLASP::Arguments::Option:0x007fd23aa3aca0 @arg="--show-all=true", @given_index=0, @given_name="--show-all", @argument_alias=nil, @given_hyphens=2, @given_label="show-all", @value="true", @name="--show-all", @extras={}>"
+#     puts args.options[0]         # => "#<CLASP::Arguments::OptionArgument:0x007fd23aa3aca0 @arg="--show-all=true", @given_index=0, @given_name="--show-all", @argument_alias=nil, @given_hyphens=2, @given_label="show-all", @value="true", @name="--show-all", @extras={}>"
 #     puts args.values.size        # => 3
 #     puts args.values[0]          # => "infile"
 #     puts args.values[1]          # => "outfile"
@@ -127,17 +127,17 @@
 #     args = CLASP::Arguments.new(argv, aliases)
 #
 #     puts args.flags.size         # => 1
-#     puts args.flags[0]           # => "#<CLASP::Arguments::Flag:0x007f8593b0ddd8 @arg="-c", @given_index=0, @given_name="-c", @argument_alias=nil, @given_hyphens=1, @given_label="c", @name="-c", @extras={}>"
+#     puts args.flags[0]           # => "#<CLASP::Arguments::FlagArgument:0x007f8593b0ddd8 @arg="-c", @given_index=0, @given_name="-c", @argument_alias=nil, @given_hyphens=1, @given_label="c", @name="-c", @extras={}>"
 #     puts args.options.size       # => 1
-#     puts args.options[0]         # => "#<CLASP::Arguments::Option:0x007f8593b0db80 @arg="-a", @given_index=1, @given_name="-a", @argument_alias=#<CLASP::Option:0x007f8593b2ea10 @name="--show-all", @aliases=["-a"], @help=nil, @values_range=[], @default_value=nil, @extras={}>, @given_hyphens=1, @given_label="a", @value="true", @name="--show-all", @extras={}>"
+#     puts args.options[0]         # => "#<CLASP::Arguments::OptionArgument:0x007f8593b0db80 @arg="-a", @given_index=1, @given_name="-a", @argument_alias=#<CLASP::OptionArgument:0x007f8593b2ea10 @name="--show-all", @aliases=["-a"], @help=nil, @values_range=[], @default_value=nil, @extras={}>, @given_hyphens=1, @given_label="a", @value="true", @name="--show-all", @extras={}>"
 #     puts args.values.size        # => 2
 #     puts args.values[0]          # => "infile"
 #     puts args.values[1]          # => "outfile"
 #
 # === Classes of interest
 # * ::CLASP::Arguments
-# * ::CLASP::Flag
-# * ::CLASP::Option
+# * ::CLASP::FlagArgument
+# * ::CLASP::OptionArgument
 #
 # === Functions of interest
 # * ::CLASP.show_version()

data/lib/clasp/version.rb

@@ -5,13 +5,13 @@
 # Purpose:      Version for CLASP.Ruby library
 #
 # Created:      16th November 2014
-# Updated:      2nd March 2018
+# Updated:      17th March 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2014-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -51,7 +51,7 @@
 module CLASP
 
 	# Current version of the CLASP.Ruby library
-	VERSION				=	'0.13.3'
+	VERSION				=	'0.15.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_ARGV_rewrite.rb

@@ -12,9 +12,15 @@ class Test_Arguments_4 < Test::Unit::TestCase
 
 		aliases	=	nil
 		argv	=	[ 'val1', '-f1', 'val2', '--' ]
+
+		assert_equal 'val1|-f1|val2|--', argv.join('|')
+
 		argv_c	=	argv.dup
 		args	=	CLASP::Arguments.new argv, aliases
 
+		assert_equal 'val1|-f1|val2|--', argv.join('|')
+
+
 		assert_equal 1, args.flags.size
 		assert_equal Hash.new, args.flags[0].extras
 
@@ -23,9 +29,9 @@ class Test_Arguments_4 < Test::Unit::TestCase
 		assert_equal 2, args.values.size
 
 		assert_same argv, args.argv
-		assert_equal 2, argv.size
+		assert_equal 4, argv.size
 		assert_equal 'val1', argv[0]
-		assert_equal 'val2', argv[1]
+		assert_equal 'val2', argv[2]
 
 		assert_equal args.argv_original_copy, argv_c
 		assert_equal argv_c, args.argv_original_copy

data/test/unit/tc_arguments_1.rb

@@ -294,6 +294,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_double_hyphen_3
 
 		aliases	=	[
+
 			CLASP.Option('--password', alias: '-p', extras: 'extra'),
 		]
 		args	=	CLASP::Arguments.new [ '-f1', 'value1', '-p', '--', 'value2' ], aliases
@@ -359,6 +360,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_flag_aliases_2
 
 		aliases	=	[
+
 			CLASP.Flag('--expand', alias: '-x')
 		]
 		args	=	CLASP::Arguments.new [ '-f1', 'value1', '-x', '--delete' ], aliases
@@ -395,6 +397,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_flag_aliases_3
 
 		aliases	=	[
+
 			CLASP.Flag('--expand', aliases: [ '-x', '--x' ], extras: %w{ e x t r a })
 		]
 		args	=	CLASP::Arguments.new [ '-f1', 'value1', '-x', '--delete', '--x' ], aliases
@@ -465,6 +468,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_option_aliases_2
 
 		aliases	=	[
+
 			CLASP.Option('--option', aliases: [ '-o' ])
 		]
 		args	=	CLASP::Arguments.new [ '-f1', 'value1', '-o=value' ], aliases
@@ -493,6 +497,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_option_aliases_3
 
 		aliases	=	[
+
 			CLASP.Option('--option', aliases: [ '-o' ])
 		]
 		args	=	CLASP::Arguments.new [ '-f1', 'value1', '-o', 'value' ], aliases
@@ -521,6 +526,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_option_default_aliases_1
 
 		aliases	=	[
+
 			CLASP.Option('--option', aliases: [ '-o' ]),
 			CLASP.Option('--option=special-value', alias: '-s')
 		]
@@ -564,6 +570,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_option_default_aliases_2
 
 		aliases	=	[
+
 			CLASP.Option('--option', aliases: [ '-o' ]),
 			CLASP.Flag('--option=special-value', alias: '-s'),
 			CLASP.Flag('--verbose', alias: '-v'),
@@ -624,6 +631,7 @@ class Test_Arguments < Test::Unit::TestCase
 	def test_option_default_aliases_3
 
 		aliases	=	[
+
 			CLASP.Option('--option', aliases: [ '-o' ]),
 			CLASP.Flag('--option=special-value', alias: '-s'),
 			CLASP.Flag('-v'),

data/test/unit/tc_arguments_inspect.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_Arguments_inspect_and_to_s < Test::Unit::TestCase
+
+	include CLASP
+
+	def test_no_arguments
+
+		argv	=	[]
+		args	=	Arguments.new argv
+
+		assert_equal %Q<[]>, args.flags.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.flags.inspect
+
+		assert_equal %Q<[]>, args.options.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.options.inspect
+
+		assert_equal %Q<[]>, args.values.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.values.inspect
+	end
+
+	def test_one_value
+
+		argv	=	[ 'val1' ]
+		args	=	Arguments.new argv
+
+		assert_equal %Q<[]>, args.flags.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.flags.inspect
+
+		assert_equal %Q<[]>, args.options.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.options.inspect
+
+		assert_equal %Q<["val1"]>, args.values.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\["val1"\].*>/, args.values.inspect
+	end
+
+	def test_three_values
+
+		argv	=	[ 'val1', 'val2', 'val3' ]
+		args	=	Arguments.new argv
+
+		assert_equal %Q<[]>, args.flags.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.flags.inspect
+
+		assert_equal %Q<[]>, args.options.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.options.inspect
+
+		assert_equal %Q<["val1", "val2", "val3"]>, args.values.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\["val1", "val2", "val3"\].*>/, args.values.inspect
+	end
+
+	def test_one_flag
+
+		argv	=	[ '-f' ]
+		args	=	Arguments.new argv
+
+		assert_equal %Q<["-f"]>, args.flags.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[#<CLASP::Arguments::FlagArgument:0x.*-f.*>\].*>/, args.flags.inspect
+
+		assert_equal %Q<[]>, args.options.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.options.inspect
+
+		assert_equal %Q<[]>, args.values.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.values.inspect
+	end
+
+	def test_two_flags
+
+		argv	=	[ '-f', '-g' ]
+		args	=	Arguments.new argv
+
+		assert_equal %Q<["-f", "-g"]>, args.flags.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[#<CLASP::Arguments::FlagArgument:0x.*-f.*-g.*>\].*>/, args.flags.inspect
+
+		assert_equal %Q<[]>, args.options.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.options.inspect
+
+		assert_equal %Q<[]>, args.values.to_s
+		assert_match /#<Array:0x[0-9a-fA-Z]+\s+\[\].*>/, args.values.inspect
+	end
+end
+
+

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::Flag, CLASP::Option, or CLASP::Alias') { 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_usage([ 'abc', :def ]) }
 
-		assert_raise_with_message(::TypeError, 'each element in aliases array must be one of the types CLASP::Flag, CLASP::Option, or CLASP::Alias') { CLASP.show_version([ '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 ]) }
 	end
 end
 

data/test/unit/tc_usage.rb

@@ -38,7 +38,7 @@ class Test_Usage < Test::Unit::TestCase
 
 		stream	=	StringIO.new
 
-		info	=	'myprog version'
+		info	=	'myprog version'.freeze
 
 		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: '', info_lines: info
 
@@ -55,7 +55,7 @@ class Test_Usage < Test::Unit::TestCase
 
 			'Synesis Software My Program',
 			'version 1',
-		]
+		].freeze
 
 		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: '', info_lines: info_lines
 
@@ -72,7 +72,7 @@ class Test_Usage < Test::Unit::TestCase
 
 			'Synesis Software My Program',
 			:version
-		]
+		].freeze
 
 		CLASP.show_usage aliases, stream: stream, program_name: 'myprog', flags_and_options: '', info_lines: info_lines, version: [ 1, 0, 1], version_prefix: 'v'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.15.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.30'
 description: |
   Command-Line Argument Sorting and Parsing library that provides a powerful
   abstraction of command-line interpretation facilities. CLASP.Ruby is a Ruby port of the popular CLASP (C/C++) library, and provides declarative specification of command-line flags and options, aliasing, flag combination, UNIX de-facto standard flag processing, and a number of utility functions for expressing usage and version information.
@@ -43,7 +43,6 @@ files:
 - lib/clasp/cli.rb
 - lib/clasp/doc_.rb
 - lib/clasp/old_module.rb
-- lib/clasp/util/immutable_array.rb
 - lib/clasp/version.rb
 - test/scratch/test_aliases.rb
 - test/scratch/test_list_command_line.rb
@@ -54,14 +53,13 @@ files:
 - test/unit/tc_arguments_1.rb
 - test/unit/tc_arguments_2.rb
 - test/unit/tc_arguments_3.rb
+- test/unit/tc_arguments_inspect.rb
 - test/unit/tc_cli.rb
 - test/unit/tc_defaults_1.rb
 - test/unit/tc_examples_Arguments.rb
 - test/unit/tc_extras.rb
-- test/unit/tc_immutable_array.rb
 - test/unit/tc_option_required.rb
 - test/unit/tc_usage.rb
-- test/unit/tc_util_immutable_array.rb
 - test/unit/ts_all.rb
 homepage: http://github.com/synesissoftware/CLASP.Ruby
 licenses:
@@ -73,9 +71,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -83,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.4.5.5
 signing_key: 
 specification_version: 4
 summary: CLASP.Ruby

data/lib/clasp/util/immutable_array.rb

@@ -1,169 +0,0 @@
-
-# ######################################################################## #
-# File:         clasp/util/immutable_array.rb
-#
-# Purpose:      Definition of the CLASP::Util::ImmutableArray class
-#
-# Created:      14th February 2014
-# Updated:      16th July 2016
-#
-# Home:         http://github.com/synesissoftware/CLASP.Ruby
-#
-# Author:       Matthew Wilson
-#
-# Copyright (c) 2014-2016, Matthew Wilson and Synesis Software
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-#   notice, this list of conditions and the following disclaimer.
-#
-# * Redistributions in binary form must reproduce the above copyright
-#   notice, this list of conditions and the following disclaimer in the
-#   documentation and/or other materials provided with the distribution.
-#
-# * Neither the names of the copyright holder nor the names of its
-#   contributors may be used to endorse or promote products derived from
-#   this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
-# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#
-# ######################################################################## #
-
-
-
-
-=begin
-=end
-
-module CLASP
-module Util
-
-# ######################################################################## #
-# classes
-
-# An immutable array
-class ImmutableArray
-
-	include Enumerable
-
-	#:nodoc:
-	def initialize(a)
-
-		raise ArgumentError, "must supply array" if a.nil?
-		raise TypeError, "must supply instance of #{::Array}; #{a.class} given" unless a.is_a? ::Array
-
-		@a = a
-	end
-
-	# Calls the block once for each element in the array
-	def each
-
-		return @a.each unless block_given?
-
-		@a.each { |i| yield i }
-	end
-
-	# Alias for +length+
-	def size
-
-		@a.size
-	end
-
-	# Indicates whether the immutable array has no elements
-	def empty?
-
-		@a.empty?
-	end
-
-	# Same semantics as +Enumerable#find+ for the underlying array
-	def find ifnone = nil
-
-		return @a.find(ifnone) { |o| yield o } if block_given?
-
-		@a.find ifnone
-	end
-
-	# The number of elements in the immutable array
-	def length
-
-		@a.length
-	end
-
-	# Same semantics as +Array#slice+
-	def slice *args
-
-		case args.length
-		when 1
-			case args[0]
-			when ::Integer
-				return @a.slice args[0]
-			end
-		when 2
-		else
-		end
-
-		self.class.new @a.slice(*args)
-	end
-
-	# Same semantics as +Array#[]+
-	def [] *args
-
-		slice(*args)
-	end
-
-	# Determines whether +rhs+ is each to the receiver
-	def == rhs
-
-		return rhs == @a if rhs.is_a? self.class
-
-		@a == rhs
-	end
-end
-
-# ######################################################################## #
-# module
-
-end # module Util
-end # module CLASP
-
-# ######################################################################## #
-# extensions
-
-#:nodoc:
-class Array
-
-	# Monkey-patched Array#== in order to handle comparison with
-	# ImmutableArray
-	#
-	# NOTE: do not do so for +eql?+
-
-	#:nodoc:
-	alias_method :old_equal, :==
-
-	undef :==
-
-	#:nodoc:
-	def ==(rhs)
-
-		return rhs == self if rhs.is_a? CLASP::Arguments::ImmutableArray
-
-		old_equal rhs
-	end
-end
-
-# ############################## end of file ############################# #
-

data/test/unit/tc_immutable_array.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
-
-require 'clasp'
-
-require 'test/unit'
-
-class Test_ImmutableArray < Test::Unit::TestCase
-
-	ImmutableArray = ::CLASP::Arguments::ImmutableArray
-
-	def test_empty
-
-		ia = ImmutableArray.new []
-
-		assert ia.empty?
-		assert_equal 0, ia.size
-		assert_equal 0, ia.length
-		assert_equal 0, ia.count
-		assert_equal 0, ia.count(:abc)
-		assert_equal 0, ia.count { |o| !o.nil? }
-		assert (ia.find { |o| !o.nil? }).nil?
-		assert_equal ImmutableArray.new([]), ia
-		assert_not_equal ImmutableArray.new([ :def ]), ia
-		assert_not_equal ImmutableArray.new([ :abc, :def ]), ia
-		assert ia[0].nil?
-		assert ia[1].nil?
-		assert_equal ImmutableArray.new([]), ia[0..1]
-	end
-
-	def test_one_item
-
-		ia = ImmutableArray.new [ :def ]
-
-		assert !ia.empty?
-		assert_equal 1, ia.size
-		assert_equal 1, ia.length
-		assert_equal 1, ia.count
-		assert_equal 0, ia.count(:abc)
-		assert_equal 1, ia.count { |o| !o.nil? }
-		assert !(ia.find { |o| !o.nil? }).nil?
-		assert_not_equal ImmutableArray.new([]), ia
-		assert_equal ImmutableArray.new([ :def ]), ia
-		assert_not_equal ImmutableArray.new([ :abc, :def ]), ia
-		assert_equal :def, ia[0]
-		assert ia[1].nil?
-		assert_equal ImmutableArray.new([ :def ]), ia[0..1]
-	end
-
-	def test_two_items
-
-		ia = ImmutableArray.new [ :abc, :def ]
-
-		assert !ia.empty?
-		assert_equal 2, ia.size
-		assert_equal 2, ia.length
-		assert_equal 2, ia.count
-		assert_equal 1, ia.count(:abc)
-		assert_equal 2, ia.count { |o| !o.nil? }
-		assert !(ia.find { |o| !o.nil? }).nil?
-		assert_not_equal ImmutableArray.new([]), ia
-		assert_not_equal ImmutableArray.new([ :def ]), ia
-		assert_equal ImmutableArray.new([ :abc, :def ]), ia
-		assert_equal :abc, ia[0]
-		assert_equal :def, ia[1]
-		assert_equal ImmutableArray.new([ :abc, :def ]), ia[0..1]
-	end
-end
-
-# ############################## end of file ############################# #
-

data/test/unit/tc_util_immutable_array.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
-
-require 'clasp'
-
-require 'test/unit'
-
-class Test_Util_ImmutableArray < Test::Unit::TestCase
-
-	include ::CLASP::Util
-
-	def test_empty
-
-		ia = ImmutableArray.new []
-
-		assert ia.empty?
-		assert_equal 0, ia.size
-		assert_equal 0, ia.length
-		assert_equal 0, ia.count
-		assert_equal 0, ia.count(:abc)
-		assert_equal 0, ia.count { |o| !o.nil? }
-		assert (ia.find { |o| !o.nil? }).nil?
-		assert_equal ImmutableArray.new([]), ia
-		assert_not_equal ImmutableArray.new([ :def ]), ia
-		assert_not_equal ImmutableArray.new([ :abc, :def ]), ia
-		assert ia[0].nil?
-		assert ia[1].nil?
-		assert_equal ImmutableArray.new([]), ia[0..1]
-	end
-
-	def test_one_item
-
-		ia = ImmutableArray.new [ :def ]
-
-		assert !ia.empty?
-		assert_equal 1, ia.size
-		assert_equal 1, ia.length
-		assert_equal 1, ia.count
-		assert_equal 0, ia.count(:abc)
-		assert_equal 1, ia.count { |o| !o.nil? }
-		assert !(ia.find { |o| !o.nil? }).nil?
-		assert_not_equal ImmutableArray.new([]), ia
-		assert_equal ImmutableArray.new([ :def ]), ia
-		assert_not_equal ImmutableArray.new([ :abc, :def ]), ia
-		assert_equal :def, ia[0]
-		assert ia[1].nil?
-		assert_equal ImmutableArray.new([ :def ]), ia[0..1]
-	end
-
-	def test_two_items
-
-		ia = ImmutableArray.new [ :abc, :def ]
-
-		assert !ia.empty?
-		assert_equal 2, ia.size
-		assert_equal 2, ia.length
-		assert_equal 2, ia.count
-		assert_equal 1, ia.count(:abc)
-		assert_equal 2, ia.count { |o| !o.nil? }
-		assert !(ia.find { |o| !o.nil? }).nil?
-		assert_not_equal ImmutableArray.new([]), ia
-		assert_not_equal ImmutableArray.new([ :def ]), ia
-		assert_equal ImmutableArray.new([ :abc, :def ]), ia
-		assert_equal :abc, ia[0]
-		assert_equal :def, ia[1]
-		assert_equal ImmutableArray.new([ :abc, :def ]), ia[0..1]
-	end
-end
-
-# ############################## end of file ############################# #
-