paper_trail_diff 0.11.0 → 0.13.0

data/lib/paper_trail_diff/timeline_range.rb

@@ -4,18 +4,21 @@
 module PaperTrailDiff
   # Chooses explicit-version or wall-clock selection for one timeline request.
   class TimelineRange
-    BOUNDARY_SYMBOLS = %i[first last].freeze
+    BOUNDARY_SYMBOLS = %i[first].freeze
+    # `:last` once named the last version, whose recorded state is the one
+    # *before* the latest change, so a range ending there silently dropped it.
+    LAST_REMOVED = '`:last` was removed because it left out the latest change: omit `to:` ' \
+                   'to end at current state, or pass a version'
 
     attr_reader :from #: untyped
     attr_reader :to #: untyped
     attr_reader :time_range #: TimeRange?
 
-    #: (untyped, from: untyped, to: untyped, within: untyped, ?versions: Array[untyped]?, ?version_scope: untyped, ?plan: RootVersionPlan?, ?live_endpoint: untyped) -> void
-    def initialize(record, from:, to:, within:, versions: nil, version_scope: nil, plan: nil, live_endpoint: nil) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
+    #: (untyped, from: untyped, to: untyped, within: untyped, ?version_scope: untyped, ?plan: RootVersionPlan?, ?live_endpoint: untyped) -> void
+    def initialize(record, from:, to:, within:, version_scope: nil, plan: nil, live_endpoint: nil) # rubocop:disable Metrics/ParameterLists
       @record = record
       @plan = plan
       @live_endpoint = live_endpoint
-      @versions = (plan ? plan.versions : versions)&.freeze
       @version_scope = version_scope
       @requested_from = from
       @requested_to = to
@@ -26,7 +29,7 @@ module PaperTrailDiff
       freeze
     end
 
-    # A record with no versions has no first or last boundary to resolve, which
+    # A record with no versions has no first boundary to resolve, which
     # is an empty history rather than a bad request.
     #: () -> bool
     def unresolved?
@@ -49,27 +52,7 @@ module PaperTrailDiff
                    live_endpoint: @live_endpoint
         ).select_plan(context_required: context_required)
       end
-      return RootVersionPlan.empty if unresolved?
-
-      VersionRange.new(
-        @record, from: @from, to: @to, version_scope: @version_scope
-      ).select_plan_for_range
-    end
-
-    #: (?context_required: bool) -> Array[untyped]
-    def select(context_required: false)
-      preselected = @versions
-      return preselected if preselected
-
-      range = time_range
-      if range
-        return TimeVersionRange.new(
-          @record, time_range: range, version_scope: @version_scope
-        ).select(context_required: context_required)
-      end
-      return empty_versions if unresolved?
-
-      VersionRange.new(@record, from: @from, to: @to, version_scope: @version_scope).select
+      explicit_plan
     end
 
     #: () -> bool
@@ -91,7 +74,6 @@ module PaperTrailDiff
     private
 
     # @rbs @record: untyped
-    # @rbs @versions: Array[untyped]?
     # @rbs @plan: RootVersionPlan?
     # @rbs @version_scope: untyped
     # @rbs @live_endpoint: untyped
@@ -100,10 +82,17 @@ module PaperTrailDiff
     # @rbs @from: untyped
     # @rbs @to: untyped
 
-    #: () -> Array[untyped]
-    def empty_versions
-      versions = [] #: Array[untyped]
-      versions.freeze
+    #: () -> RootVersionPlan
+    def explicit_plan
+      return RootVersionPlan.empty if unresolved?
+      if Endpoint.record?(@to)
+        return VersionRange.new(@record, from: @from, to: @from, version_scope: @version_scope)
+                           .select_plan_through_current(@to)
+      end
+
+      VersionRange.new(
+        @record, from: @from, to: @to, version_scope: @version_scope
+      ).select_plan_for_range
     end
 
     #: (untyped) -> bool
@@ -111,32 +100,25 @@ module PaperTrailDiff
       boundary.is_a?(Symbol)
     end
 
-    # Resolving `:first` and `:last` here keeps callers from depending on the
+    # Resolving `:first` here keeps callers from depending on the
     # order PaperTrail happens to give its versions association, which a caller
     # is also free to reorder.
     #: (untyped) -> untyped
     def resolve(boundary)
       return boundary unless symbolic?(boundary)
