filigree 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f712ddbd29650262ea478bff2b9742c840929dee
-  data.tar.gz: 130669091a1246adac6601a9ec76848ac3772fc7
+  metadata.gz: 3c9911e71c1aab6f164a4f49af71b888f9f17f63
+  data.tar.gz: dda61f8f3d3181d3787d364cf54df9a716fa9b5a
 SHA512:
-  metadata.gz: 896a8a4972016b0166c616c7115f598e5e43cd621451765e5435f39809818cc066fb751963531db5138030ade28096a1af08866067fb2fd8750bbda0c20e2af7
-  data.tar.gz: b008d5b0221615918e45a6a40bffa1619f19626aea7150b82a46b6ad3a8be8b7d185d80a659ed6ec9cafc79f75006f6961ac073a9c0b945755fd2f965658de25
+  metadata.gz: be44708b88b56c8e6d654a11e5a343319dcf14283154fdcd7acd7b33c6c125c9211b6e8e5bfa44c37c8beb51f34ccb36fbce8440251e5c0728143ccad95c0c68
+  data.tar.gz: 1591d525b1bbfde2709a5180ab7fd51d13a0e507036c19f73a89824798ac7e2091099fa39b9240b8939cec8dad2ccd9e41cc470fe0c4365da6f4cd4457b1663c

data/README.md

@@ -68,12 +68,12 @@ The most basic pattern is the literal.  Here, the object or objects being matche
       with(_) { :other }
     end
   end
-  
+
   foo(1)  # => :one
   foo(42) # => :other
 ```
 
-You may also match against variables.  This can sometimes conflict with the next kind of pattern, which is a binding pattern.  Here, the pattern will match any object, and then make the object it matched available to the *with block* via an attribute reader.  This is accomplished using the method_missing callback, so if there is a variable or function with that name you might accidentally compare against a variable or returned value.  To bind to a name that is already in scope you can use the {Filigree::MatchEnvironment#Bind} method.  In addition, class and destructuring pattern results (see bellow) can be bound to a variable by using the {Filigree::BasicPattern#as} method. 
+You may also match against variables.  This can sometimes conflict with the next kind of pattern, which is a binding pattern.  Here, the pattern will match any object, and then make the object it matched available to the *with block* via an attribute reader.  This is accomplished using the method_missing callback, so if there is a variable or function with that name you might accidentally compare against a variable or returned value.  To bind to a name that is already in scope you can use either the {Filigree::MatchEnvironment#Bind} method or the `!` Symbol method.  In addition, class and destructuring pattern results (see bellow) can be bound to a variable by using the {Filigree::BasicPattern#as} method.
 
 ```Ruby
 var = 42
@@ -93,6 +93,8 @@ x = 3
 # Returns 42
 match 42 do
   with(Bind(:x)) { x      }
+  # Equivalent to the line above.
+  with(!:x)      { x      }
   with(42)       { :hoopy }
 end
 ```
@@ -163,7 +165,7 @@ Filigree's implementation of the visitor pattern is built on the pattern matchin
 class Binary < Struct.new(:x, :y)
   extend  Filigree::Destructurable
   include Filigree::Visitor
-  
+
   def destructure(_)
     [x, y]
   end
@@ -174,11 +176,11 @@ class Mul < Binary; end
 
 class MathVisitor
   include Filigree::Visitor
-  
+
   on(Add.(x, y)) do
     x + y
   end
-  
+
   on(Mul.(x, y)) do
     x * y
   end
@@ -236,26 +238,26 @@ Configuration Handling
 ```Ruby
 class MyConfig
   include Filigree::Configuration
-  
+
   add_option Filigree::Configuration::HELP_OPTION
-  
+
   help 'Sets the target'
   required
   string_option 'target', 't'
-  
+
   help 'Set the port for the target'
   default 1025
   option 'port', 'p', conversions: [:to_i]
-  
+
   help 'Set credentials'
   default ['user', 'password']
   option 'credentials', 'c', conversions: [:to_s, :to_s]
-  
+
   help 'Be verbose'
   bool_option 'verbose', 'v'
-  
+
   auto 'next_port' { self.port + 1 }
-  
+
   help 'load data from file'
   option 'file', 'f' do |f|
     process_file f
@@ -282,18 +284,18 @@ Now that we can parse configuration options, how about we handle commands?
 ```Ruby
 class MyCommands
   include Filigree::Commands
-  
+
   help 'Adds two numbers together'
   param 'x', 'The first number to add'
   param 'y', 'The second number to add'
   command 'add' do |x, y|
     x.to_i + y.to_i
   end
-  
+
   help 'Say hello from the command handler'
   config do
     default 'world'
-    string_option 'subject', 's' 
+    string_option 'subject', 's'
   end
   command 'hello' do
     "hello #{subject}"
@@ -312,7 +314,7 @@ Type Checking
 
 Filigree provides two ways to perform basic type checking at run time:
 
-1. {check_type} and {check_array_type}
+1. {check\_type} and {check\_array\_type}
 2. {Filigree::TypedClass}
 
 The first option will simply check the type of an object or an array of objects.  Optionally, you can assign blame to a named variable, allow the value to be nil, or perform strict checking.  Strict checking uses the `instance_of?` method while non-strict checking uses `is_a?`.
@@ -322,10 +324,10 @@ The second option works like so:
 ```Ruby
 class Foo
 	include Filigree::TypedClass
