purgatory 2.7.0 → 2.8.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2MzNDQ3NjcwNDU5NGRkMmU4YTM1N2RmYzk4ZTY2NTRmZTg2ZDRhZQ==
+    Y2M1NWE4MjU0ZDg0OWE0YTcwNzA3ZGMxYzAwM2U0MWE0ZTVlZTQ5NQ==
   data.tar.gz: !binary |-
-    OThkNGVlOTc5YWY4YjYzMDExMWJiOGRiZTFmZDhjMzI5YzViNjM2OA==
+    OTEwZDI1MDM3YzhhMGFjNmYxM2RjMTk0NzFhOTY0MmZmMzI3ZjE5Yg==
 SHA512:
   metadata.gz: !binary |-
-    NjNkNGExMmE3OTQzZmJlMTFjNjkwZGU1ZGU5YTA3OTg5YTQ5YTAxNzViMmUy
-    Y2JlOTg4NWJjZTg0MTlhOWRlNzA5MDJhYWFkMzVhMjQwOWJkYzQ3YjQxODM3
-    NDAxMjQ3ZTM0OWJlODViMzYzZTMyNjA3MzJmZmI1NGVlZjE3NDI=
+    YjRmYTU3MGZhNzE1ZDZhZjQ0MDBlNWEwOTNmNThlZDU5YTVjYTVlOGUyZmQz
+    NGQzZTBiMTMyMzVkNDM5ZmM3NGUyMjU2OGJjOGJlNzEwMDVhMDQ2MWIyMmI5
+    NDc3ZTExY2I1NGU1MmI4ZjBjZThjM2M3M2MxMThhMDIzZDQ2Mzk=
   data.tar.gz: !binary |-
-    NzczZTJmMWUzYWUyODM1OGQ1ZmE1ZDc1YzIyNjc4NDg2YjlkZWY1YTEzMGZm
-    YTY5ZDgwYjBkYTc2N2U1YTkwNWI3ZjZkNjFjMzVjOTEzODExODI3MjUwZWYx
-    YTgxNDYzOGYyMGUwYmIwYzkxNTNiMTI5MTZjYjQ3MmViNjZmMzg=
+    ZTdlZjc1NzlkZmMxYWY2Y2MyNzRhOTlhMTVmNGNhNDA5NTU2ZDIxZjIyOTU1
+    MmU1Yzc3YzdlYzEzNTc0MTY3NzdlNzhlMjlhY2Q1NGNiNjhmMDVhMGEzNDRi
+    ZDY1MTVjODRhYWUxMTY4MjFiZWM4YTBlNmQ2MjM3MjY1Njg3ZGY=

data/README.markdown

@@ -59,6 +59,55 @@ Here are some handy class and instance methods available to you:
     purgatory.pending? # Returns true if the purgatory is pending, false otherwise
     purgatory.approved? # Returns true if the purgatory has been approved, false otherwise
 
+### ActiveRecord Lifecycle
+
+  When using purgatory, the timing of the activerecord lifecycle differs a bit. Normally when you run "ActiveRecord#save", the entire lifecycle of activerecord gets triggered by default. But when you replace "save" with "purgatory!", the callbacks woould only run until after_validation. It's only after you run "approve!" when the rest of callbacks (ie. before_save, after_create) gets triggered as well.
+
+    ## Normal lifecycle
+
+    before_validation
+    after_validation
+    before_save
+    around_save
+    before_create
+    around_create
+    after_create
+    after_save 
+
+    ## Purgatory lifecycle
+
+    # purgatory!
+    before_validation
+    after_validation
+
+    # approve!
+    before_validation
+    after_validation
+    before_save
+    around_save
+    before_create
+    around_create
+    after_create
+    after_save 
+
+
+### Handling Virtual Attributes
+
+  Virtual attributes allow users store variables into active record objects temporarily without saving them into the database (usually created using attr_accessor). Because these attributes are sometimes being used even on later stages of activerecord lifecycle (i.e after_create, after_save), it's important that these virtual attributes continue to exist while using purgatory. If you're using purgatory, by default, these virtual attributes would only exist on "purgatory!" phase, and would get lost on the "approve!" phase. To make sure this doesn't happen, there are 2 ways of handling it. 
+
+  1. Manual 
+  
+    use_purgatory :local_attributes => [:foo, :bar]
+
+    When you pass a hash that contains a list of virtual attributes that you want to save, purgatory will save the values of these attributes into the purgatory table during the "purgatory!" phase, so that when "approve!" is later called, the virtual attributes will be retrieved and will continue to be available in the remaining activerecord lifecyle.
+
+  2. Automatic 
+
+    use_purgatory :local_attributes => :all
+
+    By specifying all, Purgatory will programmatically determine what the virtual attributes are and save them when "purgatory!" is called, so that they will be available during "approve!".
+  
+
 ## Contributing to Purgatory
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-2.7.0
+2.8.0

data/lib/generators/purgatory/templates/create_purgatories.rb

@@ -7,6 +7,7 @@ class CreatePurgatories < ActiveRecord::Migration
       t.integer :approver_id
       t.datetime :approved_at
       t.text :requested_changes
+      t.string :attr_accessor_fields
 
       t.timestamps
     end

data/lib/purgatory/active_record_descendant_attribute_accessors.rb

@@ -0,0 +1,21 @@
+module ActiveRecordDescendantAttributeAccessors
+
+  def self.attr_accessor_instance_variables(obj)
+    include_ancestor_methods = false
+    
+    ancestors_before_active_record_base = obj.class.ancestors.take_while { |klass| klass != ActiveRecord::Base }
+
+    instance_methods_of_ancestors_before_active_record_base = ancestors_before_active_record_base
+                                                                .map { |klass| klass.instance_methods(include_ancestor_methods) }
+                                                                .flatten
+
+    setter_methods_of_ancestors_before_active_record_base = instance_methods_of_ancestors_before_active_record_base
+                                                                .select { |meth| meth.to_s.last == '=' } 
+
+    possible_instance_variables_from_setter_methods = setter_methods_of_ancestors_before_active_record_base
+                                                                .map { |meth| meth.to_s.prepend('@').chop.to_sym }
+
+    obj.instance_variables & possible_instance_variables_from_setter_methods
+  end
+
+end

data/lib/purgatory/attribute_accessor_fields.rb

@@ -0,0 +1,24 @@
+require 'active_support/core_ext/module/attribute_accessors.rb'
+
+require 'purgatory/active_record_descendant_attribute_accessors'
+
+module AttributeAccessorFields
+
+  mattr_accessor :local_attributes
+
+  def self.determine_attr_accessor_fields(obj)
+    variables = if @@local_attributes == :all
+                  ActiveRecordDescendantAttributeAccessors.attr_accessor_instance_variables(obj)
+                else
+                  Array(@@local_attributes).map { |attribute|
+                    attribute.to_s.prepend('@').to_sym
+                  }
+                end
+
+    variables.inject({}) do |hash,var|
+      hash[var] = obj.instance_variable_get(var)
+      hash
+    end
+  end
+
+end

data/lib/purgatory/purgatory.rb

@@ -10,6 +10,7 @@ class Purgatory < ActiveRecord::Base
   validates :soul_type, presence: true
 
   serialize :requested_changes
+  serialize :attr_accessor_fields
 
   def self.pending
     where(approved_at: nil)
@@ -38,6 +39,7 @@ class Purgatory < ActiveRecord::Base
   def approve!(approver = nil)
     return false if approved?
     requested_changes.each{|k,v| soul.send(:write_attribute, k, v[1])}
+    attr_accessor_fields.each{|k,v| soul.instance_variable_set(k, v)}
     if soul.save
       self.approver = approver
       self.approved_at = Time.now

data/lib/purgatory/purgatory_module.rb

@@ -1,8 +1,11 @@
+require 'purgatory/attribute_accessor_fields'
+
 module PurgatoryModule
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def use_purgatory
+    def use_purgatory(options={})
+      AttributeAccessorFields.local_attributes = options[:local_attributes]
       self.has_many :purgatories, as: :soul
     end
   end
@@ -10,7 +13,7 @@ module PurgatoryModule
   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
+    Purgatory.create soul: self, requester: requester, attr_accessor_fields: AttributeAccessorFields.determine_attr_accessor_fields(self)
   end
 
   class Configuration
@@ -27,4 +30,5 @@ module PurgatoryModule
       @_configuration ||= Configuration.new
     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.7.0 ruby lib
+# stub: purgatory 2.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "purgatory"
-  s.version = "2.7.0"
+  s.version = "2.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elan Dubrofsky"]
-  s.date = "2013-11-27"
+  s.date = "2013-11-28"
   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 = [
@@ -29,12 +29,15 @@ Gem::Specification.new do |s|
     "lib/generators/purgatory/purgatory_generator.rb",
     "lib/generators/purgatory/templates/create_purgatories.rb",
     "lib/purgatory.rb",
+    "lib/purgatory/active_record_descendant_attribute_accessors.rb",
+    "lib/purgatory/attribute_accessor_fields.rb",
     "lib/purgatory/purgatory.rb",
     "lib/purgatory/purgatory_module.rb",
     "purgatory.gemspec",
     "spec/purgatory_spec.rb",
     "spec/support/active_record.rb",
     "spec/support/animal.rb",
+    "spec/support/item.rb",
     "spec/support/user.rb",
     "spec/support/widget.rb"
   ]

data/spec/purgatory_spec.rb

@@ -2,6 +2,7 @@ require 'support/active_record'
 require 'support/widget'
 require 'support/user'
 require 'support/animal'
+require 'support/item'
 require 'purgatory/purgatory'
 
 describe Purgatory do
@@ -68,6 +69,26 @@ describe Purgatory do
           Purgatory.count.should == 2
         end
       end
+
+      context "valid changes with attr_accessor" do
+        before do
+          create_object_change_purgatory_with_attr_accessor
+          @item = Item.find(@item.id)
+        end
+
+        it "should not change the object" do
+          @item.name.should == 'foo'
+          @item.price.should == 100
+        end
+
+        it "should not save attr_accessor variable of object" do
+          @item.dante.should == nil
+        end
+
+        it "should store the attr_accessor variables in the Purgatory object" do
+          @purgatory.attr_accessor_fields.should == { :@dante => "inferno" }
+        end
+      end
     
       it "should not allow invalid changes to be put into purgatory" do
         widget = Widget.create name: 'foo'
@@ -140,6 +161,24 @@ describe Purgatory do
         end
       end
     
+      context "valid object with attr_accessor" do
+        before do
+          create_new_object_purgatory_with_attr_accessor
+        end
+
+        it "should store the attr_accessor variables in the Purgatory object" do
+          @purgatory.attr_accessor_fields.should == { :@dante => "inferno" }
+        end
+
+        it "should store the requester and requested changes" do
+          @purgatory.requester.should == user1
+          @purgatory.requested_changes['name'].first.should == nil
+          @purgatory.requested_changes['name'].last.should == 'foo'
+          @purgatory.requested_changes['price'].first.should == nil
+          @purgatory.requested_changes['price'].last.should == 100
+        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      
@@ -175,6 +214,36 @@ describe Purgatory do
         @purgatory.approve!(user2).should be_false
       end
     end
+
+    context "approving object change purgatory with attr_accessor" do
+      before do
+        create_object_change_purgatory_with_attr_accessor
+        @purgatory.approve!(user2)
+        @item = Item.find(@item.id)
+      end
+
+      it "should apply the changes" do
+        @item.name.should == 'bar'
+        @item.price.should == 200
+      end
+
+      it "should apply changes that depend on attr_accessor instance_variable" do
+        @item.original_name.should == "inferno"
+      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
@@ -217,7 +286,25 @@ describe Purgatory do
         dog.original_name.should == 'doggy'
         dog.price.should == Dog::DEFAULT_PRICE
       end
+    end
+
+    context "approving new object creation with attr_accessor" do
+      before do
+        create_new_object_purgatory_with_attr_accessor
+        @purgatory.approve!(user2)
+      end
 
+      it "should create the new object and apply any callbacks" do
+        Item.count.should == 1
+        item = Item.first
+        item.name.should == 'foo'
+        item.price.should == 100
+      end
+
+      it "should apply changes that depend on attr_accessor instance_variable" do
+        Item.first.original_name.should == 'inferno'
+      end
+      
       it "should mark purgatory as approved and store approver" do
         @purgatory.approver.should == user2
         @purgatory.should be_approved
