sham 0.5.0 → 1.0.0

data/Gemfile

@@ -1 +1,3 @@
 source "http://rubygems.org"
+
+gemspec

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Panayiotis Thomakos
+Copyright (c) 2011 Panayiotis Thomakos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -10,96 +10,155 @@ Lightweight flexible factories for Ruby on Rails testing.
 
 Create a sham file for each of your models:
 
-    # in sham/user_sham.rb
-    class User::Sham
-        def self.options
-            { :name => "Sample User" }
-        end
+    # in sham/user.rb
+    Sham.config(User) do |c|
+      c.attributes do
+        { :name => "Sample User" }
+      end
     end
 
-To enable Sham in a particular environment, add the following to your environment.rb or test.rb file:
+To load your shams you can either include the files individually, or define
+your shams directly in your test file. Sham also provides a helper function to
+load shams under the sham directory. To load all your shams add the following to
+your application.rb or test.rb file:
 
     config.after_initialize do
-        Sham::Config.activate!
+      Sham::Config.activate!
     end
-    
-To enable Sham in cucumber, add the following to your features/support/env.rb file:
+
+To enable all Shams in cucumber, add the following to your
+features/support/env.rb file:
 
     require 'sham'
-    Sham::Config.activate!    
+    Sham::Config.activate!
 
 You can now "sham" your models and pass additional attributes at creation:
 
     User.sham!
-    User.sham! :name => "New Name"
-    User.sham! :age => 23
-    
-You can use sham to build models without saving them as well:
+    User.sham!(:name => "New Name")
+    User.sham!(:age => 23)
+
+You can use sham to build models without automatically saving them as well:
 
-    user = User.sham! :build, :name => "I have not been saved"
+    user = User.sham!(:build, :name => "I have not been saved")
     user.save
-    
+
 ## RSpec Example
 
-Here is an example of testing validations on an ActiveRecord::Base class using Sham and RSpec.
+Here is an example of testing validations on an ActiveRecord::Base class using
+Sham and RSpec.
 
     # in app/models/item.rb
     class Item < ActiveRecord::Base
-        validates_numericality_of :quantity, :greater_than => 0
+      validates_numericality_of :quantity, :greater_than => 0
     end
 
-    # in sham/item_sham.rb
-    class Item::Sham
-        def self.options
-            { :quantity => 1 }
-        end
+    # in sham/item.rb
+    Sham.config(Item) do |c|
+      c.attributes do
+        { :quantity => 1 }
+      end
     end
 
     # in spec/models/item_spec.rb
+    require 'spec_helper'
+    require './sham/item'
+
     describe Item do
-        it "should not allow items with a negative price" do
-            item = Item.sham! :build, :quantity => -1
-            item.valid?.should be_false
-        end
-        
-        it "should allow items with a positive quantity" do
-            item = Item.sham! :build, :quantity => 10
-            item.valid?.should be_true
-        end
+      it "should not allow items with a negative price" do
+        item = Item.sham!(:build, :quantity => -1)
+        item.valid?.should be_false
+      end
+
+      it "should allow items with a positive quantity" do
+        item = Item.sham!(:build, :quantity => 10)
+        item.valid?.should be_true
+      end
     end
-    
-## Shamming Alternatives
-
-You can add other alternative variations to the default "sham!" functionality:
-
-    # in sham/item_sham.rb
-    class Item::Sham
-        def self.options
-            { :weight => 1.0 }
-        end
-        
-        def self.large_options
-            { :weight => 100.0 }
-        end
+
+## Alternative Shams
+
+You can easily define alternative sham configurations:
+
+    # in sham/item.rb
+    Sham.config(Item, :small) do |c|
+      c.attributes do
+        { :weight => 10.0 }
+      end
     end
-    
+
+    Sham.config(Item, :large) do |c|
+      c.attributes do
+        { :weight => 100.0 }
+      end
+    end
+
 These can be invoked using:
 
-    Item.sham_alternate! :large, :quantity => 100
-    Item.sham_alternate! :large, :build, :quantity => 0
-    
+    Item.sham!(:small, :quantity => 100)
+    Item.sham!(:large, :build, :quantity => 0)
+
+## Empty Shams
+
+You can easily define empty shams using the empty function:
+
+    # in sham/user.rb
+    Sham.config(User) do |c|
+      c.empty
+    end
+
+This can be invoked using:
+
+    User.sham!
+
 ## Nested Shamming
 
 You can nest shammed models inside others:
 
     # in sham/line_item_sham.rb
-    class LineItem::Sham
-        def self.options
-            { :item => Sham::Base.new(Item) }
-        end
+    Sham.config(LineItem) do |c|
+      c.attributes do
+        { :item => Sham::Base.new(Item) }
+      end
     end
 
-The nested shams will automatically be invoked and can be overridden during a sham:
+The nested shams will automatically be invoked and can be overridden during a
+sham call:
 
     LineItem.sham!
