audited 4.2.0 → 4.3.0

data/lib/audited/auditor.rb

@@ -9,7 +9,7 @@ module Audited
   # To store an audit comment set model.audit_comment to your comment before
   # a create, update or destroy operation.
   #
-  # See <tt>Audited::Adapters::ActiveRecord::Auditor::ClassMethods#audited</tt>
+  # See <tt>Audited::Auditor::ClassMethods#audited</tt>
   # for configuration options
   module Auditor #:nodoc:
     extend ActiveSupport::Concern
@@ -28,7 +28,7 @@ module Audited
       #   You can add to those by passing one or an array of fields to skip.
       #
       #     class User < ActiveRecord::Base
-      #       audited :except => :password
+      #       audited except: :password
       #     end
       #
       # * +require_comment+ - Ensures that audit_comment is supplied before
@@ -36,41 +36,35 @@ module Audited
       #
       def audited(options = {})
         # don't allow multiple calls
-        return if self.included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
+        return if included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
 
-        class_attribute :non_audited_columns,   :instance_writer => false
-        class_attribute :auditing_enabled,      :instance_writer => false
-        class_attribute :audit_associated_with, :instance_writer => false
+        class_attribute :audit_associated_with,   instance_writer: false
+        class_attribute :audited_options,       instance_writer: false
 
-        if options[:only]
-          except = self.column_names - options[:only].flatten.map(&:to_s)
-        else
-          except = default_ignored_attributes + Audited.ignored_attributes
-          except |= Array(options[:except]).collect(&:to_s) if options[:except]
-        end
-        self.non_audited_columns = except
+        self.audited_options = options
         self.audit_associated_with = options[:associated_with]
 
         if options[:comment_required]
-          validates_presence_of :audit_comment, :if => :auditing_enabled
+          validates_presence_of :audit_comment, if: :auditing_enabled
           before_destroy :require_comment
         end
 
         attr_accessor :audit_comment
 
-        has_many :audits, :as => :auditable, :class_name => Audited.audit_class.name
-        Audited.audit_class.audited_class_names << self.to_s
+        has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: Audit.name
+        Audit.audited_class_names << to_s
 
-        after_create  :audit_create if !options[:on] || (options[:on] && options[:on].include?(:create))
-        before_update :audit_update if !options[:on] || (options[:on] && options[:on].include?(:update))
-        before_destroy :audit_destroy if !options[:on] || (options[:on] && options[:on].include?(:destroy))
+        on = Array(options[:on])
+        after_create :audit_create    if on.empty? || on.include?(:create)
+        before_update :audit_update   if on.empty? || on.include?(:update)
+        before_destroy :audit_destroy if on.empty? || on.include?(:destroy)
 
         # Define and set after_audit and around_audit callbacks. This might be useful if you want
         # to notify a party after the audit has been created or if you want to access the newly-created
         # audit.
         define_callbacks :audit
-        set_callback :audit, :after, :after_audit, :if => lambda { self.respond_to?(:after_audit) }
-        set_callback :audit, :around, :around_audit, :if => lambda { self.respond_to?(:around_audit) }
+        set_callback :audit, :after, :after_audit, if: lambda { respond_to?(:after_audit, true) }
+        set_callback :audit, :around, :around_audit, if: lambda { respond_to?(:around_audit, true) }
 
         attr_accessor :version
 
@@ -81,7 +75,11 @@ module Audited
       end
 
       def has_associated_audits
-        has_many :associated_audits, :as => :associated, :class_name => Audited.audit_class.name
+        has_many :associated_audits, as: :associated, class_name: Audit.name
+      end
+
+      def default_ignored_attributes
+        [primary_key, inheritance_column]
       end
     end
 
@@ -120,13 +118,13 @@ module Audited
 
       # Get a specific revision specified by the version number, or +:previous+
       def revision(version)
-        revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
+        revision_with Audit.reconstruct_attributes(audits_to(version))
       end
 
       # Find the oldest revision recorded prior to the date/time provided.
       def revision_at(date_or_time)
         audits = self.audits.up_until(date_or_time)
-        revision_with Audited.audit_class.reconstruct_attributes(audits) unless audits.empty?
+        revision_with Audit.reconstruct_attributes(audits) unless audits.empty?
       end
 
       # List of attributes that are audited.
@@ -134,28 +132,36 @@ module Audited
         attributes.except(*non_audited_columns)
       end
 
+      def non_audited_columns
+        self.class.non_audited_columns
+      end
+
       protected
 
+      def non_audited_columns
+        self.class.non_audited_columns
+      end
+
       def revision_with(attributes)
-        self.dup.tap do |revision|
+        dup.tap do |revision|
           revision.id = id
           revision.send :instance_variable_set, '@attributes', self.attributes if rails_below?('4.2.0')
-          revision.send :instance_variable_set, '@new_record', self.destroyed?
-          revision.send :instance_variable_set, '@persisted', !self.destroyed?
+          revision.send :instance_variable_set, '@new_record', destroyed?
+          revision.send :instance_variable_set, '@persisted', !destroyed?
           revision.send :instance_variable_set, '@readonly', false
           revision.send :instance_variable_set, '@destroyed', false
           revision.send :instance_variable_set, '@_destroyed', false
           revision.send :instance_variable_set, '@marked_for_destruction', false
-          Audited.audit_class.assign_revision_attributes(revision, attributes)
+          Audit.assign_revision_attributes(revision, attributes)
 
           # Remove any association proxies so that they will be recreated
           # and reference the correct object for this revision. The only way
           # to determine if an instance variable is a proxy object is to
           # see if it responds to certain methods, as it forwards almost
           # everything to its target.
-          for ivar in revision.instance_variables
+          revision.instance_variables.each do |ivar|
             proxy = revision.instance_variable_get ivar
-            if !proxy.nil? and proxy.respond_to? :proxy_respond_to?
+            if !proxy.nil? && proxy.respond_to?(:proxy_respond_to?)
               revision.instance_variable_set ivar, nil
             end
           end
@@ -169,7 +175,15 @@ module Audited
       private
 
       def audited_changes
-        changed_attributes.except(*non_audited_columns).inject({}) do |changes,(attr, old_value)|
+        collection =
+          if audited_options[:only]
+            audited_columns = self.class.audited_columns.map(&:name)
+            changed_attributes.slice(*audited_columns)
+          else
+            changed_attributes.except(*non_audited_columns)
+          end
+
+        collection.inject({}) do |changes, (attr, old_value)|
           changes[attr] = [old_value, self[attr]]
           changes
         end
@@ -188,32 +202,33 @@ module Audited
       end
 
       def audit_create
-        write_audit(:action => 'create', :audited_changes => audited_attributes,
-                    :comment => audit_comment)
+        write_audit(action: 'create', audited_changes: audited_attributes,
+                    comment: audit_comment)
       end
 
       def audit_update
         unless (changes = audited_changes).empty? && audit_comment.blank?
-          write_audit(:action => 'update', :audited_changes => changes,
-                      :comment => audit_comment)
+          write_audit(action: 'update', audited_changes: changes,
+                      comment: audit_comment)
         end
       end
 
       def audit_destroy
-        write_audit(:action => 'destroy', :audited_changes => audited_attributes,
-                    :comment => audit_comment) unless self.new_record?
+        write_audit(action: 'destroy', audited_changes: audited_attributes,
+                    comment: audit_comment) unless new_record?
       end
 
       def write_audit(attrs)
-        attrs[:associated] = self.send(audit_associated_with) unless audit_associated_with.nil?
+        attrs[:associated] = send(audit_associated_with) unless audit_associated_with.nil?
         self.audit_comment = nil
-        run_callbacks(:audit)  { self.audits.create(attrs) } if auditing_enabled
+        run_callbacks(:audit)  { audits.create(attrs) } if auditing_enabled
       end
 
       def require_comment
         if auditing_enabled && audit_comment.blank?
           errors.add(:audit_comment, "Comment required before destruction")
-          return false
+          return false if Rails.version.start_with?('4.')
+          throw :abort
         end
       end
 
@@ -224,12 +239,32 @@ module Audited
       def empty_callback #:nodoc:
       end
 
+      def auditing_enabled
+        self.class.auditing_enabled
+      end
+
+      def auditing_enabled=(val)
+        self.class.auditing_enabled = val
+      end
     end # InstanceMethods
 
     module AuditedClassMethods
       # Returns an array of columns that are audited. See non_audited_columns
       def audited_columns
-        self.columns.select { |c| !non_audited_columns.include?(c.name) }
+        columns.select {|c| !non_audited_columns.include?(c.name) }
+      end
+
+      def non_audited_columns
+        @non_audited_columns ||= begin
+          options = audited_options
+          if options[:only]
+            except = column_names - Array.wrap(options[:only]).flatten.map(&:to_s)
+          else
+            except = default_ignored_attributes + Audited.ignored_attributes
+            except |= Array(options[:except]).collect(&:to_s) if options[:except]
+          end
+          except
+        end
       end
 
       # Executes the block with auditing disabled.
@@ -258,8 +293,16 @@ module Audited
       # made by +user+. This is not model specific, the method is a
       # convenience wrapper around
       # @see Audit#as_user.
-      def audit_as( user, &block )
-        Audited.audit_class.as_user( user, &block )
+      def audit_as(user, &block)
+        Audit.as_user(user, &block)
+      end
+
+      def auditing_enabled
+        Audited.store.fetch("#{table_name}_auditing_enabled", true)
+      end
+
+      def auditing_enabled=(val)
+        Audited.store["#{table_name}_auditing_enabled"] = val
       end
     end
   end

data/lib/audited/rspec_matchers.rb

@@ -76,6 +76,8 @@ module Audited
         "Did not expect #{@expectation}"
       end
 
+      alias_method :failure_message_when_negated, :negative_failure_message
+
       def description
         description = "audited"
         description += " associated with #{@options[:associated_with]}" if @options.key?(:associated_with)
@@ -149,6 +151,8 @@ module Audited
         "Expected #{model_class} to not have associated audits"
       end
 
+      alias_method :failure_message_when_negated, :negative_failure_message
+
       def description
         "has associated audits"
       end
@@ -164,9 +168,9 @@ module Audited
       end
 
       def association_exists?
-        (!reflection.nil?) &&
+        !reflection.nil? &&
           reflection.macro == :has_many &&
-          reflection.options[:class_name] == Audited.audit_class.name
+          reflection.options[:class_name] == Audit.name
       end
     end
   end

data/lib/audited/sweeper.rb

@@ -3,15 +3,12 @@ require "rails/observers/action_controller/caching"
 
 module Audited
   class Sweeper < ActionController::Caching::Sweeper
-    observe Audited.audit_class
+    observe Audited::Audit
 
-    attr_accessor :controller
-    def before(controller)
+    def around(controller)
       self.controller = controller
-      true
-    end
-
-    def after(controller)
+      yield
+    ensure
       self.controller = nil
     end
 
@@ -36,7 +33,7 @@ module Audited
 
     def define_callback(klass)
       observer = self
-      callback_meth = :"_notify_audited_sweeper"
+      callback_meth = :_notify_audited_sweeper
       klass.send(:define_method, callback_meth) do
         observer.update(:before_create, self)
       end
@@ -53,17 +50,11 @@ module Audited
   end
 end
 
-if defined?(ActionController) and defined?(ActionController::Base)
-  # Create dynamic subclass of Audited::Sweeper otherwise rspec will
-  # fail with both ActiveRecord and MongoMapper tests as there will be
-  # around_filter collision
-  sweeper_class = Class.new(Audited::Sweeper) do
-    def self.name
-      "#{Audited.audit_class}::Sweeper"
-    end
+ActiveSupport.on_load(:action_controller) do
+  if defined?(ActionController::Base)
+    ActionController::Base.around_action Audited::Sweeper.instance
   end
-
-  ActionController::Base.class_eval do
-    around_filter sweeper_class.instance
+  if defined?(ActionController::API)
+    ActionController::API.around_action Audited::Sweeper.instance
   end
 end

data/lib/audited/version.rb

@@ -1,3 +1,3 @@
 module Audited
-  VERSION = "4.2.0"
+  VERSION = "4.3.0"
 end

data/lib/audited-rspec.rb

@@ -0,0 +1,4 @@
+require 'audited/rspec_matchers'
+module RSpec::Matchers
+  include Audited::RspecMatchers
+end

data/lib/audited.rb

@@ -1,9 +1,15 @@
 require 'rails/observers/active_model/active_model'
-
+require 'active_record'
 
 module Audited
   class << self
-    attr_accessor :ignored_attributes, :current_user_method, :audit_class
+    attr_accessor :ignored_attributes, :current_user_method
+
+    # Deprecate audit_class accessors in preperation of their removal
+    def audit_class
+      Audited::Audit
+    end
+    deprecate audit_class: "Audited.audit_class is now always Audited::Audit. This method will be removed."
 
     def store
       Thread.current[:audited_store] ||= {}
@@ -14,3 +20,10 @@ module Audited
 
   @current_user_method = :current_user
 end
+
+require 'audited/auditor'
+require 'audited/audit'
+
+::ActiveRecord::Base.send :include, Audited::Auditor
+
+require 'audited/sweeper'

data/lib/generators/audited/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+require 'generators/audited/migration'
+
+module Audited
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend Audited::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_migration
+        migration_template 'install.rb', 'db/migrate/install_audited.rb'
+      end
+    end
+  end
+end

data/lib/generators/audited/migration.rb

@@ -0,0 +1,15 @@
+module Audited
+  module Generators
+    module Migration
+      # Implement the required interface for Rails::Generators::Migration.
+      def next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+    end
+  end
+end

data/lib/generators/audited/templates/add_association_to_audits.rb

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :association_id, :integer
+    add_column :audits, :association_type, :string
+  end
+
+  def self.down
+    remove_column :audits, :association_type
+    remove_column :audits, :association_id
+  end
+end

data/lib/generators/audited/templates/add_comment_to_audits.rb

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :comment, :string
+  end
+
+  def self.down
+    remove_column :audits, :comment
+  end
+end

data/lib/generators/audited/templates/add_remote_address_to_audits.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :remote_address, :string
+  end
+
+  def self.down
+    remove_column :audits, :remote_address
+  end
+end
+

data/lib/generators/audited/templates/add_request_uuid_to_audits.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :request_uuid, :string
+    add_index :audits, :request_uuid
+  end
+
+  def self.down
+    remove_column :audits, :request_uuid
+  end
+end

data/lib/generators/audited/templates/install.rb

@@ -0,0 +1,30 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :audits, :force => true do |t|
+      t.column :auditable_id, :integer
+      t.column :auditable_type, :string
+      t.column :associated_id, :integer
+      t.column :associated_type, :string
+      t.column :user_id, :integer
+      t.column :user_type, :string
+      t.column :username, :string
+      t.column :action, :string
+      t.column :audited_changes, :text
+      t.column :version, :integer, :default => 0
+      t.column :comment, :string
+      t.column :remote_address, :string
+      t.column :request_uuid, :string
+      t.column :created_at, :datetime
+    end
+
+    add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+    add_index :audits, [:associated_id, :associated_type], :name => 'associated_index'
+    add_index :audits, [:user_id, :user_type], :name => 'user_index'
+    add_index :audits, :request_uuid
+    add_index :audits, :created_at
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/generators/audited/templates/rename_association_to_associated.rb

@@ -0,0 +1,23 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    if index_exists? :audits, [:association_id, :association_type], :name => 'association_index'
+      remove_index :audits, :name => 'association_index'
+    end
+
+    rename_column :audits, :association_id, :associated_id
+    rename_column :audits, :association_type, :associated_type
+
+    add_index :audits, [:associated_id, :associated_type], :name => 'associated_index'
+  end
+
+  def self.down
+    if index_exists? :audits, [:associated_id, :associated_type], :name => 'associated_index'
+      remove_index :audits, :name => 'associated_index'
+    end
+
+    rename_column :audits, :associated_type, :association_type
+    rename_column :audits, :associated_id, :association_id
+
+    add_index :audits, [:association_id, :association_type], :name => 'association_index'
+  end
+end

data/lib/generators/audited/templates/rename_changes_to_audited_changes.rb

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    rename_column :audits, :changes, :audited_changes
+  end
+
+  def self.down
+    rename_column :audits, :audited_changes, :changes
+  end
+end

data/lib/generators/audited/templates/rename_parent_to_association.rb

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    rename_column :audits, :auditable_parent_id, :association_id
+    rename_column :audits, :auditable_parent_type, :association_type
+  end
+
+  def self.down
+    rename_column :audits, :association_type, :auditable_parent_type
+    rename_column :audits, :association_id, :auditable_parent_id
+  end
+end

data/lib/generators/audited/upgrade_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+require 'generators/audited/migration'
+
+module Audited
+  module Generators
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend Audited::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_templates
+        migrations_to_be_applied do |m|
+          migration_template "#{m}.rb", "db/migrate/#{m}.rb"
+        end
+      end
+
+      private
+
+      def migrations_to_be_applied
+        Audited::Audit.reset_column_information
+        columns = Audited::Audit.columns.map(&:name)
+
+        yield :add_comment_to_audits unless columns.include?('comment')
+
+        if columns.include?('changes')
+          yield :rename_changes_to_audited_changes
+        end
+
+        unless columns.include?('remote_address')
+          yield :add_remote_address_to_audits
+        end
+
+        unless columns.include?('request_uuid')
+          yield :add_request_uuid_to_audits
+        end
+
+        unless columns.include?('association_id')
+          if columns.include?('auditable_parent_id')
+            yield :rename_parent_to_association
+          else
+            unless columns.include?('associated_id')
+              yield :add_association_to_audits
+            end
+          end
+        end
+
+        if columns.include?('association_id')
+          yield :rename_association_to_associated
+        end
+      end
+    end
+  end
+end