clasp-ruby 0.23.0.1 → 0.23.0.2

data/lib/clasp/clasp.rb

@@ -5,13 +5,13 @@
 # Purpose:      Common 'require file' for CLASP.Ruby library
 #
 # Created:      14th February 2014
-# Updated:      11th April 2019
+# Updated:      20th January 2024
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
+# Copyright (c) 2014-2024, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -52,13 +52,13 @@ require 'clasp/version'
 
 module CLASP
 
-	# TBC (but is a shorthand for calling +Arguments.new()+
-	def self.parse(argv = ARGV, specifications = nil, options = {})
+    # TBC (but is a shorthand for calling +Arguments.new()+
+    def self.parse(argv = ARGV, specifications = nil, options = {})
 
-		return Arguments.new(argv, specifications, options)
-	end
+        return Arguments.new(argv, specifications, options)
+    end
 end # module CLASP
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/clasp/cli.rb

@@ -5,13 +5,13 @@
 # Purpose:      Command-line interface
 #
 # Created:      27th July 2015
-# Updated:      19th April 2019
+# Updated:      20th January 2024
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2024, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -53,6 +53,7 @@
 
 module CLASP
 
+
 # ######################################################################## #
 # helpers
 
@@ -64,47 +65,48 @@ module CLASP
 # @!visibility private
 module CLI_helpers_ # :nodoc: all
 
-	# @!visibility private
-	module Constants # :nodoc: all
+    # @!visibility private
+    module Constants # :nodoc: all
 
-		# @!visibility private
-		VALID_ALIAS_TYPES			=	[ FlagSpecification, OptionSpecification, AliasSpecification ]
-		# @!visibility private
-		VALID_ALIAS_TYPES_STRING	=	VALID_ALIAS_TYPES[0...-1].join(', ') + ', or ' + VALID_ALIAS_TYPES[-1].to_s
-	end # module Constants
+        # @!visibility private
+        VALID_ALIAS_TYPES           =   [ FlagSpecification, OptionSpecification, AliasSpecification ]
+        # @!visibility private
+        VALID_ALIAS_TYPES_STRING    =   VALID_ALIAS_TYPES[0...-1].join(', ') + ', or ' + VALID_ALIAS_TYPES[-1].to_s
+    end # module Constants
 
-	# @!visibility private
-	def self.generate_version_string_ options # :nodoc:
+    # @!visibility private
+    def self.generate_version_string_ options # :nodoc:
 
-		program_name	=	options[:program_name] || File.basename($0)
+        program_name    =   options[:program_name] || File.basename($0)
 
-		version_prefix	=	options[:version_prefix]
+        version_prefix  =   options[:version_prefix]
 
-		if options[:version]
+        if options[:version]
 
-			case	options[:version]
-			when	::Array
-				version	=	options[:version].join('.')
-			else
-				version = options[:version]
-			end
-		else
+            case    options[:version]
+            when    ::Array
+                version =   options[:version].join('.')
+            else
+                version = options[:version]
+            end
+        else
 
-			version_major	=	options[:version_major] or raise ArgumentError, "options must specify :version or :version_major [ + :version_minor [ + :version_revision [ + :version_build ]]]"
-			version_minor	=	options[:version_minor]
-			version_rev		=	options[:version_revision]
-			version_build	=	options[:version_build]
+            version_major   =   options[:version_major] or raise ArgumentError, "options must specify :version or :version_major [ + :version_minor [ + :version_revision [ + :version_build ]]]"
+            version_minor   =   options[:version_minor]
+            version_rev     =   options[:version_revision]
+            version_build   =   options[:version_build]
 
-			version			=	version_major.to_s
-			version			+=	".#{version_minor}" if version_minor
-			version			+=	".#{version_rev}" if version_rev
-			version			+=	".#{version_build}" if version_build
-		end
+            version         =   version_major.to_s
+            version         +=  ".#{version_minor}" if version_minor
+            version         +=  ".#{version_rev}" if version_rev
+            version         +=  ".#{version_build}" if version_build
+        end
 
-		"#{program_name} #{version_prefix}#{version}"
-	end
+        "#{program_name} #{version_prefix}#{version}"
+    end
 end # module CLI_helpers_
 
+
 # ######################################################################## #
 # methods
 
@@ -132,141 +134,142 @@ end # module CLI_helpers_
 #   - +:default_indicator+ (String) a string placed after the matching value in the listing of an option's range of values. Defaults to "(default)". If +nil+ default is used. If empty string no indication given
 def self.show_usage specifications, options={}
 
-	options	||=	{}
+    options ||= {}
 
-	raise ArgumentError, "specifications may not be nil" if specifications.nil?
-	raise TypeError, "specifications must be an array or must respond to each, reject and select" unless ::Array === specifications || (specifications.respond_to?(:each) && specifications.respond_to?(:reject) && specifications.respond_to?(:select))
+    raise ArgumentError, "specifications may not be nil" if specifications.nil?
+    raise TypeError, "specifications must be an array or must respond to each, reject and select" unless ::Array === specifications || (specifications.respond_to?(:each) && specifications.respond_to?(:reject) && specifications.respond_to?(:select))
 
-	constants		=	CLI_helpers_::Constants
-	specifications.each { |s| raise ::TypeError, "each element in specifications array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === s } }
+    constants = CLI_helpers_::Constants
 
-	alias_dups = {}
-	specifications.each { |s| s.aliases.each { |aa| warn "WARNING: alias '#{aa}' is already used for specification '#{s}'" if alias_dups.has_key? aa; alias_dups[aa] = s; } }
+    specifications.each { |s| raise ::TypeError, "each element in specifications array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === s } }
 
-	suppress_blanks	=	options[:suppress_blank_lines_between_options] || ENV['SUPPRESS_BLANK_LINES_BETWEEN_OPTIONS']
+    alias_dups = {}
+    specifications.each { |s| s.aliases.each { |aa| warn "WARNING: alias '#{aa}' is already used for specification '#{s}'" if alias_dups.has_key? aa; alias_dups[aa] = s; } }
 
-	stream			=	options[:stream] || $stdout
-	program_name	=	options[:program_name] || File.basename($0)
+    suppress_blanks =   options[:suppress_blank_lines_between_options] || ENV['SUPPRESS_BLANK_LINES_BETWEEN_OPTIONS']
 
-	info_lines		=	options[:info_lines]
-	case info_lines
-	when ::Array
+    stream          =   options[:stream] || $stdout
+    program_name    =   options[:program_name] || File.basename($0)
 
-		;
-	when ::NilClass
+    info_lines      =   options[:info_lines]
+    case info_lines
+    when ::Array
 
-		info_lines	=	[]
-	else
+        ;
+    when ::NilClass
 
-		info_lines = [ info_lines ] unless [ :each, :empty? ].all? { |m| info_lines.respond_to? m }
-	end
-	info_lines		=	info_lines.map do |line|
+        info_lines  =   []
+    else
 
-		case line
-		when :version
+        info_lines  =   [ info_lines ] unless [ :each, :empty? ].all? { |m| info_lines.respond_to? m }
+    end
+    info_lines      =   info_lines.map do |line|
 
-			CLI_helpers_.generate_version_string_ options
-		else
+        case line
+        when :version
 
-			line
-		end
-	end
+            CLI_helpers_.generate_version_string_ options
+        else
 
-	values			=	options[:values] || ''
-	values			=	" #{values}" if !values.empty? && ' ' != values[0]
+            line
+        end
+    end
 
-	flags_and_options	=	options[:flags_and_options] || ' [ ... flags and options ... ]'
-	flags_and_options	=	" #{flags_and_options}" if !flags_and_options.empty? && ' ' != flags_and_options[0]
+    values              =   options[:values] || ''
+    values              =   " #{values}" if !values.empty? && ' ' != values[0]
 
-	default_indicator	=	options[:default_indicator] || '(default)'
-	default_indicator	=	nil if default_indicator.empty?
+    flags_and_options   =   options[:flags_and_options] || ' [ ... flags and options ... ]'
+    flags_and_options   =   " #{flags_and_options}" if !flags_and_options.empty? && ' ' != flags_and_options[0]
 
-	# sift the specifications to sort out which are value-option
-	# specifications (VOAs)
+    default_indicator   =   options[:default_indicator] || '(default)'
+    default_indicator   =   nil if default_indicator.empty?
 
-	voas			=	{}
+    # sift the specifications to sort out which are value-option
+    # specifications (VOAs)
 
-	specifications.select { |s| s.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }.each do |s|
+    voas = {}
 
-		s.name =~ /^(-+[a-zA-Z0-3_-]+)[=:](.+)$/
+    specifications.select { |s| s.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }.each do |s|
 
-		voas[$1]	=	[] unless voas.has_key? $1
-		voas[$1]	<<	[ s, $2 ]
-	end
+        s.name =~ /^(-+[a-zA-Z0-3_-]+)[=:](.+)$/
 
-	fas				=	{}
+        voas[$1]   =    [] unless voas.has_key? $1
+        voas[$1]   <<   [ s, $2 ]
+    end
 
-	specifications.select { |s| AliasSpecification === s }.each do |s|
+    fas = {}
 
-		fas[s.name]	=	[] unless fas.has_key? $1
-		fas[s.name]	<<	s
-	end
+    specifications.select { |s| AliasSpecification === s }.each do |s|
 
-	specifications	=	specifications.reject { |s| s.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }
+        fas[s.name]   =   [] unless fas.has_key? $1
+        fas[s.name]   <<   s
+    end
 
-	info_lines.each { |info_line| stream.puts info_line } unless info_lines.empty?
+    specifications   =   specifications.reject { |s| s.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }
 
-	stream.puts "USAGE: #{program_name}#{flags_and_options}#{values}"
-	stream.puts
+    info_lines.each { |info_line| stream.puts info_line } unless info_lines.empty?
 
-	unless specifications.empty?
+    stream.puts "USAGE: #{program_name}#{flags_and_options}#{values}"
+    stream.puts
 
-		stream.puts "flags/options:"
-		stream.puts
-		specifications.each do |s|
+    unless specifications.empty?
 
-			case s
-			when AliasSpecification
+        stream.puts "flags/options:"
+        stream.puts
+        specifications.each do |s|
 
-				next
-			when FlagSpecification
+            case s
+            when AliasSpecification
 
-				if fas.has_key? s.name
+                next
+            when FlagSpecification
 
-					fas[s.name].each do |fa|
+                if fas.has_key? s.name
 
-						fa.aliases.each { |al| stream.puts "\t#{al}" }
-					end
-				end
-				s.aliases.each { |al| stream.puts "\t#{al}" }
-				stream.puts "\t#{s.name}"
-				stream.puts "\t\t#{s.help}"
-			when OptionSpecification
+                    fas[s.name].each do |fa|
 
-				if voas.has_key? s.name
+                        fa.aliases.each { |al| stream.puts "\t#{al}" }
+                    end
+                end
+                s.aliases.each { |al| stream.puts "\t#{al}" }
+                stream.puts "\t#{s.name}"
+                stream.puts "\t\t#{s.help}"
+            when OptionSpecification
 
-					voas[s.name].each do |ar|
+                if voas.has_key? s.name
 
-						ar[0].aliases.each { |al| stream.puts "\t#{al} #{ar[0].name}" }
-					end
-				end
-				s.aliases.each { |al| stream.puts "\t#{al} <value>" }
-				stream.puts "\t#{s.name}=<value>"
-				stream.puts "\t\t#{s.help}"
-				unless s.values_range.empty?
+                    voas[s.name].each do |ar|
 
-					d = s.default_value
+                        ar[0].aliases.each { |al| stream.puts "\t#{al} #{ar[0].name}" }
+                    end
+                end
+                s.aliases.each { |al| stream.puts "\t#{al} <value>" }
+                stream.puts "\t#{s.name}=<value>"
+                stream.puts "\t\t#{s.help}"
+                unless s.values_range.empty?
 
-					stream.puts "\t\twhere <value> one of:"
-					s.values_range.each do |v|
+                    d = s.default_value
 
-						if default_indicator && v == d
+                    stream.puts "\t\twhere <value> one of:"
+                    s.values_range.each do |v|
 
-							stream.puts "\t\t\t#{v}\t#{default_indicator}"
-						else
+                        if default_indicator && v == d
 
-							stream.puts "\t\t\t#{v}"
-						end
-					end
-				end
-			end
-			stream.puts unless suppress_blanks
-		end
-	end
+                            stream.puts "\t\t\t#{v}\t#{default_indicator}"
+                        else
 
-	exit_code		=	options[:exit_code] || options[:exit]
+                            stream.puts "\t\t\t#{v}"
+                        end
+                    end
+                end
+            end
+            stream.puts unless suppress_blanks
+        end
+    end
 
-	exit exit_code if exit_code
+    exit_code = options[:exit_code] || options[:exit]
+
+    exit exit_code if exit_code
 end
 
 # Displays version for the program according to the given specifications and options
@@ -289,30 +292,32 @@ end
 #   - +:version_prefix+       optional string to prefix the version number(s).
 def self.show_version specifications, options = {}
 
-	options	||=	{}
+    options ||= {}
+
+    raise ArgumentError, "specifications may not be nil" if specifications.nil?
+    raise TypeError, "specifications must be an array or must respond to each, reject and select" unless ::Array === specifications || (specifications.respond_to?(:each) && specifications.respond_to?(:reject) && specifications.respond_to?(:select))
 
-	raise ArgumentError, "specifications may not be nil" if specifications.nil?
-	raise TypeError, "specifications must be an array or must respond to each, reject and select" unless ::Array === specifications || (specifications.respond_to?(:each) && specifications.respond_to?(:reject) && specifications.respond_to?(:select))
+    constants = CLI_helpers_::Constants
 
-	constants		=	CLI_helpers_::Constants
-	specifications.each { |s| raise ::TypeError, "each element in specifications array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === s } }
+    specifications.each { |s| raise ::TypeError, "each element in specifications array must be one of the types #{constants::VALID_ALIAS_TYPES_STRING}" unless constants::VALID_ALIAS_TYPES.any? { |c| c === s } }
 
-	stream			=	options[:stream] || $stdout
+    stream = options[:stream] || $stdout
 
-	version_string	=	CLI_helpers_.generate_version_string_ options
+    version_string = CLI_helpers_.generate_version_string_ options
 
-	stream.puts version_string
+    stream.puts version_string
 
-	exit_code		=	options[:exit_code] || options[:exit]
+    exit_code = options[:exit_code] || options[:exit]
 
-	exit exit_code if exit_code
+    exit exit_code if exit_code
 end
 
+
 # ######################################################################## #
 # module
 
 end # module CLASP
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/clasp/doc_.rb

@@ -5,13 +5,13 @@
 # Purpose:      Documentation of the CLASP.Ruby modules
 #
 # Created:      11th June 2016
-# Updated:      19th April 2019
+# Updated:      20th January 2024
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2024, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -163,6 +163,6 @@ module CLASP
 
 end # module CLASP
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/clasp/old_module.rb

@@ -6,13 +6,13 @@
 #               gem)
 #
 # Created:      10th June 2016
-# Updated:      10th June 2016
+# Updated:      20th January 2024
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2024, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -50,6 +50,6 @@ require 'clasp'
 # Backwards-compatible alias for the CLASP library's CLASP module
 Clasp = CLASP
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #