audited 4.2.1 → 4.4.0

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

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < <%= migration_parent %>
+  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 %> < <%= migration_parent %>
+  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 %> < <%= migration_parent %>
+  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 %> < <%= migration_parent %>
+  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 %> < <%= 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_type, :string
+      t.column :username, :string
+      t.column :action, :string
+      t.column :audited_changes, :<%= options[:audited_changes_column_type] %>
+      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 %> < <%= migration_parent %>
+  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 %> < <%= migration_parent %>
+  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 %> < <%= migration_parent %>
+  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,59 @@
+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
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Audited::Generators::MigrationHelper
+      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

data/spec/audited/audit_spec.rb

@@ -0,0 +1,246 @@
+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
+
+    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
+      subject.user = user
+      expect(subject.user).to eq(user)
+    end
+
+    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 = nil
+
+      expect(subject.user).to be_nil
+      expect(subject.user_id).to be_nil
+      expect(subject.user_type).to be_nil
+      expect(subject.username).to be_nil
+    end
+
+    it "should be able to set the user to a string" do
+      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'
+      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.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 }
+
+      user.audits.each do |audit|
+        expect(audit.revision.name).to eq(audit.version.to_s)
+      end
+    end
+
+    it "should set protected attributes" do
+      u = Models::ActiveRecord::User.create(name: "Brandon")
+      u.update_attribute :logins, 1
+      u.update_attribute :logins, 2
+
+      expect(u.audits[2].revision.logins).to eq(2)
+      expect(u.audits[1].revision.logins).to eq(1)
+      expect(u.audits[0].revision.logins).to eq(0)
+    end
+
+    it "should bypass attribute assignment wrappers" do
+      u = Models::ActiveRecord::User.create(name: "<Joe>")
+      expect(u.audits.first.revision.name).to eq("&lt;Joe&gt;")
+    end
+
+    it "should work for deleted records" do
+      user = Models::ActiveRecord::User.create name: "1"
+      user.destroy
+      revision = user.audits.last.revision
+      expect(revision.name).to eq(user.name)
+      expect(revision).to be_a_new_record
+    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)
+    user.update_attribute :name, "Set to 2"
+    expect(user.audits.reload.first.version).to eq(1)
+    expect(user.audits.reload.last.version).to eq(2)
+    user.destroy
+    expect(Audited::Audit.where(auditable_type: "Models::ActiveRecord::User", auditable_id: user.id).last.version).to eq(3)
+  end
+
+  it "should set the request uuid on create" do
+    user = Models::ActiveRecord::User.create! name: "Set Request UUID"
+    expect(user.audits.reload.first.request_uuid).not_to be_blank
+  end
+
+  describe "reconstruct_attributes" do
+    it "should work with the old way of storing just the new value" do
+      audits = Audited::Audit.reconstruct_attributes([Audited::Audit.new(audited_changes: {"attribute" => "value"})])
+      expect(audits["attribute"]).to eq("value")
+    end
+  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
+
+    it "should include subclasses" do
+      expect(Audited::Audit.audited_classes).to include(Models::ActiveRecord::CustomUserSubclass)
+    end
+  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
+      expect(new_attributes).to eq({"a" => 2, "b" => 4})
+    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
+      expect(old_attributes).to eq({"a" => 1, "b" => 3})
+    end
+  end
+
+  describe "as_user" do
+    it "should record user objects" do
+      Audited::Audit.as_user(user) do
+        company = Models::ActiveRecord::Company.create name: "The auditors"
+        company.name = "The Auditors, Inc"
+        company.save
+
+        company.audits.each do |audit|
+          expect(audit.user).to eq(user)
+        end
+      end
+    end
+
+    it "should record usernames" do
+      Audited::Audit.as_user(user.name) do
+        company = Models::ActiveRecord::Company.create name: "The auditors"
+        company.name = "The Auditors, Inc"
+        company.save
+
+        company.audits.each do |audit|
+          expect(audit.username).to eq(user.name)
+        end
+      end
+    end
+
+    it "should be thread safe" do
+      begin
+        expect(user.save).to eq(true)
+
+        t1 = Thread.new do
+          Audited::Audit.as_user(user) do
+            sleep 1
+            expect(Models::ActiveRecord::Company.create(name: "The Auditors, Inc").audits.first.user).to eq(user)
+          end
+        end
+
+        t2 = Thread.new do
+          Audited::Audit.as_user(user.name) do
+            expect(Models::ActiveRecord::Company.create(name: "The Competing Auditors, LLC").audits.first.username).to eq(user.name)
+            sleep 0.5
+          end
+        end
+
+        t1.join
+        t2.join
+      end
+    end if ActiveRecord::Base.connection.adapter_name != 'SQLite'
+
+    it "should return the value from the yield block" do
+      result = Audited::Audit.as_user('foo') do
+        42
+      end
+      expect(result).to eq(42)
+    end
+
+    it "should reset audited_user when the yield block raises an exception" do
+      expect {
+        Audited::Audit.as_user('foo') do
+          raise StandardError.new('expected')
+        end
+      }.to raise_exception('expected')
+      expect(Audited.store[:audited_user]).to be_nil
+    end
+
+  end
+end