audited 4.4.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434d39dd10ca63069df2c4e65405957c0e54a9f7
-  data.tar.gz: d37dfb095ff87cb661b16c9f87d5fb4c3f4485db
+  metadata.gz: 4e4cd2ba4231df555461162a9ab0b41db0952828
+  data.tar.gz: c3bed2498a2c13bb5f3e7c27367114ca200cc3c8
 SHA512:
-  metadata.gz: 8a9265e62d4bed636d199a933237c04b5cfb2c5c66d258e907ee6d916235d89f3e12773422308ea778dc4c0c9fde46bd898b84abbd2b4b9fd329a9df9b4d8695
-  data.tar.gz: 28175be667b62bac2db50fe0bb5abde722dca710186e34ac92ffa1cba32bf44a428b69a8bf69f6811ab6f68bf211076a081b03dc842cc18803c13d4f688677e8
+  metadata.gz: 1249f2af82d7c2633ab5b9d40dfa598c4c4ce6f21d9a817ab1bc82791521a01bf6e95a43b1e1627b65cc1fb5558860acac964acee1ec9f72b85958d13cd2ebf1
+  data.tar.gz: 5c33514373b367cd52042e471b79f46adbd72c8ce7f759948d2e087a525833c985cd5a601d37319997f201fcb6a5c4ff6b3bd64ce2a1deca294ba5d80833ef21

data/CHANGELOG.md

@@ -18,6 +18,26 @@ Fixed
 
 - None
 
+## 4.5.0 (2017-05-22)
+
+Breaking changes
+
+- None
+
+Added
+
+- Support for `user_id` column to be a `uuid` type
+  [#333](https://github.com/collectiveidea/audited/pull/333)
+
+Fixed
+
+- Fix retrieval of user from controller when populated in before callbacks
+  [#336](https://github.com/collectiveidea/audited/issues/336)
+- Fix column type check in serializer for Oracle DB adapter
+  [#335](https://github.com/collectiveidea/audited/pull/335)
+- Fix `non_audited_columns` to allow symbol names
+  [#351](https://github.com/collectiveidea/audited/pull/351)
+
 ## 4.4.1 (2017-03-29)
 
 Fixed

data/README.md

@@ -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.4"
+gem "audited", "~> 4.5"
 ```
 
 Then, from your Rails app directory, create the `audits` table:
@@ -37,7 +37,7 @@ $ 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.
+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. If you're using something other than integer primary keys (e.g. UUID) for your User model, then you can use `rails generate audited:install --audited-user-id-column-type uuid` to customize the `audits` table `user_id` column type.
 
 #### Upgrading
 
@@ -170,6 +170,8 @@ end
 post.audits.last.user # => #<User id: 1>
 ```
 
+The standard Audited install assumes your User model has an integer primary key type. If this isn't true (e.g. you're using UUID primary keys), you'll need to create a migration to update the `audits` table `user_id` column type. (See Installation above for generator flags if you'd like to regenerate the install migration.)
+
 #### Custom Auditor
 
 You might need to use a custom auditor from time to time. It can be done by simply passing in a string:

data/lib/audited/audit.rb

@@ -16,7 +16,7 @@ module Audited
   class YAMLIfTextColumnType
     class << self
       def load(obj)
-        if Audited.audit_class.columns_hash["audited_changes"].sql_type == "text"
+        if Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
           ActiveRecord::Coders::YAMLColumn.new(Object).load(obj)
         else
           obj
@@ -24,7 +24,7 @@ module Audited
       end
 
       def dump(obj)
-        if Audited.audit_class.columns_hash["audited_changes"].sql_type == "text"
+        if Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
           ActiveRecord::Coders::YAMLColumn.new(Object).dump(obj)
         else
           obj
@@ -158,7 +158,7 @@ module Audited
 
     def set_audit_user
       self.user ||= ::Audited.store[:audited_user] # from .as_user
-      self.user ||= ::Audited.store[:current_user] # from Sweeper
+      self.user ||= ::Audited.store[:current_user].try!(:call) # from Sweeper
       nil # prevent stopping callback chains
     end
 

data/lib/audited/auditor.rb

@@ -129,7 +129,7 @@ module Audited
 
       # List of attributes that are audited.
       def audited_attributes
-        attributes.except(*non_audited_columns)
+        attributes.except(*non_audited_columns.map(&:to_s))
       end
 
       def non_audited_columns
@@ -251,7 +251,7 @@ module Audited
     module AuditedClassMethods
       # Returns an array of columns that are audited. See non_audited_columns
       def audited_columns
-        columns.select {|c| !non_audited_columns.include?(c.name) }
+        columns.reject { |c| non_audited_columns.map(&:to_s).include?(c.name) }
       end
 
       def non_audited_columns

data/lib/audited/sweeper.rb

@@ -18,7 +18,7 @@ module Audited
     end
 
     def current_user
-      controller.send(Audited.current_user_method) if controller.respond_to?(Audited.current_user_method, true)
+      lambda { controller.send(Audited.current_user_method) if controller.respond_to?(Audited.current_user_method, true) }
     end
 
     def remote_ip

data/lib/audited/version.rb

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

data/lib/generators/audited/install_generator.rb

@@ -13,6 +13,7 @@ module Audited
       extend Audited::Generators::Migration
 
       class_option :audited_changes_column_type, type: :string, default: "text", required: false
+      class_option :audited_user_id_column_type, type: :string, default: "integer", required: false
 
       source_root File.expand_path("../templates", __FILE__)
 

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

@@ -5,7 +5,7 @@ class <%= migration_class_name %> < <%= migration_parent %>
       t.column :auditable_type, :string
       t.column :associated_id, :integer
       t.column :associated_type, :string
-      t.column :user_id, :integer
+      t.column :user_id, :<%= options[:audited_user_id_column_type] %>
       t.column :user_type, :string
       t.column :username, :string
       t.column :action, :string

data/spec/audited/auditor_spec.rb

@@ -36,7 +36,9 @@ describe Audited::Auditor do
     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)
+      Models::ActiveRecord::User.non_audited_columns = (Models::ActiveRecord::User.non_audited_columns << :favourite_device)
+
+      expect(create_user.audits.first.audited_changes.keys.any? { |col| ['favourite_device', 'created_at', 'updated_at', 'password'].include?( col ) }).to eq(false)
     end
 
     it "should not save other columns than specified in 'only' option" do

data/spec/audited/sweeper_spec.rb

@@ -1,6 +1,8 @@
 require "spec_helper"
 
 class AuditsController < ActionController::Base
+  before_action :populate_user
+
   attr_reader :company
 
   def create
@@ -17,6 +19,8 @@ class AuditsController < ActionController::Base
 
   attr_accessor :current_user
   attr_accessor :custom_user
+
+  def populate_user; end
 end
 
 describe AuditsController do
@@ -69,6 +73,18 @@ describe AuditsController do
       expect(controller.company.audits.last.request_uuid).to eq("abc123")
     end
 
+    it "should call current_user after controller callbacks" do
+      expect(controller).to receive(:populate_user) do
+        controller.send(:current_user=, user)
+      end
+
+      expect {
+        post :create
+      }.to change( Audited::Audit, :count )
+
+      expect(controller.company.audits.last.user).to eq(user)
+    end
+
   end
 
   describe "PUT update" do

data/spec/audited_spec_helpers.rb

@@ -1,7 +1,7 @@
 module AuditedSpecHelpers
 
   def create_user(attrs = {})
-    Models::ActiveRecord::User.create({name: 'Brandon', username: 'brandon', password: 'password'}.merge(attrs))
+    Models::ActiveRecord::User.create({name: 'Brandon', username: 'brandon', password: 'password', favourite_device: 'Android Phone'}.merge(attrs))
   end
 
   def build_user(attrs = {})

data/spec/support/active_record/schema.rb

@@ -39,6 +39,7 @@ ActiveRecord::Schema.define do
     t.column :logins, :integer, default: 0
     t.column :created_at, :datetime
     t.column :updated_at, :datetime
+    t.column :favourite_device, :string
   end
 
   create_table :companies do |t|

data/test/install_generator_test.rb

@@ -34,6 +34,24 @@ class InstallGeneratorTest < Rails::Generators::TestCase
     end
   end
 
+  test "generate migration with 'string' type for user_id column" do
+    run_generator %w(--audited-user-id-column-type string)
+
+    assert_migration "db/migrate/install_audited.rb" do |content|
+      assert_includes(content, 'class InstallAudited')
+      assert_includes(content, 't.column :user_id, :string')
+    end
+  end
+
+  test "generate migration with 'uuid' type for user_id column" do
+    run_generator %w(--audited-user-id-column-type uuid)
+
+    assert_migration "db/migrate/install_audited.rb" do |content|
+      assert_includes(content, 'class InstallAudited')
+      assert_includes(content, 't.column :user_id, :uuid')
+    end
+  end
+
   test "generate migration with correct AR migration parent" do
     run_generator
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Brandon Keepers
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord