purgatory 2.3.0 → 2.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmFiMzhlMmYwYjI4ZGVlMWM3N2E1MTFjZjc0YmU1YzU5MGI3MDc2ZA==
+    NGY3YmJjZTM5ZTc0ZWU3NWQ4MTQxNTc3MDVkNzdlZjQ2ZDkzZmJkMg==
   data.tar.gz: !binary |-
-    ZGFlYjYxM2IxMWIzMjU0ZWI1MTNmN2ViZjgzMGYxZGE5OWYxNGE4Yg==
+    NTMxMTZkMTYxMzZmNGJmY2M0NzNiMjc4YTgyODExNzdkNWE2NzE4Zg==
 SHA512:
   metadata.gz: !binary |-
-    N2NjNTkxYjgzZTk1ZmNlOGE4YWUxZmE2MzZjOGFlYmJhMWZjNmQ5ODk1ZTJh
-    NWU1MWIzYTZmNGRjZDM2YzE1ZDYyMmQ4NWIzZWY0NjRiNTc3ZDlhZWM5MTI4
-    MTJhNzk5ZDgzMzM4MTFiN2I0ZTMxMjMxOGI0ZTg5NWIxMmU1M2Y=
+    OTMzNjlhY2YwMWQyYTBiMmUxMjE1MmJjYzM5MWIzMjI1OWZjOGVkZGI3ZGZm
+    NTc1YzkzN2E1YmU5NGZkNTE2MWIzMzU5MWJiNDkzYTI5MDZmOThkZWYxOWVl
+    ZGIxZTA5NTBiNGE1YTRiYTA3OGZhMWYxYWEzMGY5NzAyN2FmMDQ=
   data.tar.gz: !binary |-
-    OTZjNDRkYWYyZWRmODMxMmExODRlMjMxY2UxMDQwN2MxODc2YjJlMGRhZDAz
-    NzI1ZjM0NDJmYTNkMzIxMzA5MTViNGUyM2EzZTQ4ZmViN2E1MDUyZmViZjlj
-    YjdlMDg1MmM5ZDI0ODJjODI2ZjlmYmZlYmQxZjk3OTFmMTA0ZTA=
+    Njk0M2Q2ZWQyMTEzYTVkZDY0NzdlOGZkMzk0MDBlYTY1MzA1NTZjMTA2ZTJj
+    NWFlYzRlNWY2ZWE0MmM4MjJhYjk3YjhjMjBjNjIzNDY0YmQ5ZjdmM2Q2ZDZm
+    N2M3NjkzMDllYTBiNTBmOTZiMGNhMzY0OTZmOTJmMWFjY2I0OWY=

data/README.markdown

@@ -24,6 +24,10 @@ To put your changes to an ActiveRecord class into Purgatory, simply make your ch
     item.price = 200
     purgatory = item.purgatory!(current_user) # returns the newly created purgatory or nil if the item is changes are invalid
 
+By default, if you call purgatory! on an object then any pending purgatories whose soul is that same object will be destroyed. If you'd prefer this not to happen then you can pass fail_if_matching_soul as a parameter and this will make it so if there are pending purgatories with a matching soul then purgatory! will return nil and nothing will happen: 
+
+    purgatory = item.purgatory!(current_user, fail_if_matching_soul: true) # Returns nil and does nothing if there is already a pending purgatory on same soul
+
 To apply the changes, simply call the approve! method on the associated Pergatory instance. You can pass in the approving user as an optional parameter
 
     purgatory = item.purgatories.last
@@ -43,13 +47,15 @@ The following are some attributes of a purgatory:
     purgatory.approver # The user who approved the purgatory
     purgatory.approved_at # The time when the purgatory was approved
 
-Here are some handy scopes and methods available to you:
+Here are some handy class and instance methods available to you:
 
-    ### Scopes
+    ### Class methods
     Purgatory.pending # Returns a relation of all pending purgatories
     Purgatory.approved # Returns a relation of all approved purgatories
+    Purgatory.pending_with_matching_soul(soul) # Returns a relation of
+    all pending purgatories with soul matching the object passed in
 
-    ### Methods
+    ### Instance methods
     purgatory.pending? # Returns true if the purgatory is pending, false otherwise
     purgatory.approved? # Returns true if the purgatory has been approved, false otherwise
 

data/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.0

data/lib/purgatory/purgatory.rb

@@ -5,6 +5,7 @@ class Purgatory < ActiveRecord::Base
   belongs_to :requester, class_name: PurgatoryModule.configuration.user_class_name
   belongs_to :approver, class_name: PurgatoryModule.configuration.user_class_name
   before_create :store_changes
+  before_create :destroy_pending_with_same_soul
 
   validates :soul_type, presence: true
 
@@ -42,9 +43,17 @@ class Purgatory < ActiveRecord::Base
     false
   end
 
+  def self.pending_with_matching_soul(soul)
+    pending.where("soul_id IS NOT NULL AND soul_id = ? AND soul_type = ?", soul.id, soul.class.name)
+  end
+
   private
 
   def store_changes
     self.requested_changes = soul.changes
   end
+
+  def destroy_pending_with_same_soul
+    Purgatory.pending_with_matching_soul(soul).destroy_all
+  end
 end

data/lib/purgatory/purgatory_module.rb

@@ -7,8 +7,9 @@ module PurgatoryModule
     end
   end
 
-  def purgatory!(requester = nil)
+  def purgatory!(requester = nil, options = {})
     return nil if self.invalid?
+    return nil if Purgatory.pending_with_matching_soul(self).any? && options[:fail_if_matching_soul]
     Purgatory.create soul: self, requester: requester
   end
 
@@ -26,4 +27,4 @@ module PurgatoryModule
       @_configuration ||= Configuration.new
     end
   end
-end
+end

data/purgatory.gemspec

@@ -2,15 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: purgatory 2.3.0 ruby lib
+# stub: purgatory 2.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "purgatory"
-  s.version = "2.3.0"
+  s.version = "2.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elan Dubrofsky"]
-  s.date = "2013-11-25"
+  s.date = "2013-11-26"
   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 = [

data/spec/purgatory_spec.rb

@@ -38,6 +38,34 @@ describe Purgatory do
           @widget.purgatories.count.should == 1
           @widget.purgatories.first.should == @purgatory
         end
+
+        it "should delete old pending purgatories with same soul" do
+          @widget2 = Widget.create name: 'toy', price: 500
+          @widget2.name = 'Big Toy'
+          widget2_purgatory = @widget2.purgatory! user1
+          @widget.name = 'baz'
+          new_purgatory = @widget.purgatory! user1
+          Purgatory.find_by_id(@purgatory.id).should be_nil
+          Purgatory.find_by_id(widget2_purgatory.id).should be_present
+          Purgatory.pending.count.should == 2
+          Purgatory.last.requested_changes['name'].should == ['foo', 'baz'] 
+        end
+
+        it "should fail to create purgatory if matching pending Purgatory exists and fail_if_matching_soul is passed in" do
+          @widget.name = 'baz'
+          new_purgatory = @widget.purgatory! user1, fail_if_matching_soul: true
+          new_purgatory.should be_nil
+          Purgatory.find_by_id(@purgatory.id).should be_present
+          Purgatory.pending.count.should == 1
+        end
+
+        it "should succeed to create purgatory if matching approved Purgatory exists and fail_if_matching_soul is passed in" do
+          @purgatory.approve!
+          @widget.name = 'baz'
+          new_purgatory = @widget.purgatory! user1, fail_if_matching_soul: true
+          new_purgatory.should be_present
+          Purgatory.count.should == 2
+        end
       end
     
       it "should not allow invalid changes to be put into purgatory" do
@@ -153,14 +181,14 @@ describe Purgatory do
     @widget = Widget.create name: 'foo', price: 100
     @widget.name = 'bar'
     @widget.price = 200
-    @purgatory = @widget.purgatory! user1
+    purgatory = @widget.purgatory! user1
+    @purgatory = Purgatory.find(purgatory.id)
     @widget.reload
-    @purgatory.reload
   end
   
   def create_new_object_purgatory
     widget = Widget.new name: 'foo', price: 100
-    @purgatory = widget.purgatory! user1
-    @purgatory.reload
+    purgatory = widget.purgatory! user1
+    @purgatory = Purgatory.find(purgatory.id)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purgatory
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Elan Dubrofsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc