libclimate-ruby 0.15.0 → 0.16.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3b5494527c8f55a49015bfa7fb78ee362315a117
-  data.tar.gz: ed66aad3de517bf0aa0689c40cfd4f469a820ad1
+SHA256:
+  metadata.gz: c1e94d5cc4ba07147cf90cdd5a0429d30bef55324228eac1c27246020f35b267
+  data.tar.gz: 0fbd451ec141cdaeb5e6f2d4f720d970d0287bbc24140a9c90957a1fbd247d8a
 SHA512:
-  metadata.gz: 0b1eece97175423d77773c767dacf8148ea03dfd73c38a11840bf3eb0bfaeab54120be55ac5975c6e5cad9ca7afc82016750856bfccdffa091fa3a709b7141bf
-  data.tar.gz: 4913b8c35f85347a4c3ccbbe8cf9e89d74caaafdcfc9aa2eb8ac30f3f3d4cc5e7878a779326ac821b6a37f1d6b5f9270dc26f5fa9c5ea415d00d479fcf9ff197
+  metadata.gz: e56af8baca9f1278d41f9efa9acc8a4cd7fed0736592f875415874078a341bfbbf9c1563daa0f7bc7c2b8eeb1c4f683ad19b1c74ac27903ec6c4af73344bbddb
+  data.tar.gz: 8ac03e855c3f425857aa9fee828c637a7368cff1af1ce82ef167d3b111f74d37dc3b0d3a42d279c517a51a3ccac7dbcdf7ad7bc41d626d3eb8cd08172644707b

data/README.md

@@ -15,7 +15,9 @@ libCLImate, for Ruby
 
 **libCLImate** is a portable, lightweight mini-framework that encapsulates the common aspects of **C**ommand-**L**ine **I**nterface boilerplate, including:
 
-- command-line argument parsing and sorting;
+- command-line argument parsing and sorting, into flags, options, and values;
+- validating given and/or missing arguments;
+- a declarative form of specifying the CLI elements for a program, including associating blocks with flag/option specifications;
 - provision of de-facto standard CLI facilities, such as responding to '--help' and '--version';
 
 **libCLImate.Ruby** is the Ruby version.
@@ -48,7 +50,7 @@ climate = LibCLImate::Climate.new do |cl|
 
 		options[:debug] = true
 	end
-	cl.add_option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ]) do |o, a|
+	cl.add_option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ]) do |o, sp|
 
 		options[:verbosity] = o.value
 	end
