filigree 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c7696d87311fb00c3506b41c1f8b50e944bb63b
-  data.tar.gz: eb00162a46ccfbb5742e56498233f44e36b5d760
+  metadata.gz: b3c0573e398b2736c8f1e314ba3feb5aa21871c2
+  data.tar.gz: bbf5700aea71b6176e4b715f5667d732d30c454f
 SHA512:
-  metadata.gz: 783be7b5c305016fe61287d6c41c7f49f7e15b380cf199cfcf0633ef5e2b4cd073cae6608879655d65d134b69554bf3d9c24195fccc908d6b8dd4a14c1425e34
-  data.tar.gz: 98e5f988abc878f3f6da8e48faf8e29b547488a69f76bd3124d6541d0f321a87e7490c9a2f275068ca07dc91d35178cf090f91699ab4ab2ebcc5bc1f81f8b604
+  metadata.gz: 6517ac40aa42375670719f675c356b9cb25d6ba494ee44a30dffa3f44307a875d19139ae27350f42851f6a540dbab415adc887d13d3318987313c178344bdace
+  data.tar.gz: e15b6c5359816097a848e5a8bcf66a2ae83e98d6d421c8d79567e215427355d5ddcc02e08b2b4250ba9e5c3d4e0f656f4fb81d9770e8f863bb27049600a7ef39

data/README.md

