timelines 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b4ab605225ad136d4ab3388c6b450c3d5018b183eb254e94b06e15c7363b9bd
-  data.tar.gz: 61b78dcb22d51581a05378b50dd4400afab543a22f25683204994f0f3907adbe
+  metadata.gz: b596c9a86e1cb9a8773f9394a6d71ab6f2e4cd521f89eda1f6ac434cbf059e42
+  data.tar.gz: 57236b6ed3b91ebe95afabedf0d192c277dd5d6127d810504a2f4b9c6a0db487
 SHA512:
-  metadata.gz: c0c5fb0f0c4a5140afc3639b922d8adeec9bd4dc7ead6852c2a9a196586b00d43134cd86539d7a8aed485c2f30f02cd4b4bc7c848a868a6ed8526d72e2830127
-  data.tar.gz: e0d32533e265a3e66203f5b84b81bb85f40f5b95dded491fa7743c2c0dc254beabb785548a1f59b5cc7fd5e429734bdb4b05753d870b96f6627b7cd8a8183abe
+  metadata.gz: 8d02c52990e934303148e6ad8a2bbc021911d3fe21522ba8336ed481334a300e2c4419526dd516b1f1f986c14d5d6c6f6a4d92ece505354d2968d74c5a0b8628
+  data.tar.gz: 48248ca65e37a9aed7757f5c129385f25a2047845e252444f5a04394d701f435a439a8487ddf385c840501474287769791c345eba62f90270afc2f02347b516c

data/README.md

@@ -10,9 +10,18 @@ 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?
 
+# Returns a boolean indicating whether the record was active at a given date
+.active_at?(date)
+
 # Sets the record's `started_at` to the current time to indicate that it has started
 .start!
 
@@ -45,6 +54,14 @@ Add this line to your application's Gemfile:
 gem "timelines"
 ```
 
+## Migrations
+Run this command to create a `timelines_events` table in your project:
+```ruby
+bin/rails generate timelines:install
+```
+
+Then you can call [whatever method] to get events attached to the record.
+
 ## Contributing
 Pull requests/issues are welcome on GitHub
 

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

@@ -0,0 +1,16 @@
+module Timelines
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_application_policy
+        [
+          "create_timelines_events.rb"
+        ].each_with_index do |migration_file, index|
+          timestamp = (Time.current + index + 1).strftime("%Y%m%d%H%M%S")
+          template migration_file, "db/migrate/#{timestamp}_#{migration_file}.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/timelines/install/templates/create_timelines_events.rb

@@ -0,0 +1,10 @@
+class CreateTimelinesEvents < ActiveRecord::Migration[7.1]
+  def change
+    create_table :timelines_events, id: :uuid do |t|
+      t.references :actor, type: :uuid, polymorphic: true
+      t.references :resource, type: :uuid, polymorphic: true
+      t.string :event
+      t.timestamps
+    end
+  end
+end

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/{ephemeral.rb → models/concerns/ephemeral.rb}

@@ -7,6 +7,7 @@ module Timelines
     included do
       scope :draft, -> { where(started_at: nil) }
       scope :active, -> { where(ended_at: nil, started_at: [..Time.current]) }
+      scope :active_at, ->(date) { where("started_at <= ? AND (ended_at IS ? OR ended_at >= ?)", date, nil, date) }
       scope :with_deleted, -> { unscope(where: :ended_at) }
       scope :ended, -> { where.not(ended_at: nil) }
       scope :deleted, -> { ended }
@@ -16,6 +17,10 @@ module Timelines
         started? && !ended?
       end
 
+      def active_at?(date)
+        self.class.active_at(date).where(id: id).exists?
+      end
+
       def start!
         return if started_at.present?
 

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

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

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

@@ -0,0 +1,11 @@
+require "active_support/concern"
+
+module Timelines
+  module HasEvents
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :events, class_name: "Timelines::Event", as: :resource, dependent: :destroy
+    end
+  end
+end

data/lib/timelines/models/event.rb

@@ -0,0 +1,8 @@
+module Timelines
+  class Event < ActiveRecord::Base
+    self.table_name = "timelines_events"
+
+    belongs_to :actor, polymorphic: true
+    belongs_to :resource, polymorphic: true
+  end
+end

data/lib/timelines/version.rb

@@ -1,3 +1,3 @@
 module Timelines
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

data/lib/timelines.rb

@@ -1,6 +1,9 @@
 require "timelines/version"
-require "timelines/railtie"
-require "timelines/ephemeral"
+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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timelines
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Craig Gilchrist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,10 +35,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- lib/generators/timelines/install/install_generator.rb
+- lib/generators/timelines/install/templates/create_timelines_events.rb
 - lib/tasks/timelines_tasks.rake
 - lib/timelines.rb
-- lib/timelines/ephemeral.rb
-- lib/timelines/railtie.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
 homepage: https://github.com/Craggar/timelines
 licenses:
@@ -62,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Library for managing historical records.

data/lib/timelines/railtie.rb

@@ -1,4 +0,0 @@
-module Timelines
-  class Railtie < ::Rails::Railtie
-  end
-end