paper_trail_diff 0.17.1 → 0.18.1
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 +661 -0
- data/QUICKSTART.md +12 -14
- data/README.md +32 -30
- data/docs/architecture.md +65 -29
- data/docs/performance.md +161 -46
- data/docs/reference.md +495 -394
- data/docs/testing.md +9 -15
- data/lib/paper_trail_diff/activity_belongs_to_event_applier.rb +42 -9
- data/lib/paper_trail_diff/activity_boundary.rb +15 -6
- data/lib/paper_trail_diff/activity_child_candidate_loader.rb +91 -18
- data/lib/paper_trail_diff/activity_collection_event_applier.rb +14 -15
- data/lib/paper_trail_diff/activity_collection_record_updater.rb +18 -8
- data/lib/paper_trail_diff/activity_collection_route_updater.rb +12 -25
- data/lib/paper_trail_diff/activity_event.rb +53 -34
- data/lib/paper_trail_diff/activity_event_record_normalizer.rb +12 -26
- data/lib/paper_trail_diff/activity_event_record_resolver.rb +45 -32
- data/lib/paper_trail_diff/activity_event_snapshot_refresher.rb +26 -33
- data/lib/paper_trail_diff/activity_history.rb +28 -34
- data/lib/paper_trail_diff/activity_relationship.rb +3 -26
- data/lib/paper_trail_diff/activity_root_snapshot_refresher.rb +14 -8
- data/lib/paper_trail_diff/activity_snapshot_delta.rb +2 -3
- data/lib/paper_trail_diff/activity_snapshot_sequence.rb +92 -25
- data/lib/paper_trail_diff/activity_timeline_builder.rb +128 -77
- data/lib/paper_trail_diff/activity_transaction_applier.rb +49 -0
- data/lib/paper_trail_diff/activity_tree_filter.rb +70 -57
- data/lib/paper_trail_diff/activity_tree_places.rb +76 -0
- data/lib/paper_trail_diff/activity_version_collector.rb +45 -32
- data/lib/paper_trail_diff/activity_view.rb +2 -0
- data/lib/paper_trail_diff/analysis.rb +6 -5
- data/lib/paper_trail_diff/analysis_batch.rb +21 -17
- data/lib/paper_trail_diff/association_activity_edge.rb +99 -85
- data/lib/paper_trail_diff/association_activity_selection.rb +46 -14
- data/lib/paper_trail_diff/association_discovery.rb +4 -4
- data/lib/paper_trail_diff/association_key.rb +10 -18
- data/lib/paper_trail_diff/association_traversal.rb +72 -92
- data/lib/paper_trail_diff/batch_boundary_resolver.rb +1 -7
- data/lib/paper_trail_diff/batch_preload.rb +2 -3
- data/lib/paper_trail_diff/batched_root_analyses.rb +60 -25
- data/lib/paper_trail_diff/batched_root_analyzer.rb +5 -5
- data/lib/paper_trail_diff/batched_root_versions.rb +7 -30
- data/lib/paper_trail_diff/branch_snapshot_refresher.rb +19 -14
- data/lib/paper_trail_diff/candidate_table.rb +160 -0
- data/lib/paper_trail_diff/change_attribution.rb +15 -23
- data/lib/paper_trail_diff/collection_identity_index.rb +68 -24
- data/lib/paper_trail_diff/collection_transition.rb +3 -3
- data/lib/paper_trail_diff/comparison_batch.rb +13 -6
- data/lib/paper_trail_diff/database_time.rb +85 -0
- data/lib/paper_trail_diff/deleted_analysis_batch.rb +22 -23
- data/lib/paper_trail_diff/deleted_root_filter.rb +10 -6
- data/lib/paper_trail_diff/diagnostics.rb +26 -86
- data/lib/paper_trail_diff/endpoint.rb +37 -5
- data/lib/paper_trail_diff/engine.rb +1 -1
- data/lib/paper_trail_diff/errors.rb +0 -6
- data/lib/paper_trail_diff/exact_column_type.rb +96 -0
- data/lib/paper_trail_diff/historical_snapshot_store.rb +88 -83
- data/lib/paper_trail_diff/instrumentation.rb +0 -8
- data/lib/paper_trail_diff/live_endpoint_batch_loader.rb +1 -4
- data/lib/paper_trail_diff/live_graph_collector.rb +1 -3
- data/lib/paper_trail_diff/nested_comparator.rb +42 -10
- data/lib/paper_trail_diff/paper_trail_adapter.rb +55 -98
- data/lib/paper_trail_diff/prepared_activity_index.rb +214 -182
- data/lib/paper_trail_diff/prepared_child_candidates.rb +13 -3
- data/lib/paper_trail_diff/prepared_edge_loader.rb +11 -49
- data/lib/paper_trail_diff/prepared_history.rb +27 -177
- data/lib/paper_trail_diff/prepared_history_loader.rb +39 -57
- data/lib/paper_trail_diff/prepared_record_index.rb +221 -147
- data/lib/paper_trail_diff/prepared_snapshot_builder.rb +47 -42
- data/lib/paper_trail_diff/prepared_state_association_reader.rb +85 -62
- data/lib/paper_trail_diff/recorded_changes.rb +34 -10
- data/lib/paper_trail_diff/recorded_owner.rb +67 -0
- data/lib/paper_trail_diff/root_version_selection.rb +6 -2
- data/lib/paper_trail_diff/scope_condition.rb +120 -80
- data/lib/paper_trail_diff/scope_ranking.rb +14 -32
- data/lib/paper_trail_diff/scoped_analysis.rb +11 -6
- data/lib/paper_trail_diff/scoped_analysis_builder.rb +17 -11
- data/lib/paper_trail_diff/scoped_root_selection.rb +91 -85
- data/lib/paper_trail_diff/selection_window.rb +31 -0
- data/lib/paper_trail_diff/snapshot.rb +60 -58
- data/lib/paper_trail_diff/snapshot_members.rb +115 -0
- data/lib/paper_trail_diff/snapshot_normalizer.rb +0 -11
- data/lib/paper_trail_diff/step.rb +1 -5
- data/lib/paper_trail_diff/stored_form.rb +146 -0
- data/lib/paper_trail_diff/stored_json_values.rb +8 -5
- data/lib/paper_trail_diff/stored_time_precision.rb +67 -33
- data/lib/paper_trail_diff/stored_values.rb +35 -3
- data/lib/paper_trail_diff/support.rb +185 -35
- data/lib/paper_trail_diff/time_of_day.rb +13 -2
- data/lib/paper_trail_diff/time_range.rb +85 -11
- data/lib/paper_trail_diff/time_version_range.rb +5 -1
- data/lib/paper_trail_diff/timeline_builder.rb +5 -11
- data/lib/paper_trail_diff/timeline_range.rb +56 -19
- data/lib/paper_trail_diff/timeline_snapshot_provider.rb +31 -7
- data/lib/paper_trail_diff/total_order.rb +19 -5
- data/lib/paper_trail_diff/transaction_anchors.rb +138 -0
- data/lib/paper_trail_diff/transaction_cut.rb +67 -327
- data/lib/paper_trail_diff/transaction_ends.rb +195 -0
- data/lib/paper_trail_diff/traversal_preparer.rb +12 -24
- data/lib/paper_trail_diff/{approximate_paths.rb → unreadable_paths.rb} +8 -9
- data/lib/paper_trail_diff/value_objects.rb +8 -6
- data/lib/paper_trail_diff/version.rb +1 -1
- data/lib/paper_trail_diff/version_association_candidate_scope.rb +12 -10
- data/lib/paper_trail_diff/version_boundary.rb +0 -29
- data/lib/paper_trail_diff/version_query.rb +49 -1
- data/lib/paper_trail_diff/version_scope_filter.rb +74 -5
- data/lib/paper_trail_diff/version_sequence_diagnostics.rb +4 -31
- data/lib/paper_trail_diff/version_table.rb +8 -1
- data/lib/paper_trail_diff.rb +56 -110
- data/sig/generated/paper_trail_diff/activity_belongs_to_event_applier.rbs +24 -2
- data/sig/generated/paper_trail_diff/activity_boundary.rbs +6 -0
- data/sig/generated/paper_trail_diff/activity_child_candidate_loader.rbs +46 -5
- data/sig/generated/paper_trail_diff/activity_collection_event_applier.rbs +7 -4
- data/sig/generated/paper_trail_diff/activity_collection_record_updater.rbs +11 -2
- data/sig/generated/paper_trail_diff/activity_collection_route_updater.rbs +8 -6
- data/sig/generated/paper_trail_diff/activity_event.rbs +27 -18
- data/sig/generated/paper_trail_diff/activity_event_record_normalizer.rbs +7 -11
- data/sig/generated/paper_trail_diff/activity_event_record_resolver.rbs +26 -8
- data/sig/generated/paper_trail_diff/activity_event_snapshot_refresher.rbs +10 -2
- data/sig/generated/paper_trail_diff/activity_history.rbs +23 -26
- data/sig/generated/paper_trail_diff/activity_relationship.rbs +0 -6
- data/sig/generated/paper_trail_diff/activity_root_snapshot_refresher.rbs +5 -0
- data/sig/generated/paper_trail_diff/activity_snapshot_sequence.rbs +53 -10
- data/sig/generated/paper_trail_diff/activity_timeline_builder.rbs +64 -38
- data/sig/generated/paper_trail_diff/activity_transaction_applier.rbs +28 -0
- data/sig/generated/paper_trail_diff/activity_tree_filter.rbs +46 -38
- data/sig/generated/paper_trail_diff/activity_tree_places.rbs +45 -0
- data/sig/generated/paper_trail_diff/activity_version_collector.rbs +21 -11
- data/sig/generated/paper_trail_diff/analysis.rbs +6 -5
- data/sig/generated/paper_trail_diff/analysis_batch.rbs +8 -6
- data/sig/generated/paper_trail_diff/association_activity_edge.rbs +58 -45
- data/sig/generated/paper_trail_diff/association_activity_selection.rbs +20 -3
- data/sig/generated/paper_trail_diff/association_discovery.rbs +2 -2
- data/sig/generated/paper_trail_diff/association_key.rbs +2 -11
- data/sig/generated/paper_trail_diff/association_traversal.rbs +43 -44
- data/sig/generated/paper_trail_diff/batch_boundary_resolver.rbs +0 -2
- data/sig/generated/paper_trail_diff/batched_root_analyses.rbs +40 -17
- data/sig/generated/paper_trail_diff/batched_root_analyzer.rbs +2 -2
- data/sig/generated/paper_trail_diff/batched_root_versions.rbs +2 -11
- data/sig/generated/paper_trail_diff/branch_snapshot_refresher.rbs +12 -8
- data/sig/generated/paper_trail_diff/candidate_table.rbs +97 -0
- data/sig/generated/paper_trail_diff/change_attribution.rbs +9 -16
- data/sig/generated/paper_trail_diff/collection_identity_index.rbs +33 -13
- data/sig/generated/paper_trail_diff/collection_transition.rbs +2 -2
- data/sig/generated/paper_trail_diff/comparison_batch.rbs +5 -0
- data/sig/generated/paper_trail_diff/database_time.rbs +48 -0
- data/sig/generated/paper_trail_diff/deleted_analysis_batch.rbs +13 -15
- data/sig/generated/paper_trail_diff/deleted_root_filter.rbs +4 -0
- data/sig/generated/paper_trail_diff/diagnostics.rbs +13 -31
- data/sig/generated/paper_trail_diff/endpoint.rbs +14 -1
- data/sig/generated/paper_trail_diff/errors.rbs +0 -8
- data/sig/generated/paper_trail_diff/exact_column_type.rbs +51 -0
- data/sig/generated/paper_trail_diff/historical_snapshot_store.rbs +51 -31
- data/sig/generated/paper_trail_diff/instrumentation.rbs +0 -5
- data/sig/generated/paper_trail_diff/nested_comparator.rbs +21 -0
- data/sig/generated/paper_trail_diff/paper_trail_adapter.rbs +18 -29
- data/sig/generated/paper_trail_diff/prepared_activity_index.rbs +138 -94
- data/sig/generated/paper_trail_diff/prepared_child_candidates.rbs +10 -2
- data/sig/generated/paper_trail_diff/prepared_edge_loader.rbs +4 -21
- data/sig/generated/paper_trail_diff/prepared_history.rbs +22 -79
- data/sig/generated/paper_trail_diff/prepared_history_loader.rbs +24 -32
- data/sig/generated/paper_trail_diff/prepared_record_index.rbs +137 -63
- data/sig/generated/paper_trail_diff/prepared_snapshot_builder.rbs +22 -13
- data/sig/generated/paper_trail_diff/prepared_state_association_reader.rbs +41 -28
- data/sig/generated/paper_trail_diff/recorded_changes.rbs +19 -3
- data/sig/generated/paper_trail_diff/recorded_owner.rbs +39 -0
- data/sig/generated/paper_trail_diff/root_version_selection.rbs +4 -1
- data/sig/generated/paper_trail_diff/scope_condition.rbs +65 -52
- data/sig/generated/paper_trail_diff/scope_ranking.rbs +10 -23
- data/sig/generated/paper_trail_diff/scoped_analysis.rbs +11 -6
- data/sig/generated/paper_trail_diff/scoped_analysis_builder.rbs +7 -2
- data/sig/generated/paper_trail_diff/scoped_root_selection.rbs +49 -43
- data/sig/generated/paper_trail_diff/selection_window.rbs +19 -0
- data/sig/generated/paper_trail_diff/snapshot.rbs +37 -38
- data/sig/generated/paper_trail_diff/snapshot_members.rbs +58 -0
- data/sig/generated/paper_trail_diff/snapshot_normalizer.rbs +0 -4
- data/sig/generated/paper_trail_diff/stored_form.rbs +63 -0
- data/sig/generated/paper_trail_diff/stored_json_values.rbs +0 -2
- data/sig/generated/paper_trail_diff/stored_time_precision.rbs +33 -20
- data/sig/generated/paper_trail_diff/stored_values.rbs +18 -2
- data/sig/generated/paper_trail_diff/support.rbs +96 -16
- data/sig/generated/paper_trail_diff/time_of_day.rbs +4 -0
- data/sig/generated/paper_trail_diff/time_range.rbs +49 -4
- data/sig/generated/paper_trail_diff/time_version_range.rbs +3 -0
- data/sig/generated/paper_trail_diff/timeline_builder.rbs +3 -6
- data/sig/generated/paper_trail_diff/timeline_range.rbs +29 -8
- data/sig/generated/paper_trail_diff/timeline_snapshot_provider.rbs +17 -4
- data/sig/generated/paper_trail_diff/total_order.rbs +9 -3
- data/sig/generated/paper_trail_diff/transaction_anchors.rbs +80 -0
- data/sig/generated/paper_trail_diff/transaction_cut.rbs +43 -176
- data/sig/generated/paper_trail_diff/transaction_ends.rbs +126 -0
- data/sig/generated/paper_trail_diff/traversal_preparer.rbs +6 -11
- data/sig/generated/paper_trail_diff/{approximate_paths.rbs → unreadable_paths.rbs} +6 -7
- data/sig/generated/paper_trail_diff/value_objects.rbs +4 -2
- data/sig/generated/paper_trail_diff/version_association_candidate_scope.rbs +11 -5
- data/sig/generated/paper_trail_diff/version_boundary.rbs +0 -14
- data/sig/generated/paper_trail_diff/version_query.rbs +26 -0
- data/sig/generated/paper_trail_diff/version_scope_filter.rbs +28 -2
- data/sig/generated/paper_trail_diff/version_sequence_diagnostics.rbs +4 -15
- data/sig/generated/paper_trail_diff/version_table.rbs +4 -0
- data/sig/generated/paper_trail_diff.rbs +22 -23
- metadata +28 -20
- data/lib/paper_trail_diff/activity_target_candidate_loader.rb +0 -123
- data/lib/paper_trail_diff/fallback_paths.rb +0 -35
- data/lib/paper_trail_diff/habtm_transaction_owners.rb +0 -70
- data/lib/paper_trail_diff/historical_association_reifier.rb +0 -161
- data/lib/paper_trail_diff/historical_filter.rb +0 -210
- data/lib/paper_trail_diff/own_window.rb +0 -35
- data/lib/paper_trail_diff/prepared_association_reifier.rb +0 -51
- data/sig/generated/paper_trail_diff/activity_target_candidate_loader.rbs +0 -74
- data/sig/generated/paper_trail_diff/fallback_paths.rbs +0 -22
- data/sig/generated/paper_trail_diff/habtm_transaction_owners.rbs +0 -41
- data/sig/generated/paper_trail_diff/historical_association_reifier.rbs +0 -58
- data/sig/generated/paper_trail_diff/historical_filter.rbs +0 -96
- data/sig/generated/paper_trail_diff/own_window.rbs +0 -22
- data/sig/generated/paper_trail_diff/prepared_association_reifier.rbs +0 -27
|
@@ -7,16 +7,16 @@ module PaperTrailDiff
|
|
|
7
7
|
# the only place allowed to know about both PaperTrail and the pure engine.
|
|
8
8
|
# Reconstruction logic lives in the collaborators it wires together.
|
|
9
9
|
class PaperTrailAdapter # rubocop:disable Metrics/ClassLength
|
|
10
|
-
# `recorded_changes:` reads what each activity boundary's version
|
|
11
|
-
#
|
|
12
|
-
#: (associations: association_option, ignore: ignore_option, ?recorded_changes: bool
|
|
13
|
-
def initialize(associations:, ignore:, recorded_changes:
|
|
10
|
+
# `recorded_changes:` reads what each activity boundary's version
|
|
11
|
+
# recorded, as activity does unless told not to.
|
|
12
|
+
#: (associations: association_option, ignore: ignore_option, ?recorded_changes: bool?) -> void
|
|
13
|
+
def initialize(associations:, ignore:, recorded_changes: nil)
|
|
14
|
+
Support.boolean!(:recorded_changes, recorded_changes) unless recorded_changes.nil?
|
|
14
15
|
@association_tree = AssociationTree.build(associations)
|
|
15
16
|
@ignore_policy = IgnorePolicy.build(ignore, association_paths: @association_tree.paths)
|
|
16
|
-
@
|
|
17
|
+
@recorded_changes = recorded_changes
|
|
17
18
|
@traversal = AssociationTraversal.new(@association_tree)
|
|
18
|
-
@traversal_preparer = TraversalPreparer.new(traversal: @traversal
|
|
19
|
-
allow_approximate: allow_approximate)
|
|
19
|
+
@traversal_preparer = TraversalPreparer.new(traversal: @traversal)
|
|
20
20
|
@live_endpoints = LiveEndpointProvider.new(tree: @association_tree)
|
|
21
21
|
@instrumentation_payload = { association_paths: @association_tree.paths }.freeze
|
|
22
22
|
@snapshot_pool = SnapshotPool.new
|
|
@@ -32,7 +32,6 @@ module PaperTrailDiff
|
|
|
32
32
|
payload = @instrumentation_payload.merge(comparison_count: 1)
|
|
33
33
|
Instrumentation.instrument('compare', payload) do
|
|
34
34
|
Endpoint.validate_pair!(from_endpoint, to_endpoint)
|
|
35
|
-
notify_ambiguous_association_boundary(from_endpoint, to_endpoint)
|
|
36
35
|
ReadSnapshot.call([from_endpoint, to_endpoint]) do
|
|
37
36
|
if @association_tree.empty?
|
|
38
37
|
Engine.compare(snapshot_for_endpoint(from_endpoint), snapshot_for_endpoint(to_endpoint))
|
|
@@ -59,43 +58,18 @@ module PaperTrailDiff
|
|
|
59
58
|
end
|
|
60
59
|
end
|
|
61
60
|
|
|
62
|
-
#: (untyped, from: untyped, to: untyped, within: untyped, ?version_scope: untyped) -> Array[Step]
|
|
63
|
-
def timeline(record, from:, to:, within:, version_scope: nil)
|
|
64
|
-
Endpoint.validate_root!(record)
|
|
65
|
-
ReadSnapshot.call([record]) do
|
|
66
|
-
@traversal_preparer.call(record.class, historical: true)
|
|
67
|
-
from, to = default_range(record, from, to, within)
|
|
68
|
-
timeline_builder(record, from: from, to: to, within: within, version_scope: version_scope,
|
|
69
|
-
live_endpoint: live_endpoint_for(record, within)).build
|
|
70
|
-
end
|
|
71
|
-
end
|
|
72
|
-
|
|
73
|
-
#: (untyped, from: untyped, to: untyped, within: untyped, ?version_scope: untyped, ?snapshots: bool, ?group: Symbol?) -> Array[ActivityStep]
|
|
74
|
-
def activity_timeline(record, from:, to:, within:, version_scope: nil, snapshots: false, group: nil) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
|
|
75
|
-
Endpoint.validate_root!(record)
|
|
76
|
-
payload = model_payload(record)
|
|
77
|
-
Instrumentation.instrument('activity_timeline', payload) do
|
|
78
|
-
steps = ReadSnapshot.call([record]) do
|
|
79
|
-
@traversal_preparer.call(record.class, historical: true)
|
|
80
|
-
from, to = default_range(record, from, to, within)
|
|
81
|
-
view = activity_view(true, snapshots, group, version_scope)
|
|
82
|
-
activity_builder(
|
|
83
|
-
record, from: from, to: to, within: within, version_scope: version_scope,
|
|
84
|
-
live_endpoint: live_endpoint_for(record, within), view: view
|
|
85
|
-
).build
|
|
86
|
-
end
|
|
87
|
-
payload[:step_count] = steps.length
|
|
88
|
-
steps
|
|
89
|
-
end
|
|
90
|
-
end
|
|
91
|
-
|
|
92
61
|
#: (untyped, from: untyped, to: untyped, within: untyped, ?activity: bool, ?version_scope: untyped, ?snapshots: bool, ?group: Symbol?) -> Analysis
|
|
93
62
|
def analyze(record, from:, to:, within:, activity: false, version_scope: nil, snapshots: false, group: nil) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
|
|
94
63
|
view = activity_view(activity, snapshots, group, version_scope)
|
|
95
64
|
Endpoint.validate_root!(record)
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
65
|
+
payload = model_payload(record)
|
|
66
|
+
Instrumentation.instrument('analyze', payload) do
|
|
67
|
+
analysis = ReadSnapshot.call([record]) do
|
|
68
|
+
analyze_record(record, from: from, to: to, within: within, activity: activity,
|
|
69
|
+
version_scope: version_scope, view: view)
|
|
70
|
+
end
|
|
71
|
+
payload[:step_count] = (analysis.activity_timeline || analysis.timeline).length
|
|
72
|
+
analysis
|
|
99
73
|
end
|
|
100
74
|
end
|
|
101
75
|
|
|
@@ -112,14 +86,13 @@ module PaperTrailDiff
|
|
|
112
86
|
# caller reporting on a population does not have to rediscover which of its
|
|
113
87
|
# members changed. The roots the relation could not reach come back named
|
|
114
88
|
# rather than dropped -- see `PaperTrailDiff.analyze_scope`.
|
|
115
|
-
#: (untyped, limit: Integer?, within: untyped, ?activity: bool, ?version_scope: untyped, ?snapshots: bool, ?group: Symbol?, ?
|
|
116
|
-
def analyze_scope(scope, limit:, within:, activity: false, version_scope: nil, snapshots: false, group: nil,
|
|
89
|
+
#: (untyped, limit: Integer?, within: untyped, ?activity: bool, ?version_scope: untyped, ?snapshots: bool, ?group: Symbol?, ?include_deleted: bool) -> ScopedAnalysis
|
|
90
|
+
def analyze_scope(scope, limit:, within:, activity: false, version_scope: nil, snapshots: false, group: nil, include_deleted: false) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
|
|
117
91
|
view = activity_view(activity, snapshots, group, version_scope)
|
|
118
92
|
ReadSnapshot.call([scope]) do
|
|
119
93
|
check_scope(scope)
|
|
120
94
|
scoped_builder(scope, limit: limit, within: within, activity: activity,
|
|
121
|
-
version_scope: version_scope,
|
|
122
|
-
max_filter_versions: max_filter_versions,
|
|
95
|
+
version_scope: version_scope,
|
|
123
96
|
include_deleted: include_deleted, view: view).call
|
|
124
97
|
end
|
|
125
98
|
end
|
|
@@ -128,8 +101,9 @@ module PaperTrailDiff
|
|
|
128
101
|
|
|
129
102
|
#: (bool, bool, Symbol?, untyped) -> ActivityView
|
|
130
103
|
def activity_view(activity, snapshots, group, version_scope)
|
|
104
|
+
recorded = @recorded_changes.nil? ? activity : @recorded_changes
|
|
131
105
|
ActivityView.build(activity: activity, snapshots: snapshots, group: group,
|
|
132
|
-
recorded: @recorded, version_scope: version_scope)
|
|
106
|
+
recorded: (@ignore_policy if recorded), version_scope: version_scope)
|
|
133
107
|
end
|
|
134
108
|
|
|
135
109
|
#: (untyped) -> Hash[Symbol, untyped]
|
|
@@ -158,8 +132,7 @@ module PaperTrailDiff
|
|
|
158
132
|
def timeline_builder(record, from:, to:, within:, version_scope:, live_endpoint:) # rubocop:disable Metrics/ParameterLists
|
|
159
133
|
TimelineBuilder.new(
|
|
160
134
|
record, from: from, to: to, within: within, version_scope: version_scope,
|
|
161
|
-
live_endpoint: live_endpoint, snapshotter: @timeline_snapshotter
|
|
162
|
-
traversal: @traversal
|
|
135
|
+
live_endpoint: live_endpoint, snapshotter: @timeline_snapshotter
|
|
163
136
|
)
|
|
164
137
|
end
|
|
165
138
|
|
|
@@ -170,15 +143,23 @@ module PaperTrailDiff
|
|
|
170
143
|
Instrumentation.instrument('analyze_many', payload) do
|
|
171
144
|
AnalysisBatch.new(
|
|
172
145
|
records,
|
|
173
|
-
time_range: within.
|
|
174
|
-
|
|
146
|
+
time_range: time_range(within, records.is_a?(Array) ? records.map(&:class) : []),
|
|
147
|
+
version_scope: version_scope,
|
|
148
|
+
context_required: activity && !@association_tree.empty?,
|
|
175
149
|
live_loader: method(:load_batch_endpoints),
|
|
176
150
|
history_preparer: @historical_store.method(:prepare_batch),
|
|
177
|
-
analyzer: batched_root_analyzer(activity, view: view)
|
|
151
|
+
analyzer: batched_root_analyzer(activity, view: view),
|
|
152
|
+
reach: @traversal.method(:reach_before)
|
|
178
153
|
).call
|
|
179
154
|
end
|
|
180
155
|
end
|
|
181
156
|
|
|
157
|
+
# The window as the models' version tables keep times.
|
|
158
|
+
#: (untyped, Array[untyped]) -> TimeRange?
|
|
159
|
+
def time_range(within, models)
|
|
160
|
+
TimeRange.for(within, models.uniq) unless within.nil?
|
|
161
|
+
end
|
|
162
|
+
|
|
182
163
|
# Analysis reads association history, so a request it would refuse is
|
|
183
164
|
# refused before the first selection query rather than once analysis starts.
|
|
184
165
|
#: (untyped) -> void
|
|
@@ -220,21 +201,21 @@ module PaperTrailDiff
|
|
|
220
201
|
within = options.fetch(:within)
|
|
221
202
|
analyzer = batched_root_analyzer(options.fetch(:activity), view: options.fetch(:view))
|
|
222
203
|
DeletedAnalysisBatch.new(
|
|
223
|
-
model, identities: identities, time_range: within
|
|
204
|
+
model, identities: identities, time_range: time_range(within, [model]),
|
|
224
205
|
version_scope: options.fetch(:version_scope),
|
|
225
206
|
history_preparer: @historical_store.method(:prepare_deleted_batch),
|
|
226
|
-
analyzer: analyzer,
|
|
227
|
-
context_required: options.fetch(:activity) && !@association_tree.empty
|
|
207
|
+
analyzer: analyzer,
|
|
208
|
+
context_required: options.fetch(:activity) && !@association_tree.empty?,
|
|
209
|
+
reach: @traversal.method(:reach_before)
|
|
228
210
|
).call
|
|
229
211
|
end
|
|
230
212
|
|
|
231
|
-
#: (untyped, limit: Integer?, within: untyped, activity: bool, version_scope: untyped,
|
|
232
|
-
def scoped_builder(scope, limit:, within:, activity:, version_scope:,
|
|
213
|
+
#: (untyped, limit: Integer?, within: untyped, activity: bool, version_scope: untyped, include_deleted: bool, view: ActivityView) -> ScopedAnalysisBuilder
|
|
214
|
+
def scoped_builder(scope, limit:, within:, activity:, version_scope:, include_deleted:, view:) # rubocop:disable Metrics/ParameterLists
|
|
233
215
|
# @type var options: report_options
|
|
234
216
|
options = { within: within, activity: activity, version_scope: version_scope, view: view }
|
|
235
217
|
ScopedAnalysisBuilder.new(
|
|
236
|
-
scope, limit: limit, within: within,
|
|
237
|
-
max_filter_versions: max_filter_versions, include_deleted: include_deleted,
|
|
218
|
+
scope, limit: limit, within: within, include_deleted: include_deleted,
|
|
238
219
|
analyzer: lambda { |records|
|
|
239
220
|
analyze_batch(records, within: within, activity: activity,
|
|
240
221
|
version_scope: version_scope, view: view)
|
|
@@ -244,8 +225,7 @@ module PaperTrailDiff
|
|
|
244
225
|
},
|
|
245
226
|
# Checkpoints compare a root's own versions, so only activity can
|
|
246
227
|
# report a window in which just its associations changed.
|
|
247
|
-
|
|
248
|
-
traversal: @traversal
|
|
228
|
+
activity_traversal: (@traversal if activity), version_scope: version_scope
|
|
249
229
|
)
|
|
250
230
|
end
|
|
251
231
|
|
|
@@ -253,7 +233,7 @@ module PaperTrailDiff
|
|
|
253
233
|
# @rbs @live_endpoints: LiveEndpointProvider
|
|
254
234
|
# @rbs @instrumentation_payload: Hash[Symbol, untyped]
|
|
255
235
|
# @rbs @ignore_policy: IgnorePolicy
|
|
256
|
-
# @rbs @
|
|
236
|
+
# @rbs @recorded_changes: bool?
|
|
257
237
|
# @rbs @traversal: AssociationTraversal
|
|
258
238
|
# @rbs @traversal_preparer: TraversalPreparer
|
|
259
239
|
# @rbs @snapshot_pool: SnapshotPool
|
|
@@ -262,39 +242,6 @@ module PaperTrailDiff
|
|
|
262
242
|
# @rbs @timeline_snapshotter: TimelineSnapshotProvider
|
|
263
243
|
# @rbs @activity_snapshotter: ActivitySnapshotProvider
|
|
264
244
|
|
|
265
|
-
# The result may still be correct -- nothing the path reaches may have
|
|
266
|
-
# changed -- and the gem cannot tell which, since not seeing the change is
|
|
267
|
-
# the symptom. So it reports the condition and leaves the judgement to the
|
|
268
|
-
# application.
|
|
269
|
-
#: (untyped, untyped) -> void
|
|
270
|
-
def notify_ambiguous_association_boundary(from_endpoint, to_endpoint)
|
|
271
|
-
return unless ambiguous_association_boundary?(from_endpoint, to_endpoint)
|
|
272
|
-
|
|
273
|
-
Instrumentation.notify(
|
|
274
|
-
'ambiguous_association_boundary',
|
|
275
|
-
@instrumentation_payload.merge(
|
|
276
|
-
item_type: from_endpoint.item_type.to_s,
|
|
277
|
-
version_ids: [from_endpoint.id, to_endpoint.id].freeze,
|
|
278
|
-
recorded_at: from_endpoint.created_at
|
|
279
|
-
)
|
|
280
|
-
)
|
|
281
|
-
end
|
|
282
|
-
|
|
283
|
-
# Loaded history orders two versions that share a timestamp by id, but
|
|
284
|
-
# PT-AT places association changes by timestamp alone, so only a path it
|
|
285
|
-
# reads can lose a change between them. A request the preparer refuses
|
|
286
|
-
# raises here, before anything is reported.
|
|
287
|
-
#: (untyped, untyped) -> bool
|
|
288
|
-
def ambiguous_association_boundary?(from_endpoint, to_endpoint)
|
|
289
|
-
return false if @association_tree.empty?
|
|
290
|
-
return false unless Endpoint.version?(from_endpoint) && Endpoint.version?(to_endpoint)
|
|
291
|
-
return false unless from_endpoint.created_at == to_endpoint.created_at
|
|
292
|
-
|
|
293
|
-
model_class = RecordedClass.for(from_endpoint)
|
|
294
|
-
@traversal_preparer.call(model_class, historical: true)
|
|
295
|
-
FallbackPaths.any?(@traversal, model_class, approximate: true)
|
|
296
|
-
end
|
|
297
|
-
|
|
298
245
|
# With neither a window nor endpoints, a range is the record's whole
|
|
299
246
|
# history through its current saved state; a missing endpoint takes that
|
|
300
247
|
# side of the same default.
|
|
@@ -302,7 +249,17 @@ module PaperTrailDiff
|
|
|
302
249
|
def default_range(record, from, to, within)
|
|
303
250
|
return [from, to] unless within.nil?
|
|
304
251
|
|
|
305
|
-
[from.nil? ? :first : from, to.nil? ? record : to]
|
|
252
|
+
[from.nil? ? :first : from, to.nil? ? default_end(record) : to]
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# The current record, or a destroyed one's last version, which a window
|
|
256
|
+
# also ends at: its history stops at the destroy.
|
|
257
|
+
#: (untyped) -> untyped
|
|
258
|
+
def default_end(record)
|
|
259
|
+
return record unless Endpoint.record?(record) && record.destroyed?
|
|
260
|
+
|
|
261
|
+
relation = VersionQuery.for_items(record.class, [record.id.to_s])
|
|
262
|
+
VersionQuery.chronological(relation).last || record
|
|
306
263
|
end
|
|
307
264
|
|
|
308
265
|
# A window with nothing recorded after its last change ends at the live
|
|
@@ -358,7 +315,7 @@ module PaperTrailDiff
|
|
|
358
315
|
normalizer: @normalizer,
|
|
359
316
|
full_snapshotter: snapshots.method(:call),
|
|
360
317
|
partial_snapshotter: snapshots.method(:custom),
|
|
361
|
-
|
|
318
|
+
member_snapshot: snapshots.method(:member),
|
|
362
319
|
record_transition: snapshots.method(:record_transition),
|
|
363
320
|
prepared_record_after: snapshots.method(:record_after),
|
|
364
321
|
root_state: snapshots.method(:root_state)
|
|
@@ -371,7 +328,7 @@ module PaperTrailDiff
|
|
|
371
328
|
record,
|
|
372
329
|
range: TimelineRange.new(
|
|
373
330
|
record, from: from, to: to, within: within, version_scope: version_scope,
|
|
374
|
-
live_endpoint: live_endpoint
|
|
331
|
+
live_endpoint: live_endpoint
|
|
375
332
|
),
|
|
376
333
|
snapshotter: @activity_snapshotter,
|
|
377
334
|
view: view, traversal: @traversal
|
|
@@ -385,7 +342,7 @@ module PaperTrailDiff
|
|
|
385
342
|
|
|
386
343
|
#: (untyped) -> RecordSnapshot?
|
|
387
344
|
def historical_snapshot(version)
|
|
388
|
-
|
|
345
|
+
@historical_store.at_version(version)
|
|
389
346
|
end
|
|
390
347
|
|
|
391
348
|
#: (untyped, untyped, ?history: PreparedHistory?) -> RecordSnapshot?
|