action_trace 0.1.0

data/app/models/action_trace/activity_log.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  class ActivityLog
+    extend ActiveModel::Translation
+    include ActionTrace::ActivityLogPresenter
+
+    attr_reader :id, :source, :occurred_at, :user, :raw_subject, :details, :url, :paper_trail_version, :trackable,
+                :trackable_type
+
+    SOURCES = {
+      data_create: 'data_create',
+      data_change: 'data_change',
+      data_destroy: 'data_destroy',
+      page_visit: 'page_visit',
+      session_start: 'session_start',
+      session_end: 'session_end'
+    }.freeze
+
+    def initialize(attributes = {})
+      @id = attributes[:id]
+      @source = attributes[:source]
+      @occurred_at = attributes[:occurred_at]
+      @user = attributes[:user]
+      @raw_subject = attributes[:subject]
+      @details = attributes[:details] || {}
+      @url = attributes[:url]
+      @paper_trail_version = attributes[:paper_trail_version]
+      @trackable = attributes[:trackable]
+      @trackable_type = attributes[:trackable_type]
+    end
+
+    def data_create?
+      source == SOURCES[:data_create]
+    end
+
+    def data_change?
+      source == SOURCES[:data_change]
+    end
+
+    def data_destroy?
+      source == SOURCES[:data_destroy]
+    end
+
+    def page_visit?
+      source == SOURCES[:page_visit]
+    end
+
+    def session_start?
+      source == SOURCES[:session_start]
+    end
+
+    def human_trackable_type
+      return nil if trackable_type.blank?
+
+      trackable_type.constantize.model_name.human
+    rescue StandardError
+      trackable_type
+    end
+  end
+end

data/app/models/action_trace/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/concerns/action_trace/data_trackable.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  module DataTrackable
+    extend ActiveSupport::Concern
+
+    included do
+      include PublicActivity::Common
+
+      after_commit :track_create_activity, on: :create
+      after_commit :track_update_activity, on: :update
+      before_destroy :track_destroy_activity
+    end
+
+    private
+
+    def track_create_activity
+      track_activity('create')
+    end
+
+    def track_update_activity
+      track_activity('update')
+    end
+
+    def track_destroy_activity
+      track_activity('destroy')
+    end
+
+    def devise_actions?
+      controller = PublicActivity.get_controller
+      return false if controller.nil?
+      return false unless defined?(DeviseController)
+
+      controller.is_a?(DeviseController) || controller.is_a?(Devise::SessionsController)
+    end
+
+    def track_activity(action)
+      return if devise_actions?
+
+      current_user = PublicActivity.get_controller&.current_user
+
+      create_activity(
+        key: action_key(action),
+        owner: current_user,
+        version_id: action_version_id,
+        params: action_params
+      )
+    end
+
+    def action_key(action)
+      "#{self.class.name.downcase}.#{action}"
+    end
+
+    def action_version_id
+      return nil unless respond_to?(:versions)
+
+      versions.reload.last&.id
+    end
+
+    def action_params
+      { id: id, display_name: try(:name) || try(:complete_name) || id }
+    end
+  end
+end

data/app/presenters/action_trace/activity_log_presenter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  module ActivityLogPresenter
+    include ActionView::Helpers::TranslationHelper
+    include ActionView::Helpers::TagHelper
+
+    VISUAL_CONFIG = {
+      'data_create' => { icon: 'fas fa-plus-circle', color: 'text-success' },
+      'data_change' => { icon: 'fas fa-pencil-alt', color: 'text-primary' },
+      'data_destroy' => { icon: 'fas fa-trash-alt', color: 'text-danger' },
+      'page_visit' => { icon: 'fas fa-globe-pointer', color: 'text-secondary' },
+      'session_start' => { icon: 'fas fa-arrow-left-to-bracket', color: 'text-warning' },
+      'session_end' => { icon: 'fas fa-arrow-right-to-bracket', color: 'text-danger' }
+    }.freeze
+
+    def icon
+      visual[:icon]
+    end
+
+    def color
+      visual[:color]
+    end
+
+    def subject
+      return raw_subject unless %w[page_visit session_end].include?(source)
+
+      format_subject(details['controller'], details['action'], details['path'])
+    end
+
+    private
+
+    def visual
+      VISUAL_CONFIG[source] || VISUAL_CONFIG['page_visit']
+    end
+
+    def format_subject(controller, action, path)
+      return path if controller.blank?
+
+      singular, plural = model_names_for(controller)
+
+      case action
+      when 'index'
+        "#{I18n.t('.list')} #{plural}"
+      when 'show'
+        "#{I18n.t('.details')} #{singular}"
+      when 'new', 'create', 'edit', 'update', 'destroy', 'delete'
+        "#{I18n.t(".#{action_key(action)}")} #{singular}"
+      else
+        path
+      end
+    end
+
+    def model_names_for(controller)
+      model_class = controller.classify.constantize
+      [model_class.model_name.human, model_class.model_name.human(count: 2)]
+    rescue NameError
+      [controller.humanize.singularize, controller.humanize]
+    end
+
+    def action_key(action)
+      case action
+      when 'new', 'create' then 'new'
+      when 'edit', 'update' then 'edit'
+      when 'destroy', 'delete' then 'destroy'
+      else 'show'
+      end
+    end
+  end
+end

data/app/views/action_trace/activity_logs/_activity_log.html.erb

@@ -0,0 +1,6 @@
+<tr>
+  <td><%= activity_log.occurred_at %></td>
+  <td><%= activity_log.source %></td>
+  <td><%= activity_log.user %></td>
+  <td><%= activity_log.subject %></td>
+</tr>

data/app/views/action_trace/activity_logs/_index.html.erb

@@ -0,0 +1,13 @@
+<table>
+  <thead>
+    <tr>
+      <th><%= ActionTrace::ActivityLog.human_attribute_name(:occurred_at) %></th>
+      <th><%= ActionTrace::ActivityLog.human_attribute_name(:source) %></th>
+      <th><%= ActionTrace::ActivityLog.human_attribute_name(:user) %></th>
+      <th><%= ActionTrace::ActivityLog.human_attribute_name(:raw_subject) %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render partial: 'activity_log', collection: @activity_logs, as: :activity_log %>
+  </tbody>
+</table>

data/app/views/action_trace/activity_logs/index.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'index' %>

data/config/locales/en.yml

@@ -0,0 +1,21 @@
+en:
+  activemodel:
+    models:
+      action_trace/activity_log: "Activity Log"
+    attributes:
+      action_trace/activity_log:
+        occurred_at: "Date and Time"
+        source: "Source"
+        user: "User"
+        raw_subject: "Subject"
+  list: "List"
+  details: "Details"
+  new: "New"
+  edit: "Edit"
+  destroy: "Delete"
+  no_results_found: "There are no items to display at the moment."
+  go_to_page: "Go to Page"
+  params: "Parameters"
+  data: "Data"
+  old_value: "Previous value"
+  new_value: "New value"

data/config/locales/it.yml

@@ -0,0 +1,18 @@
+it:
+  activemodel:
+    models:
+      action_trace/activity_log: "Registro Attività"
+    attributes:
+      action_trace/activity_log:
+        occurred_at: "Data e Ora"
+        source: "Sorgente"
+        user: "Utente"
+        raw_subject: "Oggetto"
+  list: "Elenco"
+  details: "Dettaglio"
+  no_results_found: "Non ci sono elementi da visualizzare al momento."
+  go_to_page: "Visualizza Pagina"
+  params: "Parametri"
+  data: "Dati"
+  old_value: "Valore precedente"
+  new_value: "Nuovo valore"

data/config/locales/views/en.yml

@@ -0,0 +1,24 @@
+en:
+  activity_logs:
+    index:
+      title: "Activity Log"
+      history_detail: "Change Details"
+      all_sources: "All sources"
+      no_activity_logs: "No activity logs..."
+      data_create: "Creation"
+      data_change: "Change"
+      data_destroy: "Deletion"
+      page_visit: "Navigation"
+      session_start: "Session Start"
+      session_end: "Session End"
+      session_details: "Session Details"
+      system_activity: "System Activity"
+      start_date: "Start date"
+      end_date: "End date"
+      sources:
+        data_create: "Data creation"
+        data_change: "Data changes"
+        data_destroy: "Data deletion"
+        page_visit: "Page navigation"
+        session_start: "Portal logins"
+        session_end: "Portal logouts"

data/config/locales/views/it.yml

@@ -0,0 +1,24 @@
+it:
+  activity_logs:
+    index:
+      title: "Registro Attività"
+      history_detail: "Dettaglio Modifiche"
+      all_sources: "Tutte le sorgenti"
+      no_activity_logs: "Nessun registro attività..."
+      data_create: "Creazione"
+      data_change: "Modifica"
+      data_destroy: "Cancellazzione"
+      page_visit: "Navigazione"
+      session_start: "Inizio Sessione"
+      session_end: "Fine Sessione"
+      session_details: "Dettagli Sessione"
+      system_activity: "Attività di Sistema"
+      start_date: "Data inizio"
+      end_date: "Data fine"
+      sources:
+        data_create: "Creazione di dati"
+        data_change: "Modifiche ai dati"
+        data_destroy: "Cancellazzione di dati"
+        page_visit: "Navigazione delle pagine"
+        session_start: "Accessi al portale"
+        session_end: "Logout dal portale"

data/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ActionTrace::Engine.routes.draw do
+  resources :activity_logs, only: [:index] do
+    collection do
+      post :filter
+    end
+  end
+end

data/lib/action_trace/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  class Configuration
+    attr_accessor :excluded_actions, :excluded_controllers, :user_class, :log_retention_period
+
+    def initialize
+      @excluded_actions      = []
+      @excluded_controllers  = []
+      @user_class            = 'User'
+      @log_retention_period  = 1.year
+    end
+  end
+end

data/lib/action_trace/engine.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionTrace
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.after_initialize do
+      begin
+        user_class = ActionTrace.configuration.user_class.constantize
+      rescue NameError
+        raise NameError,
+              "ActionTrace: user_class '#{ActionTrace.configuration.user_class}' not found. Check config/initializers/action_trace.rb."
+      end
+
+      PublicActivity::Activity.define_singleton_method(:filter_by_company) do |scope, company_id|
+        user_ids = user_class.where(company_id: company_id).select(:id)
+        scope.where(owner_type: user_class.name, owner_id: user_ids)
+      end
+
+      [Ahoy::Visit, Ahoy::Event].each do |klass|
+        klass.define_singleton_method(:filter_by_company) do |scope, company_id|
+          user_ids = user_class.where(company_id: company_id).select(:id)
+          scope.where(user_id: user_ids)
+        end
+      end
+    end
+  end
+end

data/lib/action_trace/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActionTrace
+  VERSION = '0.1.0'
+end

data/lib/action_trace.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'action_trace/version'
+require 'action_trace/configuration'
+require 'action_trace/engine'
+
+module ActionTrace
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/generators/action_trace/install/POST_INSTALL

@@ -0,0 +1,29 @@
+
+===============================================================================
+
+  ActionTrace installed successfully!
+
+  Next steps:
+
+  1. Run migrations:
+
+       rails db:migrate
+
+  2. Mount the engine in config/routes.rb:
+
+       mount ActionTrace::Engine, at: "/action_trace"
+
+  3. Include ActivityTrackable in your ApplicationController to track page visits:
+
+       include ActivityTrackable
+
+  4. Include DataTrackable in any model you want to track:
+
+       include ActionTrace::DataTrackable
+
+  5. (Optional) Customize views:
+
+       rails generate action_trace:views
+       rails generate action_trace:views --controller
+
+===============================================================================

data/lib/generators/action_trace/install/install_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module ActionTrace
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Install ActionTrace and all its dependencies'
+
+      class_option :skip_ahoy,            type: :boolean, default: false,
+                                          desc: 'Skip ahoy_matey generator (already installed)'
+      class_option :skip_paper_trail,     type: :boolean, default: false,
+                                          desc: 'Skip paper_trail generator (already installed)'
+      class_option :skip_public_activity, type: :boolean, default: false,
+                                          desc: 'Skip public_activity generator (already installed)'
+      class_option :skip_discard,         type: :boolean, default: false,
+                                          desc: 'Skip discard generator (already installed)'
+
+      def run_ahoy_install
+        generate 'ahoy:install' unless options[:skip_ahoy]
+      end
+
+      def run_paper_trail_install
+        generate 'paper_trail:install' unless options[:skip_paper_trail]
+      end
+
+      def run_public_activity_migration
+        generate 'public_activity:migration' unless options[:skip_public_activity]
+      end
+
+      def create_add_version_id_migration
+        migration_template(
+          'migrations/add_version_id_to_activities.rb.tt',
+          'db/migrate/add_version_id_to_activities.rb'
+        )
+      end
+
+      def create_initializer
+        template 'initializers/action_trace.rb.tt', 'config/initializers/action_trace.rb'
+      end
+
+      def show_post_install_message
+        readme 'POST_INSTALL' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/action_trace/install/templates/initializers/action_trace.rb.tt

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+ActionTrace.configure do |config|
+  # config.excluded_actions      = %w[status ping]
+  # config.excluded_controllers  = %w[home]
+  # config.log_retention_period  = 1.year  # default: 1.year
+end
+
+class Ahoy::Store < Ahoy::DatabaseStore
+  def track_visit(data)
+    super(data)
+  end
+
+  def track_event(data)
+    super(data)
+  end
+end
+
+Ahoy.api      = false
+Ahoy.geocode  = false
+Ahoy.mask_ips = true
+Ahoy.cookies  = true
+
+PaperTrail.config do |config|
+  config.enabled       = true
+  config.version_limit = 10
+  config.serializer    = PaperTrail::Serializers::JSON
+end
+
+PublicActivity::Config.set do
+  enabled true
+end

data/lib/generators/action_trace/install/templates/migrations/add_version_id_to_activities.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddVersionIdToActivities < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :activities, :version_id, :integer
+  end
+end

data/lib/generators/action_trace/views/templates/views/action_trace/activity_logs/_index.html.erb

@@ -0,0 +1,7 @@
+<div id="activity-logs">
+  <% @activity_logs.each do |log| %>
+    <div class="activity-log">
+      <%= log %>
+    </div>
+  <% end %>
+</div>

data/lib/generators/action_trace/views/templates/views/action_trace/activity_logs/index.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'index' %>

data/lib/generators/action_trace/views/views_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module ActionTrace
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc 'Copy ActionTrace views to your application for customization'
+
+      class_option :controller, type: :boolean, default: false,
+                                desc: 'Also copy the ActivityLogsController to your application'
+
+      def self.source_root
+        File.expand_path('templates', __dir__)
+      end
+
+      def copy_views
+        directory 'views/action_trace', 'app/views/action_trace'
+      end
+
+      def copy_controller
+        return unless options[:controller]
+
+        copy_file(
+          File.expand_path('../../../../../app/controllers/action_trace/activity_logs_controller.rb', __dir__),
+          'app/controllers/action_trace/activity_logs_controller.rb'
+        )
+      end
+    end
+  end
+end

data/lib/tasks/action_trace_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :action_trace do
+#   # Task goes here
+# end