timelines 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cafb7917c5de0767aa5c56cfc8b0888369c8b7269e29b1acdad153466cae36e
-  data.tar.gz: 6cf81beee062e3860cd0575f88f7ed7bba0252a422cc0e5333db38e4166cd3f5
+  metadata.gz: 9e0fcaa71f51ce05f909e1476d3697c19cbce690f581357a4dcc0507154456dd
+  data.tar.gz: 8d8f0580bd04c4dca4f7f64d17b889a68eb11d689f006d24aeff8364632aed28
 SHA512:
-  metadata.gz: ce8e9743ddda620638237736225e7481045f85252aa784d57ffbdfa9754fb78a8e6a77046cdc965f0379eb8a8c717ed738a8924975c0445067b253422784abce
-  data.tar.gz: 746ddcaa83b321f511e65236ee3e76f0a2099950a95f322b09bcf124a0c7498c8baeefb7256a8f863010bc42abd48b7bc5c78fe3616683d7e27034c95006dc87
+  metadata.gz: 80767881c109435b0f5b2e6c1da160f7cd57dd21d2c0b2ad0a0c6793beff2a930e11b2f159b0327ed813dd28435e461818cc533b5c8c244ead969b877d6c0f88
+  data.tar.gz: cbc54257925c045ea37ac59b85bd3f842060f6d28665cee5dd96a70a4b63affb6202a905c108cd74787186688e719a4abc64622998b3a739f850cf740a0a0417

data/README.md

@@ -13,6 +13,9 @@ This gives you the following Instance methods:
 # 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 +48,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/{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_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.2"
+  VERSION = "0.2.3"
 end

data/lib/timelines.rb

@@ -1,6 +1,7 @@
 require "timelines/version"
-require "timelines/railtie"
-require "timelines/ephemeral"
+require "timelines/models/concerns/ephemeral"
+require "timelines/models/concerns/has_events"
+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.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Craig Gilchrist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 7.1.0
 description: |2
       Provides an Ephemeral module that can be included in any ActiveRecord model to
       provide a simple way to track active/historical/past records.
@@ -41,10 +35,13 @@ 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/ephemeral.rb
+- lib/timelines/models/concerns/has_events.rb
+- lib/timelines/models/event.rb
 - lib/timelines/version.rb
 homepage: https://github.com/Craggar/timelines
 licenses:
@@ -68,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.4
 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