effective_logging 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4453f03163296e4fc99e3b71b9726b5d6a94c111464aabf554789639bd09db42
-  data.tar.gz: 2dcb56c63e969fa619cedf4a3deb2da0a4204b080f426f077eececabdb0faf94
+  metadata.gz: b21edfec95b3f6878025e153f44ebb09bc798ac01d3a117aecfc85b341586078
+  data.tar.gz: 8c14b70a56c35b492b19d00fae30b786d871cd3ac95c7c61a34ca133b4533f9d
 SHA512:
-  metadata.gz: 60c3450c050554ae8edf1dc069f6bfa44eb8b444f5fe561f4cc3111162b4e60c8b1eb4f50cf6e56c6f48770313b62580081bac0a6852afa4d48b112997b738b1
-  data.tar.gz: d54d72ea79a1b414444f465f837d0342466b6dba91f7bf6415b0c47c0eed601b14961e7d4d299c26e179a456881efa2d243077cb86ad12fddb93964c8a693215
+  metadata.gz: 82a1e987a4642e855ab022c2b81a258fdcf95ad55edea9698e7f2f3766773c0b9f78f8b932c965e64df1c4c8cb6821600dee97063dcfd65c2785f75059e01c52
+  data.tar.gz: 33699371abdac488fc0953ba85ab7117076a2b94cb07ce7c7744d86ab90b7d389d1df6a27b33e2920005e3f3406853a3d38a53cd5eb377de090550a0f5e9bfb2

data/README.md

@@ -2,7 +2,7 @@
 
 Automatically log all sent emails, user logins, and page views. This also will log custom events from Ruby and JavaScript.
 
-Logs are stored in a single database table. A Log (one logged event) can have many children Logs, nested to any depth.
+Logs are stored in a single database table.
 
 Provides a ruby one-liner to log a message, status, user, associated object and any number of additional details.
 
@@ -74,18 +74,6 @@ Any other passed options will be serialized and stored as additional details:
 EffectiveLogger.info 'feedback given', :user => current_user, :feedback => 'your app is great!', :rating => 'good'
 ```
 
-### Sub Logs
-
-Any log can have children logs.  This is perfect for long-running tasks where there are multiple sub events:
-
-```ruby
-log = EffectiveLogger.info('importing important records')
-
-log.success('record 1 imported', :associated => @record1)
-log.error('record 2 failed to import', :associated => @record2)
-log.success('record 3 imported', :associated => @record3)
-```
-
 ### Model
 
 (optional) Sometimes you'd like to work with the `Effective::Log` relationship directly.  Add to your model:
@@ -291,9 +279,6 @@ EffectiveLogger.success('some other event', 'additional', 'information', {subjec
 
 The same statuses available to ruby will be available to JavaScript.
 
-Creating child logs via JavaScript is not yet supported.
-
-
 ## Admin Screen
 
 Visit:

data/app/datatables/effective_logs_datatable.rb

@@ -38,7 +38,7 @@ class EffectiveLogsDatatable < Effective::Datatable
   # A nil attributes[:log_id] means give me all the top level log entries
   # If we set a log_id then it's for sub logs
   collection do
-    scope = Effective::Log.includes(:user).where(parent_id: attributes[:log_id])
+    scope = Effective::Log.deep.all
 
     # Older syntax, pass by integer
     if attributes[:for]

data/app/helpers/effective_logging_helper.rb

@@ -24,12 +24,6 @@ module EffectiveLoggingHelper
     render(partial: 'effective/logs/log', locals: { log: log })
   end
 
-  def parents_of_log(log)
-    parents = [log.parent]
-    parents << parents.last.parent while(parents.last.try(:parent_id).present?)
-    parents.compact.reverse
-  end
-
   # This is called on the Logs#show Admin page, and is intended for override by the application
   def effective_logging_object_link_to(obj, action = :show)
     if obj.kind_of?(User)

data/app/models/effective/log.rb

@@ -4,16 +4,12 @@ module Effective
   class Log < ActiveRecord::Base
     self.table_name = EffectiveLogging.logs_table_name.to_s
 
-    # Self-Referencing relationship
-    belongs_to :parent, class_name: 'Effective::Log', counter_cache: true, optional: true
-    has_many :logs, class_name: 'Effective::Log', foreign_key: :parent_id
-
     belongs_to :user, polymorphic: true, optional: true
     belongs_to :changes_to, polymorphic: true, optional: true # This is the log_changes to: option
     belongs_to :associated, polymorphic: true, optional: true
 
     effective_resource do
-      logs_count          :integer  # Rails Counter Cache
+      status              :string
 
       changes_to_type     :string
       changes_to_id       :string
@@ -22,7 +18,6 @@ module Effective
       associated_id       :integer
       associated_to_s     :string
 
-      status              :string
       message             :text
       details             :text
 
@@ -48,7 +43,7 @@ module Effective
     end
 
     def log(message, status = EffectiveLogging.statuses.first, options = {})
-      EffectiveLogger.log(message, status, (options || {}).merge(parent: self))
+      EffectiveLogger.log(message, status, options)
     end
 
     def details
@@ -56,15 +51,11 @@ module Effective
     end
 
     def next_log
-      Log.order(id: :asc).where(parent_id: parent_id).where('id > ?', id).first
+      Log.order(id: :asc).where('id > ?', id).first
     end
 
     def prev_log
-      Log.order(id: :desc).where(parent_id: parent_id).where('id < ?', id).first
-    end
-
-    def child_logs_datatable
-      EffectiveLogsDatatable.new(log_id: id)
+      Log.order(id: :desc).where('id < ?', id).first
     end
 
     # Dynamically add logging methods based on the defined statuses

data/app/models/effective_logger.rb

@@ -12,10 +12,6 @@ class EffectiveLogger
       raise ArgumentError.new('Log.log :user => ... argument must be a User object')
     end
 
-    if options[:parent].present? && !options[:parent].kind_of?(Effective::Log)
-      raise ArgumentError.new('Log.log :parent => ... argument must be an Effective::Log object')
-    end
-
     if options[:associated].present? && !options[:associated].kind_of?(ActiveRecord::Base)
       raise ArgumentError.new('Log.log :associated => ... argument must be an ActiveRecord::Base object')
     end
@@ -34,7 +30,6 @@ class EffectiveLogger
       user_id: options.delete(:user_id),
       user_type: options.delete(:user_type),
       user: options.delete(:user),
-      parent: options.delete(:parent),
       associated: options.delete(:associated),
       associated_to_s: options.delete(:associated_to_s),
       details: options

data/app/views/effective/logs/_log.html.haml

@@ -2,9 +2,6 @@
   .panel-heading.card-header
     .row
       .col-md-8
-        - parents_of_log(log).each do |parent|
-          = link_to(log.message, request.fullpath.sub('/' + log.to_param, '/' + parent.to_param))
-          = ' > '
         %p= log.message.to_s.gsub("\n", '<br>').html_safe
 
       .col-md-4.text-right
@@ -31,7 +28,7 @@
         - if log.user.present?
           %p
             %strong User:
-            = (log.user.to_s.starts_with?('#<User:0x') ? (log.user.email rescue log.user) : log.user)
+            = log.user
 
         - if log.associated_id.present? && log.associated_type.present? && (log.associated.present? rescue false)
           %p
@@ -48,8 +45,3 @@
           .mt-3
             %strong= "#{key.to_s.titleize}:"
           = format_log_details_value(log, key)
-
-    - if log.logs.present?
-      %hr
-      %p This log contains #{log.logs_count} additional sub entries:
-      = render_datatable(log.child_logs_datatable)

data/db/migrate/01_create_effective_logging.rb.erb

@@ -1,7 +1,7 @@
 class CreateEffectiveLogging < ActiveRecord::Migration[4.2]
   def self.up
     create_table <%= @logs_table_name %> do |t|
-      t.integer       :parent_id
+      t.string        :status
 
       t.string        :user_type
       t.integer       :user_id
@@ -13,21 +13,23 @@ class CreateEffectiveLogging < ActiveRecord::Migration[4.2]
       t.integer       :associated_id
       t.string        :associated_to_s
 
-      t.integer       :logs_count
-
       t.text          :message
       t.text          :details
 
-      t.string        :status
-
       t.timestamps
     end
 
+    add_index <%= @logs_table_name %>, :id, order: { id: :desc }
+    add_index <%= @logs_table_name %>, :updated_at
     add_index <%= @logs_table_name %>, :user_id
-    add_index <%= @logs_table_name %>, :parent_id
-    add_index <%= @logs_table_name %>, [:associated_type, :associated_id]
-    add_index <%= @logs_table_name %>, :associated_id
+    add_index <%= @logs_table_name %>, :status
     add_index <%= @logs_table_name %>, :associated_to_s
+    add_index <%= @logs_table_name %>, [:associated_type, :associated_id]
+    add_index <%= @logs_table_name %>, [:changes_to_type, :changes_to_id]
+
+    enable_extension('pg_trgm')
+    add_index <%= @logs_table_name %>, :message, using: :gin, opclass: :gin_trgm_ops
+    add_index <%= @logs_table_name %>, :details, using: :gin, opclass: :gin_trgm_ops
   end
 
   def self.down

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '3.4.1'.freeze
+  VERSION = '3.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails