libclimate-ruby 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c5040323c276e22e2dcf86fbebf1e66bf159904d9a28e764ff913aed1d9a508
-  data.tar.gz: 9551c44bc9ca7bb1f69783d8c6b1e5ae0288548140dcd86023cd80df6fa98c14
+  metadata.gz: f003cbc8499db9924001bc35c3c5312de4e6423151d9acfaa8e835e0f7f331f3
+  data.tar.gz: 65e7371f5ded01f26074bad1413f329abd8c62237556162cef5ca0e9397deb9d
 SHA512:
-  metadata.gz: 158c64020110e066c1f57be6c4820e9519bed9fccee5883b903dd8d8f4c49d91f971bcfef8e2ff3fd416e6074be0149562098305b56a7cd705aa2619199c7620
-  data.tar.gz: 7672ba94c8724a7504f12d589ff20e703b31eb5ae5e27e6f1878ba8136a8ab2f0749e307b5d00ef11cfca277641c3c3479808c0a2d2406be1247abe887ae3f93
+  metadata.gz: 52fc0d2b96d707bedb7e12643e0cfc1d9a3724003f7454c8b64bc573b1704360fe8ce366bca0388411957f0420e777629e8e631038c3b6524aebaa2af92cfd9a
+  data.tar.gz: 5909f06e2b6ad0ca47e3da8d141382e20c93f17f80d2b8ea397364c9c0ebf7159e510373de0ed2a743ece65ae6a78202e9fed8c261f8fdbc692a044876f89f04

data/examples/flag_and_option_specifications.from_DATA.md

@@ -0,0 +1,225 @@
+# libCLImate.Ruby Example - **flag_and_option_specifications.from_DATA**
+
+## Summary
+
+Example illustrating various kinds of *flag* and *option* specifications, including the combination of short-names, loaded from the ``__END__``/``DATA`` section of the program file in **YAML** form.
+
+## Source
+
+```ruby
+#!/usr/bin/env ruby
+
+# examples/flag_and_option_specifications.from_DATA.rb
+
+
+# requires
+
+require 'libclimate'
+
+
+# Specify aliases, parse, and checking standard flags
+
+options = {}
+climate = LibCLImate::Climate.load DATA do |cl|
+
+	cl.on_flag('--debug') { options[:debug] = true }
+
+	cl.on_option('--verbosity') { |o, a| options[:verbosity] = o.value }
+end
+
+r = climate.run ARGV
+
+
+# Program-specific processing of flags/options
+
+if options[:verbosity]
+
+	$stdout.puts "verbosity is specified as: #{options[:verbosity]}"
+end
+
+if options[:debug]
+
+	$stdout.puts 'Debug mode is specified'
+end
+
+
+# some notional output
+
+$stdout.puts "processing in '#{r.values[0]}'" + (r.values.size > 1 ? " and '#{r.values[1]}'" : '')
+
+
+__END__
+---
+libclimate:
+  clasp:
+    specifications:
+    - flag:
+        name:  --debug
+        alias:  -d
+        help:  runs in Debug mode
+        required:  false
+    - option:
+        name:  --verbosity
+        alias: -v
+        help:  specifies the verbosity
+        values:
+        - silent
+        - quiet
+        - terse
+        - chatty
+        - verbose
+    - alias:
+        resolved:  --verbosity=chatty
+        aliases:
+        - --chatty
+        - -c
+  constrain_values: !ruby/range 1..2
+  exit_on_missing: true
+  flags_and_options: "[... flags/options ...]"
+  usage_values: "<dir-1> [ <dir-2> ]"
+  value_names:
+  - first directory
+  - second directory
+  info_lines:
+  - libCLImate.Ruby examples
+  - :version
+  - Illustrates use of libCLImate.Ruby's specification of flags, options, and aliases, from DATA
+  -
+  version:
+  - 0
+  - 1
+  - "2"
+```
+```ruby
+```
+
+## Usage
+
+NOTE: in order to demonstrate fully the utility of the *loading-from-source-file-YAML* facility, I've added a constraint for 1-2 values - notionally directories - 
+
+### No arguments
+
+If executed with no arguments
+
+```
+    ruby examples/flag_and_option_specifications.from_DATA.rb
+```
+
+or (in a Unix shell):
+
+```
+    ./examples/flag_and_option_specifications.from_DATA.rb
+```
+
+it gives the output (with an exit code of **1**):
+
+```
+flag_and_option_specifications.from_DATA(.rb): first directory not specified; use --help for usage
+```
+
+
+### Show usage
+
+If executed with the arguments
+
+```
+    ruby examples/flag_and_option_specifications.from_DATA.rb --help
+```
+
+it gives the output:
+
+```
+libCLImate.Ruby examples
+flag_and_option_specifications.from_DATA(.rb) 0.1.2
+Illustrates use of libCLImate.Ruby's specification of flags, options, and aliases, from DATA
+
+USAGE: flag_and_option_specifications.from_DATA(.rb) [... flags/options ...] <dir-1> [ <dir-2> ]
+
+flags/options:
+
+	--help
+		shows this help and terminates
+
+	--version
+		shows version and terminates
+
+	-d
+	--debug
+		runs in Debug mode
+
+	--chatty --verbosity=chatty
+	-c --verbosity=chatty
+	--verbosity=<value>
+		specifies the verbosity
+		where <value> one of:
+			silent
+			quiet
+			terse
+			chatty
+			verbose
+
+```
+
+### Specify flags and options in long-form
+
+If executed with the arguments
+
+```
+    ruby examples/flag_and_option_specifications.from_DATA.rb dir-1 dir-2 --debug --verbosity=silent
+```
+
+it gives the output:
+
+```
+verbosity is specified as: silent
+Debug mode is specified
+processing in 'dir-1' and 'dir-2'
+```
+
+### Specify flags and options in short-form
+
+If executed with the arguments
+
+```
+    ruby examples/flag_and_option_specifications.from_DATA.rb dir-1 dir-2 -v silent -d
+```
+
+it gives the (same) output:
+
+```
+verbosity is specified as: silent
+Debug mode is specified
+processing in 'dir-1' and 'dir-2'
+```
+
+### Specify flags and options in short-form, including an alias for an option-with-value
+
+If executed with the arguments
+
+```
+    ruby examples/flag_and_option_specifications.from_DATA.rb dir-1 dir-2 -c -d
+```
+
+it gives the output:
+
+```
+verbosity is specified as: chatty
+Debug mode is specified
+processing in 'dir-1' and 'dir-2'
+```
+
+### Specify flags and options with combined short-form
+
+If executed with the arguments
+
+```
+    ruby examples/flag_and_option_specifications.from_DATA.rb dir-1 dir-2 -dc
+```
+
+it gives the (same) output:
+
+```
+verbosity is specified as: chatty
+Debug mode is specified
+processing in 'dir-1' and 'dir-2'
+```

data/examples/flag_and_option_specifications.from_DATA.rb

@@ -8,11 +8,6 @@
 require 'libclimate'
 
 
-# constants
-
-PROGRAM_VERSION = '0.0.1'
-
-
 # Specify aliases, parse, and checking standard flags
 
 options = {}
@@ -39,6 +34,11 @@ if options[:debug]
 end
 
 
+# some notional output
+
+$stdout.puts "processing in '#{r.values[0]}'" + (r.values.size > 1 ? " and '#{r.values[1]}'" : '')
+
+
 __END__
 ---
 libclimate:
@@ -51,6 +51,7 @@ libclimate:
         required:  false
     - option:
         name:  --verbosity
+        alias: -v
         help:  specifies the verbosity
         values:
         - silent
@@ -66,10 +67,10 @@ libclimate:
   constrain_values: !ruby/range 1..2
   exit_on_missing: true
   flags_and_options: "[... flags/options ...]"
-  usage_values: "<directory-1> [ <directory-2> ]"
+  usage_values: "<dir-1> [ <dir-2> ]"
   value_names:
-  - directory-1
-  - directory-2
+  - first directory
+  - second directory
   info_lines:
   - libCLImate.Ruby examples
   - :version
@@ -77,6 +78,6 @@ libclimate:
   -
   version:
   - 0
-  - 3
-  - "4"
+  - 1
+  - "2"
 

data/examples/flag_and_option_specifications.md

@@ -1,4 +1,4 @@
-# libCLImate.Ruby Example - **show_usage_and_version**
+# libCLImate.Ruby Example - **flag_and_option_specifications**
 
 ## Summary
 

data/lib/libclimate/climate.rb

@@ -5,7 +5,7 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      13th April 2019
+# Updated:      15th April 2019
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -173,6 +173,17 @@ class Climate
 		GIVEN_SPECS_ = "_Given_Specs_01B59422_8407_4c89_9432_8160C52BD5AD"
 	end # module Climate_Constants_
 
+	def make_abort_message_ msg
+
+		if 0 != (usage_help_suffix || 0).size
+
+			"#{msg}; #{usage_help_suffix}"
+		else
+
+			msg
+		end
+	end
+
 	def show_usage_
 
 		options	=	{}
@@ -475,6 +486,7 @@ class Climate
 		@stderr				=	$stderr
 		@constrain_values	=	nil
 		@flags_and_options	=	flags_and_options
+		@usage_help_suffix	=	'use --help for usage'
 		@usage_values		=	usage_values
 		@value_names		=	[]
 		version_context		=	options[:version_context]
@@ -530,6 +542,8 @@ class Climate
 	attr_accessor :constrain_values
 	# (String) Optional string to describe the flags and options section. Defaults to "[ +...+ +flags+ +and+ +options+ +...+ ]"
 	attr_accessor :flags_and_options
+	# (String) The string that is appended to #abort calls made during #run. Defaults to "use --help for usage"
+	attr_accessor :usage_help_suffix
 	# @return (::String) Optional string to describe the program values, eg \<xyz "[ { <<directory> | &lt;file> } ]"
 	attr_accessor :usage_values
 	# ([String]) Zero-based array of names for values to be used when that value is not present (according to the +:constrain_values+ attribute)
@@ -625,7 +639,7 @@ class Climate
 				results[:flags][selector] << f
 			else
 
-				message = "unrecognised flag '#{f}'; use --help for usage"
+				message = make_abort_message_("unrecognised flag '#{f}'")
 
 				if false
 
@@ -687,7 +701,7 @@ class Climate
 				results[:options][selector] << o
 			else
 
-				message = "unrecognised option '#{o}'; use --help for usage"
+				message = make_abort_message_("unrecognised option '#{o}'")
 
 				if false
 
@@ -756,16 +770,37 @@ class Climate
 		when nil
 
 			;
+		when ::Array
+
+			warn "value of 'constrain_values' attribute, if an #{::Array}, must not be empty and all elements must be of type #{::Integer}" if values_constraint.empty? || !values_constraint.all? { |v| ::Integer === v }
+
+			unless values_constraint.include? values.size
+
+				message = make_abort_message_("wrong number of values: #{values.size} given, #{values_constraint} required")
+
+				if exit_on_missing
+
+					self.abort message
+				else
+
+					if program_name && !program_name.empty?
+
+						message = "#{program_name}: #{message}"
+					end
+
+					stderr.puts message
+				end
+			end
 		when ::Integer
 
 			unless values.size == values_constraint
 
 				if name = val_names[values.size]
 
-					message = name + ' not specified; use --help for usage'
+					message = make_abort_message_(name + ' not specified')
 				else
 
-					message = "wrong number of values: #{values.size} given, #{values_constraint} required; use --help for usage"
+					message = make_abort_message_("wrong number of values: #{values.size} given, #{values_constraint} required")
 				end
 
 				if exit_on_missing
@@ -787,10 +822,10 @@ class Climate
 
 				if name = val_names[values.size]
 
-					message = name + ' not specified; use --help for usage'
+					message = make_abort_message_(name + ' not specified')
 				else
 
