effective_logging 3.5.4 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b0d07832764f1aca2982e520809195ae26b36c947b04b15f4ae5318ec74b4f7
-  data.tar.gz: 507ff8215257de3ce69a6ded010f18ec123469b111b8cb74f426263cec3e43ac
+  metadata.gz: 1e01f3b3cf8eef9efac4f4632689436b4af1a306d404751c8bb7ef3a4b0bfaac
+  data.tar.gz: d202700416cfc326a4629308efe158a22f86ced2b338cf73992ec4b711991fb7
 SHA512:
-  metadata.gz: d11842ba982615466b169a5415bed591f7e025cd912a94c0dc1ee4f105ea15b191833a73e78e6e406206c57de9456c5e12c6bc62961c5cb106fd24b4a5677446
-  data.tar.gz: 7f270c7159f350a5de6db15f30e42665a541dd060747a967078212dc4f39b2036ff21b218c209c3d72f14667d26db62c6825fbd7a0493ca0ac2240166935b95f
+  metadata.gz: 6e8bc213d1d252c3f1b52af723f4ff49f134d159bc1d48f4e6213e75257596c0426dc7b2e0f319b047436662bd93a71deadc271a31dac91a26fb2e45ec954149
+  data.tar.gz: 6ce20cf20608edc2aba0c6145c44cb8ee7cbddc02b39324852f632763b2553fe4d553e9345249fe12917a38b33c91819fe980364222120be1d4b1be9c83daa00

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Code and Effect Inc.
+Copyright 2023 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -254,7 +254,7 @@ First, require the javascript in your application.js:
 and add the user permission:
 
 ```ruby
-can :create, Effective::Log
+can :create, EffectiveLogging.Log
 ```
 
 then logging an event from JavaScript is almost the same one-liner as from ruby:
@@ -290,7 +290,7 @@ link_to 'Logs', effective_logging.admin_logs_path   # /admin/logs
 But you may need to add the permission (using CanCan):
 
 ```ruby
-can :manage, Effective::Log
+can :manage, EffectiveLoggging.Log
 can :admin, :effective_logging
 ```
 

data/app/controllers/admin/logs_controller.rb

@@ -6,6 +6,9 @@ module Admin
     include Effective::CrudController
     skip_log_page_views
 
+    resource_scope -> { EffectiveLogging.Log.deep.all }
+    datatable -> { Admin::EffectiveLogsDatatable.new }
+
     if (config = EffectiveLogging.layout)
       layout(config.kind_of?(Hash) ? config[:admin] : config)
     end

data/app/controllers/effective/logs_controller.rb

@@ -5,15 +5,17 @@ module Effective
     include Effective::CrudController
     skip_log_page_views
 
+    resource_scope -> { EffectiveLogging.Log.all }
+
     if (config = EffectiveLogging.layout)
       layout(config.kind_of?(Hash) ? config[:application] : config)
     end
 
     # This is a post from our Javascript
     def create
-      EffectiveResources.authorize!(self, :create, Effective::Log.new)
+      EffectiveResources.authorize!(self, :create, resource_scope.new)
 
-      @log = Effective::Log.new.tap do |log|
+      @log = resource_scope.new.tap do |log|
         log.message = log_params[:message]
         log.status = EffectiveLogging.statuses.find { |status| status == log_params[:status] } || 'info'
         log.user = EffectiveLogging.current_user || current_user
@@ -40,12 +42,12 @@ module Effective
 
     # This is the User index event
     def index
-      EffectiveResources.authorize!(self, :index, Effective::Log.new(user_id: current_user.id))
+      EffectiveResources.authorize!(self, :index, resource_scope.new(user: current_user, user_id: current_user.id))
       @datatable = EffectiveLogsDatatable.new(self, for: current_user.id)
     end
 
     def html_part
-      @log = Effective::Log.find(params[:id])
+      @log = resource_scope.find(params[:id])
 
       EffectiveResources.authorize!(self, :show, @log)
 

data/app/datatables/admin/effective_logs_datatable.rb

@@ -0,0 +1,2 @@
+class Admin::EffectiveLogsDatatable < EffectiveLogsDatatable
+end

data/app/datatables/effective_log_changes_datatable.rb

@@ -37,7 +37,7 @@ class EffectiveLogChangesDatatable < 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
-    Effective::Log.logged_changes.deep
+    EffectiveLogging.Log.logged_changes.deep
       .where(changes_to_type: attributes[:changes_to_type], changes_to_id: attributes[:changes_to_id])
   end
 

data/app/datatables/effective_logs_datatable.rb

@@ -42,7 +42,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.deep.all
+    scope = EffectiveLogging.Log.deep.all
 
     # Older syntax, pass by integer
     if attributes[:for]

data/app/models/concerns/acts_as_loggable.rb

@@ -20,7 +20,7 @@ module ActsAsLoggable
   end
 
   included do
-    has_many :logged_changes, -> { order(:id).where(status: EffectiveLogging.log_changes_status) }, as: :changes_to, class_name: 'Effective::Log'
+    has_many :logged_changes, -> { EffectiveLogging.Log.order(:id).where(status: EffectiveLogging.log_changes_status) }, as: :changes_to
 
     log_changes_options = {
       to: @acts_as_loggable_options[:to],

data/app/models/concerns/effective_logging_log.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# EffectiveLoggingLog
+#
+# Mark your log model with effective_logging_log to get all the includes
+
+module EffectiveLoggingLog
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_logging_log
+      include ::EffectiveLoggingLog
+    end
+  end
+
+  module ClassMethods
+    def effective_logging_log?; true; end
+  end
+
+  included do
+    self.table_name = (EffectiveLogging.logs_table_name || :logs).to_s
+
+    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
+      status              :string
+
+      changes_to_type     :string
+      changes_to_id       :string
+
+      associated_type     :string
+      associated_id       :integer
+      associated_to_s     :string
+
+      message             :text
+      details             :text
+
+      timestamps
+    end
+
+    serialize :details, Hash
+
+    validates :message, presence: true
+    validates :status, presence: true
+
+    validate(if: -> { status.present? }) do
+      errors.add(:status, "is not included") unless EffectiveLogging.statuses.include?(status)
+    end
+
+    scope :deep, -> { includes(:user, :associated, :changes_to) }
+    scope :sorted, -> { order(:id) }
+    scope :logged_changes, -> { where(status: EffectiveLogging.log_changes_status) }
+    scope :changes, -> { where(status: EffectiveLogging.log_changes_status) }
+
+    # Dynamically add logging methods based on the defined statuses
+    # EffectiveLogging.info 'my message'
+    (EffectiveLogging.statuses || []).each do |status|
+      send(:define_method, status) { |message, options={}| log(message, status, options) }
+    end
+
+  end
+
+  # Instance Methods
+  def to_s
+    "#{model_name.human} ##{id}"
+  end
+
+  def associated_to_s=(value)
+    super(value.to_s[0...255].presence) # Take only first 255 characters
+  end
+
+  def log(message, status = nil, options = {})
+    status ||= EffectiveLogging.statuses.first
+    EffectiveLogger.log(message, status, options)
+  end
+
+  def details
+    self[:details] || {}
+  end
+
+  def next_log
+    self.class.order(id: :asc).where('id > ?', id).first
+  end
+
+  def prev_log
+    self.class.order(id: :desc).where('id < ?', id).first
+  end
+
+end

data/app/models/effective/log.rb

@@ -1,68 +1,7 @@
-# frozen_string_literal: true
-
 module Effective
   class Log < ActiveRecord::Base
-    self.table_name = EffectiveLogging.logs_table_name.to_s
-
-    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
-      status              :string
-
-      changes_to_type     :string
-      changes_to_id       :string
-
-      associated_type     :string
-      associated_id       :integer
-      associated_to_s     :string
-
-      message             :text
-      details             :text
-
-      timestamps
-    end
-
-    serialize :details, Hash
-
-    validates :message, presence: true
-    validates :status, presence: true, inclusion: { in: EffectiveLogging.statuses }
-
-    scope :deep, -> { includes(:user, :associated) }
-    scope :sorted, -> { order(:id) }
-    scope :logged_changes, -> { where(status: EffectiveLogging.log_changes_status) }
-    scope :changes, -> { where(status: EffectiveLogging.log_changes_status) }
-
-    def to_s
-      "Log #{id}"
-    end
-
-    def associated_to_s=(value)
-      super(value.to_s[0...255].presence) # Take only first 255 characters
-    end
-
-    def log(message, status = EffectiveLogging.statuses.first, options = {})
-      EffectiveLogger.log(message, status, options)
-    end
-
-    def details
-      self[:details] || {}
-    end
-
-    def next_log
-      Log.order(id: :asc).where('id > ?', id).first
-    end
-
-    def prev_log
-      Log.order(id: :desc).where('id < ?', id).first
-    end
-
-    # Dynamically add logging methods based on the defined statuses
-    # EffectiveLogging.info 'my message'
-    (EffectiveLogging.statuses || []).each do |status|
-      send(:define_method, status) { |message, options={}| log(message, status, options) }
-    end
+    self.table_name = (EffectiveLogging.logs_table_name || :logs).to_s
 
+    effective_logging_log
   end
 end

data/app/models/effective_logger.rb

@@ -24,7 +24,7 @@ class EffectiveLogger
       options[:user_agent] ||= request.user_agent
     end
 
-    log = Effective::Log.new(
+    log = EffectiveLogging.Log.new(
       message: message,
       status: status,
       user_id: options.delete(:user_id),

data/config/effective_logging.rb

@@ -1,6 +1,6 @@
 EffectiveLogging.setup do |config|
-  # Configure Database Tables
-  config.logs_table_name = :logs
+  # Specify Log class
+  # config.log_class_name = 'Effective::Log'
 
   # Admin Screens Layout Settings
   # config.layout = { application: 'application', admin: 'admin' }

data/db/migrate/101_create_effective_logging.rb

@@ -0,0 +1,34 @@
+class CreateEffectiveLogging < ActiveRecord::Migration[6.0]
+  def change
+    create_table :logs do |t|
+      t.string        :status
+
+      t.string        :user_type
+      t.integer       :user_id
+
+      t.string        :changes_to_type
+      t.integer       :changes_to_id
+
+      t.string        :associated_type
+      t.integer       :associated_id
+      t.string        :associated_to_s
+
+      t.text          :message
+      t.text          :details
+
+      t.timestamps
+    end
+
+    add_index :logs, :id, order: { id: :desc }
+    add_index :logs, :updated_at
+    add_index :logs, :user_id
+    add_index :logs, :status
+    add_index :logs, :associated_to_s
+    add_index :logs, [:associated_type, :associated_id]
+    add_index :logs, [:changes_to_type, :changes_to_id]
+
+    enable_extension('pg_trgm')
+    add_index :logs, :message, using: :gin, opclass: :gin_trgm_ops
+    add_index :logs, :details, using: :gin, opclass: :gin_trgm_ops
+  end
+end

data/lib/effective_logging/active_record_logger.rb

@@ -43,7 +43,7 @@ module EffectiveLogging
     end
 
     def log(message, details)
-      Effective::Log.create!(
+      EffectiveLogging.Log.create!(
         changes_to: log_changes_to,
         associated: object,
         associated_to_s: (object.to_s rescue nil),

data/lib/effective_logging/engine.rb

@@ -28,6 +28,7 @@ module EffectiveLogging
       app.config.to_prepare do
         ActiveSupport.on_load :active_record do
           ActiveRecord::Base.extend(ActsAsLoggable::Base)
+          ActiveRecord::Base.extend(EffectiveLoggingLog::Base)
         end
       end
     end

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '3.5.4'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/lib/effective_logging.rb

@@ -6,12 +6,17 @@ module EffectiveLogging
   def self.config_keys
     [
       :logs_table_name, :layout, :additional_statuses,
+      :log_class_name,
       :active_storage_enabled, :email_enabled, :sign_in_enabled, :sign_out_enabled
     ]
   end
 
   include EffectiveGem
 
+  def self.Log
+    log_class_name&.constantize || Effective::Log
+  end
+
   def self.statuses
     @statuses ||= (
       base = [

data/lib/generators/effective_logging/install_generator.rb

@@ -20,9 +20,7 @@ module EffectiveLogging
       end
 
       def create_migration_file
-        @logs_table_name = ':' + EffectiveLogging.logs_table_name.to_s
-
-        migration_template ('../' * 3) + 'db/migrate/01_create_effective_logging.rb.erb', 'db/migrate/create_effective_logging.rb'
+        migration_template ('../' * 3) + 'db/migrate/101_create_effective_logging.rb', 'db/migrate/create_effective_logging.rb'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 4.1.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-29 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_test_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_developer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: Automatically log all sent emails, user logins, and page views. This
   also will log custom events from Ruby and JavaScript.
 email:
@@ -94,10 +178,12 @@ files:
 - app/assets/javascripts/effective_logging/effective_logger.js.coffee.erb
 - app/controllers/admin/logs_controller.rb
 - app/controllers/effective/logs_controller.rb
+- app/datatables/admin/effective_logs_datatable.rb
 - app/datatables/effective_log_changes_datatable.rb
 - app/datatables/effective_logs_datatable.rb
 - app/helpers/effective_logging_helper.rb
 - app/models/concerns/acts_as_loggable.rb
+- app/models/concerns/effective_logging_log.rb
 - app/models/effective/log.rb
 - app/models/effective_logger.rb
 - app/views/admin/logs/_layout.html.haml
@@ -109,7 +195,7 @@ files:
 - app/views/effective/logs/show.html.haml
 - config/effective_logging.rb
 - config/routes.rb
-- db/migrate/01_create_effective_logging.rb.erb
+- db/migrate/101_create_effective_logging.rb
 - lib/effective_logging.rb
 - lib/effective_logging/active_record_logger.rb
 - lib/effective_logging/active_storage_logger.rb
@@ -139,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Automatically log all sent emails, user logins, and page views. This also

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

@@ -1,38 +0,0 @@
-class CreateEffectiveLogging < ActiveRecord::Migration[4.2]
-  def self.up
-    create_table <%= @logs_table_name %> do |t|
-      t.string        :status
-
-      t.string        :user_type
-      t.integer       :user_id
-
-      t.string        :changes_to_type
-      t.integer       :changes_to_id
-
-      t.string        :associated_type
-      t.integer       :associated_id
-      t.string        :associated_to_s
-
-      t.text          :message
-      t.text          :details
-
-      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 %>, :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
-    drop_table <%= @logs_table_name %>
-  end
-end