libclimate-ruby 0.14.0 → 0.15.2

data/lib/libclimate/version.rb

@@ -4,11 +4,11 @@
 # Purpose:      Version for libclimate.Ruby library
 #
 # Created:      13th July 2015
-# Updated:      15th April 2019
+# Updated:      26th June 2022
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
-# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2022, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -43,7 +43,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.14.0'
+	VERSION					=	'0.15.2'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_minimal.rb

@@ -250,7 +250,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 			bl = false#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 }})
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely') { is_verbose = true }
 		end
 
 		argv = %w{ --help --verbose --succinct }
@@ -308,7 +308,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 			cl.stdout = str
 			cl.exit_on_usage = false
 
-			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely') { is_verbose = true }
 		end
 
 		argv = %w{ --verbose }
@@ -353,7 +353,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 			cl.stdout = str
 			cl.exit_on_usage = false
 
-			cl.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') { |o| verbosity = o.value }
 		end
 
 		argv = %w{ -v 2 }

data/test/unit/tc_minimal_CLASP.rb

@@ -222,7 +222,7 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 			cl.exit_on_usage = false
 
 			cl.add_flag('--succinct', alias: '-s', help: 'operates succinctly')
-			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => proc { is_verbose = true }})
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely') { is_verbose = true }
 		end
 
 		argv = %w{ --help --verbose --succinct }
@@ -279,7 +279,7 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 			cl.stdout = str
 			cl.exit_on_usage = false
 
-			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
+			cl.add_flag('--verbose', alias: '-v', help: 'operates verbosely') { is_verbose = true }
 		end
 
 		argv = %w{ --verbose }
@@ -323,7 +323,7 @@ class Test_Climate_minimal_CLASP < Test::Unit::TestCase
 			cl.stdout = str
 			cl.exit_on_usage = false
 
-			cl.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') { |o| verbosity = o.value }
 		end
 
 		argv = %w{ -v 2 }

data/test/unit/tc_parse.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/env ruby
+#
+# test version inference
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_parse < Test::Unit::TestCase
+
+	class VerifyException < RuntimeError; end
+
+	class MissingRequiredException < VerifyException; end
+	class UnrecognisedArgumentException < VerifyException; end
+	class UnusedArgumentException < VerifyException; end
+
+	def test_empty_specs_empty_args
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+		]
+
+		r = climate.parse argv
+
+		assert_eql climate, r.climate
+		assert_equal 0, r.flags.size
+		assert_equal 0, r.options.size
+		assert_equal 0, r.values.size
+
+		r.verify()
+	end
+
+	def test_one_flag_with_block
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		debug	=	false
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_flag('--debug', alias: '-d') { debug = true }
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+
+			'-d',
+		]
+
+		r = climate.parse argv
+
+		assert_false debug
+
+		assert_eql climate, r.climate
+		assert_equal 1, r.flags.size
+		assert_equal 0, r.options.size
+		assert_equal 0, r.values.size
+
+		flag0 = r.flags[0]
+
+		assert_equal '-d', flag0.given_name
+		assert_equal '--debug', flag0.name
+
+		r.verify()
+
+		assert_true debug
+	end
+
+	def test_one_option_with_block
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		verb	=	nil
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_option('--verbosity', alias: '-v') do |o, s|
+
+				verb = o.value
+			end
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+
+			'-v',
+			'chatty',
+		]
+
+		r = climate.parse argv
+
+		assert_nil verb
+
+		assert_eql climate, r.climate
+		assert_equal 0, r.flags.size
+		assert_equal 1, r.options.size
+		assert_equal 0, r.values.size
+
+		option0 = r.options[0]
+
+		assert_equal '-v', option0.given_name
+		assert_equal '--verbosity', option0.name
+
+		r.verify()
+
+		assert_equal 'chatty', verb
+	end
+
+	def test_one_required_flag_that_is_missing
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_option('--verbosity', alias: '-v', required: true) do |o, s|
+
+				verb = o.value
+			end
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+		]
+
+		r = climate.parse argv
+
+		assert_eql climate, r.climate
+		assert_equal 0, r.flags.size
+		assert_equal 0, r.options.size
+		assert_equal 0, r.values.size
+
+		assert_raise_with_message(MissingRequiredException, /.*verbosity.*not specified/) { r.verify(raise_on_required: MissingRequiredException) }
+	end
+end
+

data/test/unit/tc_parse_and_verify.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+#
+# test version inference
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_parse_and_verify < Test::Unit::TestCase
+
+	class VerifyException < RuntimeError; end
+
+	class MissingRequiredException < VerifyException; end
+	class UnrecognisedArgumentException < VerifyException; end
+	class UnusedArgumentException < VerifyException; end
+
+	def test_empty_specs_empty_args
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+		]
+
+		r = climate.parse_and_verify argv
+
+		assert_eql climate, r.climate
+		assert_equal 0, r.flags.size
+		assert_equal 0, r.options.size
+		assert_equal 0, r.values.size
+	end
+
+	def test_one_flag_with_block
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		debug	=	false
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_flag('--debug', alias: '-d') { debug = true }
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+
+			'-d',
+		]
+
+		r = climate.parse_and_verify argv
+
+		assert_true debug
+
+		assert_eql climate, r.climate
+		assert_equal 1, r.flags.size
+		assert_equal 0, r.options.size
+		assert_equal 0, r.values.size
+
+		flag0 = r.flags[0]
+
+		assert_equal '-d', flag0.given_name
+		assert_equal '--debug', flag0.name
+	end
+
+	def test_one_option_with_block
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		verb	=	nil
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_option('--verbosity', alias: '-v') do |o, s|
+
+				verb = o.value
+			end
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+
+			'-v',
+			'chatty',
+		]
+
+		r = climate.parse_and_verify argv
+
+		assert_equal 'chatty', verb
+
+		assert_eql climate, r.climate
+		assert_equal 0, r.flags.size
+		assert_equal 1, r.options.size
+		assert_equal 0, r.values.size
+
+		option0 = r.options[0]
+
+		assert_equal '-v', option0.given_name
+		assert_equal '--verbosity', option0.name
+	end
+
+	def test_one_required_flag_that_is_missing
+
+		stdout	=	StringIO.new
+		stderr	=	StringIO.new
+
+		climate = LibCLImate::Climate.new do |cl|
+
+			cl.add_option('--verbosity', alias: '-v', required: true) do |o, s|
+
+				verb = o.value
+			end
+
+			cl.stdout = $stdout
+			cl.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+
+		argv = [
+		]
+
+		assert_raise_with_message(MissingRequiredException, /.*verbosity.*not specified/) do
+
+			climate.parse_and_verify argv, raise_on_required: MissingRequiredException
+		end
+	end
+end
+

data/test/unit/tc_values.rb

@@ -87,6 +87,58 @@ class Test_Climate_values_constraints < Test::Unit::TestCase
 		assert_match /wrong number of values.*3 given.*2 required.*/, stderr.string
 	end
 
+	def test_constrain_with_integer_and_names
+
+		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 = 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_not_empty stderr.string
+		assert_match /output-path not specified.*#{climate.usage_help_suffix}/, stderr.string
+
+		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.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_simple_range
 
 		stdout	=	StringIO.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.2
 platform: ruby
 authors:
 - Matt Wilson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -16,29 +16,49 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.1
 - !ruby/object:Gem::Dependency
   name: xqsr3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '0.37'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
-description: "\n"
+        version: '0.37'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+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: []
@@ -62,16 +82,18 @@ files:
 - test/unit/tc_infer_version.rb
 - test/unit/tc_minimal.rb
 - test/unit/tc_minimal_CLASP.rb
+- test/unit/tc_parse.rb
+- test/unit/tc_parse_and_verify.rb
 - test/unit/tc_test_specifications.rb
 - test/unit/tc_values.rb
 - 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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: libCLImate.Ruby
 test_files: []