-	
+
 	typed_ivar :bar, Integer
 	typed_ivar :baz, String
-	
+
 	default_constructor
 end
 

data/lib/filigree/abstract_class.rb

@@ -36,11 +36,11 @@ end
 module Filigree
 	# A module the implements the abstract class and abstract method patterns.
 	module AbstractClass
-	
+
 		####################
 		# Instance Methods #
 		####################
-	
+
 		# Declares a method with the given name.  If it is called it will raise
 		# an AbstractMethodError.
 		#
@@ -49,19 +49,19 @@ module Filigree
 		# @return [void]
 		def abstract_method(name)
 			abstract_class_name = @abstract_class.name
-		
+
 			define_method name do
 				raise AbstractMethodError.new name, abstract_class_name
 			end
 		end
-	
+
 		# Install instance class variables in the extended class.
 		#
 		# @return [void]
 		def install_icvars
 			@abstract_class = self
 		end
-	
+
 		# Raise an AbstractClassError if someone attempts to instantiate an
 		# abstract class.
 		#
@@ -75,11 +75,11 @@ module Filigree
 				super
 			end
 		end
-	
+
 		#############
 		# Callbacks #
 		#############
-	
+
 		# Tell the extended class to install its instance class variables.
 		#
 		# @return [void]

data/lib/filigree/application.rb

@@ -30,11 +30,11 @@ module Filigree
 	# the basic framework for larger desktop and command line applications.
 	module Application
 		include ClassMethodsModule
-	
+
 		#############
 		# Constants #
 		#############
-	
+
 		REQUIRED_METHODS = [
 			:kill,
 			:pause,
@@ -46,29 +46,29 @@ module Filigree
 		####################
 		# Instance Methods #
 		####################
-	
+
 		attr_accessor :configuration
 		alias :config :configuration
-	
+
 		def initialize
 			@configuration = self.class::Configuration.new
-		
+
 			# Set up signal handlers.
 			Signal.trap('ABRT') { self.stop }
 			Signal.trap('INT')  { self.stop }
 			Signal.trap('QUIT') { self.stop }
 			Signal.trap('TERM') { self.stop }
-		
+
 			Signal.trap('KILL') { self.kill }
-		
+
 			Signal.trap('CONT') { self.resume }
 			Signal.trap('STOP') { self.pause  }
 		end
-	
+
 		#################
 		# Class Methods #
 		#################
-	
+
 		module ClassMethods
 			# Check to make sure all of the required methods are defined.
 			#
@@ -82,7 +82,7 @@ module Filigree
 					end
 				end
 			end
-			
+
 			# Create a new instance of this application and run it.
 			#
 			# @return [Object]
@@ -90,11 +90,11 @@ module Filigree
 				self.new.run
 			end
 		end
-	
+
 		#############
 		# Callbacks #
 		#############
-	   
+
 		class << self
 			alias :old_included :included
 

data/lib/filigree/class.rb

@@ -25,12 +25,12 @@ class Class
 	def includes_module?(mod)
 		self.included_modules.include?(mod)
 	end
-	
+
 	# @return [String]  Name of class without the namespace.
 	def short_name
 		self.name.split('::').last
 	end
-	
+
 	# Checks to see if a Class object is a subclass of the given class.
 	#
 	# @param [Class]  klass  Class we are checking if this is a subclass of.
@@ -38,7 +38,7 @@ class Class
 	# @return [Boolean]  If self is a subclass of klass
 	def subclass_of?(klass)
 		check_type(klass, Class, 'klass')
-		
+
 		if (superklass = self.superclass)
 			superklass == klass or superklass.subclass_of?(klass)
 		else

data/lib/filigree/class_methods_module.rb

@@ -32,7 +32,11 @@ module Filigree
 		def self.included(mod)
 			mod.instance_exec do
 				def included(mod)
-					mod.extend self::ClassMethods
+					mod.extend(self::ClassMethods) if self.const_defined?(:ClassMethods)
+
+					if self.method_defined?(:ClassVariables)
+						mod.instance_exec(self.method(:ClassVariables))
+					end
 				end
 			end
 		end

data/lib/filigree/commands.rb

@@ -30,11 +30,11 @@ end
 module Filigree
 	module Commands
 		include ClassMethodsModule
-	
+
 		####################
 		# Instance Methods #
 		####################
-	
+
 		# This will find the appropriate command and execute it.
 		#
 		# @param [String]  line  String containing the command to be processed and its arguments
@@ -42,41 +42,41 @@ module Filigree
 		# @return [Object]  Result of invoking the command's block
 		def call(line)
 			namespace, rest = self.class.get_namespace(line.split)
-		
+
 			if namespace == self.class.commands
 				raise CommandNotFoundError, line
 			end
-		
+
 			command = namespace[:nil]
-		
-			action = 
+
+			action =
 			if command.config
 				conf_obj = command.config.new(rest)
 				rest     = conf_obj.rest
-			
+
 				-> (*args) { conf_obj.instance_exec(*args, &command.action) }
 			else
 				command.action
 			end
-		
+
 			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}."
 			end
 		end
-	
+
 		#################
 		# Class Methods #
 		#################
-	
+
 		module ClassMethods
 			# @return [Hash<String, Hash>]
 			attr_accessor :commands
-			
+
 			# @return [Array<Command>]
 			attr_accessor :command_list
-			
+
 			# Add a command to the necessary internal data structures.
 			#
 			# @param [Command]  command_obj  Command to add
@@ -87,7 +87,7 @@ module Filigree
 				namespace = reify_namespace(command_obj.name.split.map(&:to_sym))
 				namespace[:nil] = command_obj
 			end
-			
+
 			# Add a new command to the class.  All command code is executed
 			# in the context of the Commands object.
 			#
@@ -97,12 +97,12 @@ module Filigree
 			# @return [void]
 			def command(str, &block)
 				add_command Command.new(str, @help_string, @param_docs, @config, block)
-			
+
 				@help_string = ''
 				@param_docs  = Array.new
 				@config      = nil
 			end
-			
+
 			# This will generate an anonymous {Configuration} class for this
 			# command.  After a string resolves to the next command defined
 			# the remainder of the command line will be passed to an
@@ -119,7 +119,7 @@ module Filigree
 				@config = Class.new { include Filigree::Configuration }
 				@config.instance_exec &block
 			end
-			
+
 			# Attaches the provided help string to the command that is
 			# defined next.
 			#
@@ -129,7 +129,7 @@ module Filigree
 			def help(str)
 				@help_string = str
 			end
-			
+
 			# Install the instance class variables in the including class.
 			#
 			# @return [void]
@@ -140,7 +140,7 @@ module Filigree
 				@help_string  = ''
 				@param_docs   = Array.new
 			end
-			
+
 			# Given a root namespace, find the namespace indicated by the
 			# provided tokens.
 			#
@@ -154,7 +154,7 @@ module Filigree
 					[root, tokens]
 				else
 					curr_token = tokens.first.to_sym
-				
+
 					if ns = root[curr_token]
 						tokens.shift
 						get_namespace(tokens, root: ns)
@@ -163,17 +163,17 @@ module Filigree
 					end
 				end
 			end
-			
+
 			# Add a description for a command's parameter.
 			#
 			# @param  [String]  name         Name of the parameter
 			# @param  [String]  description  Description of the parameter.
 			#
-			# @return [void] 
+			# @return [void]
 			def param(name, description)
 				@param_docs << [name, description]
 			end
-			
+
 			# Find or create the namespace specified by tokens.
 			#
 			# @param  [Array<String>]       tokens  Tokens specifying the namespace.
@@ -186,69 +186,69 @@ module Filigree
 					root
 				else
 					curr_token = tokens.shift
-				
+
 					ns = root[curr_token]
 					ns = root[curr_token] = Hash.new if ns.nil?
-				
+
 					reify_namespace(tokens, root: ns)
 				end
 			end
-		
+
 			#############
 			# Callbacks #
 			#############
-			
+
 			def self.extended(klass)
 				klass.install_icvars
 			end
 		end
-	
+
 		#################
 		# Inner Classes #
 		#################
-		
+
 		# The POD representing a command.
 		Command = Struct.new(:name, :help, :param_help, :config, :action)
-	
+
 		########################
 		# Pre-defined Commands #
 		########################
-		
+
 		# The default help command.  This can be added to your class via
 		# add_command.
 		HELP_COMMAND = Command.new('help', 'Prints this help message.', [], nil, Proc.new do
 			puts 'Usage: <command> [options] <args>'
 			puts
 			puts 'Commands:'
-		
+
 			comm_list = self.class.command_list
-		
+
 			sorted_comm_list = comm_list.sort { |a, b| a.name <=> b.name }
 			max_length       = comm_list.lazy.map { |opt| opt.name.length }.max
-		
-		
+
+
 			sorted_comm_list.each do |comm|
 				printf "  % #{max_length}s", comm.name
-			
+
 				if comm.config
 					print ' [options]'
 				end
-			
+
 				puts comm.param_help.inject('') { |str, pair| str << " <#{pair.first}>" }
-			
+
 				if comm.config
 					options = comm.config.options_long.values.sort { |a, b| a.long <=> b.long }
 					puts Filigree::Configuration::Option.to_s(options, max_length + 4)
 				end
-			
+
 				puts
-			
+
 				if !comm.param_help.empty?
 					max_param_len = comm.param_help.inject(0) do |max, pair|
 						param_len = pair.first.to_s.length
 						max <=  param_len ? param_len : max
 					end
-				
+
 					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)