acts-as-approvable 0.6.7 → 0.6.8.1

data/gemfiles/rails32.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "activerecord", "~> 3.2.0"
-gem "railties", "~> 3.2.0"
-
-gemspec :path=>"../"

data/gemfiles/rails32.gemfile.lock

@@ -1,99 +0,0 @@
-PATH
-  remote: /Users/jlogsdon/Code/acts_as_approvable/acts_as_approvable
-  specs:
-    acts-as-approvable (0.6.7)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionpack (3.2.1)
-      activemodel (= 3.2.1)
-      activesupport (= 3.2.1)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.1)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.1)
-      activesupport (= 3.2.1)
-      builder (~> 3.0.0)
-    activerecord (3.2.1)
-      activemodel (= 3.2.1)
-      activesupport (= 3.2.1)
-      arel (~> 3.0.0)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.1)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    appraisal (0.4.1)
-      bundler
-      rake
-    arel (3.0.0)
-    builder (3.0.0)
-    coderay (1.0.5)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.1)
-    json (1.6.5)
-    metaclass (0.0.1)
-    method_source (0.7.0)
-    mocha (0.10.4)
-      metaclass (~> 0.0.1)
-    multi_json (1.0.4)
-    pry (0.9.8)
-      coderay (~> 1.0.5)
-      method_source (~> 0.7)
-      slop (>= 2.4.3, < 3)
-    rack (1.4.1)
-    rack-cache (1.1)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    railties (3.2.1)
-      actionpack (= 3.2.1)
-      activesupport (= 3.2.1)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    redcarpet (2.1.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)
-    sprockets (2.1.2)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.5)
-    thor (0.14.6)
-    tilt (1.3.3)
-    tzinfo (0.3.31)
-    yard (0.7.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.2.0)
-  acts-as-approvable!
-  appraisal
-  mocha
-  pry
-  railties (~> 3.2.0)
-  rake
-  redcarpet
-  shoulda
-  simplecov
-  sqlite3
-  yard

data/lib/acts_as_approvable/acts_as_approvable.rb

@@ -1,291 +0,0 @@
-module ActsAsApprovable
-  ##
-  # The meat of {ActsAsApprovable}. This applies methods for the configured approval events
-  # and configures the required relationships.
-  module Model
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
-
-    ##
-    # Class methods added to `ActiveRecord::Base`.
-    module ClassMethods
-      # 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 = {})
-        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', 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_active
-        self.approvals_active = true
-
-        has_many :approvals, :as => :item, :dependent => :destroy
-
-        if self.approvable_on.include?(:update)
-          include UpdateInstanceMethods
-          before_update :approvable_update, :if => :approvable_update?
-        end
-
-        if self.approvable_on.include?(:create)
-          include CreateInstanceMethods
-          before_create :approvable_create, :if => :approvable_create?
-        end
-
-        after_save :approvable_save, :if => :approvals_enabled?
-      end
-
-      ##
-      # Enable the approval queue for this model.
-      def approvals_on
-        self.approvals_active = true
-      end
-
-      ##
-      # Disable the approval queue for this model.
-      def approvals_off
-        self.approvals_active = false
-      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_active
-        approvals_off
-        yield(self)
-      ensure
-        approvals_on if enable
-      end
-    end
-
-    ##
-    # 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 == 'pending' or approval.try(:pending?)
-      end
-
-      ##
-      # Returns true if the record has been approved.
-      def approved?
-        approval_state == 'approved' or approval.try(:approved?)
-      end
-
-      ##
-      # Returns true if the record has been rejected.
-      def rejected?
-        approval_state == 'rejected' or 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
-
-    ##
-    # Instance methods that apply to the :update event specifically.
-    module UpdateInstanceMethods
-      ##
-      # Retrieve all approval records for `:update` events.
-      def update_approvals(all = true)
-        all ? approvals.find_all_by_event('update') : approvals.find_all_by_event_and_state('update', 0)
-      end
-
-      ##
-      # Returns true if the record has any `#update_approvals` that are pending
-      # approval.
-      def pending_changes?
-        !update_approvals(false).empty?
-      end
-
-      ##
-      # Returns true if any notable (eg. not ignored) fields have been changed.
-      def changed_notably?
-        notably_changed.any?
-      end
-
-      ##
-      # Returns an array of any notable (eg. not ignored) fields that have not
-      # been changed.
-      #
-      # @return [Array] a list of changed fields.
-      def notably_changed
-        unless self.class.approvable_only.empty?
-          self.class.approvable_only.select { |field| changed.include?(field) }
-        else
-          changed - self.class.approvable_ignore
-        end
-      end
-
-      private
-      def approvable_update?
-        approvals_enabled? and approvable_on?(:update) and changed_notably?
-      end
-
-      def approvable_update
-        changed = {}
-        notably_changed.each do |attr|
-          original, changed_to = changes[attr]
-
-          write_attribute(attr.to_s, original)
-          changed[attr] = changed_to
-        end
-
-        @approval = approvals.build(:event => 'update', :state => 'pending', :object => changed)
-      end
-    end
-
-    ##
-    # 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?
-        ActsAsApprovable.enabled? and self.class.approvals_active and approvals_on?
-      end
-
-      ##
-      # Returns the inverse of `#approvals_enabled?`
-      def approvals_disabled?
-        !approvals_enabled?
-      end
-
-      def approvals_off
-        @approvals_disabled = true
-      end
-
-      def approvals_on
-        @approvals_disabled = false
-      end
-
-      def approvals_on?
-        not @approvals_disabled
-      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.include?(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

data/test/acts_as_approvable_model_test.rb

@@ -1,459 +0,0 @@
-require 'test_helper'
-
-class ActsAsApprovableModelTest < Test::Unit::TestCase
-  load_schema
-
-  def teardown
-    truncate
-  end
-
-  context 'A record with update only approval' do
-    context 'and ignored fields' do
-      setup { @project = Project.create }
-
-      should 'have no approvals' do
-        assert @project.approvals.empty?
-      end
-
-      context 'which updates an ignored column' do
-        setup { @project.update_attribute(:title, 'Ignore Me') }
-
-        should 'not have an approval' do
-          assert @project.approvals.empty?
-        end
-      end
-
-      context 'which updates an ignore column and a non-ignored column' do
-        setup { @project.update_attributes(:title => 'Ignore Me', :description => 'Must Review') }
-
-        should 'have one approval' do
-          assert_equal 1, @project.approvals.size
-        end
-
-        should 'not update the records ignored column' do
-          assert_equal nil, @project.description
-        end
-
-        should 'update the records non-ignored columns' do
-          assert_equal 'Ignore Me', @project.title
-        end
-
-        should 'have the description on the approval' do
-          assert @project.approvals.last.object.key?('description')
-          assert_equal 'Must Review', @project.approvals.last.object['description']
-        end
-      end
-
-      context 'that is altered using #without_approval' do
-        should 'not have an approval object' do
-          @project.without_approval { |i| i.update_attribute(:description, 'updated') }
-          assert @project.approvals.empty?
-        end
-
-        should 'correctly restore approval queue state' do
-          assert @project.approvals_on?
-          @project.approvals_off
-          assert !@project.approvals_on?
-          @project.without_approval { |i| i.update_attribute(:description, 'updated') }
-          assert !@project.approvals_on?
-        end
-      end
-    end
-
-    context 'and "only" fields' do
-      setup { @game = Game.create }
-
-      should 'have no approvals' do
-        assert @game.approvals.empty?
-      end
-
-      context 'which updates an only column' do
-        setup { @game.update_attribute(:title, 'review') }
-
-        should 'have an approval' do
-          assert_equal 1, @game.approvals.size
-        end
-
-        should 'have pending changes' do
-          assert @game.pending_changes?
-        end
-      end
-
-      context 'which updates an only column and another column' do
-        setup { @game.update_attributes(:title => 'review', :description => 'no review') }
-
-        should 'have one approval' do
-          assert_equal 1, @game.approvals.size
-        end
-
-        should 'not update the records only column' do
-          assert_equal nil, @game.title
-        end
-
-        should 'update the records other fields' do
-          assert_equal 'no review', @game.description
-        end
-
-        should 'have the title on the approval' do
-          assert @game.approvals.last.object.key?('title')
-          assert_equal 'review', @game.approvals.last.object['title']
-        end
-      end
-
-      context 'that has approved, rejected and pending update approvals' do
-        setup do
-          @game.update_attributes(:title => 'review1')
-          @game.update_approvals.last.approve!(true)
-
-          @game.update_attributes(:title => 'review2')
-          @game.update_approvals.last.reject!
-
-          @game.update_attributes(:title => 'review3')
-          @game.update_attributes(:title => 'review4')
-        end
-
-        should 'have #pending_changes?' do
-          assert @game.pending_changes?
-        end
-      end
-
-      context 'that has approved and rejected, but no pending update approvals' do
-        setup do
-          @game.update_attributes(:title => 'review1')
-          @game.update_approvals.last.approve!(true)
-
-          @game.update_attributes(:title => 'review2')
-          @game.update_approvals.last.reject!
-        end
-
-        should 'have #pending_changes?' do
-          assert !@game.pending_changes?
-        end
-      end
-
-      context 'that is altered using #without_approval' do
-        setup { @game.without_approval { |i| i.update_attribute(:title, 'updated') } }
-
-        should 'not have an approval object' do
-          assert @game.approvals.empty?
-        end
-      end
-
-      context 'with approval queue disabled' do
-        context 'at the record level' do
-          setup do
-            @game.approvals_off
-            @game.update_attributes(:title => 'review')
-          end
-
-          teardown { @game.approvals_on }
-
-          should 'have approvals off' do
-            assert @game.approvals_disabled?
-          end
-
-          should 'not have an approval object' do
-            assert @game.approvals.empty?
-          end
-        end
-
-        context 'at the model level' do
-          setup do
-            Game.approvals_off
-            @game.update_attributes(:title => 'review')
-          end
-
-          teardown { Game.approvals_on }
-
-          should 'have approvals off' do
-            assert @game.approvals_disabled?
-          end
-
-          should 'not have an approval object' do
-            assert @game.approvals.empty?
-          end
-        end
-
-        context 'at the global level' do
-          setup do
-            ActsAsApprovable.disable
-            @game.update_attributes(:title => 'review')
-          end
-
-          teardown { ActsAsApprovable.enable }
-
-          should 'have approvals off' do
-            assert @game.approvals_disabled?
-          end
-
-          should 'not have an approval object' do
-            assert @game.approvals.empty?
-          end
-        end
-      end
-    end
-  end
-
-  context 'An approval record' do
-    setup do
-      @project = Project.create
-      @project.update_attribute(:description, 'review')
-      @approval = @project.approvals.last
-    end
-
-    should 'not be locked by default' do
-      assert @approval.unlocked?
-      assert !@approval.locked?
-    end
-
-    should 'be pending' do
-      assert @approval.pending?
-      assert !@approval.approved?
-      assert !@approval.rejected?
-    end
-
-    should 'check attributes in object' do
-      @approval.object['foo'] = 'bar'
-      @approval.approve!
-      assert_equal @approval.object['description'], @approval.item.description
-    end
-
-    context 'that is accepted' do
-      setup { @approval.approve! }
-
-      should 'be locked' do
-        assert @approval.locked?
-        assert !@approval.unlocked?
-      end
-
-      should 'be approved' do
-        assert @approval.approved?
-        assert !@approval.rejected?
-        assert !@approval.pending?
-      end
-
-      should 'update the target item' do
-        assert_equal @approval.object['description'], @approval.item.description
-      end
-
-      should 'raise an error if approved again' do
-        assert_raise(ActsAsApprovable::Error::Locked) { @approval.approve! }
-      end
-
-      should 'raise an error if rejected' do
-        assert_raise(ActsAsApprovable::Error::Locked) { @approval.reject! }
-      end
-    end
-
-    context 'that is rejected' do
-      setup { @approval.reject! }
-
-      should 'be locked' do
-        assert @approval.locked?
-        assert !@approval.unlocked?
-      end
-
-      should 'be rejected' do
-        assert @approval.rejected?
-        assert !@approval.approved?
-        assert !@approval.pending?
-      end
-
-      should 'not update the target item' do
-        assert_equal nil, @approval.item.description
-      end
-
-      should 'raise an error if approved' do
-        assert_raise(ActsAsApprovable::Error::Locked) { @approval.approve! }
-      end
-
-      should 'raise an error if rejected again' do
-        assert_raise(ActsAsApprovable::Error::Locked) { @approval.reject! }
-      end
-    end
-
-    context 'that is stale' do
-      setup { @approval.update_attributes(:created_at => 10.days.ago) }
-
-      should 'be stale' do
-        assert @approval.stale?
-        assert !@approval.fresh?
-      end
-
-      should 'raise an error if approved' do
-        assert_raise(ActsAsApprovable::Error::Stale) { @approval.approve! }
-        assert @approval.pending?
-      end
-
-      should 'not raise an error if rejected' do
-        assert_nothing_raised { @approval.reject! }
-        assert @approval.rejected?
-      end
-
-      should 'allow approval when forced' do
-        assert_nothing_raised { @approval.approve!(true) }
-        assert @approval.approved?
-      end
-    end
-  end
-
-  context 'A record with create only approval' do
-    setup { @user = User.create }
-
-    should 'be pending by default' do
-      assert @user.pending?
-      assert !@user.approved?
-      assert !@user.rejected?
-    end
-
-    should 'have an approval object' do
-      assert_equal 1, @user.approvals.size
-    end
-
-    should 'set the local state' do
-      assert_equal 'pending', @user.state
-    end
-
-    context 'when approved' do
-      setup do
-        @user.approve!
-        @user.reload
-      end
-
-      should 'be approved' do
-        assert @user.approved?
-        assert !@user.rejected?
-        assert !@user.pending?
-      end
-
-      should 'update the local state' do
-        assert_equal 'approved', @user.state
-      end
-    end
-
-    context 'when rejected' do
-      setup do
-        @user.reject!
-        @user.reload
-      end
-
-      should 'be rejected' do
-        assert @user.rejected?
-        assert !@user.approved?
-        assert !@user.pending?
-      end
-
-      should 'update the local state' do
-        assert_equal 'rejected', @user.state
-      end
-    end
-
-    context '.without_approval' do
-      should 'disable approvals for the given block' do
-        @user = User.without_approval { |m| m.create }
-        assert @user.approval.nil?
-      end
-    end
-  end
-
-  context 'A record with default settings' do
-    setup { @employee = Employee.create }
-
-    should 'be pending by default' do
-      assert @employee.pending?
-      assert !@employee.approved?
-      assert !@employee.rejected?
-    end
-
-    should 'get the state from the approval record' do
-      assert_equal @employee.approval_state, @employee.approval.state
-    end
-
-    context 'when updated' do
-      setup { @employee.update_attributes(:name => 'John Doe') }
-
-      should 'not update the attribute' do
-        assert_equal nil, @employee.name
-      end
-
-      should 'create an approval record' do
-        assert_equal 1, @employee.update_approvals.size
-      end
-    end
-
-    context 'when approving' do
-      setup { @approval = @employee.approval }
-
-      should 'call before_approve hook' do
-        @approval.item.expects(:before_approve).once
-        @approval.approve!
-      end
-
-      should 'call after_approve hook' do
-        @approval.item.expects(:after_approve).once
-        @approval.approve!
-      end
-
-      should 'halt if before_approve returns false' do
-        @approval.item.stubs(:before_approve).returns(false)
-        @approval.approve!
-        assert @approval.item.pending?
-      end
-    end
-
-    context 'when rejecting' do
-      setup { @approval = @employee.approval }
-
-      should 'call before_reject hook' do
-        @approval.item.expects(:before_reject).once
-        @approval.reject!
-      end
-
-      should 'call after_reject hook' do
-        @approval.item.expects(:after_reject).once
-        @approval.reject!
-      end
-
-      should 'halt if before_reject returns false' do
-        @approval.item.stubs(:before_reject).returns(false)
-        @approval.reject!
-        assert @approval.item.pending?
-      end
-    end
-  end
-
-  context '.options_for_state' do
-    should 'return an array' do
-      assert_kind_of Array, Approval.options_for_state
-    end
-
-    should 'contain our states' do
-      assert Approval.options_for_state.include?(['All', -1])
-      assert Approval.options_for_state.include?(['Pending', 0])
-      assert Approval.options_for_state.include?(['Approved', 1])
-      assert Approval.options_for_state.include?(['Rejected', 2])
-    end
-  end
-
-  context '.options_for_type' do
-    context 'without approval records' do
-      should 'be empty' do
-        assert Approval.options_for_type.empty?
-      end
-    end
-
-    context 'with approval records' do
-      setup do
-        Project.create.update_attributes(:description => 'review')
-        Game.create.update_attributes(:title => 'review')
-        User.create
-      end
-
-      should 'contain all types with approvals' do
-        assert Approval.options_for_type.include?('Project')
-        assert Approval.options_for_type.include?('Game')
-        assert Approval.options_for_type.include?('User')
-      end
-    end
-  end
-end