libclimate-ruby 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02794e536b229ccb6f52ec08d7899389dd749dab
+  data.tar.gz: 28d0b8f7d6243ed083c8cfd85e1f7536bca6b7c5
+SHA512:
+  metadata.gz: f6778014e31bfa9ce3024a4e09fdc59197091fd65ef85c75928ecda9cc0b4f5d67cd681b91f1e801f4d9a7a5f2dcbcd5807bfafc2bd4f39bf218ee8af6290d0c
+  data.tar.gz: 3d165c6a9f529123f3816bd719ce5dcd1bf9da583cdb9cc81c51aab89cbfef4e503e4de8611919e7e2cd8ef2131a66aa18808175e833307a1afc58ee26a5bfa3

data/LICENSE

@@ -0,0 +1,30 @@
+libCLImate.Ruby
+
+Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the names of libCLImate or libCLImate.Ruby nor the names of the
+  copyright holder nor the names of its contributors may be used to endorse or
+  promote products derived from this software without specific prior written
+  permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,26 @@
+# libCLImate.Ruby
+libCLImate for Ruby
+
+## Installation & usage
+
+Install using `gem install libclimate-ruby` or add it to your `Gemfile`.
+
+## Description
+
+TODO
+
+## Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/libCLImate.Ruby "GitHub Page")
+
+## Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/libCLImate.Ruby.
+
+## Related projects
+
+**libCLImate.Ruby** uses the **[clasp.Ruby](https://github.com/synesissoftware/clasp.Ruby)** and **[xqsr3](https://github.com/synesissoftware/xqsr3)** libraries.
+
+## License
+
+**libCLImate.Ruby** is released under the 3-clause BSD license. See LICENSE for details.

data/lib/libclimate.rb

@@ -0,0 +1,43 @@
+# ######################################################################## #
+# File:         libclimate.rb
+#
+# Purpose:      Top-level include for libclimate.Ruby library
+#
+# Created:      13th July 2015
+# Updated:      14th May 2016
+#
+# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+#
+# Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+require 'libclimate/libclimate'
+
+# ############################## end of file ############################# #
+

data/lib/libclimate/climate.rb

@@ -0,0 +1,251 @@
+
+# ######################################################################## #
+# File:         lib/libclimate/climate.rb
+#
+# Purpose:      Definition of the ::LibCLImate::Climate class
+#
+# Created:      13th July 2015
+# Updated:      11th June 2016
+#
+# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+require 'clasp'
+require 'xqsr3/extensions/io'
+
+if !defined? Colcon
+
+	begin
+
+		require 'colcon'
+	rescue LoadError => x
+
+		warn "could not load colcon library" if $DEBUG
+	end
+end
+
+module LibCLImate
+
+class Climate
+
+  private
+	def show_usage_
+
+		options	=	{}
+		options.merge! stream: stdout, program_name: program_name, version: version, exit: exit_on_usage ? 0 : nil
+		options[:info_lines] = info_lines if info_lines
+		options[:values] = usage_values if usage_values
+
+		CLASP.show_usage aliases, options
+	end
+
+	def show_version_
+
+		CLASP.show_version aliases, stream: stdout, program_name: program_name, version: version, exit: exit_on_usage ? 0 : nil
+	end
+
+  public
+	def initialize(options={})
+
+		options ||=	{}
+
+		program_name = File.basename($0)
+		program_name = (program_name =~ /\.rb$/) ? "#$`(#$&)" : program_name
+
+		if defined? Colcon
+
+			program_name = "#{::Colcon::Decorations::Bold}#{program_name}#{::Colcon::Decorations::Unbold}"
+		end
+
+		@aliases			=	[]
+		@exit_on_unknown	=	true
+		@exit_on_usage		=	true
+		@info_lines			=	nil
+		@program_name		=	program_name
+		@stdout				=	$stdout
+		@stderr				=	$stderr
+		@usage_values		=	usage_values
+		@version			=	[]
+
+		@aliases << CLASP::Flag.Help(handle: proc { show_usage_ }) unless options[:no_help_flag]
+		@aliases << CLASP::Flag.Version(handle: proc { show_version_ }) unless options[:no_version_flag]
+
+		raise ArgumentError, "block is required" unless block_given?
+
+		yield self
+	end
+
+	attr_accessor :aliases
+	attr_accessor :exit_on_unknown
+	attr_accessor :exit_on_usage
+	attr_accessor :info_lines
+	attr_accessor :program_name
+	attr_accessor :stdout
+	attr_accessor :stderr
+	attr_accessor :usage_values
+	attr_accessor :version
+
+	def run argv = ARGV
+
+		raise ArgumentError, "argv may not be nil" if argv.nil?
+
+		arguments	=	CLASP::Arguments.new argv, aliases
+		flags		=	arguments.flags
+		options		=	arguments.options
+		values		=	arguments.values.to_a
+
+		results		=	{
+
+			flags: {
+
+				given:		flags,
+				handled:	[],
+				unhandled:	[],
+				unknown:	[]
+			},
+
+			options: {
+
+				given:		options,
+				handled:	[],
+				unhandled:	[],
+				unknown:	[]
+			},
+
+			values:	values
+		}
+
+		flags.each do |f|
+
+			al = aliases.detect do |a|
+
+				a.kind_of?(::CLASP::Flag) && f.name == a.name
+			end
+
+			if al
+
+				selector	=	:unhandled
+
+				ex = f.extras
+
+				case f.extras
+				when ::Hash
+					if f.extras.has_key? :handle
+
+						f.extras[:handle].call(f, al)
+
+						selector = :handled
+					end
+				end
+
+				results[:flags][selector] << f
+			else
+
+				message = "#{program_name}: unrecognised flag '#{f}'; use --help for usage"
+
+				if exit_on_unknown
+
+					abort message
+				else
+
+					stderr.puts message
+				end
+
+				results[:flags][:unknown] << f
+			end
+		end
+
+		options.each do |o|
+
+			al = aliases.detect do |a|
+
+				a.kind_of?(::CLASP::Option) && o.name == a.name
+			end
+
+			if al
+
+				selector	=	:unhandled
+
+				ex = al.extras
+
+				case ex
+				when ::Hash
+					if ex.has_key? :handle
+
+						ex[:handle].call(o, al)
+
+						selector = :handled
+					end
+				end
+
+				results[:options][selector] << o
+			else
+
+				message = "#{program_name}: unrecognised option '#{o}'; use --help for usage"
+
+				if exit_on_unknown
+
+					abort message
+				else
+
+					stderr.puts message
+				end
+
+				results[:options][:unknown] << o
+			end
+		end
+
+		def results.flags
+
+			self[:flags]
+		end
+
+		def results.options
+
+			self[:options]
+		end
+
+		def results.values
+
+			self[:values]
+		end
+
+		results
+	end
+end # class Climate
+
+end # module LibCLImate
+
+# ############################## end of file ############################# #
+
+

data/lib/libclimate/libclimate.rb

@@ -0,0 +1,50 @@
+# ######################################################################## #
+# File:         libclimate/libclimate.rb
+#
+# Purpose:      Main file for libclimate.Ruby library
+#
+# Created:      13th July 2015
+# Updated:      14th May 2016
+#
+# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+#
+# Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+require 'libclimate/climate'
+require 'libclimate/version'
+
+module LibCLImate
+
+
+end # module LibCLImate
+
+# ############################## end of file ############################# #
+
+

data/lib/libclimate/version.rb

@@ -0,0 +1,61 @@
+# ######################################################################## #
+# File:         libclimate/version.rb
+#
+# Purpose:      Version for libclimate.Ruby library
+#
+# Created:      13th July 2015
+# Updated:      11th June 2016
+#
+# Home:         http://github.com/synesissoftware/libCLImate.Ruby
+#
+# Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+# Main module for libCLImate.Ruby library
+module LibCLImate
+
+	# Current version of the libCLImate.Ruby library
+	VERSION					=	'0.2.3'
+
+	private
+	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+	public
+	# Major version of the libCLImate.Ruby library
+	VERSION_MAJOR			=	VERSION_PARTS_[0] # :nodoc:
+	# # Minor version of the libCLImate.Ruby library
+	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/scratch/blankzeroes.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+
+#############################################################################
+# File:         test/scratch/blankzeroes.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      14 05 2016
+# Updated:      14 05 2016
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+# ##########################################################
+# constants
+
+PROGRAM_VER_MAJOR               =   0
+PROGRAM_VER_MINOR               =   1
+PROGRAM_VER_REVISION            =   2
+
+# ##########################################################
+# command-line parsing
+
+LibCLImate::Climate.new do |climate|
+
+	climate.version = [ PROGRAM_VER_MAJOR, PROGRAM_VER_MINOR, PROGRAM_VER_REVISION ]
+end.run
+
+# ##########################################################
+# main
+
+$<.each_line do |line|
+
+	puts line.split(/\t/).map { |s| '0' == s ? '' : s }.join("\t")
+end
+
+# ############################## end of file ############################# #
+

data/test/unit/tc_minimal.rb

@@ -0,0 +1,363 @@
+#!/usr/bin/ruby
+#
+# test minimal uses
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_minimal < 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 ############################# #
+
+

data/test/unit/tc_test_aliases.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby
+#
+# test complex scenarios
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_minimal < Test::Unit::TestCase
+
+	def test_option_with_flag_aliases
+
+		options	=	{}
+
+		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 } })
+		end
+
+		# invoke via option
+		begin
+			options = {}
+
+			argv = %w{ --action=action1 }
+
+			r = climate.run argv
+
+			assert_not_nil r
+			assert_kind_of ::Hash, r
+			assert_equal 3, r.size
+			assert_equal 0, r.flags[:given].size
+
+			assert_equal 1, options.size
+			assert_not_nil options[:action]
+			assert_equal 'action1', options[:action]
+		end
+
+		# invoke via option alias
+		begin
+			options = {}
+
+			argv = %w{ -a action2 }
+
+			r = climate.run argv
+
+			assert_equal 1, options.size
+			assert_not_nil options[:action]
+			assert_equal 'action2', options[:action]
+		end
+
+		# invoke via flag alias
+		begin
+			options = {}
+
+			argv = %w{ -c }
+
+			r = climate.run argv
+
+			assert_equal 1, options.size
+			assert_not_nil options[:action]
+			assert_equal 'change', options[:action]
+		end
+
+		# invoke via flag alias
+		begin
+			options = {}
+
+			argv = %w{ -l }
+
+			r = climate.run argv
+
+			assert_equal 1, options.size
+			assert_not_nil options[:action]
+			assert_equal 'list', options[:action]
+		end
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/ts_all.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby
+#
+# executes all other tests
+
+this_file   =   File.expand_path(__FILE__)
+this_dir    =   File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: libclimate-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clasp-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: xqsr3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2+
+
+email: matthew@synesis.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/libclimate.rb
+- lib/libclimate/climate.rb
+- lib/libclimate/libclimate.rb
+- lib/libclimate/version.rb
+- test/scratch/blankzeroes.rb
+- test/unit/tc_minimal.rb
+- test/unit/tc_test_aliases.rb
+- test/unit/ts_all.rb
+homepage: http://www.libclimate.org/
+licenses:
+- Modified BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: libCLImate.Ruby
+test_files: []