factory_loader 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.1.0 / 2008-03-17
+
+* Initial release
+
+

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/factory_loader.rb
+spec/factory_loader_spec.rb
+spec/sample_project
+spec/sample_project/lib
+spec/sample_project/lib/cat.rb
+spec/sample_project/lib/dog.rb
+spec/sample_project/lib/factories
+spec/sample_project/lib/factories/fish
+spec/sample_project/lib/factories/fish/dolphin_factory.rb
+spec/sample_project/lib/fish
+spec/sample_project/lib/fish/dolphin.rb
+spec/sample_project/lib/fish/guppy.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,48 @@
+= FactoryLoader
+
+* http://www.continuousthinking.com/factory_loader (url)
+
+== DESCRIPTION:
+
+FactoryLoader is intended to help scale object creation with less pain and less refactoring.
+
+Public git repository: 	git://github.com/zdennis/factory_loader.git
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+See RDOC
+
+== REQUIREMENTS:
+
+* active_support
+
+== INSTALL:
+
+* gem install factory_loader
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Zach Dennis, Mutually Human Software
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/rdoctask'
+
+task :default => :spec
+
+task :spec do
+  system "spec spec --pattern '**/*_spec.rb'"
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "FactoryLoader: intended to help scaling complex object creation with less pain and less refactoring." 
+  rdoc.rdoc_files.include('lib/**/*.rb', 'README','CHANGES','MIT-LICENSE')
+end
+
+require 'rubygems'
+require 'hoe'
+require './lib/factory_loader.rb'
+
+Hoe.new('factory_loader', FactoryLoader::VERSION) do |p|
+  p.developer('Zach Dennis', 'zach.dennis@gmail.com')
+end

data/lib/factory_loader.rb

@@ -0,0 +1,97 @@
+require 'find'
+
+# FactoryLoader is intended to help scale object creation with less pain and less 
+# refactoring. 
+#
+# In the early stages of a project object creation is simple and object
+# dependencies are kept to a minimum. As the project grows so does the
+# complexity of object dependencies and object creation. It doesn't make
+# sense to create custom factory classes upfront to deal with complex
+# object construction that may not exist yet. But when those custom
+# factories are needed it is usually painful and time consuming to update
+# the code base to use them. It's also easy for developers to give-in
+# due to time constraints and start making bad decisions.
+#
+# This is where FactoryLoader comes into play. It automaticaly creates a Factory
+# class for your objects and provides a Factory#create method which passes any arguments
+# along to your object's constructor.
+#
+# When you need to have custom factory behavior you can implement the factory
+# without having to update other code references (assuming you've used them
+# in the rest of your application rather then direct class references).
+#
+# For example given a directory structure like the below:
+#
+#   init.rb
+#   lib/
+#    |--things/
+#           |-- foo.rb
+#           |-- bar.rb
+#    |--factories/
+#           |-- bar_factory.rb
+#
+# Given this project directory structure you could have the following code 
+# in init.rb:
+#    factory_loader = FactoryLoader.new("lib/factories")
+#    factory_loader.load("lib/things")
+# 
+# The first call constructs a factory loader telling it which directory is used
+# to store custom factories. 
+#
+# The second call will create a factory for each *.rb file in the lib/things/
+# directory. So for the foo.rb file a FooFactory class will be created
+# which can be used to wrap creation of Foo objects. The generated factory
+# will provide a #create method which will pass along all arguments to
+# the constructor of the object it wraps. So...
+#    FooFactory.new.create :a => :b 
+# is the same as:
+#    Foo.new :a => :b
+#
+# A FooFactory will be created, but a BarFactory will not. This is because
+# we told the FactoryLoader that custom factories are storied in lib/factories/
+# and a bar_factory.rb exists there, so FactoryLoader assumes you want to use
+# a custom factory.
+#
+# Author: Zach Dennis, zdennis at mutuallyhuman dot com
+class FactoryLoader
+  VERSION = "0.1.0"
+  
+  def initialize(*factory_paths)
+    @factory_paths = factory_paths.map{ |f| File.expand_path(f) } 
+  end
+
+  def load(directory) # :nodoc:
+    Dir[directory + "/**/*.rb"].each do |file|
+      object_filename = File.basename(file, ".rb")
+      factory_filepath = "#{object_filename}_factory.rb"
+      unless custom_factory_exists?(factory_filepath)
+        load_object_factory object_filename.classify
+      end
+    end  
+  end
+  
+  private
+  
+  def custom_factory_exists?(factory_filepath)
+    found = false
+    @factory_paths.find do |path|
+      found = Dir["#{path}/**/#{factory_filepath}"].any?
+    end
+    found
+  end
+  
+  def load_object_factory(object_name)
+    factory_name = "#{object_name}Factory"
+    unless Object.const_defined?(factory_name)
+      eval <<-CODE
+        class ::#{factory_name}
+          def create(options={})
+            #{object_name}.new options
+          end
+        end
+      CODE
+    end
+  end
+end
+
+

data/spec/factory_loader_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fileutils'
+
+describe FactoryLoader, "#load" do
+  def load
+    FactoryLoader.new(CUSTOM_FACTORIES_DIR).load(SAMPLE_LIB_DIR)
+  end
+    
+    it "creates a factory for each .rb file in the loaded directory" do
+      load
+      Object.const_defined?("CatFactory").should be_true
+      Object.const_defined?("DogFactory").should be_true
+    end
+    
+    it "creates a factory for each .rb object in sub-directories of the loaded directory" do
+      load
+      Object.const_defined?("GuppyFactory").should be_true
+    end
+    
+    it "does not create a factory for .rb files in any custom factory directory" do
+      load
+      Object.const_defined?("AnimalFactory").should be_false
+    end
+  
+  it "does not create a factory for .rb files in a sub-directory of any custom factory directory" do
+    load
+    Object.const_defined?("DolphinFactory").should be_false
+  end
+  
+  describe "when a set of custom factory paths are given" do
+    before(:all) do
+      FileUtils.touch(SAMPLE_LIB_DIR + "/animal.rb")
+      FileUtils.touch(CUSTOM_FACTORIES_DIR + "/animal_factory.rb")
+    end
+    
+    after(:all) do
+      FileUtils.rm(SAMPLE_LIB_DIR + "/animal.rb")
+      FileUtils.rm(CUSTOM_FACTORIES_DIR + "/animal_factory.rb")
+    end
+    
+    it "does not create a factory for the presenter" do
+      load
+      Object.const_defined?("AnimalFactory").should be_false
+    end
+  end
+  
+  describe "a created factory" do
+    before(:all) do
+      ::Person = stub("Person model")
+      Dir["#{SAMPLE_LIB_DIR}/*.rb"].each{ |f| require f }
+      load
+    end
+  
+    describe '#create' do
+      before do
+        @object = mock "some new object"
+        ::Dog.stub!(:new).and_return(@object)
+      end
+      
+      it "creates a presenter passing along any options" do
+        ::Dog.should_receive(:new).with(:foo => :bar)
+        ::DogFactory.new.create(:foo => :bar)
+      end
+      
+      it "returns the newly created presenter" do
+        ::DogFactory.new.create.should == @object        
+      end
+    end
+  end
+end

data/spec/sample_project/lib/cat.rb

@@ -0,0 +1,3 @@
+class Cat
+  
+end

data/spec/sample_project/lib/dog.rb

@@ -0,0 +1,2 @@
+class Dog
+end

data/spec/sample_project/lib/fish/guppy.rb

@@ -0,0 +1,2 @@
+class Guppy
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+
+spec_helper = File.dirname(__FILE__) + '/../../../../spec/spec_helper.rb'
+if File.exists?(spec_helper)
+  puts "Running specs inside of rails project. Letting the Rails project load rspec."
+  require spec_helper
+else
+  puts "Running specs outside of rails project. Using active_support and rspec gems."
+  require 'rubygems'
+  require 'active_support'  
+  require 'spec'
+end
+
+SAMPLE_PROJECT_DIR = File.dirname(__FILE__) + '/sample_project'
+CUSTOM_FACTORIES_DIR = SAMPLE_PROJECT_DIR + "/lib/factories"
+SAMPLE_LIB_DIR = SAMPLE_PROJECT_DIR + "/lib"
+FileUtils.mkdir_p(CUSTOM_FACTORIES_DIR)
+require File.dirname(__FILE__) + '/../lib/factory_loader'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: factory_loader
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Zach Dennis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: "FactoryLoader is intended to help scale object creation with less pain and less refactoring.  Public git repository: \tgit://github.com/zdennis/factory_loader.git"
+email: 
+- zach.dennis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/factory_loader.rb
+- spec/factory_loader_spec.rb
+- spec/sample_project
+- spec/sample_project/lib
+- spec/sample_project/lib/cat.rb
+- spec/sample_project/lib/dog.rb
+- spec/sample_project/lib/factories
+- spec/sample_project/lib/factories/fish
+- spec/sample_project/lib/factories/fish/dolphin_factory.rb
+- spec/sample_project/lib/fish
+- spec/sample_project/lib/fish/dolphin.rb
+- spec/sample_project/lib/fish/guppy.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.continuousthinking.com/factory_loader (url)
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: factory_loader
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: FactoryLoader is intended to help scale object creation with less pain and less refactoring
+test_files: []
+