rspec-factory-girl 0.2.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Yann Lugrin
+
+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.rdoc

@@ -0,0 +1,69 @@
+= RSpec - Factory Girl
+
+RSpec matcher collection for testing your model built with factory girl.
+
+  describe Post do
+    it { should be_built_by_factory } # Factory named ':post' is used
+    it { should be_created_by_factory } # Factory named ':post' is used
+
+    it { should be_built_by_factory(:my_factory) }
+    it { should be_created_by_factory(:my_factory) }
+  end
+
+== Install
+
+Run the following if you haven't already:
+
+  gem sources -a http://gems.github.com
+
+Install the gem:
+
+  sudo gem install yannlugrin-rspec-factory-girl
+
+== Installing via Rails
+
+Specify the gem dependency in your config/environment.rb file after 'spec/rails' dependency:
+
+  config.gem "yannlugrin-rspec-factory-girl", :lib => "rspec/factory_girl", :source => "http://gems.github.com"
+
+Then run in terminal:
+
+  $ rake gems:install
+
+=== As a Plugin
+
+You can also install Remarkable as a plugin:
+
+  $ script/plugin install git://github.com/yannlugrin/rspec-factory-girl.git
+
+Or using git submodules:
+
+  $ git submodule add git://github.com/yannlugrin/rspec-factory-girl.git vendor/plugins/rspec-factory-girl
+
+== Requirements
+
+* activerecord >= 2.3.2
+* factory_girl >= 1.2.0
+* rspec >= 1.2.0
+* rspec-rails >= 1.2.0
+
+== RubyGems
+
+RubyGems is not required by this library, if you have a LoadError when you run rake tasks, use
+follwing command:
+
+  RUBYOPT="rubygems" rake
+
+or export RUBYOPTS before launch rake tasks:
+
+  RUBYOPT="rubygems"
+  export RUBYOPT
+
+== More information
+
+Github: http://www.github.com/yannlugrin/rspec-factory-girl
+Bug tracking: http://yannlugrin.lighthouseapp.com/projects/27537-rspec-factory-girl/overview
+
+== Copyright & License
+
+Copyright (c) 2009 Yann Lugrin. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 2

data/lib/spec/factory_girl.rb

@@ -0,0 +1,11 @@
+require 'spec/factory_girl/matchers'
+
+module Spec
+  module Rails
+    module Example
+      class ModelExampleGroup
+        include Spec::FactoryGirl::Matchers
+      end
+    end
+  end
+end

data/lib/spec/factory_girl/matchers.rb

@@ -0,0 +1,3 @@
+require 'spec/factory_girl/matchers/base'
+require 'spec/factory_girl/matchers/be_built_by_factory'
+require 'spec/factory_girl/matchers/be_created_by_factory'

data/lib/spec/factory_girl/matchers/base.rb

@@ -0,0 +1,65 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module Spec
+  module FactoryGirl
+    module Matchers
+      class Base
+        def initialize(factory)
+          @factory = factory
+          @errors = []
+        end
+
+        def matches?(target)
+          prepare_matches(target)
+          return false unless @result
+
+          # record is a kind of target class
+          unless @result.kind_of?(@target)
+            @errors << "'#{@target}' class expected, but factory return object kind of #{@result.class}"
+            return false
+          end
+
+          # record is valid
+          unless @result.valid?
+            @errors += @result.errors.full_messages
+            return false
+          end
+
+          # record can be saved
+          begin
+            @result.save!
+          rescue ActiveRecord::RecordInvalid => e
+            @errors << e.to_s
+            return false
+          end
+
+          # A second record can be created
+          begin
+            Factory.create(@factory)
+          rescue ActiveRecord::RecordInvalid => e
+            @errors << "model has uniqueness validation, use sequence in factory (#{e.to_s})"
+            return false
+          end
+
+          @errors.empty?
+        end
+
+        private
+
+        def prepare_matches(target)
+          @target  ||= target_class(target)
+          @factory ||= default_factory(@target)
+        end
+
+        def default_factory(target)
+          target.to_s.underscore.to_sym if target.kind_of? Class
+        end
+
+        def target_class(target)
+          target.kind_of?(Class) ? target : target.class
+        end
+      end
+    end
+  end
+end