@@ -102,10 +104,13 @@ Defect reports, feature requests, and pull requests are welcome on https://githu
 * [**CLASP**](https://github.com/synesissoftware/CLASP/)
 * [**CLASP.Go**](https://github.com/synesissoftware/CLASP.Go/)
 * [**CLASP.js**](https://github.com/synesissoftware/CLASP.js/)
+* [**CLASP.NET**](https://github.com/synesissoftware/CLASP.NET/)
+* [**CLASP.Python**](https://github.com/synesissoftware/CLASP.Python/)
 * [**CLASP.Ruby**](https://github.com/synesissoftware/CLASP.Ruby/)
-* [**libCLImate** (C/C++)](https://github.com/synesissoftware/libCLImate.Ruby)
+* [**libCLImate** (C/C++)](https://github.com/synesissoftware/libCLImate)
 * [**xqsr3**](https://github.com/synesissoftware.com/libCLImate.Ruby-xml/)
 
 ### License
 
 **libCLImate.Ruby** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+

data/examples/flag_and_option_specifications.from_DATA.md

@@ -7,7 +7,7 @@ Example illustrating various kinds of *flag* and *option* specifications, includ
 ## Source
 
 ```ruby
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/flag_and_option_specifications.from_DATA.rb
 

data/examples/flag_and_option_specifications.from_DATA.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/flag_and_option_specifications.from_DATA.rb
 

data/examples/flag_and_option_specifications.md

@@ -7,7 +7,7 @@ Example illustrating various kinds of *flag* and *option* specifications, includ
 ## Source
 
 ```ruby
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/flag_and_option_specifications.rb
 
@@ -153,7 +153,7 @@ processing in 'dir-1' and 'dir-2'
 If executed with the arguments
 
 ```
-    ruby examples/flag_and_option_specifications.rb -v silent -d
+    ruby examples/flag_and_option_specifications.rb dir-1 dir-2 -v silent -d
 ```
 
 it gives the (same) output:
@@ -161,6 +161,7 @@ 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
@@ -168,7 +169,7 @@ Debug mode is specified
 If executed with the arguments
 
 ```
-    ruby examples/flag_and_option_specifications.rb -c -d
+    ruby examples/flag_and_option_specifications.rb -c -d dir-1 dir-2
 ```
 
 it gives the output:
@@ -176,6 +177,7 @@ 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
@@ -183,7 +185,7 @@ Debug mode is specified
 If executed with the arguments
 
 ```
-    ruby examples/flag_and_option_specifications.rb -dc
+    ruby examples/flag_and_option_specifications.rb -dc dir-1 dir-2
 ```
 
 it gives the (same) output:
@@ -191,5 +193,5 @@ 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.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/flag_and_option_specifications.rb
 

data/examples/show_usage_and_version.md

@@ -7,7 +7,7 @@ Simple example supporting ```--help``` and ```--version```.
 ## Source
 
 ```ruby
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/show_usage_and_version.rb
 

data/examples/show_usage_and_version.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/show_usage_and_version.rb
 

data/lib/libclimate/climate.rb

@@ -5,12 +5,13 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      29th April 2019
+# Updated:      24th July 2022
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2022, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -183,6 +184,7 @@ class Climate
 			@flags					=	arguments.flags
 			@options				=	arguments.options
 			@values					=	arguments.values
+			@double_slash_index		=	arguments.double_slash_index
 		end
 
 		# (Climate) The +Climate+ instance from which this instance was obtained
@@ -209,6 +211,8 @@ class Climate
 		# (String) A (frozen) array of values
 		attr_reader :values
 
+		attr_reader :double_slash_index
+
 		# Verifies the initiating command-line against the specifications,
 		# raising an exception if any missing, unused, or unrecognised flags,
 		# options, or values are found
@@ -970,8 +974,8 @@ class Climate
 	#
 	# === Returns
 	# an instance of a type derived from +::Hash+ with the additional
-	# attributes +flags+, +options+, +values+, and +argv+.
-	#
+	# attributes +flags+, +options+, +values+, +double_slash_index+ and
+	# +argv+.
 	def run(argv = ARGV) # :yields: customised +::Hash+
 
 		raise ArgumentError, "argv may not be nil" if argv.nil?
@@ -988,6 +992,8 @@ class Climate
 		options		=	arguments.options
 		values		=	arguments.values.to_a
 
+		double_slash_index	=	arguments.double_slash_index
+
 		results		=	{
 
 			flags: {
@@ -1138,6 +1144,11 @@ class Climate
 			self[:values]
 		end
 
+		results.define_singleton_method(:double_slash_index) do
+
+			double_slash_index
+		end
+
 		results.define_singleton_method(:argv) do
 
 			argv

data/lib/libclimate/version.rb

@@ -4,10 +4,11 @@
 # Purpose:      Version for libclimate.Ruby library
 #
 # Created:      13th July 2015
-# Updated:      29th April 2019
+# Updated:      1st December 2023
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -43,7 +44,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.15.0'
+	VERSION					=	'0.16.0.1'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/scratch/specifications.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 #############################################################################
 # File:         test/scratch/specifications.rb
@@ -6,7 +6,7 @@
 # Purpose:      Demonstrates use of specifications in options and flags
 #
 # Created:      7th February 2018
-# Updated:      7th February 2018
+# Updated:      22nd July 2022
 #
 # Author:       Matthew Wilson
 #

data/test/unit/tc_abort.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test abort
 

data/test/unit/tc_double_slash_index.rb

@@ -0,0 +1,91 @@
+#! /usr/bin/env ruby
+#
+# test attribute `LibCLImate::Climate#double_slash_index`
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_double_slash_index < Test::Unit::TestCase
+
+	def test_some_arguments_without_DSI
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_flag('--abc')
+
+			cl.add_flag('-d')
+			cl.add_flag('-e')
+			cl.add_flag('-f')
+		end
+
+		argv = %w{ --abc -d -e -f }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert 3 <= r.size
+		assert_not_nil r[:flags]
+		assert_not_nil r[:options]
+		assert_not_nil r[:values]
+		assert_equal 4, r[:flags].size
+		assert_equal 4, r.flags.size
+		assert_equal 4, r[:flags][:given].size
+		assert_equal 0, r[:flags][:handled].size
+		assert_equal 4, r[:flags][:unhandled].size
+		assert_equal 0, r[:flags][:unknown].size
+		assert_equal 4, r[:options].size
+		assert_equal 0, r[:options][:given].size
+		assert_equal 0, r[:options][:handled].size
+		assert_equal 0, r[:options][:unhandled].size
+		assert_equal 0, r[:options][:unknown].size
+		assert_equal 0, r[:values].size
+		assert_nil r.double_slash_index
+	end
+
+	def test_some_arguments_with_DSI
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_flag('--abc')
+
+			cl.add_flag('-d')
+			cl.add_flag('-e')
+			cl.add_flag('-f')
+		end
+
+		argv = %w{ --abc -d -- -e -f }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert 3 <= r.size
+		assert_not_nil r[:flags]
+		assert_not_nil r[:options]
+		assert_not_nil r[:values]
+		assert_equal 4, r[:flags].size
+		assert_equal 4, r.flags.size
+		assert_equal 2, r[:flags][:given].size
+		assert_equal 0, r[:flags][:handled].size
+		assert_equal 2, r[:flags][:unhandled].size
+		assert_equal 0, r[:flags][:unknown].size
+		assert_equal 4, r[:options].size
+		assert_equal 0, r[:options][:given].size
+		assert_equal 0, r[:options][:handled].size
+		assert_equal 0, r[:options][:unhandled].size
+		assert_equal 0, r[:options][:unknown].size
+		assert_equal 2, r[:values].size
+		assert_equal '-e', r[:values][0]
+		assert_equal '-f', r[:values][1]
+		assert_equal 2, r.double_slash_index
+	end
+end

data/test/unit/tc_infer_version.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test version inference
 

data/test/unit/tc_minimal.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test simple scenarios
 
@@ -71,6 +71,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		assert_equal 0, r[:options][:unhandled].size
 		assert_equal 0, r[:options][:unknown].size
 		assert_equal 0, r[:values].size
+		assert_nil r.double_slash_index
 
 		lines	=	str.string.split(/\n/)
 		lines	=	lines.reject { |line| line.chomp.strip.empty? }
@@ -119,6 +120,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		assert_equal 0, r[:options][:unhandled].size
 		assert_equal 0, r[:options][:unknown].size
 		assert_equal 0, r[:values].size
+		assert_nil r.double_slash_index
 
 		lines	=	str.string.split(/\n/)
 		lines	=	lines.reject { |line| line.chomp.strip.empty? }

data/test/unit/tc_minimal_CLASP.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test simple scenarios (with CLASP)
 
@@ -71,6 +71,7 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 		assert_equal 0, r[:options][:unhandled].size
 		assert_equal 0, r[:options][:unknown].size
 		assert_equal 0, r[:values].size
+		assert_nil r.double_slash_index
 
 		lines	=	str.string.split(/\n/)
 		lines	=	lines.reject { |line| line.chomp.strip.empty? }
@@ -119,6 +120,7 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 		assert_equal 0, r[:options][:unhandled].size
 		assert_equal 0, r[:options][:unknown].size
 		assert_equal 0, r[:values].size
+		assert_nil r.double_slash_index
 
 		lines	=	str.string.split(/\n/)
 		lines	=	lines.reject { |line| line.chomp.strip.empty? }

data/test/unit/tc_parse.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test version inference
 
@@ -44,6 +44,7 @@ class Test_Climate_parse < Test::Unit::TestCase
 		assert_equal 0, r.flags.size
 		assert_equal 0, r.options.size
 		assert_equal 0, r.values.size
+		assert_nil r.double_slash_index
 
 		r.verify()
 	end
@@ -69,6 +70,7 @@ class Test_Climate_parse < Test::Unit::TestCase
 		argv = [
 
 			'-d',
+			'--',
 		]
 
 		r = climate.parse argv
@@ -79,6 +81,7 @@ class Test_Climate_parse < Test::Unit::TestCase
 		assert_equal 1, r.flags.size
 		assert_equal 0, r.options.size
 		assert_equal 0, r.values.size
+		assert_equal 1, r.double_slash_index
 
 		flag0 = r.flags[0]
 
@@ -125,6 +128,7 @@ class Test_Climate_parse < Test::Unit::TestCase
 		assert_equal 0, r.flags.size
 		assert_equal 1, r.options.size
 		assert_equal 0, r.values.size
+		assert_nil r.double_slash_index
 
 		option0 = r.options[0]
 
@@ -156,6 +160,7 @@ class Test_Climate_parse < Test::Unit::TestCase
 		assert $stderr.equal? climate.stderr
 
 		argv = [
+			'--',
 		]
 
 		r = climate.parse argv
@@ -164,6 +169,7 @@ class Test_Climate_parse < Test::Unit::TestCase
 		assert_equal 0, r.flags.size
 		assert_equal 0, r.options.size
 		assert_equal 0, r.values.size
+		assert_equal 0, r.double_slash_index
 
 		assert_raise_with_message(MissingRequiredException, /.*verbosity.*not specified/) { r.verify(raise_on_required: MissingRequiredException) }
 	end

data/test/unit/tc_parse_and_verify.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test version inference
 
@@ -44,6 +44,7 @@ class Test_Climate_parse_and_verify < Test::Unit::TestCase
 		assert_equal 0, r.flags.size
 		assert_equal 0, r.options.size
 		assert_equal 0, r.values.size
+		assert_nil r.double_slash_index
 	end
 
 	def test_one_flag_with_block
@@ -77,6 +78,7 @@ class Test_Climate_parse_and_verify < Test::Unit::TestCase
 		assert_equal 1, r.flags.size
 		assert_equal 0, r.options.size
 		assert_equal 0, r.values.size
+		assert_nil r.double_slash_index
 
 		flag0 = r.flags[0]
 
@@ -119,6 +121,7 @@ class Test_Climate_parse_and_verify < Test::Unit::TestCase
 		assert_equal 0, r.flags.size
 		assert_equal 1, r.options.size
 		assert_equal 0, r.values.size
+		assert_nil r.double_slash_index
 
 		option0 = r.options[0]
 

data/test/unit/tc_test_specifications.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test specifications
 

data/test/unit/tc_values.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 

data/test/unit/tc_with_blocks.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test blocks
 

data/test/unit/tc_with_blocks_CLASP.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # test blocks (with CLASP)
 

data/test/unit/ts_all.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -16,29 +16,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: xqsr3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.37'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
-description: "\n"
+        version: '0.37'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.3
+description: |
+  libCLImate is a portable, lightweight mini-framework that encapsulates the common aspects of Command-Line Interface boilerplate, including:
+
+  - command-line argument parsing and sorting, into flags, options, and values;
+  - validating given and/or missing arguments;
+  - a declarative form of specifying the CLI elements for a program, including associating blocks with flag/option specifications;
+  - provision of de-facto standard CLI facilities, such as responding to '--help' and '--version';
+
+  libCLImate.Ruby is the Ruby version.
 email: matthew@synesis.com.au
 executables: []
 extensions: []
@@ -59,6 +73,7 @@ files:
 - test/scratch/blankzeroes.rb
 - test/scratch/specifications.rb
 - test/unit/tc_abort.rb
+- test/unit/tc_double_slash_index.rb
 - test/unit/tc_infer_version.rb
 - test/unit/tc_minimal.rb
 - test/unit/tc_minimal_CLASP.rb
@@ -69,7 +84,7 @@ files:
 - test/unit/tc_with_blocks.rb
 - test/unit/tc_with_blocks_CLASP.rb
 - test/unit/ts_all.rb
-homepage: http://www.libclimate.org/
+homepage: https://github.com/synesissoftware/libCLImate.Ruby
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -79,17 +94,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: libCLImate.Ruby