purgatory 2.14.0 → 3.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTFhODEwZmNlNDk4MjUxMTBkNWY0ZTgzMzIwYWU2NGY4OTgzOWMwNA==
+    NmFlNGZiY2ZlNWNkYzRkNzc2MDJlOWIxM2RiZjMyYTNhNjRmMDc5NA==
   data.tar.gz: !binary |-
-    ODA1NDhkMjZhMjJkZjA1Y2YxMGZjMjc4MGNlNDQ3YjJjODgwNzI3ZA==
+    ZWRmYWJjYzg2Mzg2ZjFmZjE1MmVjYjM5ZDU5Y2I0MTE0MDRhYmE4Yg==
 SHA512:
   metadata.gz: !binary |-
-    ZDdjNzM5MTExNzU3NWJkMzMxZDRkMWE3MTczZWQ5M2UzOGEyODE5OGRlMTU3
-    Njg3MzZkYzM4MjI2ODA0OWNlOWQyOGM1NzFkNzRhODNlNTdmMzVjM2VjZTZj
-    YWY3NGIzZTllYzVhNzM4NDkxODc4Y2I1MGQyN2NkOGNhNmQ3NTg=
+    MzI4OTMzYWQ2NTBhNWMyM2ExNTc3NTE2OWJiMmE2MTE2Mzc4MDhkYWJmZDQw
+    MTgyMDdhYWQ0MTg5MGJiMWM2NWZjNmIxMmE1MzZhODgzN2QxNjhiNDI5ODRj
+    YjRmOWZjMGZjNWQ1YmZlYjM4OWQ0YzExMTFhNDlmNTljMTUxOTM=
   data.tar.gz: !binary |-
-    OTUzMGU2ZWRhYTg2YTc1ZThkNDViZDlmMWEyNWJhMjQ2ZTA2MjZlMTc5NDU0
-    NGNlZmYzOTRjYjQ5MjVmZjZiOTI2OGQ3NTVlZDIxMzYzZmJhMWU5NmZjMjQw
-    MDNkYzY5MGY0ZTM1ZTNjZTMxMGViZjc2Y2I5MmRhYjM0MDNlZmU=
+    MmZmNDRjY2MwYWEzNjA2MTdlZTRjY2U1ZGJlZmFjYTk2ZDRlOTcxYjNiYmRi
+    MDkxMGIzNzQzNGEwOTAzZWFhMmJlOGRjOWIwMDU1YmNhYzZmZjA5NTliMGUy
+    MzFkYzQ1ZWExZjQzMjg2NTRjYjE1ZDhkZTQzYzU5NzkxMGIyYjU=

data/README.markdown

@@ -41,6 +41,14 @@ You can also put the creation of a new object into Purgatory
     item = Item.new price: 100
     purgatory = item.purgatory!
 
+Call .purgatize.method(params) to put a method call into Purgatory. When the purgatory is approved the method will be called on the soul
+
+    #without purgatory:
+    item.increase_price(200)
+
+    #with purgatory:
+    item.purgatize(current_user).increase_price(200)
+
 The following are some attributes of a purgatory:
 
     purgatory.soul # The ActiveRecord model instance whose changes are in purgatory
@@ -49,6 +57,7 @@ The following are some attributes of a purgatory:
     purgatory.requested_changes # A hash of the proposed changes. The keys are the attribute names and the values are 2-element arrays where the 1st element is the old value and the 2nd element is the new value
     purgatory.approver # The user who approved the purgatory
     purgatory.approved_at # The time when the purgatory was approved
+    purgatory.performable_method # Information about the method to call on the soul when the purgatory is approved
 
 Here are some handy class and instance methods available to you:
 
@@ -110,7 +119,15 @@ Here are some handy class and instance methods available to you:
     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!".
-  
+
+## Updating Purgatory Version
+
+    Whenever you update the version of purgatory you will need to:
+    
+    1. Run the generator to create required migrations
+        $ rails generate purgatory
+    2. Migrate the database
+        $ rake db:migrate
 
 ## Contributing to Purgatory
  

data/VERSION

@@ -1 +1 @@
-2.14.0
+3.0.0

data/lib/generators/purgatory/purgatory_generator.rb

@@ -17,7 +17,11 @@ class PurgatoryGenerator < Rails::Generators::Base
   end
 
   def create_migration_file
-    migration_template 'create_purgatories.rb', 'db/migrate/create_purgatories.rb'
+    ['create_purgatories', 'add_performable_method_to_purgatories'].each do |filename|
+      unless self.class.migration_exists?("db/migrate", "#{filename}").present?
+        migration_template "#{filename}.rb", "db/migrate/#{filename}.rb"
+      end
+    end
   end
 
   def create_initializer_file

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

@@ -0,0 +1,5 @@
+class AddPerformableMethodToPurgatories < ActiveRecord::Migration
+  def change
+    add_column :purgatories, :performable_method, :text
+  end
+end

data/lib/purgatory/purgatory.rb

@@ -11,6 +11,7 @@ class Purgatory < ActiveRecord::Base
 
   serialize :requested_changes
   serialize :attr_accessor_fields
+  serialize :performable_method
 
   def self.pending
     where(approved_at: nil)
@@ -37,14 +38,15 @@ class Purgatory < ActiveRecord::Base
   end
 
   def soul_with_changes
-    requested_changes.each{|k,v| soul.send(:write_attribute, k, v[1])}
-    attr_accessor_fields.each{|k,v| soul.instance_variable_set(k, v)}
+    requested_changes.each{|k,v| soul.send(:write_attribute, k, v[1])} if requested_changes
+    attr_accessor_fields.each{|k,v| soul.instance_variable_set(k, v)} if attr_accessor_fields
     soul
   end
 
   def approve!(approver = nil)
     return false if approved? 
     if soul_with_changes.save
+      soul.send(performable_method[:method],*performable_method[:args]) if performable_method
       self.approver = approver
       self.approved_at = Time.now
       self.soul_id = soul.id

data/lib/purgatory/purgatory_module.rb

@@ -10,6 +10,10 @@ module PurgatoryModule
     end
   end
 
+  def purgatize(requester = nil, options = {})
+    Purgatization.new(self, requester, options)
+  end
+
   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]
@@ -20,6 +24,19 @@ module PurgatoryModule
     attr_accessor :user_class_name
   end
 
+  class Purgatization
+    def initialize(soul, requester, options)
+      @soul = soul
+      @requester = requester
+      @options = options
+    end
+
+    def method_missing(method, *args)
+      return nil if Purgatory.pending_with_matching_soul(@soul).any? && @options[:fail_if_matching_soul]
+      Purgatory.create soul: @soul, requester: @requester, performable_method: {method: method.to_sym, args: args}
+    end
+  end
+
   class << self
     def configure(&block)
       yield(configuration)

data/purgatory.gemspec

@@ -2,15 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: purgatory 2.14.0 ruby lib
+# stub: purgatory 3.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "purgatory"
-  s.version = "2.14.0"
+  s.version = "3.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Elan Dubrofsky"]
-  s.date = "2013-12-27"
+  s.date = "2014-11-07"
   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,6 +30,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "init.rb",
     "lib/generators/purgatory/purgatory_generator.rb",
+    "lib/generators/purgatory/templates/add_performable_method_to_purgatories.rb",
     "lib/generators/purgatory/templates/create_purgatories.rb",
     "lib/purgatory.rb",
     "lib/purgatory/active_record_descendant_attribute_accessors.rb",
@@ -45,8 +47,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/financeit/purgatory"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.1.11"
+  s.rubygems_version = "2.2.2"
   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

@@ -346,6 +346,16 @@ describe Purgatory do
         @purgatory.approve!(user2).should be_false
       end
     end
+
+    context "approving method call purgatory" do
+      before{create_method_call_purgatory}
+      it "should call the method" do
+        @widget.name.should == 'foo'
+        @purgatory.approve!
+        @widget.reload
+        @widget.name.should == 'bar'
+      end
+    end
   end
 
   describe "use_purgatory" do
@@ -552,6 +562,57 @@ describe Purgatory do
         end
       end
     end
+    context :purgatize do
+      context "putting method call into purgatory" do
+        context "valid changes" do
+          before {create_method_call_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 performable_method" do
+            @purgatory.soul.should == @widget
+            @purgatory.requester.should == user1
+            @purgatory.performable_method[:method].should == :rename
+            @purgatory.performable_method[:args].should == ['bar']
+          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.purgatize(user1).rename('bar')
+            @widget.name = 'baz'
+            new_purgatory = @widget.purgatize(user1).rename('bar')
+            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.purgatize(user1, fail_if_matching_soul: true).rename('bar')
+            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.purgatize(user1, fail_if_matching_soul: true).rename('bar')
+            new_purgatory.should be_present
+            Purgatory.count.should == 2
+          end
+        end
+      end
+    end
   end
   
   private
@@ -565,6 +626,13 @@ describe Purgatory do
     @widget.reload
   end
 
+  def create_method_call_purgatory
+    @widget = Widget.create name: 'foo', price: 100
+    purgatory = @widget.purgatize(user1).rename('bar')
+    @purgatory = Purgatory.find(purgatory.id)
+    @widget.reload
+  end
+
   def create_new_object_purgatory
     widget = Widget.new name: 'foo', price: 100
     purgatory = widget.purgatory! user1

data/spec/support/active_record.rb

@@ -1,5 +1,6 @@
 require 'active_record'
 require 'generators/purgatory/templates/create_purgatories'
+require 'generators/purgatory/templates/add_performable_method_to_purgatories'
 require 'purgatory/purgatory_module'
 
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
@@ -31,6 +32,7 @@ ActiveRecord::Migration.create_table :items do |t|
 end
 
 CreatePurgatories.new.migrate(:up)
+AddPerformableMethodToPurgatories.new.migrate(:up)
 
 PurgatoryModule.configure do |config|
   config.user_class_name = 'User'

data/spec/support/widget.rb

@@ -5,6 +5,10 @@ class Widget < ActiveRecord::Base
   validates :name, presence: true
   before_create :set_original_name
   
+  def rename(new_name)
+    self.update_attributes(name: new_name)
+  end
+
   private
   
   def set_original_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purgatory
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Elan Dubrofsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -72,6 +72,7 @@ files:
 - VERSION
 - init.rb
 - lib/generators/purgatory/purgatory_generator.rb
+- lib/generators/purgatory/templates/add_performable_method_to_purgatories.rb
 - lib/generators/purgatory/templates/create_purgatories.rb
 - lib/purgatory.rb
 - lib/purgatory/active_record_descendant_attribute_accessors.rb
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Allow changes to a model to be put in purgatory until they are approved