audited 4.6.0 → 4.10.0

data/spec/audited/rspec_matchers_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe Models::ActiveRecord::UserExceptPassword do
+  let(:non_audited_columns) { subject.class.non_audited_columns }
+
+  it { should_not be_audited.only(non_audited_columns) }
+  it { should be_audited.except(:password) }
+  it { should_not be_audited.requires_comment }
+  it { should be_audited.on(:create, :update, :destroy) }
+  # test chaining
+  it { should be_audited.except(:password).on(:create, :update, :destroy) }
+end
+
+describe Models::ActiveRecord::UserOnlyPassword do
+  let(:audited_columns) { subject.class.audited_columns }
+
+  it { should be_audited.only(:password) }
+  it { should_not be_audited.except(audited_columns) }
+  it { should_not be_audited.requires_comment }
+  it { should be_audited.on(:create, :update, :destroy) }
+  it { should be_audited.only(:password).on(:create, :update, :destroy) }
+end
+
+describe Models::ActiveRecord::CommentRequiredUser do
+  let(:audited_columns) { subject.class.audited_columns }
+  let(:non_audited_columns) { subject.class.non_audited_columns }
+
+  it { should_not be_audited.only(non_audited_columns) }
+  it { should_not be_audited.except(audited_columns) }
+  it { should be_audited.requires_comment }
+  it { should be_audited.on(:create, :update, :destroy) }
+  it { should be_audited.requires_comment.on(:create, :update, :destroy) }
+end
+
+describe Models::ActiveRecord::OnCreateCommentRequiredUser do
+  let(:audited_columns) { subject.class.audited_columns }
+  let(:non_audited_columns) { subject.class.non_audited_columns }
+
+  it { should_not be_audited.only(non_audited_columns) }
+  it { should_not be_audited.except(audited_columns) }
+  it { should be_audited.requires_comment }
+  it { should be_audited.on(:create) }
+  it { should_not be_audited.on(:update, :destroy) }
+  it { should be_audited.requires_comment.on(:create) }
+end
+
+describe Models::ActiveRecord::OnUpdateCommentRequiredUser do
+  let(:audited_columns) { subject.class.audited_columns }
+  let(:non_audited_columns) { subject.class.non_audited_columns }
+
+  it { should_not be_audited.only(non_audited_columns) }
+  it { should_not be_audited.except(audited_columns) }
+  it { should be_audited.requires_comment }
+  it { should be_audited.on(:update) }
+  it { should_not be_audited.on(:create, :destroy) }
+  it { should be_audited.requires_comment.on(:update) }
+end
+
+describe Models::ActiveRecord::OnDestroyCommentRequiredUser do
+  let(:audited_columns) { subject.class.audited_columns }
+  let(:non_audited_columns) { subject.class.non_audited_columns }
+
+  it { should_not be_audited.only(non_audited_columns) }
+  it { should_not be_audited.except(audited_columns) }
+  it { should be_audited.requires_comment }
+  it { should be_audited.on(:destroy) }
+  it { should_not be_audited.on(:create, :update) }
+  it { should be_audited.requires_comment.on(:destroy) }
+end

data/spec/audited/sweeper_spec.rb

@@ -1,5 +1,7 @@
 require "spec_helper"
 
+SingleCov.covered! uncovered: 2 # 2 conditional on_load conditions
+
 class AuditsController < ActionController::Base
   before_action :populate_user
 
@@ -11,7 +13,7 @@ class AuditsController < ActionController::Base
   end
 
   def update
-    current_user.update_attributes(password: 'foo')
+    current_user.update!(password: 'foo')
     head :ok
   end
 
@@ -27,14 +29,13 @@ describe AuditsController do
   include RSpec::Rails::ControllerExampleGroup
   render_views
 
-  before(:each) do
+  before do
     Audited.current_user_method = :current_user
   end
 
   let(:user) { create_user }
 
   describe "POST audit" do
-
     it "should audit user" do
       controller.send(:current_user=, user)
       expect {
@@ -44,6 +45,15 @@ describe AuditsController do
       expect(controller.company.audits.last.user).to eq(user)
     end
 
+    it "does not audit when method is not found" do
+      controller.send(:current_user=, user)
+      Audited.current_user_method = :nope
+      expect {
+        post :create
+      }.to change( Audited::Audit, :count )
+      expect(controller.company.audits.last.user).to eq(nil)
+    end
+
     it "should support custom users for sweepers" do
       controller.send(:custom_user=, user)
       Audited.current_user_method = :custom_user
@@ -84,7 +94,6 @@ describe AuditsController do
 
       expect(controller.company.audits.last.user).to eq(user)
     end
-
   end
 
   describe "PUT update" do
@@ -92,13 +101,13 @@ describe AuditsController do
       controller.send(:current_user=, user)
 
       expect {
-        put :update, Rails::VERSION::MAJOR == 4 ? {id: 123} : {params: {id: 123}}
+        params = Rails::VERSION::MAJOR == 4 ? {id: 123} : {params: {id: 123}}
+        put :update, **params
       }.to_not change( Audited::Audit, :count )
     end
   end
 end
 
-
 describe Audited::Sweeper do
 
   it "should be thread-safe" do

data/spec/audited_spec_helpers.rb

@@ -8,8 +8,8 @@ module AuditedSpecHelpers
     Models::ActiveRecord::User.new({name: 'darth', username: 'darth', password: 'noooooooo'}.merge(attrs))
   end
 
-  def create_versions(n = 2)
-    Models::ActiveRecord::User.create(name: 'Foobar 1').tap do |u|
+  def create_versions(n = 2, attrs = {})
+    Models::ActiveRecord::User.create(name: 'Foobar 1', **attrs).tap do |u|
       (n - 1).times do |i|
         u.update_attribute :name, "Foobar #{i + 2}"
       end
@@ -17,4 +17,18 @@ module AuditedSpecHelpers
     end
   end
 
+  def run_migrations(direction, migrations_paths, target_version = nil)
+    if rails_below?('5.2.0.rc1')
+      ActiveRecord::Migrator.send(direction, migrations_paths, target_version)
+    elsif rails_below?('6.0.0.rc1')
+      ActiveRecord::MigrationContext.new(migrations_paths).send(direction, target_version)
+    else
+      ActiveRecord::MigrationContext.new(migrations_paths, ActiveRecord::SchemaMigration).send(direction, target_version)
+    end
+  end
+
+  def rails_below?(rails_version)
+    Gem::Version.new(Rails::VERSION::STRING) < Gem::Version.new(rails_version)
+  end
+
 end

data/spec/rails_app/app/assets/config/manifest.js

@@ -0,0 +1 @@
+{}

data/spec/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+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/rails_app/config/database.yml

@@ -19,6 +19,7 @@ mysql: &MYSQL
   username: root
   password:
   database: audited_test
+  charset: utf8
 
 test:
   <<: *<%= ENV['DB'] || 'SQLITE3MEM' %>

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
 ENV['RAILS_ENV'] = 'test'
+require 'bundler/setup'
+require 'single_cov'
+SingleCov.setup :rspec
 
-require 'bundler'
 if Bundler.definition.dependencies.map(&:name).include?('protected_attributes')
   require 'protected_attributes'
 end
 require 'rails_app/config/environment'
 require 'rspec/rails'
 require 'audited'
+require 'audited-rspec'
 require 'audited_spec_helpers'
 require 'support/active_record/models'
 

data/spec/support/active_record/models.rb

@@ -4,19 +4,40 @@ require File.expand_path('../schema', __FILE__)
 module Models
   module ActiveRecord
     class User < ::ActiveRecord::Base
-      audited allow_mass_assignment: true, except: :password
+      audited except: :password
       attribute :non_column_attr if Rails.version >= '5.1'
       attr_protected :logins if respond_to?(:attr_protected)
+      enum status: { active: 0, reliable: 1, banned: 2 }
 
       def name=(val)
         write_attribute(:name, CGI.escapeHTML(val))
       end
     end
 
+    class UserExceptPassword < ::ActiveRecord::Base
+      self.table_name = :users
+      audited except: :password
+    end
+
     class UserOnlyPassword < ::ActiveRecord::Base
       self.table_name = :users
       attribute :non_column_attr if Rails.version >= '5.1'
-      audited allow_mass_assignment: true, only: :password
+      audited only: :password
+    end
+
+    class UserRedactedPassword < ::ActiveRecord::Base
+      self.table_name = :users
+      audited redacted: :password
+    end
+
+    class UserMultipleRedactedAttributes < ::ActiveRecord::Base
+      self.table_name = :users
+      audited redacted: [:password, :ssn]
+    end
+
+    class UserRedactedPasswordCustomRedaction < ::ActiveRecord::Base
+      self.table_name = :users
+      audited redacted: :password, redaction_value: ["My", "Custom", "Value", 7]
     end
 
     class CommentRequiredUser < ::ActiveRecord::Base
@@ -24,6 +45,26 @@ module Models
       audited comment_required: true
     end
 
+    class OnCreateCommentRequiredUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited comment_required: true, on: :create
+    end
+
+    class OnUpdateCommentRequiredUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited comment_required: true, on: :update
+    end
+
+    class OnDestroyCommentRequiredUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited comment_required: true, on: :destroy
+    end
+
+    class NoUpdateWithCommentOnlyUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited update_with_comment_only: false
+    end
+
     class AccessibleAfterDeclarationUser < ::ActiveRecord::Base
       self.table_name = :users
       audited
@@ -38,7 +79,7 @@ module Models
 
     class NoAttributeProtectionUser < ::ActiveRecord::Base
       self.table_name = :users
-      audited allow_mass_assignment: true
+      audited
     end
 
     class UserWithAfterAudit < ::ActiveRecord::Base
@@ -57,6 +98,11 @@ module Models
       end
     end
 
+    class MaxAuditsUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited max_audits: 5
+    end
+
     class Company < ::ActiveRecord::Base
       audited
     end
@@ -66,6 +112,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/spec/support/active_record/schema.rb

@@ -15,10 +15,10 @@ begin
       db_config[:configure_connection] = false
     end
     adapter = ActiveRecord::Base.send("#{db_type}_connection", db_config)
-    adapter.recreate_database db_name
+    adapter.recreate_database db_name, db_config.slice('charset').symbolize_keys
     adapter.disconnect!
   end
-rescue Exception => e
+rescue => e
   Kernel.warn e
 end
 
@@ -35,11 +35,13 @@ ActiveRecord::Schema.define do
     t.column :username, :string
     t.column :password, :string
     t.column :activated, :boolean
+    t.column :status, :integer, default: 0
     t.column :suspended_at, :datetime
     t.column :logins, :integer, default: 0
     t.column :created_at, :datetime
     t.column :updated_at, :datetime
     t.column :favourite_device, :string
+    t.column :ssn, :integer
   end
 
   create_table :companies do |t|

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.6.0
+  version: 4.10.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -10,10 +10,10 @@ authors:
 - Brian Ryckbost
 - Steve Richert
 - Ryan Glover
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,20 +21,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -55,20 +55,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +97,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: single_cov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -101,30 +129,36 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.20
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Log all changes to your models
 email: info@collectiveidea.com
 executables: []
@@ -132,6 +166,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Appraisals
@@ -140,12 +175,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails40.gemfile
-- gemfiles/rails41.gemfile
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
 - lib/audited-rspec.rb
 - lib/audited.rb
 - lib/audited/audit.rb
@@ -160,6 +195,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
@@ -168,8 +204,11 @@ files:
 - lib/generators/audited/upgrade_generator.rb
 - spec/audited/audit_spec.rb
 - spec/audited/auditor_spec.rb
+- spec/audited/rspec_matchers_spec.rb
 - spec/audited/sweeper_spec.rb
 - spec/audited_spec_helpers.rb
+- spec/rails_app/app/assets/config/manifest.js
+- spec/rails_app/app/controllers/application_controller.rb
 - spec/rails_app/config/application.rb
 - spec/rails_app/config/database.yml
 - spec/rails_app/config/environment.rb
@@ -198,7 +237,7 @@ homepage: https://github.com/collectiveidea/audited
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,16 +245,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Log all changes to your models
 test_files: []