+      raise InvalidTimelineRangeError, LAST_REMOVED if boundary == :last
 
       unless BOUNDARY_SYMBOLS.include?(boundary)
         raise InvalidTimelineRangeError,
-              "unsupported boundary: #{boundary.inspect}; use :first, :last, a version, or a record"
+              "unsupported boundary: #{boundary.inspect}; use :first, a version, or a record"
       end
 
-      boundary == :first ? ordered_versions.first : ordered_versions.last
+      ordered_versions.first
     end
 
     #: () -> untyped
     def ordered_versions
-      versions_relation.reorder(created_at: :asc, id: :asc)
-    end
-
-    #: () -> untyped
-    def versions_relation
-      @record.public_send(@record.class.versions_association_name)
-    rescue NoMethodError => e
-      message = 'record does not expose a PaperTrail version history'
-      raise InvalidTimelineRangeError, message, cause: e
+      Endpoint.versions(@record).reorder(created_at: :asc, id: :asc)
     end
 
     #: (untyped) -> TimeRange?

data/lib/paper_trail_diff/timeline_snapshot_provider.rb

@@ -8,10 +8,15 @@ module PaperTrailDiff
     def initialize(store, live_snapshotter:)
       @store = store
       @live_snapshotter = live_snapshotter
+      @snapshots = {} #: Hash[Array[untyped], RecordSnapshot?]
     end
 
     #: (untyped, Array[untyped]) -> void
     def prepare(record, versions)
+      # Adjacent steps share endpoints. Keep their immutable snapshots for this
+      # root only, including nil create states, and release them before the next
+      # root so batch memory does not retain every reconstructed graph.
+      @snapshots.clear
       @store.prepare(record, versions)
     end
 
@@ -19,9 +24,14 @@ module PaperTrailDiff
     # version, which is the one endpoint no version history can reconstruct.
     #: (untyped) -> RecordSnapshot?
     def call(endpoint)
-      return live_snapshot(endpoint) if Endpoint.record?(endpoint)
+      key = [endpoint.class.name, endpoint.id]
+      return @snapshots[key] if @snapshots.key?(key)
 
-      @store.uncached(endpoint, endpoint)
+      @snapshots[key] = if Endpoint.record?(endpoint)
+                          live_snapshot(endpoint)
+                        else
+                          @store.uncached(endpoint, endpoint)
+                        end
     end
 
     private
@@ -33,5 +43,6 @@ module PaperTrailDiff
 
     # @rbs @store: HistoricalSnapshotStore
     # @rbs @live_snapshotter: untyped
+    # @rbs @snapshots: Hash[Array[untyped], RecordSnapshot?]
   end
 end

data/lib/paper_trail_diff/traversal.rb

@@ -73,7 +73,7 @@ module PaperTrailDiff
     def each_change(&receiver)
       return enum_for(:each_change) unless receiver
 
-      each_entry { |entry| receiver.call(entry) if entry.change? }
+      each_entry { |entry| yield(entry) if entry.change? }
       self
     end
   end

data/lib/paper_trail_diff/value_objects.rb

@@ -20,6 +20,72 @@ module PaperTrailDiff
     end
   end
 
+  # A change to an array inside a value the database stores whole, reported by
+  # membership rather than by position.
+  #
+  # Position would be the obvious thing to report and the wrong one: elements
+  # here carry no identity, so inserting at the front makes every later index
+  # look changed, and one insertion is described as several edits. Membership is
+  # answerable without claiming any pairing -- "gained \"saturn v\"" is true
+  # whether the array is a set, a queue, or a ranked list.
+  #
+  # That leaves one case membership cannot see, so it is named rather than
+  # hidden: the same elements in a different order. `reordered?` says so.
+  #
+  # An element that is itself a Hash or Array is reported whole. Saying which
+  # field of which object changed would require pairing before-elements with
+  # after-elements, and nothing in the value licenses that pairing.
+  class ArrayChange
+    attr_reader :from #: Array[untyped]
+    attr_reader :to #: Array[untyped]
+    attr_reader :added #: Array[untyped]
+    attr_reader :removed #: Array[untyped]
+
+    #: (from: Array[untyped], to: Array[untyped]) -> void
+    def initialize(from:, to:)
+      @from = Support.immutable_copy(from)
+      @to = Support.immutable_copy(to)
+      @added = Support.immutable_copy(ArrayChange.surplus(to, from))
+      @removed = Support.immutable_copy(ArrayChange.surplus(from, to))
+      freeze
+    end
+
+    # Elements of `left` with no counterpart left in `right`, matching by value
+    # and respecting duplicates, so ["a", "a"] -> ["a"] reports one removal
+    # rather than none.
+    #: (Array[untyped], Array[untyped]) -> Array[untyped]
+    def self.surplus(left, right)
+      pool = right.dup
+      left.reject do |item|
+        index = pool.index(item)
+        index ? pool.delete_at(index) || true : false
+      end
+    end
+
+    # Same elements, different sequence. Only meaningful for a change that was
+    # recorded at all, which this only is when the two sides differ.
+    #: () -> bool
+    def reordered?
+      added.empty? && removed.empty?
+    end
+
+    #: () -> bool
+    def empty?
+      from == to
+    end
+
+    #: () -> Hash[Symbol, untyped]
+    def to_h
+      {
+        from: Support.serialize(from),
+        to: Support.serialize(to),
+        added: Support.serialize(added),
+        removed: Support.serialize(removed),
+        reordered: reordered?
+      }
+    end
+  end
+
   # Attribute and nested-association changes for a record whose identity did not change.
   class RecordChange
     attr_reader :record #: RecordReference

data/lib/paper_trail_diff/version.rb

@@ -2,5 +2,5 @@
 # rbs_inline: enabled
 
 module PaperTrailDiff
-  VERSION = '0.11.0'
+  VERSION = '0.13.0'
 end

data/lib/paper_trail_diff/version_association_candidate_scope.rb

@@ -32,7 +32,7 @@ module PaperTrailDiff
     def with_connection(&block)
       return @version_class.with_connection(&block) if @version_class.respond_to?(:with_connection)
 
-      block.call(@version_class.connection)
+      yield(@version_class.connection)
     end
 
     #: () -> String

data/lib/paper_trail_diff/version_boundary.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+module PaperTrailDiff
+  # Places one version relative to another on the recorded timeline.
+  module VersionBoundary
+    module_function
+
+    # Whether `candidate` was recorded at or after `boundary`. Versions sharing
+    # a timestamp are ordered by id, which reflects insertion order only for
+    # sequential ids in one version table; any other tie cannot be ordered, and
+    # guessing would place a change on an arbitrary side of the boundary. A
+    # bare instant has no position among same-time versions, so it keeps them.
+    #: (untyped, untyped) -> bool
+    def at_or_after?(candidate, boundary)
+      tied = candidate.created_at == boundary.created_at
+      return candidate.created_at > boundary.created_at unless tied
+      return true unless version_record?(boundary)
+      return true if same_version?(candidate, boundary)
+
+      unless orderable_tie?(candidate, boundary)
+        raise AmbiguousVersionOrderError, Support.ambiguous_message([boundary, candidate])
+      end
+
+      Support.compare_versions(candidate, boundary) >= 0
+    end
+
+    #: (untyped) -> bool
+    def version_record?(value)
+      value.respond_to?(:id) && value.respond_to?(:item_type) &&
+        value.class.respond_to?(:table_name)
+    end
+    private_class_method :version_record?
+
+    #: (untyped, untyped) -> bool
+    def same_version?(left, right)
+      left.class.table_name == right.class.table_name && left.id.to_s == right.id.to_s
+    end
+    private_class_method :same_version?
+
+    #: (untyped, untyped) -> bool
+    def orderable_tie?(left, right)
+      left.class.table_name == right.class.table_name &&
+        Support.sequential_id?(left.id) && Support.sequential_id?(right.id)
+    end
+    private_class_method :orderable_tie?
+  end
+end

