audited 4.7.1 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d424ccbbbd38610298c61507f9a31e8333a11b9
-  data.tar.gz: 144e1fe365c5e745b5205184de45f9882d8d2cb5
+  metadata.gz: bd000e9aee82f6d9bc8f26875cf255276e1c03c4
+  data.tar.gz: 71228c6fd0026f14f1c79ffc092fa212c680ec12
 SHA512:
-  metadata.gz: 5d555a6c56d918fd09a8b691f5bc9634949aa7b0c409646e593bca23e0971da6d57b11577dbd50f9d31c271f790875783c64379b79a77d2d43c3f059b8ae7339
-  data.tar.gz: d09615fefeb971c56f5fec72ec2b3674d316bd2acbaa4e80fccb0cc6a6c27bcb11ad0fd8c9d83e69872f7bfe900e6fba140522cb99d561d41bbb0e380f19d6d0
+  metadata.gz: 85c69841d137bc726c684589a1b4ec6e2352fa3f1751cd20c38431f66dd67c459766c842f7582cda9cabfadd235d3c1b2b37548408a23118d14b194ac45e6f1b
+  data.tar.gz: 1c1a0854e666f9255972563fe2c32bb708fd1f4ad271144d1062a765c22a40d929a8bc2301278ae30bb162d214b19ea24046c35478f10c56af2748ef7205582a

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Audited ChangeLog
 
-## Unreleased
+## 4.8.0 (2018-08-19)
 
 Breaking changes
 
@@ -8,11 +8,21 @@ Breaking changes
 
 Added
 
-- None
+- Add ability to globally disable auditing
+  [#426](https://github.com/collectiveidea/audited/pull/426)
+- Add `own_and_associated_audits` method to auditable models
+  [#428](https://github.com/collectiveidea/audited/pull/428)
+- Ability to nest `as_user` within itself
+  [#450](https://github.com/collectiveidea/audited/pull/450)
+- Private methods can now be used for conditional auditing
+  [#454](https://github.com/collectiveidea/audited/pull/454)
 
 Changed
 
-- None
+- Add version to `auditable_index`
+  [#427](https://github.com/collectiveidea/audited/pull/427)
+- Rename audited resource revision `version` attribute to `audit_version` and deprecate `version` attribute
+  [#443](https://github.com/collectiveidea/audited/pull/443)
 
 Fixed
 
@@ -30,7 +40,8 @@ Added
 
 Changed
 
-- None
+- Change/deprecate `version` attribute to `audit_version` attribute
+  [#443](https://github.com/collectiveidea/audited/pull/443)
 
 Fixed
 

data/README.md

@@ -193,7 +193,7 @@ Outside of a request, Audited can still record the user with the `as_user` metho
 
 ```ruby
 Audited.audit_class.as_user(User.find(1)) do
-  post.update_attribute!(title: "Hello, world!")
+  post.update_attributes!(title: "Hello, world!")
 end
 post.audits.last.user # => #<User id: 1>
 ```
@@ -255,6 +255,11 @@ user.audits.last.associated # => #<Company name: "Collective Idea">
 company.associated_audits.last.auditable # => #<User name: "Steve Richert">
 ```
 
+You can access records' own audits and associated audits in one go:
+```ruby
+company.own_and_associated_audits
+```
+
 ### Conditional auditing
 
 If you want to audit only under specific conditions, you can provide conditional options (similar to ActiveModel callbacks) that will ensure your model is only audited for these conditions.
@@ -312,6 +317,12 @@ To disable auditing on an entire model:
 User.auditing_enabled = false
 ```
 
+To disable auditing on all models:
+
+```ruby
+Audited.auditing_enabled = false
+```
+
 ### Custom `Audit` model
 
 If you want to extend or modify the audit model, create a new class that

data/lib/audited.rb

@@ -2,7 +2,7 @@ require 'active_record'
 
 module Audited
   class << self
-    attr_accessor :ignored_attributes, :current_user_method, :max_audits
+    attr_accessor :ignored_attributes, :current_user_method, :max_audits, :auditing_enabled
     attr_writer :audit_class
 
     def audit_class
@@ -21,6 +21,7 @@ module Audited
   @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on)
 
   @current_user_method = :current_user
+  @auditing_enabled = true
 end
 
 require 'audited/auditor'

data/lib/audited/audit.rb

@@ -65,7 +65,7 @@ module Audited
     def revision
       clazz = auditable_type.constantize
       (clazz.find_by_id(auditable_id) || clazz.new).tap do |m|
-        self.class.assign_revision_attributes(m, self.class.reconstruct_attributes(ancestors).merge(version: version))
+        self.class.assign_revision_attributes(m, self.class.reconstruct_attributes(ancestors).merge(audit_version: version))
       end
     end
 
@@ -88,20 +88,18 @@ module Audited
 
     # Allows user to undo changes
     def undo
-      model = self.auditable_type.constantize
-      if action == 'create'
+      case action
+      when 'create'
         # destroys a newly created record
-        model.find(auditable_id).destroy!
-      elsif action == 'destroy'
+        auditable.destroy!
+      when 'destroy'
         # creates a new record with the destroyed record attributes
-        model.create(audited_changes)
-      else
+        auditable_type.constantize.create!(audited_changes)
+      when 'update'
         # changes back attributes
-        audited_object = model.find(auditable_id)
-        self.audited_changes.each do |k, v|
-          audited_object[k] = v[0]
-        end
-        audited_object.save
+        auditable.update_attributes!(audited_changes.transform_values(&:first))
+      else
+        raise StandardError, "invalid action given #{action}"
       end
     end
 
@@ -133,21 +131,22 @@ module Audited
     # by +user+. This method is hopefully threadsafe, making it ideal
     # for background operations that require audit information.
     def self.as_user(user, &block)
+      last_audited_user = ::Audited.store[:audited_user] 
       ::Audited.store[:audited_user] = user
       yield
     ensure
-      ::Audited.store[:audited_user] = nil
+      ::Audited.store[:audited_user] = last_audited_user
     end
 
     # @private
     def self.reconstruct_attributes(audits)
       attributes = {}
       result = audits.collect do |audit|
-        attributes.merge!(audit.new_attributes)[:version] = audit.version
+        attributes.merge!(audit.new_attributes)[:audit_version] = audit.version
         yield attributes if block_given?
       end
       block_given? ? result : attributes
-    end
+   end
 
     # @private
     def self.assign_revision_attributes(record, attributes)
@@ -171,7 +170,7 @@ module Audited
     private
 
     def set_version_number
-      max = self.class.auditable_finder(auditable_id, auditable_type).descending.first.try(:version) || 0
+      max = self.class.auditable_finder(auditable_id, auditable_type).maximum(:version) || 0
       self.version = max + 1
     end
 

data/lib/audited/auditor.rb

@@ -55,7 +55,7 @@ module Audited
 
         class_attribute :audit_associated_with, instance_writer: false
         class_attribute :audited_options,       instance_writer: false
-        attr_accessor :version, :audit_comment
+        attr_accessor :audit_version, :audit_comment
 
         self.audited_options = options
         normalize_audited_options
@@ -90,6 +90,16 @@ module Audited
     end
 
     module AuditedInstanceMethods
+      # Deprecate version attribute in favor of audit_version attribute – preparing for eventual removal.
+      def method_missing(method_name, *args, &block)
+        if method_name == :version
+          ActiveSupport::Deprecation.warn("`version` attribute has been changed to `audit_version`. This attribute will be removed.")
+          audit_version
+        else
+          super
+        end
+      end
+
       # Temporarily turns off auditing while saving.
       def save_without_auditing
         without_auditing { save }
@@ -145,6 +155,14 @@ module Audited
         attributes.except(*non_audited_columns)
       end
 
+      # Returns a list combined of record audits and associated audits.
+      def own_and_associated_audits
+        Audited.audit_class.unscoped
+        .where('(auditable_type = :type AND auditable_id = :id) OR (associated_type = :type AND associated_id = :id)',
+          type: self.class.name, id: id)
+        .order(created_at: :desc)
+      end
+
       # Combine multiple audits into one.
       def combine_audits(audits_to_combine)
         combine_target = audits_to_combine.last
@@ -210,8 +228,8 @@ module Audited
 
       def audits_to(version = nil)
         if version == :previous
-          version = if self.version
-                      self.version - 1
+          version = if self.audit_version
+                      self.audit_version - 1
                     else
                       previous = audits.descending.offset(1).first
                       previous ? previous.version : 1
@@ -290,9 +308,8 @@ module Audited
 
       def run_conditional_check(condition, matching: true)
         return true if condition.blank?
-
         return condition.call(self) == matching if condition.respond_to?(:call)
-        return send(condition) == matching if respond_to?(condition.to_sym)
+        return send(condition) == matching if respond_to?(condition.to_sym, true)
 
         true
       end
@@ -355,7 +372,7 @@ module Audited
       end
 
       def auditing_enabled
-        Audited.store.fetch("#{table_name}_auditing_enabled", true)
+        Audited.store.fetch("#{table_name}_auditing_enabled", true) && Audited.auditing_enabled
       end
 
       def auditing_enabled=(val)

data/lib/audited/version.rb

@@ -1,3 +1,3 @@
 module Audited
-  VERSION = "4.7.1"
+  VERSION = "4.8.0"
 end

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

@@ -0,0 +1,21 @@
+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

@@ -17,7 +17,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/upgrade_generator.rb

@@ -58,6 +58,10 @@ module Audited
         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

@@ -213,6 +213,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"

data/spec/audited/auditor_spec.rb

@@ -20,6 +20,24 @@ describe Audited::Auditor do
     context "should be configurable which conditions are audited" do
       subject { ConditionalCompany.new.send(:auditing_enabled) }
 
+      context "when condition method is private" do
+        subject { ConditionalPrivateCompany.new.send(:auditing_enabled) }
+
+        before do
+          class ConditionalPrivateCompany < ::ActiveRecord::Base
+            self.table_name = 'companies'
+
+            audited if: :foo?
+
+            private def foo?
+              true
+            end
+          end
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
       context "when passing a method name" do
         before do
           class ConditionalCompany < ::ActiveRecord::Base
@@ -581,21 +599,21 @@ describe Audited::Auditor do
     it "should find the given revision" do
       revision = user.revision(3)
       expect(revision).to be_a_kind_of( Models::ActiveRecord::User )
-      expect(revision.version).to eq(3)
+      expect(revision.audit_version).to eq(3)
       expect(revision.name).to eq('Foobar 3')
     end
 
     it "should find the previous revision with :previous" do
       revision = user.revision(:previous)
-      expect(revision.version).to eq(4)
+      expect(revision.audit_version).to eq(4)
       #expect(revision).to eq(user.revision(4))
       expect(revision.attributes).to eq(user.revision(4).attributes)
     end
 
     it "should be able to get the previous revision repeatedly" do
       previous = user.revision(:previous)
-      expect(previous.version).to eq(4)
-      expect(previous.revision(:previous).version).to eq(3)
+      expect(previous.audit_version).to eq(4)
+      expect(previous.revision(:previous).audit_version).to eq(3)
     end
 
     it "should be able to set protected attributes" do
@@ -669,7 +687,7 @@ describe Audited::Auditor do
       audit.created_at = 1.hour.ago
       audit.save!
       user.update_attributes name: 'updated'
-      expect(user.revision_at( 2.minutes.ago ).version).to eq(1)
+      expect(user.revision_at( 2.minutes.ago ).audit_version).to eq(1)
     end
 
     it "should be nil if given a time before audits" do
@@ -677,6 +695,33 @@ describe Audited::Auditor do
     end
   end
 
+  describe "own_and_associated_audits" do
+    it "should return audits for self and associated audits" do
+      owner = Models::ActiveRecord::Owner.create!
+      company = owner.companies.create!
+      company.update!(name: "Collective Idea")
+
+      other_owner = Models::ActiveRecord::Owner.create!
+      other_company = other_owner.companies.create!
+
+      expect(owner.own_and_associated_audits).to match_array(owner.audits + company.audits)
+    end
+
+    it "should order audits by creation time" do
+      owner = Models::ActiveRecord::Owner.create!
+      first_audit = owner.audits.first
+      first_audit.update_column(:created_at, 1.year.ago)
+
+      company = owner.companies.create!
+      second_audit = company.audits.first
+      second_audit.update_column(:created_at, 1.month.ago)
+
+      company.update!(name: "Collective Idea")
+      third_audit = company.audits.last
+      expect(owner.own_and_associated_audits.to_a).to eq([third_audit, second_audit, first_audit])
+    end
+  end
+
   describe "without auditing" do
     it "should not save an audit when calling #save_without_auditing" do
       expect {
@@ -697,31 +742,44 @@ describe Audited::Auditor do
     end
 
     it "should be thread safe using a #without_auditing block" do
-      begin
-        t1 = Thread.new do
-          expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
-          Models::ActiveRecord::User.without_auditing do
-            expect(Models::ActiveRecord::User.auditing_enabled).to eq(false)
-            Models::ActiveRecord::User.create!( name: 'Bart' )
-            sleep 1
-            expect(Models::ActiveRecord::User.auditing_enabled).to eq(false)
-          end
-          expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
-        end
-
-        t2 = Thread.new do
-          sleep 0.5
-          expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
-          Models::ActiveRecord::User.create!( name: 'Lisa' )
+      skip if Models::ActiveRecord::User.connection.class.name.include?("SQLite")
+
+      t1 = Thread.new do
+        expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
+        Models::ActiveRecord::User.without_auditing do
+          expect(Models::ActiveRecord::User.auditing_enabled).to eq(false)
+          Models::ActiveRecord::User.create!( name: 'Bart' )
+          sleep 1
+          expect(Models::ActiveRecord::User.auditing_enabled).to eq(false)
         end
-        t1.join
-        t2.join
+        expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
+      end
 
-        expect(Models::ActiveRecord::User.find_by_name('Bart').audits.count).to eq(0)
-        expect(Models::ActiveRecord::User.find_by_name('Lisa').audits.count).to eq(1)
-      rescue ActiveRecord::StatementInvalid
-        STDERR.puts "Thread safety tests cannot be run with SQLite"
+      t2 = Thread.new do
+        sleep 0.5
+        expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
+        Models::ActiveRecord::User.create!( name: 'Lisa' )
       end
+      t1.join
+      t2.join
+
+      expect(Models::ActiveRecord::User.find_by_name('Bart').audits.count).to eq(0)
+      expect(Models::ActiveRecord::User.find_by_name('Lisa').audits.count).to eq(1)
+    end
+
+    it "should not save an audit when auditing is globally disabled" do
+      expect(Audited.auditing_enabled).to eq(true)
+      Audited.auditing_enabled = false
+      expect(Models::ActiveRecord::User.auditing_enabled).to eq(false)
+
+      user = create_user
+      expect(user.audits.count).to eq(0)
+
+      Audited.auditing_enabled = true
+      expect(Models::ActiveRecord::User.auditing_enabled).to eq(true)
+
+      user.update_attributes(name: 'Test')
+      expect(user.audits.count).to eq(1)
     end
   end
 

data/spec/rails_app/config/application.rb

@@ -6,3 +6,8 @@ module RailsApp
     config.i18n.enforce_available_locales = true
   end
 end
+
+require 'active_record/connection_adapters/sqlite3_adapter'
+if ActiveRecord::ConnectionAdapters::SQLite3Adapter.respond_to?(:represent_boolean_as_integer)
+  ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer = true
+end

data/spec/support/active_record/models.rb

@@ -91,6 +91,7 @@ module Models
 
     class Owner < ::ActiveRecord::Base
       self.table_name = 'users'
+      audited
       has_associated_audits
       has_many :companies, class_name: "OwnedCompany", dependent: :destroy
     end

data/test/db/version_6.rb

@@ -14,4 +14,6 @@ ActiveRecord::Schema.define do
     t.column :associated_id, :integer
     t.column :associated_type, :string
   end
+
+  add_index :audits, [:auditable_type, :auditable_id], name: 'auditable_index'
 end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 ENV['RAILS_ENV'] = 'test'
 
-$:.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
 require File.expand_path('../../spec/rails_app/config/environment', __FILE__)
 require 'rails/test_help'
@@ -8,7 +8,6 @@ require 'rails/test_help'
 require 'audited'
 
 class ActiveSupport::TestCase
-
   setup do
     ActiveRecord::Migration.verbose = false
   end

data/test/upgrade_generator_test.rb

@@ -79,6 +79,16 @@ class UpgradeGeneratorTest < Rails::Generators::TestCase
     end
   end
 
+  test "should add 'version' to auditable_index" do
+    load_schema 6
+
+    run_generator %w(upgrade)
+
+    assert_migration "db/migrate/add_version_to_auditable_index.rb" do |content|
+      assert_match(/add_index :audits, \[:auditable_type, :auditable_id, :version\]/, content)
+    end
+  end
+
   test "generate migration with correct AR migration parent" do
     load_schema 1
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.8.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -160,6 +160,7 @@ files:
 - lib/generators/audited/templates/add_comment_to_audits.rb
 - lib/generators/audited/templates/add_remote_address_to_audits.rb
 - lib/generators/audited/templates/add_request_uuid_to_audits.rb
+- lib/generators/audited/templates/add_version_to_auditable_index.rb
 - lib/generators/audited/templates/install.rb
 - lib/generators/audited/templates/rename_association_to_associated.rb
 - lib/generators/audited/templates/rename_changes_to_audited_changes.rb