filigree 0.1.2

data/lib/filigree/types.rb

@@ -0,0 +1,159 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/05/04
+# Description:	Extensions to help with type checking.
+
+############
+# Requires #
+############
+
+# Standard Library
+
+# Filigree
+require 'filigree/class_methods_module'
+
+###########
+# Methods #
+###########
+
+# A method for type checking Ruby values.
+#
+# @param [Object]       obj       Object to type check.
+# @param [Class]        type      Class the object should be an instance of.
+# @param [String, nil]  blame     Variable name to blame for failed type checks.
+# @param [Boolean]      nillable  Object can be nil?
+# @param [Boolean]      strict    Strict or non-strict checking.  Uses `instance_of?` and `is_a?` respectively.
+#
+# @raise [ArgumentError] An error is raise if the type checking fails.
+#
+# @return [Object] The object passed as parameter o.
+def check_type(obj, type, blame = nil, nillable = false, strict = false)
+	type_ok = if strict then obj.instance_of?(type) else obj.is_a?(type) end || (obj.nil? and nillable)	
+	
+	if type_ok
+		obj
+	else
+		if blame
+			raise TypeError,
+				"Parameter #{blame} must be an instance of the #{type.name} class.  Received an instance of #{obj.class.name}."
+		else
+			raise TypeError,
+				"Expected an object of type #{type.name}.  Received an instance of #{obj.class.name}."
+		end
+	end
+end
+
+# A method for type checking Ruby array values.
+#
+# @param [Array<Object>]  array     Array of objects to type check.
+# @param [Class]          type      Class the objects should be an instance of.
+# @param [String, nil]    blame     Variable name to blame for failed type checks.
+# @param [Boolean]        nillable  Object can be nil?
+# @param [Boolean]        strict    Strict or non-strict checking.  Uses `instance_of?` and `is_a?` respectively.
+#
+# @raise [ArgumentError] An error is raise if the type checking fails.
+#
+# @return [Object] The object passed in parameter o.
+def check_array_type(array, type, blame = nil, nillable = false, strict = false)
+	array.each do |obj|
+		type_ok = if strict then obj.instance_of?(type) else obj.is_a?(type) end || (obj.nil? and nillable)
+		
+		if not type_ok
+			if blame
+				raise TypeError, "Parameter #{blame} must contain instances of the #{type.name} class."
+			else
+				raise TypeError, "Expected an object of type #{type.name}."
+			end
+		end
+	end
+end
+
+#######################
+# Classes and Modules #
+#######################
+
+module Filigree
+	# Allows the including class to define typed type checked instance
+	# variables.  This also provides a default constructor.
+	module TypedClass
+		include ClassMethodsModule
+		
+		# Set each of the typed instance variables to its corresponding
+		# value.
+		#
+		# @param [Array<Object>]  vals  Values to set typed variables to
+		#
+		# @return [void]
+		def set_typed_ivars(vals)
+			self.class.typed_ivars.zip(vals).each do |name, val|
+				self.send("#{name}=", val)
+			end
+		end
+	
+		module ClassMethods
+			# Define the default constructor for the including class.
+			#
+			# @param [Boolean]  strict  To use strict checking or not
+			#
+			# @return [void]
+			def default_constructor(strict = false)
+				class_eval do
+					if strict
+						def initialize(*vals)
+							if self.class.typed_ivars.length != vals.length
+								raise ArgumentError, "#{self.class.typed_ivars.length} arguments expected, #{vals.length} given."
+							end
+				
+							self.set_typed_ivars(vals)
+						end
+					else
+						def initialize(*vals)
+							self.set_typed_ivars(vals)
+						end
+					end
+				end
+			end
+			
+			# Define a new typed accessor.
+			#
+			# @param [Symbol]   name      Name of the accessor
+			# @param [Boolean]  nillable  If the value can be nil or not
+			# @param [Boolean]  strict    To use strict checking or not
+			# @param [Class]    type      Type of the accessor
+			# @param [Proc]     checker   Method used to check the type
+			#
+			# @return [void]
+			def define_typed_accessor(name, nillable, strict, type, checker)
+				define_method "#{name}=" do |obj|
+					self.instance_variable_set("@#{name}", checker.call(obj, type, name, nillable, strict))
+				end
+			end
+			private :define_typed_accessor
+			
+			# Define a typed instance variable.
+			#
+			# @param [Symbol]   name      Name of the accessor
+			# @param [Class]    type      Type of the accessor
+			# @param [Boolean]  nillable  If the value can be nil or not
+			# @param [Boolean]  strict    To use strict checking or not
+			#
+			# @return [void]
+			def typed_ivar(name, type, nillable = false, strict = false)
+				typed_ivars << name
+			
+				define_typed_accessor(name, nillable, strict, *
+					type.is_a?(Array) ? [type.first, method(:check_array_type)] : [type, method(:check_type)]
+				)
+		
+				attr_reader name
+			end
+			
+			# Return the typed instance variables for an object.
+			#
+			# @return [Array<Symbol>]  Array of defined typed instance variables
+			def typed_ivars
+				@typed_ivars ||= Array.new
+			end
+		end
+	end
+end

data/lib/filigree/version.rb

@@ -0,0 +1,8 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/4/19
+# Description:	This file specifies the version number of Filigree.
+
+module Filigree
+	VERSION = '0.1.2'
+end

data/lib/filigree/visitor.rb

@@ -0,0 +1,195 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2014/02/11
+# Description:	An implementation of the Visitor pattern.
+
+############
+# Requires #
+############
+
+# Standard Library
+
+# Filigree
+require 'filigree/class_methods_module'
+require 'filigree/match'
+
+#######################
+# Classes and Modules #
+#######################
+
+module Filigree
+	# An implementation of the Visitor pattern.
+	module Visitor
+	
+		include ClassMethodsModule
+	
+		####################
+		# Instance Methods #
+		####################
+		
+		# Find the correct pattern and execute its block on the provided
+		# objects.
+		#
+		# @param [Object]  objects  Objects to pattern match.
+		#
+		# @return [Object]  Result of calling the matched pattern's block
+		#
+		# @raise [MatchError]  Raised when no matching pattern is found
+		def call(*objects)
+			self.class.patterns.each do |pattern|
+				@match_bindings = OpenStruct.new
+		
+				return pattern.(self, objects) if pattern.match?(objects, self)
+			end
+	
+			# If we didn't find anything we raise a MatchError.
+			raise MatchError
+		end
+		alias :visit :call
+	
+		#############
+		# Callbacks #
+		#############
+		
+		# This is used to get and set binding names
+		def method_missing(name, *args)
+			if args.empty? and @match_bindings.respond_to?(name)
+				@match_bindings.send(name)
+			elsif name.to_s[-1] == '=' and args.length == 1
+				@match_bindings.send(name, *args)
+			else
+				super(name, *args)
+			end
+		end
+	
+		#################
+		# Class Methods #
+		#################
+	
+		module ClassMethods
+		
+			attr_reader :patterns
+			
+			# Force a name binding.
+			#
+			# @param [Symbol]  name  Name to bind to
+			#
+			# @return [BindingPattern]
+			def Bind(name)
+				BindingPattern.new(name)
+			end
+			
+			# Force a literal comparison.
+			#
+			# @param [Object]  obj  Object to be comapred against
+			#
+			# @return [LiteralPattern]
+			def Literal(obj)
+				LiteralPattern.new(obj)
+			end
+			
+			# Install the instance class variables in the including class.
+			#
+			# @return [void]
+			def install_icvars
+				@patterns = Array.new
+				@deferred = Array.new
+			end
+			
+			# Define a pattern for this visitor.
+			#
+			# @see match  Pattern matching description
+			#
+			# @param [Object]  pattern  List of pattern elements
+			# @param [Proc]    block    Block to be executed when the pattern is matched
+			#
+			# @return [void]
+			def on(*pattern, &block)
+				guard = if pattern.last.is_a?(Proc) then pattern.pop end 
+		
+				@patterns << (mp = OuterPattern.new(pattern, guard, block))
+		
+				if block
+					@deferred.each { |pattern| pattern.block = block }
+					@deferred.clear
+			
+				else
+					@deferred << mp
+				end
+			end
+		
+			#############
+			# Callbacks #
+			#############
+			
+			# Used to generate wildcard and binding patterns.
+			def method_missing(name, *args)
+				if args.empty?
+					if name == :_ then WildcardPattern.instance else BindingPattern.new(name) end
+				else
+					super(name, *args)
+				end
+			end
+	
+			def self.extended(klass)
+				klass.install_icvars
+			end
+		end
+	end
+	
+	# This class can be used to call multiple visitors on an object at once.
+	# This could potentialy reduce the number of times data structures are
+	# traversed.
+	class TourGuide
+		attr_reader :visitors
+		
+		# Call each visitor on the specified objects.
+		#
+		# @param [Object]  objects  Objects to be visited
+		#
+		# @return [Array<Visitor>]  The wrapped visitors
+		def call(*objects)
+			@visitors.each { |visitor| visitor.(*objects) }
+		end
+		
+		# Construct a tour guide for a list of visitors.
+		#
+		# @param [Visitor]  visitors  List of visitors
+		def initialize(*visitors)
+			@visitors = visitors
+		end
+	end
+	
+	# This module provides a default implementation of three common traversal
+	# patterns: pre-order, post-order, and in-order (level-order).  The
+	# including class must implement the `children` function.
+	module Visitable
+		
+		# Visit this object with the provided visitor in pre-, post-, or
+		# in-order traversal.
+		#
+		# @param [Visitor]                          visitor  Visitor to call
+		# @param [:preorder, :inorder, :postorder]  method   How to visit
+		#
+		# @return [void]
+		def visit(visitor, method = :preorder)
+			case method
+			when :preorder
+				visitor.(self)
+				children.compact.each { |child| child.visit(visitor, :preorder) }
+			
+			when :inorder
+				nodes = [self]
+			
+				while node = nodes.shift
+					nodes += node.children.compact
+					visitor.(node)
+				end
+			
+			when :postorder
+				children.compact.each { |child| child.visit(visitor, :postorder) }
+				visitor.(self)
+			end
+		end
+	end
+end

data/lib/filigree.rb

@@ -0,0 +1,27 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/4/19
+# Description:	The root file for the Filigree project.
+
+#############
+# Requires #
+############
+
+# Standard Library
+
+# Filigree
+require 'filigree/abstract_class'
+require 'filigree/application'
+require 'filigree/array'
+require 'filigree/boolean'
+require 'filigree/class'
+require 'filigree/class_methods_module'
+require 'filigree/commands'
+require 'filigree/configuration'
+require 'filigree/match'
+require 'filigree/object'
+require 'filigree/request_file'
+require 'filigree/string'
+require 'filigree/types'
+require 'filigree/version'
+require 'filigree/visitor'

data/test/tc_abstract_class.rb

@@ -0,0 +1,74 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/04/19
+# Description:	Test cases for the AbstractClass module.
+
+############
+# Requires #
+############
+
+# Gems
+require 'minitest/autorun'
+
+# Filigree
+require 'filigree/abstract_class'
+
+#######################
+# Classes and Modules #
+#######################
+
+class AbstractClassTester < Minitest::Test
+	class Foo
+		extend Filigree::AbstractClass
+		
+		abstract_method :foo
+	end
+	
+	class Bar < Foo; end
+	
+	class Bam < Foo
+		def foo
+			true
+		end
+	end
+	
+	class Baf < Foo
+		extend Filigree::AbstractClass
+	end
+	
+	class Zap < Baf; end
+	
+	def setup
+	end
+	
+	def test_abstract_method
+		assert_raises(AbstractMethodError) { Bar.new.foo }
+		
+		Bam.new.foo
+	end
+	
+	def test_instantiate_abstract_class
+		assert_raises(AbstractClassError) { Foo.new }
+	end
+	
+	def test_instantiate_subclass
+		Bar.new 
+	end
+	
+	def test_multi_level_abstract_hierarchy
+		assert_raises(AbstractClassError) { Baf.new }
+		
+		Zap.new
+	end
+	
+	def test_multiple_hierarchies
+		baf = Class.new { extend Filigree::AbstractClass }
+		baz = Class.new(baf)
+		
+		assert_raises(AbstractClassError) { Foo.new }
+		assert_raises(AbstractClassError) { baf.new }
+		
+		Bar.new
+		baz.new
+	end
+end

data/test/tc_application.rb

