timelines 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 339ae3e7d0c51c23d89e50623e47968edeea76e05f712450b8239dce582a40d9
+  data.tar.gz: 10a248044ed773b787dd9a0520c4198e5742fab92e0635b715dfe13fe5d23dec
+SHA512:
+  metadata.gz: 216d2927c9597196a0978234f6745d41ba4b0f9f545b51ad7dd74acdf0fdf0aa49097809f17281969675680e7767b4eb73caa887e16d0f75707739023996cebd
+  data.tar.gz: 03f80b16d2d44a06086f0adb3a8c8a26cf10f549297cf4a786d7115045cb4550928f0c778a7de64fb451b219457808f7291c12ba903cb315e35ba83c8d739974

data/README.md

@@ -0,0 +1,52 @@
+# Timelines
+I use this `Ephemeral` pattern frequently across projects to have a simple pattern for tracking the lifecycle of a record, whether it is currently active/ended/draft, and soft-deleting records to keep an audit trail.
+
+## Usage
+For an ActiveRecord model that has `started_at` and `ended_at` columns (datetime), include `Ephemeral` to give it ephemeral behavior.
+
+```ruby
+include Timelines::Ephemeral
+```
+
+This gives you the following Instance methods:
+```ruby
+# Returns a boolean indicating whether the record is currently active
+.active?
+
+# Sets the record's `started_at` to the current time to indicate that it has started
+.start!
+
+# Returns a boolean indicating whether the record has started
+.started?
+
+# Sets the record's `ended_at` to the current time to indicate that it has ended
+.end!
+
+# Returns a boolean indicating whether the record has ended
+.ended?
+
+# Returns a boolean indicating whether the record is currently in a draft state (nil `started_at` and `ended_at`, or `started_at` in the future)
+.draft?
+
+# Soft-deletes the record by setting `ended_at` to the current time, removing it from the `.active` scope.
+.destroy
+```
+
+And the following Class methods:
+```ruby
+# Soft-deletes all records by setting `ended_at` to the current time, removing them from the `.active` scope.
+.self.destroy_all
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "timelines"
+```
+
+## Contributing
+Pull requests/issues are welcome on GitHub
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/tasks/timelines_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :timelines do
+#   # Task goes here
+# end

data/lib/timelines/ephemeral.rb

@@ -0,0 +1,52 @@
+require "active_support/concern"
+
+module Timelines
+  module Ephemeral
+    extend ActiveSupport::Concern
+
+    included do
+      scope :draft, -> { where(started_at: nil) }
+      scope :active, -> { where(ended_at: nil, started_at: [..Time.current]) }
+      scope :with_deleted, -> { unscope(where: :ended_at) }
+      scope :ended, -> { where.not(ended_at: nil) }
+      scope :deleted, -> { ended }
+      scope :not_deleted, -> { where(ended_at: nil) }
+
+      def active?
+        started? && !ended?
+      end
+
+      def start!
+        return if started_at.present?
+
+        update(started_at: Time.current)
+      end
+
+      def started?
+        !!started_at&.past?
+      end
+
+      def end!
+        destroy
+      end
+
+      def ended?
+        !!ended_at&.past?
+      end
+
+      def draft?
+        !started?
+      end
+
+      def destroy
+        return if ended_at.present?
+
+        update(ended_at: Time.current)
+      end
+
+      def self.destroy_all
+        where(ended_at: nil).update_all(ended_at: Time.current)
+      end
+    end
+  end
+end

data/lib/timelines/railtie.rb

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

data/lib/timelines/version.rb

@@ -0,0 +1,3 @@
+module Timelines
+  VERSION = "0.1.0"
+end

data/lib/timelines.rb

@@ -0,0 +1,6 @@
+require "timelines/version"
+require "timelines/railtie"
+require "timelines/ephemeral"
+
+module Timelines
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: timelines
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Craig Gilchrist
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: Library for managing historical records.
+email:
+- craig.a.gilchrist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/tasks/timelines_tasks.rake
+- lib/timelines.rb
+- lib/timelines/ephemeral.rb
+- lib/timelines/railtie.rb
+- lib/timelines/version.rb
+homepage: https://github.com/Craggar/timelines
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Craggar/timelines
+  github_repo: git@github.com:Craggar/timelines.git
+  source_code_uri: https://github.com/Craggar/timelines
+  changelog_uri: https://github.com/Craggar/timelines/CHANGELOG.md
+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.4.10
+signing_key:
+specification_version: 4
+summary: Library for managing historical records.
+test_files: []