velocity_audited 5.1.4 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442ee1a7c413fc26e6ddd02cfb1d1201fb5034cb19f54f5607d5ed0f04328012
-  data.tar.gz: 456faa3bd554bcd65ef6277caf785f283456d3683e54d70067ec75380f618bff
+  metadata.gz: 7b39436e9380cd8f81939d01bd864c669d65bb033ef97d7c265165160e52809c
+  data.tar.gz: 761804b094627fcb2b13e991ec8eb66288f1761d3d9ba4b134811d3ed399b3b8
 SHA512:
-  metadata.gz: bcb4961726f31f2af54ab96f3501fdc5cc1406c257c9eeb8d985d99e37f60c19112dbd366e46793b29589dd07900be3e16caf23da71f8f330f53cc4ab79c0b05
-  data.tar.gz: b099ebb6947568e53c37799057f2e39794a13674e5ef712b4c31e6c30a1727fe7c64db7ad25135e9068daa29fd97ec4215c8a0c0673785829964710d36ad58b3
+  metadata.gz: ebd15ee11f7c91d2beb3c61db75d6a6c8a3795c8615423d9c9ad9ed9294d321ad5439427adba2a45238318d4e79fa1183a5401250d62ed945b36ee25f03091b6
+  data.tar.gz: 0621c54999850e9a6cd4cbe12642cc1e99ea0e367119aba2a503009f290ea5cc99374dab67d34e2e8c9007a4f51ee660c5429c6607ecc3917fa5bb3260f16bdf

data/README.md

@@ -42,10 +42,10 @@ gem "audited", "~> 5.0"
 And if you're using ```require: false``` you must add initializers like this:
 
 ```ruby
-#./config/initializers/audited.rb
-require "audited"
+#./config/initializers/velocity_audited.rb
+require "velocity_audited"
 
-Audited::Railtie.initializers.each(&:run)
+VelocityAudited::Railtie.initializers.each(&:run)
 ```
 
 Then, from your Rails app directory, create the `audits` table:
@@ -174,7 +174,7 @@ end
 You can limit the number of audits stored for your model. To configure limiting for all audited models, put the following in an initializer file (`config/initializers/audited.rb`):
 
 ```ruby
-Audited.max_audits = 10 # keep only 10 latest audits
+VelocityAudited.max_audits = 10 # keep only 10 latest audits
 ```
 
 or customize per model:
@@ -213,13 +213,13 @@ end
 To use a method other than `current_user`, put the following in an initializer file (`config/initializers/audited.rb`):
 
 ```ruby
-Audited.current_user_method = :authenticated_user
+VelocityAudited.current_user_method = :authenticated_user
 ```
 
 Outside of a request, Audited can still record the user with the `as_user` method:
 
 ```ruby
-Audited.audit_class.as_user(User.find(1)) do
+VelocityAudited.audit_class.as_user(User.find(1)) do
   post.update!(title: "Hello, world!")
 end
 post.audits.last.user # => #<User id: 1>
@@ -246,7 +246,7 @@ end
 `as_user` also accepts a string, which can be useful for auditing updates made in a CLI environment:
 
 ```rb
-Audited.audit_class.as_user("console-user-#{ENV['SSH_USER']}") do
+VelocityAudited.audit_class.as_user("console-user-#{ENV['SSH_USER']}") do
   post.update_attributes!(title: "Hello, world!")
 end
 post.audits.last.user # => 'console-user-username'
@@ -255,11 +255,11 @@ post.audits.last.user # => 'console-user-username'
 If you want to set a specific user as the auditor of the commands in a CLI environment, whether that is a string or an ActiveRecord object, you can use the following command:
 
 ```rb
-Audited.store[:audited_user] = "username"
+VelocityAudited.store[:audited_user] = "username"
 
 # or
 
-Audited.store[:audited_user] = User.find(1)
+VelocityAudited.store[:audited_user] = User.find(1)
 ```
 
 ### Associated Audits
@@ -366,7 +366,7 @@ User.auditing_enabled = false
 To disable auditing on all models:
 
 ```ruby
-Audited.auditing_enabled = false
+VelocityAudited.auditing_enabled = false
 ```
 
 If you have auditing disabled by default on your model you can enable auditing
@@ -390,18 +390,20 @@ end
 
 If you want to extend or modify the audit model, create a new class that
 inherits from `Audited::Audit`:
+
 ```ruby
-class CustomAudit < Audited::Audit
+class CustomAudit < VelocityAudited::Audit
   def some_custom_behavior
     "Hiya!"
   end
 end
 ```
 Then set it in an initializer:
+
 ```ruby
-# config/initializers/audited.rb
+# config/initializers/velocity_audited.rb
 
-Audited.config do |config|
+VelocityAudited.config do |config|
   config.audit_class = CustomAudit
 end
 ```
@@ -411,9 +413,9 @@ end
 In 4.10, the default behavior for enums changed from storing the value synthesized by Rails to the value stored in the DB. You can restore the previous behavior by setting the store_synthesized_enums configuration value:
 
 ```ruby
-# config/initializers/audited.rb
+# config/initializers/velocity_audited.rb
 
-Audited.store_synthesized_enums = true
+VelocityAudited.store_synthesized_enums = true
 ```
 
 ## Support

data/lib/audited/audit.rb

@@ -2,7 +2,7 @@
 
 require "set"
 
-module Audited
+module VelocityAudited
   # Audit saves the changes to ActiveRecord models.  It has the following attributes:
   #
   # * <tt>auditable</tt>: the ActiveRecord model that was changed
@@ -34,7 +34,7 @@ module Audited
       end
 
       def text_column?
-        Audited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
+        VelocityAudited.audit_class.columns_hash["audited_changes"].type.to_s == "text"
       end
     end
   end
@@ -134,11 +134,11 @@ module Audited
     # by +user+. This method is hopefully threadsafe, making it ideal
     # for background operations that require audit information.
     def self.as_user(user)
-      last_audited_user = ::Audited.store[:audited_user]
-      ::Audited.store[:audited_user] = user
+      last_audited_user = ::VelocityAudited.store[:audited_user]
+      ::VelocityAudited.store[:audited_user] = user
       yield
     ensure
-      ::Audited.store[:audited_user] = last_audited_user
+      ::VelocityAudited.store[:audited_user] = last_audited_user
     end
 
     # @private
@@ -181,18 +181,18 @@ module Audited
     end
 
     def set_audit_user
-      self.user ||= ::Audited.store[:audited_user] # from .as_user
-      self.user ||= ::Audited.store[:current_user].try!(:call) # from Sweeper
+      self.user ||= ::VelocityAudited.store[:audited_user] # from .as_user
+      self.user ||= ::VelocityAudited.store[:current_user].try!(:call) # from Sweeper
       nil # prevent stopping callback chains
     end
 
     def set_request_uuid
-      self.request_uuid ||= ::Audited.store[:current_request_uuid]
+      self.request_uuid ||= ::VelocityAudited.store[:current_request_uuid]
       self.request_uuid ||= SecureRandom.uuid
     end
 
     def set_remote_address
-      self.remote_address ||= ::Audited.store[:current_remote_address]
+      self.remote_address ||= ::VelocityAudited.store[:current_remote_address]
     end
   end
 end

data/lib/audited/auditor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Audited
+module VelocityAudited
   # Specify this act if you want changes to your model to be saved in an
   # audit table.  This assumes there is an audits table ready.
   #
@@ -60,10 +60,10 @@ module Audited
       #
       def audited(options = {})
         # don't allow multiple calls
-        return if included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
+        return if included_modules.include?(VelocityAudited::Auditor::AuditedInstanceMethods)
 
