audited 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e4cd2ba4231df555461162a9ab0b41db0952828
-  data.tar.gz: c3bed2498a2c13bb5f3e7c27367114ca200cc3c8
+  metadata.gz: 11243e8bfb9c50162f0f939a283270f7bf706387
+  data.tar.gz: 9b081dea623844e1bd37b71f774490dc8596ef84
 SHA512:
-  metadata.gz: 1249f2af82d7c2633ab5b9d40dfa598c4c4ce6f21d9a817ab1bc82791521a01bf6e95a43b1e1627b65cc1fb5558860acac964acee1ec9f72b85958d13cd2ebf1
-  data.tar.gz: 5c33514373b367cd52042e471b79f46adbd72c8ce7f759948d2e087a525833c985cd5a601d37319997f201fcb6a5c4ff6b3bd64ce2a1deca294ba5d80833ef21
+  metadata.gz: f5ca8463b13d3c2fc463749a1ff46c1522b5ed6c049dd743e72d47577c5da025f46f3ab90492fa19a88cfbf7cd38ee302e2aefced16098dcd3bd7846a6be0eb9
+  data.tar.gz: e4e5b349f6a8db618deb7a6fd48a853eb75729ddbff3b78c431c89247ec17aaceb2e4a67dd206defbfeb5fe4e8b6a47c4af0212c5898fd777848c08625aca90e

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 cache: bundler
 rvm:
   - 2.1
-  - 2.2.4
-  - 2.3.1
-  - 2.4.1
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
   - ruby-head
 env:
   - DB=SQLITE
@@ -18,6 +18,7 @@ gemfile:
   - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head
@@ -26,9 +27,15 @@ matrix:
       gemfile: gemfiles/rails50.gemfile
     - rvm: 2.1
       gemfile: gemfiles/rails51.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.1
+      gemfile: gemfiles/rails52.gemfile
+    - rvm: 2.4.2
       gemfile: gemfiles/rails40.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.4.2
+      gemfile: gemfiles/rails41.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails40.gemfile
+    - rvm: ruby-head
       gemfile: gemfiles/rails41.gemfile
   fast_finish: true
 branches:

data/Appraisals

@@ -19,5 +19,10 @@ appraise 'rails50' do
 end
 
 appraise 'rails51' do
-  gem 'rails', '>= 5.1.0.rc1', '< 5.2'
+  gem 'rails', '~> 5.1.4'
+end
+
+appraise 'rails52' do
+  gem 'rails', '>= 5.2.0.beta2', '< 5.3'
+  gem 'mysql2', '~> 0.4.4'
 end

data/CHANGELOG.md

@@ -18,6 +18,49 @@ Fixed
 
 - None
 
+
+## 4.6.0 (2018-01-10)
+
+Breaking changes
+
+- None
+
+Added
+
+- Add functionality to undo specific audit
+  [#381](https://github.com/collectiveidea/audited/pull/381)
+
+Changed
+
+- Removed duplicate declaration of `non_audited_columns` method
+  [#365](https://github.com/collectiveidea/audited/pull/365)
+- Updated `audited_changes` calculation to support Rails>=5.1 change syntax
+  [#377](https://github.com/collectiveidea/audited/pull/377)
+- Improve index ordering for polymorphic indexes
+  [#385](https://github.com/collectiveidea/audited/pull/385)
+- Update CI to test on newer versions of Ruby and Rails
+  [#386](https://github.com/collectiveidea/audited/pull/386)
+  [#387](https://github.com/collectiveidea/audited/pull/387)
+  [#388](https://github.com/collectiveidea/audited/pull/388)
+- Simplify `audited_columns` calculation
+  [#391](https://github.com/collectiveidea/audited/pull/391)
+- Simplify `audited_changes` calculation
+  [#389](https://github.com/collectiveidea/audited/pull/389)
+- Normalize options passed to `audited` method
+  [#397](https://github.com/collectiveidea/audited/pull/397)
+
+Fixed
+
+- Fixed typo in rspec causing incorrect test failure
+  [#360](https://github.com/collectiveidea/audited/pull/360)
+- Allow running specs using rake
+  [#390](https://github.com/collectiveidea/audited/pull/390)
+- Passing an invalid version to `revision` returns `nil` instead of last version
+  [#384](https://github.com/collectiveidea/audited/pull/384)
+- Fix duplicate deceleration warnings
+  [#399](https://github.com/collectiveidea/audited/pull/399)
+
+
 ## 4.5.0 (2017-05-22)
 
 Breaking changes

data/README.md

@@ -11,10 +11,10 @@ For Rails 3, use gem version 3.0 or see the [3.0-stable branch](https://github.c
 
 Audited supports and is [tested against](http://travis-ci.org/collectiveidea/audited) the following Ruby versions:
 
-* 2.1.5
-* 2.2.4
-* 2.3.1
-* 2.4.1
+* 2.1.10
+* 2.2.8
+* 2.3.5
+* 2.4.2
 
 Audited may work just fine with a Ruby version not listed above, but we can't guarantee that it will. If you'd like to maintain a Ruby that isn't listed, please let us know with a [pull request](https://github.com/collectiveidea/audited/pulls).
 
@@ -27,7 +27,7 @@ Audited is currently ActiveRecord-only. In a previous life, Audited worked with
 Add the gem to your Gemfile:
 
 ```ruby
-gem "audited", "~> 4.5"
+gem "audited", "~> 4.6"
 ```
 
 Then, from your Rails app directory, create the `audits` table:

data/gemfiles/rails40.gemfile

@@ -6,4 +6,4 @@ gem "rails", "~> 4.0.0"
 gem "protected_attributes"
 gem "test-unit"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails41.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 4.1.0"
 gem "protected_attributes"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails42.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 4.2.0"
 gem "protected_attributes"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails50.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails51.gemfile

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", ">= 5.1.0.rc1", "< 5.2"
+gem "rails", "~> 5.1.4"
 
-gemspec :name => "audited", :path => "../"
+gemspec name: "audited", path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", ">= 5.2.0.beta2", "< 5.3"
+gem "mysql2", "~> 0.4.4"
+
+gemspec name: "audited", path: "../"

data/lib/audited.rb

@@ -2,10 +2,11 @@ require 'active_record'
 
 module Audited
   class << self
-    attr_accessor :ignored_attributes, :current_user_method, :audit_class
+    attr_accessor :ignored_attributes, :current_user_method
+    attr_writer :audit_class
 
     def audit_class
-      @audit_class || Audit
+      @audit_class ||= Audit
     end
 
     def store

data/lib/audited/audit.rb

@@ -86,6 +86,25 @@ module Audited
       end
     end
 
+    # Allows user to undo changes
+    def undo
+      model = self.auditable_type.constantize
+      if action == 'create'
+        # destroys a newly created record
+        model.find(auditable_id).destroy!
+      elsif action == 'destroy'
+        # creates a new record with the destroyed record attributes
+        model.create(audited_changes)
+      else
+        # 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
+      end
+    end
+
     # Allows user to be set to either a string or an ActiveRecord object
     # @private
     def user_as_string=(user)

data/lib/audited/auditor.rb

@@ -38,26 +38,29 @@ module Audited
         # don't allow multiple calls
         return if included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
 
+        extend Audited::Auditor::AuditedClassMethods
+        include Audited::Auditor::AuditedInstanceMethods
+
         class_attribute :audit_associated_with,   instance_writer: false
         class_attribute :audited_options,       instance_writer: false
+        attr_accessor :version, :audit_comment
 
         self.audited_options = options
-        self.audit_associated_with = options[:associated_with]
+        normalize_audited_options
 
-        if options[:comment_required]
+        self.audit_associated_with = audited_options[:associated_with]
+
+        if audited_options[:comment_required]
           validates_presence_of :audit_comment, if: :auditing_enabled
           before_destroy :require_comment
         end
 
-        attr_accessor :audit_comment
-
         has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: Audited.audit_class.name
         Audited.audit_class.audited_class_names << to_s
 
-        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)
+        after_create :audit_create    if audited_options[:on].include?(:create)
+        before_update :audit_update   if audited_options[:on].include?(:update)
+        before_destroy :audit_destroy if audited_options[: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
@@ -66,21 +69,12 @@ module Audited
         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
-
-        extend Audited::Auditor::AuditedClassMethods
-        include Audited::Auditor::AuditedInstanceMethods
-
-        self.auditing_enabled = true
+        enable_auditing
       end
 
       def has_associated_audits
         has_many :associated_audits, as: :associated, class_name: Audited.audit_class.name
       end
-
-      def default_ignored_attributes
-        [primary_key, inheritance_column]
-      end
     end
 
     module AuditedInstanceMethods
@@ -109,16 +103,15 @@ module Audited
       def revisions(from_version = 1)
         audits = self.audits.from_version(from_version)
         return [] if audits.empty?
-        revisions = []
-        audits.each do |audit|
-          revisions << audit.revision
-        end
-        revisions
+        audits.map(&:revision)
       end
 
       # Get a specific revision specified by the version number, or +:previous+
+      # Returns nil for versions greater than revisions count
       def revision(version)
-        revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
+        if version == :previous || self.audits.last.version >= version
+          revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
+        end
       end
 
       # Find the oldest revision recorded prior to the date/time provided.
@@ -129,11 +122,7 @@ module Audited
 
       # List of attributes that are audited.
       def audited_attributes
-        attributes.except(*non_audited_columns.map(&:to_s))
-      end
-
-      def non_audited_columns
-        self.class.non_audited_columns
+        attributes.except(*non_audited_columns)
       end
 
       protected
@@ -142,6 +131,10 @@ module Audited
         self.class.non_audited_columns
       end
 
+      def audited_columns
+        self.class.audited_columns
+      end
+
       def revision_with(attributes)
         dup.tap do |revision|
           revision.id = id
@@ -175,17 +168,11 @@ module Audited
       private
 
       def audited_changes
-        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
+        all_changes = respond_to?(:changes_to_save) ? changes_to_save : changes
+        if audited_options[:only].present?
+          all_changes.slice(*audited_columns)
+        else
+          all_changes.except(*non_audited_columns)
         end
       end
 
@@ -236,9 +223,6 @@ module Audited
         alias_method "#{attr_name}_callback".to_sym, attr_name
       end
 
-      def empty_callback #:nodoc:
-      end
-
       def auditing_enabled
         self.class.auditing_enabled
       end
@@ -251,24 +235,19 @@ module Audited
     module AuditedClassMethods
       # Returns an array of columns that are audited. See non_audited_columns
       def audited_columns
-        columns.reject { |c| non_audited_columns.map(&:to_s).include?(c.name) }
+        @audited_columns ||= column_names - non_audited_columns
       end
 
+      # We have to calculate this here since column_names may not be available when `audited` is called
       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
+        @non_audited_columns ||= audited_options[:only].present? ?
+                                 column_names - audited_options[:only] :
+                                 default_ignored_attributes | audited_options[:except]
       end
 
       def non_audited_columns=(columns)
-        @non_audited_columns = columns
+        @audited_columns = nil # reset cached audited columns on assignment
+        @non_audited_columns = columns.map(&:to_s)
       end
 
       # Executes the block with auditing disabled.
@@ -308,6 +287,18 @@ module Audited
       def auditing_enabled=(val)
         Audited.store["#{table_name}_auditing_enabled"] = val
       end
+
+      protected
+      def default_ignored_attributes
+        [primary_key, inheritance_column] + Audited.ignored_attributes
+      end
+
+      def normalize_audited_options
+        audited_options[:on] = Array.wrap(audited_options[:on])
+        audited_options[:on] = [:create, :update, :destroy] if audited_options[:on].empty?
+        audited_options[:only] = Array.wrap(audited_options[:only]).map(&:to_s)
+        audited_options[:except] = Array.wrap(audited_options[:except]).map(&:to_s)
+      end
     end
   end
 end

data/lib/audited/rspec_matchers.rb

@@ -117,7 +117,7 @@ module Audited
             except |= @options[:except].collect(&:to_s) if @options[:except]
           end
 
-          expects "non audited columns (#{model_class.non_audited_columns.inspect}) to match (#{expect})"
+          expects "non audited columns (#{model_class.non_audited_columns.inspect}) to match (#{except})"
           model_class.non_audited_columns =~ except
         else
           true

data/lib/audited/version.rb

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

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

@@ -17,8 +17,8 @@ class <%= migration_class_name %> < <%= migration_parent %>
       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/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

@@ -25,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')
 
@@ -53,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

@@ -38,6 +38,28 @@ describe Audited::Audit do
       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

data/spec/audited/auditor_spec.rb

@@ -60,6 +60,25 @@ describe Audited::Auditor do
       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") }
@@ -452,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

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__))
 

data/spec/support/active_record/models.rb

@@ -5,7 +5,7 @@ module Models
   module ActiveRecord
     class User < ::ActiveRecord::Base
       audited allow_mass_assignment: true, except: :password
-
+      attribute :non_column_attr if Rails.version >= '5.1'
       attr_protected :logins if respond_to?(:attr_protected)
 
       def name=(val)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -145,6 +145,7 @@ files:
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
 - lib/audited-rspec.rb
 - lib/audited.rb
 - lib/audited/audit.rb
@@ -163,6 +164,7 @@ files:
 - lib/generators/audited/templates/rename_association_to_associated.rb
 - lib/generators/audited/templates/rename_changes_to_audited_changes.rb
 - lib/generators/audited/templates/rename_parent_to_association.rb
+- lib/generators/audited/templates/revert_polymorphic_indexes_order.rb
 - lib/generators/audited/upgrade_generator.rb
 - spec/audited/audit_spec.rb
 - spec/audited/auditor_spec.rb
@@ -212,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Log all changes to your models