acts-as-approvable 0.6.7 → 0.6.8.1

data/gemfiles/rails31.gemfile

@@ -4,5 +4,6 @@ source "http://rubygems.org"
 
 gem "activerecord", "~> 3.1.0"
 gem "railties", "~> 3.1.0"
+gem "sqlite3"
 
 gemspec :path=>"../"

data/gemfiles/rails31.gemfile.lock

@@ -32,21 +32,44 @@ GEM
       bundler
       rake
     arel (2.2.1)
+    binding_of_caller (0.6.7)
     builder (3.0.0)
     coderay (1.0.5)
+    coolline (0.1.0)
+    cucumber (1.1.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.5.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
     erubis (2.7.0)
+    gherkin (2.5.1)
+      json (>= 1.4.6)
     hike (1.2.1)
     i18n (0.6.0)
+    io-console (0.3)
     json (1.6.5)
-    metaclass (0.0.1)
-    method_source (0.7.0)
-    mocha (0.10.4)
-      metaclass (~> 0.0.1)
+    method_source (0.7.1)
     multi_json (1.0.4)
-    pry (0.9.8)
+    plymouth (0.3.2)
+      pry-exception_explorer (>= 0.1.7)
+    pry (0.9.8.4)
       coderay (~> 1.0.5)
-      method_source (~> 0.7)
-      slop (>= 2.4.3, < 3)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    pry-coolline (0.1.1)
+      coolline (~> 0.1.0)
+      io-console (~> 0.3.0)
+    pry-exception_explorer (0.1.9)
+      pry-stack_explorer (>= 0.3.9)
+    pry-nav (0.1.0)
+      pry (~> 0.9.8.1)
+    pry-stack_explorer (0.4.1)
+      binding_of_caller (~> 0.6.2)
+      pry (~> 0.9.8.2)
+    pry-syntax-hacks (0.0.6)
+      pry (>= 0.9.8)
     rack (1.3.6)
     rack-cache (1.1)
       rack (>= 0.4)
@@ -67,19 +90,29 @@ GEM
     rdoc (3.12)
       json (~> 1.4)
     redcarpet (2.1.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
     shoulda (2.11.3)
     simplecov (0.5.4)
       multi_json (~> 1.0.3)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    slop (2.4.3)
+    slop (2.4.4)
     sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.5)
+    term-ansicolor (1.0.6)
     thor (0.14.6)
     tilt (1.3.3)
+    timecop (0.3.5)
     tzinfo (0.3.31)
     yard (0.7.5)
 
@@ -89,13 +122,20 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 3.1.0)
   acts-as-approvable!
-  appraisal
-  mocha
-  pry
+  appraisal (~> 0.4.1)
+  cucumber (~> 1.1.0)
+  plymouth
+  pry (~> 0.9.8.1)
+  pry-coolline
+  pry-nav (~> 0.1.0)
+  pry-stack_explorer
+  pry-syntax-hacks
   railties (~> 3.1.0)
-  rake
-  redcarpet
-  shoulda
+  rake (~> 0.9.2)
+  redcarpet (~> 2.1.0)
+  rspec (~> 2.8.0)
+  shoulda (~> 2.0)
   simplecov
   sqlite3
+  timecop (~> 0.3.5)
   yard

data/gemfiles/sqlite.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sqlite"
+
+gemspec :path=>"../"

data/generators/acts_as_approvable/templates/create_approvals.rb

@@ -1,13 +1,14 @@
 class CreateApprovals < ActiveRecord::Migration
   def self.up
     create_table :approvals do |t|
-      t.string   :item_type, :null => false
-      t.integer  :item_id,   :null => false
-      t.string   :event,     :null => false
-      t.integer  :state,     :null => false, :default => 0
-<% if options[:owner] %>      t.integer  :owner_id
-<% end %>      t.text     :object
-      t.text     :reason
+      t.string  :item_type, :null => false
+      t.integer :item_id,   :null => false
+      t.string  :event,     :null => false
+      t.integer :state,     :null => false, :default => 0
+<% if options[:owner] %>      t.integer :owner_id
+<% end %>      t.text    :object,    :limit => 16777216
+      t.text    :original,  :limit => 16777216
+      t.text    :reason
 
       t.timestamps
     end

data/lib/acts-as-approvable.rb

@@ -1,9 +1,8 @@
 require 'active_record'
 
-
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require 'acts_as_approvable/acts_as_approvable'
+require 'acts_as_approvable/model'
 require 'acts_as_approvable/approval'
 require 'acts_as_approvable/error'
 require 'acts_as_approvable/ownership'
@@ -12,7 +11,7 @@ require 'acts-as-approvable/version'
 if defined?(Rails) && Rails.version =~ /^3\./
   require 'acts_as_approvable/railtie'
 elsif defined?(ActiveRecord)
-  ActiveRecord::Base.send :include, ActsAsApprovable::Model
+  ActiveRecord::Base.send :extend, ActsAsApprovable::Model
 end
 
 $LOAD_PATH.shift

data/lib/acts_as_approvable/approval.rb

@@ -10,8 +10,9 @@ class Approval < ActiveRecord::Base
   validates_numericality_of :state, :greater_than_or_equal_to => 0, :less_than => STATES.length
 
   serialize :object
+  serialize :original
 
-  before_save :can_save?
+  before_save :able_to_save?
 
   ##
   # Find the enumerated value for a given state.
@@ -97,7 +98,7 @@ class Approval < ActiveRecord::Base
   ##
   # Returns true if the approval able to be saved. This requires an unlocked
   # approval, or an approval just leaving the 'pending' state.
-  def can_save?
+  def able_to_save?
     unlocked? or state_was == 'pending'
   end
 

data/lib/acts_as_approvable/model.rb

@@ -0,0 +1,55 @@
+require 'acts_as_approvable/model/class_methods'
+require 'acts_as_approvable/model/instance_methods'
+require 'acts_as_approvable/model/create_instance_methods'
+require 'acts_as_approvable/model/update_instance_methods'
+
+module ActsAsApprovable
+  ##
+  # The meat of {ActsAsApprovable}. This applies methods for the configured approval events
+  # and configures the required relationships.
+  module Model
+    # Declare this in your model to require approval on new records or changes to fields.
+    #
+    # @param [Hash] options the options for this models approval workflow.
+    # @option options [Symbol,Array] :on    The events to require approval on (`:create` or `:update`).
+    # @option options [String] :state_field The local field to store `:create` approval state.
+    # @option options [Array]  :ignore      A list of fields to ignore. By default we ignore `:created_at`, `:updated_at` and
+    #                                       the field specified in `:state_field`.
+    # @option options [Array]  :only        A list of fields to explicitly require approval on. This list supercedes `:ignore`.
+    def acts_as_approvable(options = {})
+      extend ClassMethods
+      include InstanceMethods
+
+      cattr_accessor :approvable_on
+      self.approvable_on = Array.wrap(options.delete(:on) { [:create, :update] })
+
+      cattr_accessor :approvable_field
+      self.approvable_field = options.delete(:state_field)
+
+      cattr_accessor :approvable_ignore
+      ignores = Array.wrap(options.delete(:ignore) { [] })
+      ignores.push('created_at', 'updated_at', primary_key, self.approvable_field)
+      self.approvable_ignore = ignores.compact.uniq.map(&:to_s)
+
+      cattr_accessor :approvable_only
+      self.approvable_only = Array.wrap(options.delete(:only) { [] }).uniq.map(&:to_s)
+
+      cattr_accessor :approvals_disabled
+      self.approvals_disabled = false
+
+      has_many :approvals, :as => :item, :dependent => :destroy
+
+      if approvable_on?(:update)
+        include UpdateInstanceMethods
+        before_update :approvable_update, :if => :approvable_update?
+      end
+
+      if approvable_on?(:create)
+        include CreateInstanceMethods
+        before_create :approvable_create, :if => :approvable_create?
+      end
+
+      after_save :approvable_save, :if => :approvals_enabled?
+    end
+  end
+end

data/lib/acts_as_approvable/model/class_methods.rb

@@ -0,0 +1,63 @@
+module ActsAsApprovable
+  module Model
+    ##
+    # Class methods available after acts_as_approvable has been called
+    module ClassMethods
+      ##
+      # Returns true if the approval queue is active at both the local and global
+      # level. Note that the global level supercedes the local level.
+      def approvals_enabled?
+        global_approvals_on? and approvals_on?
+      end
+
+      def approvals_disabled?
+        not approvals_enabled?
+      end
+
+      ##
+      # Enable the approval queue for this model.
+      def approvals_on
+        self.approvals_disabled = false
+      end
+
+      ##
+      # Disable the approval queue for this model.
+      def approvals_off
+        self.approvals_disabled = true
+      end
+
+      def approvals_on?
+        not self.approvals_disabled
+      end
+
+      def global_approvals_on?
+        ActsAsApprovable.enabled?
+      end
+
+      ##
+      # Returns true if the model is configured to use the approval queue on the
+      # given event (`:create` or `:update`).
+      def approvable_on?(event)
+        self.approvable_on.include?(event)
+      end
+
+      ##
+      # Returns a list of fields that require approval.
+      def approvable_fields
+        return self.approvable_only unless self.approvable_only.empty?
+        column_names - self.approvable_ignore
+      end
+
+      ##
+      # Execute a code block while the approval queue is temporarily disabled. The
+      # queue state will be returned to it's previous value, either on or off.
+      def without_approval(&block)
+        enable = self.approvals_on?
+        approvals_off
+        yield(self)
+      ensure
+        approvals_on if enable
+      end
+    end
+  end
+end

