clasp-ruby 0.11.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8da53dd37696e2528150ea2194a0b3455df79ce
-  data.tar.gz: 531aa7eb5a3f7fac55f024c021f22aefe84b5d75
+  metadata.gz: e91dda59cda14727e357868705aa9b64ea6b2360
+  data.tar.gz: bb8bebd59f109aee136c869d50c70ab1ded2568d
 SHA512:
-  metadata.gz: 182e5db95920e7adbd62786d608d8a8de0c29f85e266d4a3ab481ed24a5c7665fe51c9e1a6a498e78d43d08b3597f145a05bf464fa5c44013001685f849a0e33
-  data.tar.gz: 72372e9151b6f1acf8efe591b9b1d9213acf52c5a042fd442d69c090908ba4f42d091297e6e709a5b18d317ba6f73d568448ce7c8a8a7749c6d720cf9f420513
+  metadata.gz: 4aa994801820d90d6acd54e86cd140f7617de6e7cb157bdce328ddda568264aacf98f348afbe4e504483b95ff98e98904e6cfc2bdabd307b7d838517f3b3b93b
+  data.tar.gz: 12b9257d551fc31b941011e4fc792928e850c1dc721380322586712f11243d411a5d4ff133e8fa9c102d4fad02ef35a416b15a663baf9eacd0c487f785870387

data/lib/clasp/aliases.rb

@@ -5,13 +5,13 @@
 # Purpose:      Alias classes
 #
 # Created:      25th October 2014
-# Updated:      10th June 2016
+# Updated:      1st January 2018
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2014-2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2014-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -131,15 +131,45 @@ class Option
 	#   - +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+.
+	#   - +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+.
-	def initialize(name, aliases, help, values_range, default_value, extras = nil)
+	def initialize(name, aliases, help, values_range, default_value, required, required_message, extras = nil)
 
-		@name			=	name
-		@aliases		=	(aliases || []).select { |a| a and not a.empty? }
-		@help			=	help
-		@values_range	=	values_range || []
-		@default_value	=	default_value
-		@extras			=	extras || {}
+		@name				=	name
+		@aliases			=	(aliases || []).select { |a| a and not a.empty? }
+		@help				=	help
+		@values_range		=	values_range || []
+		@default_value		=	default_value
+		@required			=	required
+		@required_message	=	nil
+		@extras				=	extras || {}
+
+		rm_name				=	nil
+
+		if required_message
+
+			if "\0" == required_message[0]
+
+				rm_name		=	required_message[1..-1]
+			end
+		else
+
+			rm_name			=	"'#{name}'"
+		end
+
+		if rm_name
+
+			required_message	=	"#{rm_name} not specified; use --help for usage"
+		end
+
+		@required_message	=	required_message
 	end
 
 	# The option's name string
@@ -152,20 +182,40 @@ class Option
 	attr_reader	:values_range
 	# The default value of the option
 	attr_reader	:default_value
-	# The flag's extras
+	# Indicates whether the option is required
+	def required?; @required; end
+	# The message to be used when reporting that a required option is
+	# missing
+	attr_reader	:required_message
+	# The option's extras
 	attr_reader :extras
 
 	# String form of the option
 	def to_s
 
-		"{#{name}; aliases=#{aliases.join(', ')}; values_range=[ #{values_range.join(', ')} ]; default_value='#{default_value}'; help='#{help}'; extras=#{extras}}"
+		"{#{name}; aliases=#{aliases.join(', ')}; values_range=[ #{values_range.join(', ')} ]; default_value='#{default_value}'; help='#{help}'; required?=#{required?}; extras=#{extras}}"
 	end
 end
 
 # ######################################################################## #
 # functions
 
-# Generator method that obtains a CLASP::Flag according to the given parameters
+# Generator method that obtains a CLASP::Flag according to the given
+# parameters
+#
+# === Signature
+#
+# * *Parameters:*
+#   - +name+:: [::String] The flag name, e.g. '--verbose'
+#   - +options+:: [::Hash] An options hash, containing any of the following
+#     options:
+#
+# * *Options:*
+#   - +:alias+ [::String] An alias, e.g. '-v'
+#   - +:aliases+ [::Array] An array of aliases, e.g. [ '-v', '-verb' ]
+#   - +:extras+ An application-defined object, usually a hash of custom
+#     attributes
+#   - +:help+ [::String] A help string
 def CLASP.Flag(name, options = {})
 
 	aliases	=	nil
@@ -202,13 +252,44 @@ def CLASP.Flag(name, options = {})
 	CLASP::Flag.new(name, aliases, help, extras)
 end
 
-# Generator method that obtains a CLASP::Option according to the given parameters
+# Generator method that obtains a CLASP::Option according to the given
+# parameters
+#
+# === Signature
+#
+# * *Parameters:*
+#   - +name+:: [::String] The flag name, e.g. '--verbose'
+#   - +options+:: [::Hash] An options hash, containing any of the following
+#     options:
+#
+# * *Options:*
+#   - +:alias+ [::String] An alias, e.g. '-v'
+#   - +:aliases+ [::Array] An array of aliases, e.g. [ '-v', '-verb' ]
+#   - +:default_value+ The default value for the option
+#   - +:default+ [DEPRECATED] Alternative to +:default_value+
+#   - +:extras+ An application-defined object, usually a hash of custom
+#     attributes
+#   - +:help+ [::String] A help string
+#   - +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+.
+#   - +:values_range+ [::Array] An array defining the accepted values for
+#     the option
+#   - +:values+ [DEPRECATED] Alternative to +:values_range+
 def CLASP.Option(name, options = {})
 
 	aliases			=	nil
 	help			=	nil
 	values_range	=	nil
 	default_value	=	nil
+	required		=	false
+	require_message	=	nil
 	extras			=	nil
 
 	options.each do |k, v|
@@ -231,6 +312,12 @@ def CLASP.Option(name, options = {})
 			when	:default_value, :default
 
 				default_value	=	v
+			when	:required
+
+				required	=	v
+			when	:required_message
+
+				require_message	=	v
 			when	:extras
 
 				extras	=	v
@@ -244,7 +331,7 @@ def CLASP.Option(name, options = {})
 		end
 	end
 
-	CLASP::Option.new(name, aliases, help, values_range, default_value, extras)
+	CLASP::Option.new(name, aliases, help, values_range, default_value, required, require_message, extras)
 end
 
 # ######################################################################## #
@@ -254,3 +341,4 @@ end # module CLASP
 
 # ############################## end of file ############################# #
 
+

data/lib/clasp/version.rb

@@ -5,13 +5,13 @@
 # Purpose:      Version for CLASP.Ruby library
 #
 # Created:      16th November 2014
-# Updated:      16th July 2016
+# Updated:      1st January 2018
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2014-2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2014-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -51,7 +51,7 @@
 module CLASP
 
 	# Current version of the CLASP.Ruby library
-	VERSION				=	'0.11.1'
+	VERSION				=	'0.12.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/tc_extras.rb

@@ -0,0 +1,46 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_extras_1 < Test::Unit::TestCase
+
+	def test_Option_with_no_extras
+
+		o = CLASP.Option('--verbose')
+
+		assert_equal '--verbose', o.name
+		assert_equal [], o.aliases
+		assert_equal [], o.values_range
+		assert_equal nil, o.default_value
+		assert_equal ({}), o.extras
+	end
+
+	def test_Option_with_extras_as_symbol
+
+		o = CLASP.Option('--verbose', extras: :extras)
+
+		assert_equal '--verbose', o.name
+		assert_equal [], o.aliases
+		assert_equal [], o.values_range
+		assert_equal nil, o.default_value
+		assert_equal :extras, o.extras
+	end
+
+	def test_Option_with_extras_as_hash
+
+		o = CLASP.Option('--verbose', extras: { :abc => 'abc', :def => 'def' })
+
+		assert_equal '--verbose', o.name
+		assert_equal [], o.aliases
+		assert_equal [], o.values_range
+		assert_equal nil, o.default_value
+		assert_equal ({ :abc => 'abc', :def => 'def' }), o.extras
+	end
+end
+
+
+

data/test/unit/tc_option_required.rb

@@ -0,0 +1,51 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'test/unit'
+
+class Test_Option_required < Test::Unit::TestCase
+
+	def test_Option_required_false_implicit
+
+		o = CLASP.Option('--verbose')
+
+		assert_equal '--verbose', o.name
+		assert_equal [], o.aliases
+		assert_equal [], o.values_range
+		assert_equal nil, o.default_value
+		assert_equal ({}), o.extras
+		assert_false o.required?
+		assert_equal "'--verbose' not specified; use --help for usage", o.required_message
+	end
+
+	def test_Option_required_false_explicit
+
+		o = CLASP.Option('--verbose', required: false, required_message: "\0Verbosity")
+
+		assert_equal '--verbose', o.name
+		assert_equal [], o.aliases
+		assert_equal [], o.values_range
+		assert_equal nil, o.default_value
+		assert_equal ({}), o.extras
+		assert_false o.required?
+		assert_equal "Verbosity not specified; use --help for usage", o.required_message
+	end
+
+	def test_Option_required_true
+
+		o = CLASP.Option('--verbose', required: true, required_message: 'Verbosity not given')
+
+		assert_equal '--verbose', o.name
+		assert_equal [], o.aliases
+		assert_equal [], o.values_range
+		assert_equal nil, o.default_value
+		assert_equal ({}), o.extras
+		assert_true o.required?
+		assert_equal "Verbosity not given", o.required_message
+	end
+end
+
+

data/test/unit/ts_all.rb

@@ -2,7 +2,6 @@
 #
 # executes all other tests
 
-this_file	=	File.expand_path(__FILE__)
 this_dir	=	File.expand_path(File.dirname(__FILE__))
 
 # all tc_*rb in current directory

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies: []
 description: |
   Command-Line Argument Sorting and Parsing library that provides a powerful
@@ -42,7 +42,9 @@ files:
 - test/unit/tc_arguments_3.rb
 - test/unit/tc_defaults_1.rb
 - test/unit/tc_examples_Arguments.rb
+- test/unit/tc_extras.rb
 - test/unit/tc_immutable_array.rb
+- test/unit/tc_option_required.rb
 - test/unit/tc_usage.rb
 - test/unit/tc_util_immutable_array.rb
 - test/unit/ts_all.rb