libclimate-ruby 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d55c53e5b2ddc3f8726d800b40b4d3b314abf8c5
-  data.tar.gz: 8846d76a971949a876c3ef83c6c022d41e6435d6
+  metadata.gz: 81a934726e041f8d8de3c7b1d74eee4f331320ca
+  data.tar.gz: d6d9d783ff08b0db0bfc25842ee76ac8dd263062
 SHA512:
-  metadata.gz: 56e9b36042061363132ed2a8464c965947b472a484a4fb3831e482b7ae64bc9de4833713cd624fbea76744eff4001840334fe4b3735806526e6dc22cc76c451d
-  data.tar.gz: 5ea0e2a5fa012615cb101d77047ac2c373e3fa96e395e7b45000f58f00cec22ce0ddc695095c15ada8774daedfc61d61211adb0256464dde0d2b3aac959480ec
+  metadata.gz: 22e38caf3b72cdaedc405ee5c36f84aadce0de9fa7e9c3dc3819037d880513f3a48af59254ebe67a4d631a9218fae4c33387155ed1857b4e88fd767edb16909c
+  data.tar.gz: 5b4592c4bee450fbdae5b1b074e05812e04fbc28226f0bfc354c3a1680b39b7f1053cccf206160c596bf6913a2977bb93ae8964f4b4f24c4176ad36af6feb6fd

data/lib/libclimate/climate.rb

@@ -5,7 +5,7 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      14th June 2016
+# Updated:      17th June 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -42,6 +42,7 @@
 
 require 'clasp'
 require 'xqsr3/extensions/io'
+require 'xqsr3/quality/parameter_checking'
 
 if !defined? Colcon
 
@@ -292,13 +293,18 @@ class Climate
 				results[:flags][selector] << f
 			else
 
-				message = "#{program_name}: unrecognised flag '#{f}'; use --help for usage"
+				message = "unrecognised flag '#{f}'; use --help for usage"
 
 				if exit_on_unknown
 
-					abort message
+					self.abort message
 				else
 
+					if program_name && !program_name.empty?
+
+						message = "#{program_name}: #{message}"
+					end
+
 					stderr.puts message
 				end
 
@@ -343,13 +349,18 @@ class Climate
 				results[:options][selector] << o
 			else
 
-				message = "#{program_name}: unrecognised option '#{o}'; use --help for usage"
+				message = "unrecognised option '#{o}'; use --help for usage"
 
 				if exit_on_unknown
 
-					abort message
+					self.abort message
 				else
 
+					if program_name && !program_name.empty?
+
+						message = "#{program_name}: #{message}"
+					end
+
 					stderr.puts message
 				end
 
@@ -417,6 +428,54 @@ class Climate
 
 		msg
 	end
+
+	# Adds a flag to +aliases+
+	#
+	# === Signature
+	#
+	# * *Parameters*
+	#   - +name+:: The flag name
+	#   - +options+:: An options hash, containing any of the following options.
+	#
+	# * *Options*
+	#   - +:help+:: 
+	#   - +:alias+:: 
+	#   - +:aliases+:: 
+	#   - +:extras+:: 
+	def add_flag(name, options={})
+
+		aliases << CLASP.Flag(name, **options)
+	end
+
+	#
+	# * *Options*
+	#   - +:alias+:: 
+	#   - +:aliases+:: 
+	#   - +:help+:: 
+	#   - +:values_range+:: 
+	#   - +:default_value+:: 
+	#   - +:extras+:: 
+	def add_option(name, options={})
+
+		aliases << CLASP.Option(name, **options)
+	end
+
+	# Adds a flag to +aliases+
+	#
+	# === Signature
+	#
+	# * *Parameters*
+	#   - +name+:: The flag name
+	#   - +options+:: An options hash, containing any of the following options.
+	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?
+
+		klass = CLASP.Option
+
+		self.aliases << klass(name, aliases: aliases)
+	end
 end # class Climate
 
 end # module LibCLImate

data/lib/libclimate/version.rb

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

data/test/unit/tc_minimal.rb

@@ -223,8 +223,8 @@ class Test_Climate_minimal < Test::Unit::TestCase
 
 			bl = false#proc { is_verbose = true }
 
-			climate.aliases << CLASP.Flag('--succinct', alias: '-s', help: 'operates succinctly')
-			climate.aliases << CLASP.Flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => 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 }})
 		end
 
 		argv = %w{ --help --verbose --succinct }