data/lib/paper_trail_diff/version_query.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+module PaperTrailDiff
+  # Arel conditions shared by the version queries that need one row per item.
+  module VersionQuery
+    module_function
+
+    # Keeps each item's earliest version among those the block also accepts:
+    # no other version of the same item that the block accepts is earlier. A
+    # correlated NOT EXISTS stays portable where window functions are not.
+    #: (untyped) ?{ (untyped) -> untyped } -> untyped
+    def no_earlier_version(table, &block)
+      arel = Object.const_get(:Arel) #: untyped
+      earlier = table.alias('paper_trail_diff_earlier_versions')
+      arel.const_get(:SelectManager).new
+          .from(earlier)
+          .project(arel.sql('1'))
+          .where(earlier_version(table, earlier, &block))
+          .exists
+          .not
+    end
+
+    #: (untyped, untyped) ?{ (untyped) -> untyped } -> untyped
+    def earlier_version(table, earlier)
+      same_item = earlier[:item_type].eq(table[:item_type])
+                                     .and(earlier[:item_id].eq(table[:item_id]))
+                                     .and(earlier[:created_at].lt(table[:created_at]))
+      block_given? ? same_item.and(yield(earlier)) : same_item
+    end
+    private_class_method :earlier_version
+  end
+end

data/lib/paper_trail_diff/version_range.rb

@@ -12,7 +12,7 @@ module PaperTrailDiff
       @version_scope = version_scope
     end
 
-    # Same selection as `select`, but keeping the step pairs a filter implies.
+    # Keep both reconstruction boundaries and the step pairs a filter implies.
     #: () -> RootVersionPlan
     def select_plan_for_range
       relation = validated_relation
@@ -24,7 +24,7 @@ module PaperTrailDiff
 
     #: () -> untyped
     def validated_relation
-      relation = versions_relation
+      relation = Endpoint.versions(@record)
       validate_boundary!(@from, relation, boundary: :from)
       validate_boundary!(@to, relation, boundary: :to)
       if Support.compare_versions(@from, @to).positive?
@@ -34,26 +34,12 @@ module PaperTrailDiff
       relation
     end
 
-    #: () -> Array[untyped]
-    def select
-      relation = versions_relation
+    #: (untyped) -> RootVersionPlan
+    def select_plan_through_current(current)
+      Endpoint.validate_pair!(@record, current)
+      relation = Endpoint.versions(@record)
       validate_boundary!(@from, relation, boundary: :from)
-      validate_boundary!(@to, relation, boundary: :to)
-      if Support.compare_versions(@from, @to).positive?
-        raise InvalidTimelineRangeError, '`from` version must not follow `to` version'
-      end
-
-      select_relation(
-        relation.where(created_at: @from.created_at..@to.created_at),
-        through: @to
-      )
-    end
-
-    #: () -> Array[untyped]
-    def select_through_latest
-      relation = versions_relation
-      validate_boundary!(@from, relation, boundary: :from)
-      select_relation(relation.where(created_at: @from.created_at..))
+      select_plan(relation.where(created_at: @from.created_at..), live_endpoint: current)
     end
 
     private
@@ -63,22 +49,8 @@ module PaperTrailDiff
     # @rbs @to: untyped
     # @rbs @version_scope: untyped
 
-    #: () -> untyped
-    def versions_relation
-      association_name = @record.class.versions_association_name
-      @record.public_send(association_name)
-    rescue NoMethodError => e
-      message = 'record does not expose a PaperTrail version history'
-      raise InvalidTimelineRangeError, message, cause: e
-    end
-
-    #: (untyped, ?through: untyped) -> Array[untyped]
-    def select_relation(relation, through: nil)
-      select_plan(relation, through: through).versions
-    end
-
-    #: (untyped, ?through: untyped) -> RootVersionPlan
-    def select_plan(relation, through: nil)
+    #: (untyped, ?through: untyped, ?live_endpoint: untyped) -> RootVersionPlan
+    def select_plan(relation, through: nil, live_endpoint: nil)
       in_range = ordered(relation.to_a.select do |version|
         next false if Support.compare_versions(@from, version).positive?
         next true unless through
@@ -90,7 +62,7 @@ module PaperTrailDiff
         selected: VersionScopeFilter.new(@version_scope).call(relation, in_range),
         after_range: nil,
         windowed: false,
-        filtered: !@version_scope.nil?
+        filtered: !@version_scope.nil?, live_endpoint: live_endpoint
       ).call
     end