libclimate-ruby 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 508db783549ec969fcfaca95ac11cebcbc29a340
-  data.tar.gz: 4cb1d7eb161c1992e94500daded0068a6b018f41
+  metadata.gz: c60a586c2e532a081cd93992f608aca85b9b1503
+  data.tar.gz: a68a322bfaa05bc443c5da8fea1eea5416cb74ca
 SHA512:
-  metadata.gz: beffffe172884c20114e2cb3d705e504f555980393f33ddc246eed5966714b645d0bed9e6a08d6cba6b592782ab215865cfd6178a9a332bfe08364e4d1334df8
-  data.tar.gz: e4a0c48f13a41c88ea2feb1a0b213e31e23dfdb69a503715820eea8d6b835f1352cf0a1aa5909daf632985487f509145940b64201ce9a2601a38c63f54fc63ea
+  metadata.gz: 1471d9e52219711737f689bfbca38bf5591326856d69de60c900f62b71ebd2a99f8fb5db4e192d8b4c76137a09d6bb2eeb55cd4d0e3cd3a9b0cfd741c35615a4
+  data.tar.gz: 2f26a31ae8663e370fc29d4a340b92549f44c9592b4e7fa7c065827792d11fd15c90720b7c77945efc098d2bfa17d574fee2639236c8e4e6d21baf37f3dfdf80

data/lib/libclimate/climate.rb

@@ -5,7 +5,7 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      1st January 2018
+# Updated:      4th February 2018
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -260,20 +260,26 @@ class Climate
 	# * *Options*:
 	#   - +:no_help_flag+:: Prevents the use of the CLASP::Flag.Help flag-alias
 	#   - +:no_version_flag+:: Prevents the use of the CLASP::Version.Help flag-alias
+	#   - +:program_name+:: [ ::String ] An explicit program-name, which is
+	#     inferred from +$0+ if this is +nil+
 	#   - +:version+:: A version specification. If not specified, this is
 	#     inferred
 	#
 	# * *Block*:: An optional block which receives the constructing instance, allowing the user to modify the attributes.
 	def initialize(options={}) # :yields: climate
 
+		check_parameter options, 'options', allow_nil: true, type: ::Hash
+
 		options ||=	{}
 
-		program_name = File.basename($0)
-		program_name = (program_name =~ /\.rb$/) ? "#$`(#$&)" : program_name
+		check_option options, :program_name, type: ::String, allow_nil: true
 
-		if defined? Colcon
+		pr_name		=	options[:program_name]
+
+		unless pr_name
 
-			program_name = "#{::Colcon::Decorations::Bold}#{program_name}#{::Colcon::Decorations::Unbold}"
+			pr_name	=	File.basename($0)
+			pr_name	=	(pr_name =~ /\.rb$/) ? "#$`(#$&)" : pr_name
 		end
 
 		@aliases			=	[]
@@ -281,7 +287,7 @@ class Climate
 		@exit_on_missing	=	true
 		@exit_on_usage		=	true
 		@info_lines			=	nil
-		@program_name		=	program_name
+		set_program_name pr_name
 		@stdout				=	$stdout
 		@stderr				=	$stderr
 		@usage_values		=	usage_values
@@ -294,6 +300,16 @@ class Climate
 		yield self if block_given?
 	end
 
+	def set_program_name name
+
+		if defined? Colcon
+
+			name = "#{::Colcon::Decorations::Bold}#{name}#{::Colcon::Decorations::Unbold}"
+		end
+
+		@program_name	=	name
+	end
+
 	# An array of aliases attached to the climate instance, whose contents should be modified by adding (or removing) CLASP aliases
 	# @return [Array] The aliases
 	attr_reader :aliases
@@ -659,7 +675,7 @@ class Climate
 		check_parameter name, 'name', allow_nil: false, types: [ ::String, ::Symbol ]
 		raise ArgumentError, "must supply at least one alias" if aliases.empty?
 
-		self.aliases << CLASP.Option(name, aliases: aliases)
+		self.aliases << CLASP.Alias(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:      3rd January 2018
+# Updated:      7th February 2018
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -43,7 +43,7 @@
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.7.2'
+	VERSION					=	'0.7.4'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/scratch/aliases.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/scratch/aliases.rb
+#
+# Purpose:      Demonstrates use of aliases in options and flags
+#
+# Created:      7th February 2018
+# Updated:      7th February 2018
+#
+# 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            =   1
+PROGRAM_VER_BUILD               =   1
+
+# ##########################################################
+# command-line parsing
+
+options = {}
+
+r = LibCLImate::Climate.new do |cl|
+
+	cl.add_flag('--verbose', alias: '-v', help: 'specifies verbosity') { options[:verbose] = true }
+	cl.add_alias('--verbose', '--V')
+
+	cl.add_option('--logging-threshold', alias: '-l', help: 'specifies the logging threshold') { |o, a| options[:logging_threshold] = o.value }
+	cl.add_alias('--logging-threshold=informational', '--I')
+
+	cl.info_lines = [
+
+		:version,
+		'demonstrates use of aliases',
+	]
+end.run
+
+
+# ##########################################################
+# main
+
+puts "logging-threshold: #{options[:logging_threshold]}"
+puts "verbose: #{options[:verbose]}"
+
+# ############################## end of file ############################# #
+
+

data/test/scratch/blankzeroes.rb

@@ -6,7 +6,7 @@
 # Purpose:      This filter program converts 0 values in a TSV into blanks
 #
 # Created:      14th May 2016
-# Updated:      1st January 2018
+# Updated:      5th February 2018
 #
 # Author:       Matthew Wilson
 #
@@ -49,3 +49,4 @@ end
 
 # ############################## end of file ############################# #
 
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.13.1
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.13.1
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -63,6 +63,7 @@ files:
 - lib/libclimate/climate.rb
 - lib/libclimate/libclimate.rb
 - lib/libclimate/version.rb
+- test/scratch/aliases.rb
 - test/scratch/blankzeroes.rb
 - test/unit/tc_abort.rb
 - test/unit/tc_infer_version.rb