data/lib/spec/factory_girl/matchers/be_built_by_factory.rb

@@ -0,0 +1,31 @@
+module Spec
+  module FactoryGirl
+    module Matchers
+      class BeBuiltByFactory < Spec::FactoryGirl::Matchers::Base
+        def description
+          "build instance of '#{@target}' by factory '#{@factory}'"
+        end
+
+        def matches?(target)
+          prepare_matches(target)
+          
+          @result = Factory.build(@factory)
+          
+          super
+        end
+
+        def failure_message_for_should
+          "expected #{@target.inspect} to be build by factory '#{@factory}'\n" + @errors.join("\n")
+        end
+
+        def failure_message_for_should_not
+          "expected #{@target.inspect} not to be build by factory '#{@factory}'"
+        end
+      end
+
+      def be_built_by_factory(factory = nil)
+        BeBuiltByFactory.new(factory)
+      end
+    end
+  end
+end

data/lib/spec/factory_girl/matchers/be_created_by_factory.rb

@@ -0,0 +1,36 @@
+module Spec
+  module FactoryGirl
+    module Matchers
+      class BeCreatedByFactory < Spec::FactoryGirl::Matchers::Base
+        def description
+          "create instance of '#{@target}' by factory '#{@factory}'"
+        end
+
+        def matches?(target)
+          prepare_matches(target)
+          
+          begin
+            @result = Factory.create(@factory)
+          rescue ActiveRecord::RecordInvalid => e
+            @errors << e.to_s
+            return false
+          end
+          
+          super
+        end
+
+        def failure_message_for_should
+          "expected #{@target.inspect} to be created by factory '#{@factory}'\n" + @errors.join("\n")
+        end
+        
+        def failure_message_for_should_not
+          "expected #{@target.inspect} not to be created by factory '#{@factory}'"
+        end
+      end
+
+      def be_created_by_factory(factory = nil)
+        BeCreatedByFactory.new(factory)
+      end
+    end
+  end
+end

data/spec/factory_girl_spec.rb

@@ -0,0 +1,152 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec/factory_girl'
+
+describe 'Factory' do
+  include Spec::FactoryGirl::Matchers
+
+  context 'with default factory name if subject is a class' do
+    before(:each) do
+      define_model(:simple_model)
+
+      Factory.define :simple_model do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should be_built_by_factory }
+    it { should be_created_by_factory }
+  end
+
+  context 'with default factory name if subject is a instance' do
+    before(:each) do
+      define_model(:simple_model)
+
+      Factory.define :simple_model do |model|
+      end
+    end
+    subject { SimpleModel.new }
+
+    it { should be_built_by_factory }
+    it { should be_created_by_factory }
+  end
+
+  context 'with specified factory name' do
+    before(:each) do
+      define_model(:simple_model)
+
+      Factory.define :another_model, :class => SimpleModel do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should be_built_by_factory(:another_model) }
+    it { should be_created_by_factory(:another_model) }
+  end
+
+  context 'with another class' do
+    before(:each) do
+      define_model(:simple_model)
+      define_model(:another_model)
+
+      Factory.define :simple_model, :class => AnotherModel do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should_not be_built_by_factory(:simple_model) }
+    it { should_not be_created_by_factory(:simple_model) }
+  end
+
+  context 'without attribute' do
+    before(:each) do
+      define_model(:simple_model)
+
+      Factory.define :simple_model do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should be_built_by_factory(:simple_model) }
+    it { should be_created_by_factory(:simple_model) }
+  end
+
+  context 'with attribute' do
+    before(:each) do
+      define_model(:simple_model, :name => :string)
+
+      Factory.define :simple_model do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should be_built_by_factory(:simple_model) }
+    it { should be_created_by_factory(:simple_model) }
+  end
+
+  context 'without all needed attribute' do
+    before(:each) do
+      define_model(:simple_model, :name => :string) do
+        validates_presence_of :name
+      end
+
+      Factory.define :simple_model do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should_not be_built_by_factory(:simple_model) }
+    it { should_not be_created_by_factory(:simple_model) }
+  end
+
+  context 'with all needed attribute' do
+    before(:each) do
+      define_model(:simple_model, :name => :string) do
+        validates_presence_of :name
+      end
+
+      Factory.define :simple_model do |model|
+        model.name 'My name'
+      end
+    end
+    subject { SimpleModel }
+
+    it { should be_built_by_factory(:simple_model) }
+    it { should be_created_by_factory(:simple_model) }
+  end
+
+  context 'without sequence for unique attribute' do
+    before(:each) do
+      define_model(:simple_model, :name => :string) do
+        validates_uniqueness_of :name
+      end
+
+      Factory.define :simple_model do |model|
+      end
+    end
+    subject { SimpleModel }
+
+    it { should_not be_built_by_factory(:simple_model) }
+    it { should_not be_created_by_factory(:simple_model) }
+  end
+
+  context 'with sequence for unique attribute' do
+    before(:each) do
+      define_model(:simple_model, :name => :string) do
+        validates_uniqueness_of :name
+      end
+
+      Factory.sequence :name do |n|
+        "name #{n}"
+      end
+
+      Factory.define :simple_model do |model|
+        model.name { Factory.next(:name) }
+      end
+    end
+    subject { SimpleModel }
+
+    it { should be_built_by_factory(:simple_model) }
+    it { should be_created_by_factory(:simple_model) }
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format specdoc
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'spec'
+require 'activerecord'
+require 'factory_girl'
+
+# Configuration information
+config = {
+  :database => {
+    :adapter => 'sqlite3',
+    :database => File.expand_path(File.join(File.dirname(__FILE__), 'test.sqlite3')),
+    :pool => 5,
+    :timeout => 5000
+  }
+}
+
+# Establish connection to database
+ActiveRecord::Base.establish_connection(config[:database])
+
+# Rspec config
+Spec::Runner.configure do |config|
+end
+
+# Helpers to create models
+def create_table(table_name, &block)
+  connection = ActiveRecord::Base.connection
+
+  begin
+    connection.execute("DROP TABLE IF EXISTS #{table_name}")
+    connection.create_table(table_name, &block)
+    @created_tables ||= []
+    @created_tables << table_name
+    connection
+  rescue Exception => e
+    connection.execute("DROP TABLE IF EXISTS #{table_name}")
+    raise e
+  end
+end
+
+def define_model_class(class_name, &block)
+  klass = Class.new(ActiveRecord::Base)
+
+  silence_warnings do
+    Object.const_set(class_name, klass)
+  end
+
+  klass.class_eval(&block) if block_given?
+
+  @defined_constants ||= []
+  @defined_constants << class_name
+
+  klass
+end
+
+def define_model(name, columns = {}, &block)
+  class_name = name.to_s.pluralize.classify
+  table_name = class_name.tableize
+
+  create_table(table_name) do |table|
+    columns.each do |name, type|
+      table.column name, type
+    end
+  end
+
+  define_model_class(class_name, &block)
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-factory-girl
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Yann Lugrin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: yann.lugrin@sans-savoir.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/spec
+- lib/spec/factory_girl
+- lib/spec/factory_girl/matchers.rb
+- lib/spec/factory_girl/matchers
+- lib/spec/factory_girl/matchers/base.rb
+- lib/spec/factory_girl/matchers/be_built_by_factory.rb
+- lib/spec/factory_girl/matchers/be_created_by_factory.rb
+- lib/spec/factory_girl.rb
+- spec/factory_girl_spec.rb
+- spec/test.sqlite3
+- spec/spec.opts
+- spec/spec_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/yannlugrin/rspec-factory-girl
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Rspec matcher collection for testing your model built with factory girl
+test_files: []
+