sham 0.0.1 → 0.0.2

data/README.markdown

@@ -0,0 +1,100 @@
+# Sham
+
+Lightweight flexible factories for Ruby on Rails testing.
+
+## Installation
+
+    gem install sham
+
+## Getting Started
+
+Create a sham file for each of your models:
+
+    # in sham/user_sham.rb
+    class Sham::UserSham < Sham::Core
+        def self.options
+            { :name => "Sample User" }
+        end
+    end
+
+Note: Sham is automatically enabled in test and cucumber environments.  You can manually enable it or disable
+it by using the enable! and disable! commands in your environment.rb or test.rb files:
+
+    Sham::Config.enable!
+    Sham::Config.disable!
+
+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 = 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.
+
+    # in app/models/item.rb
+    class Item < ActiveRecord::Base
+        validates_numericality_of :quantity, :greater_than => 0
+    end
+
+    # in sham/item_sham.rb
+    class Sham::ItemSham < Sham::Core
+        def self.options
+            { :quantity => 1 }
+        end
+    end
+
+    # in spec/models/item_spec.rb
+    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
+    end
+    
+## Shamming Alternatives
+
+You can add other alternative variations to the default "sham!" functionality:
+
+    # in sham/item_sham.rb
+    class Sham::ItemSham < Sham::Core
+        def self.options
+            { :weight => 1.0 }
+        end
+        
+        def self.large_options
+            { :weight => 100.0 }
+        end
+    end
+    
+These can be invoked using:
+
+    Item.sham_alternate! :large, :quantity => 100
+    Item.sham_alternate! :large, :build, :quantity => 0
+    
+## Nested Shamming
+
+You can nest shammed models inside others:
+
+    # in sham/line_item_sham.rb
+    class Sham::LineItemSham < Sham::Core
+        def self.options
+            { :item => Sham::Base.new(Item) }
+        end
+    end
+
+The nested shams will automatically be invoked and can be overridden during a sham:
+
+    LineItem.sham!
+    LineItem.sham! :item => Item.sham!(:weight => 100)

data/lib/sham/version.rb

@@ -1,3 +1,3 @@
 module Sham
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/sham.rb

@@ -12,6 +12,10 @@ module Sham
       @@enabled = true
     end
     
+    def self.disable!
+      @@enabled = false
+    end
+    
     def self.enabled?
       !!@@enabled
     end
@@ -72,7 +76,7 @@ module Sham
 
         def self.sham_alternate! type, *args
           options = (args.extract_options! || {})
-          Sham.add_options! self.name, options, "self.#{type}_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)
@@ -82,7 +86,7 @@ module Sham
   end
 end
 
-Sham::Config.enable!
+Sham::Config.enable! if ["test", "cucumber"].member?(ENV['RAILS_ENV'])
 
 if Sham::Config.enabled?
   Dir["#{RAILS_ROOT}/sham/*_sham.rb"].each{ |f| require f }  

data/sham.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Pan Thomakos"]
   s.email       = ["pan.thomakos@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/sham"
+  s.homepage    = "http://github.com/panthomakos/sham"
   s.summary     = "sham-#{Sham::VERSION}"
   s.description = %q{Flexible factories for Ruby on Rails testing.}
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sham
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Pan Thomakos
@@ -39,7 +39,7 @@ files:
 - lib/sham/version.rb
 - sham.gemspec
 has_rdoc: true
-homepage: http://rubygems.org/gems/sham
+homepage: http://github.com/panthomakos/sham
 licenses: []
 
 post_install_message: 
@@ -71,6 +71,6 @@ rubyforge_project: sham
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: sham-0.0.1
+summary: sham-0.0.2
 test_files: []