rspec-set 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -1,13 +1,4 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'https://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
-end
+# Specify your gem's dependencies in rspec-set.gemspec
+gemspec

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2010 Philippe Creux
+Copyright (c) 2013 Philippe Creux
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,16 +1,18 @@
 = rspec-set
 
-<tt>#set</tt> is a little helper for RSpec to speed-up your specs.
+<tt>#set</tt> is a little RSpec helper that speeds-up drastically integration tests that relies on active record objects.
 
-<tt>#set</tt> can be used as a replacement of <tt>#let</tt>: <tt>#set</tt> will create the resource <tt>before(:all)</tt> your examples and will reload the resource <tt>before(:each)</tt> example.
+<tt>#set</tt> takes advantage of the fact that RSpec rails runs each examples in SQL transactions.
+Since all the changes made to the database are rolledback after each example we can create an active record object before all examples
+and use it in each examples without any collisions as long as we reload the object from the database before each example.
 
-<tt>#let</tt> on the other hand creates the resource for every single example.
+<tt>#set</tt> can be used as a replacement of <tt>#let</tt>: <tt>#set</tt> will create the resource <tt>before(:all)</tt> your examples and will reload the resource <tt>before(:each)</tt> example.
 
 You can drastically improve the time spent to run your specs. On an application with 3000 examples we decreased the specs duration by 70%!
 
 == Usage
 
-The following code will create a flight before running the examples and reload the flight from the DB before each example.
+The following code will create one (and only one!) flight before running the examples and reload the flight from the DB before each example.
 
   require 'spec_helper'
 
@@ -19,6 +21,10 @@ The following code will create a flight before running the examples and reload t
       Flight.create!
     end
 
+    it "should be on_time" do
+      flight.should be_on_time
+    end
+
     it "should be cancellable" do
       flight.cancel
       flight.should be_cancelled
@@ -36,6 +42,8 @@ RSpec wraps each example in an SQL transaction which gets rolled back at the end
 
 <tt>#set</tt> creates a flight once before running any example. Each example uses this flight and changes its state. Since RSpec rolls back the SQL transaction, the flight gets back to its initial state before each example. <tt>#set</tt> takes care of reloading the flight from the DB before each example. Examples won't affect each others then.
 
+You can find more examples in https://github.com/pcreux/rspec-set/blob/master/features/lib/rspec-set.feature
+
 == Notes
 
 * <tt>#set</tt> works only with ActiveRecord objects saved to the DB so far.
@@ -43,13 +51,19 @@ RSpec wraps each example in an SQL transaction which gets rolled back at the end
 * <tt>#set</tt> does not handle multi-level transactions.
 * You will have to call <tt>DatabaseCleaner.clean</tt> <tt>before(:all)</tt> specs which rely on having an empty database. <tt>#set</tt> don't clean the database for you.
 
+== Install
+
+Add rspec-set to you Gemfile
+
+  gem 'rspec-set'
+
+and replace calls to <tt>#let</tt> creating active record objects by <tt>#set</tt>.
+
 == TODO
 
-* add cukes
-* support non active record objects
-* support non saved active record objects
+* support non saved active record objects (changes made to non saved active record objects won't be rolledback after each example)
 * make <tt>before(:all) running in a transaction - See: http://rhnh.net/2010/10/06/transactional-before-all-with-rspec-and-datamapper
-* support multi-level transactions
+* support multi-level transactions (combinations of subcontext with set and changes made in before(:all) leads to weird behaviour sometimes
 
 
 == Contributing to rspec-set

data/Rakefile

@@ -1,57 +1 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "rspec-set"
-  gem.homepage = "http://github.com/pcreux/rspec-set"
-  gem.license = "MIT"
-  gem.summary = %{set() is a helper for RSpec which setup active record
-    objects before all tests and restore them to there original state 
-    before each test}
-  gem.description = %{set() is a helper for RSpec which setup active record
-    objects before all tests and restore them to there original state 
-    before each test}
-  gem.email = "pcreux@gmail.com"
-  gem.authors = ["Philippe Creux"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_runtime_dependency 'rspec', '>= 2'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rspec-set #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require "bundler/gem_tasks"

data/features/rspec-set.feature

@@ -0,0 +1,118 @@
+Feature: set
+
+  As a rails developer willing to speed-up my integration tests
+  In order to take advantage of examples running in transactions
+  I want to use #set that store the data before all example and
+  reload active record objects before each examples
+
+  Scenario: Examples run in transactions (no side effects between examples)
+    Given a file named "spec/models/widget_spec.rb" with:
+      """
+      require "spec_helper"
+
+      describe Widget do
+        set(:widget) { Widget.create!(:name => 'widget_1') }
+
+        subject { widget }
+
+        context "when name is changed to 'widget_2" do
+          before do
+            widget.update_attributes!(:name => 'widget_2')
+          end
+
+          its(:name) { should == 'widget_2' }
+        end
+
+        context "when name is 'widget_1" do
+          its(:name) { should == 'widget_1' }
+        end
+      end
+      """
+    When I run "rspec spec/models/widget_spec.rb"
+    Then the examples should all pass
+
+  Scenario: We can use sub sub contexts just fine
+    Given a file named "spec/models/widget_spec.rb" with:
+      """
+      require "spec_helper"
+
+      describe Widget do
+        set(:widget) { Widget.create(:name => 'apple') }
+
+        subject { widget }
+
+        context "when name is changed to 'banana" do
+          before do
+            widget.update_attributes!(:name => 'banana')
+          end
+
+          its(:name) { should == 'banana' }
+
+          context "when we append ' is good'" do
+            before do
+              widget.name << ' is good'
+              widget.save!
+            end
+
+            its(:name) { should == 'banana is good' }
+          end
+
+          context "when we append ' is bad'" do
+            before do
+              widget.name << ' is bad'
+              widget.save!
+            end
+
+            its(:name) { should == 'banana is bad' }
+
+            context "when we append ' for you'" do
+              before do
+                widget.name << ' for you'
+                widget.save!
+              end
+
+              its(:name) { should == 'banana is bad for you' }
+            end
+          end
+        end
+
+        context "when name is 'apple" do
+          its(:name) { should == 'apple' }
+        end
+      end
+      """
+    When I run "rspec spec/models/widget_spec.rb"
+    Then the examples should all pass
+
+
+  Scenario: I can delete an object, it will be available in the next example.
+    Given a file named "spec/models/widget_spec.rb" with:
+      """
+      require "spec_helper"
+
+      describe Widget do
+        set(:widget) { Widget.create(:name => 'apple') }
+
+        subject { widget }
+
+        context "when I destroy the widget" do
+          before do
+            widget.destroy
+          end
+
+          it "should be destroyed" do
+            Widget.find_by_id(widget.id).should be_nil
+          end
+        end
+
+        context "when name is 'apple" do
+          its(:name) { should == 'apple' }
+        end
+      end
+      """
+    When I run "rspec spec/models/widget_spec.rb"
+    Then the examples should all pass
+
+  Scenario: I can update a model in a before block
+
+  Scenario: I can use a set model in another set definition

data/lib/rspec-set.rb

@@ -1,6 +1,8 @@
+require "version"
+
 module RSpec
   module Core
-    module Set 
+    module Set
       module ClassMethods
         # Set @variable_name in a before(:all) block and give access to it
         # via let(:variable_name)
@@ -15,16 +17,29 @@ module RSpec
         #
         def set(variable_name, &block)
           before(:all) do
-            self.class.send(:class_variable_set, "@@#{variable_name}".to_sym, instance_eval(&block))
+            # Create model
+            self.class.send(:class_variable_set, "@@__rspec_set_#{variable_name}".to_sym, instance_eval(&block))
           end
-         
-          let(variable_name) do 
-            self.class.send(:class_variable_get, "@@#{variable_name}".to_sym).tap do |i|
-              if i.respond_to?(:new_record?) && i.respond_to?(:reload)
-                i.reload unless i.new_record?
+
+          before(:each) do
+            model = send(variable_name)
+
+            if model.is_a?(ActiveRecord::Base)
+              if model.destroyed?
+                # Relig destroyed model
+                model.class.find(i.id)
+              elsif !model.new_record?
+                # Reload saved model
+                model.reload
               end
+            else
+              warn "#{variable_name} is a #{model.class} - rspec-set works with ActiveRecord models only"
             end
           end
+
+          define_method(variable_name) do
+            self.class.send(:class_variable_get, "@@__rspec_set_#{variable_name}".to_sym)
+          end
         end # set()
 
       end # ClassMethods
@@ -35,7 +50,7 @@ module RSpec
     end # Set
 
     class ExampleGroup
-      include Set 
+      include Set
     end # ExampleGroup
 
   end # Core

data/lib/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Set
+    VERSION = "0.1.0"
+  end
+end

data/rspec-set.gemspec

@@ -1,63 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
 
-Gem::Specification.new do |s|
-  s.name = %q{rspec-set}
-  s.version = "0.0.1"
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-set"
+  spec.version       = Rspec::Set::VERSION
+  spec.authors       = ["Philippe Creux"]
+  spec.email         = ["pcreux@gmail.com"]
+  spec.description   = "#set(), speed-up your specs"
+  spec.summary       = "#set() is a helper for RSpec which setup active record
+                        objects before all tests and restore them to there original state 
+                        before each test"
+  spec.homepage      = "http://github.com/pcreux/rspec-set"
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Philippe Creux"]
-  s.date = %q{2011-02-04}
-  s.description = %q{set() is a helper for RSpec which setup active record
-    objects before all tests and restore them to there original state 
-    before each test}
-  s.email = %q{pcreux@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/rspec-set.rb",
-    "rspec-set.gemspec"
-  ]
-  s.homepage = %q{http://github.com/pcreux/rspec-set}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{set() is a helper for RSpec which setup active record objects before all tests and restore them to there original state  before each test}
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency(%q<rspec>, [">= 2"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 2"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 2"])
-  end
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
 end
-

metadata

@@ -1,152 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rspec-set
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Philippe Creux
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-04 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70356762024000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
-  name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70356762024000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70356762019460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-  name: rspec
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
-  requirement: *id005
-description: |-
-  set() is a helper for RSpec which setup active record
-      objects before all tests and restore them to there original state 
-      before each test
-email: pcreux@gmail.com
+  version_requirements: *70356762019460
+description: ! '#set(), speed-up your specs'
+email:
+- pcreux@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-files: 
-- .document
+extra_rdoc_files: []
+files:
+- .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
+- features/rspec-set.feature
 - lib/rspec-set.rb
+- lib/version.rb
 - rspec-set.gemspec
-has_rdoc: true
 homepage: http://github.com/pcreux/rspec-set
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2867062105310348299
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -2867062105310348299
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: set() is a helper for RSpec which setup active record objects before all tests and restore them to there original state  before each test
-test_files: []
-
+summary: ! '#set() is a helper for RSpec which setup active record objects before
+  all tests and restore them to there original state  before each test'
+test_files:
+- features/rspec-set.feature

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/Gemfile.lock

@@ -1,20 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.5.1)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rcov (0.9.9)
-    shoulda (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
-  rcov
-  shoulda

data/VERSION

@@ -1 +0,0 @@
-0.0.1