cm-action-trail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf963726bc6cc26dcf6c632b42def11bc2fa174047019dfb450d7253a302342b
+  data.tar.gz: 71838d3c802ec1223651e187422d09866795929bd8487e350d574a68f4bb5f04
+SHA512:
+  metadata.gz: a973c09b6e3e542c8d8726e1ccdaaee503b7b4796982fe90e3e0fac2bed0305df1d7f51780e9bf6a05ae39bbe5367eaa597260036ac0a5e03f856bfe33ad9335
+  data.tar.gz: f3030df9dee7411025ea5a3a795d48a2f591b7460794a4fb3a7faa575901054e372aed887a413d32324748d96635470185b30b037ef6ceda2c94afc71f0721e8

data/README.md

@@ -0,0 +1,33 @@
+# CmAdmin
+
+An action logger gem for Ruby on Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cm-action-trail'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Copy the migration
+
+    $ rails cm_action_trail:install:migrations
+
+Include inside the model
+
+    has_action_trail
+
+In application.rb
+    
+    require 'cm-action-trail'
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/commutatus/cm-action-trail).

data/app/models/action_trail.rb

@@ -0,0 +1,16 @@
+class ActionTrail < ApplicationRecord
+  
+  belongs_to :entity, polymorphic: true
+  belongs_to :actor, foreign_key: 'actor_id', class_name: 'User', optional: true
+
+  enum trail_type: { created: 0, updated: 1, deleted: 2 }
+
+  def create_notification(notify_content, receiver)
+    notifications.create(
+      notification_content: notify_content,
+      sender_id: self.actor_id,
+      notifiable: self.entity,
+      receiver: receiver
+    )
+  end
+end

data/db/migrate/20220302120216_create_action_trails.rb

@@ -0,0 +1,14 @@
+class CreateActionTrails < ActiveRecord::Migration[6.1]
+  def change
+    create_table :action_trails do |t|
+      t.string :entity_type
+      t.integer :entity_id
+      t.integer :trail_type
+      t.string :event_name, null: false
+      t.integer :actor_id
+      t.jsonb :entity_changes
+
+      t.timestamps
+    end
+  end
+end

data/lib/cm-action-trail/core.rb

@@ -0,0 +1,40 @@
+module CmActionTrail::Core
+  extend ActiveSupport::Concern
+
+  included do
+    attr_accessor :current_action_name
+
+    after_commit :register_event
+
+    before_save {|record|
+      if record.current_action_name.nil?
+        record.current_action_name = record.new_record? ? 'created' : 'updated'
+      end
+    }
+    before_destroy {|record| record.current_action_name = 'destroyed'}
+
+    has_many :action_trails, as: :entity
+
+  end
+
+  def check_trail_type
+    if self.new_record?
+      :created
+    elsif self.destroyed?
+      :deleted
+    else
+      :updated
+    end
+  end
+
+  def register_event
+    trail_type = check_trail_type
+    ::ActionTrail.create(
+        entity: self,
+        trail_type: trail_type,
+        event_name: self.current_action_name,
+        actor_id: Current.user&.id,
+        entity_changes: saved_changes.except(:updated_at)
+      )
+  end
+end

data/lib/cm-action-trail/engine.rb

@@ -0,0 +1,5 @@
+module CmActionTrail
+  class Engine < ::Rails::Engine
+    isolate_namespace CmActionTrail
+  end
+end

data/lib/cm-action-trail/version.rb

@@ -0,0 +1,3 @@
+module CmActionTrail
+  VERSION = "0.0.1"
+end

data/lib/cm-action-trail.rb

@@ -0,0 +1,13 @@
+require 'cm-action-trail/version'
+require 'cm-action-trail/engine'
+require 'cm-action-trail/core'
+
+module CmActionTrail
+  def has_action_trail
+    include CmActionTrail::Core
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.extend CmActionTrail
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: cm-action-trail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- anbublacky
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-06 00:00:00.000000000 Z
+dependencies: []
+description: Description of Cm::ActionTrail.
+email:
+- anbublacky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/models/action_trail.rb
+- db/migrate/20220302120216_create_action_trails.rb
+- lib/cm-action-trail.rb
+- lib/cm-action-trail/core.rb
+- lib/cm-action-trail/engine.rb
+- lib/cm-action-trail/version.rb
+homepage: https://github.com/commutatus/cm-action-trail
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/commutatus/cm-action-trail
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Summary of Cm::ActionTrail.
+test_files: []