-					message = "wrong number of values: #{values.size} givens, #{values_constraint.begin} - #{values_constraint.end - (values_constraint.exclude_end? ? 1 : 0)} required; use --help for usage"
+					message = make_abort_message_("wrong number of values: #{values.size} givens, #{values_constraint.begin} - #{values_constraint.end - (values_constraint.exclude_end? ? 1 : 0)} required")
 				end
 
 				if exit_on_missing
@@ -808,7 +843,7 @@ class Climate
 			end
 		else
 
-			warn "value of 'constrain_values' attribute - '#{constrain_values}' (#{constrain_values.class}) - of wrong type : must be #{::Integer}, #{::Range}, or nil"
+			warn "value of 'constrain_values' attribute - '#{constrain_values}' (#{constrain_values.class}) - of wrong type : must be #{::Array}, #{::Integer}, #{::Range}, or nil"
 		end
 
 

data/lib/libclimate/version.rb

@@ -4,7 +4,7 @@
 # Purpose:      Version for libclimate.Ruby library
 #
 # Created:      13th July 2015
-# Updated:      13th April 2019
+# Updated:      15th April 2019
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -43,7 +43,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.13.0'
+	VERSION					=	'0.14.0'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_abort.rb

@@ -20,11 +20,11 @@ class Test_Climate_abort < Test::Unit::TestCase
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'myprog'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
+			cl.program_name	=	'myprog'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
 		end
 
 		s			=	climate.abort 'something happened', exit: nil
@@ -42,11 +42,11 @@ class Test_Climate_abort < Test::Unit::TestCase
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'myprog'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
+			cl.program_name	=	'myprog'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
 		end
 
 		s			=	climate.abort 'something happened', exit: nil, program_name: ''
@@ -64,11 +64,11 @@ class Test_Climate_abort < Test::Unit::TestCase
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'myprog'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
+			cl.program_name	=	'myprog'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
 		end
 
 		s			=	climate.abort 'something happened', exit: nil, program_name: 'my-prog'

data/test/unit/tc_minimal.rb

@@ -17,7 +17,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 	def test_no_arguments_no_mods
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
 			;
 		end
@@ -28,10 +28,10 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 	def test_no_arguments_set_streams
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.stdout = $stdout
-			climate.stderr = $stderr
+			cl.stdout = $stdout
+			cl.stderr = $stderr
 		end
 
 		assert $stdout.equal? climate.stdout
@@ -42,11 +42,11 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 		end
 
 		argv = %w{ --help }
@@ -89,12 +89,12 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.info_lines = 'Synesis Software Open Source'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.info_lines = 'Synesis Software Open Source'
+			cl.stdout = str
+			cl.exit_on_usage = false
 		end
 
 		argv = %w{ --help }
@@ -139,12 +139,12 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.version = [ 1, 2, 3, 4 ]
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.version = [ 1, 2, 3, 4 ]
+			cl.stdout = str
+			cl.exit_on_usage = false
 		end
 
 		argv = %w{ --version }
@@ -164,12 +164,12 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'program'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
-			climate.exit_on_unknown	=	false
+			cl.program_name	=	'program'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
+			cl.exit_on_unknown	=	false
 		end
 
 		argv = %w{ --unknown }
@@ -184,17 +184,43 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		assert_equal "program: unrecognised flag '--unknown'; use --help for usage", lines_err[0]
 	end
 
+	def test_unrecognised_flag_terse
+
+		strout = StringIO.new
+		strerr = StringIO.new
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.program_name		=	'program'
+			cl.stdout				=	strout
+			cl.stderr				=	strerr
+			cl.exit_on_unknown		=	false
+			cl.usage_help_suffix	=	''
+		end
+
+		argv = %w{ --unknown }
+
+		climate.run argv
+
+		lines_out	=	strout.string.split /\n/
+		lines_err	=	strerr.string.split /\n/
+
+		assert_equal 0, lines_out.size
+		assert_equal 1, lines_err.size
+		assert_equal "program: unrecognised flag '--unknown'", lines_err[0]
+	end
+
 	def test_unrecognised_option
 
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'program'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
-			climate.exit_on_unknown	=	false
+			cl.program_name	=	'program'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
+			cl.exit_on_unknown	=	false
 		end
 
 		argv = %w{ --unknown=10 }
@@ -215,16 +241,16 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		is_verbose = false
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 
 			bl = false#proc { is_verbose = true }
 
-			climate.add_flag('--succinct', alias: '-s', help: 'operates succinctly')
-			climate.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => proc { is_verbose = true }})
+			cl.add_flag('--succinct', alias: '-s', help: 'operates succinctly')
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => proc { is_verbose = true }})
 		end
 
 		argv = %w{ --help --verbose --succinct }
@@ -276,13 +302,13 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		is_verbose = false
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 
-			climate.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
 		end
 
 		argv = %w{ --verbose }
@@ -321,13 +347,13 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		verbosity = 1
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 
-			climate.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', extras: { handle: proc { |o| verbosity = o.value }})
+			cl.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', extras: { handle: proc { |o| verbosity = o.value }})
 		end
 
 		argv = %w{ -v 2 }
@@ -364,11 +390,11 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
+			cl.program_name = 'program'
 
-			climate.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true)
+			cl.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true)
 		end
 
 		assert climate.specifications[2].required?
@@ -405,15 +431,15 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		str = StringIO.new
 		stre = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.stderr = stre
-			climate.exit_on_usage = false
-			climate.exit_on_missing = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.stderr = stre
+			cl.exit_on_usage = false
+			cl.exit_on_missing = false
 
-			climate.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true)
+			cl.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true)
 		end
 
 		r = climate.run %w{ }
@@ -455,15 +481,15 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		str = StringIO.new
 		stre = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.stderr = stre
-			climate.exit_on_usage = false
-			climate.exit_on_missing = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.stderr = stre
+			cl.exit_on_usage = false
+			cl.exit_on_missing = false
 
-			climate.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true, required_message: 'Verbosity not specified')
+			cl.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true, required_message: 'Verbosity not specified')
 		end
 
 		r = climate.run %w{ }
@@ -505,15 +531,15 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		str = StringIO.new
 		stre = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.stderr = stre
-			climate.exit_on_usage = false
-			climate.exit_on_missing = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.stderr = stre
+			cl.exit_on_usage = false
+			cl.exit_on_missing = false
 
-			climate.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true, required_message: "\0Verbosity")
+			cl.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', required: true, required_message: "\0Verbosity")
 		end
 
 		r = climate.run %w{ }

data/test/unit/tc_minimal_CLASP.rb

@@ -17,7 +17,7 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 	def test_no_arguments_no_mods
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
 			;
 		end
@@ -28,10 +28,10 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 	def test_no_arguments_set_streams
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.stdout = $stdout
-			climate.stderr = $stderr
+			cl.stdout = $stdout
+			cl.stderr = $stderr
 		end
 
 		assert $stdout.equal? climate.stdout
@@ -42,11 +42,11 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 		end
 
 		argv = %w{ --help }
@@ -89,12 +89,12 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.info_lines = 'Synesis Software Open Source'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.info_lines = 'Synesis Software Open Source'
+			cl.stdout = str
+			cl.exit_on_usage = false
 		end
 
 		argv = %w{ --help }
@@ -139,12 +139,12 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 		str = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.version = [ 1, 2, 3, 4 ]
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.version = [ 1, 2, 3, 4 ]
+			cl.stdout = str
+			cl.exit_on_usage = false
 		end
 
 		argv = %w{ --version }
@@ -164,12 +164,12 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'program'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
-			climate.exit_on_unknown	=	false
+			cl.program_name	=	'program'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
+			cl.exit_on_unknown	=	false
 		end
 
 		argv = %w{ --unknown }
@@ -189,12 +189,12 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 		strout = StringIO.new
 		strerr = StringIO.new
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name	=	'program'
-			climate.stdout			=	strout
-			climate.stderr			=	strerr
-			climate.exit_on_unknown	=	false
+			cl.program_name	=	'program'
+			cl.stdout			=	strout
+			cl.stderr			=	strerr
+			cl.exit_on_unknown	=	false
 		end
 
 		argv = %w{ --unknown=10 }
@@ -215,16 +215,14 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 		is_verbose = false
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 
-			bl = false#proc { is_verbose = true }
-
-			climate.add_flag('--succinct', alias: '-s', help: 'operates succinctly')
-			climate.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => proc { is_verbose = true }})
+			cl.add_flag('--succinct', alias: '-s', help: 'operates succinctly')
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => proc { is_verbose = true }})
 		end
 
 		argv = %w{ --help --verbose --succinct }
@@ -275,13 +273,13 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 		is_verbose = false
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 
-			climate.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
 		end
 
 		argv = %w{ --verbose }
@@ -319,13 +317,13 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 
 		verbosity = 1
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.program_name = 'program'
-			climate.stdout = str
-			climate.exit_on_usage = false
+			cl.program_name = 'program'
+			cl.stdout = str
+			cl.exit_on_usage = false
 
-			climate.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', extras: { handle: proc { |o| verbosity = o.value }})
+			cl.add_option('--verbosity', alias: '-v', help: 'determines level of verbose operation', extras: { handle: proc { |o| verbosity = o.value }})
 		end
 
 		argv = %w{ -v 2 }

data/test/unit/tc_test_specifications.rb

@@ -19,11 +19,11 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		options	=	{}
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.add_option('--action', alias: '-a') { |o, a| options[:action] = o.value }
-			climate.add_alias('--action=list', '-l')
-			climate.add_alias('--action=change', '-c')
+			cl.add_option('--action', alias: '-a') { |o, a| options[:action] = o.value }
+			cl.add_alias('--action=list', '-l')
+			cl.add_alias('--action=change', '-c')
 		end
 
 		# invoke via option

data/test/unit/tc_values.rb

@@ -19,21 +19,21 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 
 		climate = LibCLImate::Climate.new do |cl|
 
-			cl.exit_on_unknown	=	false
+			cl.exit_on_missing	=	false
 
 			cl.stdout	=	stdout
 			cl.stderr	=	stderr
 		end
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ ]
 		assert_equal 0, r.values.size
 		assert_empty stdout.string
 		assert_empty stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1' ]
 		assert_equal 1, r.values.size
 		assert_empty stdout.string
@@ -47,7 +47,7 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 
 		climate = LibCLImate::Climate.new do |cl|
 
-			cl.exit_on_unknown	=	false
+			cl.exit_on_missing	=	false
 
 			cl.stdout	=	stdout
 			cl.stderr	=	stderr
@@ -55,31 +55,31 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 			cl.constrain_values = 2
 		end
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ ]
 		assert_equal 0, r.values.size
 		assert_empty stdout.string
 		assert_not_empty stderr.string
 		assert_match /wrong number of values.*0 given.*2 required.*/, stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1' ]
 		assert_equal 1, r.values.size
 		assert_empty stdout.string
 		assert_not_empty stderr.string
 		assert_match /wrong number of values.*1 given.*2 required.*/, stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1', 'value-2' ]
 		assert_equal 2, r.values.size
 		assert_empty stdout.string
 		assert_empty stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1', 'value-2', 'value-3' ]
 		assert_equal 3, r.values.size
 		assert_empty stdout.string
@@ -94,7 +94,7 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 
 		climate = LibCLImate::Climate.new do |cl|
 
-			cl.exit_on_unknown	=	false
+			cl.exit_on_missing	=	false
 
 			cl.stdout	=	stdout
 			cl.stderr	=	stderr
@@ -102,40 +102,96 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 			cl.constrain_values = 0..2
 		end
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ ]
 		assert_equal 0, r.values.size
 		assert_empty stdout.string
 		assert_empty stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1' ]
 		assert_equal 1, r.values.size
 		assert_empty stdout.string
 		assert_empty stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1', 'value-2' ]
 		assert_equal 2, r.values.size
 		assert_empty stdout.string
 		assert_empty stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1', 'value-2', 'value-3' ]
 		assert_equal 3, r.values.size
 		assert_empty stdout.string
 		assert_not_empty stderr.string
 
-		stdout.truncate(0)
-		stderr.truncate(0)
+		stdout.string = ''
+		stderr.string = ''
 		r = climate.run [ 'value-1', 'value-2', 'value-3', 'value-4' ]
 		assert_equal 4, r.values.size
 		assert_empty stdout.string
 		assert_not_empty stderr.string
 	end
+
+	def test_constrain_with_simple_array
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.exit_on_missing	=	false
+
+			cl.stdout	=	stdout
+			cl.stderr	=	stderr
+
+			cl.constrain_values = [ 1, 3 ]
+
+			cl.program_name	=	"myprog"
+			cl.usage_help_suffix	=	''
+		end
+
+		stdout.string = ''
+		stderr.string = ''
+		r = climate.run [ ]
+		assert_equal 0, r.values.size
+		assert_empty stdout.string
+		assert_not_empty stderr.string
+
+		stdout.string = ''
+		stderr.string = ''
+		r = climate.run [ 'value-1' ]
+		assert_equal 1, r.values.size
+		assert_empty stdout.string
+		assert_empty stderr.string
+
+		stdout.string = ''
+		stderr.string = ''
+		r = climate.run [ 'value-1', 'value-2' ]
+		assert_equal 2, r.values.size
+		assert_empty stdout.string
+		assert_not_empty stderr.string
+
+		stdout.string = ''
+		stderr.string = ''
+		r = climate.run [ 'value-1', 'value-2', 'value-3' ]
+		assert_equal 3, r.values.size
+		assert_empty stdout.string
+		assert_empty stderr.string
+
+		stdout.string = ''
+		stderr.string = ''
+		assert_equal '', stderr.string
+		r = climate.run [ 'value-1', 'value-2', 'value-3', 'value-4' ]
+		assert_equal 4, r.values.size
+		assert_empty stdout.string
+		assert_not_empty stderr.string
+		assert_equal "myprog: wrong number of values: 4 given, [1, 3] required\n", stderr.string
+	end
 end
 

data/test/unit/tc_with_blocks.rb

@@ -19,9 +19,9 @@ class Test_Climate_with_blocks < Test::Unit::TestCase
 
 		is_verbose	=	false
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.add_flag('--verbose') { is_verbose = true }
+			cl.add_flag('--verbose') { is_verbose = true }
 		end
 
 		argv = %w{ --verbose }
@@ -35,9 +35,9 @@ class Test_Climate_with_blocks < Test::Unit::TestCase
 
 		flavour	=	nil
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.add_option('--flavour') { |o|  flavour = o.value }
+			cl.add_option('--flavour') { |o|  flavour = o.value }
 		end
 
 		argv = %w{ --flavour=blueberry }

data/test/unit/tc_with_blocks_CLASP.rb

@@ -19,9 +19,9 @@ class Test_Climate_with_blocks_CLASP < Test::Unit::TestCase
 
 		is_verbose	=	false
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.add_flag('--verbose') { is_verbose = true }
+			cl.add_flag('--verbose') { is_verbose = true }
 		end
 
 		argv = %w{ --verbose }
@@ -35,9 +35,9 @@ class Test_Climate_with_blocks_CLASP < Test::Unit::TestCase
 
 		flavour	=	nil
 
-		climate = LibCLImate::Climate.new do |climate|
+		climate = LibCLImate::Climate.new do |cl|
 
-			climate.add_option('--flavour') { |o|  flavour = o.value }
+			cl.add_option('--flavour') { |o|  flavour = o.value }
 		end
 
 		argv = %w{ --flavour=blueberry }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- examples/flag_and_option_specifications.from_DATA.md
 - examples/flag_and_option_specifications.from_DATA.rb
 - examples/flag_and_option_specifications.md
 - examples/flag_and_option_specifications.rb