foca-kaleidoscope 0.1.0

data/README.markdown

@@ -0,0 +1,75 @@
+Kaleidoscope
+============
+
+**Simple** and **clean** object factories for ActiveRecord objects.
+
+Kaleidoscopes are ridiculously simple objects, and they provide us with
+beautiful images with almost no work on our part.
+
+Example plz?
+------------
+
+    Kaleidoscope.define do
+      factory(User) {{ :name => "Foo Bar", :email => "foo@bar.com", :password => "test" }}
+      factory(User, :admin) {{ :admin => true }}
+      factory(User, :named) do
+        lambda {|name| { :conditions => { :name => name }}}
+      end
+    end
+    
+    User.factory.create #=> #<User id: 1, name: "Foo Bar", email: "foo@bar.com", password: "test", admin: false>
+    User.admin.create #=> #<User id: 2, name: nil, email: nil, password: nil, admin: true>
+    
+    # Overwriting values
+    User.factory.create(:name => "foca") #=> #<User id: 3, name: "foca", email: "foo@bar.com", password: "test", admin: false>
+    
+    # Don't save values automatically
+    User.factory.new #=> #<User id: nil, ...>
+
+How does it work?
+-----------------
+
+It just uses named scopes behind the scenes. Each factory declaration defines
+a new named scope with the provided name (or `factory` by default).
+
+This means we don't touch *any* class. No methods are added on 
+`ActiveRecord::Base`. 
+
+If the named scope already exists (or you have a class method with that
+same name), the factory declaration will fail with an `ArgumentError`.
+
+But enough README, read the code, the factory declaration is 5 lines of code.
+Literally.
+
+Why?
+----
+
+Just a thought experiment, but it might turn out to be useful after all. All 
+credit goes to [Jeremy McAnally][jeremy] for the original idea.
+
+License
+-------
+
+Copyright (c) 2009 [Jeremy McAnally][jeremy] & [Nicolás Sanguinetti][foca] for [entp][].
+
+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.
+
+[jeremy]: http://github.com/jeremymcanally
+[foca]:   http://github.com/foca
+[entp]:   http://entp.com

data/lib/kaleidoscope.rb

@@ -0,0 +1,39 @@
+require "rubygems"
+require "activerecord"
+
+module Kaleidoscope
+  # Setup simple and clean factories for activerecord using named_scopes
+  # (no touching of the internals!)
+  # 
+  #   Kaleidoscope.factory(User) {{ 
+  #     :email => Faker::Internet.email, 
+  #     :password => "test", 
+  #     :password_confirmation => "test" 
+  #   }}
+  #
+  #   User.kaleidoscope.create #=> #<User id: 1, email: "foo@bar.com", ...>
+  #   User.kaleidoscope.new    #=> #<User id: nil, email: "bar@foo.com" ...>
+  # 
+  #   Kaleidoscope.factory(User, :admin) {{
+  #     :admin => true
+  #   }}
+  #
+  #   User.admin.create #=> #<User id: 1, admin: true, ...>
+  def self.factory(model, name=nil, &block)
+    name ||= :factory
+    raise ArgumentError, "#{model.name} already has a #{name} method" if model.respond_to?(name)
+    definition = block.call
+    definition = { :conditions => definition } if Hash === definition
+    model.named_scope name, definition
+  end
+  
+  # Call this to define multiple factories together. Only for aesthetic reasons.
+  #
+  #   Kaleidoscope.define do
+  #     factory(User, :admin) {{ :admin => true }}
+  #     factory(User, :inactive) {{ :state => 'pending' }}
+  #   end
+  def self.define(&block)
+    module_eval(&block)
+  end
+end

data/test/test_kaleidoscope.rb

@@ -0,0 +1,82 @@
+require "test/unit"
+require File.dirname(__FILE__) + "/../lib/kaleidoscope"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+module TestHelpers
+  class User < ActiveRecord::Base
+    named_scope :lives_in, lambda {|country| { :conditions => { :country => country }}}
+    
+    def self.create_table
+      connection.create_table table_name do |t|
+        t.string     :name
+        t.string     :email
+        t.string     :password
+        t.string     :country
+        t.boolean    :admin, :default => false
+        t.timestamps
+      end
+    end
+    
+    def self.drop_table
+      connection.drop_table table_name
+    end
+  end
+
+  Kaleidoscope.define do
+    factory(User) {{ :name => "Foo Bar", :email => "foo@bar.com", :password => "test" }}
+    factory(User, :admin) {{ :admin => true }}
+    factory(User, :named) do
+      lambda {|name| { :conditions => { :name => name }}}
+    end
+  end
+end
+
+class TestKaleidoscope < Test::Unit::TestCase
+  include TestHelpers
+  
+  def setup
+    User.create_table
+  end
+  
+  def teardown
+    User.drop_table
+  end
+  
+  def test_models_are_created_with_correct_attributes
+    user = User.factory.create
+    
+    assert_equal "Foo Bar", user.name
+    assert_equal "foo@bar.com", user.email
+    assert_equal "test", user.password
+    assert !user.admin?
+  end
+  
+  def test_you_can_overwrite_attributes_the_normal_activerecord_way
+    user = User.admin.create(:name => "John")
+    
+    assert_equal "John", user.name
+    assert user.admin?
+  end
+  
+  def test_models_can_chain_factory_scopes
+    user = User.admin.named("John").create
+    
+    assert_equal "John", user.name
+    assert user.admin?
+  end
+  
+  def test_raises_when_you_declare_duplicate_factory
+    assert_raise ArgumentError do
+      Kaleidoscope.factory(User) {{ :name => "Bar Foo" }}
+    end
+  end
+  
+  def test_works_with_existing_named_scopes_in_the_model
+    user = User.factory.lives_in("Uruguay").create
+    
+    assert_equal "Uruguay", user.country
+    assert_equal "Foo Bar", user.name
+    assert_equal "foo@bar.com", user.email
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: foca-kaleidoscope
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+description: Easy and clean model factories for active record
+email: contacto@nicolassanguinetti.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/kaleidoscope.rb
+- test/test_kaleidoscope.rb
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+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: kaleidoscope
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easy and clean model factories for active record
+test_files: []
+