clasp-ruby 0.21.0 → 0.22.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5d4b4a9b8453b84575f693c6c1cf3d58c0af5999843c360295f799d60dc6b57d
-  data.tar.gz: 2089b0ead4ef6161d6cdda4d2129f2361567d434ea5aa3bcb257918093bdad7a
+SHA1:
+  metadata.gz: bdf2add70e2d8e134e6759718fabde89ecb5c158
+  data.tar.gz: dcf9e41a17a28f53406daef64bdba1f614f2a080
 SHA512:
-  metadata.gz: c24103543ec9d290ae1731ab49a8937e02148b48e567c199ed1c3bb7a12edda0c892b4cd36eeb0fa6a8232fd9936db2fbae254e8db1a835bdf054a3df0f82af0
-  data.tar.gz: c1ea7534927c52c7c138da6da8f43c2c28f13222f35ff751c5d6b4a6aa456d18b6e655de5eaec3373d21aee864913d4ae6dc70d32e7d6e0b33815dc3fe40f57e
+  metadata.gz: d329ce03d0057446f877425faec12da111253f0bb51dbcd0d1e619d0f3e7f5dcc781b20b18ffbb65eb796011b3021d208e1d391881754ec3ecd61e6efad49186
+  data.tar.gz: 63873b0a897f4d854d6f4c80e5605cd68ebecdb4591361662cfa075292ac9c4a69ae8aa8f09ab97446db675fe5611cca41bc7ea83f01853bafb55722b5093fee

data/lib/clasp/specifications.rb

@@ -5,7 +5,7 @@
 # Purpose:      Argument specification classes
 #
 # Created:      25th October 2014
-# Updated:      20th April 2019
+# Updated:      29th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -57,8 +57,40 @@ module CLASP
 # ######################################################################## #
 # classes
 
+# @!visibility private
+class SpecificationBase # :nodoc: all
+
+	private
+	# @!visibility private
+	def check_arity_(blk, range, label) # :nodoc:
+
+		raise ArgumentError, "block must be a #{Proc}; #{blk.class} given" unless blk.nil? || Proc === blk
+
+		if blk
+
+			case blk.arity
+			when range
+
+				;
+			else
+
+				msg = "wrong arity for #{label}"
+
+				if $DEBUG
+
+					raise ArgumentError, msg
+				else
+
+					warn msg
+				end
+			end
+		end
+	end
+	public
+end
+
 # A class that represents the specification for a command-line flag
-class FlagSpecification
+class FlagSpecification < SpecificationBase
 
 	# Creates a FlagSpecification instance from the given name, aliases, and help
 	#
@@ -70,13 +102,18 @@ class FlagSpecification
 	#   - +help+ (+String+) The help string, which may be +nil+
 	#   - +extras+ An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+
 	#
+	# * *Block* An optional block that is called when a matching flag argument is found
+	#
 	# *NOTE:* Users should prefer the +CLASP::Flag()+ method
-	def initialize(name, aliases, help, extras = nil)
+	def initialize(name, aliases, help, extras = nil, &blk)
+
+		check_arity_(blk, 0..3, "flag")
 
 		@name			=	name
 		@aliases		=	(aliases || []).select { |a| a and not a.empty? }
 		@help			=	help
 		@extras			=	extras || {}
+		@action			=	blk
 	end
 
 	# The flag's name string
@@ -88,6 +125,17 @@ class FlagSpecification
 	# The flag's extras
 	attr_reader :extras
 
+	# (Proc) The procedure
+	attr_reader :action
+
+	# @!visibility private
+	def action=(blk) # :nodoc: all
+
+		check_arity_(blk, 0..3, "flag")
+
+		@action = blk
+	end
+
 	# String form of the flag
 	def to_s
 
@@ -135,28 +183,38 @@ class FlagSpecification
 	@@Version_	=	self.new('--version', [], 'shows version and terminates')
   public
 	# An instance of FlagSpecification that provides default '--help' information
-	def self.Help(extras = nil)
+	#
+	# If you wish to specify +extras+ or attach a block, you may do so
+	def self.Help(extras = nil, &blk)
 
 		h = @@Help_
 
-		return self.new(h.name, h.aliases, h.help, extras) if extras
+		if extras || blk
+
+			return self.new(h.name, h.aliases, h.help, extras, &blk)
+		end
 
 		h
 	end
 
 	# An instance of FlagSpecification that provides default '--version' information
-	def self.Version(extras = nil)
+	#
+	# If you wish to specify +extras+ or attach a block, you may do so
+	def self.Version(extras = nil, &blk)
 
 		h = @@Version_
 
-		return self.new(h.name, h.aliases, h.help, extras) if extras
+		if extras || blk
+
+			return self.new(h.name, h.aliases, h.help, extras, &blk)
+		end
 
 		h
 	end
 end
 
 # A class that represents the specification for a command-line option
-class OptionSpecification
+class OptionSpecification < SpecificationBase
 
 	# Creates an OptionSpecification instance from the given name, aliases, help,
 	# values_range, and default_value
@@ -174,8 +232,12 @@ class OptionSpecification
 	#   - +constraint+ (Hash) Constraint to be applied to the parsed values of options matching this specification. NOTE: only integer constraints are supported in the current version
 	#   - +extras+ An application-defined additional parameter. If +nil+, it is assigned an empty +Hash+
 	#
+	# * *Block* An optional block that is called when a matching option argument is found
+	#
 	# *NOTE:* Users should prefer the +CLASP::Option()+ method
-	def initialize(name, aliases, help, values_range, default_value, required, required_message, constraint, extras = nil)
+	def initialize(name, aliases, help, values_range, default_value, required, required_message, constraint, extras = nil, &blk)
+
+		check_arity_(blk, 0..3, "option")
 
 		@name				=	name
 		@aliases			=	(aliases || []).select { |a| a and not a.empty? }
@@ -186,6 +248,7 @@ class OptionSpecification
 		@required_message	=	nil
 		@constraint			=	constraint || {}
 		@extras				=	extras || {}
+		@action				=	blk
 
 		rm_name				=	nil
 
@@ -227,6 +290,17 @@ class OptionSpecification
 	# The option's extras
 	attr_reader :extras
 
+	# (Proc) The procedure
+	attr_reader :action
+
+	# @!visibility private
+	def action=(blk) # :nodoc: all
+
+		check_arity_(blk, 0..3, "flag")
+
+		@action = blk
+	end
+
 	# String form of the option
 	def to_s
 
@@ -318,7 +392,9 @@ end
 #   - +:aliases+ (::Array) An array of aliases, e.g. [ '-v', '-verb' ]. Ignored if +:alias+ is specified
 #   - +:extras+ An application-defined object, usually a hash of custom attributes
 #   - +:help+ (::String) A help string
-def CLASP.Flag(name, options = {})
+#
+# * *Block* An optional block that is called when a matching flag argument is found
+def CLASP.Flag(name, options = {}, &blk)
 
 	aliases	=	nil
 	help	=	nil
@@ -351,7 +427,7 @@ def CLASP.Flag(name, options = {})
 		end
 	end
 
-	CLASP::FlagSpecification.new(name, aliases, help, extras)
+	CLASP::FlagSpecification.new(name, aliases, help, extras, &blk)
 end
 
 # Generator method that obtains a CLASP::OptionSpecification according to the given
@@ -376,7 +452,9 @@ end
 #   - +constraint+ (Hash) Constraint to be applied to the parsed values of options matching this specification. NOTE: only integer constraints are supported in the current version
 #   - +:values_range+ (::Array) An array defining the accepted values for the option
 #   - +:values+ [DEPRECATED] Alternative to +:values_range+
-def CLASP.Option(name, options = {})
+#
+# * *Block* An optional block that is called when a matching option argument is found
+def CLASP.Option(name, options = {}, &blk)
 
 	aliases			=	nil
 	help			=	nil
@@ -429,7 +507,7 @@ def CLASP.Option(name, options = {})
 		end
 	end
 
-	CLASP::OptionSpecification.new(name, aliases, help, values_range, default_value, required, require_message, constraint, extras)
+	CLASP::OptionSpecification.new(name, aliases, help, values_range, default_value, required, require_message, constraint, extras, &blk)
 end
 
 def CLASP.Alias(name, *args)

data/lib/clasp/version.rb

@@ -5,12 +5,13 @@
 # Purpose:      Version for CLASP.Ruby library
 #
 # Created:      16th November 2014
-# Updated:      20th April 2019
+# Updated:      22nd August 2020
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -51,7 +52,7 @@
 module CLASP
 
 	# Current version of the CLASP.Ruby library
-	VERSION				=	'0.21.0'
+	VERSION				=	'0.22.0.1'
 
 	private
 	# @!visibility private

data/test/unit/tc_with_action.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'clasp'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+class Test_WithAction < Test::Unit::TestCase
+
+	def test_flag_with_action
+
+		debug = false
+
+		specifications	=	[
+
+			CLASP.Flag('--debug', alias: '-d') { debug = true }
+		]
+		argv	=	[]
+		args	=	CLASP.parse argv, specifications
+
+		assert_equal 0, args.flags.size
+		assert_equal 0, args.options.size
+		assert_equal 0, args.values.size
+
+		assert_false debug
+
+		argv2	=	[ '--debug' ]
+		args2	=	CLASP.parse argv2, specifications
+
+		assert_equal 1, args2.flags.size
+		assert_equal 0, args2.options.size
+		assert_equal 0, args2.values.size
+
+		assert_false debug
+
+		if ix = args2.flags.index('--debug')
+
+			flag = args2.flags[ix]
+
+			flag.argument_specification.action.call(flag, flag.argument_specification)
+		end
+
+		assert_true debug
+	end
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2020-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -71,6 +71,7 @@ files:
 - test/unit/tc_specifications.rb
 - test/unit/tc_typed_options.rb
 - test/unit/tc_usage.rb
+- test/unit/tc_with_action.rb
 - test/unit/ts_all.rb
 homepage: http://github.com/synesissoftware/CLASP.Ruby
 licenses:
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.4.5.5
 signing_key: 
 specification_version: 4
 summary: CLASP.Ruby