libclimate-ruby 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02794e536b229ccb6f52ec08d7899389dd749dab
-  data.tar.gz: 28d0b8f7d6243ed083c8cfd85e1f7536bca6b7c5
+  metadata.gz: 11f0e8e0239a415d2c396a07c97b040db5bc29c3
+  data.tar.gz: 9fd775fe9b0e5c64c0507d6fdb76a2208889a35a
 SHA512:
-  metadata.gz: f6778014e31bfa9ce3024a4e09fdc59197091fd65ef85c75928ecda9cc0b4f5d67cd681b91f1e801f4d9a7a5f2dcbcd5807bfafc2bd4f39bf218ee8af6290d0c
-  data.tar.gz: 3d165c6a9f529123f3816bd719ce5dcd1bf9da583cdb9cc81c51aab89cbfef4e503e4de8611919e7e2cd8ef2131a66aa18808175e833307a1afc58ee26a5bfa3
+  metadata.gz: cdefc270711e796b5e26bf9e436ef44cddfe309a1120cc77aa463f0fb2f0ed36015bc75b2bd7cc35093f33b80d279ee49939c8b276dea862ee9b3660af62635a
+  data.tar.gz: fa9c99fc53a11004a1525771ab9cf51f25693abf685f076b8bb14260674ab11f0af89a9ce3f39af329ee03ebc402c88b9520d151051d461cdba1db61ced7a746

data/README.md

@@ -1,6 +1,8 @@
 # libCLImate.Ruby
 libCLImate for Ruby
 
+[![Gem Version](https://badge.fury.io/rb/libclimate-ruby.svg)](https://badge.fury.io/rb/libclimate-ruby)
+
 ## Installation & usage
 
 Install using `gem install libclimate-ruby` or add it to your `Gemfile`.

data/lib/libclimate/climate.rb

@@ -5,7 +5,7 @@
 # Purpose:      Definition of the ::LibCLImate::Climate class
 #
 # Created:      13th July 2015
-# Updated:      11th June 2016
+# Updated:      13th June 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -48,7 +48,7 @@ if !defined? Colcon
 	begin
 
 		require 'colcon'
-	rescue LoadError => x
+	rescue LoadError #=> x
 
 		warn "could not load colcon library" if $DEBUG
 	end
@@ -56,9 +56,15 @@ end
 
 module LibCLImate
 
+# Class used to gather together the CLI specification, and execute it
+#
+#
+#
 class Climate
 
-  private
+	#:stopdoc:
+
+	private
 	def show_usage_
 
 		options	=	{}
@@ -74,8 +80,23 @@ class Climate
 		CLASP.show_version aliases, stream: stdout, program_name: program_name, version: version, exit: exit_on_usage ? 0 : nil
 	end
 
-  public
-	def initialize(options={})
+	#:startdoc:
+
+	public
+
+	# Creates an instance of the Climate class.
+	#
+	# === Signature
+	#
+	# * *Parameters*:
+	#   - +options:+:: An options hash, containing any of the following options.
+	#
+	# * *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
+	#
+	# * *Block*:: An optional block which receives the constructing instance, allowing the user to modify the attributes.
+	def initialize(options={}) # :yields: climate
 
 		options ||=	{}
 
@@ -100,21 +121,33 @@ class Climate
 		@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
+		yield self if block_given?
 	end
 
-	attr_accessor :aliases
+	# 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
+	# Indicates whether exit will be called (with non-zero exit code) when an unknown command-line flag or option is encountered
+	# @return [Boolean]
+	# @return *true* exit(1) will be called
+	# @return *false* exit will not be called
 	attr_accessor :exit_on_unknown
+	# @return [Boolean] Indicates whether exit will be called (with zero exit code) when usage/version is requested on the command-line
 	attr_accessor :exit_on_usage
+	# @return [Array] Optional array of string of program-information that will be written before the rest of the usage block when usage is requested on the command-line
 	attr_accessor :info_lines
+	# @return [String] A program name; defaults to the name of the executing script
 	attr_accessor :program_name
+	# @return [IO] The output stream for normative output; defaults to $stdout
 	attr_accessor :stdout
+	# @return [IO] The output stream for contingent output; defaults to $stderr
 	attr_accessor :stderr
+	# @return [String] Optional string to describe the program values, eg \<xyz "[ { <<directory> | &lt;file> } ]"
 	attr_accessor :usage_values
+	# @return [String, Array] A version string or an array of integers representing the version components
 	attr_accessor :version
 
+	# Executes the prepared Climate instance
 	def run argv = ARGV
 
 		raise ArgumentError, "argv may not be nil" if argv.nil?
@@ -156,13 +189,13 @@ class Climate
 
 				selector	=	:unhandled
 
-				ex = f.extras
+				ex = al.extras
 
-				case f.extras
+				case ex
 				when ::Hash
-					if f.extras.has_key? :handle
+					if ex.has_key? :handle
 
-						f.extras[:handle].call(f, al)
+						ex[:handle].call(f, al)
 
 						selector = :handled
 					end

data/lib/libclimate/libclimate.rb

@@ -4,7 +4,7 @@
 # Purpose:      Main file for libclimate.Ruby library
 #
 # Created:      13th July 2015
-# Updated:      14th May 2016
+# Updated:      12th June 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -40,6 +40,7 @@
 require 'libclimate/climate'
 require 'libclimate/version'
 
+# Main module for libCLImate.Ruby library
 module LibCLImate
 
 

data/lib/libclimate/version.rb

@@ -4,7 +4,7 @@
 # Purpose:      Version for libclimate.Ruby library
 #
 # Created:      13th July 2015
-# Updated:      11th June 2016
+# Updated:      13th June 2016
 #
 # Home:         http://github.com/synesissoftware/libCLImate.Ruby
 #
@@ -37,11 +37,10 @@
 # ######################################################################## #
 
 
-# Main module for libCLImate.Ruby library
 module LibCLImate
 
 	# Current version of the libCLImate.Ruby library
-	VERSION					=	'0.2.3'
+	VERSION					=	'0.2.4'
 
 	private
 	VERSION_PARTS_			=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
@@ -52,7 +51,6 @@ module LibCLImate
 	VERSION_MINOR			=	VERSION_PARTS_[1] # :nodoc:
 	# # Revision version of the libCLImate.Ruby library
 	VERSION_REVISION		=	VERSION_PARTS_[2] # :nodoc:
-	#
 
 end # module LibCLImate
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libclimate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-11 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clasp-ruby
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'