paper_trail_diff 0.15.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +724 -1
- data/README.md +43 -8
- data/docs/architecture.md +7 -5
- data/docs/performance.md +89 -32
- data/docs/reference.md +427 -96
- data/docs/testing.md +260 -32
- data/lib/paper_trail_diff/activity_belongs_to_event_applier.rb +2 -16
- data/lib/paper_trail_diff/activity_boundary.rb +55 -34
- data/lib/paper_trail_diff/activity_child_candidate_loader.rb +46 -57
- data/lib/paper_trail_diff/activity_collection_event_applier.rb +33 -11
- data/lib/paper_trail_diff/activity_collection_route_updater.rb +1 -1
- data/lib/paper_trail_diff/activity_event.rb +33 -21
- data/lib/paper_trail_diff/activity_event_record_resolver.rb +16 -116
- data/lib/paper_trail_diff/activity_event_route_finder.rb +49 -18
- data/lib/paper_trail_diff/activity_event_snapshot_refresher.rb +13 -7
- data/lib/paper_trail_diff/activity_history.rb +90 -49
- data/lib/paper_trail_diff/activity_range.rb +9 -35
- data/lib/paper_trail_diff/activity_root_snapshot_refresher.rb +104 -52
- data/lib/paper_trail_diff/activity_root_steps.rb +10 -13
- data/lib/paper_trail_diff/activity_scope_filter.rb +77 -0
- data/lib/paper_trail_diff/activity_snapshot_delta.rb +12 -15
- data/lib/paper_trail_diff/activity_snapshot_sequence.rb +37 -15
- data/lib/paper_trail_diff/activity_target_candidate_loader.rb +35 -43
- data/lib/paper_trail_diff/activity_timeline_builder.rb +200 -249
- data/lib/paper_trail_diff/activity_transaction_grouper.rb +3 -1
- data/lib/paper_trail_diff/activity_tree_filter.rb +54 -13
- data/lib/paper_trail_diff/activity_version_collector.rb +72 -138
- data/lib/paper_trail_diff/activity_view.rb +22 -11
- data/lib/paper_trail_diff/analysis.rb +39 -6
- data/lib/paper_trail_diff/analysis_batch.rb +16 -58
- data/lib/paper_trail_diff/approximate_paths.rb +4 -8
- data/lib/paper_trail_diff/association_activity_edge.rb +5 -24
- data/lib/paper_trail_diff/association_activity_selection.rb +10 -18
- data/lib/paper_trail_diff/association_discovery.rb +1 -6
- data/lib/paper_trail_diff/association_key.rb +9 -6
- data/lib/paper_trail_diff/association_traversal.rb +49 -6
- data/lib/paper_trail_diff/batch_boundary_resolver.rb +33 -42
- data/lib/paper_trail_diff/batch_preload.rb +2 -12
- data/lib/paper_trail_diff/batched_root_analyses.rb +72 -0
- data/lib/paper_trail_diff/batched_root_analyzer.rb +22 -14
- data/lib/paper_trail_diff/batched_root_versions.rb +25 -20
- data/lib/paper_trail_diff/branch_snapshot_refresher.rb +41 -42
- data/lib/paper_trail_diff/change_attribution.rb +314 -0
- data/lib/paper_trail_diff/change_row.rb +30 -10
- data/lib/paper_trail_diff/comparison_batch.rb +3 -4
- data/lib/paper_trail_diff/configuration.rb +1 -1
- data/lib/paper_trail_diff/deleted_analysis_batch.rb +22 -33
- data/lib/paper_trail_diff/deleted_root_filter.rb +29 -10
- data/lib/paper_trail_diff/deprecation.rb +4 -43
- data/lib/paper_trail_diff/diagnostics.rb +8 -7
- data/lib/paper_trail_diff/direct_record_state_loader.rb +8 -1
- data/lib/paper_trail_diff/endpoint.rb +78 -44
- data/lib/paper_trail_diff/errors.rb +2 -9
- data/lib/paper_trail_diff/fallback_paths.rb +2 -5
- data/lib/paper_trail_diff/habtm_transaction_owners.rb +5 -3
- data/lib/paper_trail_diff/historical_association_reifier.rb +3 -1
- data/lib/paper_trail_diff/historical_filter.rb +40 -15
- data/lib/paper_trail_diff/historical_snapshot_store.rb +80 -38
- data/lib/paper_trail_diff/instrumentation.rb +0 -8
- data/lib/paper_trail_diff/live_endpoint_batch_loader.rb +11 -7
- data/lib/paper_trail_diff/live_endpoint_provider.rb +7 -23
- data/lib/paper_trail_diff/live_graph_collector.rb +3 -3
- data/lib/paper_trail_diff/nested_comparator.rb +46 -19
- data/lib/paper_trail_diff/net_change.rb +276 -0
- data/lib/paper_trail_diff/own_window.rb +35 -0
- data/lib/paper_trail_diff/paper_trail_adapter.rb +119 -87
- data/lib/paper_trail_diff/prepared_activity_index.rb +182 -50
- data/lib/paper_trail_diff/prepared_child_candidates.rb +58 -0
- data/lib/paper_trail_diff/prepared_edge_loader.rb +43 -107
- data/lib/paper_trail_diff/prepared_history.rb +31 -36
- data/lib/paper_trail_diff/prepared_history_loader.rb +47 -12
- data/lib/paper_trail_diff/prepared_record_index.rb +143 -49
- data/lib/paper_trail_diff/prepared_snapshot_builder.rb +16 -0
- data/lib/paper_trail_diff/prepared_state_association_reader.rb +17 -19
- data/lib/paper_trail_diff/read_snapshot.rb +99 -0
- data/lib/paper_trail_diff/recorded_changes.rb +10 -11
- data/lib/paper_trail_diff/recorded_changes_reader.rb +60 -0
- data/lib/paper_trail_diff/recorded_class.rb +14 -19
- data/lib/paper_trail_diff/recorded_columns.rb +33 -0
- data/lib/paper_trail_diff/root_version_plan.rb +20 -22
- data/lib/paper_trail_diff/root_version_selection.rb +39 -29
- data/lib/paper_trail_diff/scope_condition.rb +92 -32
- data/lib/paper_trail_diff/scope_ranking.rb +27 -34
- data/lib/paper_trail_diff/scoped_analysis.rb +27 -4
- data/lib/paper_trail_diff/scoped_analysis_builder.rb +18 -7
- data/lib/paper_trail_diff/scoped_root_selection.rb +65 -39
- data/lib/paper_trail_diff/snapshot_normalizer.rb +18 -3
- data/lib/paper_trail_diff/stored_json_values.rb +52 -0
- data/lib/paper_trail_diff/stored_time_precision.rb +30 -18
- data/lib/paper_trail_diff/stored_values.rb +20 -0
- data/lib/paper_trail_diff/support.rb +185 -35
- data/lib/paper_trail_diff/time_of_day.rb +39 -0
- data/lib/paper_trail_diff/time_range.rb +40 -22
- data/lib/paper_trail_diff/time_version_range.rb +5 -10
- data/lib/paper_trail_diff/timeline_builder.rb +9 -3
- data/lib/paper_trail_diff/timeline_range.rb +18 -12
- data/lib/paper_trail_diff/timeline_snapshot_provider.rb +1 -1
- data/lib/paper_trail_diff/total_order.rb +55 -0
- data/lib/paper_trail_diff/transaction_cut.rb +235 -75
- data/lib/paper_trail_diff/traversal_preparer.rb +5 -8
- data/lib/paper_trail_diff/value_objects.rb +8 -4
- data/lib/paper_trail_diff/version.rb +1 -1
- data/lib/paper_trail_diff/version_association_candidate_scope.rb +1 -12
- data/lib/paper_trail_diff/version_boundary.rb +41 -23
- data/lib/paper_trail_diff/version_query.rb +25 -25
- data/lib/paper_trail_diff/version_range.rb +12 -16
- data/lib/paper_trail_diff/version_sequence_diagnostics.rb +36 -1
- data/lib/paper_trail_diff/version_table.rb +12 -8
- data/lib/paper_trail_diff.rb +32 -44
- data/sig/generated/paper_trail_diff/activity_belongs_to_event_applier.rbs +0 -8
- data/sig/generated/paper_trail_diff/activity_boundary.rbs +39 -17
- data/sig/generated/paper_trail_diff/activity_child_candidate_loader.rbs +19 -22
- data/sig/generated/paper_trail_diff/activity_collection_event_applier.rbs +13 -5
- data/sig/generated/paper_trail_diff/activity_event.rbs +25 -9
- data/sig/generated/paper_trail_diff/activity_event_record_resolver.rbs +6 -34
- data/sig/generated/paper_trail_diff/activity_event_route_finder.rbs +25 -4
- data/sig/generated/paper_trail_diff/activity_event_snapshot_refresher.rbs +6 -3
- data/sig/generated/paper_trail_diff/activity_history.rbs +54 -19
- data/sig/generated/paper_trail_diff/activity_range.rbs +6 -20
- data/sig/generated/paper_trail_diff/activity_root_snapshot_refresher.rbs +55 -10
- data/sig/generated/paper_trail_diff/activity_root_steps.rbs +6 -6
- data/sig/generated/paper_trail_diff/activity_scope_filter.rbs +51 -0
- data/sig/generated/paper_trail_diff/activity_snapshot_delta.rbs +5 -3
- data/sig/generated/paper_trail_diff/activity_snapshot_sequence.rbs +21 -3
- data/sig/generated/paper_trail_diff/activity_target_candidate_loader.rbs +19 -24
- data/sig/generated/paper_trail_diff/activity_timeline_builder.rbs +125 -127
- data/sig/generated/paper_trail_diff/activity_tree_filter.rbs +41 -8
- data/sig/generated/paper_trail_diff/activity_version_collector.rbs +42 -35
- data/sig/generated/paper_trail_diff/activity_view.rbs +16 -8
- data/sig/generated/paper_trail_diff/analysis.rbs +26 -5
- data/sig/generated/paper_trail_diff/analysis_batch.rbs +6 -24
- data/sig/generated/paper_trail_diff/association_activity_edge.rbs +0 -13
- data/sig/generated/paper_trail_diff/association_activity_selection.rbs +6 -9
- data/sig/generated/paper_trail_diff/association_discovery.rbs +0 -3
- data/sig/generated/paper_trail_diff/association_key.rbs +5 -0
- data/sig/generated/paper_trail_diff/association_traversal.rbs +26 -2
- data/sig/generated/paper_trail_diff/batch_boundary_resolver.rbs +17 -17
- data/sig/generated/paper_trail_diff/batch_preload.rbs +0 -4
- data/sig/generated/paper_trail_diff/batched_root_analyses.rbs +47 -0
- data/sig/generated/paper_trail_diff/batched_root_analyzer.rbs +13 -8
- data/sig/generated/paper_trail_diff/batched_root_versions.rbs +10 -6
- data/sig/generated/paper_trail_diff/branch_snapshot_refresher.rbs +16 -4
- data/sig/generated/paper_trail_diff/change_attribution.rbs +185 -0
- data/sig/generated/paper_trail_diff/change_row.rbs +22 -7
- data/sig/generated/paper_trail_diff/deleted_analysis_batch.rbs +11 -9
- data/sig/generated/paper_trail_diff/deleted_root_filter.rbs +9 -3
- data/sig/generated/paper_trail_diff/deprecation.rbs +4 -24
- data/sig/generated/paper_trail_diff/direct_record_state_loader.rbs +4 -0
- data/sig/generated/paper_trail_diff/endpoint.rbs +40 -16
- data/sig/generated/paper_trail_diff/errors.rbs +2 -11
- data/sig/generated/paper_trail_diff/habtm_transaction_owners.rbs +2 -1
- data/sig/generated/paper_trail_diff/historical_filter.rbs +20 -9
- data/sig/generated/paper_trail_diff/historical_snapshot_store.rbs +40 -10
- data/sig/generated/paper_trail_diff/instrumentation.rbs +0 -3
- data/sig/generated/paper_trail_diff/live_endpoint_batch_loader.rbs +3 -0
- data/sig/generated/paper_trail_diff/live_endpoint_provider.rbs +5 -8
- data/sig/generated/paper_trail_diff/live_graph_collector.rbs +2 -2
- data/sig/generated/paper_trail_diff/nested_comparator.rbs +20 -4
- data/sig/generated/paper_trail_diff/net_change.rbs +168 -0
- data/sig/generated/paper_trail_diff/own_window.rbs +22 -0
- data/sig/generated/paper_trail_diff/paper_trail_adapter.rbs +19 -6
- data/sig/generated/paper_trail_diff/prepared_activity_index.rbs +113 -17
- data/sig/generated/paper_trail_diff/prepared_child_candidates.rbs +39 -0
- data/sig/generated/paper_trail_diff/prepared_edge_loader.rbs +18 -35
- data/sig/generated/paper_trail_diff/prepared_history.rbs +15 -13
- data/sig/generated/paper_trail_diff/prepared_history_loader.rbs +28 -3
- data/sig/generated/paper_trail_diff/prepared_record_index.rbs +70 -15
- data/sig/generated/paper_trail_diff/prepared_snapshot_builder.rbs +12 -0
- data/sig/generated/paper_trail_diff/prepared_state_association_reader.rbs +6 -7
- data/sig/generated/paper_trail_diff/read_snapshot.rbs +62 -0
- data/sig/generated/paper_trail_diff/recorded_changes.rbs +4 -2
- data/sig/generated/paper_trail_diff/recorded_changes_reader.rbs +41 -0
- data/sig/generated/paper_trail_diff/recorded_class.rbs +7 -6
- data/sig/generated/paper_trail_diff/recorded_columns.rbs +21 -0
- data/sig/generated/paper_trail_diff/root_version_plan.rbs +8 -4
- data/sig/generated/paper_trail_diff/root_version_selection.rbs +27 -13
- data/sig/generated/paper_trail_diff/scope_condition.rbs +39 -9
- data/sig/generated/paper_trail_diff/scope_ranking.rbs +16 -16
- data/sig/generated/paper_trail_diff/scoped_analysis.rbs +19 -0
- data/sig/generated/paper_trail_diff/scoped_analysis_builder.rbs +9 -2
- data/sig/generated/paper_trail_diff/scoped_root_selection.rbs +40 -12
- data/sig/generated/paper_trail_diff/snapshot_normalizer.rbs +7 -0
- data/sig/generated/paper_trail_diff/stored_json_values.rbs +35 -0
- data/sig/generated/paper_trail_diff/stored_time_precision.rbs +19 -5
- data/sig/generated/paper_trail_diff/stored_values.rbs +13 -0
- data/sig/generated/paper_trail_diff/support.rbs +120 -23
- data/sig/generated/paper_trail_diff/time_of_day.rbs +21 -0
- data/sig/generated/paper_trail_diff/time_range.rbs +15 -7
- data/sig/generated/paper_trail_diff/time_version_range.rbs +2 -5
- data/sig/generated/paper_trail_diff/timeline_builder.rbs +6 -2
- data/sig/generated/paper_trail_diff/timeline_range.rbs +12 -7
- data/sig/generated/paper_trail_diff/total_order.rbs +32 -0
- data/sig/generated/paper_trail_diff/transaction_cut.rbs +131 -40
- data/sig/generated/paper_trail_diff/traversal_preparer.rbs +2 -2
- data/sig/generated/paper_trail_diff/value_objects.rbs +5 -1
- data/sig/generated/paper_trail_diff/version_association_candidate_scope.rbs +0 -7
- data/sig/generated/paper_trail_diff/version_boundary.rbs +17 -8
- data/sig/generated/paper_trail_diff/version_query.rbs +17 -10
- data/sig/generated/paper_trail_diff/version_range.rbs +6 -9
- data/sig/generated/paper_trail_diff/version_sequence_diagnostics.rbs +16 -0
- data/sig/generated/paper_trail_diff/version_table.rbs +3 -0
- data/sig/generated/paper_trail_diff.rbs +16 -16
- metadata +31 -7
- data/lib/paper_trail_diff/preloaded_endpoint_batch_loader.rb +0 -60
- data/sig/generated/paper_trail_diff/preloaded_endpoint_batch_loader.rbs +0 -32
|
@@ -10,38 +10,47 @@ module PaperTrailDiff
|
|
|
10
10
|
# window reports only the events inside it, and closes on a final destroy,
|
|
11
11
|
# or on the live row when nothing recorded follows it.
|
|
12
12
|
class ActivityTimelineBuilder # rubocop:disable Metrics/ClassLength
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
# `traversal` holds the tree and reads its reflections; the adapter passes
|
|
14
|
+
# the one it reads every root with, so they are resolved once for a call
|
|
15
|
+
# rather than once for each root.
|
|
16
|
+
#: (untyped, range: TimelineRange, snapshotter: untyped, view: ActivityView, traversal: AssociationTraversal) -> void
|
|
17
|
+
def initialize(record, range:, snapshotter:, view:, traversal:)
|
|
15
18
|
@view = view
|
|
16
19
|
@record = record
|
|
17
20
|
@to = range.to
|
|
18
21
|
@range = range
|
|
19
|
-
@tree = tree
|
|
22
|
+
@tree = traversal.tree
|
|
23
|
+
@traversal = traversal
|
|
20
24
|
@snapshotter = snapshotter
|
|
25
|
+
# The root's own activity reads a version filter's answers from the plan.
|
|
26
|
+
@filter = (view.version_filter unless @tree.empty?)
|
|
21
27
|
end
|
|
22
28
|
|
|
23
29
|
#: () -> Array[ActivityStep]
|
|
24
30
|
def build
|
|
25
|
-
return
|
|
31
|
+
return steps_of(window_replay) if @range.time?
|
|
26
32
|
return no_steps if @range.unresolved?
|
|
27
|
-
return
|
|
33
|
+
return steps_of(current_replay) if Endpoint.record?(@to)
|
|
28
34
|
|
|
29
35
|
Endpoint.validate!(@to)
|
|
30
|
-
|
|
36
|
+
steps_of(version_replay)
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# The window the range covers once its edges have moved to transactions.
|
|
40
|
+
#: () -> TimeRange?
|
|
41
|
+
def window
|
|
42
|
+
@range.time_range
|
|
31
43
|
end
|
|
32
44
|
|
|
33
45
|
# Builds the endpoint diff, the root timeline, and the activity from one
|
|
34
46
|
# activity snapshot pass.
|
|
35
47
|
#: () -> Analysis
|
|
36
48
|
def analyze
|
|
37
|
-
return
|
|
49
|
+
return analysis(window_replay) if @range.time?
|
|
38
50
|
return Analysis.empty if @range.unresolved?
|
|
39
|
-
return
|
|
40
|
-
|
|
41
|
-
plan = @range.select_plan
|
|
42
|
-
return Analysis.empty if plan.empty?
|
|
51
|
+
return analysis(current_replay) if Endpoint.record?(@to)
|
|
43
52
|
|
|
44
|
-
|
|
53
|
+
analysis(version_replay)
|
|
45
54
|
end
|
|
46
55
|
|
|
47
56
|
private
|
|
@@ -50,8 +59,10 @@ module PaperTrailDiff
|
|
|
50
59
|
# @rbs @to: untyped
|
|
51
60
|
# @rbs @range: TimelineRange
|
|
52
61
|
# @rbs @tree: AssociationTree
|
|
62
|
+
# @rbs @traversal: AssociationTraversal
|
|
53
63
|
# @rbs @snapshotter: untyped
|
|
54
64
|
# @rbs @view: ActivityView
|
|
65
|
+
# @rbs @filter: ActivityScopeFilter?
|
|
55
66
|
|
|
56
67
|
#: () -> Array[ActivityStep]
|
|
57
68
|
def no_steps
|
|
@@ -59,77 +70,109 @@ module PaperTrailDiff
|
|
|
59
70
|
steps.freeze
|
|
60
71
|
end
|
|
61
72
|
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#: () -> Array[ActivityStep]
|
|
68
|
-
def
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
root_versions = plan.reconstruction_versions
|
|
73
|
-
activity_steps(version_history(root_versions), destroyed_boundary(root_versions), nil)
|
|
73
|
+
# Each kind of range replays into the same things, or into nil when it
|
|
74
|
+
# reports no step: its plan and history, the steps it reports, ending with
|
|
75
|
+
# the one that closes the range after its last event, the state it ends
|
|
76
|
+
# at, and the live record's snapshot and when it was read, which the root
|
|
77
|
+
# timeline's closing step reads.
|
|
78
|
+
#: (RootVersionPlan, ActivityHistory, ActivityStep?, RecordSnapshot?, ?RecordSnapshot?, ?untyped) -> [RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?
|
|
79
|
+
def replayed(plan, history, closing, final, snapshot = nil, captured_at = nil) # rubocop:disable Metrics/ParameterLists
|
|
80
|
+
steps = closing ? history.steps + [closing] : history.steps
|
|
81
|
+
[plan, history, steps, final, snapshot, captured_at] unless steps.empty?
|
|
74
82
|
end
|
|
75
83
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
snapshots = prepare_history(root_versions)
|
|
80
|
-
events = collect_events(root_versions, snapshots, range_end: root_versions.last)
|
|
81
|
-
replay(root_versions, events, snapshots)
|
|
84
|
+
#: ([RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?) -> Array[ActivityStep]
|
|
85
|
+
def steps_of(replay)
|
|
86
|
+
replay ? present(replay.fetch(2)) : no_steps
|
|
82
87
|
end
|
|
83
88
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
89
|
+
# A range that reports no step is empty, whatever its replay read: a
|
|
90
|
+
# version filter may keep nothing in it, or only the version that ends it,
|
|
91
|
+
# which opens no step, and a range may run from a version to itself.
|
|
92
|
+
#: ([RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?) -> Analysis
|
|
93
|
+
def analysis(replay)
|
|
94
|
+
return Analysis.empty unless replay
|
|
95
|
+
|
|
96
|
+
plan, history, steps, final, snapshot, captured_at = replay
|
|
97
|
+
Analysis.new(
|
|
98
|
+
diff: Engine.compare(history.first_snapshot, final),
|
|
99
|
+
timeline: ActivityRootSteps.call(plan, history.root_snapshots, closing_snapshot: snapshot,
|
|
100
|
+
captured_at: captured_at),
|
|
101
|
+
activity_timeline: present(steps),
|
|
102
|
+
from_snapshot: history.first_snapshot,
|
|
103
|
+
to_snapshot: final
|
|
104
|
+
)
|
|
88
105
|
end
|
|
89
106
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
107
|
+
# Every boundary between the endpoints, filtered out or not: dropping one
|
|
108
|
+
# would fold the change it carried into a neighbouring step and credit it
|
|
109
|
+
# to whoever made that one. A version filter decides only which of the
|
|
110
|
+
# steps are reported (see #reported?). Only the activity view gains the
|
|
111
|
+
# closing removal. The endpoint diff and the root timeline keep their
|
|
112
|
+
# `compare` and `timeline` semantics, under which the state at a destroy
|
|
113
|
+
# version is the state before the deletion.
|
|
114
|
+
#: () -> [RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?
|
|
115
|
+
def version_replay
|
|
116
|
+
plan = select_plan
|
|
117
|
+
history = history_until(plan)
|
|
118
|
+
replayed(plan, history, closing_step(history, plan), history.last_snapshot)
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Activity replays every root version in the range, even those a version
|
|
122
|
+
# filter leaves out, so that each change it keeps is read as the whole
|
|
123
|
+
# history shows it. Only a window reads a context: an explicit range
|
|
124
|
+
# always holds a version.
|
|
125
|
+
#: () -> RootVersionPlan
|
|
126
|
+
def select_plan = @range.select_plan(context_required: !@tree.empty?, whole: true)
|
|
127
|
+
|
|
128
|
+
# Whether the event's step is reported: it is inside the range, and a
|
|
129
|
+
# version filter keeps it. With associations the filter keeps whole
|
|
130
|
+
# transactions (see ActivityScopeFilter). On the root alone it keeps the
|
|
131
|
+
# root's versions, as `timeline` does, and so does a plan without one, but
|
|
132
|
+
# for the version it holds only to reveal the last change in it.
|
|
133
|
+
#: (ActivityEvent, RootVersionPlan) -> bool
|
|
134
|
+
def reported?(event, plan)
|
|
135
|
+
return false unless @range.include?(event.version)
|
|
136
|
+
|
|
137
|
+
filter = @filter
|
|
138
|
+
filter ? filter.kept?(event.version) : !event.root? || plan.mutation?(event.version)
|
|
96
139
|
end
|
|
97
140
|
|
|
98
141
|
# The explicit live endpoint and a batch's live closing endpoint use the
|
|
99
|
-
# same selected plan
|
|
100
|
-
|
|
101
|
-
|
|
142
|
+
# same selected plan, which replays every version through to the current
|
|
143
|
+
# record, a version filter or not.
|
|
144
|
+
#: () -> [RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?
|
|
145
|
+
def current_replay
|
|
102
146
|
validate_current_range!
|
|
103
|
-
plan =
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
snapshot, captured_at = capture_current if plan.closing_record
|
|
147
|
+
plan = select_plan
|
|
148
|
+
snapshot, captured_at = capture_current
|
|
107
149
|
history = history_until(plan, snapshot, captured_at)
|
|
108
|
-
|
|
109
|
-
[plan, history, snapshot, boundary]
|
|
150
|
+
live_replay(plan, history, @to, captured_at, snapshot)
|
|
110
151
|
end
|
|
111
152
|
|
|
112
|
-
#
|
|
113
|
-
#
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
153
|
+
# A range that closes after its last event ends at what closed it: the
|
|
154
|
+
# live row, or nothing after a destroy, where no live row is read. One
|
|
155
|
+
# that does not ends at the state its last reported step reached.
|
|
156
|
+
#: (RootVersionPlan, ActivityHistory, untyped, untyped, RecordSnapshot?) -> [RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?
|
|
157
|
+
def live_replay(plan, history, live, captured_at, snapshot)
|
|
158
|
+
closing = closing_step(history, plan, live, captured_at, snapshot)
|
|
159
|
+
replayed(plan, history, closing, closing ? snapshot : history.last_snapshot, snapshot,
|
|
160
|
+
captured_at)
|
|
120
161
|
end
|
|
121
162
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
def empty_history(plan)
|
|
127
|
-
[plan, ActivityHistory.empty, nil, nil]
|
|
163
|
+
#: (RootVersionPlan, ?RecordSnapshot?, ?untyped) -> ActivityHistory
|
|
164
|
+
def history_until(plan, snapshot = nil, captured_at = nil)
|
|
165
|
+
events, snapshots = range_events(plan, captured_at)
|
|
166
|
+
replay(plan, events, snapshots, current: plan.closing_record, closing: snapshot)
|
|
128
167
|
end
|
|
129
168
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
169
|
+
# The range's events up to its last root version, or to the instant the
|
|
170
|
+
# live record it closes on was read, with the history they are read from.
|
|
171
|
+
#: (RootVersionPlan, untyped) -> [Array[ActivityEvent], untyped]
|
|
172
|
+
def range_events(plan, captured_at)
|
|
173
|
+
versions = plan.reconstruction_versions
|
|
174
|
+
snapshots = prepare_history(versions, end_at: captured_at)
|
|
175
|
+
[collect_events(versions, snapshots, range_end: captured_at || versions.last), snapshots]
|
|
133
176
|
end
|
|
134
177
|
|
|
135
178
|
#: () -> [RecordSnapshot?, untyped]
|
|
@@ -147,178 +190,88 @@ module PaperTrailDiff
|
|
|
147
190
|
reject_live_habtm!
|
|
148
191
|
end
|
|
149
192
|
|
|
150
|
-
#
|
|
151
|
-
#
|
|
152
|
-
#
|
|
153
|
-
#
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
#: () -> Array[ActivityStep]
|
|
183
|
-
def window_steps
|
|
184
|
-
history, _plan, closing, = window_history
|
|
185
|
-
present(closing ? history.steps + [closing] : history.steps)
|
|
186
|
-
end
|
|
187
|
-
|
|
188
|
-
#: () -> Analysis
|
|
189
|
-
def analyze_window
|
|
190
|
-
history, plan, closing, closing_snapshot, captured_at = window_history
|
|
191
|
-
analysis(plan, history,
|
|
192
|
-
final: window_final_snapshot(history, closing, closing_snapshot),
|
|
193
|
-
steps: present(closing ? history.steps + [closing] : history.steps),
|
|
194
|
-
closing_snapshot: closing_snapshot, captured_at: captured_at)
|
|
195
|
-
end
|
|
196
|
-
|
|
197
|
-
# A window with a closing step ends at what closed it: the live row, or
|
|
198
|
-
# nothing after a destroy, where no live row is read. One that ends before
|
|
199
|
-
# a later event ends at the state that event found.
|
|
200
|
-
#: (ActivityHistory, ActivityStep?, RecordSnapshot?) -> RecordSnapshot?
|
|
201
|
-
def window_final_snapshot(history, closing, closing_snapshot)
|
|
202
|
-
closing ? closing_snapshot : history.last_snapshot
|
|
203
|
-
end
|
|
204
|
-
|
|
205
|
-
#: () -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
|
|
206
|
-
def window_history
|
|
207
|
-
plan = @range.select_plan(context_required: !@tree.empty?)
|
|
208
|
-
reject_live_habtm! if plan.closing_record
|
|
209
|
-
return empty_window(plan) if plan.empty? && !plan.closing_record
|
|
210
|
-
|
|
211
|
-
# A window closing on current state runs to the instant it is captured,
|
|
212
|
-
# not to the last root version, or descendants that moved after that
|
|
213
|
-
# version would be missing from a report that claims to reach now.
|
|
214
|
-
window_replay(plan, (Time.now.utc if plan.closing_record))
|
|
215
|
-
end
|
|
216
|
-
|
|
217
|
-
# Nothing reads a window's closing step, live snapshot, or capture time
|
|
218
|
-
# when it reported nothing, so mutations of those cannot change an answer.
|
|
219
|
-
# mutant:disable
|
|
220
|
-
#: (RootVersionPlan) -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
|
|
221
|
-
def empty_window(plan)
|
|
222
|
-
[ActivityHistory.empty, plan, nil, nil, nil]
|
|
223
|
-
end
|
|
224
|
-
|
|
225
|
-
# A window with no selected event reports nothing. Any other has a
|
|
226
|
-
# boundary after its last one: the plan refuses a window that has no later
|
|
227
|
-
# version, ends on no destroy, and does not close on the live row.
|
|
228
|
-
#: (RootVersionPlan, untyped) -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
|
|
229
|
-
def window_replay(plan, captured_at)
|
|
230
|
-
versions = plan.reconstruction_versions
|
|
231
|
-
snapshots = prepare_history(versions, end_at: captured_at)
|
|
232
|
-
events = collect_events(versions, snapshots, range_end: captured_at || versions.last)
|
|
233
|
-
selected = selected_events(events, plan)
|
|
234
|
-
last = selected.last
|
|
235
|
-
return empty_window(plan) unless last
|
|
236
|
-
|
|
237
|
-
snapshot = window_live_snapshot(plan)
|
|
238
|
-
history = replay(versions, events, snapshots, current: plan.closing_record, closing: snapshot)
|
|
239
|
-
closing = window_closing(history, last, plan, captured_at, snapshot, events)
|
|
240
|
-
[history, plan, closing, snapshot, captured_at]
|
|
241
|
-
end
|
|
242
|
-
|
|
243
|
-
# One live read serves both the closing activity step and the endpoint the
|
|
244
|
-
# analysis reports, which would otherwise reconstruct the graph twice.
|
|
245
|
-
#: (RootVersionPlan) -> RecordSnapshot?
|
|
246
|
-
def window_live_snapshot(plan)
|
|
247
|
-
record = plan.closing_record
|
|
248
|
-
return unless record
|
|
249
|
-
|
|
250
|
-
@snapshotter.call(record, record)
|
|
251
|
-
end
|
|
252
|
-
|
|
253
|
-
# Root versions inside the window that the plan does not report are context
|
|
254
|
-
# rather than mutations: the version appended to reveal the last selected
|
|
255
|
-
# change, and anything a filter excluded but the replay still walks. Neither
|
|
256
|
-
# may be counted as a selected mutation. Descendant events are not filtered,
|
|
257
|
-
# so window membership is the whole test for them.
|
|
258
|
-
#: (Array[ActivityEvent], RootVersionPlan) -> Array[ActivityEvent]
|
|
259
|
-
def selected_events(events, plan)
|
|
260
|
-
events.select do |event|
|
|
261
|
-
@range.include?(event.version) && (!event.root? || plan.mutation?(event.version))
|
|
262
|
-
end
|
|
263
|
-
end
|
|
264
|
-
|
|
265
|
-
# A window either closes on the absence its final destruction leaves, or on
|
|
266
|
-
# current state when it reaches past everything recorded. Both are boundaries
|
|
267
|
-
# no version can supply.
|
|
193
|
+
# A window with no selected event reports nothing, and so does one whose
|
|
194
|
+
# replay left out every event it selected, each of a record outside the
|
|
195
|
+
# tree throughout, such as a comment created outside a scope. Any other
|
|
196
|
+
# has a boundary after its last event: the plan refuses a window that has
|
|
197
|
+
# no later version, ends on no destroy, and does not close on the live row.
|
|
198
|
+
#
|
|
199
|
+
# A window closing on current state runs to the instant it is captured,
|
|
200
|
+
# not to the last root version, or descendants that moved after that
|
|
201
|
+
# version would be missing from a report that claims to reach now.
|
|
202
|
+
#: () -> [RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?
|
|
203
|
+
def window_replay
|
|
204
|
+
plan = select_plan
|
|
205
|
+
live = plan.closing_record
|
|
206
|
+
reject_live_habtm! if live
|
|
207
|
+
window_activity(plan, live, (Time.now.utc if live)) unless plan.empty? && !live
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# The live record is read only once something in the window is reported.
|
|
211
|
+
#: (RootVersionPlan, untyped, untyped) -> [RootVersionPlan, ActivityHistory, Array[ActivityStep], RecordSnapshot?, RecordSnapshot?, untyped]?
|
|
212
|
+
def window_activity(plan, live, captured_at)
|
|
213
|
+
events, snapshots = range_events(plan, captured_at)
|
|
214
|
+
return unless events.any? { |event| reported?(event, plan) }
|
|
215
|
+
|
|
216
|
+
snapshot = (@snapshotter.call(live, live) if live)
|
|
217
|
+
history = replay(plan, events, snapshots, current: live, closing: snapshot)
|
|
218
|
+
live_replay(plan, history, live, captured_at, snapshot)
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# The step that closes the range after its last event, which is reported
|
|
222
|
+
# as that event's step would be. It runs from the last boundary the
|
|
223
|
+
# history kept into one no version can supply: the live record the range
|
|
224
|
+
# closes on, or the absence a final root destroy leaves.
|
|
268
225
|
#
|
|
269
226
|
# Everything recorded means on every requested path, not only the root's
|
|
270
|
-
# own versions. When an association changed after
|
|
271
|
-
#
|
|
272
|
-
#
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
#: (ActivityHistory, ActivityEvent) -> ActivityStep
|
|
283
|
-
def window_destroyed_step(history, event)
|
|
284
|
-
version = event.version
|
|
227
|
+
# own versions. When an association changed after a window, its last step
|
|
228
|
+
# already ends at that change, at the state the window left, and that
|
|
229
|
+
# change is the last kept event, outside the window; closing on current
|
|
230
|
+
# state would add it to a window it was not in. A plan that does not close
|
|
231
|
+
# on the current record holds a version after the window, which is such a
|
|
232
|
+
# change, or ends at a destruction.
|
|
233
|
+
#: (ActivityHistory, RootVersionPlan, ?untyped, ?untyped, ?RecordSnapshot?) -> ActivityStep?
|
|
234
|
+
def closing_step(history, plan, live = nil, captured_at = nil, snapshot = nil)
|
|
235
|
+
boundary = closing_boundary(history.last_event, plan, live, captured_at)
|
|
236
|
+
return unless boundary
|
|
237
|
+
|
|
238
|
+
last = history.last_boundary #: ActivityBoundary
|
|
285
239
|
ActivityStep.between(
|
|
286
|
-
from_boundary:
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
to_snapshot: nil, retain: @view.retain?
|
|
240
|
+
from_boundary: last, to_boundary: boundary,
|
|
241
|
+
from_snapshot: history.last_event_snapshot, to_snapshot: snapshot,
|
|
242
|
+
retain: @view.retain?, attribution: history.last_attribution
|
|
290
243
|
)
|
|
291
244
|
end
|
|
292
245
|
|
|
293
|
-
#
|
|
294
|
-
#
|
|
295
|
-
#
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
step_from_last(history, previous, current, snapshot)
|
|
301
|
-
end
|
|
246
|
+
# Without a live record to close on, a range closes only on the root's
|
|
247
|
+
# destruction, and its last event is then the root's own: the version
|
|
248
|
+
# that ends an explicit range, or a window's version after it, or the
|
|
249
|
+
# destroy nothing follows.
|
|
250
|
+
#: (ActivityEvent?, RootVersionPlan, untyped, untyped) -> ActivityBoundary?
|
|
251
|
+
def closing_boundary(event, plan, live, captured_at)
|
|
252
|
+
return unless event && reported?(event, plan)
|
|
302
253
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
254
|
+
if live
|
|
255
|
+
ActivityBoundary.current(live, captured_at: captured_at, recorded: root_recorded)
|
|
256
|
+
elsif event.version.event == 'destroy'
|
|
257
|
+
ActivityBoundary.destroyed(event.version, recorded: root_recorded)
|
|
258
|
+
end
|
|
306
259
|
end
|
|
307
260
|
|
|
308
261
|
#: () -> void
|
|
309
262
|
def reject_live_habtm!
|
|
310
|
-
|
|
263
|
+
@traversal.reject_live_habtm_activity!(@record.class)
|
|
311
264
|
end
|
|
312
265
|
|
|
313
|
-
#: () ->
|
|
266
|
+
#: () -> RecordedChangesReader?
|
|
314
267
|
def root_recorded
|
|
315
|
-
@view.
|
|
268
|
+
@view.recorded_reader(root: true)
|
|
316
269
|
end
|
|
317
270
|
|
|
318
271
|
# A window prepares from its start, explicit endpoints from their first
|
|
319
272
|
# version.
|
|
320
|
-
#: (Array[untyped],
|
|
321
|
-
def prepare_history(root_versions, end_at:
|
|
273
|
+
#: (Array[untyped], end_at: untyped) -> untyped
|
|
274
|
+
def prepare_history(root_versions, end_at:)
|
|
322
275
|
options = { start_at: @range.begin_time, end_at: end_at }.compact
|
|
323
276
|
@snapshotter.prepare(@record, root_versions, **options)
|
|
324
277
|
end
|
|
@@ -332,53 +285,51 @@ module PaperTrailDiff
|
|
|
332
285
|
events = ActivityVersionCollector.new(
|
|
333
286
|
@record,
|
|
334
287
|
root_versions: root_versions,
|
|
335
|
-
|
|
288
|
+
traversal: @traversal,
|
|
336
289
|
prepared: snapshots.activity_index,
|
|
337
290
|
range_start: @range.begin_time || root_versions.first,
|
|
338
291
|
range_end: range_end
|
|
339
292
|
).call
|
|
340
|
-
|
|
293
|
+
events = ActivityTransactionGroups.before_closing(events, range_end) unless @range.time?
|
|
294
|
+
prepare_filter(snapshots, events)
|
|
295
|
+
events
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# A version filter reads its answers for a batch's history once, for the
|
|
299
|
+
# first root that history serves.
|
|
300
|
+
#: (untyped, Array[ActivityEvent]) -> void
|
|
301
|
+
def prepare_filter(snapshots, events)
|
|
302
|
+
@filter&.prepare(snapshots.history, events.map(&:version))
|
|
341
303
|
end
|
|
342
304
|
|
|
343
305
|
# Events after the last root version read the root from the live record
|
|
344
|
-
# when the range closes on it. Explicit endpoints report every step
|
|
345
|
-
# their range includes every version.
|
|
346
|
-
#: (
|
|
347
|
-
def replay(
|
|
306
|
+
# when the range closes on it. Explicit endpoints report every step their
|
|
307
|
+
# plan does, as their range includes every version.
|
|
308
|
+
#: (RootVersionPlan, Array[ActivityEvent], untyped, current: untyped, closing: RecordSnapshot?) -> ActivityHistory
|
|
309
|
+
def replay(plan, events, snapshots, current:, closing:)
|
|
348
310
|
ActivityHistoryBuilder.new(
|
|
349
|
-
|
|
311
|
+
plan.reconstruction_versions, events, snapshots,
|
|
350
312
|
current: current,
|
|
351
|
-
include_step: ->(event) {
|
|
313
|
+
include_step: ->(event) { reported?(event, plan) },
|
|
352
314
|
view: @view,
|
|
353
|
-
closing: closing
|
|
315
|
+
closing: closing,
|
|
316
|
+
root: root_reference
|
|
354
317
|
).call
|
|
355
318
|
end
|
|
356
319
|
|
|
357
|
-
# The
|
|
358
|
-
#
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
)
|
|
320
|
+
# The root as a change row's `record` would name it. A root is a record,
|
|
321
|
+
# or a deleted one rebuilt from its destroy (see DeletedAnalysisBatch).
|
|
322
|
+
# A reference reads its type with `to_s`, so mutant cannot tell the class
|
|
323
|
+
# from its name here.
|
|
324
|
+
# mutant:disable
|
|
325
|
+
#: () -> RecordReference
|
|
326
|
+
def root_reference
|
|
327
|
+
RecordReference.new(type: @record.class.name, id: @record.id)
|
|
366
328
|
end
|
|
367
329
|
|
|
368
330
|
#: (Array[ActivityStep]) -> Array[ActivityStep]
|
|
369
331
|
def present(steps)
|
|
370
332
|
@view.present(steps).freeze
|
|
371
333
|
end
|
|
372
|
-
|
|
373
|
-
#: (RootVersionPlan, ActivityHistory, final: RecordSnapshot?, steps: Array[ActivityStep], ?closing_snapshot: RecordSnapshot?, ?captured_at: untyped) -> Analysis
|
|
374
|
-
def analysis(plan, history, final:, steps:, **closing)
|
|
375
|
-
Analysis.new(
|
|
376
|
-
diff: Engine.compare(history.first_snapshot, final),
|
|
377
|
-
timeline: ActivityRootSteps.call(plan, history.root_snapshots, **closing),
|
|
378
|
-
activity_timeline: steps,
|
|
379
|
-
from_snapshot: history.first_snapshot,
|
|
380
|
-
to_snapshot: final
|
|
381
|
-
)
|
|
382
|
-
end
|
|
383
334
|
end
|
|
384
335
|
end
|
|
@@ -71,13 +71,15 @@ module PaperTrailDiff
|
|
|
71
71
|
def merge(group)
|
|
72
72
|
first = group.first #: ActivityStep
|
|
73
73
|
last = group.last #: ActivityStep
|
|
74
|
+
sources = group.flat_map(&:sources)
|
|
74
75
|
ActivityStep.between(
|
|
75
76
|
from_boundary: first.from_boundary,
|
|
76
77
|
to_boundary: last.to_boundary,
|
|
77
78
|
from_snapshot: first.from_snapshot,
|
|
78
79
|
to_snapshot: last.to_snapshot,
|
|
79
80
|
retain: @retain,
|
|
80
|
-
sources:
|
|
81
|
+
sources: sources,
|
|
82
|
+
attribution: first.attribution&.with_sources(sources)
|
|
81
83
|
)
|
|
82
84
|
end
|
|
83
85
|
end
|