libclimate-ruby 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ddeb7a8f3fbcbe387ff00dc9c0413a2921a1573
-  data.tar.gz: 205642b3c90c1c34685163a87534b496e10b1e97
+  metadata.gz: d55c53e5b2ddc3f8726d800b40b4d3b314abf8c5
+  data.tar.gz: 8846d76a971949a876c3ef83c6c022d41e6435d6
 SHA512:
-  metadata.gz: 9fa38dafe06b342668e826492f9219904833f1e0a91feb11754f8731187bf42106fcad467ec08c7b8d360fb6ddeb4c9cf68c1bd63ba69aa54a206126a79c1a79
-  data.tar.gz: 3c8de16fba64582e4d4fc9ec9bf121c924de7b3a736972c413f2e28b86c47446bd9154daed06658e5d303e6c3f4c1946e66b57aebad730fac5e3809766d130cf
+  metadata.gz: 56e9b36042061363132ed2a8464c965947b472a484a4fb3831e482b7ae64bc9de4833713cd624fbea76744eff4001840334fe4b3735806526e6dc22cc76c451d
+  data.tar.gz: 5ea0e2a5fa012615cb101d77047ac2c373e3fa96e395e7b45000f58f00cec22ce0ddc695095c15ada8774daedfc61d61211adb0256464dde0d2b3aac959480ec

data/lib/libclimate/climate.rb

@@ -5,7 +5,7 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      13th June 2016
+# Updated:      14th June 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -217,6 +217,14 @@ class Climate
 	attr_accessor :version
 
 	# Executes the prepared Climate instance
+	#
+	# == Signature
+	#
+	# * *Parameters*:
+	#   - +argv+:: The array of arguments; defaults to <tt>ARGV</tt>
+	#
+	# * *Returns*:
+	#
 	def run argv = ARGV
 
 		raise ArgumentError, "argv may not be nil" if argv.nil?
@@ -318,6 +326,7 @@ class Climate
 
 					selector = :handled
 				else
+
 					ex = al.extras
 
 					case ex
@@ -365,6 +374,49 @@ class Climate
 
 		results
 	end
+
+	# Calls abort() with the given message prefixed by the program_name
+	#
+	# === Signature
+	#
+	# * *Parameters*:
+	#   - +message+:: The message string
+	#   - +options+:: An option hash, containing any of the following options
+	#
+	# * *Options*:
+	#   - +:stream+:: {optional} The output stream to use. Defaults to the value of the attribute +stderr+.
+	#   - +:program_name+:: {optional} Uses the given value rather than the +program_name+ attribute; does not prefix if the empty string
+	#   - +:exit+:: {optional} The exit code. Defaults to 1. Does not exit if +nil+ specified.
+	#
+	# * *Return*:
+	#   The combined message string, if <tt>exit()</tt> not called.
+	def abort message, options={}
+
+		prog_name	=	options[:program_name]
+		prog_name	||=	program_name
+		prog_name	||=	''
+
+		stream		=	options[:stream]
+		stream		||=	stderr
+		stream		||=	$stderr
+
+		exit_code	=	options.has_key?(:exit) ? options[:exit] : 1
+
+		if prog_name.empty?
+
+			msg = message
+		else
+
+			msg = "#{prog_name}: #{message}"
+		end
+
+
+		stream.puts msg
+
+		exit(exit_code) if exit_code
+
+		msg
+	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:      13th June 2016
+# Updated:      14th June 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -40,7 +40,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.3.1'
+	VERSION					=	'0.4.1'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_abort.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby
+#
+# test abort
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+
+require 'libclimate'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_Climate_abort < Test::Unit::TestCase
+
+	def test_abort_normal
+
+		strout = StringIO.new
+		strerr = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'myprog'
+			climate.stdout			=	strout
+			climate.stderr			=	strerr
+		end
+
+		s			=	climate.abort 'something happened', exit: nil
+
+		lines_err	=	strerr.string.split /\n/
+
+		assert_equal 'myprog: something happened', s
+
+		assert_equal 1, lines_err.size
+		assert_equal 'myprog: something happened', lines_err[0]
+	end
+
+	def test_abort_no_program_name
+
+		strout = StringIO.new
+		strerr = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'myprog'
+			climate.stdout			=	strout
+			climate.stderr			=	strerr
+		end
+
+		s			=	climate.abort 'something happened', exit: nil, program_name: ''
+
+		lines_err	=	strerr.string.split /\n/
+
+		assert_equal 'something happened', s
+
+		assert_equal 1, lines_err.size
+		assert_equal 'something happened', lines_err[0]
+	end
+
+	def test_abort_custom_program_name
+
+		strout = StringIO.new
+		strerr = StringIO.new
+
+		climate = LibCLImate::Climate.new do |climate|
+
+			climate.program_name	=	'myprog'
+			climate.stdout			=	strout
+			climate.stderr			=	strerr
+		end
+
+		s			=	climate.abort 'something happened', exit: nil, program_name: 'my-prog'
+
+		lines_err	=	strerr.string.split /\n/
+
+		assert_equal 'my-prog: something happened', s
+
+		assert_equal 1, lines_err.size
+		assert_equal 'my-prog: something happened', lines_err[0]
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/tc_minimal.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #
-# test minimal uses
+# test simple scenarios
 
 $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -57,17 +57,18 @@ 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_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
@@ -88,8 +89,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: libCLImate.Ruby
 test_files: []
+has_rdoc: