clasp-ruby 0.16.1 → 0.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 476b60beb87db0936ad2bf1d5562cd68d2ba41fe
+  data.tar.gz: ce781faefb3d24a1d431b48337fea7c1ebf2a0fb
+SHA512:
+  metadata.gz: 95926ccb787ca5b0dd1d6920783d103e0e4bf91b21c14763e9ae4c62ef872718fe41fd868c2e1d3fc7a5b764da5e831b02d73d0794486a3acabaa82edf2cf11f
+  data.tar.gz: e335964cf459fab293d7b9a790d7c66f34572844e8c5b544b0733283c5b37436ece225ddc5e845609dc422f7eb37ac90e928f59ad838bbdec29d7841e67e6e3d

data/lib/clasp/aliases.rb

@@ -5,7 +5,7 @@
 # Purpose:      Alias classes
 #
 # Created:      25th October 2014
-# Updated:      14th February 2019
+# Updated:      10th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -257,7 +257,7 @@ def CLASP.Flag(name, options = {})
 			case	k
 			when	:alias
 
-				aliases	=	[ v ]
+				aliases	=	[ v ] if v
 			when	:aliases
 
 				aliases	=	v unless aliases
@@ -328,7 +328,7 @@ def CLASP.Option(name, options = {})
 			case	k
 			when	:alias
 
-				aliases	=	[ v ]
+				aliases	=	[ v ] if v
 			when	:aliases
 
 				aliases	=	v unless aliases

data/lib/clasp/arguments.rb

@@ -6,7 +6,7 @@
 #               CLASP.Ruby
 #
 # Created:      14th February 2014
-# Updated:      14th February 2019
+# Updated:      10th April 2019
 #
 # Home:         http://github.com/synesissoftware/CLASP.Ruby
 #
@@ -46,6 +46,10 @@
 
 
 
+require File.join(File.dirname(__FILE__), 'aliases.rb')
+
+require 'yaml'
+
 =begin
 =end
 
@@ -183,6 +187,131 @@ class Arguments
 	# Construction
 
 	public
+
+	# Loads an instance of the class, as specified by +source+, according to the given parameters
+	#
+	# See the documentation for the ::CLASP module for examples
+	#
+	# === Signature
+	#
+	# * *Parameters*:
+	#   - +argv+:: (+Array+) The arguments array. May not be +nil+. Defaults to +ARGV+.
+	#   - +source+:: (+Hash+, +IO+) The arguments specification, either as a Hash or an instance of an IO-implementing type containing a YAML specification.
+	#   - +options+:: An options hash, containing any of the following options.
+	#
+	# * *Options*:
+	#   - +mutate_argv:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>.
+	#
+	def self.load(argv, source, options = {})
+
+		options ||= {}
+
+		h = nil
+
+		case source
+		when ::IO
+
+			h = YAML.load(source.read)
+		when ::Hash
+
+			h = source
+		else
+
+			if source.respond_to?(:to_hash)
+
+				h = source.to_hash
+			else
+
+				raise TypeError, "#{self}.#{__method__}() 'source' argument must be a #{::Hash}, or an object implementing #{::IO}, or a type implementing to_hash'"
+			end
+		end
+
+		aliases	=	[]
+
+		_clasp	=	h['clasp'] or raise ArgumentError, "missing top-level 'clasp' element in load configuration"
+		::Hash === _clasp or raise ArgumentError, "top-level 'clasp' element must be a #{::Hash}"
+
+		_specs	=	(_clasp['arg-specs'] || _clasp['aliases']) or raise ArgumentError, "missing element 'clasp/arg-specs'"
+		::Array === _specs or raise ArgumentError, "top-level 'arg-specs' element must be a #{::Hash}"
+
+		_specs.each do |_spec|
+
+			case _spec
+			when ::Hash
+
+				# TODO: make a utility function and shrink all the following
+
+				_spec.each do |_arg_type, _details|
+
+					case _arg_type
+					when 'flag', :flag
+
+						_name	=	_details['name']
+
+						unless _name
+
+							warn "flag arg-spec missing required 'name' field"
+						else
+
+							_alias		=	_details['alias']
+							_aliases	=	_details['aliases']
+							_help		=	_details['help'] || _details['description']
+
+							aliases	<<	CLASP.Flag(_name, alias: _alias, aliases: _aliases, help: _help)
+						end
+					when 'option', :option
+
+						_name	=	_details['name']
+
+						unless _name
+
+							warn "option arg-spec missing required 'name' field"
+						else
+
+							_alias				=	_details['alias']
+							_aliases			=	_details['aliases']
+							_default_value		=	_details['default_value'] || _details['default']
+							_help				=	_details['help'] || _details['description']
+							_required			=	_details['required']
+							_required_message	=	_details['required_message']
+							_values_range		=	_details['values_range'] || _details['values']
+
+							aliases	<<	CLASP.Option(_name, alias: _alias, aliases: _aliases, default_value: _default_value, help: _help, required: _required, required_message: _required_message, values_range: _values_range)
+						end
+					when 'alias', :alias
+
+						_resolved	=	_details['resolved']
+
+						unless _resolved
+
+							warn "alias arg-spec missing required 'resolved' field"
+						else
+
+							_alias				=	_details['alias']
+							_aliases			=	_details['aliases']
+
+							unless _alias || _aliases
+
+								warn "alias arg-spec missing required 'alias' or 'aliases' field"
+							else
+
+								aliases << CLASP.Flag(_resolved, alias: _alias, aliases: _aliases)
+							end
+						end
+					else
+
+						warn "unknown arg-type '#{_arg_type}' specified"
+					end
+				end
+			else
+
+				warn "non-#{::Hash} element in 'clasp/arg-specs': #{_spec} (of type #{_spec.class})"
+			end
+		end
+
+		self.new argv, aliases, options
+	end
+
 	# Constructs an instance of the class, according to the given parameters
 	#
 	# See the documentation for the ::CLASP module for examples
@@ -195,7 +324,7 @@ class Arguments
 	#   - +options+:: An options hash, containing any of the following options.
 	#
 	# * *Options*:
-	#   - +mutate_arg:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>.
+	#   - +mutate_argv:+:: (+Boolean+) Determines if the library should mutate +argv+. Defaults to +true+. This is essential when using CLASP in conjunction with <tt>$\<</tt>.
 	#
 	def initialize(argv = ARGV, aliases = nil, options = {})
 

data/lib/clasp/version.rb

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

data/test/scratch/test_usage.rb

@@ -25,8 +25,6 @@ puts '*' * 40
 
 puts 'version:'
 puts
-#CLASP.show_version Aliases, version: '1.2.3.4'
-#CLASP.show_version Aliases, version_major: 1, version_minor: 2
 CLASP.show_version Aliases, version: [ 1, 2, 3 ]
 puts '*' * 40
 

data/test/scratch/test_usage_from_DATA.rb

@@ -0,0 +1,46 @@
+#! /usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
+
+require 'clasp'
+
+Arguments	=	CLASP::Arguments.load(ARGV, DATA)
+
+puts
+puts '*' * 40
+puts 'usage:'
+puts
+CLASP.show_usage(Arguments.aliases)
+puts '*' * 40
+
+puts 'version:'
+puts
+CLASP.show_version Arguments.aliases, version: [ 1, 2, 3 ]
+puts '*' * 40
+
+__END__
+---
+clasp:
+  arg-specs:
+  - flag:
+      name: --version
+      alias: -v
+      help: shows the program version and quits
+  - option:
+      name: --verbosity
+      help: the verbosity
+      values:
+      - silent
+      - quiet
+      - succinct
+      - chatty
+      - verbose
+  - alias:
+      resolved: --verbosity=succinct
+      aliases:
+      - --succinct
+      - -s
+  - alias:
+      resolved: --verbosity=verbose
+      alias: --verbose
+

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clasp-ruby
 version: !ruby/object:Gem::Version
-  version: 0.16.1
-  prerelease: 
+  version: 0.17.0
 platform: ruby
 authors:
 - Matt Wilson
@@ -14,39 +13,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.30'
-description: ! 'Command-Line Argument Sorting and Parsing library that provides a
-  powerful
-
-  abstraction of command-line interpretation facilities. CLASP.Ruby is a Ruby port
-  of the popular CLASP (C/C++) library, and provides declarative specification of
-  command-line flags and options, aliasing, flag combination, UNIX de-facto standard
-  flag processing, and a number of utility functions for expressing usage and version
-  information.
-
-'
+description: |
+  Command-Line Argument Sorting and Parsing library that provides a powerful
+  abstraction of command-line interpretation facilities. CLASP.Ruby is a Ruby port of the popular CLASP (C/C++) library, and provides declarative specification of command-line flags and options, aliasing, flag combination, UNIX de-facto standard flag processing, and a number of utility functions for expressing usage and version information.
 email: matthew@synesis.com.au
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - examples/cr-example.rb
 - examples/flag_and_option_aliases.md
 - examples/flag_and_option_aliases.rb
 - examples/show_usage_and_version.md
 - examples/show_usage_and_version.rb
+- lib/clasp-ruby.rb
+- lib/clasp.rb
 - lib/clasp/aliases.rb
 - lib/clasp/arguments.rb
 - lib/clasp/clasp.rb
@@ -54,18 +48,17 @@ files:
 - lib/clasp/doc_.rb
 - lib/clasp/old_module.rb
 - lib/clasp/version.rb
-- lib/clasp-ruby.rb
-- lib/clasp.rb
 - test/scratch/test_aliases.rb
 - test/scratch/test_list_command_line.rb
 - test/scratch/test_usage.rb
+- test/scratch/test_usage_from_DATA.rb
 - test/scratch/test_usage_with_duplicate_aliases.rb
+- test/unit/tc_ARGV_rewrite.rb
 - test/unit/tc_aliases.rb
 - test/unit/tc_arguments_1.rb
 - test/unit/tc_arguments_2.rb
 - test/unit/tc_arguments_3.rb
 - test/unit/tc_arguments_inspect.rb
-- test/unit/tc_ARGV_rewrite.rb
 - test/unit/tc_cli.rb
 - test/unit/tc_defaults_1.rb
 - test/unit/tc_examples_Arguments.rb
@@ -73,31 +66,28 @@ files:
 - test/unit/tc_option_required.rb
 - test/unit/tc_usage.rb
 - test/unit/ts_all.rb
-- README.md
-- LICENSE
 homepage: http://github.com/synesissoftware/CLASP.Ruby
 licenses:
-- BSD 3-Clause
+- BSD-3-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.6.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: CLASP.Ruby
 test_files: []