libclimate-ruby 0.5.4 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27265b86889e0e995ed67a48ac70e0ca19b8ab28
-  data.tar.gz: a2b1dd26135037da92619f215c7a354505b80281
+  metadata.gz: 24a39166bed4017b6995568774ae097912ba87b6
+  data.tar.gz: 8fa2bfc9913468c918e6ebb9d60943de2c4eeeb3
 SHA512:
-  metadata.gz: c3f5ce33c1f5203f5783d1be2f9f4aa1ed276c6766977a792df82a61a230a694adbc00be941cb7813a69231a14aa7e9b98d7ba3b1ef0974b48fbf12b50c4bffa
-  data.tar.gz: efba7a53d812e26f729df04d9cc3a9032d7e74901ad0bace2655c22ead175187ab8f7e198be191d63a47267d5d8d8a820aa6894a3a6b80bd3d7e778dbf634446
+  metadata.gz: 0f870554b875e6cf86197a64425808f1c4b82e5d004bad13408056b2e67abcda35e3d858e21b83551965ba865fa300e2848a5db1544bebb84723e12aa75e80c4
+  data.tar.gz: 3b603573a811bc14318b0d329f751b45aaec215c80d8f84b6a40abe543619e72045d7f487c40191b2e60df6988df1b63887996f51f0ecb0c7e55ebf8f0401910

data/lib/libclimate/climate.rb

@@ -5,13 +5,13 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      18th June 2016
+# Updated:      16th March 2017
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2017, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -147,6 +147,26 @@ class Climate
 
 	def show_version_
 
+		ver = version || []
+
+		if ver.empty?
+
+			if defined? PROGRAM_VER_MAJOR
+
+				ver << PROGRAM_VER_MAJOR
+
+				if defined? PROGRAM_VER_MINOR
+
+					ver << PROGRAM_VER_MINOR
+
+					if defined? PROGRAM_VERSION_REVISION
+
+						ver << PROGRAM_VER_REVISION
+					end
+				end
+			end
+		end
+
 		CLASP.show_version aliases, stream: stdout, program_name: program_name, version: version, exit: exit_on_usage ? 0 : nil
 	end
 
@@ -225,6 +245,8 @@ class Climate
 	#   - +argv+:: The array of arguments; defaults to <tt>ARGV</tt>
 	#
 	# * *Returns*:
+	#   an instance of a type derived from +::Hash+ with the additional
+	#   attributes +flags+, +options+, +values+, and +argv+.
 	#
 	def run argv = ARGV
 
@@ -281,6 +303,7 @@ class Climate
 
 					case ex
 					when ::Hash
+
 						if ex.has_key? :handle
 
 							ex[:handle].call(f, al)
@@ -337,6 +360,7 @@ class Climate
 
 					case ex
 					when ::Hash
+
 						if ex.has_key? :handle
 
 							ex[:handle].call(o, al)
@@ -383,6 +407,11 @@ class Climate
 			self[:values]
 		end
 
+		results.define_singleton_method(:argv) do
+
+			argv
+		end
+
 		results
 	end
 
@@ -444,6 +473,8 @@ class Climate
 	#   - +:extras+:: 
 	def add_flag(name, options={}, &block)
 
+		::Xqsr3::Quality::ParameterChecking.check_parameter name, 'name', allow_nil: false, types: [ ::String, ::Symbol ]
+
 		aliases << CLASP.Flag(name, **options, &block)
 	end
 
@@ -457,6 +488,8 @@ class Climate
 	#   - +:extras+:: 
 	def add_option(name, options={}, &block)
 
+		::Xqsr3::Quality::ParameterChecking.check_parameter name, 'name', allow_nil: false, types: [ ::String, ::Symbol ]
+
 		aliases << CLASP.Option(name, **options, &block)
 	end
 
@@ -465,17 +498,44 @@ class Climate
 	# === Signature
 	#
 	# * *Parameters*
-	#   - +name+:: The flag name
-	#   - +options+:: An options hash, containing any of the following options.
+	#   - +name+:: The flag/option name or the valued option
+	#   - +aliases+:: One or more aliases
+	#
+	# === Examples
+	#
+	# ==== Alias(es) of a flag (single statement)
+	#
+	# +climate.add_flag('--mark-missing', alias: '-x')+
+	#
+	# +climate.add_flag('--absolute-path', aliases: [ '-abs', '-p' ])+
+	#
+	# ==== Alias(es) of a flag (multiple statements)
+	#
+	# +climate.add_flag('--mark-missing')+
+	# +climate.add_alias('--mark-missing', '-x')+
+	#
+	# +climate.add_flag('--absolute-path')+
+	# +climate.add_alias('--absolute-path', '-abs', '-p')+
+	#
+	# ==== Alias(es) of an option (single statement)
+	#
+	# +climate.add_option('--add-patterns', alias: '-p')+
+	#
+	# ==== Alias(es) of an option (multiple statements)
+	#
+	# +climate.add_option('--add-patterns')+
+	# +climate.add_alias('--add-patterns', '-p')+
+	#
+	# ==== Alias of a valued option (which has to be multiple statements)
+	#
+	# +climate.add_option('--verbosity')+
+	# +climate.add_alias('--verbosity=succinct', '-s')+
+	# +climate.add_alias('--verbosity=verbose', '-v')+
 	def add_alias(name, *aliases)
 
 		::Xqsr3::Quality::ParameterChecking.check_parameter name, 'name', allow_nil: false, types: [ ::String, ::Symbol ]
 		raise ArgumentError, "must supply at least one alias" if aliases.empty?
 
-=begin
-		klass = CLASP::Option
-=end
-
 		self.aliases << CLASP.Option(name, aliases: aliases)
 	end
 end # class Climate

data/lib/libclimate/version.rb

@@ -4,7 +4,7 @@
 # Purpose:      Version for libclimate.Ruby library
 #
 # Created:      13th July 2015
-# Updated:      18th June 2016
+# Updated:      5th July 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -40,7 +40,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.5.4'
+	VERSION					=	'0.6.1'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_abort.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # test abort
 
@@ -84,4 +84,3 @@ end
 
 # ############################## end of file ############################# #
 
-

data/test/unit/tc_infer_version.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+#
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+PROGRAM_VER_MAJOR	=	3
+
+class Test_Climate_infer_version_3_22 < Test::Unit::TestCase
+
+	PROGRAM_VER_MINOR	=	22
+
+	def test_inference_of_version
+
+		strout = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'myprog'
+			climate.stdout			=	strout
+		end.run [ 'myprog', '--version' ]
+
+		s = strout.string
+
+		assert_equal "myprog 3.22", s
+	end
+end
+
+class Test_Climate_infer_version_3_2 < Test::Unit::TestCase
+
+	PROGRAM_VER_MINOR		=	2
+	PROGRAM_VER_REVISION	=	99
+
+	def test_inference_of_version
+
+		strout = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'myprog'
+			climate.stdout			=	strout
+		end.run [ 'myprog', '--version' ]
+
+		s = strout.string
+
+		assert_equal "myprog 3.2.99", s
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/tc_minimal.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # test simple scenarios
 
@@ -234,6 +234,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		assert_not_nil r
 		assert_kind_of ::Hash, r
 		assert_equal 3, r.size
+		assert argv.equal? r.argv
 		assert_not_nil r[:flags]
 		assert_not_nil r[:options]
 		assert_not_nil r[:values]
@@ -291,6 +292,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		assert_not_nil r
 		assert_kind_of ::Hash, r
 		assert_equal 3, r.size
+		assert argv.equal? r.argv
 		assert_not_nil r[:flags]
 		assert_not_nil r[:options]
 		assert_not_nil r[:values]
@@ -335,6 +337,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 		assert_not_nil r
 		assert_kind_of ::Hash, r
 		assert_equal 3, r.size
+		assert argv.equal? r.argv
 		assert_not_nil r[:flags]
 		assert_not_nil r[:options]
 		assert_not_nil r[:values]
@@ -360,4 +363,3 @@ end
 
 # ############################## end of file ############################# #
 
-

data/test/unit/tc_minimal_CLASP.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
-# test simple scenarios
+# test simple scenarios (with CLASP)
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 
@@ -360,4 +360,3 @@ end
 
 # ############################## end of file ############################# #
 
-

data/test/unit/tc_test_aliases.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
-# test complex scenarios
+# test aliases
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 
@@ -21,9 +21,9 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 		climate = LibCLImate::Climate.new do |climate|
 
-			climate.aliases << CLASP.Flag('--action=list', alias: '-l')
-			climate.aliases << CLASP.Flag('--action=change', alias: '-c')
-			climate.aliases << CLASP.Option('--action', alias: '-a', extras: { handle: Proc.new { |o, a| options[:action] = o.value } })
+			climate.add_option('--action', alias: '-a') { |o, a| options[:action] = o.value }
+			climate.add_alias('--action=list', '-l')
+			climate.add_alias('--action=change', '-c')
 		end
 
 		# invoke via option
@@ -87,4 +87,3 @@ end
 
 # ############################## end of file ############################# #
 
-

data/test/unit/tc_with_blocks.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
-# test Recls entries
+# test blocks
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 
@@ -50,4 +50,3 @@ end
 
 # ############################## end of file ############################# #
 
-

data/test/unit/tc_with_blocks_CLASP.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
-# test Recls entries
+# test blocks (with CLASP)
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 
@@ -50,4 +50,3 @@ end
 
 # ############################## end of file ############################# #
 
-

data/test/unit/ts_all.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/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.5.4
+  version: 0.6.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-18 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -65,6 +65,7 @@ files:
 - lib/libclimate/version.rb
 - test/scratch/blankzeroes.rb
 - test/unit/tc_abort.rb
+- test/unit/tc_infer_version.rb
 - test/unit/tc_minimal.rb
 - test/unit/tc_minimal_CLASP.rb
 - test/unit/tc_test_aliases.rb