-    LineItem.sham! :item => Item.sham!(:weight => 100)
+    LineItem.sham!(:item => Item.sham!(:weight => 100))
+
+
+## Subclass Shams
+
+Sham plays well with subclassing. That means shams defined on parent classes
+will be available to child classes as well:
+
+    Sham.config(Person) do |c|
+      c.empty
+    end
+
+    class Person; end
+    class Employee < Person; end
+
+    Employee.sham!
+
+## Reloading Shams with Spork
+
+[Spork](https://rubygems.org/gems/spork) is a great gem that creates a
+Distributed Ruby environment that you can run your RSpec and Cucumber tests
+against. If you are using Rails it is often necessary to re-load your models and
+controllers between Spork test runs so that the Spork DRB picks up your latest
+model changes. This is usually accomplished using a Spork 'each run' block. This
+block of code gets executed before each test run. If you want to be able to
+reload your shams with Spork all you need to do is add a Sham::Config.activate!
+line to this block after you have re-loaded your models and controllers.
+
+    Spork.each_run do
+      ActiveSupport::Dependencies.clear
+      ActiveRecord::Base.instantiate_observers
+      Sham::Config.activate!
+    end if Spork.using_spork?
+
+This change will cause sham to be re-loaded so that you can continue to use it
+with Spork.

data/lib/sham.rb

@@ -14,11 +14,32 @@ module Sham
 
   class Config
     def self.activate!
-      Dir["#{Rails.root}/sham/*_sham.rb"].each do |f|
+      Dir["#{Rails.root}/sham/**/*.rb"].each do |f|
         load f
-        (File.basename(f).match(/(.*)_sham.rb/)[1]).classify.constantize.send :include, Sham::Methods
       end
     end
+
+    attr_accessor :klass, :name
+
+    def initialize klass, name
+      self.klass = klass
+      self.name = name
+    end
+
+    def attributes &attributes
+      klass.add_sham_attributes(name, attributes)
+    end
+
+    def empty
+      klass.add_sham_attributes(name, Proc.new{ Hash.new() })
+    end
+  end
+
+  def self.config klass, name = :default
+    unless klass.include?(Sham::Shammable)
+      klass.send(:include, Sham::Shammable)
+    end
+    yield(Sham::Config.new(klass, name))
   end
 
   def self.string!
@@ -37,31 +58,46 @@ module Sham
     end
   end
 
-  def self.add_options! klass, options = {}, options_string = "options"
-    eval("#{klass}::Sham.#{options_string}").each do |key, value|
+  def self.add_options! klass, options = {}, attributes
+    attributes.call.each do |key, value|
       options[key] = self.parse!(value) unless options.has_key?(key)
     end
   end
 
-  module Methods
-    def self.included klass
-      klass.class_eval do
-        def self.sham! *args
-          options = (args.extract_options! || {})
-          ::Sham.add_options! self.name, options
-          klass = (options.delete(:type) || self.name).constantize
-          return klass.create(options) unless args[0] == :build
-          return klass.new(options)
+  module Shammable
+    def self.included(klass)
+      klass.extend(ClassMethods)
+
+      klass.class_eval <<-EVAL
+        def self.add_sham_attributes name, attributes
+          @@sham_attributes ||= {}
+          @@sham_attributes[name] = attributes
+        end
+
+        def self.sham_attributes
+          @@sham_attributes
         end
+      EVAL
+    end
+
+    module ClassMethods
+      def sham! *args
+        options = (args.extract_options! || {})
+        type = (args[0] == :build ? args[1] : args[0]) || :default
+        build = args[0] == :build || args[1] == :build
 
-        def self.sham_alternate! type, *args
-          options = (args.extract_options! || {})
-          ::Sham.add_options! self.name, options, "#{type}_options"
-          klass = (options.delete(:type) || self.name).constantize
-          return klass.create(options) unless args[0] == :build
-          return klass.new(options)
+        ::Sham.add_options! self.name, options, sham_attributes[type]
+        klass = (options.delete(:type) || self.name).constantize
+        if build
+          klass.new(options)
+        else
+          klass.create(options)
         end
       end
+
+      def sham_alternate! type, *args
+        sham!(type, *args)
+      end
     end
   end
 end

data/lib/sham/version.rb

@@ -1,3 +1,3 @@
 module Sham
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/sham.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.markdown", "License.txt"]
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
+  s.add_development_dependency('rails', '>= 3.0.1')
 end

metadata

@@ -1,30 +1,36 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sham
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.5.0
 platform: ruby
-authors: 
+authors:
 - Pan Thomakos
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-18 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
+date: 2011-09-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70123949484060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *70123949484060
 description: Lightweight flexible factories for Ruby on Rails testing.
-email: 
+email:
 - pan.thomakos@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
 - License.txt
-files: 
+files:
 - .document
 - .gitignore
 - Gemfile
@@ -34,33 +40,29 @@ files:
 - lib/sham.rb
 - lib/sham/version.rb
 - sham.gemspec
-has_rdoc: true
 homepage: http://github.com/panthomakos/sham
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: sham
-rubygems_version: 1.6.0
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: sham-0.5.0
+summary: sham-1.0.0
 test_files: []
-