audited 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b04e8c93cc4b6351654924948b663708433e8a01
-  data.tar.gz: ce147cca64fde0e62e06bd7235851a907ec4ccb5
+  metadata.gz: b999065ad92a0fbe08d0739e44dfe966d35ee57f
+  data.tar.gz: 258e418fcfaf0b839c209435dda7ab509c25b52b
 SHA512:
-  metadata.gz: f9fc970bef11b25088cc77123857efad07fb319b84a82696e6f195cce0b9cb1c90cac1a3b0330e57143a61b8a38d9973b13a9618421adeebae030f8f483a9f42
-  data.tar.gz: a7841493a1889185d35c323287d98fd9ca332a91fa18f5d751fcff77508baafb5a2e1a5056eeeb1d6e5fd8efe3d9f13aa407403c85038303642dbd631c7817f9
+  metadata.gz: acb5cb634042722106e7b120791723d879677992628572c830c03d2594e472857127d09714ed6d61cd3aaec635b82e4396441d94a900556e01bc795ad1ed05a1
+  data.tar.gz: 41fff32c9c1b060f040007a038d2840c6e7c43f528dbc9924d3ac1727fee692c10e959bc43bbe2c25882c2cfad9f69b54d8bb21836a3786a1c11928ed10a5770

data/.travis.yml

@@ -4,22 +4,32 @@ rvm:
   - 2.1
   - 2.2.4
   - 2.3.1
+  - 2.4.1
   - ruby-head
 env:
   - DB=SQLITE
   - DB=POSTGRES
   - DB=MYSQL
+addons:
+  postgresql: "9.4"
 gemfile:
   - gemfiles/rails40.gemfile
   - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head
   exclude:
     - rvm: 2.1
       gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails51.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails40.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails41.gemfile
   fast_finish: true
 branches:
   only:

data/Appraisals

@@ -16,7 +16,8 @@ end
 
 appraise 'rails50' do
   gem 'rails', '~> 5.0.0'
+end
 
-  # The following needs to point to Github until the release of 0.1.3
-  gem 'rails-observers', github: 'rails/rails-observers', branch: 'master'
+appraise 'rails51' do
+  gem 'rails', '>= 5.1.0.rc1', '< 5.2'
 end

data/CHANGELOG.md

@@ -0,0 +1,190 @@
+# Audited ChangeLog
+
+## Unreleased
+
+Breaking changes
+
+- None
+
+Added
+
+- None
+
+Changed
+
+- None
+
+Fixed
+
+- None
+
+## 4.4.0 (2017-03-29)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support for `audited_changes` to be a `json` or `jsonb` column in PostgreSQL
+  [#216](https://github.com/collectiveidea/audited/issues/216)
+- Allow `Audited::Audit` to be subclassed by configuring `Audited.audit_class`
+  [#314](https://github.com/collectiveidea/audited/issues/314)
+- Support for Ruby on Rails 5.1
+  [#329](https://github.com/collectiveidea/audited/issues/329)
+- Support for Ruby 2.4
+  [#329](https://github.com/collectiveidea/audited/issues/329)
+
+Changed
+
+- Remove rails-observer dependency
+  [#325](https://github.com/collectiveidea/audited/issues/325)
+- Undeprecated `Audited.audit_class` reader
+  [#314](https://github.com/collectiveidea/audited/issues/314)
+
+Fixed
+
+- SQL error in Rails Conditional GET (304 caching)
+  [#295](https://github.com/collectiveidea/audited/pull/295)
+- Fix missing non_audited_columns= configuration setter
+  [#320](https://github.com/collectiveidea/audited/issues/320)
+- Fix migration generators to specify AR migration version
+  [#329](https://github.com/collectiveidea/audited/issues/329)
+
+## 4.3.0 (2016-09-17)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support singular arguments for options: `on` and `only`
+
+Fixed
+
+- Fix auditing instance attributes if "only" option specified
+- Allow private / protected callback declarations
+- Do not eagerly connect to database
+
+## 4.2.2 (2016-08-01)
+
+- Correct auditing_enabled for STI models
+- Properly set table name for mongomapper
+
+## 4.2.1 (2016-07-29)
+
+- Fix bug when only: is a single field.
+- update gemspec to use mongomapper 0.13
+- sweeper need not run observer for mongomapper
+- Make temporary disabling of auditing threadsafe
+- Centralize `Audited.store` as thread safe variable store
+
+## 4.2.0 (2015-03-31)
+
+Not yet documented.
+
+## 4.0.0 (2014-09-04)
+
+Not yet documented.
+
+## 4.0.0.rc1 (2014-07-30)
+
+Not yet documented.
+
+## 3.0.0 (2012-09-25)
+
+Not yet documented.
+
+## 3.0.0.rc2 (2012-07-09)
+
+Not yet documented.
+
+## 3.0.0.rc1 (2012-04-25)
+
+Not yet documented.
+
+## 2012-04-10
+
+- Add Audit scopes for creates, updates and destroys [chriswfx]
+
+## 2011-10-25
+
+- Made ignored_attributes configurable [senny]
+
+## 2011-09-09
+
+- Rails 3.x support
+- Support for associated audits
+- Support for remote IP address storage
+- Plenty of bug fixes and refactoring
+- [kennethkalmer, ineu, PatrickMa, jrozner, dwarburton, bsiggelkow, dgm]
+
+## 2009-01-27
+
+- Store old and new values for updates, and store all attributes on destroy.
+- Refactored revisioning methods to work as expected
+
+## 2008-10-10
+
+- changed to make it work in development mode
+
+## 2008-09-24
+
+- Add ability to record parent record of the record being audited [Kenneth Kalmer]
+
+## 2008-04-19
+
+- refactored to make compatible with dirty tracking in edge rails
+  and to stop storing both old and new values in a single audit
+
+## 2008-04-18
+
+- Fix NoMethodError when trying to access the :previous revision
+  on a model that doesn't have previous revisions [Alex Soto]
+
+## 2008-03-21
+
+- added #changed_attributes to get access to the changes before a
+  save [Chris Parker]
+
+## 2007-12-16
+
+- Added #revision_at for retrieving a revision from a specific
+  time [Jacob Atzen]
+
+## 2007-12-16
+
+- Fix error when getting revision from audit with no changes
+  [Geoffrey Wiseman]
+
+## 2007-12-16
+
+- Remove dependency on acts_as_list
+
+## 2007-06-17
+
+- Added support getting previous revisions
+
+## 2006-11-17
+
+- Replaced use of singleton User.current_user with cache sweeper
+  implementation for auditing the user that made the change
+
+## 2006-11-17
+
+- added migration generator
+
+## 2006-08-14
+
+- incorporated changes from Michael Schuerig to write_attribute
+  that saves the new value after every change and not just the
+  first, and performs proper type-casting before doing comparisons
+
+## 2006-08-14
+
+- The "changes" are now saved as a serialized hash
+
+## 2006-07-21
+
+- initial version

data/README.md

@@ -3,7 +3,7 @@ Audited [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.svg
 
 **Audited** (previously acts_as_audited) is an ORM extension that logs all changes to your models. Audited can also record who made those changes, save comments and associate models related to the changes.
 
-Audited currently (4.x) works with Rails 5.0 and 4.2. It may work with 4.1 and 4.0, but this is not guaranteed.
+Audited currently (4.x) works with Rails 5.1, 5.0 and 4.2. It may work with 4.1 and 4.0, but this is not guaranteed.
 
 For Rails 3, use gem version 3.0 or see the [3.0-stable branch](https://github.com/collectiveidea/audited/tree/3.0-stable).
 
@@ -14,6 +14,7 @@ Audited supports and is [tested against](http://travis-ci.org/collectiveidea/aud
 * 2.1.5
 * 2.2.4
 * 2.3.1
+* 2.4.1
 
 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).
 
@@ -26,12 +27,7 @@ Audited is currently ActiveRecord-only. In a previous life, Audited worked with
 Add the gem to your Gemfile:
 
 ```ruby
-gem "audited", "~> 4.3"
-```
-
-If you are using rails 5.0, you would also need the following line in your Gemfile.
-```ruby
-gem "rails-observers", github: 'rails/rails-observers'
+gem "audited", "~> 4.4"
 ```
 
 Then, from your Rails app directory, create the `audits` table:
@@ -41,6 +37,8 @@ $ rails generate audited:install
 $ rake db:migrate
 ```
 
+If you're using PostgreSQL, then you can use `rails generate audited:install --audited-changes-column-type jsonb` (or `json`) to store audit changes natively with its JSON column types.
+
 #### Upgrading
 
 If you're already using Audited (or acts_as_audited), your `audits` table may require additional columns. After every upgrade, please run:
@@ -166,7 +164,7 @@ Audited.current_user_method = :authenticated_user
 Outside of a request, Audited can still record the user with the `as_user` method:
 
 ```ruby
-Audited::Audit.as_user(User.find(1)) do
+Audited.audit_class.as_user(User.find(1)) do
   post.update_attribute!(title: "Hello, world!")
 end
 post.audits.last.user # => #<User id: 1>
@@ -217,7 +215,7 @@ class Company < ActiveRecord::Base
 end
 ```
 
-Now, when a audit is created for a user, that user's company is also saved alongside the audit. This makes it much easier (and faster) to access audits indirectly related to a company.
+Now, when an audit is created for a user, that user's company is also saved alongside the audit. This makes it much easier (and faster) to access audits indirectly related to a company.
 
 ```ruby
 company = Company.create!(name: "Collective Idea")
@@ -258,6 +256,26 @@ To disable auditing on an entire model:
 User.auditing_enabled = false
 ```
 
+### Custom `Audit` model
+
+If you want to extend or modify the audit model, create a new class that
+inherits from `Audited::Audit`:
+```ruby
+class CustomAudit < Audited::Audit
+  def some_custom_behavior
+    "Hiya!"
+  end
+end
+```
+Then set it in an initializer:
+```ruby
+# config/initializers/audited.rb
+
+Audited.config do |config|
+  config.audit_class = CustomAudit
+end
+```
+
 ## Gotchas
 
 ### Using attr_protected with Rails 4.x

data/gemfiles/rails50.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
-gem "rails-observers", :github => "rails/rails-observers", :branch => "master"
 
 gemspec :name => "audited", :path => "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", ">= 5.1.0.rc1", "< 5.2"
+
+gemspec :name => "audited", :path => "../"

data/lib/audited.rb

@@ -1,19 +1,20 @@
-require 'rails/observers/active_model/active_model'
 require 'active_record'
 
 module Audited
   class << self
-    attr_accessor :ignored_attributes, :current_user_method
+    attr_accessor :ignored_attributes, :current_user_method, :audit_class
 
-    # Deprecate audit_class accessors in preperation of their removal
     def audit_class
-      Audited::Audit
+      @audit_class || Audit
     end
-    deprecate audit_class: "Audited.audit_class is now always Audited::Audit. This method will be removed."
 
     def store
       Thread.current[:audited_store] ||= {}
     end
+
+    def config
+      yield(self)
+    end
   end
 
   @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on)

data/lib/audited/audit.rb

@@ -6,25 +6,44 @@ module Audited
   # * <tt>auditable</tt>: the ActiveRecord model that was changed
   # * <tt>user</tt>: the user that performed the change; a string or an ActiveRecord model
   # * <tt>action</tt>: one of create, update, or delete
-  # * <tt>audited_changes</tt>: a serialized hash of all the changes
+  # * <tt>audited_changes</tt>: a hash of all the changes
   # * <tt>comment</tt>: a comment set with the audit
   # * <tt>version</tt>: the version of the model
   # * <tt>request_uuid</tt>: a uuid based that allows audits from the same controller request
   # * <tt>created_at</tt>: Time that the change was performed
   #
-  class Audit < ::ActiveRecord::Base
-    include ActiveModel::Observing
 
+  class YAMLIfTextColumnType
+    class << self
+      def load(obj)
+        if Audited.audit_class.columns_hash["audited_changes"].sql_type == "text"
+          ActiveRecord::Coders::YAMLColumn.new(Object).load(obj)
+        else
+          obj
+        end
+      end
+
+      def dump(obj)
+        if Audited.audit_class.columns_hash["audited_changes"].sql_type == "text"
+          ActiveRecord::Coders::YAMLColumn.new(Object).dump(obj)
+        else
+          obj
+        end
+      end
+    end
+  end
+
+  class Audit < ::ActiveRecord::Base
     belongs_to :auditable,  polymorphic: true
     belongs_to :user,       polymorphic: true
     belongs_to :associated, polymorphic: true
 
-    before_create :set_version_number, :set_audit_user, :set_request_uuid
+    before_create :set_version_number, :set_audit_user, :set_request_uuid, :set_remote_address
 
     cattr_accessor :audited_class_names
     self.audited_class_names = Set.new
 
-    serialize :audited_changes
+    serialize :audited_changes, YAMLIfTextColumnType
 
     scope :ascending,     ->{ reorder(version: :asc) }
     scope :descending,    ->{ reorder(version: :desc)}
@@ -95,10 +114,10 @@ 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)
-      Thread.current[:audited_user] = user
+      ::Audited.store[:audited_user] = user
       yield
     ensure
-      Thread.current[:audited_user] = nil
+      ::Audited.store[:audited_user] = nil
     end
 
     # @private
@@ -125,6 +144,11 @@ module Audited
       record
     end
 
+    # use created_at as timestamp cache key
+    def self.collection_cache_key(collection = all, timestamp_column = :created_at)
+      super(collection, :created_at)
+    end
+
     private
 
     def set_version_number
@@ -133,12 +157,18 @@ module Audited
     end
 
     def set_audit_user
-      self.user = Thread.current[:audited_user] if Thread.current[:audited_user]
+      self.user ||= ::Audited.store[:audited_user] # from .as_user
+      self.user ||= ::Audited.store[:current_user] # from Sweeper
       nil # prevent stopping callback chains
     end
 
     def set_request_uuid
+      self.request_uuid ||= ::Audited.store[:current_request_uuid]
       self.request_uuid ||= SecureRandom.uuid
     end
+
+    def set_remote_address
+      self.remote_address ||= ::Audited.store[:current_remote_address]
+    end
   end
 end

data/lib/audited/auditor.rb

@@ -51,8 +51,8 @@ module Audited
 
         attr_accessor :audit_comment
 
-        has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: Audit.name
-        Audit.audited_class_names << to_s
+        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)
@@ -75,7 +75,7 @@ module Audited
       end
 
       def has_associated_audits
-        has_many :associated_audits, as: :associated, class_name: Audit.name
+        has_many :associated_audits, as: :associated, class_name: Audited.audit_class.name
       end
 
       def default_ignored_attributes
@@ -118,13 +118,13 @@ module Audited
 
       # Get a specific revision specified by the version number, or +:previous+
       def revision(version)
-        revision_with Audit.reconstruct_attributes(audits_to(version))
+        revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
       end
 
       # Find the oldest revision recorded prior to the date/time provided.
       def revision_at(date_or_time)
         audits = self.audits.up_until(date_or_time)
-        revision_with Audit.reconstruct_attributes(audits) unless audits.empty?
+        revision_with Audited.audit_class.reconstruct_attributes(audits) unless audits.empty?
       end
 
       # List of attributes that are audited.
@@ -152,7 +152,7 @@ module Audited
           revision.send :instance_variable_set, '@destroyed', false
           revision.send :instance_variable_set, '@_destroyed', false
           revision.send :instance_variable_set, '@marked_for_destruction', false
-          Audit.assign_revision_attributes(revision, attributes)
+          Audited.audit_class.assign_revision_attributes(revision, attributes)
 
           # Remove any association proxies so that they will be recreated
           # and reference the correct object for this revision. The only way
@@ -267,6 +267,10 @@ module Audited
         end
       end
 
+      def non_audited_columns=(columns)
+        @non_audited_columns = columns
+      end
+
       # Executes the block with auditing disabled.
       #
       #   Foo.without_auditing do
@@ -294,7 +298,7 @@ module Audited
       # convenience wrapper around
       # @see Audit#as_user.
       def audit_as(user, &block)
-        Audit.as_user(user, &block)
+        Audited.audit_class.as_user(user, &block)
       end
 
       def auditing_enabled

data/lib/audited/rspec_matchers.rb

@@ -170,7 +170,7 @@ module Audited
       def association_exists?
         !reflection.nil? &&
           reflection.macro == :has_many &&
-          reflection.options[:class_name] == Audit.name
+          reflection.options[:class_name] == Audited.audit_class.name
       end
     end
   end

data/lib/audited/sweeper.rb

@@ -1,60 +1,49 @@
-require "rails/observers/activerecord/active_record"
-require "rails/observers/action_controller/caching"
-
 module Audited
-  class Sweeper < ActionController::Caching::Sweeper
-    observe Audited::Audit
+  class Sweeper
+    STORED_DATA = {
+      current_remote_address: :remote_ip,
+      current_request_uuid: :request_uuid,
+      current_user: :current_user
+    }
+
+    delegate :store, to: ::Audited
 
     def around(controller)
       self.controller = controller
+      STORED_DATA.each { |k,m| store[k] = send(m) }
       yield
     ensure
       self.controller = nil
-    end
-
-    def before_create(audit)
-      audit.user ||= current_user
-      audit.remote_address = controller.try(:request).try(:remote_ip)
-      audit.request_uuid = request_uuid if request_uuid
+      STORED_DATA.keys.each { |k| store.delete(k) }
     end
 
     def current_user
       controller.send(Audited.current_user_method) if controller.respond_to?(Audited.current_user_method, true)
     end
 
-    def request_uuid
-      controller.try(:request).try(:uuid)
-    end
-
-    def add_observer!(klass)
-      super
-      define_callback(klass)
+    def remote_ip
+      controller.try(:request).try(:remote_ip)
     end
 
-    def define_callback(klass)
-      observer = self
-      callback_meth = :_notify_audited_sweeper
-      klass.send(:define_method, callback_meth) do
-        observer.update(:before_create, self)
-      end
-      klass.send(:before_create, callback_meth)
+    def request_uuid
+      controller.try(:request).try(:uuid)
     end
 
     def controller
-      ::Audited.store[:current_controller]
+      store[:current_controller]
     end
 
     def controller=(value)
-      ::Audited.store[:current_controller] = value
+      store[:current_controller] = value
     end
   end
 end
 
 ActiveSupport.on_load(:action_controller) do
   if defined?(ActionController::Base)
-    ActionController::Base.around_action Audited::Sweeper.instance
+    ActionController::Base.around_action Audited::Sweeper.new
   end
   if defined?(ActionController::API)
-    ActionController::API.around_action Audited::Sweeper.instance
+    ActionController::API.around_action Audited::Sweeper.new
   end
 end

data/lib/audited/version.rb

@@ -1,3 +1,3 @@
 module Audited
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end

data/lib/generators/audited/install_generator.rb

@@ -3,13 +3,17 @@ 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 InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
+      include Audited::Generators::MigrationHelper
       extend Audited::Generators::Migration
 
+      class_option :audited_changes_column_type, type: :string, default: "text", required: false
+
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_migration

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :association_id, :integer
     add_column :audits, :association_type, :string

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :comment, :string
   end

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :remote_address, :string
   end

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     add_column :audits, :request_uuid, :string
     add_index :audits, :request_uuid

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     create_table :audits, :force => true do |t|
       t.column :auditable_id, :integer
@@ -9,7 +9,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.column :user_type, :string
       t.column :username, :string
       t.column :action, :string
-      t.column :audited_changes, :text
+      t.column :audited_changes, :<%= options[:audited_changes_column_type] %>
       t.column :version, :integer, :default => 0
       t.column :comment, :string
       t.column :remote_address, :string

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+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'

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+class <%= migration_class_name %> < <%= migration_parent %>
   def self.up
     rename_column :audits, :changes, :audited_changes
   end

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

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
+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

data/lib/generators/audited/upgrade_generator.rb

@@ -3,11 +3,13 @@ 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__)

data/spec/audited/audit_spec.rb

@@ -3,6 +3,54 @@ 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
@@ -191,9 +239,8 @@ describe Audited::Audit do
           raise StandardError.new('expected')
         end
       }.to raise_exception('expected')
-      expect(Thread.current[:audited_user]).to be_nil
+      expect(Audited.store[:audited_user]).to be_nil
     end
 
   end
-
 end

data/spec/audited/auditor_spec.rb

@@ -17,7 +17,7 @@ describe Audited::Auditor do
       end
     end
 
-    it "should be configurable which attributes are not audited" do
+    it "should be configurable which attributes are not audited via ignored_attributes" do
       Audited.ignored_attributes = ['delta', 'top_secret', 'created_at']
       class Secret < ::ActiveRecord::Base
         audited
@@ -26,6 +26,15 @@ describe Audited::Auditor do
       expect(Secret.non_audited_columns).to include('delta', 'top_secret', 'created_at')
     end
 
+    it "should be configurable which attributes are not audited via non_audited_columns=" do
+      class Secret2 < ::ActiveRecord::Base
+        audited
+        self.non_audited_columns = ['delta', 'top_secret', 'created_at']
+      end
+
+      expect(Secret2.non_audited_columns).to include('delta', 'top_secret', 'created_at')
+    end
+
     it "should not save non-audited columns" do
       expect(create_user.audits.first.audited_changes.keys.any? { |col| ['created_at', 'updated_at', 'password'].include?( col ) }).to eq(false)
     end
@@ -48,6 +57,38 @@ describe Audited::Auditor do
       user.save!
       expect(user.audits.last.audited_changes.keys).to eq(%w{password})
     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") }
+
+        after do
+          ActiveRecord::Migrator.rollback([migrations_path])
+        end
+
+        it "should work if column type is 'json'" do
+          ActiveRecord::Migrator.up([migrations_path], 1)
+          Audited::Audit.reset_column_information
+          expect(Audited::Audit.columns_hash["audited_changes"].sql_type).to eq("json")
+
+          user = Models::ActiveRecord::User.create
+          user.name = "new name"
+          user.save!
+          expect(user.audits.last.audited_changes).to eq({"name" => [nil, "new name"]})
+        end
+
+        it "should work if column type is 'jsonb'" do
+          ActiveRecord::Migrator.up([migrations_path], 2)
+          Audited::Audit.reset_column_information
+          expect(Audited::Audit.columns_hash["audited_changes"].sql_type).to eq("jsonb")
+
+          user = Models::ActiveRecord::User.create
+          user.name = "new name"
+          user.save!
+          expect(user.audits.last.audited_changes).to eq({"name" => [nil, "new name"]})
+        end
+      end
+    end
   end
 
   describe :new do
@@ -601,7 +642,7 @@ describe Audited::Auditor do
         Models::ActiveRecord::Company.auditing_enabled = false
         company.update_attributes name: 'STI auditors'
         Models::ActiveRecord::Company.auditing_enabled = true
-      }.to_not change( Audited.audit_class, :count )
+      }.to_not change( Audited::Audit, :count )
     end
   end
 end

data/spec/audited/sweeper_spec.rb

@@ -76,7 +76,7 @@ describe AuditsController do
       controller.send(:current_user=, user)
 
       expect {
-        put :update, id: 123
+        put :update, Rails::VERSION::MAJOR == 4 ? {id: 123} : {params: {id: 123}}
       }.to_not change( Audited::Audit, :count )
     end
   end
@@ -86,21 +86,23 @@ end
 describe Audited::Sweeper do
 
   it "should be thread-safe" do
+    instance = Audited::Sweeper.new
+
     t1 = Thread.new do
       sleep 0.5
-      Audited::Sweeper.instance.controller = 'thread1 controller instance'
-      expect(Audited::Sweeper.instance.controller).to eq('thread1 controller instance')
+      instance.controller = 'thread1 controller instance'
+      expect(instance.controller).to eq('thread1 controller instance')
     end
 
     t2 = Thread.new do
-      Audited::Sweeper.instance.controller = 'thread2 controller instance'
+      instance.controller = 'thread2 controller instance'
       sleep 1
-      expect(Audited::Sweeper.instance.controller).to eq('thread2 controller instance')
+      expect(instance.controller).to eq('thread2 controller instance')
     end
 
     t1.join; t2.join
 
-    expect(Audited::Sweeper.instance.controller).to be_nil
+    expect(instance.controller).to be_nil
   end
 
 end

data/spec/support/active_record/models.rb

@@ -15,6 +15,7 @@ module Models
 
     class UserOnlyPassword < ::ActiveRecord::Base
       self.table_name = :users
+      attribute :non_column_attr if Rails.version >= '5.1'
       audited allow_mass_assignment: true, only: :password
     end
 

data/spec/support/active_record/postgres/1_change_audited_changes_type_to_json.rb

@@ -0,0 +1,12 @@
+parent = Rails::VERSION::MAJOR == 4 ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+class ChangeAuditedChangesTypeToJson < parent
+  def self.up
+    remove_column :audits, :audited_changes
+    add_column :audits, :audited_changes, :json
+  end
+
+  def self.down
+    remove_column :audits, :audited_changes
+    add_column :audits, :audited_changes, :text
+  end
+end

data/spec/support/active_record/postgres/2_change_audited_changes_type_to_jsonb.rb

@@ -0,0 +1,12 @@
+parent = Rails::VERSION::MAJOR == 4 ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+class ChangeAuditedChangesTypeToJsonb < parent
+  def self.up
+    remove_column :audits, :audited_changes
+    add_column :audits, :audited_changes, :jsonb
+  end
+
+  def self.down
+    remove_column :audits, :audited_changes
+    add_column :audits, :audited_changes, :text
+  end
+end

data/test/install_generator_test.rb

@@ -7,11 +7,39 @@ class InstallGeneratorTest < Rails::Generators::TestCase
   setup :prepare_destination
   tests Audited::Generators::InstallGenerator
 
-  test "should generate a migration" do
-    run_generator %w(install)
+  test "generate migration with 'text' type for audited_changes column" do
+    run_generator
 
     assert_migration "db/migrate/install_audited.rb" do |content|
-      assert_match(/class InstallAudited/, content)
+      assert_includes(content, 'class InstallAudited')
+      assert_includes(content, 't.column :audited_changes, :text')
+    end
+  end
+
+  test "generate migration with 'jsonb' type for audited_changes column" do
+    run_generator %w(--audited-changes-column-type jsonb)
+
+    assert_migration "db/migrate/install_audited.rb" do |content|
+      assert_includes(content, 'class InstallAudited')
+      assert_includes(content, 't.column :audited_changes, :jsonb')
+    end
+  end
+
+  test "generate migration with 'json' type for audited_changes column" do
+    run_generator %w(--audited-changes-column-type json)
+
+    assert_migration "db/migrate/install_audited.rb" do |content|
+      assert_includes(content, 'class InstallAudited')
+      assert_includes(content, 't.column :audited_changes, :json')
+    end
+  end
+
+  test "generate migration with correct AR migration parent" do
+    run_generator
+
+    assert_migration "db/migrate/install_audited.rb" do |content|
+      parent = Rails::VERSION::MAJOR == 4 ? 'ActiveRecord::Migration' : "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      assert_includes(content, "class InstallAudited < #{parent}\n")
     end
   end
 end

data/test/upgrade_generator_test.rb

@@ -6,7 +6,11 @@ class UpgradeGeneratorTest < Rails::Generators::TestCase
   destination File.expand_path('../../tmp', __FILE__)
   setup :prepare_destination
   tests Audited::Generators::UpgradeGenerator
-  self.use_transactional_fixtures = false
+  if Rails::VERSION::MAJOR == 4
+    self.use_transactional_fixtures = false
+  else
+    self.use_transactional_tests = false
+  end
 
   test "should add 'comment' to audits table" do
     load_schema 1
@@ -74,4 +78,15 @@ class UpgradeGeneratorTest < Rails::Generators::TestCase
       assert_match(/add_index :audits, :request_uuid/, content)
     end
   end
+
+  test "generate migration with correct AR migration parent" do
+    load_schema 1
+
+    run_generator %w(upgrade)
+
+    assert_migration "db/migrate/add_comment_to_audits.rb" do |content|
+      parent = Rails::VERSION::MAJOR == 4 ? 'ActiveRecord::Migration' : "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      assert_includes(content, "class AddCommentToAudits < #{parent}\n")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-17 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -35,20 +35,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: rails-observers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +135,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - Appraisals
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -158,6 +144,7 @@ files:
 - gemfiles/rails41.gemfile
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
 - lib/audited-rspec.rb
 - lib/audited.rb
 - lib/audited/audit.rb
@@ -167,6 +154,7 @@ files:
 - lib/audited/version.rb
 - lib/generators/audited/install_generator.rb
 - lib/generators/audited/migration.rb
+- lib/generators/audited/migration_helper.rb
 - lib/generators/audited/templates/add_association_to_audits.rb
 - lib/generators/audited/templates/add_comment_to_audits.rb
 - lib/generators/audited/templates/add_remote_address_to_audits.rb
@@ -192,6 +180,8 @@ files:
 - spec/rails_app/config/routes.rb
 - spec/spec_helper.rb
 - spec/support/active_record/models.rb
+- spec/support/active_record/postgres/1_change_audited_changes_type_to_json.rb
+- spec/support/active_record/postgres/2_change_audited_changes_type_to_jsonb.rb
 - spec/support/active_record/schema.rb
 - test/db/version_1.rb
 - test/db/version_2.rb

data/CHANGELOG

@@ -1,34 +0,0 @@
-Audited ChangeLog
--------------------------------------------------------------------------------
-* 2012-04-10 - Add Audit scopes for creates, updates and destroys [chriswfx]
-* 2011-10-25 - Made ignored_attributes configurable [senny]
-* 2011-09-09 - Rails 3.x support
-               Support for associated audits
-               Support for remote IP address storage
-               Plenty of bug fixes and refactoring
-               [kennethkalmer, ineu, PatrickMa, jrozner, dwarburton, bsiggelkow, dgm]
-* 2009-01-27 - Store old and new values for updates, and store all attributes on destroy.
-               Refactored revisioning methods to work as expected
-* 2008-10-10 - changed to make it work in development mode
-* 2008-09-24 - Add ability to record parent record of the record being audited
-               [Kenneth Kalmer]
-* 2008-04-19 - refactored to make compatible with dirty tracking in edge rails
-               and to stop storing both old and new values in a single audit
-* 2008-04-18 - Fix NoMethodError when trying to access the :previous revision
-               on a model that doesn't have previous revisions [Alex Soto]
-* 2008-03-21 - added #changed_attributes to get access to the changes before a
-               save [Chris Parker]
-* 2007-12-16 - Added #revision_at for retrieving a revision from a specific
-               time [Jacob Atzen]
-* 2007-12-16 - Fix error when getting revision from audit with no changes
-               [Geoffrey Wiseman]
-* 2007-12-16 - Remove dependency on acts_as_list
-* 2007-06-17 - Added support getting previous revisions
-* 2006-11-17 - Replaced use of singleton User.current_user with cache sweeper
-               implementation for auditing the user that made the change
-* 2006-11-17 - added migration generator
-* 2006-08-14 - incorporated changes from Michael Schuerig to write_attribute
-               that saves the new value after every change and not just the
-               first, and performs proper type-casting before doing comparisons
-* 2006-08-14 - The "changes" are now saved as a serialized hash
-* 2006-07-21 - initial version