audited 4.3.0 → 4.6.0

data/lib/audited/version.rb

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

data/lib/generators/audited/install_generator.rb

@@ -3,13 +3,18 @@ require 'rails/generators/migration'
 require 'active_record'
 require 'rails/generators/active_record'
 require 'generators/audited/migration'
+require 'generators/audited/migration_helper'
 
 module Audited
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
+      include Audited::Generators::MigrationHelper
       extend Audited::Generators::Migration
 
+      class_option :audited_changes_column_type, type: :string, default: "text", required: false
+      class_option :audited_user_id_column_type, type: :string, default: "integer", required: false
+
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_migration

data/lib/generators/audited/migration_helper.rb

@@ -0,0 +1,9 @@
+module Audited
+  module Generators
+    module MigrationHelper
+      def migration_parent
+        Rails::VERSION::MAJOR == 4 ? 'ActiveRecord::Migration' : "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :association_id, :integer
     add_column :audits, :association_type, :string

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :comment, :string
   end

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :remote_address, :string
   end

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :request_uuid, :string
     add_index :audits, :request_uuid

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

@@ -1,15 +1,15 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   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_id, :<%= options[:audited_user_id_column_type] %>
       t.column :user_type, :string
       t.column :username, :string
       t.column :action, :string
-      t.column :audited_changes, :text
+      t.column :audited_changes, :<%= options[:audited_changes_column_type] %>
       t.column :version, :integer, :default => 0
       t.column :comment, :string
       t.column :remote_address, :string
@@ -17,8 +17,8 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       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, [:auditable_type, :auditable_id], :name => 'auditable_index'
+    add_index :audits, [:associated_type, :associated_id], :name => 'associated_index'
     add_index :audits, [:user_id, :user_type], :name => 'user_index'
     add_index :audits, :request_uuid
     add_index :audits, :created_at

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     if index_exists? :audits, [:association_id, :association_type], :name => 'association_index'
       remove_index :audits, :name => 'association_index'

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

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

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

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

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

@@ -0,0 +1,20 @@
+class <%= migration_class_name %> < <%= migration_parent %>
+  def self.up
+    fix_index_order_for [:associated_id, :associated_type], 'associated_index'
+    fix_index_order_for [:auditable_id, :auditable_type], 'auditable_index'
+  end
+
+  def self.down
+    fix_index_order_for [:associated_type, :associated_id], 'associated_index'
+    fix_index_order_for [:auditable_type, :auditable_id], 'auditable_index'
+  end
+
+  private
+
+  def fix_index_order_for(columns, index_name)
+    if index_exists? :audits, columns, name: index_name
+      remove_index :audits, name: index_name
+      add_index :audits, columns.reverse, name: index_name
+    end
+  end
+end

data/lib/generators/audited/upgrade_generator.rb

@@ -3,11 +3,13 @@ require 'rails/generators/migration'
 require 'active_record'
 require 'rails/generators/active_record'
 require 'generators/audited/migration'
+require 'generators/audited/migration_helper'
 
 module Audited
   module Generators
     class UpgradeGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
+      include Audited::Generators::MigrationHelper
       extend Audited::Generators::Migration
 
       source_root File.expand_path("../templates", __FILE__)
@@ -23,6 +25,7 @@ module Audited
       def migrations_to_be_applied
         Audited::Audit.reset_column_information
         columns = Audited::Audit.columns.map(&:name)
+        indexes = Audited::Audit.connection.indexes(Audited::Audit.table_name)
 
         yield :add_comment_to_audits unless columns.include?('comment')
 
@@ -51,6 +54,10 @@ module Audited
         if columns.include?('association_id')
           yield :rename_association_to_associated
         end
+
+        if indexes.any? { |i| i.columns == %w[associated_id associated_type] }
+          yield :revert_polymorphic_indexes_order
+        end
       end
     end
   end

data/spec/audited/audit_spec.rb

@@ -3,6 +3,76 @@ require "spec_helper"
 describe Audited::Audit do
   let(:user) { Models::ActiveRecord::User.new name: "Testing" }
 
+  describe "audit class" do
+    around(:example) do |example|
+      original_audit_class = Audited.audit_class
+
+      class CustomAudit < Audited::Audit
+        def custom_method
+          "I'm custom!"
+        end
+      end
+
+      class TempModel < ::ActiveRecord::Base
+        self.table_name = :companies
+      end
+
+      example.run
+
+      Audited.config { |config| config.audit_class = original_audit_class }
+      Audited::Audit.audited_class_names.delete("TempModel")
+      Object.send(:remove_const, :TempModel)
+      Object.send(:remove_const, :CustomAudit)
+    end
+
+    context "when a custom audit class is configured" do
+      it "should be used in place of #{described_class}" do
+        Audited.config { |config| config.audit_class = CustomAudit }
+        TempModel.audited
+
+        record = TempModel.create
+
+        audit = record.audits.first
+        expect(audit).to be_a CustomAudit
+        expect(audit.custom_method).to eq "I'm custom!"
+      end
+    end
+
+    it "should undo changes" do
+      user = Models::ActiveRecord::User.create(name: "John")
+      user.update_attribute(:name, 'Joe')
+      user.audits.last.undo
+      user.reload
+
+      expect(user.name).to eq("John")
+    end
+
+    it "should undo destroyed model" do
+      user = Models::ActiveRecord::User.create(name: "John")
+      user.destroy
+      user.audits.last.undo
+      user = Models::ActiveRecord::User.find_by(name: "John")
+      expect(user.name).to eq("John")
+    end
+
+    it "should undo created model" do
+      user = Models::ActiveRecord::User.create(name: "John")
+      expect {user.audits.last.undo}.to change(Models::ActiveRecord::User, :count).by(-1)
+    end
+
+    context "when a custom audit class is not configured" do
+      it "should default to #{described_class}" do
+        TempModel.audited
+
+        record = TempModel.create
+
+        audit = record.audits.first
+        expect(audit).to be_a Audited::Audit
+        expect(audit.respond_to?(:custom_method)).to be false
+      end
+    end
+  end
+
   describe "user=" do
 
     it "should be able to set the user to a model object" do
@@ -191,9 +261,8 @@ describe Audited::Audit do
           raise StandardError.new('expected')
         end
       }.to raise_exception('expected')
-      expect(Thread.current[:audited_user]).to be_nil
+      expect(Audited.store[:audited_user]).to be_nil
     end
 
   end
-
 end

data/spec/audited/auditor_spec.rb

@@ -17,7 +17,7 @@ describe Audited::Auditor do
       end
     end
 
-    it "should be configurable which attributes are not audited" do
+    it "should be configurable which attributes are not audited via ignored_attributes" do
       Audited.ignored_attributes = ['delta', 'top_secret', 'created_at']
       class Secret < ::ActiveRecord::Base
         audited
@@ -26,8 +26,19 @@ describe Audited::Auditor do
       expect(Secret.non_audited_columns).to include('delta', 'top_secret', 'created_at')
     end
 
+    it "should be configurable which attributes are not audited via non_audited_columns=" do
+      class Secret2 < ::ActiveRecord::Base
+        audited
+        self.non_audited_columns = ['delta', 'top_secret', 'created_at']
+      end
+
+      expect(Secret2.non_audited_columns).to include('delta', 'top_secret', 'created_at')
+    end
+
     it "should not save non-audited columns" do
-      expect(create_user.audits.first.audited_changes.keys.any? { |col| ['created_at', 'updated_at', 'password'].include?( col ) }).to eq(false)
+      Models::ActiveRecord::User.non_audited_columns = (Models::ActiveRecord::User.non_audited_columns << :favourite_device)
+
+      expect(create_user.audits.first.audited_changes.keys.any? { |col| ['favourite_device', 'created_at', 'updated_at', 'password'].include?( col ) }).to eq(false)
     end
 
     it "should not save other columns than specified in 'only' option" do
@@ -48,6 +59,57 @@ describe Audited::Auditor do
       user.save!
       expect(user.audits.last.audited_changes.keys).to eq(%w{password})
     end
+
+    it "should save attributes not specified in 'except' option" do
+      user = Models::ActiveRecord::User.create
+      user.instance_eval do
+        def non_column_attr
+          @non_column_attr
+        end
+
+        def non_column_attr=(val)
+          attribute_will_change!("non_column_attr")
+          @non_column_attr = val
+        end
+      end
+
+      user.password = "password"
+      user.non_column_attr = "some value"
+      user.save!
+      expect(user.audits.last.audited_changes.keys).to eq(%w{non_column_attr})
+    end
+
+    if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' && Rails.version >= "4.2.0.0" # Postgres json and jsonb support was added in Rails 4.2
+      describe "'json' and 'jsonb' audited_changes column type" do
+        let(:migrations_path) { SPEC_ROOT.join("support/active_record/postgres") }
+
+        after do
+          ActiveRecord::Migrator.rollback([migrations_path])
+        end
+
+        it "should work if column type is 'json'" do
+          ActiveRecord::Migrator.up([migrations_path], 1)
+          Audited::Audit.reset_column_information
+          expect(Audited::Audit.columns_hash["audited_changes"].sql_type).to eq("json")
+
+          user = Models::ActiveRecord::User.create
+          user.name = "new name"
+          user.save!
+          expect(user.audits.last.audited_changes).to eq({"name" => [nil, "new name"]})
+        end
+
+        it "should work if column type is 'jsonb'" do
+          ActiveRecord::Migrator.up([migrations_path], 2)
+          Audited::Audit.reset_column_information
+          expect(Audited::Audit.columns_hash["audited_changes"].sql_type).to eq("jsonb")
+
+          user = Models::ActiveRecord::User.create
+          user.name = "new name"
+          user.save!
+          expect(user.audits.last.audited_changes).to eq({"name" => [nil, "new name"]})
+        end
+      end
+    end
   end
 
   describe :new do
@@ -409,6 +471,10 @@ describe Audited::Auditor do
         user.revision(1).save!
       }.to change( Models::ActiveRecord::User, :count ).by(1)
     end
+
+    it "should return nil for values greater than the number of revisions" do
+      expect(user.revision(user.revisions.count + 1)).to be_nil
+    end
   end
 
   describe "revision_at" do
@@ -601,7 +667,7 @@ describe Audited::Auditor do
         Models::ActiveRecord::Company.auditing_enabled = false
         company.update_attributes name: 'STI auditors'
         Models::ActiveRecord::Company.auditing_enabled = true
-      }.to_not change( Audited.audit_class, :count )
+      }.to_not change( Audited::Audit, :count )
     end
   end
 end

data/spec/audited/sweeper_spec.rb

@@ -1,6 +1,8 @@
 require "spec_helper"
 
 class AuditsController < ActionController::Base
+  before_action :populate_user
+
   attr_reader :company
 
   def create
@@ -17,6 +19,8 @@ class AuditsController < ActionController::Base
 
   attr_accessor :current_user
   attr_accessor :custom_user
+
+  def populate_user; end
 end
 
 describe AuditsController do
@@ -69,6 +73,18 @@ describe AuditsController do
       expect(controller.company.audits.last.request_uuid).to eq("abc123")
     end
 
+    it "should call current_user after controller callbacks" do
+      expect(controller).to receive(:populate_user) do
+        controller.send(:current_user=, user)
+      end
+
+      expect {
+        post :create
+      }.to change( Audited::Audit, :count )
+
+      expect(controller.company.audits.last.user).to eq(user)
+    end
+
   end
 
   describe "PUT update" do
@@ -76,7 +92,7 @@ describe AuditsController do
       controller.send(:current_user=, user)
 
       expect {
-        put :update, id: 123
+        put :update, Rails::VERSION::MAJOR == 4 ? {id: 123} : {params: {id: 123}}
       }.to_not change( Audited::Audit, :count )
     end
   end
@@ -86,21 +102,23 @@ end
 describe Audited::Sweeper do
 
   it "should be thread-safe" do
+    instance = Audited::Sweeper.new
+
     t1 = Thread.new do
       sleep 0.5
-      Audited::Sweeper.instance.controller = 'thread1 controller instance'
-      expect(Audited::Sweeper.instance.controller).to eq('thread1 controller instance')
+      instance.controller = 'thread1 controller instance'
+      expect(instance.controller).to eq('thread1 controller instance')
     end
 
     t2 = Thread.new do
-      Audited::Sweeper.instance.controller = 'thread2 controller instance'
+      instance.controller = 'thread2 controller instance'
       sleep 1
-      expect(Audited::Sweeper.instance.controller).to eq('thread2 controller instance')
+      expect(instance.controller).to eq('thread2 controller instance')
     end
 
     t1.join; t2.join
 
-    expect(Audited::Sweeper.instance.controller).to be_nil
+    expect(instance.controller).to be_nil
   end
 
 end

data/spec/audited_spec_helpers.rb

@@ -1,7 +1,7 @@
 module AuditedSpecHelpers
 
   def create_user(attrs = {})
-    Models::ActiveRecord::User.create({name: 'Brandon', username: 'brandon', password: 'password'}.merge(attrs))
+    Models::ActiveRecord::User.create({name: 'Brandon', username: 'brandon', password: 'password', favourite_device: 'Android Phone'}.merge(attrs))
   end
 
   def build_user(attrs = {})

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 ENV['RAILS_ENV'] = 'test'
 
+require 'bundler'
 if Bundler.definition.dependencies.map(&:name).include?('protected_attributes')
   require 'protected_attributes'
 end
@@ -8,7 +9,6 @@ require 'rspec/rails'
 require 'audited'
 require 'audited_spec_helpers'
 require 'support/active_record/models'
-load "audited/sweeper.rb" # force to reload sweeper
 
 SPEC_ROOT = Pathname.new(File.expand_path('../', __FILE__))