@@ -0,0 +1,53 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/05/15
+# Description:	Test cases for the Application module.
+
+############
+# Requires #
+############
+
+# Gems
+require 'minitest/autorun'
+
+# Filigree
+require 'filigree/application'
+
+#######################
+# Classes and Modules #
+#######################
+
+class ApplicationTester < Minitest::Test
+	class Foo
+		include Filigree::Application
+	end
+	
+	class Bar
+		include Filigree::Application
+		
+		class Configuration
+			auto :foo do
+				:foo
+			end
+		end
+		
+		def kill;   end
+		def pause;  end
+		def resume; end
+		def run;    end
+		def stop;   end
+	end
+	
+	def setup
+	
+	end
+	
+	def test_application
+		assert_raises(NoMethodError)	{ Foo.finalize }
+		Bar.finalize
+	end
+	
+	def test_embedded_config
+		assert_equal :foo, Bar.new.config.foo
+	end
+end

data/test/tc_array.rb

@@ -0,0 +1,28 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2014/02/05
+# Description:	Test cases for the Array extensions.
+
+############
+# Requires #
+############
+
+# Gems
+require 'minitest/autorun'
+
+# Filigree
+require 'filigree/array'
+
+#######################
+# Classes and Modules #
+#######################
+
+class ArrayTester < Minitest::Test
+	
+	def setup
+	end
+	
+	def test_map_with_method
+		assert_equal [:cat, :dog, :cow], ['cat', 'dog', 'cow'].map(:to_sym)
+	end
+end

data/test/tc_boolean.rb

@@ -0,0 +1,38 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/05/04
+# Description:	Test cases for Boolean extensions.
+
+############
+# Requires #
+############
+
+# Gems
+require 'minitest/autorun'
+
+# Filigree
+require 'filigree/boolean'
+
+#######################
+# Classes and Modules #
+#######################
+
+class BooleanTester < Minitest::Test
+	def setup
+		
+	end
+	
+	def test_integer
+		assert  1.to_bool
+		assert 10.to_bool
+		assert !0.to_bool
+	end
+	
+	def test_true
+		assert_equal 1, true.to_i
+	end
+	
+	def test_false
+		assert_equal 0, false.to_i
+	end
+end

data/test/tc_class.rb

@@ -0,0 +1,45 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/05/04
+# Description:	Test cases for Class extensions.
+
+############
+# Requires #
+############
+
+# Gems
+require 'minitest/autorun'
+
+# Filigree
+require 'filigree/class'
+
+#######################
+# Classes and Modules #
+#######################
+
+class ClassTester < Minitest::Test
+	module Foo; end
+	
+	class Bar
+		include Foo
+	
+		class Baf; end
+	end
+	
+	class Baz < Bar; end
+	
+	def setup
+		
+	end
+	
+	def test_class
+		assert Bar.includes_module?(Foo)
+		
+		assert_equal 'ClassTester::Bar::Baf', Bar::Baf.name 
+		assert_equal 'Baf', Bar::Baf.short_name
+		
+		assert  Baz.subclass_of?(Bar)
+		assert !Baz.subclass_of?(Fixnum)
+		assert_raises(TypeError) { Baz.subclass_of?(1) }
+	end
+end

data/test/tc_class_methods_module.rb

@@ -0,0 +1,71 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Filigree
+# Date:		2013/05/15
+# Description:	Test cases the InnerClassModule module.
+
+############
+# Requires #
+############
+
+# Gems
+require 'minitest/autorun'
+
+# Filigree
+require 'filigree/class_methods_module'
+
+#######################
+# Classes and Modules #
+#######################
+
+class ClassMethodsModuleTester < Minitest::Test
+	module Foo
+		include Filigree::ClassMethodsModule
+		
+		def foo
+			:foo
+		end
+		
+		module ClassMethods
+			def foo
+				:foo
+			end
+		end
+	end
+	
+	module Baz
+		include Filigree::ClassMethodsModule
+		
+		def baz
+			:baz
+		end
+		
+		module ClassMethods
+			def baz
+				:baz
+			end
+		end
+	end
+	
+	class Bar
+		include Foo
+	end
+	
+	class Baf
+		include Foo
+		include Baz
+	end
+	
+	def test_class_methods_module
+		assert_equal :foo, Bar.foo
+		assert_equal :foo, Bar.new.foo
+	end
+	
+	def test_double_include
+		
+		assert_equal :foo, Baf.foo
+		assert_equal :foo, Baf.new.foo
+		
+		assert_equal :baz, Baf.baz
+		assert_equal :baz, Baf.new.baz
+	end
+end