@@ -232,6 +319,161 @@ describe Purgatory do
       end
     end
   end
+
+  describe "determine_attr_accessor_fields" do
+    before do
+      AttributeAccessorFields.local_attributes = nil
+    end
+    
+    after do
+      AttributeAccessorFields.local_attributes = nil
+    end
+
+    context "obj has no attr_accessors" do
+      before do
+        @obj = Widget.new
+      end
+
+      it "should not contain any thing" do
+        AttributeAccessorFields.determine_attr_accessor_fields(@obj).should == {}
+      end
+    end
+
+    context "obj has attr_accessors" do
+      before do
+        klass = create_subclass_of(Widget)
+        klass.instance_eval { attr_accessor :dante, :minos, :charon }
+
+        @obj = klass.new
+
+        @obj.dante = "inferno"
+        @obj.minos = "inferno"
+        @obj.charon = "inferno"
+      end
+
+      context "local_attributes is empty" do
+        it "should not contain any attr_accessor values" do
+          AttributeAccessorFields.determine_attr_accessor_fields(@obj).should == {}
+        end
+      end
+
+      context "local_attributes is array" do
+        context "array size is 1" do
+          before do
+            AttributeAccessorFields.local_attributes = [:dante] 
+          end
+
+          it "should only contain attr_accessors specified in array" do
+            AttributeAccessorFields.determine_attr_accessor_fields(@obj).should == { :@dante => "inferno" }
+          end
+        end
+        context "array size is more than 1" do
+          before do
+            AttributeAccessorFields.local_attributes = [:dante, :minos]
+          end
+
+          it "should only contain attr_accessors specified in array" do
+            AttributeAccessorFields.determine_attr_accessor_fields(@obj).should == { :@dante => "inferno", :@minos => "inferno" }
+          end
+
+        end
+      end
+      
+      context "value of local_variables is :all" do
+        before do
+          AttributeAccessorFields.local_attributes = :all
+        end
+
+        it "should automatically determine attr_accessor values that doesnt include ones belonging to AR::Base and its ancestors, and then store these values" do
+          AttributeAccessorFields.determine_attr_accessor_fields(@obj).should == { :@dante => "inferno", :@minos => "inferno", :@charon => "inferno" }
+        end
+      end
+    end
+  end
+
+  describe "#attr_accessor_instance_variables" do
+    context "attr_accessor defined in a module/class that is an ancestor of ActiveRecord::Base" do
+      before do
+        @active_record_ancestor = ActiveRecord::Base.ancestors[1]
+        @active_record_ancestor.instance_eval { attr_accessor :dante }
+        @widget = Widget.new name: 'foo', price: 100
+        @widget.dante = "inferno"
+      end
+      
+      after do
+        @active_record_ancestor.class_eval { undef :dante  }
+        @active_record_ancestor.class_eval { undef :dante= }
+      end
+
+      it "should not include instance_variables that belong to ancestor of ActiveRecord::Base" do
+        ActiveRecordDescendantAttributeAccessors.attr_accessor_instance_variables(@widget).should == []
+      end
+    end
+
+    context "attr_accessor defined in ActiveRecord::Base" do
+      before do
+        ActiveRecord::Base.instance_eval { attr_accessor :dante }
+        @widget = Widget.new name: 'foo', price: 100
+        @widget.dante = "inferno"
+      end
+      
+      after do
+        ActiveRecord::Base.class_eval { undef :dante  }
+        ActiveRecord::Base.class_eval { undef :dante= }
+      end
+
+      it "should not include instance_variables that belong to ActiveRecord::Base" do
+        ActiveRecordDescendantAttributeAccessors.attr_accessor_instance_variables(@widget).should == []
+      end
+    end
+
+    context "attr_accessor defined in a module/class that is not an ancestor of ActiveRecord::Base" do
+      context "attr_accessor defined in a module mixin" do
+        before do
+          klass = create_subclass_of(Widget)
+          module A; attr_accessor :dante; end
+          klass.instance_eval { include A }
+
+          @widget = klass.new name: 'foo', price: 100
+          @widget.dante = "inferno"
+        end
+        
+        it "should include instance_variables from attr_accessors that belong to descendant of ActiveRecord::Base" do
+          ActiveRecordDescendantAttributeAccessors.attr_accessor_instance_variables(@widget).should == [:@dante]
+        end
+      end
+
+      context "attr_accessor defined in a superclass" do
+        before do
+          klass = create_subclass_of(Widget)
+          subklass = create_subclass_of(klass)
+
+          klass.instance_eval { attr_accessor :dante }
+
+          @widget = subklass.new name: 'foo', price: 100
+          @widget.dante = "inferno"
+        end
+        
+        it "should include instance_variables from attr_accessors that belong to descendant of ActiveRecord::Base" do
+          ActiveRecordDescendantAttributeAccessors.attr_accessor_instance_variables(@widget).should == [:@dante]
+        end
+      end
+
+      context "attr_accessor defined in a class" do
+        before do
+          klass    = create_subclass_of(Widget)
+          klass.instance_eval { attr_accessor :dante }
+
+          @widget = klass.new name: 'foo', price: 100
+          @widget.dante = "inferno"
+        end
+        
+        it "should include instance_variables from attr_accessors that belong to descendant of ActiveRecord::Base" do
+          ActiveRecordDescendantAttributeAccessors.attr_accessor_instance_variables(@widget).should == [:@dante]
+        end
+      end
+    end
+  end
   
   private
   
@@ -243,7 +485,7 @@ describe Purgatory do
     @purgatory = Purgatory.find(purgatory.id)
     @widget.reload
   end
-  
+
   def create_new_object_purgatory
     widget = Widget.new name: 'foo', price: 100
     purgatory = widget.purgatory! user1
@@ -256,4 +498,23 @@ describe Purgatory do
     @purgatory = Purgatory.find(purgatory.id)
   end
   
+  def create_object_change_purgatory_with_attr_accessor
+    @item = Item.create name: 'foo', price: 100, dante: "classic"
+    @item.name = 'bar'
+    @item.price = 200
+    @item.dante = "inferno"
+    purgatory = @item.purgatory! user1
+    @purgatory = Purgatory.find(purgatory.id)
+    @item.reload
+  end
+
+  def create_new_object_purgatory_with_attr_accessor
+    item = Item.new name: 'foo', price: 100, dante: "inferno"
+    purgatory = item.purgatory! user1
+    @purgatory = Purgatory.find(purgatory.id)
+  end
+
+  def create_subclass_of(klass)
+    Class.new(klass)  
+  end
 end

data/spec/support/active_record.rb

@@ -21,6 +21,12 @@ ActiveRecord::Migration.create_table :animals do |t|
   t.string :type
   t.integer :price 
   t.string :original_name 
+end
+
+ActiveRecord::Migration.create_table :items do |t|
+  t.string :name
+  t.integer :price
+  t.string :original_name 
   t.timestamps
 end
 

data/spec/support/item.rb

@@ -0,0 +1,17 @@
+require 'purgatory'
+
+class Item < ActiveRecord::Base
+  use_purgatory local_attributes: [:dante]
+
+  validates :name, presence: true
+
+  attr_accessor :dante
+
+  after_save :set_original_name
+  
+  private
+  
+  def set_original_name
+    update_column(:original_name, @dante)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purgatory
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Elan Dubrofsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -72,12 +72,15 @@ files:
 - lib/generators/purgatory/purgatory_generator.rb
 - lib/generators/purgatory/templates/create_purgatories.rb
 - lib/purgatory.rb
+- lib/purgatory/active_record_descendant_attribute_accessors.rb
+- lib/purgatory/attribute_accessor_fields.rb
 - lib/purgatory/purgatory.rb
 - lib/purgatory/purgatory_module.rb
 - purgatory.gemspec
 - spec/purgatory_spec.rb
 - spec/support/active_record.rb
 - spec/support/animal.rb
+- spec/support/item.rb
 - spec/support/user.rb
 - spec/support/widget.rb
 homepage: http://github.com/financeit/purgatory