timelines 0.4.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c65a5feb6df7817fe888742b8de6d6c7f81e532ccc41d7290fbd265ff54b1e
-  data.tar.gz: cb783db345463c6553cbcb3a689ad50effc5b1d83afb84e7492d66fd16e6b9b2
+  metadata.gz: 7c47e84c6bedc124729951662521fc68baeaede671752dc275f7d2114bcd4983
+  data.tar.gz: 1875a77f55430a151878b874b99dabb4d7adfb9a3ba68a2829d861485f907b47
 SHA512:
-  metadata.gz: 803e6084c141d0bdae68bb4d95062c56d7e2173b15fddc9c22c804c2019317def240954d765e8e82f506e4f48ac34c10124ef0c6290a6ddc531081bd19a34cfa
-  data.tar.gz: 03f429339c43f0372a58e24c9db90acec09e4f828f9ba74607166edd34a427ceebcf1b2cd699e5e460cfdb58ea0ee78f028ceadfe8d405fc54c03f6e4f9bb499
+  metadata.gz: d698afedff13c041581a16b149d5565eee5ce537740d2c8a601b292ab14dd1337eb0807e993e669e7e50ed98eb68c04d875da317a6aff607db910cac98d2d48b
+  data.tar.gz: 606a6e61c05cb1972b1ca4eca2d39556954e6adc75a640d81790a526411088abe392bc38a6428c72db652ef18a09b4a4592a0ed06c81ecac1025fe28f7b2b95b

data/README.md

@@ -47,6 +47,19 @@ And the following Class methods:
 .self.destroy_all
 ```
 
+Enables defining conditions for automated logging of events for a record's many lifecycle events, which are logged through an ActiveJob adapter.
+
+The parameters are an optional `on:` param (which defaults to `before_save`), and 4 procs that define the resource, actor, event, and conditions for logging the event. Conditions can be used to ensure an event only fires on a new record, or on a record that has been updated in a specific way/meets certain criteria to be eligible to log the event.
+```ruby
+include Timelines::TracksEvents
+tracks_timelines_event :create_event,
+  resource: ->(instance) { instance },
+  on: :before_create,
+  actor: ->(instance) { instance.created_by },
+  event: ->(instance) { "instance::create" },
+  conditions: ->(instance) { instance.new_record? }
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/timelines/jobs/event_logger.rb

@@ -0,0 +1,16 @@
+module Timelines
+  class EventLogger < ::ActiveJob::Base
+    queue_as :default
+
+    def perform(actor_type, actor_id, resource_klass, resource_id, event, timestamp = Time.current)
+      actor = actor_type.constantize.find_by(id: actor_id)
+      resource = resource_klass.constantize.find_by(id: resource_id)
+      return unless actor.present? && resource.present? && event.present?
+
+      ::Timelines::Event.create!(actor: actor, resource: resource, event: event, created_at: timestamp)
+    rescue => e
+      Rails.logger.error("Failed to log event: #{e.message} - #{actor_type} #{actor_id} - #{resource_klass} #{resource_id} - #{event}")
+      raise e
+    end
+  end
+end

data/lib/timelines/models/concerns/has_audit_trail.rb

@@ -6,6 +6,7 @@ module Timelines
 
     included do
       include ::Timelines::HasEvents
+      include ::Timelines::TracksEvents
 
       def audit_trail(reverse: false)
         ::Timelines::AuditTrail.new(resource: self, reverse: reverse)

data/lib/timelines/models/concerns/tracks_events.rb

@@ -0,0 +1,26 @@
+require "active_support/concern"
+
+module Timelines
+  module TracksEvents
+    extend ActiveSupport::Concern
+
+    included do
+      def self.tracks_timelines_event(name, actor:, resource:, event:, conditions:, on: :before_save)
+        method_name = "track_#{name}_event"
+        define_method method_name.to_sym do
+          event_should_be_logged = conditions.call(self)
+          return unless event_should_be_logged
+
+          event_actor = actor.call(self)
+          event_resource = resource.call(self)
+          event_summary = event.call(self)
+          return unless event_actor.present? && event_resource.present? && event_summary.present?
+
+          ::Timelines::EventLogger.perform_later(event_actor.class.name, event_actor.id, event_resource.class.name, event_resource.id, event_summary, Time.current)
+        end
+
+        send(on, method_name.to_sym)
+      end
+    end
+  end
+end

data/lib/timelines/version.rb

@@ -1,3 +1,3 @@
 module Timelines
-  VERSION = "0.4.0"
+  VERSION = "1.0.1"
 end

data/lib/timelines.rb

@@ -1,7 +1,9 @@
 require "timelines/version"
+require "timelines/jobs/event_logger"
 require "timelines/models/concerns/ephemeral"
 require "timelines/models/concerns/has_events"
 require "timelines/models/concerns/has_audit_trail"
+require "timelines/models/concerns/tracks_events"
 require "timelines/models/concerns/audit_trail"
 require "timelines/models/event"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timelines
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Craig Gilchrist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,10 +39,12 @@ files:
 - lib/generators/timelines/install/templates/create_timelines_events.rb
 - lib/tasks/timelines_tasks.rake
 - lib/timelines.rb
+- lib/timelines/jobs/event_logger.rb
 - lib/timelines/models/concerns/audit_trail.rb
 - lib/timelines/models/concerns/ephemeral.rb
 - lib/timelines/models/concerns/has_audit_trail.rb
 - lib/timelines/models/concerns/has_events.rb
+- lib/timelines/models/concerns/tracks_events.rb
 - lib/timelines/models/event.rb
 - lib/timelines/version.rb
 homepage: https://github.com/Craggar/timelines