@@ -164,7 +164,11 @@ Filigree's implementation of the visitor pattern is built on the pattern matchin
 ```Ruby
 class Binary < Struct.new(:x, :y)
   extend  Filigree::Destructurable
-  include Filigree::Visitor
+  include Filigree::Visitable
+
+  def children
+  	[x, y]
+  end
 
   def destructure(_)
     [x, y]

data/Rakefile

@@ -76,16 +76,6 @@ request_file('reek/rake/task', 'Reek is not installed.') do
 	end
 end
 
-##################
-# Rubygems Tasks #
-##################
-
-request_file('rubygems/tasks', 'Rubygems-tasks is not installed.') do
-	Gem::Tasks.new do |t|
-		t.console.command = 'pry'
-	end
-end
-
 ########
 # YARD #
 ########

data/lib/filigree/commands.rb

@@ -30,6 +30,8 @@ end
 
 module Filigree
 	module Commands
+		using Filigree
+
 		include ClassMethodsModule
 
 		####################
@@ -38,14 +40,23 @@ module Filigree
 
 		# This will find the appropriate command and execute it.
 		#
-		# @param [String]  line  String containing the command to be processed and its arguments
+		# @param [String, Array<String>]  overloaded  String containing the command to be processed and its arguments
 		#
 		# @return [Object]  Result of invoking the command's block
-		def call(line)
-			namespace, rest = self.class.get_namespace(line.split)
+		def call(overloaded)
+			split_line =
+			if overloaded.is_a?(String)
+				overloaded.split
+			elsif overloaded.is_a?(Array)
+				overloaded
+			else
+				raise TypeError, "Expected a String or Array of Strings."
+			end
+
+			namespace, rest = self.class.get_namespace(split_line)
 
 			if namespace == self.class.commands
-				raise CommandNotFoundError, line
+				raise CommandNotFoundError, split_line.join(' ')
 			end
 
 			command = namespace[:nil]
@@ -63,7 +74,9 @@ module Filigree
 			if command.action.arity < 0 or command.action.arity == rest.length
 				self.instance_exec(*rest, &action)
 			else
-				raise ArgumentError, "Wrong number of arguments for command: #{command.name}."
+				raise ArgumentError,
+				      "Wrong number of arguments for command: #{command.name}. " +
+				      "Expected #{command.action.arity} but got #{rest.length}."
 			end
 		end
 
@@ -209,7 +222,8 @@ module Filigree
 		#################
 
 		# The POD representing a command.
-		Command = Struct.new(:name, :help, :param_help, :config, :action)
+		class Command < Struct.new(:name, :help, :param_help, :config, :action)
+		end
 
 		########################
 		# Pre-defined Commands #
@@ -243,6 +257,8 @@ module Filigree
 					puts Filigree::Configuration::Option.to_s(options, max_length + 4)
 				end
 
+				puts
+				puts "\t#{comm.help}"
 				puts
 
 				if !comm.param_help.empty?
@@ -253,7 +269,7 @@ module Filigree
 
 					segment_indent	= max_param_len + 8
 					comm.param_help.each do |name, help|
-						printf "     %-#{max_param_len}s - %s\n", name, help.segment(segment_indent)
+						printf "\t%-#{max_param_len}s - %s\n", name, help.segment(segment_indent)
 					end
 				end
 			end

data/lib/filigree/configuration.rb

@@ -13,6 +13,12 @@
 require 'filigree/class_methods_module'
 require 'filigree/string'
 
+#########
+# Notes #
+#########
+
+# TODO: Add support for configuration destructors
+
 #######################
 # Classes and Modules #
 #######################
@@ -92,7 +98,7 @@ module Filigree
 
 			case overloaded
 			when Array
-				handle_array_options(overloaded, set_opts)
+				handle_array_options(overloaded.clone, set_opts)
 
 			when String, IO
 				handle_serialized_options(overloaded, set_opts)
@@ -109,6 +115,13 @@ module Filigree
 			self.class.required_options.each do |option|
 				raise ArgumentError, "Option #{option} not set." if self.send(option).nil?
 			end
+
+			# Initialize the auto options
+			self.class.auto_blocks.each do |name, block|
+				result = self.instance_exec(&block)
+
+				self.define_singleton_method(name) { result }
+			end
 		end
 
 		# Find the appropriate option object given a string.
@@ -127,6 +140,8 @@ module Filigree
 
 		# Configure the object from an array of strings.
 		#
+		# TODO: Improve the way arguments are pulled out of the ARGV array.
+		#
 		# @param [Array<String>]  argv      String options
 		# @param [Array<String>]  set_opts  List of names of options already added
 		#
@@ -185,6 +200,8 @@ module Filigree
 		#################
 
 		module ClassMethods
+			# @return [Hash<Symbol, Block>]  Hash of names to blocks used for auto configuration
+			attr_reader :auto_blocks
 			# @return [Hash<String, Option>]  Hash of options with long names used as keys
 			attr_reader :options_long
 			# @return [Hash<String, Option>]  hash of options with short name used as keys
@@ -209,7 +226,7 @@ module Filigree
 			#
 			# @return [void]
 			def auto(name, &block)
-				define_method(name, &block)
+				@auto_blocks[name.to_sym] = block
 			end
 
 			# Define a boolean option.  The variable will be set to true if
@@ -248,6 +265,7 @@ module Filigree
 			#
 			# @return [void]
 			def install_icvars
+				@auto_blocks   = Hash.new
 				@help_string   = ''
 				@next_default  = nil
 				@next_required = false
@@ -266,8 +284,7 @@ module Filigree
 			#
 			# @return [void]
 			def option(long, short = nil, conversions: nil, &block)
-
-				long  = long.to_s
+				long  = long.to_s.gsub('-', '_')
 				short = short.to_s if short
 
 				add_option Option.new(long, short, @help_string, @next_default,
@@ -337,6 +354,8 @@ module Filigree
 		# This class represents an option that can appear in the
 		# configuration.
 		class Option < Struct.new(:long, :short, :help, :default, :handler)
+			using Filigree
+
 			# Returns the number of arguments that this option takes.
 			#
 			# @return [Fixnum]  Number of arguments the option takes
@@ -350,7 +369,7 @@ module Filigree
 			# Print the option information out as a string.
 			#
 			# Layout:
-			# |       ||--`long`,|| ||-`short`|| ~ |
+			# |       ||--`long`,|| ||-`short`||   |
 			# |_______||_________||_||________||___|
 			#   indent    max_l+3  1   max_s+1   3
 			#
@@ -364,9 +383,9 @@ module Filigree
 				segmented_help = self.help.segment(segment_indent)
 
 				if self.short
-					sprintf "#{' ' * indent}%-#{max_long + 3}s %-#{max_short + 1}s ~ %s", "--#{self.long},", '-' + self.short, segmented_help
+					sprintf "#{' ' * indent}%-#{max_long + 3}s %-#{max_short + 1}s   %s", "--#{self.long},", '-' + self.short, segmented_help
 				else
-					sprintf "#{' ' * indent}%-#{max_long + max_short + 5}s ~ %s", '--' + self.long, segmented_help
+					sprintf "#{' ' * indent}%-#{max_long + max_short + 5}s   %s", '--' + self.long, segmented_help
 				end
 			end
 
@@ -396,7 +415,7 @@ module Filigree
 
 		# The default help option.  This can be added to your class via
 		# add_option.
-		HELP_OPTION = Option.new('help', 'h', 'Prints this help message.', nil, Proc.new do
+		HELP_OPTION = Option.new('help', 'h', 'Prints this help message', nil, Proc.new do
 			puts "Usage: #{self.class.usage}"
 			puts
 			puts 'Options:'

data/lib/filigree/match.rb

@@ -22,9 +22,9 @@ require 'filigree/class'
 # An error that indicates that no pattern matched a given object.
 class MatchError < RuntimeError; end
 
-###########
-# Methods #
-###########
+#######################
+# Classes and Modules #
+#######################
 
 # This is an implementation of pattern matching.  The objects passed to match
 # are tested against the patterns defined inside the match block.  The return
@@ -162,10 +162,6 @@ def match(*objects, &block)
 	me.find_match(objects)
 end
 
-#######################
-# Classes and Modules #
-#######################
-
 module Filigree
 
 	using Filigree

data/lib/filigree/version.rb

@@ -4,5 +4,5 @@
 # Description: This file specifies the version number of Filigree.
 
 module Filigree
-	VERSION = '0.4.0'
+	VERSION = '0.4.1'
 end

data/lib/filigree/visitor.rb

@@ -241,17 +241,17 @@ module Filigree
 				children.flatten.compact.inject(false) { |mod, child| child.visit(visitor, :preorder) || mod } || res
 
 			when :inorder
-				mod   = false
+				lmod   = false
 				nodes = [self]
 
 				# Not all Ruby implementations support modifying arrays while
 				# you are iterating over them.
 				while node = nodes.shift
 					nodes += node.children.flatten.compact
-					mod    = visitor.visit(node) || mod
+					lmod = visitor.visit(node) || lmod
 				end
 
-				mod
+				lmod
 
 			when :postorder
 				res = children.flatten.compact.inject(false) { |modified, child| child.visit(visitor, :postorder) || modified }

data/test/tc_match.rb

@@ -153,16 +153,16 @@ class MatchTester < Minitest::Test
 		end
 	end
 
-	def match_tester_tuple(*touple)
-		match(*touple) do
+	def match_tester_tuple(*tuple)
+		match(*tuple)do
 			with(1, 2) { :FOO }
 			with(3, 4) { :BAR }
 			with(5)    { :BAF }
 		end
 	end
 
-	def match_tester_tuple_wildcard(*touple)
-		match(*touple) do
+	def match_tester_tuple_wildcard(*tuple)
+		match(*tuple)do
 			with(1)
 			with(2, 3) { :DEF }
 			with(4, _) { :PART_WILD }

data/test/tc_string.rb

@@ -29,9 +29,6 @@ Hello, I am a test string.
   code can be tested.
 eos
 
-	def setup
-	end
-
 	def test_segmentation
 		assert_equal SEGMENTED.chomp, ORIGINAL.segment(2, 30)
 	end

metadata

@@ -1,167 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: filigree
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Chris Wailes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-notes
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubygems-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.9
 description: Filigree provides new classes and extensions to core library classes
@@ -205,7 +177,7 @@ files:
 - test/ts_filigree.rb
 homepage: https://github.com/chriswailes/filigree
 licenses:
-- University of Illinois/NCSA Open Source License
+- NCSA
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -228,16 +200,16 @@ signing_key:
 specification_version: 4
 summary: Extra functionality for Ruby.
 test_files:
-- test/tc_boolean.rb
-- test/tc_object.rb
-- test/tc_types.rb
-- test/tc_configuration.rb
 - test/tc_commands.rb
+- test/tc_types.rb
+- test/tc_class.rb
 - test/tc_string.rb
+- test/tc_application.rb
+- test/tc_match.rb
 - test/tc_abstract_class.rb
-- test/tc_visitor.rb
+- test/tc_object.rb
 - test/tc_class_methods_module.rb
-- test/tc_match.rb
-- test/tc_class.rb
-- test/tc_application.rb
+- test/tc_configuration.rb
+- test/tc_boolean.rb
+- test/tc_visitor.rb
 - test/ts_filigree.rb