-        extend Audited::Auditor::AuditedClassMethods
-        include Audited::Auditor::AuditedInstanceMethods
+        extend VelocityAudited::Auditor::AuditedClassMethods
+        include VelocityAudited::Auditor::AuditedInstanceMethods
 
         class_attribute :audit_associated_with, instance_writer: false
         class_attribute :audited_options, instance_writer: false
@@ -79,8 +79,8 @@ module Audited
           before_destroy :require_comment if audited_options[:on].include?(:destroy)
         end
 
-        has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: Audited.audit_class.name, inverse_of: :auditable
-        Audited.audit_class.audited_class_names << to_s
+        has_many :audits, -> { order(version: :asc) }, as: :auditable, class_name: VelocityAudited.audit_class.name, inverse_of: :auditable
+        VelocityAudited.audit_class.audited_class_names << to_s
 
         after_create :audit_create if audited_options[:on].include?(:create)
         before_update :audit_update if audited_options[:on].include?(:update)
@@ -97,7 +97,7 @@ module Audited
       end
 
       def has_associated_audits
-        has_many :associated_audits, as: :associated, class_name: Audited.audit_class.name
+        has_many :associated_audits, as: :associated, class_name: VelocityAudited.audit_class.name
       end
     end
 
@@ -159,14 +159,14 @@ module Audited
       # Returns nil for versions greater than revisions count
       def revision(version)
         if version == :previous || audits.last.version >= version
-          revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
+          revision_with VelocityAudited.audit_class.reconstruct_attributes(audits_to(version))
         end
       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 Audited.audit_class.reconstruct_attributes(audits) unless audits.empty?
+        revision_with VelocityAudited.audit_class.reconstruct_attributes(audits) unless audits.empty?
       end
 
       # List of attributes that are audited.
@@ -177,7 +177,7 @@ module Audited
 
       # Returns a list combined of record audits and associated audits.
       def own_and_associated_audits
-        Audited.audit_class.unscoped
+        VelocityAudited.audit_class.unscoped
           .where("(auditable_type = :type AND auditable_id = :id) OR (associated_type = :type AND associated_id = :id)",
             type: self.class.base_class.name, id: id)
           .order(created_at: :desc)
@@ -206,7 +206,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
-          Audited.audit_class.assign_revision_attributes(revision, attributes)
+          VelocityAudited.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
@@ -239,7 +239,7 @@ module Audited
       end
 
       def normalize_enum_changes(changes)
-        return changes if Audited.store_synthesized_enums
+        return changes if VelocityAudited.store_synthesized_enums
 
         self.class.defined_enums.each do |name, values|
           if changes.has_key?(name)
@@ -310,19 +310,22 @@ module Audited
       def write_audit(attrs)
         self.audit_comment = nil
         attrs[:db_audit] = true
+        attrs[:record_id] = id
+        attrs[:model] = self.class.base_class.name
         attrs = add_metadata(attrs)
         if auditing_enabled
           attrs[:associated] = send(audit_associated_with) unless audit_associated_with.nil?
-          logger.audit(attrs.to_json)
+          logger.info(attrs.to_json)
         end
       end
 
       def add_metadata(attrs)
-        attrs[:client] = ::Audited.store[:client]
-        attrs[:origin] = ::Audited.store[:origin]
-        attrs[:user_agent] = ::Audited.store[:user_agent]
-        attrs[:ip] = ::Audited.store[:ip]
-        attrs[:uid] = ::Audited.store[:uid]
+        attrs[:client] = ::VelocityAudited.store[:client]
+        attrs[:origin] = ::VelocityAudited.store[:origin]
+        attrs[:user_agent] = ::VelocityAudited.store[:user_agent]
+        attrs[:ip] = ::VelocityAudited.store[:current_remote_address]
+        attrs[:uid] = ::VelocityAudited.store[:uid]
+        attrs[:request_id] = ::VelocityAudited.store[:request_id]
         attrs
       end
 
@@ -436,19 +439,19 @@ module Audited
       # convenience wrapper around
       # @see Audit#as_user.
       def audit_as(user, &block)
-        Audited.audit_class.as_user(user, &block)
+        VelocityAudited.audit_class.as_user(user, &block)
       end
 
       def auditing_enabled
-        Audited.store.fetch("#{table_name}_auditing_enabled", true) && Audited.auditing_enabled
+        VelocityAudited.store.fetch("#{table_name}_auditing_enabled", true) && VelocityAudited.auditing_enabled
       end
 
       def auditing_enabled=(val)
-        Audited.store["#{table_name}_auditing_enabled"] = val
+        VelocityAudited.store["#{table_name}_auditing_enabled"] = val
       end
 
       def default_ignored_attributes
-        [primary_key, inheritance_column] | Audited.ignored_attributes
+        [primary_key, inheritance_column] | VelocityAudited.ignored_attributes
       end
 
       protected
@@ -458,7 +461,7 @@ module Audited
         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)
-        max_audits = audited_options[:max_audits] || Audited.max_audits
+        max_audits = audited_options[:max_audits] || VelocityAudited.max_audits
         audited_options[:max_audits] = Integer(max_audits).abs if max_audits
       end
 

data/lib/audited/railtie.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-module Audited
+module VelocityAudited
   class Railtie < Rails::Railtie
     initializer "audited.sweeper" do
       ActiveSupport.on_load(:action_controller) do
         if defined?(ActionController::Base)
-          ActionController::Base.around_action Audited::Sweeper.new
+          ActionController::Base.around_action VelocityAudited::Sweeper.new
         end
         if defined?(ActionController::API)
-          ActionController::API.around_action Audited::Sweeper.new
+          ActionController::API.around_action VelocityAudited::Sweeper.new
         end
       end
     end

data/lib/audited/rspec_matchers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Audited
+module VelocityAudited
   module RspecMatchers
     # Ensure that the model is audited.
     #
@@ -221,7 +221,7 @@ module Audited
       def association_exists?
         !reflection.nil? &&
           reflection.macro == :has_many &&
-          reflection.options[:class_name] == Audited.audit_class.name
+          reflection.options[:class_name] == VelocityAudited.audit_class.name
       end
     end
   end

data/lib/audited/sweeper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Audited
+module VelocityAudited
   class Sweeper
     STORED_DATA = {
       current_remote_address: :remote_ip,
@@ -8,12 +8,12 @@ module Audited
       current_user: :current_user,
       origin: :origin,
       user_agent: :user_agent,
-      ip: :ip,
       uid: :uid,
-      client: :client
+      client: :client,
+      request_id: :request_id
     }
 
-    delegate :store, to: ::Audited
+    delegate :store, to: ::VelocityAudited
 
     def around(controller)
       self.controller = controller
@@ -25,7 +25,7 @@ module Audited
     end
 
     def current_user
-      lambda { controller.send(Audited.current_user_method) if controller.respond_to?(Audited.current_user_method, true) }
+      lambda { controller.send(VelocityAudited.current_user_method) if controller.respond_to?(VelocityAudited.current_user_method, true) }
     end
 
     def remote_ip
@@ -43,11 +43,7 @@ module Audited
     def user_agent
       controller.try(:request).try(:headers)['User-Agent']
     end
-
-    def ip
-      controller.try(:request).try(:headers)['HTTP_X_FORWARDED_FOR']
-    end
-
+    
     def uid
       controller.try(:request).try(:headers)['uid']
     end
@@ -56,6 +52,10 @@ module Audited
       controller.try(:request).try(:headers)['client']
     end
 
+    def request_id
+      controller.try(:request).try(:uuid)
+    end
+
     def controller
       store[:current_controller]
     end

data/lib/audited/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Audited
-  VERSION = "5.1.4"
+module VelocityAudited
+  VERSION = "6.0.3"
 end

data/lib/audited-rspec.rb

@@ -2,5 +2,5 @@
 
 require "audited/rspec_matchers"
 module RSpec::Matchers
-  include Audited::RspecMatchers
+  include VelocityAudited::RspecMatchers
 end

data/lib/generators/audited/install_generator.rb

@@ -7,12 +7,12 @@ require "rails/generators/active_record"
 require "generators/audited/migration"
 require "generators/audited/migration_helper"
 
-module Audited
+module VelocityAudited
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-      include Audited::Generators::MigrationHelper
-      extend Audited::Generators::Migration
+      include VelocityAudited::Generators::MigrationHelper
+      extend VelocityAudited::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

data/lib/generators/audited/migration.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Audited
+module VelocityAudited
   module Generators
     module Migration
       # Implement the required interface for Rails::Generators::Migration.

data/lib/generators/audited/migration_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Audited
+module VelocityAudited
   module Generators
     module MigrationHelper
       def migration_parent

data/lib/generators/audited/upgrade_generator.rb

@@ -7,12 +7,12 @@ require "rails/generators/active_record"
 require "generators/audited/migration"
 require "generators/audited/migration_helper"
 
-module Audited
+module VelocityAudited
   module Generators
     class UpgradeGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-      include Audited::Generators::MigrationHelper
-      extend Audited::Generators::Migration
+      include VelocityAudited::Generators::MigrationHelper
+      extend VelocityAudited::Generators::Migration
 
       source_root File.expand_path("../templates", __FILE__)
 
@@ -25,9 +25,9 @@ module Audited
       private
 
       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)
+        VelocityAudited::Audit.reset_column_information
+        columns = VelocityAudited::Audit.columns.map(&:name)
+        indexes = VelocityAudited::Audit.connection.indexes(VelocityAudited::Audit.table_name)
 
         yield :add_comment_to_audits unless columns.include?("comment")
 

data/lib/velocity_audited.rb

@@ -1,53 +1,49 @@
+# frozen_string_literal: true
+
 require "active_record"
 
 module VelocityAudited
-  # frozen_string_literal: true
-  #
-  module Audited
-    class << self
-      attr_accessor \
+  class << self
+    attr_accessor \
       :auditing_enabled,
       :current_user_method,
       :ignored_attributes,
       :max_audits,
       :store_synthesized_enums
-      attr_writer :audit_class
-
-      def audit_class
-        @audit_class ||= Audit
-      end
+    attr_writer :audit_class
 
-      def store
-        current_store_value = Thread.current.thread_variable_get(:audited_store)
+    def audit_class
+      @audit_class ||= Audit
+    end
 
-        if current_store_value.nil?
-          Thread.current.thread_variable_set(:audited_store, {})
-        else
-          current_store_value
-        end
-      end
+    def store
+      current_store_value = Thread.current.thread_variable_get(:audited_store)
 
-      def config
-        yield(self)
+      if current_store_value.nil?
+        Thread.current.thread_variable_set(:audited_store, {})
+      else
+        current_store_value
       end
     end
 
-    @ignored_attributes = %w[lock_version created_at updated_at created_on updated_on]
-
-    @current_user_method = :current_user
-    @auditing_enabled = true
-    @store_synthesized_enums = false
+    def config
+      yield(self)
+    end
   end
 
-  require "audited/auditor"
+  @ignored_attributes = %w[lock_version created_at updated_at created_on updated_on]
 
-  ActiveSupport.on_load :active_record do
-    require "audited/audit"
-    include Audited::Auditor
-  end
+  @current_user_method = :current_user
+  @auditing_enabled = true
+  @store_synthesized_enums = false
+end
 
-  require "audited/sweeper"
-  require "audited/railtie"
+require "audited/auditor"
 
+ActiveSupport.on_load :active_record do
+  require "audited/audit"
+  include VelocityAudited::Auditor
+end
 
-end
+require "audited/sweeper"
+require "audited/railtie"