data/lib/acts_as_approvable/model/create_instance_methods.rb

@@ -0,0 +1,83 @@
+module ActsAsApprovable
+  module Model
+    ##
+    # Instance methods that apply to the `:create` event specifically.
+    module CreateInstanceMethods
+      ##
+      # Retrieve approval record for the creation event.
+      #
+      # @return [Approval]
+      def approval
+        approvals.find_by_event('create')
+      end
+
+      ##
+      # Get the approval state of the current record from either the local state
+      # field or, if no state field exists, the creation approval object.
+      #
+      # @return [String] one of `'pending'`, `'approved`' or `'rejected'`.
+      def approval_state
+        if self.class.approvable_field
+          send(self.class.approvable_field)
+        elsif approval.present?
+          approval.state
+        end
+      end
+
+      ##
+      # Set the records local approval state.
+      #
+      # @param [String] state one of `'pending'`, `'approved`' or `'rejected'`.
+      def set_approval_state(state)
+        return unless self.class.approvable_field
+        send("#{self.class.approvable_field}=".to_sym, state)
+      end
+
+      ##
+      # Returns true if the record is pending approval.
+      def pending?
+        approval_state.present? ? approval_state == 'pending' : approval.try(:pending?)
+      end
+
+      ##
+      # Returns true if the record has been approved.
+      def approved?
+        approval_state.present? ? approval_state == 'approved' : approval.try(:approved?)
+      end
+
+      ##
+      # Returns true if the record has been rejected.
+      def rejected?
+        approval_state.present? ? approval_state == 'rejected' : approval.try(:rejected?)
+      end
+
+      ##
+      # Approves the record through {Approval#approve!}
+      #
+      # @return [Boolean]
+      def approve!
+        return unless approvable_on?(:create) && approval.present?
+        approval.approve!
+      end
+
+      ##
+      # Rejects the record through {Approval#reject!}
+      #
+      # @return [Boolean]
+      def reject!
+        return unless approvable_on?(:create) && approval.present?
+        approval.reject!
+      end
+
+      private
+      def approvable_create?
+        approvals_enabled? and approvable_on?(:create)
+      end
+
+      def approvable_create
+        @approval = approvals.build(:event => 'create', :state => 'pending')
+        set_approval_state('pending')
+      end
+    end
+  end
+end

data/lib/acts_as_approvable/model/instance_methods.rb

@@ -0,0 +1,89 @@
+module ActsAsApprovable
+  module Model
+    ##
+    # Instance methods that apply to both `:update` and `:create` events.
+    module InstanceMethods
+      ##
+      # Returns true if the approval queue is active at both the local and global
+      # level. Note that the global level supercedes the local level.
+      def approvals_enabled?
+        global_approvals_on? and model_approvals_on? and approvals_on?
+      end
+
+      ##
+      # Returns the inverse of `#approvals_enabled?`
+      def approvals_disabled?
+        not approvals_enabled?
+      end
+
+      def approvals_off
+        @approvals_disabled = true
+      end
+
+      def approvals_on
+        @approvals_disabled = false
+      end
+
+      def approvals_on?
+        not @approvals_disabled
+      end
+
+      def model_approvals_on?
+        self.class.approvals_on?
+      end
+
+      def global_approvals_on?
+        ActsAsApprovable.enabled?
+      end
+
+      ##
+      # Returns true if the model is configured to use the approval queue on the
+      # given event (`:create` or `:update`).
+      def approvable_on?(event)
+        self.class.approvable_on?(event)
+      end
+
+      ##
+      # A filter that is run before the record can be approved. Returning false
+      # stops the approval process from completing.
+      def before_approve(approval); end
+
+      ##
+      # A filter that is run after the record has been approved.
+      def after_approve(approval); end
+
+      ##
+      # A filter that is run before the record can be rejected. Returning false
+      # stops the rejection process from completing.
+      def before_reject(approval); end
+
+      ##
+      # A filter that is run after the record has been rejected.
+      def after_reject(approval); end
+
+      ##
+      # Execute a code block while the approval queue is temporarily disabled. The
+      # queue state will be returned to it's previous value, either on or off.
+      def without_approval(&block)
+        enable = approvals_on? # If we use #approvals_enabled? the global state might be incorrectly applied.
+        approvals_off
+        yield(self)
+      ensure
+        approvals_on if enable
+      end
+
+      def save_without_approval(*args)
+        without_approval { |i| save(*args) }
+      end
+
+      def save_without_approval!(*args)
+        without_approval { |i| save!(*args) }
+      end
+
+      private
+      def approvable_save
+        @approval.save if @approval.present? && @approval.new_record?
+      end
+    end
+  end
+end