factory 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af7197952cadafdfba8350d996ceeb68ac7a36ac
+  data.tar.gz: e8ac58587592718d33024f25f605fe79cae03c7d
+SHA512:
+  metadata.gz: 99f06461fb2a002858d3be54f6654f50892e96d2188c7492f0d5c2f91119d42598ac124b15b61bf26a73d8907761508cda7fb32a2cfdeca6ed85d9ced9bcb5d6
+  data.tar.gz: 45b57955dd35837f63a9ba1c4f4ae339ef0a3ee3012937e4398d0401e2ae92c947f98a2abe27e4317f5e6425ee9975a9dce1f168f42253c150ba46e6964b3f6b

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw[po]
+Gemfile.lock
+/html
+/garbage
+/tmp
+/temp
+/trash

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+# gem "rails"

data/README.rdoc

@@ -0,0 +1,92 @@
+Welcome to the Factory!
+
+=Overview
+
+The Factory mixin provides a robust Factory implementation. Overrides are
+automatically registered upon sub-classing. Manual override and disables are 
+available if auto-registration does not result in the desired factory overrides.
+Manual overrides are available at the class and global granularities. Method arguments
+can be passed in as strings or symbols so that overrides can be set even before classes
+have been defined.
+
+=Usage
+
+==Using the Factory
+
+The Factory module should be included in the classes which you want to provide factory
+overrides. 
+ class ParentClass
+   include Factory
+   def initialize arg=nil
+     @arg = arg
+   end
+ end
+Inheriting from this class will automatically register the sub-class as the override
+of the parent class.
+ class Child1 < ParentClass
+ end
+Sub-classes need not include +Factory+ though doing so should not hurt anything.  
+The +create+ class method is implemeted by the mixin for the parent class and all
+sub-classes. Constructor arguments can be passed similarly through +create+.
+ ParentClass.create('hello') # Returns an object of type Child1
+Subsequent sub-classing updates the factory overrides.
+ class Child2 < Child1
+ end
+
+ ParentClass.create # Returns an object of type Child2
+ Child1.create # Returns an object of type Child2
+ ParentClass.new # Works normally. Returns an object of type ParentClass.
+
+ class Child3 < ParentClass
+ end
+
+ ParentClass.create # Returns an object of type Child3
+ Child1.create # Returns an object of type Child2 since Child3 is not a decendent.
+
+== Manual Factory Overrides
+
+If the resulting factory overrides are not what is desired, they can be manually
+overriden.  
+The methods that are discussed in the section takes arguments which are the class
+constants
+ Factory.global_disable_override Child3
+or as a symbol (strings are also accepted).
+ Factory.global_disable_override :Child3
+This allows overrides to be used even before a class is defined.  
+
+=== Factory Override Disable
+
+Continuing from the above example +ParentClass+ has a factory override of +Child3+
+since it was the last sub-class to inherit from it. If the intention is to have
++Child2+ be the factory override there are several ways this can be accomplished.  
+To disable a class from overriding a particular class either of the following can
+be used.
+ Factory.disable_override ParentClass, Child3
+ ParentClass.create # Returns an object of type Child2
+or,
+ ParentClass.disable_factory_override Child3
+ ParentClass.create # Returns an object of type Child2
+Since the disable is with respect to a specific ancestor, other ancestors are 
+uneffected.  
+
+=== Factory Override Enable
+
+Another way of manually configuring overrides is through enabling an override. This
+can also be used to cancel an existing class specific factory disable override.
+ Factory.enable_override ParentClass, Child3
+ ParentClass.create # Returns an object of type Child3
+The last override enable takes presedence.
+ Factory.enable_override ParentClass, Child2
+ ParentClass.create # Returns an object of type Child2
+or, 
+ ParentClass.enable_override Child2
+ ParentClass.create # Returns an object of type Child2
+Subsequent calls of the disable override methods will cancel the previous enable
+overrides on the same types.  
+
+=== Global Factory Override Methods
+
+To disable a class from overriding any classes use the following, 
+ Factory.global_disable_override Child3
+To cancel the disable override,
+ Factory.remove_global_disable_override Child3

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake/testtask'
+require 'rdoc/task'
+
+#
+# Rake defined tasks 
+# 
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.test_files = FileList['test/test*.rb']
+#	t.verbose = true
+end
+
+Rake::RDocTask.new(:rdoc) do |rd|
+	rd.main = "doc/README.rdoc"
+	rd.rdoc_files.include("doc/*.rdoc", "lib/**/*.rb", "bin/*")
+	rd.title = "Factory API"
+	rd.options << "--include=doc"
+end
+
+Rake::RDocTask.new(:rdoc_dev) do |rd|
+	rd.main = "doc/README.rdoc"
+	rd.rdoc_files.include("doc/*.rdoc", "lib/**/*.rb", "test/**/*.rb", "bin/*")
+	rd.rdoc_dir = "html_dev"
+	rd.title = "Factory Development API"
+	rd.options << "--all"
+	rd.options << "--include=doc"
+end
+

data/factory.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "factory"
+  spec.version       = Factory::VERSION
+  spec.authors       = ["Ben Delsol"]
+  spec.email         = ["ben.delsol@intel.com"]
+	spec.summary       = "Provides a simple factory module for object construction."
+	spec.description   = ""
+  spec.homepage      = ""
+
+  orig = $VERBOSE; $VERBOSE = nil
+  spec.files         = `git ls-files`.split($/)
+  $VERBOSE = orig
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "0.8.7"
+  spec.add_development_dependency "rdoc"
+
+	spec.extra_rdoc_files = Dir.glob("doc/*.rdoc")
+	spec.has_rdoc = true
+	spec.rdoc_options += ["--title=TestStats API",
+			"--main=README.rdoc", "-f", "hanna"]
+end
+

data/lib/factory.rb

@@ -0,0 +1,228 @@
+
+require 'factory/version'
+
+# The Factory mixin provides a robust Factory implementation. Overrides are
+# automatically registered upon sub-classing. Manual override and disables are 
+# available if auto-registration does not result in the desired factory overrides.
+# Manual overrides are available at the class and global granularities. Method arguments
+# can be passed in as strings or symbols so that overrides can be set even before 
+# classes have been defined.
+module Factory
+
+	@override_lists = {}
+	@global_override_disables = []
+
+	# OverrideList is used to keep track of a classes various override settings.
+	class OverrideList #:nodoc:
+
+		attr_reader :class_name, :parent
+
+		def initialize name
+			@class_name = name
+			@parent = nil
+			@sub_class_overrides = []
+			@override_disables = []
+			@manual_overrides =[]
+		end
+
+		# Used to specify the parent class of the class which this OverrideList is for.
+		def parent= class_name
+			if (!@parent.nil? and !class_name.nil?) and (@parent != class_name)
+				raise "parent can be written only once." 
+			end
+			@parent ||= class_name
+		end
+
+		# Called by Factory when a registered class is inherited from.
+		def add_inherited_override sub_class
+			@sub_class_overrides << sub_class
+		end
+
+		# Called by Factory when the user is manually overriding factory override 
+		# sub-class defaults.
+		def add_override name
+			@manual_overrides << name
+			@override_disables.delete name
+		end
+
+		# Called by Factory when the user is manually overriding factory override 
+		# sub-class defaults.
+		def remove_override name
+			@override_disables << name
+		end
+
+		# Calculates and returns the class name as string of the factory override for the
+		# class which this OverrideList is for. Manual and global overrides take 
+		# presedence over automatic overrides via inheritance.
+		def get_override
+			overrides = @sub_class_overrides + @manual_overrides
+			while !overrides.empty?
+				override = overrides.pop
+				return override unless @override_disables.include? override or 
+												Factory.global_override_disables.include? override
+			end
+			return @class_name
+		end
+
+		# Called during testing.
+		def reset_overrides #:nodoc:
+			@manual_overrides.clear
+			@override_disables.clear
+		end
+
+		# Returns a print friendly string which summarizes the factory override
+		# configuration.
+		def to_s
+			<<-TXT
+Factory Class: #{class_name}
+  Parent:                   #{parent.nil? ? 'Not in Factory' : parent}
+  Sub-class Overrides:      #{@sub_class_overrides.empty? ?
+										'None' : @sub_class_overrides.join(', ')}
+  Manual Overrides:         #{@manual_overrides.empty? ?
+  										'None' : @manual_overrides.join(', ')}
+  Manual Override Disables: #{@override_disables.empty? ? 
+  										'None' : @override_disables.join(', ')}
+  Factory Override:         #{get_override}
+			TXT
+		end
+
+	end
+
+	########################################
+	# Factory Class Methods
+	########################################
+	
+	# Include callback which adds class methods to the including class.
+	def self.included klass #:nodoc:
+		Factory.create_override_list klass
+		klass.extend Factory::ClassMethods
+	end
+
+	# The methods in this module will be added to classes which include Factory as
+	# class methods.
+	module ClassMethods
+
+		# Inheritance callback. Creates an OverrideList and adds sub-class auto-overrides.
+		def inherited sub_class #:nodoc:
+			Factory.create_override_list sub_class, self
+			Factory.inherited_override self, sub_class
+		end
+
+		# Used to create objects of the type registered as the classes factory override.
+		def create *args
+			return Factory[self].new() if args.empty?
+			return Factory[self].new(*args)
+		end
+
+		# Used to manually enable class specific override class.
+		def enable_factory_override overriding_class
+			Factory.enable_override self, overriding_class
+		end
+
+		# Used to manually disable class specific override class.
+		def disable_factory_override overriding_class
+			Factory.disable_override self, overriding_class
+		end
+
+		# Accessor which returns the class which is registered as this classes override.
+		def factory_override
+			Factory[self]
+		end
+
+	end
+	
+	########################################
+	# Class Method Mixins
+	########################################
+	
+	# Registers a class in the factory by creating it an OverrideList.
+	def self.create_override_list klass, parent=nil #:nodoc:
+		parent = parent.to_s unless parent.nil?
+		@override_lists[klass.to_s] ||= OverrideList.new(klass.to_s)
+		@override_lists[klass.to_s].parent ||= parent
+		return @override_lists[klass.to_s]
+	end
+
+	# Adds inherited overrides up the chain of ancestors.
+	def self.inherited_override parent, sub_class #:nodoc:
+		override_list = @override_lists[parent.to_s]
+		override_list.add_inherited_override sub_class.to_s
+		if override_list.parent
+			Factory.inherited_override override_list.parent, sub_class.to_s
+		end
+	end
+
+	# Returns an OverrideList for +klass+ or creates it if it does not already exist.
+	def self.override_list klass #:nodoc:
+		@override_lists[klass.to_s] ||= Factory.create_override_list(klass.to_s)
+	end
+
+	# Accessor which returns the +@global_override_disables+ array.
+	def self.global_override_disables #:nodoc:
+		@global_override_disables.dup
+	end
+
+	# Used for testing purposes. Resets all manual override arrays. 
+	def self.reset_overrides #:nodoc:
+		@global_override_disables.clear
+		@override_lists.each_value do |ovr_list|
+			ovr_list.reset_overrides
+		end
+	end
+
+	# Used to manually enable class specific override class.
+	def self.enable_override overridden_class, overriding_class
+		Factory.override_list(overridden_class).add_override overriding_class.to_s
+	end
+	
+	# Used to manually disable class specific override class.
+	def self.disable_override overridden_class, overriding_class
+		Factory.override_list(overridden_class.to_s).remove_override overriding_class.to_s
+	end
+
+	# Used to manually disable a class from overriding any ancestors.
+	def self.global_disable_override overriding_class
+		@global_override_disables << overriding_class.to_s
+	end
+
+	# Used to cancel a previous +global_disable_override+.
+	def self.remove_global_disable_override overriding_class
+		@global_override_disables.delete overriding_class.to_s
+	end
+
+	# Accessor which returns the factory override of +base_class+.
+	def self.[] base_class
+		if @override_lists[base_class.to_s].nil?
+			raise "class called #{base_class} is not registered with the factory."
+		end
+		eval @override_lists[base_class.to_s].get_override 
+	end
+
+	# Prints a summary of the Factory override configuration. Returns the summary as
+	# a string. The summary will not be printed if +silent+ is true.
+	def self.print_overrides silent=false
+		s = <<-TXT
+********************************
+ Factory Overrides
+********************************
+
+Global Factory Override Disables: #{@global_override_disables.empty? ?
+				'None' : @global_override_disables.join(', ')}
+
+			TXT
+
+		@override_lists.each_value {|ovr_list| s += ovr_list.to_s }
+		puts s unless silent
+
+		return s
+
+	end
+
+	########################################
+	# Instance Method Mixins
+	########################################
+	
+	# None.
+
+end
+

data/lib/factory/version.rb

@@ -0,0 +1,5 @@
+
+module Factory
+	VERSION = '1.0.0'
+end
+

data/test/helper.rb

@@ -0,0 +1,32 @@
+
+require 'rubygems'
+require 'bundler'
+require 'factory'
+
+Factory.enable_override :Base, :C3
+Factory.global_disable_override :C4
+class Base
+	include Factory
+	attr_reader :arg
+	def initialize arg=nil
+		@arg = arg
+	end
+end
+
+class C1 < Base
+	include Factory # Not needed but shouldn't hurt anything
+end
+C1.disable_factory_override :C5
+class C2 < Base
+end
+class C3 < C1
+end
+class C4 < C2
+end
+class C5 < C1
+end
+Array.class_eval do
+	include Factory
+end
+class Array2 < Array
+end

data/test/test_factory.rb

@@ -0,0 +1,235 @@
+
+require 'helper'
+require 'test/unit'
+
+class FactoryTest < Test::Unit::TestCase
+
+	def test_factory01_pre_class_definition_overrides
+
+		assert_equal C3, Base.create.class
+		assert_equal C3, Factory[Base]
+		assert_equal C3, Base.factory_override
+
+		assert_equal C2, C2.create.class
+		assert_equal C2, Factory[C2]
+		assert_equal C2, C2.factory_override
+
+	end
+
+	def test_factory02_check_inherited_overrides
+
+		assert_equal C3, C1.create.class
+		assert_equal C3, Factory[C1]
+		assert_equal C3, C1.factory_override
+
+		assert_equal C3, C3.create.class
+		assert_equal C3, Factory[C3]
+		assert_equal C3, C3.factory_override
+
+		assert_equal Array2, Array.create.class
+		assert_equal Array2, Factory[Array]
+
+	end
+
+	def test_factory03_enable_disable_factory_overrides
+		Factory.reset_overrides
+
+		# def enable_factory_override overriding_class
+		# 	Factory.enable_override self, overriding_class
+		# end
+
+		# def disable_factory_override overriding_class
+		# 	Factory.disable_override self, overriding_class
+		# end
+
+		C1.enable_factory_override C3
+
+		assert_equal C5, Base.create.class
+		assert_equal C5, Factory[Base]
+		assert_equal C5, Base.factory_override
+		assert_equal C3, C1.create.class
+		assert_equal C3, Factory[C1]
+		assert_equal C3, C1.factory_override
+		assert_equal C3, C3.create.class
+		assert_equal C3, Factory[C3]
+		assert_equal C3, C3.factory_override
+		assert_equal C5, C5.create.class
+		assert_equal C5, Factory[C5]
+		assert_equal C5, C5.factory_override
+
+		C1.disable_factory_override C3
+		Factory.disable_override :C1, C5
+		C2.disable_factory_override :C4
+
+		assert_equal C5, Base.create.class
+		assert_equal C5, Factory[Base]
+		assert_equal C5, Base.factory_override
+		assert_equal C1, C1.create.class
+		assert_equal C1, Factory[C1]
+		assert_equal C1, C1.factory_override
+		assert_equal C3, C3.create.class
+		assert_equal C3, Factory[C3]
+		assert_equal C3, C3.factory_override
+		assert_equal C5, C5.create.class
+		assert_equal C5, Factory[C5]
+		assert_equal C5, C5.factory_override
+		assert_equal C2, C2.create.class
+		assert_equal C2, Factory[C2]
+		assert_equal C2, C2.factory_override
+
+		Factory.enable_override :Base, C1
+		C3.enable_factory_override :C5
+		Factory.enable_override "C1", "C3"
+
+		assert_equal C1, Base.create.class
+		assert_equal C1, Factory[Base]
+		assert_equal C1, Base.factory_override
+		assert_equal C3, C1.create.class
+		assert_equal C3, Factory[C1]
+		assert_equal C3, C1.factory_override
+		assert_equal C5, C3.create.class
+		assert_equal C5, Factory[C3]
+		assert_equal C5, C3.factory_override
+		assert_equal C5, C5.create.class
+		assert_equal C5, Factory[C5]
+		assert_equal C5, C5.factory_override
+
+		Factory.disable_override :Array, Array2
+
+		assert_equal Array, Array.create.class
+		assert_equal Array, Factory[Array]
+
+		Array.enable_factory_override Array2
+
+		assert_equal Array2, Array.create.class
+		assert_equal Array2, Factory[Array]
+
+	end
+
+	def test_factory05_global_disable_override_and_remove_global_disable_override
+		Factory.reset_overrides
+
+		Factory.global_disable_override :C4
+		Factory.global_disable_override C5
+
+		assert_equal C3, Base.create.class
+		assert_equal C3, Factory[Base]
+		assert_equal C3, Base.factory_override
+		assert_equal C3, C1.create.class
+		assert_equal C3, Factory[C1]
+		assert_equal C3, C1.factory_override
+		assert_equal C3, C3.create.class
+		assert_equal C3, Factory[C3]
+		assert_equal C3, C3.factory_override
+		assert_equal C5, C5.create.class
+		assert_equal C5, Factory[C5]
+		assert_equal C5, C5.factory_override
+		assert_equal C2, C2.create.class
+		assert_equal C2, Factory[C2]
+		assert_equal C2, C2.factory_override
+		assert_equal C4, C4.create.class
+		assert_equal C4, Factory[C4]
+		assert_equal C4, C4.factory_override
+
+		Factory.remove_global_disable_override C4
+
+		assert_equal C4, Base.create.class
+		assert_equal C4, Factory[Base]
+		assert_equal C4, Base.factory_override
+		assert_equal C3, C1.create.class
+		assert_equal C3, Factory[C1]
+		assert_equal C3, C1.factory_override
+		assert_equal C3, C3.create.class
+		assert_equal C3, Factory[C3]
+		assert_equal C3, C3.factory_override
+		assert_equal C5, C5.create.class
+		assert_equal C5, Factory[C5]
+		assert_equal C5, C5.factory_override
+		assert_equal C4, C2.create.class
+		assert_equal C4, Factory[C2]
+		assert_equal C4, C2.factory_override
+		assert_equal C4, C4.create.class
+		assert_equal C4, Factory[C4]
+		assert_equal C4, C4.factory_override
+
+	end
+
+	def test_factory06_create_args
+		Factory.reset_overrides
+		o = C1.create('hello')
+		assert_equal C5, o.class
+		assert_equal 'hello', o.arg
+	end
+
+	def test_factory07_print_overrides
+
+		Factory.reset_overrides
+
+		# One of each type of instance variable set
+		Factory.global_disable_override :C4
+		C1.enable_factory_override C3
+		Factory.disable_override :Array, Array2
+
+		expected_string = <<-TXT
+********************************
+ Factory Overrides
+********************************
+
+Global Factory Override Disables: C4
+
+Factory Class: Base
+  Parent:                   Not in Factory
+  Sub-class Overrides:      C1, C2, C3, C4, C5
+  Manual Overrides:         None
+  Manual Override Disables: None
+  Factory Override:         C5
+Factory Class: C1
+  Parent:                   Base
+  Sub-class Overrides:      C3, C5
+  Manual Overrides:         C3
+  Manual Override Disables: None
+  Factory Override:         C3
+Factory Class: C2
+  Parent:                   Base
+  Sub-class Overrides:      C4
+  Manual Overrides:         None
+  Manual Override Disables: None
+  Factory Override:         C2
+Factory Class: C3
+  Parent:                   C1
+  Sub-class Overrides:      None
+  Manual Overrides:         None
+  Manual Override Disables: None
+  Factory Override:         C3
+Factory Class: C4
+  Parent:                   C2
+  Sub-class Overrides:      None
+  Manual Overrides:         None
+  Manual Override Disables: None
+  Factory Override:         C4
+Factory Class: C5
+  Parent:                   C1
+  Sub-class Overrides:      None
+  Manual Overrides:         None
+  Manual Override Disables: None
+  Factory Override:         C5
+Factory Class: Array
+  Parent:                   Not in Factory
+  Sub-class Overrides:      Array2
+  Manual Overrides:         None
+  Manual Override Disables: Array2
+  Factory Override:         Array
+Factory Class: Array2
+  Parent:                   Array
+  Sub-class Overrides:      None
+  Manual Overrides:         None
+  Manual Override Disables: None
+  Factory Override:         Array2
+		TXT
+
+		assert_equal expected_string, Factory.print_overrides(true)
+
+	end
+
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: factory
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Delsol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-10 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+description: ''
+email:
+- ben.delsol@intel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- factory.gemspec
+- lib/factory.rb
+- lib/factory/version.rb
+- test/helper.rb
+- test/test_factory.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --title=TestStats API
+- --main=README.rdoc
+- -f
+- hanna
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Provides a simple factory module for object construction.
+test_files:
+- test/helper.rb
+- test/test_factory.rb