@@ -281,7 +281,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 			climate.stdout = str
 			climate.exit_on_usage = false
 
-			climate.aliases << CLASP.Flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
+			climate.add_flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
 		end
 
 		argv = %w{ --verbose }
@@ -325,7 +325,7 @@ class Test_Climate_minimal < Test::Unit::TestCase
 			climate.stdout = str
 			climate.exit_on_usage = false
 
-			climate.aliases << CLASP.Option('--verbosity', alias: '-v', help: 'determines level of verbose operation', extras: { handle: proc { |o| verbosity = o.value }})
+			climate.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_minimal_clasp.rb

@@ -0,0 +1,363 @@
+#!/usr/bin/ruby
+#
+# test simple scenarios
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_minimal_CLASP < Test::Unit::TestCase
+
+	def test_no_arguments_no_mods
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			;
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+	end
+
+	def test_no_arguments_set_streams
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.stdout = $stdout
+			climate.stderr = $stderr
+		end
+
+		assert $stdout.equal? climate.stdout
+		assert $stderr.equal? climate.stderr
+	end
+
+	def test_help_to_string
+
+		str = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name = 'program'
+			climate.stdout = str
+			climate.exit_on_usage = false
+		end
+
+		argv = %w{ --help }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert_equal 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 1, r[:flags][:given].size
+		assert_equal 1, r[:flags][:handled].size
+		assert_equal 0, 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
+
+		lines	=	str.string.split(/\n/)
+		lines	=	lines.reject { |line| line.chomp.strip.empty? }
+		lines	=	lines.map { |line| line.chomp.strip }
+
+		assert_equal 6, lines.size
+		assert_equal "USAGE: program [ ... flags and options ... ]", lines[0]
+		assert_equal "flags/options:", lines[1]
+		assert_equal "--help", lines[2]
+		assert_equal "shows this help and terminates", lines[3]
+		assert_equal "--version", lines[4]
+		assert_equal "shows version and terminates", lines[5]
+	end
+
+	def test_help_to_string_with_info_line
+
+		str = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name = 'program'
+			climate.info_lines = 'Synesis Software Open Source'
+			climate.stdout = str
+			climate.exit_on_usage = false
+		end
+
+		argv = %w{ --help }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert_equal 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 1, r[:flags][:given].size
+		assert_equal 1, r[:flags][:handled].size
+		assert_equal 0, 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
+
+		lines	=	str.string.split(/\n/)
+		lines	=	lines.reject { |line| line.chomp.strip.empty? }
+		lines	=	lines.map { |line| line.chomp.strip }
+
+		assert_equal 7, lines.size
+		index = -1
+		assert_equal 'Synesis Software Open Source', lines[index += 1]
+		assert_equal "USAGE: program [ ... flags and options ... ]", lines[index += 1]
+		assert_equal "flags/options:", lines[index += 1]
+		assert_equal "--help", lines[index += 1]
+		assert_equal "shows this help and terminates", lines[index += 1]
+		assert_equal "--version", lines[index += 1]
+		assert_equal "shows version and terminates", lines[index += 1]
+	end
+
+	def test_version_to_string
+
+		str = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name = 'program'
+			climate.version = [ 1, 2, 3, 4 ]
+			climate.stdout = str
+			climate.exit_on_usage = false
+		end
+
+		argv = %w{ --version }
+
+		climate.run argv
+
+		lines	=	str.string.split(/\n/)
+		lines	=	lines.reject { |line| line.chomp.strip.empty? }
+		lines	=	lines.map { |line| line.chomp.strip }
+
+		assert_equal 1, lines.size
+		assert_equal "program 1.2.3.4", lines[0]
+	end
+
+	def test_unrecognised_flag
+
+		strout = StringIO.new
+		strerr = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'program'
+			climate.stdout			=	strout
+			climate.stderr			=	strerr
+			climate.exit_on_unknown	=	false
+		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'; use --help for usage", lines_err[0]
+	end
+
+	def test_unrecognised_option
+
+		strout = StringIO.new
+		strerr = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'program'
+			climate.stdout			=	strout
+			climate.stderr			=	strerr
+			climate.exit_on_unknown	=	false
+		end
+
+		argv = %w{ --unknown=10 }
+
+		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 option '--unknown=10'; use --help for usage", lines_err[0]
+	end
+
+	def test_one_custom_flag_help_to_string
+
+		str = StringIO.new
+
+		is_verbose = false
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name = 'program'
+			climate.stdout = str
+			climate.exit_on_usage = false
+
+			bl = false#proc { is_verbose = true }
+
+			climate.aliases << CLASP.Flag('--succinct', alias: '-s', help: 'operates succinctly')
+			climate.aliases << CLASP.Flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { :handle => proc { is_verbose = true }})
+		end
+
+		argv = %w{ --help --verbose --succinct }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert_equal 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 3, r[:flags][:given].size
+		assert_equal 2, r[:flags][:handled].size
+		assert_equal 1, 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_equal 0, r.values.size
+		lines	=	str.string.split(/\n/)
+		lines	=	lines.reject { |line| line.chomp.strip.empty? }
+		lines	=	lines.map { |line| line.chomp.strip }
+
+		assert_equal 12, lines.size
+		index = -1
+		assert_equal "USAGE: program [ ... flags and options ... ]", lines[index += 1]
+		assert_equal "flags/options:", lines[index += 1]
+		assert_equal "--help", lines[index += 1]
+		assert_equal "shows this help and terminates", lines[index += 1]
+		assert_equal "--version", lines[index += 1]
+		assert_equal "shows version and terminates", lines[index += 1]
+		assert_equal "-s", lines[index += 1]
+		assert_equal "--succinct", lines[index += 1]
+		assert_equal "operates succinctly", lines[index += 1]
+		assert_equal "-v", lines[index += 1]
+		assert_equal "--verbose", lines[index += 1]
+		assert_equal "operates verbosely", lines[index += 1]
+	end
+
+	def test_one_custom_flag_with_select
+
+		str = StringIO.new
+
+		is_verbose = false
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name = 'program'
+			climate.stdout = str
+			climate.exit_on_usage = false
+
+			climate.aliases << CLASP.Flag('--verbose', alias: '-v', help: 'operates verbosely', extras: { handle: proc { is_verbose = true }})
+		end
+
+		argv = %w{ --verbose }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert_equal 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 1, r[:flags][:given].size
+		assert_equal 1, r[:flags][:handled].size
+		assert_equal 0, 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
+		lines	=	str.string.split(/\n/)
+		lines	=	lines.reject { |line| line.chomp.strip.empty? }
+		lines	=	lines.map { |line| line.chomp.strip }
+
+		assert_equal 0, lines.size
+		assert is_verbose, "is_verbose not altered"
+	end
+
+	def test_one_custom_option_with_select
+
+		str = StringIO.new
+
+		verbosity = 1
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name = 'program'
+			climate.stdout = str
+			climate.exit_on_usage = false
+
+			climate.aliases << CLASP.Option('--verbosity', alias: '-v', help: 'determines level of verbose operation', extras: { handle: proc { |o| verbosity = o.value }})
+		end
+
+		argv = %w{ -v 2 }
+
+		r = climate.run argv
+
+		assert_not_nil r
+		assert_kind_of ::Hash, r
+		assert_equal 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 0, r[:flags][:given].size
+		assert_equal 0, r[:flags][:handled].size
+		assert_equal 0, r[:flags][:unhandled].size
+		assert_equal 0, r[:flags][:unknown].size
+		assert_equal 4, r[:options].size
+		assert_equal 1, r[:options][:given].size
+		assert_equal 1, r[:options][:handled].size
+		assert_equal 0, r[:options][:unhandled].size
+		assert_equal 0, r[:options][:unknown].size
+		assert_equal 0, r[:values].size
+		lines	=	str.string.split(/\n/)
+		lines	=	lines.reject { |line| line.chomp.strip.empty? }
+		lines	=	lines.map { |line| line.chomp.strip }
+
+		assert_equal 0, lines.size
+		assert_equal '2', verbosity
+	end
+end
+
+# ############################## end of file ############################# #
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-14 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -57,18 +57,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/libclimate.rb
 - lib/libclimate/climate.rb
 - lib/libclimate/libclimate.rb
 - lib/libclimate/version.rb
-- lib/libclimate.rb
 - test/scratch/blankzeroes.rb
 - test/unit/tc_abort.rb
 - test/unit/tc_minimal.rb
+- test/unit/tc_minimal_clasp.rb
 - test/unit/tc_test_aliases.rb
 - test/unit/tc_with_blocks.rb
 - test/unit/ts_all.rb
-- README.md
-- LICENSE
 homepage: http://www.libclimate.org/
 licenses:
 - Modified BSD
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: libCLImate.Ruby