floor_manager 0.1.0

data/LICENSE

@@ -0,0 +1,23 @@
+
+ Copyright (c) 2010 Kaspar Schiess
+
+ 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/README

@@ -0,0 +1,58 @@
+
+FLOOR MANAGER - when your job is handling the girls
+
+The floor manager manages a whole graph of objects and lets you create them 
+in memory or the database for the duration of a test. 
+
+You need two posts that are linked up to the same author? [1] Easy: 
+
+  FloorManager.define :first do
+    one :author do  
+      name 'John Smith'
+    end
+  
+    any :post do
+      title 'The posts title'
+      author.set :author
+    end
+  end
+
+And in your tests: 
+  
+  before(:each) do
+    FloorManager.reset
+    
+    floor = FloorManager.get(:floor)
+    posts = [floor.create(:post), floor.create(:post)]
+  end
+  
+This gives you two posts to test against. Both posts will have the same
+author, right down to the database id. 
+
+INSTALLATION
+
+Either by installing from http://github.com/kschiess/floor_manager as a rails
+plugin or by using rubygems:
+
+  gem install floor_manager
+  
+Then just require it atop of your floor definitions as follows: 
+
+  require 'floor_manager'
+  # Your floors go here...
+
+COMPATIBILITY
+
+This has only been tested with rails 2. Both Ruby 1.8 and Ruby 1.9 should
+work.
+
+STATUS
+
+Useful in daily life. 
+  
+AUTHOR
+
+Kaspar Schiess (kaspar.schiess@absurd.li)
+
+[1] http://robots.thoughtbot.com/post/159807023/waiting-for-a-factory-girl
+

data/Rakefile

@@ -0,0 +1,75 @@
+
+
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new
+
+
+task :default => ["spec"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "floor_manager"
+  s.version           = "0.1.0"
+  s.summary           = "Allows creation of a whole graph of objects on the fly during testing"
+  s.author            = "Kaspar Schiess"
+  s.email             = "kaspar.schiess@absurd.li"
+  s.homepage          = "http://github.com/kschiess/floor_manager"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(LICENSE Rakefile README) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  s.add_dependency("activesupport", "~> 2.3.5")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("flexmock")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/floor_manager/employee/attribute_action.rb

@@ -0,0 +1,71 @@
+module FloorManager::Employee
+  module AttributeAction
+    # Base class for stored actions.
+    class Base
+      def initialize(name)
+        @name = name
+      end
+      def set(obj, value)
+        if obj.kind_of?(Hash)
+          obj[@name] = value
+        else
+          obj.send("#{@name}=", value)
+        end
+      end
+      def get(obj)
+        if obj.kind_of?(Hash)
+          obj[@name]
+        else
+          obj.send(@name)
+        end
+      end
+    end
+    
+    # Stores the action of producing another employee via a collection proxy
+    # stored in field.
+    class AssocAppend < Base
+      def initialize(field, create_args)
+        super field
+        @create_args = create_args
+      end
+      def apply(obj, floor, employee)
+        instance = floor.build(*@create_args)
+        get(obj) << instance
+      end
+    end
+    
+    # Stores the action of producing another employee via the floor and then
+    # storing that as a value. 
+    class AssocSet < Base
+      def initialize(field, create_args)
+        super field
+        @create_args = create_args
+      end
+      def apply(obj, floor, employee)
+        set(obj, floor.build(*@create_args))
+      end
+    end
+    
+    # Stores the action of setting an attribute to an immediate value.
+    class Immediate < Base
+      def initialize(name, value)
+        super(name)
+        @value = value
+      end
+      def apply(obj, floor, employee)
+        set(obj, @value)
+      end
+    end
+    
+    # Stores the action of setting an attribute to the result of a block.
+    class Block < Base
+      def initialize(name, block)
+        super(name)
+        @block = block
+      end
+      def apply(obj, floor, employee)
+        set(obj, @block.call(obj, floor))
+      end
+    end
+  end
+end

data/lib/floor_manager/employee/dsl.rb

@@ -0,0 +1,78 @@
+module FloorManager::Employee
+  class DSL < BlankSlate
+    # A proxy that is the receiver of #set and #append in a construct like this: 
+    #
+    #   one :spy do
+    #     relationship.set :gun
+    #   end
+    #
+    class AssocProxy < Struct.new(:employee, :field, :dsl)
+      def set(*create_args)
+        dsl._add_attribute AttributeAction::AssocSet.new(field, create_args)
+      end
+      def append(*create_args)
+        dsl._add_attribute AttributeAction::AssocAppend.new(field, create_args)
+      end
+      def string(chars=10)
+        dsl._add_attribute AttributeAction::Block.new(field, proc {
+          (0...chars).map{ ('a'..'z').to_a[rand(26)] }.join
+        })
+      end
+    end
+
+    def initialize(employee, filter=:none, &block)
+      @employee = employee
+      @filter = filter
+      
+      instance_eval(&block)
+    end
+      
+    # Register actions to be taken if the object gets saved (floor#create)
+    #
+    def after_create(&block)
+      FloorManager::Employee::DSL.new(@employee, :after_create, &block)
+    end
+      
+    # This method missing handles several magic incantations: 
+    #
+    # a) Setting an attribute to a value that is given: 
+    #   
+    #     name 'john'
+    #
+    # b) Setting an attribute to a value that is returned from a block: 
+    #
+    #     name { |obj, floor| rand()>0.5 ? 'John' : 'Peter' }
+    #
+    #   Note that the first argument is the +obj+ under construction (your 
+    #   model instance) and the second argument is the floor the model is 
+    #   being constructed in. This is useful for retrieving other objects that
+    #   live in the same floor. 
+    #
+    # c) Access to the association magic: 
+    #
+    #     spouse.set :linda
+    #     friends.append :frank
+    #
+    #   Please see +AssocProxy+ for further explanation on this. 
+    #
+    def method_missing(sym, *args, &block)
+      if args.size == 1
+        # Immediate attribute
+        value = args.first
+        _add_attribute AttributeAction::Immediate.new(sym, value)
+      elsif block
+        # Lazy attribute
+        _add_attribute AttributeAction::Block.new(sym, block)
+      elsif args.empty?
+        # Maybe: #set / #append proxy?
+        AssocProxy.new(@employee, sym, self)
+      else
+        super
+      end
+    end
+
+    def _add_attribute(action)
+      @employee.add_attribute @filter, action
+    end
+  end
+end

data/lib/floor_manager/employee.rb

@@ -0,0 +1,109 @@
+
+require 'active_support'
+require 'blankslate'
+
+module FloorManager::Employee
+
+  # Base class for employees. No instances of this should be created. 
+  class Template
+    def self.from_dsl(klass_name, &block)
+      new(klass_name).tap { |emp| DSL.new(emp, &block) }
+    end
+
+    def initialize(klass_name)
+      @klass_name = klass_name
+      @attributes = Hash.new { |h,k| h[k] = Array.new }
+    end
+    
+    # Build this employee in memory. 
+    #
+    def build(floor, overrides)
+      produce_instance.tap { |i| apply_attributes(i, :none, floor, overrides) }
+    end
+    
+    # Create this employee in the database. 
+    #
+    def create(floor, overrides)
+      produce_instance.tap { |i| 
+        apply_attributes(i, :none, floor, overrides)
+        i.save!
+        
+        unless @attributes[:after_create].empty?
+          apply_attributes(i, :after_create, floor) 
+          i.save! 
+        end
+      }
+    end
+    
+    # Returns just the attributes that would be used.
+    #
+    def attrs(floor, overrides)
+      build(floor, overrides).attributes
+    end
+    
+    # Reset this employee between test runs.
+    #
+    def reset
+      # Empty, but subclasses will override this.
+    end
+
+    # Add an attribute to set. The action should implement the AttributeAction
+    # interface. This method is mainly used by the DSL to store actions to
+    # take.
+    #
+    def add_attribute filter, action
+      @attributes[filter] << action
+    end
+  protected
+    def produce_instance
+      @klass_name.to_s.
+        camelcase.
+        constantize.
+        new
+    end
+    
+    # Modify attribute values in +instance+, setting them to what was
+    # specified in the factory for this employee and then overriding them with
+    # what was given in +overrides+.
+    #
+    def apply_attributes(instance, filter, floor, overrides={})
+      # First apply all attributes that were given in the factory definition. 
+      @attributes[filter].
+        each do |action|
+          action.apply(instance, floor, self)
+        end
+
+      # Then override with what the user just gave us.
+      overrides.each do |name, value|
+        AttributeAction::Immediate.new(name, value).apply(instance, floor, self)
+      end
+    end
+  end
+  
+  # A unique employee that will be build/created only once in the given floor. 
+  class Unique < Template
+    def reset
+      @instance = nil
+    end
+
+    # Override these to shortcut attribute setting when the instance exists 
+    # already. 
+    def build(floor, overrides)
+      @instance || super
+    end
+    def create(floor, overrides)
+      @instance || super
+    end
+    def attrs(floor, overrides)
+      @instance && @instance.attributes || super
+    end
+  protected
+    # Override to produce only one instance.
+    def produce_instance
+      @instance ||= super
+    end
+  end
+end
+
+require 'floor_manager/employee/dsl'
+require 'floor_manager/employee/attribute_action'

data/lib/floor_manager/floor.rb

@@ -0,0 +1,75 @@
+
+
+# A single floor under the supervision of the manager. This is basically a 
+# context in which unique/singleton instances and templates can coexist. 
+#
+class FloorManager::Floor
+  class DSL
+    def initialize(&block)
+      @floor = FloorManager::Floor.new
+      instance_eval(&block)
+    end
+    
+    def one(name, opts={}, &block) 
+      klass_name = opts[:class] || name
+      @floor.employees[name.to_sym] = FloorManager::Employee::Unique.from_dsl(klass_name, &block)
+    end
+    
+    def any(name, opts={}, &block)
+      klass_name = opts[:class] || name
+      @floor.employees[name.to_sym] = FloorManager::Employee::Template.from_dsl(klass_name, &block)
+    end
+    
+    def object
+      @floor
+    end
+  end
+  def self.from_dsl(&block)
+    DSL.new(&block).object
+  end
+  
+  attr_reader :employees
+  def initialize
+    @employees = {}
+  end
+  
+  # Allows production of new employees by calling their names as methods on
+  # the floor. 
+  #
+  # With a definition of 
+  #   
+  #   one :dog do
+  #   end
+  #   
+  # you could call
+  #
+  #   floor.dog 
+  #
+  # and get the same as if you had called floor.build :dog
+  #
+  def method_missing(sym, *args, &block)
+    if args.size <= 1 && employees.has_key?(sym)
+      attribute_overrides = {}
+      attribute_overrides = args.first unless args.empty?
+      employees[sym].build(self, attribute_overrides)
+    else
+      super
+    end
+  end
+
+  def create(something, overrides={})
+    employees[something.to_sym].create(self, overrides)
+  end
+  def build(something, overrides={})
+    employees[something.to_sym].build(self, overrides)
+  end
+  def attrs(something, overrides={})
+    employees[something.to_sym].attrs(self, overrides)
+  end
+
+  def reset
+    employees.values.each do |employee|
+      employee.reset
+    end
+  end
+end 

data/lib/floor_manager.rb

@@ -0,0 +1,31 @@
+
+class FloorManager
+  class <<self
+    attr_reader :floors
+    
+    # Defines a new environment under the supervision of the floor manager. 
+    #
+    def define(environment_name, &block)
+      @floors ||= {}
+      
+      @floors[environment_name] = FloorManager::Floor.from_dsl(&block)
+    end
+    
+    # Returns an instance of the environment.
+    #
+    def get(environment_name)
+      floors[environment_name]
+    end
+    
+    # Resets all instances produced. Use this in after(:each). 
+    #
+    def reset
+      @floors.values.each do |floor|
+        floor.reset
+      end
+    end
+  end
+end
+
+require 'floor_manager/floor'
+require 'floor_manager/employee'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: floor_manager
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kaspar Schiess
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: kaspar.schiess@absurd.li
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- LICENSE
+- Rakefile
+- README
+- lib/floor_manager/employee/attribute_action.rb
+- lib/floor_manager/employee/dsl.rb
+- lib/floor_manager/employee.rb
+- lib/floor_manager/floor.rb
+- lib/floor_manager.rb
+has_rdoc: true
+homepage: http://github.com/kschiess/floor_manager
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Allows creation of a whole graph of objects on the fly during testing
+test_files: []
+