audited 4.7.0 → 5.0.0

data/lib/audited/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Audited
+  class Railtie < Rails::Railtie
+    initializer "audited.sweeper" do
+      ActiveSupport.on_load(:action_controller) do
+        if defined?(ActionController::Base)
+          ActionController::Base.around_action Audited::Sweeper.new
+        end
+        if defined?(ActionController::API)
+          ActionController::API.around_action Audited::Sweeper.new
+        end
+      end
+    end
+  end
+end

data/lib/audited/rspec_matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Audited
   module RspecMatchers
     # Ensure that the model is audited.
@@ -78,9 +80,9 @@ module Audited
       def description
         description = "audited"
         description += " associated with #{@options[:associated_with]}" if @options.key?(:associated_with)
-        description += " only => #{@options[:only].join ', '}"          if @options.key?(:only)
-        description += " except => #{@options[:except].join(', ')}"     if @options.key?(:except)
-        description += " requires audit_comment"                        if @options.key?(:comment_required)
+        description += " only => #{@options[:only].join ", "}" if @options.key?(:only)
+        description += " except => #{@options[:except].join(", ")}" if @options.key?(:except)
+        description += " requires audit_comment" if @options.key?(:comment_required)
 
         description
       end

data/lib/audited/sweeper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Audited
   class Sweeper
     STORED_DATA = {
@@ -10,7 +12,7 @@ module Audited
 
     def around(controller)
       self.controller = controller
-      STORED_DATA.each { |k,m| store[k] = send(m) }
+      STORED_DATA.each { |k, m| store[k] = send(m) }
       yield
     ensure
       self.controller = nil
@@ -38,12 +40,3 @@ module Audited
     end
   end
 end
-
-ActiveSupport.on_load(:action_controller) do
-  if defined?(ActionController::Base)
-    ActionController::Base.around_action Audited::Sweeper.new
-  end
-  if defined?(ActionController::API)
-    ActionController::API.around_action Audited::Sweeper.new
-  end
-end

data/lib/audited/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Audited
-  VERSION = "4.7.0"
+  VERSION = "5.0.0"
 end

data/lib/generators/audited/install_generator.rb

@@ -1,9 +1,11 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'active_record'
-require 'rails/generators/active_record'
-require 'generators/audited/migration'
-require 'generators/audited/migration_helper'
+# frozen_string_literal: true
+
+require "rails/generators"
+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
@@ -18,7 +20,7 @@ module Audited
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_migration
-        migration_template 'install.rb', 'db/migrate/install_audited.rb'
+        migration_template "install.rb", "db/migrate/install_audited.rb"
       end
     end
   end

data/lib/generators/audited/migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Audited
   module Generators
     module Migration

data/lib/generators/audited/migration_helper.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :association_id, :integer

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :comment, :string

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :remote_address, :string

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :request_uuid, :string

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class <%= migration_class_name %> < <%= migration_parent %>
+  def self.up
+    if index_exists?(:audits, [:auditable_type, :auditable_id], name: index_name)
+      remove_index :audits, name: index_name
+      add_index :audits, [:auditable_type, :auditable_id, :version], name: index_name
+    end
+  end
+
+  def self.down
+    if index_exists?(:audits, [:auditable_type, :auditable_id, :version], name: index_name)
+      remove_index :audits, name: index_name
+      add_index :audits, [:auditable_type, :auditable_id], name: index_name
+    end
+  end
+
+  private
+
+  def index_name
+    'auditable_index'
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     create_table :audits, :force => true do |t|
@@ -17,7 +19,7 @@ class <%= migration_class_name %> < <%= migration_parent %>
       t.column :created_at, :datetime
     end
 
-    add_index :audits, [:auditable_type, :auditable_id], :name => 'auditable_index'
+    add_index :audits, [:auditable_type, :auditable_id, :version], :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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     if index_exists? :audits, [:association_id, :association_type], :name => 'association_index'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     rename_column :audits, :changes, :audited_changes

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     rename_column :audits, :auditable_parent_id, :association_id

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     fix_index_order_for [:associated_id, :associated_type], 'associated_index'

data/lib/generators/audited/upgrade_generator.rb

@@ -1,9 +1,11 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'active_record'
-require 'rails/generators/active_record'
-require 'generators/audited/migration'
-require 'generators/audited/migration_helper'
+# frozen_string_literal: true
+
+require "rails/generators"
+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
@@ -27,37 +29,41 @@ module Audited
         columns = Audited::Audit.columns.map(&:name)
         indexes = Audited::Audit.connection.indexes(Audited::Audit.table_name)
 
-        yield :add_comment_to_audits unless columns.include?('comment')
+        yield :add_comment_to_audits unless columns.include?("comment")
 
-        if columns.include?('changes')
+        if columns.include?("changes")
           yield :rename_changes_to_audited_changes
         end
 
-        unless columns.include?('remote_address')
+        unless columns.include?("remote_address")
           yield :add_remote_address_to_audits
         end
 
-        unless columns.include?('request_uuid')
+        unless columns.include?("request_uuid")
           yield :add_request_uuid_to_audits
         end
 
-        unless columns.include?('association_id')
-          if columns.include?('auditable_parent_id')
+        unless columns.include?("association_id")
+          if columns.include?("auditable_parent_id")
             yield :rename_parent_to_association
           else
-            unless columns.include?('associated_id')
+            unless columns.include?("associated_id")
               yield :add_association_to_audits
             end
           end
         end
 
-        if columns.include?('association_id')
+        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
+
+        if indexes.any? { |i| i.columns == %w[auditable_type auditable_id] }
+          yield :add_version_to_auditable_index
+        end
       end
     end
   end

data/spec/audited/audit_spec.rb

@@ -1,5 +1,28 @@
 require "spec_helper"
 
+SingleCov.covered! uncovered: 1 # Rails version check
+
+class CustomAudit < Audited::Audit
+  def custom_method
+    "I'm custom!"
+  end
+end
+
+class TempModel1 < ::ActiveRecord::Base
+  self.table_name = :companies
+end
+
+class TempModel2 < ::ActiveRecord::Base
+  self.table_name = :companies
+end
+
+class Models::ActiveRecord::CustomUser < ::ActiveRecord::Base
+end
+
+class Models::ActiveRecord::CustomUserSubclass < Models::ActiveRecord::CustomUser
+  audited
+end
+
 describe Audited::Audit do
   let(:user) { Models::ActiveRecord::User.new name: "Testing" }
 
@@ -7,30 +30,17 @@ describe Audited::Audit 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
+        TempModel1.audited
 
-        record = TempModel.create
+        record = TempModel1.create
 
         audit = record.audits.first
         expect(audit).to be_a CustomAudit
@@ -38,43 +48,64 @@ describe Audited::Audit do
       end
     end
 
-    it "should undo changes" do
-      user = Models::ActiveRecord::User.create(name: "John")
-      user.update_attribute(:name, 'Joe')
+    context "when a custom audit class is not configured" do
+      it "should default to #{described_class}" do
+        TempModel2.audited
+
+        record = TempModel2.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 "#audited_changes" do
+    let(:audit) { Audited.audit_class.new }
+
+    it "can unserialize yaml from text columns" do
+      audit.audited_changes = {foo: "bar"}
+      expect(audit.audited_changes).to eq foo: "bar"
+    end
+
+    it "does not unserialize from binary columns" do
+      allow(Audited::YAMLIfTextColumnType).to receive(:text_column?).and_return(false)
+      audit.audited_changes = {foo: "bar"}
+      expect(audit.audited_changes).to eq "{:foo=>\"bar\"}"
+    end
+  end
+
+  describe "#undo" do
+    let(:user) { Models::ActiveRecord::User.create(name: "John") }
+
+    it "undos changes" do
+      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")
+    it "undos destroy" do
       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)
+    it "undos creation" do
+      user # trigger create
+      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
+    it "fails when trying to undo unknown" do
+      audit = user.audits.last
+      audit.action = "oops"
+      expect { audit.undo }.to raise_error("invalid action given oops")
     end
   end
 
   describe "user=" do
-
     it "should be able to set the user to a model object" do
       subject.user = user
       expect(subject.user).to eq(user)
@@ -82,8 +113,8 @@ describe Audited::Audit do
 
     it "should be able to set the user to nil" do
       subject.user_id = 1
-      subject.user_type = 'Models::ActiveRecord::User'
-      subject.username = 'joe'
+      subject.user_type = "Models::ActiveRecord::User"
+      subject.username = "joe"
 
       subject.user = nil
 
@@ -94,30 +125,28 @@ describe Audited::Audit do
     end
 
     it "should be able to set the user to a string" do
-      subject.user = 'test'
-      expect(subject.user).to eq('test')
+      subject.user = "test"
+      expect(subject.user).to eq("test")
     end
 
     it "should clear model when setting to a string" do
       subject.user = user
-      subject.user = 'testing'
+      subject.user = "testing"
       expect(subject.user_id).to be_nil
       expect(subject.user_type).to be_nil
     end
 
     it "should clear the username when setting to a model" do
-      subject.username = 'test'
+      subject.username = "test"
       subject.user = user
       expect(subject.username).to be_nil
     end
-
   end
 
   describe "revision" do
-
     it "should recreate attributes" do
       user = Models::ActiveRecord::User.create name: "1"
-      5.times {|i| user.update_attribute :name, (i + 2).to_s }
+      5.times { |i| user.update_attribute :name, (i + 2).to_s }
 
       user.audits.each do |audit|
         expect(audit.revision.name).to eq(audit.version.to_s)
@@ -148,6 +177,34 @@ describe Audited::Audit do
     end
   end
 
+  describe ".collection_cache_key" do
+    if ActiveRecord::VERSION::MAJOR >= 5
+      it "uses created at" do
+        Audited::Audit.delete_all
+        audit = Models::ActiveRecord::User.create(name: "John").audits.last
+        audit.update_columns(created_at: Time.zone.parse("2018-01-01"))
+        expect(Audited::Audit.collection_cache_key).to match(/-20180101\d+$/)
+      end
+    else
+      it "is not defined" do
+        expect { Audited::Audit.collection_cache_key }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+  describe ".assign_revision_attributes" do
+    it "dups when frozen" do
+      user.freeze
+      assigned = Audited::Audit.assign_revision_attributes(user, name: "Bar")
+      expect(assigned.name).to eq "Bar"
+    end
+
+    it "ignores unassignable attributes" do
+      assigned = Audited::Audit.assign_revision_attributes(user, oops: "Bar")
+      expect(assigned.name).to eq "Testing"
+    end
+  end
+
   it "should set the version number on create" do
     user = Models::ActiveRecord::User.create! name: "Set Version Number"
     expect(user.audits.first.version).to eq(1)
@@ -171,12 +228,6 @@ describe Audited::Audit do
   end
 
   describe "audited_classes" do
-    class Models::ActiveRecord::CustomUser < ::ActiveRecord::Base
-    end
-    class Models::ActiveRecord::CustomUserSubclass < Models::ActiveRecord::CustomUser
-      audited
-    end
-
     it "should include audited classes" do
       expect(Audited::Audit.audited_classes).to include(Models::ActiveRecord::User)
     end
@@ -187,17 +238,37 @@ describe Audited::Audit do
   end
 
   describe "new_attributes" do
-    it "should return a hash of the new values" do
-      new_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}).new_attributes
+    it "should return the audited_changes without modification for create" do
+      new_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :create).new_attributes
+      expect(new_attributes).to eq({"int" => 1, "array" => [1]})
+    end
+
+    it "should return a hash that contains the after values of each attribute" do
+      new_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}, action: :update).new_attributes
       expect(new_attributes).to eq({"a" => 2, "b" => 4})
     end
+
+    it "should return the audited_changes without modification for destroy" do
+      new_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :destroy).new_attributes
+      expect(new_attributes).to eq({"int" => 1, "array" => [1]})
+    end
   end
 
   describe "old_attributes" do
-    it "should return a hash of the old values" do
-      old_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}).old_attributes
+    it "should return the audited_changes without modification for create" do
+      old_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :create).new_attributes
+      expect(old_attributes).to eq({"int" => 1, "array" => [1]})
+    end
+
+    it "should return a hash that contains the before values of each attribute" do
+      old_attributes = Audited::Audit.new(audited_changes: {a: [1, 2], b: [3, 4]}, action: :update).old_attributes
       expect(old_attributes).to eq({"a" => 1, "b" => 3})
     end
+
+    it "should return the audited_changes without modification for destroy" do
+      old_attributes = Audited::Audit.new(audited_changes: {int: 1, array: [1]}, action: :destroy).old_attributes
+      expect(old_attributes).to eq({"int" => 1, "array" => [1]})
+    end
   end
 
   describe "as_user" do
@@ -213,6 +284,25 @@ describe Audited::Audit do
       end
     end
 
+    it "should support nested as_user" do
+      Audited::Audit.as_user("sidekiq") do
+        company = Models::ActiveRecord::Company.create name: "The auditors"
+        company.name = "The Auditors, Inc"
+        company.save
+        expect(company.audits[-1].user).to eq("sidekiq")
+
+        Audited::Audit.as_user(user) do
+          company.name = "NEW Auditors, Inc"
+          company.save
+          expect(company.audits[-1].user).to eq(user)
+        end
+
+        company.name = "LAST Auditors, Inc"
+        company.save
+        expect(company.audits[-1].user).to eq("sidekiq")
+      end
+    end
+
     it "should record usernames" do
       Audited::Audit.as_user(user.name) do
         company = Models::ActiveRecord::Company.create name: "The auditors"
@@ -225,8 +315,8 @@ describe Audited::Audit do
       end
     end
 
-    it "should be thread safe" do
-      begin
+    if ActiveRecord::Base.connection.adapter_name != "SQLite"
+      it "should be thread safe" do
         expect(user.save).to eq(true)
 
         t1 = Thread.new do
@@ -246,10 +336,10 @@ describe Audited::Audit do
         t1.join
         t2.join
       end
-    end if ActiveRecord::Base.connection.adapter_name != 'SQLite'
+    end
 
     it "should return the value from the yield block" do
-      result = Audited::Audit.as_user('foo') do
+      result = Audited::Audit.as_user("foo") do
         42
       end
       expect(result).to eq(42)
@@ -257,12 +347,11 @@ describe Audited::Audit do
 
     it "should reset audited_user when the yield block raises an exception" do
       expect {
-        Audited::Audit.as_user('foo') do
-          raise StandardError.new('expected')
+        Audited::Audit.as_user("foo") do
+          raise StandardError.new("expected")
         end
-      }.to raise_exception('expected')
+      }.to raise_exception("expected")
       expect(Audited.store[:audited_user]).to be_nil
     end
-
   end
 end