timelines 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e0fcaa71f51ce05f909e1476d3697c19cbce690f581357a4dcc0507154456dd
-  data.tar.gz: 8d8f0580bd04c4dca4f7f64d17b889a68eb11d689f006d24aeff8364632aed28
+  metadata.gz: f48e1bf0dfd0471248184f1039e1a1b4d3d338c9891369c5462756f8587f4da1
+  data.tar.gz: ddf9d3c52ca93eac3f4435b12ded8db25fb32fb746f283cb08b5982efd4043ea
 SHA512:
-  metadata.gz: 80767881c109435b0f5b2e6c1da160f7cd57dd21d2c0b2ad0a0c6793beff2a930e11b2f159b0327ed813dd28435e461818cc533b5c8c244ead969b877d6c0f88
-  data.tar.gz: cbc54257925c045ea37ac59b85bd3f842060f6d28665cee5dd96a70a4b63affb6202a905c108cd74787186688e719a4abc64622998b3a739f850cf740a0a0417
+  metadata.gz: f854359a07cc0007336d067e028f5f88f3415b5203511422d784c3036183fe5f7857ab6079da9018ecb27075b6da097410bce57018732c504dc3e70e880537e2
+  data.tar.gz: 6f3cd805f1ef214f135e3a0d2856e806ccf4fbaedd20c414c1b7fe0f0bfd34246fb74b33e4f7fb37a184789319267422abb9df904ff4b7ab206039fe4ae7c11b

data/README.md

@@ -10,6 +10,12 @@ include Timelines::Ephemeral
 
 This gives you the following Instance methods:
 ```ruby
+# Returns an AuditTrail object containing the resource and any associated events, in chronological order
+.audit_trail
+
+# Returns an AuditTrail object containing the resource and any associated events, in reverse order
+.audit_trail(reverse: true)
+
 # Returns a boolean indicating whether the record is currently active
 .active?
 

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

@@ -0,0 +1,15 @@
+module Timelines
+  class AuditTrail
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Validations
+
+    attribute :resource
+    attribute :reverse
+    attribute :events
+
+    def events
+      reverse ? resource.events.reverse : resource.events
+    end
+  end
+end

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

@@ -32,7 +32,15 @@ module Timelines
       end
 
       def end!
-        destroy
+        return self if ended_at.present?
+
+        result = ActiveRecord::Base.transaction do
+          run_callbacks(:destroy) do
+            update(ended_at: Time.current)
+          end
+        end
+
+        result ? self : false
       end
 
       def ended?
@@ -44,13 +52,11 @@ module Timelines
       end
 
       def destroy
-        return if ended_at.present?
-
-        update(ended_at: Time.current)
+        end!
       end
 
-      def self.destroy_all
-        where(ended_at: nil).update_all(ended_at: Time.current)
+      def destroy!
+        end!
       end
     end
   end

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

@@ -0,0 +1,15 @@
+require "active_support/concern"
+
+module Timelines
+  module HasAuditTrail
+    extend ActiveSupport::Concern
+
+    included do
+      include ::Timelines::HasEvents
+
+      def audit_trail(reverse: false)
+        ::Timelines::AuditTrail.new(resource: self, reverse: reverse)
+      end
+    end
+  end
+end

data/lib/timelines/version.rb

@@ -1,3 +1,3 @@
 module Timelines
-  VERSION = "0.2.3"
+  VERSION = "0.3.1"
 end

data/lib/timelines.rb

@@ -1,6 +1,8 @@
 require "timelines/version"
 require "timelines/models/concerns/ephemeral"
 require "timelines/models/concerns/has_events"
+require "timelines/models/concerns/has_audit_trail"
+require "timelines/models/concerns/audit_trail"
 require "timelines/models/event"
 
 module Timelines

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timelines
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Craig Gilchrist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,7 +39,9 @@ files:
 - lib/generators/timelines/install/templates/create_timelines_events.rb
 - lib/tasks/timelines_tasks.rake
 - lib/timelines.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/event.rb
 - lib/timelines/version.rb
@@ -65,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Library for managing historical records.