paper_trail_diff 0.14.0 → 0.16.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 +501 -0
- data/QUICKSTART.md +21 -4
- data/README.md +59 -56
- data/docs/architecture.md +32 -11
- data/docs/performance.md +125 -391
- data/docs/reference.md +470 -117
- data/docs/testing.md +83 -7
- data/lib/paper_trail_diff/activity_boundary.rb +83 -26
- data/lib/paper_trail_diff/activity_child_candidate_loader.rb +2 -1
- data/lib/paper_trail_diff/activity_collection_event_applier.rb +33 -1
- data/lib/paper_trail_diff/activity_event.rb +41 -10
- data/lib/paper_trail_diff/activity_event_route_finder.rb +31 -0
- data/lib/paper_trail_diff/activity_event_snapshot_refresher.rb +12 -1
- data/lib/paper_trail_diff/activity_history.rb +34 -9
- data/lib/paper_trail_diff/activity_range.rb +18 -3
- data/lib/paper_trail_diff/activity_root_snapshot_refresher.rb +43 -25
- data/lib/paper_trail_diff/activity_snapshot_sequence.rb +76 -37
- data/lib/paper_trail_diff/activity_target_candidate_loader.rb +5 -5
- data/lib/paper_trail_diff/activity_timeline_builder.rb +272 -111
- data/lib/paper_trail_diff/activity_transaction_grouper.rb +2 -1
- data/lib/paper_trail_diff/activity_tree_filter.rb +114 -0
- data/lib/paper_trail_diff/activity_version_collector.rb +7 -5
- data/lib/paper_trail_diff/activity_view.rb +69 -0
- data/lib/paper_trail_diff/analysis.rb +37 -6
- data/lib/paper_trail_diff/analysis_batch.rb +25 -31
- data/lib/paper_trail_diff/approximate_paths.rb +48 -0
- data/lib/paper_trail_diff/association_activity_edge.rb +6 -6
- data/lib/paper_trail_diff/association_discovery.rb +9 -1
- data/lib/paper_trail_diff/association_key.rb +56 -0
- data/lib/paper_trail_diff/association_traversal.rb +13 -4
- data/lib/paper_trail_diff/batch_boundary_resolver.rb +3 -4
- data/lib/paper_trail_diff/batch_preload.rb +53 -0
- data/lib/paper_trail_diff/batched_root_analyzer.rb +18 -14
- data/lib/paper_trail_diff/batched_root_versions.rb +38 -14
- data/lib/paper_trail_diff/branch_snapshot_refresher.rb +19 -16
- data/lib/paper_trail_diff/change_row.rb +133 -0
- data/lib/paper_trail_diff/collection_comparator.rb +5 -32
- data/lib/paper_trail_diff/configuration.rb +35 -12
- data/lib/paper_trail_diff/deleted_analysis_batch.rb +23 -19
- data/lib/paper_trail_diff/deleted_root_filter.rb +101 -0
- data/lib/paper_trail_diff/deprecation.rb +61 -0
- data/lib/paper_trail_diff/diagnostics.rb +86 -99
- data/lib/paper_trail_diff/endpoint.rb +26 -3
- data/lib/paper_trail_diff/errors.rb +3 -1
- data/lib/paper_trail_diff/fallback_paths.rb +38 -0
- data/lib/paper_trail_diff/historical_association_reifier.rb +2 -4
- data/lib/paper_trail_diff/historical_filter.rb +19 -10
- data/lib/paper_trail_diff/historical_snapshot_store.rb +57 -67
- data/lib/paper_trail_diff/live_endpoint_batch_loader.rb +1 -35
- data/lib/paper_trail_diff/nested_comparator.rb +19 -18
- data/lib/paper_trail_diff/paper_trail_adapter.rb +198 -166
- data/lib/paper_trail_diff/preloaded_endpoint_batch_loader.rb +13 -1
- data/lib/paper_trail_diff/prepared_activity_index.rb +17 -13
- data/lib/paper_trail_diff/prepared_edge_loader.rb +2 -1
- data/lib/paper_trail_diff/prepared_history.rb +15 -1
- data/lib/paper_trail_diff/prepared_history_loader.rb +2 -3
- data/lib/paper_trail_diff/prepared_record_index.rb +42 -7
- data/lib/paper_trail_diff/read_snapshot.rb +77 -0
- data/lib/paper_trail_diff/root_version_selection.rb +4 -2
- data/lib/paper_trail_diff/scope_condition.rb +157 -32
- data/lib/paper_trail_diff/scope_ranking.rb +23 -14
- data/lib/paper_trail_diff/scoped_analysis.rb +11 -0
- data/lib/paper_trail_diff/scoped_analysis_builder.rb +29 -11
- data/lib/paper_trail_diff/scoped_root_selection.rb +29 -16
- data/lib/paper_trail_diff/snapshot.rb +16 -1
- data/lib/paper_trail_diff/support.rb +29 -2
- data/lib/paper_trail_diff/time_range.rb +39 -16
- data/lib/paper_trail_diff/timeline_builder.rb +13 -7
- data/lib/paper_trail_diff/timeline_range.rb +9 -1
- data/lib/paper_trail_diff/timeline_snapshot_provider.rb +24 -17
- data/lib/paper_trail_diff/transaction_cut.rb +240 -0
- data/lib/paper_trail_diff/traversal_preparer.rb +134 -29
- data/lib/paper_trail_diff/version.rb +1 -1
- data/lib/paper_trail_diff/version_boundary.rb +41 -10
- data/lib/paper_trail_diff/version_query.rb +34 -10
- data/lib/paper_trail_diff/version_scope_filter.rb +9 -10
- data/lib/paper_trail_diff/version_sequence_diagnostics.rb +35 -17
- data/lib/paper_trail_diff/version_table.rb +60 -0
- data/lib/paper_trail_diff.rb +101 -57
- data/sig/generated/paper_trail_diff/activity_boundary.rbs +54 -19
- data/sig/generated/paper_trail_diff/activity_collection_event_applier.rbs +13 -0
- data/sig/generated/paper_trail_diff/activity_event.rbs +25 -4
- data/sig/generated/paper_trail_diff/activity_event_route_finder.rbs +14 -0
- data/sig/generated/paper_trail_diff/activity_event_snapshot_refresher.rbs +6 -0
- data/sig/generated/paper_trail_diff/activity_history.rbs +21 -6
- data/sig/generated/paper_trail_diff/activity_range.rbs +9 -2
- data/sig/generated/paper_trail_diff/activity_root_snapshot_refresher.rbs +21 -10
- data/sig/generated/paper_trail_diff/activity_snapshot_sequence.rbs +48 -9
- data/sig/generated/paper_trail_diff/activity_timeline_builder.rbs +138 -30
- data/sig/generated/paper_trail_diff/activity_tree_filter.rbs +73 -0
- data/sig/generated/paper_trail_diff/activity_version_collector.rbs +2 -0
- data/sig/generated/paper_trail_diff/activity_view.rbs +42 -0
- data/sig/generated/paper_trail_diff/analysis.rbs +24 -5
- data/sig/generated/paper_trail_diff/analysis_batch.rbs +8 -15
- data/sig/generated/paper_trail_diff/approximate_paths.rbs +23 -0
- data/sig/generated/paper_trail_diff/association_discovery.rbs +5 -0
- data/sig/generated/paper_trail_diff/association_key.rbs +29 -0
- data/sig/generated/paper_trail_diff/association_traversal.rbs +4 -0
- data/sig/generated/paper_trail_diff/batch_preload.rbs +29 -0
- data/sig/generated/paper_trail_diff/batched_root_analyzer.rbs +13 -10
- data/sig/generated/paper_trail_diff/batched_root_versions.rbs +14 -4
- data/sig/generated/paper_trail_diff/branch_snapshot_refresher.rbs +6 -0
- data/sig/generated/paper_trail_diff/change_row.rbs +86 -0
- data/sig/generated/paper_trail_diff/collection_comparator.rbs +2 -16
- data/sig/generated/paper_trail_diff/configuration.rbs +19 -3
- data/sig/generated/paper_trail_diff/deleted_analysis_batch.rbs +11 -8
- data/sig/generated/paper_trail_diff/deleted_root_filter.rbs +56 -0
- data/sig/generated/paper_trail_diff/deprecation.rbs +35 -0
- data/sig/generated/paper_trail_diff/diagnostics.rbs +37 -30
- data/sig/generated/paper_trail_diff/endpoint.rbs +11 -2
- data/sig/generated/paper_trail_diff/errors.rbs +3 -1
- data/sig/generated/paper_trail_diff/fallback_paths.rbs +22 -0
- data/sig/generated/paper_trail_diff/historical_filter.rbs +12 -2
- data/sig/generated/paper_trail_diff/historical_snapshot_store.rbs +33 -28
- data/sig/generated/paper_trail_diff/live_endpoint_batch_loader.rbs +0 -15
- data/sig/generated/paper_trail_diff/nested_comparator.rbs +10 -7
- data/sig/generated/paper_trail_diff/paper_trail_adapter.rbs +64 -52
- data/sig/generated/paper_trail_diff/preloaded_endpoint_batch_loader.rbs +9 -1
- data/sig/generated/paper_trail_diff/prepared_activity_index.rbs +11 -4
- data/sig/generated/paper_trail_diff/prepared_history.rbs +10 -0
- data/sig/generated/paper_trail_diff/prepared_record_index.rbs +20 -2
- data/sig/generated/paper_trail_diff/read_snapshot.rbs +43 -0
- data/sig/generated/paper_trail_diff/root_version_selection.rbs +2 -0
- data/sig/generated/paper_trail_diff/scope_condition.rbs +81 -15
- data/sig/generated/paper_trail_diff/scope_ranking.rbs +14 -6
- data/sig/generated/paper_trail_diff/scoped_analysis.rbs +6 -0
- data/sig/generated/paper_trail_diff/scoped_analysis_builder.rbs +14 -2
- data/sig/generated/paper_trail_diff/scoped_root_selection.rbs +16 -7
- data/sig/generated/paper_trail_diff/snapshot.rbs +8 -0
- data/sig/generated/paper_trail_diff/support.rbs +15 -0
- data/sig/generated/paper_trail_diff/time_range.rbs +24 -9
- data/sig/generated/paper_trail_diff/timeline_builder.rbs +6 -2
- data/sig/generated/paper_trail_diff/timeline_range.rbs +2 -0
- data/sig/generated/paper_trail_diff/timeline_snapshot_provider.rbs +17 -7
- data/sig/generated/paper_trail_diff/transaction_cut.rbs +126 -0
- data/sig/generated/paper_trail_diff/traversal_preparer.rbs +66 -8
- data/sig/generated/paper_trail_diff/version_boundary.rbs +22 -3
- data/sig/generated/paper_trail_diff/version_query.rbs +18 -2
- data/sig/generated/paper_trail_diff/version_scope_filter.rbs +4 -5
- data/sig/generated/paper_trail_diff/version_sequence_diagnostics.rbs +19 -9
- data/sig/generated/paper_trail_diff/version_table.rbs +30 -0
- data/sig/generated/paper_trail_diff.rbs +29 -26
- metadata +49 -11
- data/lib/paper_trail_diff/activity_grouping.rb +0 -38
- data/lib/paper_trail_diff/batch_safety.rb +0 -63
- data/lib/paper_trail_diff/time_activity_timeline_builder.rb +0 -223
- data/sig/generated/paper_trail_diff/activity_grouping.rbs +0 -22
- data/sig/generated/paper_trail_diff/batch_safety.rbs +0 -30
- data/sig/generated/paper_trail_diff/time_activity_timeline_builder.rbs +0 -92
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
# rbs_inline: enabled
|
|
3
3
|
|
|
4
4
|
module PaperTrailDiff
|
|
5
|
-
# Reconstructs and caches immutable historical snapshots for one adapter
|
|
5
|
+
# Reconstructs and caches immutable historical snapshots for one adapter
|
|
6
|
+
# configuration. It keeps the histories batches prepare, by root version;
|
|
7
|
+
# one prepared for a single root goes back to the caller, who passes it to
|
|
8
|
+
# every read for that root.
|
|
6
9
|
class HistoricalSnapshotStore
|
|
7
10
|
#: (tree: AssociationTree, traversal: AssociationTraversal, normalizer: SnapshotNormalizer, preparer: untyped) -> void
|
|
8
11
|
def initialize(tree:, traversal:, normalizer:, preparer:)
|
|
@@ -13,11 +16,11 @@ module PaperTrailDiff
|
|
|
13
16
|
@prepared_snapshotter = PreparedSnapshotBuilder.new(traversal)
|
|
14
17
|
@live_graph_collector = LiveGraphCollector.new(tree: tree, traversal: traversal)
|
|
15
18
|
@snapshots = {} #: Hash[Array[untyped], RecordSnapshot?]
|
|
16
|
-
@prepared_history = nil #: PreparedHistory?
|
|
17
19
|
@prepared_histories = {} #: Hash[Array[untyped], PreparedHistory]
|
|
20
|
+
@live_roots = {} #: Hash[identity, untyped]
|
|
18
21
|
end
|
|
19
22
|
|
|
20
|
-
#: (untyped, Array[untyped], ?start_at: untyped, ?end_at: untyped) ->
|
|
23
|
+
#: (untyped, Array[untyped], ?start_at: untyped, ?end_at: untyped) -> PreparedHistory?
|
|
21
24
|
def prepare(
|
|
22
25
|
record,
|
|
23
26
|
root_versions,
|
|
@@ -28,12 +31,9 @@ module PaperTrailDiff
|
|
|
28
31
|
|
|
29
32
|
# A batched preparation already covers these roots.
|
|
30
33
|
batched = root_versions.find { |version| @prepared_histories.key?(context_key(version)) }
|
|
31
|
-
if batched
|
|
32
|
-
@prepared_history = @prepared_histories.fetch(context_key(batched))
|
|
33
|
-
return
|
|
34
|
-
end
|
|
34
|
+
return @prepared_histories.fetch(context_key(batched)) if batched
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
PreparedHistoryLoader.new(
|
|
37
37
|
record, root_ids: [record.id], root_versions: root_versions, start_at: start_at,
|
|
38
38
|
end_at: end_at, tree: @tree, traversal: @traversal, live_records: []
|
|
39
39
|
).call
|
|
@@ -46,6 +46,9 @@ module PaperTrailDiff
|
|
|
46
46
|
Instrumentation.instrument('prepare_history', batch_payload(records, root_versions)) do
|
|
47
47
|
register_batch(records, root_versions, start_at: start_at, end_at: end_at)
|
|
48
48
|
end
|
|
49
|
+
# A batch passes its roots as it just loaded them, so the current state
|
|
50
|
+
# they close on is read from them rather than once more per root.
|
|
51
|
+
records.each { |record| @live_roots[Endpoint.identity(record)] = record }
|
|
49
52
|
end
|
|
50
53
|
|
|
51
54
|
# Missing roots, and roots compared only between versions, have no live
|
|
@@ -58,50 +61,41 @@ module PaperTrailDiff
|
|
|
58
61
|
register_batch(records, root_versions, live_records: [], start_at: start_at, end_at: end_at)
|
|
59
62
|
end
|
|
60
63
|
|
|
61
|
-
|
|
62
|
-
|
|
64
|
+
# `history` is the one `prepare` returned for this root, if any.
|
|
65
|
+
#: (untyped, untyped, ?history: PreparedHistory?) -> RecordSnapshot?
|
|
66
|
+
def call(root_endpoint, context_endpoint, history: nil)
|
|
63
67
|
key = snapshot_key(root_endpoint, context_endpoint)
|
|
64
68
|
return @snapshots[key] if @snapshots.key?(key)
|
|
65
69
|
|
|
66
|
-
@snapshots[key] = uncached(root_endpoint, context_endpoint)
|
|
70
|
+
@snapshots[key] = uncached(root_endpoint, context_endpoint, history: history)
|
|
67
71
|
end
|
|
68
72
|
|
|
69
|
-
#: (untyped, untyped) -> RecordSnapshot?
|
|
70
|
-
def uncached(root_endpoint, context_endpoint)
|
|
71
|
-
custom(
|
|
72
|
-
|
|
73
|
-
context_endpoint,
|
|
74
|
-
tree: @tree,
|
|
75
|
-
normalizer: @normalizer
|
|
76
|
-
)
|
|
73
|
+
#: (untyped, untyped, ?history: PreparedHistory?) -> RecordSnapshot?
|
|
74
|
+
def uncached(root_endpoint, context_endpoint, history: nil)
|
|
75
|
+
custom(root_endpoint, context_endpoint, tree: @tree, normalizer: @normalizer,
|
|
76
|
+
history: history)
|
|
77
77
|
end
|
|
78
78
|
|
|
79
|
-
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer) -> RecordSnapshot?
|
|
80
|
-
def custom(root_endpoint, context_endpoint, tree:, normalizer:)
|
|
79
|
+
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer, ?history: PreparedHistory?) -> RecordSnapshot?
|
|
80
|
+
def custom(root_endpoint, context_endpoint, tree:, normalizer:, history: nil)
|
|
81
|
+
history = history_for(context_endpoint, history)
|
|
81
82
|
if Endpoint.version?(root_endpoint)
|
|
82
83
|
return snapshot_from_version(
|
|
83
|
-
root_endpoint,
|
|
84
|
-
context_endpoint,
|
|
85
|
-
tree: tree,
|
|
86
|
-
normalizer: normalizer
|
|
84
|
+
root_endpoint, context_endpoint, tree: tree, normalizer: normalizer, history: history
|
|
87
85
|
)
|
|
88
86
|
end
|
|
89
87
|
|
|
90
|
-
snapshot_from_live_root(
|
|
91
|
-
|
|
92
|
-
context_endpoint,
|
|
93
|
-
tree: tree,
|
|
94
|
-
normalizer: normalizer
|
|
95
|
-
)
|
|
88
|
+
snapshot_from_live_root(root_endpoint, context_endpoint, tree: tree, normalizer: normalizer,
|
|
89
|
+
history: history)
|
|
96
90
|
end
|
|
97
91
|
|
|
98
|
-
#: (untyped, habtm_version: untyped) -> untyped
|
|
99
|
-
def association_reader(context_version, habtm_version:)
|
|
92
|
+
#: (untyped, habtm_version: untyped, ?history: PreparedHistory?) -> untyped
|
|
93
|
+
def association_reader(context_version, habtm_version:, history: nil)
|
|
100
94
|
fallback = HistoricalAssociationReifier.new(
|
|
101
95
|
context_version,
|
|
102
96
|
habtm_version: habtm_version
|
|
103
97
|
)
|
|
104
|
-
history =
|
|
98
|
+
history = history_for(context_version, history)
|
|
105
99
|
return fallback unless history
|
|
106
100
|
|
|
107
101
|
PreparedAssociationReifier.new(
|
|
@@ -112,25 +106,6 @@ module PaperTrailDiff
|
|
|
112
106
|
)
|
|
113
107
|
end
|
|
114
108
|
|
|
115
|
-
#: () -> PreparedActivityIndex?
|
|
116
|
-
def activity_index
|
|
117
|
-
@prepared_history&.activity_index
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
#: (untyped) -> [Hash[untyped, untyped], Hash[untyped, untyped]]?
|
|
121
|
-
def record_transition(version)
|
|
122
|
-
history = @prepared_history
|
|
123
|
-
return unless history
|
|
124
|
-
|
|
125
|
-
history.record_transition(Endpoint.model_class(version), version.item_id, version)
|
|
126
|
-
end
|
|
127
|
-
|
|
128
|
-
#: (untyped, ?direct: bool) -> [bool, untyped]
|
|
129
|
-
def record_after(version, direct: false)
|
|
130
|
-
@prepared_history&.record_after(Endpoint.model_class(version), version.item_id, version,
|
|
131
|
-
direct: direct) || [false, nil]
|
|
132
|
-
end
|
|
133
|
-
|
|
134
109
|
private
|
|
135
110
|
|
|
136
111
|
# @rbs @tree: AssociationTree
|
|
@@ -140,8 +115,14 @@ module PaperTrailDiff
|
|
|
140
115
|
# @rbs @prepared_snapshotter: PreparedSnapshotBuilder
|
|
141
116
|
# @rbs @live_graph_collector: LiveGraphCollector
|
|
142
117
|
# @rbs @snapshots: Hash[Array[untyped], RecordSnapshot?]
|
|
143
|
-
# @rbs @prepared_history: PreparedHistory?
|
|
144
118
|
# @rbs @prepared_histories: Hash[Array[untyped], PreparedHistory]
|
|
119
|
+
# @rbs @live_roots: Hash[identity, untyped]
|
|
120
|
+
|
|
121
|
+
# A batch's history for the version wins over the one a caller passes.
|
|
122
|
+
#: (untyped, PreparedHistory?) -> PreparedHistory?
|
|
123
|
+
def history_for(context_endpoint, history)
|
|
124
|
+
@prepared_histories[context_key(context_endpoint)] || history
|
|
125
|
+
end
|
|
145
126
|
|
|
146
127
|
#: (untyped) -> Array[untyped]
|
|
147
128
|
def context_key(endpoint)
|
|
@@ -170,34 +151,43 @@ module PaperTrailDiff
|
|
|
170
151
|
root_versions.each { |version| @prepared_histories[context_key(version)] = history }
|
|
171
152
|
end
|
|
172
153
|
|
|
173
|
-
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer) -> RecordSnapshot?
|
|
174
|
-
def snapshot_from_version(root_version, context_version, tree:, normalizer:)
|
|
154
|
+
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer, history: PreparedHistory?) -> RecordSnapshot?
|
|
155
|
+
def snapshot_from_version(root_version, context_version, tree:, normalizer:, history:)
|
|
175
156
|
model_class = RecordedClass.for(root_version)
|
|
176
157
|
@preparer.call(model_class, historical: true)
|
|
177
158
|
@traversal.ensure_habtm_history!(model_class, root_version)
|
|
178
159
|
handled, snapshot = @prepared_snapshotter.call(
|
|
179
|
-
root_version, context_version, tree: tree, normalizer: normalizer,
|
|
180
|
-
history: @prepared_histories[context_key(context_version)] ||
|
|
181
|
-
@prepared_history
|
|
160
|
+
root_version, context_version, tree: tree, normalizer: normalizer, history: history
|
|
182
161
|
)
|
|
183
162
|
return snapshot if handled
|
|
184
163
|
|
|
185
164
|
record = root_version.reify(dup: true)
|
|
186
165
|
normalize(record, context_version, tree: tree, normalizer: normalizer,
|
|
187
|
-
habtm_version: root_version)
|
|
166
|
+
habtm_version: root_version, history: history)
|
|
188
167
|
end
|
|
189
168
|
|
|
190
|
-
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer) -> RecordSnapshot?
|
|
191
|
-
def snapshot_from_live_root(root_record, context_version, tree:, normalizer:)
|
|
192
|
-
record =
|
|
169
|
+
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer, history: PreparedHistory?) -> RecordSnapshot?
|
|
170
|
+
def snapshot_from_live_root(root_record, context_version, tree:, normalizer:, history:)
|
|
171
|
+
record = live_root(root_record)
|
|
193
172
|
@preparer.call(record.class, historical: true)
|
|
194
173
|
normalize(record, context_version, tree: tree, normalizer: normalizer,
|
|
195
|
-
habtm_version: context_version)
|
|
174
|
+
habtm_version: context_version, history: history)
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Rebuilding a version's associations writes them onto the record, so each
|
|
178
|
+
# snapshot gets its own copy of a batch's loaded row, built from the row's
|
|
179
|
+
# stored values without a query.
|
|
180
|
+
#: (untyped) -> untyped
|
|
181
|
+
def live_root(root_record)
|
|
182
|
+
loaded = @live_roots[Endpoint.identity(root_record)]
|
|
183
|
+
return Endpoint.reload_record(root_record) unless loaded
|
|
184
|
+
|
|
185
|
+
loaded.class.instantiate(loaded.attributes_before_type_cast)
|
|
196
186
|
end
|
|
197
187
|
|
|
198
|
-
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer, habtm_version: untyped) -> RecordSnapshot?
|
|
199
|
-
def normalize(record, context_version, tree:, normalizer:, habtm_version:)
|
|
200
|
-
reifier = association_reader(context_version, habtm_version: habtm_version)
|
|
188
|
+
#: (untyped, untyped, tree: AssociationTree, normalizer: SnapshotNormalizer, habtm_version: untyped, history: PreparedHistory?) -> RecordSnapshot?
|
|
189
|
+
def normalize(record, context_version, tree:, normalizer:, habtm_version:, history:) # rubocop:disable Metrics/ParameterLists
|
|
190
|
+
reifier = association_reader(context_version, habtm_version: habtm_version, history: history)
|
|
201
191
|
reflections = [] #: Array[untyped]
|
|
202
192
|
reflections = @traversal.reflections_for(record.class, tree, path: '') if record
|
|
203
193
|
reifier.reify(record, reflections) if record && !reflections.empty?
|
|
@@ -46,9 +46,7 @@ module PaperTrailDiff
|
|
|
46
46
|
def preload_model_tree(model_class, records, tree)
|
|
47
47
|
reflections = selected_reflections(model_class, tree)
|
|
48
48
|
resolve_polymorphic_targets(records, reflections)
|
|
49
|
-
batch, individual = reflections.partition
|
|
50
|
-
batch_safe?(records.fetch(0), reflection)
|
|
51
|
-
end
|
|
49
|
+
batch, individual = reflections.partition { |reflection, _| BatchPreload.safe?(reflection) }
|
|
52
50
|
preload_batch(records, batch.map { |reflection, _| reflection.name })
|
|
53
51
|
preload_subtrees(records, batch, individually: false)
|
|
54
52
|
preload_subtrees(records, individual, individually: true)
|
|
@@ -101,38 +99,6 @@ module PaperTrailDiff
|
|
|
101
99
|
active_record.const_get(:Associations).const_get(:Preloader)
|
|
102
100
|
end
|
|
103
101
|
|
|
104
|
-
# The preloader applies a limit or offset to all owners' records at once,
|
|
105
|
-
# not to each owner's, so such an association is loaded per record. A
|
|
106
|
-
# has_one is no exception. Through a part with a limit, an offset or a
|
|
107
|
-
# has_one cut, the preloader keeps what the part alone would load, while
|
|
108
|
-
# the through's own query keeps the part's conditions only.
|
|
109
|
-
#: (untyped, untyped) -> bool
|
|
110
|
-
def batch_safe?(record, reflection)
|
|
111
|
-
scope = reflection.scope
|
|
112
|
-
return false if scope && !scope.arity.zero?
|
|
113
|
-
return true unless reflection.collection? || reflection.has_one?
|
|
114
|
-
return false if cut_part?(reflection)
|
|
115
|
-
|
|
116
|
-
relation = record.association(reflection.name).scope
|
|
117
|
-
relation.limit_value.nil? && relation.offset_value.nil?
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
#: (untyped) -> bool
|
|
121
|
-
def cut_part?(reflection)
|
|
122
|
-
reflection.collection? &&
|
|
123
|
-
(ScopeCondition.ranked_parts?(reflection) || through_parts(reflection).any?(&:has_one?))
|
|
124
|
-
end
|
|
125
|
-
|
|
126
|
-
# Every part a through passes, at any depth.
|
|
127
|
-
#: (untyped) -> Array[untyped]
|
|
128
|
-
def through_parts(reflection)
|
|
129
|
-
return [] unless reflection.through_reflection?
|
|
130
|
-
|
|
131
|
-
[reflection.through_reflection, reflection.source_reflection].flat_map do |part|
|
|
132
|
-
[part, *through_parts(part)]
|
|
133
|
-
end
|
|
134
|
-
end
|
|
135
|
-
|
|
136
102
|
#: (Array[untyped], untyped) -> Array[untyped]
|
|
137
103
|
def load_individually(records, reflection)
|
|
138
104
|
unique_records(records.flat_map do |record|
|
|
@@ -52,13 +52,17 @@ module PaperTrailDiff
|
|
|
52
52
|
# Returns the changed paths, or an empty hash when the pair is not two
|
|
53
53
|
# structures this can look inside. An empty result therefore means "nothing
|
|
54
54
|
# to report at this depth", and the caller still has the whole-value change.
|
|
55
|
+
# Two arrays at the top are one membership change, at the empty path.
|
|
55
56
|
#: () -> nested_changes
|
|
56
57
|
def call
|
|
57
|
-
|
|
58
|
+
from, to = structures
|
|
58
59
|
changes = {} #: nested_changes
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
60
|
+
if from.is_a?(Hash) && to.is_a?(Hash)
|
|
61
|
+
walk(from, to, [], changes)
|
|
62
|
+
elsif from.is_a?(Array) && to.is_a?(Array)
|
|
63
|
+
whole = [] #: Array[String]
|
|
64
|
+
changes[whole.freeze] = change_for(from, to) if from != to
|
|
65
|
+
end
|
|
62
66
|
changes.freeze
|
|
63
67
|
end
|
|
64
68
|
|
|
@@ -67,26 +71,23 @@ module PaperTrailDiff
|
|
|
67
71
|
# @rbs @from_value: untyped
|
|
68
72
|
# @rbs @to_value: untyped
|
|
69
73
|
|
|
70
|
-
# Both sides have to be readable as
|
|
71
|
-
# anything. A column that held text on one side and
|
|
72
|
-
# changed wholesale, and saying so is the accurate report.
|
|
73
|
-
#: () -> [
|
|
74
|
+
# Both sides have to be readable as the same kind of structure for a
|
|
75
|
+
# nested answer to mean anything. A column that held text on one side and
|
|
76
|
+
# JSON on the other changed wholesale, and saying so is the accurate report.
|
|
77
|
+
#: () -> [untyped, untyped]
|
|
74
78
|
def structures
|
|
75
79
|
[structure(@from_value), structure(@to_value)]
|
|
76
80
|
end
|
|
77
81
|
|
|
78
|
-
|
|
82
|
+
# A string is read as JSON; anything else, or JSON that is neither an
|
|
83
|
+
# object nor an array, is left for #call to decline.
|
|
84
|
+
#: (untyped) -> untyped
|
|
79
85
|
def structure(value)
|
|
80
|
-
return value
|
|
81
|
-
return unless value.is_a?(String)
|
|
86
|
+
return value unless value.is_a?(String)
|
|
82
87
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
nil
|
|
87
|
-
end
|
|
88
|
-
# JSON parses objects into plain Hashes, never a subclass.
|
|
89
|
-
parsed if parsed.instance_of?(Hash)
|
|
88
|
+
JSON.parse(value)
|
|
89
|
+
rescue JSON::ParserError
|
|
90
|
+
nil
|
|
90
91
|
end
|
|
91
92
|
|
|
92
93
|
#: (Hash[untyped, untyped], Hash[untyped, untyped], Array[String], nested_changes) -> void
|