libclimate-ruby 0.16.0.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1e94d5cc4ba07147cf90cdd5a0429d30bef55324228eac1c27246020f35b267
-  data.tar.gz: 0fbd451ec141cdaeb5e6f2d4f720d970d0287bbc24140a9c90957a1fbd247d8a
+  metadata.gz: 93f46385f402db50a58439b942019ed126dd63473b62a26e838891bc0df15fb1
+  data.tar.gz: b38cc0a266ca7aea7ff3bef2e5532c99b92cf4fe5a6cacd2ddd48d98f61451ae
 SHA512:
-  metadata.gz: e56af8baca9f1278d41f9efa9acc8a4cd7fed0736592f875415874078a341bfbbf9c1563daa0f7bc7c2b8eeb1c4f683ad19b1c74ac27903ec6c4af73344bbddb
-  data.tar.gz: 8ac03e855c3f425857aa9fee828c637a7368cff1af1ce82ef167d3b111f74d37dc3b0d3a42d279c517a51a3ccac7dbcdf7ad7bc41d626d3eb8cd08172644707b
+  metadata.gz: 8676f6ed6c9ad75d9fa713139e825a3f3fb3e757a8b5d416995b8989b160a32e2c16f2ecb1b3b79d32f12bcc325073be42bfeb867bdb47f314c53f1444e22bae
+  data.tar.gz: 1cc2874f4963d361c6e756a314508787baf7fafc0a5175c9174a6b4efc5dcd89e469f1f89c855d302e6d4e14cc36e2f954aea6c9c74e491e34d7a2985b4860ce

data/lib/libclimate/climate.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/libclimate/climate.rb
+# File:     lib/libclimate/climate.rb
 #
-# Purpose:      Definition of the ::LibCLImate::Climate class
+# Purpose:  Definition of the ::LibCLImate::Climate class
 #
-# Created:      13th July 2015
-# Updated:      24th July 2022
+# Created:  13th July 2015
+# Updated:  10th August 2024
 #
-# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+# Home:     http://github.com/synesissoftware/libCLImate.Ruby
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
-# Copyright (c) 2019-2022, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -144,7 +144,7 @@ module LibCLImate
 #
 #   program_options = {}
 #
-#   climate = LibCLImate::Climate.new do |cl|
+#   climate = LibCLImate::Climate.new(value_attributes: true)  do |cl|
 #
 #     cl.add_flag('--verbose', alias: '-v', help: 'Makes program output verbose') { program_options[:verbose] = true }
 #
@@ -153,8 +153,9 @@ module LibCLImate
 #       program_options[:flavour] = check_flavour(o.value) or cl.abort "Invalid flavour '#{o.value}'; use --help for usage"
 #     end
 #
-#     cl.usage_values = '<value-1> [ ... <value-N> ]'
-#     cl.constrain_values = 1..100000
+#     cl.usage_values = '<source-path> [ <destination-path> ]'
+#     cl.constrain_values = 1..2
+#     cl.value_names = %w{ source-path destination-path }
 #
 #     cl.info_lines = [
 #
@@ -164,6 +165,10 @@ module LibCLImate
 #     ]
 #   end
 #
+#   r = climate.run ARGV
+#
+#   puts "copying from '#{r.source_path}' to '#{r.destination_path || '.'}'"
+#
 class Climate
 
 	include ::Xqsr3::Quality::ParameterChecking
@@ -789,6 +794,7 @@ class Climate
 	#   - +:no_help_flag+ (boolean) Prevents the use of the +CLASP::Flag.Help+ flag-specification
 	#   - +:no_version_flag+ (boolean) Prevents the use of the +CLASP::Flag.Version+ flag-specification
 	#   - +:program_name+ (::String) An explicit program-name, which is inferred from +$0+ if this is +nil+
+	#   - +:value_attributes+ (boolean) Causes any possible value-names, as described in `#value_names`, to be applied as attributes with the given values, if any, on the command-line
 	#   - +:version+ (String, [Integer], [String]) A version specification. If not specified, this is inferred
 	#   - +:version_context+ Object or class that defines a context for searching the version. Ignored if +:version+ is specified
 	#
@@ -830,6 +836,8 @@ class Climate
 		version_context		=	options[:version_context]
 		@version			=	options[:version] || infer_version_(version_context)
 
+		@value_attributes	=	options[:value_attributes]
+
 		unless options[:no_help_flag]
 
 			f	=	CLASP::Flag.Help()
@@ -929,7 +937,7 @@ class Climate
 	#
 	# === Returns
 	# (ParseResults) Results
-	def parse(argv = ARGV) # :yields: ParseResults
+	def parse(argv = ARGV, **options) # :yields: ParseResults
 
 		raise ArgumentError, "argv may not be nil" if argv.nil?
 
@@ -957,7 +965,7 @@ class Climate
 	# (ParseResults) Results
 	def parse_and_verify(argv = ARGV, **options) # :yields: ParseResults
 
-		r = parse argv
+		r = parse argv, **options
 
 		r.verify(**options)
 
@@ -976,17 +984,17 @@ class Climate
 	# an instance of a type derived from +::Hash+ with the additional
 	# attributes +flags+, +options+, +values+, +double_slash_index+ and
 	# +argv+.
-	def run(argv = ARGV) # :yields: customised +::Hash+
+	def run(argv = ARGV, **options) # :yields: customised +::Hash+
 
 		raise ArgumentError, "argv may not be nil" if argv.nil?
 
 		arguments = CLASP::Arguments.new argv, specifications
 
-		run_ argv, arguments
+		run_ argv, arguments, **options
 	end
 
 	private
-	def run_(argv, arguments) # :nodoc:
+	def run_(argv, arguments, **opts) # :nodoc:
 
 		flags		=	arguments.flags
 		options		=	arguments.options
@@ -1154,6 +1162,31 @@ class Climate
 			argv
 		end
 
+
+		if opts[:value_attributes] || @value_attributes
+
+		  (value_names || []).each_with_index do |name, index|
+
+			name = name.gsub(/-/, '_').to_sym
+
+			if results.respond_to? name
+
+			  warn "cannot create attribute `#{name}` on instance of `#{results.class}` because that name is already used"
+			else
+
+			  value = results.values[index]
+
+			  results.define_singleton_method(name) do
+
+				value
+			  end
+			end
+		  end
+		end
+
+
+		results.freeze
+
 		results
 	end
 	public
@@ -1396,6 +1429,7 @@ class Climate
 end # class Climate
 end # module LibCLImate
 
+
 # ############################## end of file ############################# #
 
 

data/lib/libclimate/libclimate.rb

@@ -1,14 +1,14 @@
 # ######################################################################## #
-# File:         libclimate/libclimate.rb
+# File:     libclimate/libclimate.rb
 #
-# Purpose:      Main file for libclimate.Ruby library
+# Purpose:  Main file for libclimate.Ruby library
 #
-# Created:      13th July 2015
-# Updated:      13th April 2019
+# Created:  13th July 2015
+# Updated:  10th August 2024
 #
-# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+# Home:     http://github.com/synesissoftware/libCLImate.Ruby
 #
-# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2024, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -50,6 +50,7 @@ require 'libclimate/version'
 module LibCLImate
 end # module LibCLImate
 
+
 # ############################## end of file ############################# #
 
 

data/lib/libclimate/version.rb

@@ -1,14 +1,14 @@
 # ######################################################################## #
-# File:         libclimate/version.rb
+# File:     libclimate/version.rb
 #
-# Purpose:      Version for libclimate.Ruby library
+# Purpose:  Version for libclimate.Ruby library
 #
-# Created:      13th July 2015
-# Updated:      1st December 2023
+# Created:  13th July 2015
+# Updated:  10th August 2024
 #
-# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+# Home:     http://github.com/synesissoftware/libCLImate.Ruby
 #
-# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -44,7 +44,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.16.0.1'
+	VERSION					=	'0.17.0'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
@@ -55,9 +55,9 @@ module LibCLImate
 	VERSION_MINOR			=	VERSION_PARTS_[1] # :nodoc:
 	# # Revision version of the libCLImate.Ruby library
 	VERSION_REVISION		=	VERSION_PARTS_[2] # :nodoc:
-
 end # module LibCLImate
 
+
 # ############################## end of file ############################# #
 
 

data/test/unit/tc_values.rb

@@ -92,7 +92,7 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 		stdout	=	StringIO.new
 		stderr	=	StringIO.new
 
-		climate = LibCLImate::Climate.new do |cl|
+		climate = LibCLImate::Climate.new(value_attributes: true) do |cl|
 
 			cl.exit_on_missing	=	false
 
@@ -129,6 +129,67 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 		assert_equal 2, r.values.size
 		assert_empty stdout.string
 		assert_empty stderr.string
+		assert r.respond_to? :input_path
+		assert r.respond_to? :output_path
+
+		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
+		assert_match /wrong number of values.*3 given.*2 required.*/, stderr.string
+	end
+
+	def test_constrain_with_integer_and_names_2
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		climate = LibCLImate::Climate.new(value_attributes: true) do |cl|
+
+			cl.exit_on_missing	=	false
+
+			cl.stdout	=	stdout
+			cl.stderr	=	stderr
+
+			cl.constrain_values = 1..2
+			cl.value_names = [
+
+				'input-path',
+				'output-path',
+			]
+		end
+
+		stdout.string = ''
+		stderr.string = ''
+		r = climate.run [ ]
+		assert_equal 0, r.values.size
+		assert_empty stdout.string
+		assert_not_empty stderr.string
+		assert_match /input-path not specified.*#{climate.usage_help_suffix}/, 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
+		assert r.respond_to? :input_path
+		assert r.respond_to? :output_path
+		assert_equal 'value-1', r.input_path
+		  assert_nil r.output_path
+
+		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
+		assert r.respond_to? :input_path
+		assert r.respond_to? :output_path
+		assert_equal 'value-1', r.input_path
+		assert_equal 'value-2', r.output_path
 
 		stdout.string = ''
 		stderr.string = ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.16.0.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,26 +27,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0.2
 - !ruby/object:Gem::Dependency
   name: xqsr3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.37'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.37.3
+        version: '0.39'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.37'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.37.3
+        version: '0.39'
 description: |
   libCLImate is a portable, lightweight mini-framework that encapsulates the common aspects of Command-Line Interface boilerplate, including: