purgatory 2.0.0 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDk0ZTBiMmNiNjlmMWUyODRjNTc0OWZjNjE5YTAxZDE0YTI1YjExYQ==
+    ZDk2M2Q4ODkzMTE1NDM4YzRjNGFjZTVmNDg3ZDI0MTE2YzI5NjkzOA==
   data.tar.gz: !binary |-
-    MWZjODBlNzQ0MDNmYWI2NmE1MTEyZWQwNjBlYzEwYTcwMzgxNTljZg==
-SHA512:
+    MjgzNTkxZWM0NzJiNDQyYzY3YzI4NmQ3NmEzNWMwMzZhYjhjNDk5ZQ==
+!binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OGFhNDljZmM4YjU0YWZiNTllNjgwZDcyMjhlMGUwZWIzZDRkYzMzMjk1ZWM5
-    YTkwOWVkNjg4MjViNzFhZGE0MzM0ODdhNGQ4YTEwYmQwMDgxNWRlMmMzMGQ2
-    YzllMzlhYmQ1MTAzMmNjY2M0NTkyMjg0NjNhZGVjNWVhZTI1YmI=
+    MTJlOTU1NDRiNjgzZjM5ODgzZWY1NjExZTg1YzAxMWVkZTI1OTdkZTA2NGQ5
+    NmQ2NmIwYjMyZDI2OWFlNDM0ZDcwODI5OWU0ZTMxMThhYTkwYjFiM2U2NzIy
+    NDEzZTNmMWQ0MTliZDVhMzk2OTJlYmUyNDY0ZDUxNjVhZWE1ODc=
   data.tar.gz: !binary |-
-    ZGJmNDZhNjNhMWQ2ZTdmMGYwMzAyNDMyZjQ3NjFiY2U1MThhYzNiNzYzM2Vl
-    MzdjYThkZGUyNGVjN2JlYmQ0M2M3MzU0MGJmNDMxYTVmYzQ0YjFiYmQyMWNk
-    MjY2MzBjYjNhZWZkNTk3ZTlkNzc2MGY1NTg3YzI3ZTY0MjBiMjI=
+    MTJlMmE3ZWEwNjM0NDQyNGYxNjNmYjE5NzVmOTE3ZGFmNDI1ZTFhZjgwYzdh
+    YzFhMjkwZDlkZmYyN2JjMThhNmIzNjIzYmZjYTFjNzFjMjAzZjhiZDFjOGFj
+    ZGQxN2E3Mjc5NDJjMmJjNWJmZTA0OTE0ZDJkZmQ2NmE2Yjg0Mjk=

data/Gemfile

@@ -11,3 +11,9 @@ group :development do
   gem "bundler", "~> 1.0"
   gem "jeweler", "~> 1.8.7"
 end
+
+group :test do
+  gem "activerecord"
+  gem "rspec"
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activerecord (1.6.0)
     activesupport (4.0.1)
       i18n (~> 0.6, >= 0.6.4)
       minitest (~> 4.2)
@@ -10,6 +11,7 @@ GEM
     addressable (2.3.5)
     atomic (1.1.14)
     builder (3.2.2)
+    diff-lcs (1.1.3)
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
     git (1.2.6)
@@ -52,12 +54,21 @@ GEM
     rake (10.1.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.1.5)
+    shoulda-context (1.1.6)
     shoulda-matchers (2.4.0)
       activesupport (>= 3.0.0)
+    sqlite3 (1.3.7)
     thread_safe (0.1.3)
       atomic
     tzinfo (0.3.38)
@@ -66,7 +77,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   bundler (~> 1.0)
   jeweler (~> 1.8.7)
   rdoc (~> 3.12)
+  rspec
   shoulda
+  sqlite3

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/lib/purgatory/purgatory.rb

@@ -1,6 +1,4 @@
 class Purgatory < ActiveRecord::Base
-  attr_accessible :requester, :soul
-
   belongs_to :soul, polymorphic: true, autosave: false
   belongs_to :requester, class_name: 'User'
   belongs_to :approver, class_name: 'User'
@@ -8,8 +6,13 @@ class Purgatory < ActiveRecord::Base
 
   validates :soul_type, presence: true
 
-  scope :pending, conditions: { approved_at: nil }
-  scope :approved, conditions: ["approved_at IS NOT NULL"]
+  def self.pending
+    where(approved_at: nil)
+  end
+  
+  def self.approved
+    where ["approved_at IS NOT NULL"]
+  end
 
   def approved?
     approved_at.present?
@@ -24,14 +27,13 @@ class Purgatory < ActiveRecord::Base
   end
 
   def soul
-    super || soul_type.constantize.new
+    @soul ||= (super || soul_type.constantize.new)
   end
 
   def approve!(approver = nil)
     return false if approved?
-    changes = changes_hash
-
-    if soul.update_attributes(changes.update(changes){|k,v| v.last}, without_protection: true)
+    changes_hash.each{|k,v| soul.send "#{k}=", v[1]}
+    if soul.save
       self.approver = approver
       self.approved_at = Time.now
       save

data/purgatory.gemspec

@@ -2,15 +2,14 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: purgatory 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "purgatory"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elan Dubrofsky"]
-  s.date = "2013-11-22"
+  s.date = "2013-11-24"
   s.description = "Put your model changes in purgatory and allow them to remain lost souls until they are approved"
   s.email = "elan.dubrofsky@gmail.com"
   s.extra_rdoc_files = [
@@ -32,13 +31,15 @@ Gem::Specification.new do |s|
     "lib/purgatory/purgatory.rb",
     "lib/purgatory/purgatory_module.rb",
     "purgatory.gemspec",
-    "test/helper.rb",
-    "test/test_purgatory.rb"
+    "spec/purgatory_spec.rb",
+    "spec/support/active_record.rb",
+    "spec/support/user.rb",
+    "spec/support/widget.rb"
   ]
   s.homepage = "http://github.com/financeit/purgatory"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.1.10"
+  s.rubygems_version = "2.0.3"
   s.summary = "Allow changes to a model to be put in purgatory until they are approved"
 
   if s.respond_to? :specification_version then

data/spec/purgatory_spec.rb

@@ -0,0 +1,166 @@
+require 'support/active_record'
+require 'support/widget'
+require 'support/user'
+require 'purgatory'
+
+describe Purgatory do
+  let(:user1) {User.create name: 'Elan'}
+  let(:user2) {User.create name: 'Reg'}
+  context :purgatory! do
+    context "putting object changes into purgatory" do
+      context "valid changes" do
+        before {create_object_change_purgatory}
+        
+        it "should create and return pending Purgatory object" do
+          @purgatory.should be_present
+          @purgatory.should_not be_approved
+          @purgatory.should be_pending            
+          Purgatory.pending.count.should == 1
+          Purgatory.pending.first.should == @purgatory
+          Purgatory.approved.count.should be_zero            
+        end
+    
+        it "should store the soul, requester and requested changes" do
+          @purgatory.soul.should == @widget
+          @purgatory.requester.should == user1
+          @purgatory.changes_hash['name'].first.should == 'foo'
+          @purgatory.changes_hash['name'].last.should == 'bar'
+          @purgatory.changes_hash['price'].first.should == 100
+          @purgatory.changes_hash['price'].last.should == 200
+        end
+    
+        it "should not change the widget" do
+          @widget.name.should == 'foo'
+          @widget.price.should == 100
+        end
+    
+        it "should allow the widget to access its purgatories" do
+          @widget.purgatories.count.should == 1
+          @widget.purgatories.first.should == @purgatory
+        end
+      end
+    
+      it "should not allow invalid changes to be put into purgatory" do
+        widget = Widget.create name: 'foo'
+        widget.name = ''
+        widget.purgatory!(user1).should be_nil      
+        widget.reload
+        widget.name.should == 'foo'
+        Purgatory.count.should be_zero
+      end
+    end
+    
+    context "putting new object creation into purgatory" do
+      context "valid object" do
+        before {create_new_object_purgatory}
+    
+        it "should create and return pending Purgatory object" do
+          @purgatory.should be_present
+          @purgatory.should_not be_approved
+          @purgatory.should be_pending            
+          Purgatory.pending.count.should == 1
+          Purgatory.pending.first.should == @purgatory
+          Purgatory.approved.count.should be_zero            
+        end
+        
+        it "should return the soul as a new instance of the purgatoried class" do
+          widget = @purgatory.soul
+          widget.class.should == Widget
+          widget.should be_new_record
+        end
+        
+        it "should store the requester and requested changes" do
+          @purgatory.requester.should == user1
+          @purgatory.changes_hash['name'].first.should == nil
+          @purgatory.changes_hash['name'].last.should == 'foo'
+          @purgatory.changes_hash['price'].first.should == nil
+          @purgatory.changes_hash['price'].last.should == 100
+        end
+    
+        it "should not create a widget" do
+          Widget.count.should be_zero
+        end
+      end
+    
+      it "should not allow invalid object creation to be put into purgatory" do
+        widget = Widget.new name: ''
+        widget.purgatory!(user1).should be_nil      
+        Purgatory.count.should be_zero
+        Widget.count.should be_zero
+      end
+    end
+  end
+  
+  context :approve! do
+    context "approving object change purgatory" do
+      before do
+        create_object_change_purgatory
+        @purgatory.approve!(user2).should be_true
+        @widget.reload
+      end
+      
+      it "should apply the changes" do
+        @widget.name.should == 'bar'
+        @widget.price.should == 200
+      end
+      
+      it "should mark purgatory as approved and store approver" do
+        @purgatory.approver.should == user2
+        @purgatory.should be_approved
+        @purgatory.should_not be_pending            
+        Purgatory.pending.count.should be_zero
+        Purgatory.approved.count.should == 1
+        Purgatory.approved.first.should == @purgatory
+      end
+      
+      it "should fail if you try to approve again" do
+        @purgatory.approve!(user2).should be_false
+      end
+    end
+    
+    context "approving new object creation" do
+      before do
+        create_new_object_purgatory
+        @purgatory.approve!(user2).should be_true
+      end
+      
+      it "should create the new object and apply any callbacks" do
+        Widget.count.should == 1
+        widget = Widget.first
+        widget.name.should == 'foo'
+        widget.price.should == 100
+        widget.original_name.should == 'foo'
+      end
+      
+      it "should mark purgatory as approved and store approver" do
+        @purgatory.approver.should == user2
+        @purgatory.should be_approved
+        @purgatory.should_not be_pending            
+        Purgatory.pending.count.should be_zero
+        Purgatory.approved.count.should == 1
+        Purgatory.approved.first.should == @purgatory
+      end
+      
+      it "should fail if you try to approve again" do
+        @purgatory.approve!(user2).should be_false
+      end
+    end
+  end
+  
+  private
+  
+  def create_object_change_purgatory
+    @widget = Widget.create name: 'foo', price: 100
+    @widget.name = 'bar'
+    @widget.price = 200
+    @purgatory = @widget.purgatory! user1
+    @widget.reload
+    @purgatory.reload
+  end
+  
+  def create_new_object_purgatory
+    widget = Widget.new name: 'foo', price: 100
+    @purgatory = widget.purgatory! user1
+    @purgatory.reload
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+require 'generators/purgatory/templates/create_purgatories'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.create_table :widgets do |t|
+  t.string :name
+  t.integer :price
+  t.string :original_name 
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :users do |t|
+  t.string :name
+  t.timestamps
+end
+
+CreatePurgatories.new.migrate(:up)
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/support/widget.rb

@@ -0,0 +1,13 @@
+require 'purgatory'
+
+class Widget < ActiveRecord::Base
+  use_purgatory
+  validates :name, presence: true
+  before_create :set_original_name
+  
+  private
+  
+  def set_original_name
+    self.original_name = name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purgatory
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Elan Dubrofsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -89,8 +89,10 @@ files:
 - lib/purgatory/purgatory.rb
 - lib/purgatory/purgatory_module.rb
 - purgatory.gemspec
-- test/helper.rb
-- test/test_purgatory.rb
+- spec/purgatory_spec.rb
+- spec/support/active_record.rb
+- spec/support/user.rb
+- spec/support/widget.rb
 homepage: http://github.com/financeit/purgatory
 licenses:
 - MIT
@@ -111,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Allow changes to a model to be put in purgatory until they are approved

data/test/helper.rb

@@ -1,18 +0,0 @@
-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 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'purgatory'
-
-class Test::Unit::TestCase
-end

data/test/test_purgatory.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestPurgatory < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end