fast_versioning 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87613fb753cc329fe499c239bc0a84ce505879abb87c4c74cff07c657b0b86db
-  data.tar.gz: 7dec724f5f187384c874ff7af8bd4751054d5462e0e2233d94dfc03075f5e3f7
+  metadata.gz: 2bd60ff0e35e539783059550b97c8075a76422d3a2ed83f025a9633e5c5396ec
+  data.tar.gz: d5ec4ba1e53650f50edb668abb3e4f77f9275984f7b051708401ed92c6469630
 SHA512:
-  metadata.gz: 9b635ba136aed6ec8b8ef573a4e8d958826ff5d481a83fc75f1dddee18d706b6b8909a3b323d1e3db18bf6042f7e4cda7c03ad770848a22147ee19a7e982f8b1
-  data.tar.gz: 8a2ca6a9207836d1f54feaa6ffddfd86a3583493b00aad0897eb3a25f321e47752892f84b68e7298e96247d944b6c389f1c4742ce04fe4ef2b530b511f143f88
+  metadata.gz: 6ae2748e70169334cd3d1920fa13ea740bdcb6310dd4d656d1b188b96a2bfb3ce029551b229cff7a1080295c5884827ecee9c6ea8bd8b29593ed8b04b445d0e9
+  data.tar.gz: 57b5ba1b6e5444dd4aa2caf694a89fabe7cbc9a4268e974a8d664f3075e37e507a81b1f1d1d5156f24da28da9eb99fa89b0a3d03db698716c23ef43d8986a7ee

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/ArcadiaPower/fast-versioning.svg?branch=master)](https://travis-ci.org/ArcadiaPower/fast-versioning)
+
 Fast Versioning
 ===========
 A [PaperTrail](https://github.com/airblade/paper_trail) extension for seamless fast key/value versioning of individual object attributes, which can be queried.
@@ -83,6 +85,38 @@ Example usage:
 
     # query
     your_model.fast_versions_for(:status).where(value: 'active').where(prev_value: 'incomplete')
+
+    # alternatively:
+    FastVersioning::FastVersion.find_by(
+      item_type: 'ItemType',
+      name: 'name',
+      value: 'value'
+      prev_value: 'prev_value'
+    )
+```
+
+### Timeline helper
+`FastVersioning::Timeline` is a simple helper you can use to generate a timeline hash for a tracked property
+
+example usage:
+```ruby
+FastVersioning::Timeline.new(
+  fast_versions: model.fast_versions,
+  name: "status"
+).to_h
+
+# {
+#   Thu, 01 Apr 2021 14:08:48 EDT -04:00..Mon, 05 Apr 2021 21:53:48 EDT -04:00 => 'active',
+#   Mon, 05 Apr 2021 21:53:48 EDT -04:00..Mon, 05 Apr 2021 22:02:44 EDT -04:00 => 'inactive',
+#   Mon, 05 Apr 2021 22:02:44 EDT -04:00..Infinity => 'active'
+# }
+```
+
+Testing
+-------------
+```
+bundle exec appraisal install
+bundle exec appraisal rspec
 ```
 
-An [Arcadia Power](http://www.arcadiapower.com) Project
+An [Arcadia](http://www.arcadia.com) Project

data/app/models/fast_versioning/fast_version.rb

@@ -1,11 +1,9 @@
 module FastVersioning
   class FastVersion < ActiveRecord::Base
     belongs_to :item, polymorphic: true
-    belongs_to :whodunnit, polymorphic: true
+    belongs_to :whodunnit, polymorphic: true, optional: true
     belongs_to :version, class_name: 'PaperTrail::Version'
 
-    validates :version_id, uniqueness: { scope: :name }
-
     serialize :meta, JSON
   end
 end

data/db/migrate/20190514134359_add_unique_index_to_version_id_name.rb

@@ -0,0 +1,5 @@
+class AddUniqueIndexToVersionIdName < ActiveRecord::Migration[5.0]
+  def change
+    add_index :fast_versioning_fast_versions, %i[version_id name], unique: true
+  end
+end

data/lib/fast_versioning.rb

@@ -2,6 +2,8 @@ require 'paper_trail'
 require 'fast_versioning/tracked_attribute'
 require 'fast_versioning/fast_versioned'
 require 'fast_versioning/value_change'
+require 'fast_versioning/timelines/duration'
+require 'fast_versioning/timeline'
 require 'fast_versioning/paper_trail_extensions'
 require 'fast_versioning/railtie'
 require 'fast_versioning/engine'

data/lib/fast_versioning/timeline.rb

@@ -0,0 +1,47 @@
+module FastVersioning
+  # a timeline for a tracked property
+  class Timeline
+    # @param name [String] tracked property name
+    # @param fast_versions [ActiveRecord::Collection] FastVersion collection
+    #
+    def initialize(fast_versions:, name:)
+      self.fast_versions = fast_versions
+      self.name = name
+    end
+
+    # @return [Hash] hash of duration => date ranges
+    #
+    # @example
+    #
+    #   FastVersioning::Timeline.new(fast_versions: model.fast_versions, name: 'status').to_h
+    #
+    #   {
+    #     Thu, 01 Apr 2021 14:08:48 EDT -04:00..Mon, 05 Apr 2021 21:53:48 EDT -04:00 => 'active',
+    #     Mon, 05 Apr 2021 21:53:48 EDT -04:00..Mon, 05 Apr 2021 22:02:44 EDT -04:00 => 'inactive'
+    #   }
+    #
+    def to_h
+      durations_array.map do |duration|
+        [duration.date_range, duration.value]
+      end.to_h
+    end
+
+    private
+
+      attr_accessor :fast_versions, :name
+
+      def filtered_fast_versions
+        fast_versions.where(name: name).order('created_at')
+      end
+
+      def durations_array
+        @value_durations ||= (filtered_fast_versions.to_a + [nil]).each_cons(2).map do |item, prev_item|
+          Timelines::Duration.new(
+            value: item.value,
+            start_date: item.created_at,
+            end_date: prev_item&.created_at
+          )
+        end
+      end
+  end
+end

data/lib/fast_versioning/timelines/duration.rb

@@ -0,0 +1,32 @@
+module FastVersioning
+  # value duration period
+  # @private
+  module Timelines
+    class Duration
+      # @param value [String] tracked property name
+      # @param start_date [Time] when was the value set
+      # @param end_date [Time, nil] when was the value unset (nil will default to Float::INFINITY)
+      def initialize(value:, start_date:, end_date:)
+        self.value = value
+        self.start_date = start_date
+        self.end_date = end_date
+      end
+
+      # @return [Range]
+      def date_range
+        start_date..end_date_or_the_future
+      end
+
+      attr_reader :value
+
+      private
+
+      attr_accessor :start_date, :end_date
+      attr_writer :value
+
+      def end_date_or_the_future
+        end_date || Float::INFINITY
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_versioning
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
-- Arcadia Power
-- Iwo Dziechciarow
-- Justin Doody
-autorequire: 
+- Arcadia
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -21,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: paper_trail
   requirement: !ruby/object:Gem::Requirement
@@ -39,9 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,9 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -80,9 +72,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fast versioning extension for paper_trail
 email:
-- engineering@arcadiapower.com
+- engineering@arcadia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,18 +111,21 @@ files:
 - Rakefile
 - app/models/fast_versioning/fast_version.rb
 - db/migrate/20160914161314_create_fast_versioning_fast_versions.rb
+- db/migrate/20190514134359_add_unique_index_to_version_id_name.rb
 - lib/fast_versioning.rb
 - lib/fast_versioning/engine.rb
 - lib/fast_versioning/fast_versioned.rb
 - lib/fast_versioning/paper_trail_extensions.rb
 - lib/fast_versioning/railtie.rb
+- lib/fast_versioning/timeline.rb
+- lib/fast_versioning/timelines/duration.rb
 - lib/fast_versioning/tracked_attribute.rb
 - lib/fast_versioning/value_change.rb
 homepage: https://github.com/ArcadiaPower/fast-versioning
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Fast versioning extension for paper_trail
 test_files: []