effective_logging 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd43bfe19f220a08425b7f93f3160ef4d2fa4107e6eb8c7d00d7e92dff2ede90
-  data.tar.gz: 3d0a977bcff9579e325523aa03472b107d028f2076197e947913b6b4d64df4c7
+  metadata.gz: e35081e813792fcd9865ba3eba02cea731a1b51f4a5c011c97af9f3f25e0fc55
+  data.tar.gz: a1d4917f498c069796790aa020154f6d2b8b7b6f74a7d4185345277351c00de8
 SHA512:
-  metadata.gz: 004220be5d784fce7fb075b9eac6a6f344d4416bfe1c9d64af6edb895b6ed1802e62cca9b52364746a2eba6b9b7b3a4418d3508f912954048d520a0e8106a5a1
-  data.tar.gz: d02dee405d04dd01b1bb135ecf90b7241e2feae917c911ad5785e8474eb04b5821a02e2478924c64a8b8458984c3691129bbd0265a326fef1f16350487f06ee7
+  metadata.gz: 30a6e493e44048f188b01ec46b143f1a95f0bd05b350ed9749f53ce656e50f198f40a093f6d36051efab553f51f4d8f224c24951cf55e5db3b65614d66413080
+  data.tar.gz: db74e4b23a36e85c7a7a67e5ff1a48a1c4229db6593b6bf01c725bd8c66e8a79ed2bfa885e8f3945d5f97680587d01d1d539d1fc974d82081d4038ceec0b6eae

data/app/controllers/admin/tracks_controller.rb

@@ -0,0 +1,8 @@
+module Admin
+  class TracksController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_logging) }
+
+    include Effective::CrudController
+  end
+end

data/app/datatables/admin/effective_tracks_datatable.rb

@@ -0,0 +1,29 @@
+module Admin
+  class EffectiveTracksDatatable < Effective::Datatable
+    filters do
+      filter_date_range
+
+      scope :all
+      scope :signed_in
+      scope :signed_out
+    end
+
+    datatable do
+      col :id, visible: false
+
+      col :created_at
+
+      col :action
+      col :owner, label: 'Resource'
+      col :user
+
+      col :title
+      col :details, visible: false
+    end
+
+    collection do
+      Effective::Track.deep.all.where(created_at: date_range)
+    end
+
+  end
+end

data/app/models/concerns/acts_as_trackable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Just works with effective_resources controller to track views on show action
+# Add acts_as_trackable to your model
+# add_column :things, :tracks_count, :integer, default: 0
+module ActsAsTrackable
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_trackable(*options)
+      @acts_as_trackable = options || []
+      include ::ActsAsTrackable
+    end
+  end
+
+  included do
+    has_many :tracks, -> { order(:id) }, as: :owner, class_name: 'Effective::Track'
+  end
+
+  module ClassMethods
+    def acts_as_trackable?; true; end
+  end
+
+  # Instance Methods
+  def track!(action: 'view', user: nil, details: nil)
+    tracks.create!(action: action, user: user, details: details)
+  end
+end

data/app/models/effective/track.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Effective
+  class Track < ActiveRecord::Base
+    self.table_name = (EffectiveLogging.tracks_table_name || :tracks).to_s
+
+    # The owner resource of this tracked thing
+    belongs_to :owner, polymorphic: true, counter_cache: true
+
+    # Present when the user is signed in
+    belongs_to :user, polymorphic: true, optional: true
+
+    ACTIONS = ['view']
+
+    effective_resource do
+      action          :string
+
+      title           :string
+      details         :text
+
+      timestamps
+    end
+
+    if EffectiveResources.serialize_with_coder?
+      serialize :details, type: Hash, coder: YAML
+    else
+      serialize :details, Hash
+    end
+
+    validates :action, presence: true
+    before_save :assign_title # Assign computed title always
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { includes(:owner, :user) }
+
+    scope :signed_in, -> { where.not(user_id: nil) }
+    scope :signed_out, -> { where(user_id: nil) }
+
+    def to_s
+      title.presence || model_name.human
+    end
+
+    private
+
+    def assign_title
+      title = [action, 'of', "#{owner}", ("by #{user || 'guest user'}")].compact.join(' ')
+      assign_attributes(title: title)
+    end
+
+  end
+end

data/config/routes.rb

@@ -11,6 +11,7 @@ EffectiveLogging::Engine.routes.draw do
 
   namespace :admin do
     resources :logs, only: [:index, :show]
+    resources :tracks, only: :index
   end
 
 end

data/db/migrate/101_create_effective_logging.rb

@@ -30,5 +30,22 @@ class CreateEffectiveLogging < ActiveRecord::Migration[6.0]
     enable_extension('pg_trgm')
     add_index :logs, :message, using: :gin, opclass: :gin_trgm_ops
     add_index :logs, :details, using: :gin, opclass: :gin_trgm_ops
+
+    create_table :tracks do |t|
+      t.string        :owner_type
+      t.integer       :owner_id
+
+      t.string        :user_type
+      t.integer       :user_id
+
+      t.string        :action
+      t.string        :title
+      t.text          :details
+
+      t.timestamps
+    end
+
+    add_index :tracks, :owner_id
+    add_index :tracks, :user_id
   end
 end

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(ActsAsTrackable::Base)
           ActiveRecord::Base.extend(EffectiveLoggingLog::Base)
         end
       end

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '4.2.0'.freeze
+  VERSION = '4.3.0'.freeze
 end

data/lib/effective_logging.rb

@@ -5,7 +5,7 @@ require 'effective_logging/version'
 module EffectiveLogging
   def self.config_keys
     [
-      :logs_table_name, :layout, :additional_statuses,
+      :logs_table_name, :tracks_table_name, :layout, :additional_statuses,
       :log_class_name,
       :active_storage_enabled, :email_enabled, :sign_in_enabled, :sign_out_enabled
     ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -177,14 +177,18 @@ files:
 - app/assets/javascripts/effective_logging.js
 - app/assets/javascripts/effective_logging/effective_logger.js.coffee.erb
 - app/controllers/admin/logs_controller.rb
+- app/controllers/admin/tracks_controller.rb
 - app/controllers/effective/logs_controller.rb
 - app/datatables/admin/effective_logs_datatable.rb
+- app/datatables/admin/effective_tracks_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/acts_as_trackable.rb
 - app/models/concerns/effective_logging_log.rb
 - app/models/effective/log.rb
+- app/models/effective/track.rb
 - app/models/effective_logger.rb
 - app/views/admin/logs/_layout.html.haml
 - app/views/admin/logs/index.html.haml