sequel-auditer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44286a93587c09bbef33c1977f2d721081054844118d3928f4b85505e075c5aa
-  data.tar.gz: 189ea2f2dcaecc8e14126d8915fa9c574ecbfd402f9e726ec6e32f27f58e4db1
+  metadata.gz: 6860ac0c5865b177eac491a277880e87fe783ed4537be357de32a0d1f477f604
+  data.tar.gz: 2dd9b761c2210f6b9eb135f6556aadc570bfa3f1f02671a1affb0a6c9d186da9
 SHA512:
-  metadata.gz: 194e4c5c7f5d6f1cf7d41f583c4a1048d938ed299beff7cf919e01597ad723adb699ecfd92feb89118d79e23712c0a6c8566264d436e5fc1a765e240a684e678
-  data.tar.gz: aa0386f43e8f235931e73fadfac67525c67b9b49b525d3d23f6aff9f8090227129ad3d8074846f37eb2457c1101f700540a1a24d33c76b354b672347e2bf1253
+  metadata.gz: c5e5172bcb8f2f75192065c72559095308373c04cd92369e2c1881db19bce86fec84554d4dac9f250f81c3c87790e3a777f636f8be36f23266d3c4049c81a746
+  data.tar.gz: 50f98657d457799fae402bf92ecfd7beba7b1b109448d993b412dd0f7095886d7c7e345a10f381c1562e8e520cf09191941f370aa45dc9df5e34db0db1aa26f8

data/.gitignore

@@ -10,3 +10,4 @@
 spec/sequel-audited-test.db
 .env.test
 rubocop
+*.gem

data/README.md

@@ -7,14 +7,6 @@ and when the change was made.
 This plugin provides model auditing (a.k.a: record versioning) for DB scenarios when DB triggers
 are not possible. (ie: on a web app on Heroku).
 
-
-
-## Disclaimer
-
-This is still **work-in-progress**, and therefore **NOT production ready**, so **use with care**
-and test thoroughly before depending upon this gem for mission-critical stuff!
-You have been warned! No warranties and guarantees expressed or implied!
-
 <br>
 
 ----

data/lib/sequel/auditer/version.rb

@@ -1,5 +1,5 @@
 module Sequel
   module Auditer
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/sequel/plugins/auditer.rb

@@ -2,7 +2,7 @@ require_relative '../auditer'
 
 class AuditLog < Sequel::Model
   # handle versioning of audited records
-  plugin :list, field: :version, scope: [:associated_type, :associated_id]
+  plugin :list, field: :version, scope: %i[associated_type associated_id]
   plugin :timestamps
   plugin :polymorphic
 
@@ -15,12 +15,12 @@ class AuditLog < Sequel::Model
     if u = audit_user
       self.modifier = u
     end
-	
-	# grab any additional info if any
-	if i = audit_additional_info
+
+    # grab any additional info if any
+    if i = audit_additional_info
       self.additional_info = i
-    end
-	
+      end
+
     super
   end
 
@@ -32,30 +32,27 @@ class AuditLog < Sequel::Model
   # # NOTE! this allows overriding the default value on a per audited model
   def audit_user
     user = ::Sequel::Auditer::Railtie.user
-    return user if !user.nil?
-	
-	begin
-		m = Kernel.const_get(associated_type)
-		m.send(m.auditer_current_user_method) || send(m.auditer_current_user_method)
-	rescue
-		nil
-	end
+
+    m = Kernel.const_get(associated_type)
+    u = m.send(m.auditer_current_user_method) || send(m.auditer_current_user_method)
+    return u unless u.nil?
+    return user if u.nil? && !user.nil?
+
+    nil
+  rescue StandardError
+    nil
   end
-  
+
   def audit_additional_info
-	begin
-		m = Kernel.const_get(associated_type)
-		m.send(m.auditer_additional_info_method) || send(m.	auditer_additional_info_method)
-	rescue
-		nil
-	end
+    m = Kernel.const_get(associated_type)
+    m.send(m.auditer_additional_info_method) || send(m. auditer_additional_info_method)
+  rescue StandardError
+    nil
   end
-
 end
 
 module Sequel
   module Plugins
-
     # Given a Post model with these fields:
     #   [:id, :category_id, :title, :body, :author_id, :created_at, :updated_at]
     #
@@ -86,7 +83,6 @@ module Sequel
     #
     #
     module Auditer
-
       # called when
       def self.configure(model, opts = {})
         model.instance_eval do
@@ -107,12 +103,7 @@ module Sequel
           only    = opts.fetch(:only, [])
           except  = opts.fetch(:except, [])
 
-          unless only.empty?
-            # we should only track the provided column
-            included_columns = [only].flatten
-            # subtract the 'only' columns from all columns to get excluded_columns
-            excluded_columns = columns - included_columns
-          else # except:
+          if only.empty? # except:
             # all columns minus any excepted columns and default ignored columns
             included_columns = [
               [columns - [except].flatten].flatten - @auditer_default_ignored_columns
@@ -121,6 +112,11 @@ module Sequel
             # except_columns = except.empty? ? [] : [except].flatten
             excluded_columns = [columns - included_columns].flatten.uniq
             # excluded_columns = [columns - [except_columns, included_columns].flatten].flatten.uniq
+          else
+            # we should only track the provided column
+            included_columns = [only].flatten
+            # subtract the 'only' columns from all columns to get excluded_columns
+            excluded_columns = columns - included_columns
           end
 
           @auditer_included_columns = included_columns
@@ -132,15 +128,10 @@ module Sequel
             class: audit_model_name,
             as: 'associated'
           )
-
         end
-
-
       end
 
-      #
       module ClassMethods
-
         attr_accessor :auditer_default_ignored_columns, :auditer_current_user_method, :auditer_additional_info_method
         # The holder of ignored columns
         attr_reader :auditer_ignored_columns
@@ -149,15 +140,13 @@ module Sequel
 
         attr_accessor :auditer_reference_method
 
-
         Plugins.inherited_instance_variables(self,
                                              :@auditer_default_ignored_columns => nil,
                                              :@auditer_current_user_method     => nil,
                                              :@auditer_additional_info_method  => nil,
                                              :@auditer_included_columns        => nil,
                                              :@auditer_ignored_columns         => nil,
-                                             :@auditer_reference_method        => nil
-                                            )
+                                             :@auditer_reference_method        => nil)
 
         def non_audited_columns
           columns - auditer_columns
@@ -202,10 +191,8 @@ module Sequel
           audit_model.where(opts.merge(associated_type: name.to_s)).order(:version).all
         end
 
-
         private
 
-
         def audit_model
           const_get(audit_model_name)
         end
@@ -223,11 +210,7 @@ module Sequel
         end
 
         def set_user_method(opts)
-          if opts[:user_method]
-            @auditer_current_user_method = opts[:user_method]
-          else
-            @auditer_current_user_method = ::Sequel::Auditer.auditer_current_user_method
-          end
+          @auditer_current_user_method = opts[:user_method] || ::Sequel::Auditer.auditer_current_user_method
         end
 
         def set_additional_info_method(opts)
@@ -243,13 +226,9 @@ module Sequel
             @auditer_reference_method = opts[:reference_method]
           end
         end
-
       end
 
-
-      #
       module InstanceMethods
-
         # Returns who put the post into its current state.
         #
         #   post.blame  # => 'joeblogs'
@@ -262,7 +241,7 @@ module Sequel
           v = versions.last unless versions.empty?
           v ? v.modifier : 'not audited'
         end
-        alias_method :last_audited_by, :blame
+        alias last_audited_by blame
 
         # Returns who put the post into its current state.
         #
@@ -276,19 +255,19 @@ module Sequel
           v = versions.last unless versions.empty?
           v ? v.created_at : 'not audited'
         end
-        alias_method :last_audited_on, :last_audited_at
+        alias last_audited_on last_audited_at
 
         private
 
         # extract audited values only
         def auditer_values(event)
           vals = case event
-          when Sequel::Auditer::CREATE
-            self.values
-          when Sequel::Auditer::UPDATE
-            (column_changes.empty? ? previous_changes : column_changes)
-          when Sequel::Auditer::DESTROY
-            self.values
+                 when Sequel::Auditer::CREATE
+                   values
+                 when Sequel::Auditer::UPDATE
+                   (column_changes.empty? ? previous_changes : column_changes)
+                 when Sequel::Auditer::DESTROY
+                   values
           end
           vals.except(*model.auditer_default_ignored_columns)
         end
@@ -304,7 +283,7 @@ module Sequel
         end
 
         ### CALLBACKS ###
-		
+
         def after_create
           super
           add_audited(Sequel::Auditer::CREATE)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-auditer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kematzy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2018-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel