clasp-ruby 0.19.1.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69caf746b37b7e16ba320e99323da8dd939d902d5f94c2e7d7911e872cfcbe01
-  data.tar.gz: 5618e602950f633aa11c1ecad79edcce0fcd2edc7f8686c04a42b060b6569db9
+  metadata.gz: 2e7715986763c851922433b19a5b08fd761f700bf9b65dfaf74c338e105d3188
+  data.tar.gz: 998e0fe0365c4ca7b11d2ae29269ea5d84fbf3cb65bab70cbe590072a339250c
 SHA512:
-  metadata.gz: 28a4e8557e601beee4f2730fe1535c8c8f6eae5911d587df17286799284ae717e2062c4f48030f6544b0a05124d8ddd82bee497a991b775e5d1d6917df845f6e
-  data.tar.gz: 569c62d78ff95828e4af59066b6b65cf13746a58cd432f0f51ba54f4f1e082ac5e71e6dc59aeb02110b73599c08da57f0cec9c24f7eaa337cccd015bc9e11e5a
+  metadata.gz: ea17e88ca07b892f2e20083e63c2973eb8c3d11a66a0d02f338b57dde312e807189178cc603fd1d4965fc53189656734ea024ade3d6229c7f4c438cfa1168de9
+  data.tar.gz: 5ca6e41aa2757ae84a8824737aae0d0baac6654c0c7b026f7c4159d0ad2edc8766643216d1e9448f53f6a2c10f5b9759988d289d803911889c8534e4ac34a0b0

data/examples/flag_and_option_specifications.md

@@ -23,14 +23,14 @@ InfoLines = [
 
     'CLASP.Ruby examples',
     :version,
-    "Illustrates use of CLASP.Ruby's use of flags, options, and specifications",
+    "Illustrates use of CLASP.Ruby's use of flags, options, and aliases",
     '',
 ]
 
 # Specify specifications, parse, and checking standard flags
 
 Flag_Debug = CLASP.Flag('--debug', alias: '-d', help: 'runs in Debug mode')
-Option_Verbosity = CLASP.Option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ])
+Option_Verbosity = CLASP.Option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ], default_value: 'terse')
 Flag_Chatty = CLASP.Flag('--verbosity=chatty', alias: '-c')
 
 Specifications = [
@@ -47,7 +47,7 @@ args = CLASP::Arguments.new ARGV, Specifications
 
 if args.flags.include?(CLASP::FlagSpecification.Help)
 
-    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
+    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines, default_indicator: '*default*')
 end
 
 if args.flags.include?('--version')
@@ -76,7 +76,7 @@ if (unused = args.find_first_unknown())
 
 	$stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
 
-    sys.exit(1)
+    exit 1
 end
 ```
 
@@ -129,7 +129,7 @@ flags/options:
 	--verbosity=<value>
 		specifies the verbosity
 		where <value> one of:
-			terse
+			terse	*default*
 			quiet
 			silent
 			chatty
@@ -201,3 +201,4 @@ verbosity is specified as: chatty
 Debug mode is specified
 ```
 
+

data/examples/flag_and_option_specifications.rb

@@ -21,7 +21,7 @@ InfoLines = [
 # Specify specifications, parse, and checking standard flags
 
 Flag_Debug = CLASP.Flag('--debug', alias: '-d', help: 'runs in Debug mode')
-Option_Verbosity = CLASP.Option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ])
+Option_Verbosity = CLASP.Option('--verbosity', alias: '-v', help: 'specifies the verbosity', values: [ 'terse', 'quiet', 'silent', 'chatty' ], default_value: 'terse')
 Flag_Chatty = CLASP.Flag('--verbosity=chatty', alias: '-c')
 
 Specifications = [
@@ -38,7 +38,7 @@ args = CLASP::Arguments.new ARGV, Specifications
 
 if args.flags.include?(CLASP::FlagSpecification.Help)
 
-    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines)
+    CLASP.show_usage(Specifications, exit_code: 0, version: ProgramVersion, stream: $stdout, info_lines: InfoLines, default_indicator: '*default*')
 end
 
 if args.flags.include?('--version')

data/lib/clasp/arguments.rb

@@ -140,13 +140,20 @@ class Arguments
 		# should not be called directly from application code
 		def initialize(arg, given_index, given_name, resolved_name, argument_spec, given_hyphens, given_label, value, extras) # :nodoc:
 
+			actual_value			=	value
+
+			if value.nil? && argument_spec
+
+				actual_value = argument_spec.default_value
+			end
+
 			@arg					=	arg
 			@given_index			=	given_index
 			@given_name				=	given_name
 			@argument_specification	=	argument_spec
 			@given_hyphens			=	given_hyphens
 			@given_label			=	given_label
-			@value					=	value
+			@value					=	actual_value
 			@name					=	resolved_name || given_name
 			@extras					=	extras.nil? ? {} : extras
 		end

data/lib/clasp/cli.rb

@@ -125,6 +125,7 @@ end # module CLI_helpers_
 #   - +:values+                               appends this string to USAGE line if specified.
 #   - +:flags_and_options+                    inserts a custom string instead of the default string <tt>'[ ... flags and options ... ]'</tt>.
 #   - +:info_lines+                           inserts 0+ information lines prior to the usage.
+#   - +: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	||=	{}
@@ -133,10 +134,10 @@ def self.show_usage specifications, options={}
 	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 { |a| 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 === a } }
+	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 } }
 
 	alias_dups = {}
-	specifications.each { |a| a.aliases.each { |aa| warn "WARNING: alias '#{aa}' is already used for alias '#{a}'" if alias_dups.has_key? aa; alias_dups[aa] = a; } }
+	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; } }
 
 	suppress_blanks	=	options[:suppress_blank_lines_between_options] || ENV['SUPPRESS_BLANK_LINES_BETWEEN_OPTIONS']
 
@@ -173,28 +174,31 @@ def self.show_usage specifications, options={}
 	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]
 
+	default_indicator	=	options[:default_indicator] || '(default)'
+	default_indicator	=	nil if default_indicator.empty?
+
 	# sift the specifications to sort out which are value-option
 	# specifications (VOAs)
 
 	voas			=	{}
 
-	specifications.select { |a| a.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }.each do |a|
+	specifications.select { |s| s.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }.each do |s|
 
-		a.name =~ /^(-+[a-zA-Z0-3_-]+)[=:](.+)$/
+		s.name =~ /^(-+[a-zA-Z0-3_-]+)[=:](.+)$/
 
 		voas[$1]	=	[] unless voas.has_key? $1
-		voas[$1]	<<	[ a, $2 ]
+		voas[$1]	<<	[ s, $2 ]
 	end
 
 	fas				=	{}
 
-	specifications.select { |a| AliasSpecification === a }.each do |a|
+	specifications.select { |s| AliasSpecification === s }.each do |s|
 
-		fas[a.name]	=	[] unless fas.has_key? $1
-		fas[a.name]	<<	a
+		fas[s.name]	=	[] unless fas.has_key? $1
+		fas[s.name]	<<	s
 	end
 
-	specifications	=	specifications.reject { |a| a.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }
+	specifications	=	specifications.reject { |s| s.name =~ /^-+[a-zA-Z0-3_-]+[=:].+/ }
 
 	info_lines.each { |info_line| stream.puts info_line } unless info_lines.empty?
 
@@ -205,40 +209,51 @@ def self.show_usage specifications, options={}
 
 		stream.puts "flags/options:"
 		stream.puts
-		specifications.each do |a|
+		specifications.each do |s|
 
-			case a
+			case s
 			when AliasSpecification
 
 				next
 			when FlagSpecification
 
-				if fas.has_key? a.name
+				if fas.has_key? s.name
 
-					fas[a.name].each do |fa|
+					fas[s.name].each do |fa|
 
 						fa.aliases.each { |al| stream.puts "\t#{al}" }
 					end
 				end
-				a.aliases.each { |al| stream.puts "\t#{al}" }
-				stream.puts "\t#{a.name}"
-				stream.puts "\t\t#{a.help}"
+				s.aliases.each { |al| stream.puts "\t#{al}" }
+				stream.puts "\t#{s.name}"
+				stream.puts "\t\t#{s.help}"
 			when OptionSpecification
 
-				if voas.has_key? a.name
+				if voas.has_key? s.name
 
-					voas[a.name].each do |ar|
+					voas[s.name].each do |ar|
 
 						ar[0].aliases.each { |al| stream.puts "\t#{al} #{ar[0].name}" }
 					end
 				end
-				a.aliases.each { |al| stream.puts "\t#{al} <value>" }
-				stream.puts "\t#{a.name}=<value>"
-				stream.puts "\t\t#{a.help}"
-				unless a.values_range.empty?
+				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?
+
+					d = s.default_value
 
 					stream.puts "\t\twhere <value> one of:"
-					a.values_range.each { |v| stream.puts "\t\t\t#{v}" }
+					s.values_range.each do |v|
+
+						if default_indicator && v == d
+
+							stream.puts "\t\t\t#{v}\t#{default_indicator}"
+						else
+
+							stream.puts "\t\t\t#{v}"
+						end
+					end
 				end
 			end
 			stream.puts unless suppress_blanks
@@ -276,7 +291,7 @@ def self.show_version specifications, options = {}
 	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 { |a| 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 === a } }
+	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
 

data/lib/clasp/specifications.rb

@@ -165,7 +165,7 @@ class OptionSpecification
 	#   - +aliases+ (+Array+) 0 or more strings specifying short-form or option-value aliases
 	#   - +help+ (+String+) The help string, which may be +nil+
 	#   - +values_range+ (+Array+) 0 or more strings specifying values supported by the option
-	#   - +default_value+ (+String+) The default value of the option. May be +nil+
+	#   - +default_value+ (+String+) The default value of the option, which will be used in the case where an option is specified without a value. May be +nil+
 	#   - +required+ (boolean) Whether the option is required. May be +nil+
 	#   - +required_message+ (::String) Message to be used when reporting that a required option is missing. May be +nil+ in which case a message of the form "<option-name> not specified; use --help for usage". If begins with the nul character ("\0"), then is used in the place of the <option-name> and placed into the rest of the standard form message
 	#   - +extras+ An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+

data/lib/clasp/version.rb

@@ -51,7 +51,7 @@
 module CLASP
 
 	# Current version of the CLASP.Ruby library
-	VERSION				=	'0.19.1.1'
+	VERSION				=	'0.20.0'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_default_value.rb

@@ -0,0 +1,133 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+require 'xqsr3/extensions/test/unit'
+
+class Test_DefaultValue < Test::Unit::TestCase
+
+	def test_long_form_without_default
+
+		specifications	=	[
+
+			CLASP.Option('--verbosity', values: [ 'silent', 'terse', 'normal', 'chatty', 'verbose' ])
+		]
+
+		argv	=	[ '--verbosity' ]
+		args	=	CLASP::Arguments.new(argv, specifications)
+
+		assert_equal 0, args.flags.size
+		assert_equal 1, args.options.size
+		assert_equal 0, args.values.size
+
+		option0	=	args.options[0]
+
+		assert_equal '--verbosity', option0.name
+		assert_nil option0.value
+	end
+
+	def test_long_form_with_default
+
+		specifications	=	[
+
+			CLASP.Option('--verbosity', values: [ 'silent', 'terse', 'normal', 'chatty', 'verbose' ], default_value: 'normal')
+		]
+
+		argv	=	[ '--verbosity' ]
+		args	=	CLASP::Arguments.new(argv, specifications)
+
+		assert_equal 0, args.flags.size
+		assert_equal 1, args.options.size
+		assert_equal 0, args.values.size
+
+		option0	=	args.options[0]
+
+		assert_equal '--verbosity', option0.name
+		assert_equal 'normal', option0.value
+	end
+
+	def test_short_form_without_default
+
+		specifications	=	[
+
+			CLASP.Option('--verbosity', alias: '-v', values: [ 'silent', 'terse', 'normal', 'chatty', 'verbose' ])
+		]
+
+		argv	=	[ '-v' ]
+		args	=	CLASP::Arguments.new(argv, specifications)
+
+		assert_equal 0, args.flags.size
+		assert_equal 1, args.options.size
+		assert_equal 0, args.values.size
+
+		option0	=	args.options[0]
+
+		assert_equal '--verbosity', option0.name
+		assert_nil option0.value
+	end
+
+	def test_short_form_with_default
+
+		specifications	=	[
+
+			CLASP.Option('--verbosity', alias: '-v', values: [ 'silent', 'terse', 'normal', 'chatty', 'verbose' ], default_value: 'normal')
+		]
+
+		argv	=	[ '-v' ]
+		args	=	CLASP::Arguments.new(argv, specifications)
+
+		assert_equal 0, args.flags.size
+		assert_equal 1, args.options.size
+		assert_equal 0, args.values.size
+
+		option0	=	args.options[0]
+
+		assert_equal '--verbosity', option0.name
+		assert_equal 'normal', option0.value
+	end
+
+	def test_short_form_without_default_and_separator
+
+		specifications	=	[
+
+			CLASP.Option('--verbosity', alias: '-v', values: [ 'silent', 'terse', 'normal', 'chatty', 'verbose' ])
+		]
+
+		argv	=	[ '-v', '--', 'some-value' ]
+		args	=	CLASP::Arguments.new(argv, specifications)
+
+		assert_equal 0, args.flags.size
+		assert_equal 1, args.options.size
+		assert_equal 1, args.values.size
+
+		option0	=	args.options[0]
+
+		assert_equal '--verbosity', option0.name
+		assert_nil option0.value
+	end
+
+	def test_short_form_with_default_and_separator
+
+		specifications	=	[
+
+			CLASP.Option('--verbosity', alias: '-v', values: [ 'silent', 'terse', 'normal', 'chatty', 'verbose' ], default_value: 'normal')
+		]
+
+		argv	=	[ '-v', '--', 'some-value' ]
+		args	=	CLASP::Arguments.new(argv, specifications)
+
+		assert_equal 0, args.flags.size
+		assert_equal 1, args.options.size
+		assert_equal 1, args.values.size
+
+		option0	=	args.options[0]
+
+		assert_equal '--verbosity', option0.name
+		assert_equal 'normal', option0.value
+	end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.19.1.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Matt Wilson
@@ -60,6 +60,7 @@ files:
 - test/unit/tc_arguments_3.rb
 - test/unit/tc_arguments_inspect.rb
 - test/unit/tc_cli.rb
+- test/unit/tc_default_value.rb
 - test/unit/tc_defaults_1.rb
 - test/unit/tc_examples_Arguments.rb
 - test/unit/tc_extras.rb