paper_trail_diff 0.16.0 → 0.17.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 +581 -1
- data/README.md +42 -7
- data/docs/architecture.md +7 -5
- data/docs/performance.md +86 -38
- data/docs/reference.md +309 -92
- data/docs/testing.md +240 -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 +3 -13
- 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 +29 -29
- data/lib/paper_trail_diff/activity_event_snapshot_refresher.rb +2 -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 +74 -40
- 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 +194 -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 +19 -5
- 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 +16 -14
- data/lib/paper_trail_diff/batched_root_versions.rb +25 -20
- data/lib/paper_trail_diff/branch_snapshot_refresher.rb +27 -31
- data/lib/paper_trail_diff/change_attribution.rb +329 -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 -37
- data/lib/paper_trail_diff/deleted_root_filter.rb +3 -6
- data/lib/paper_trail_diff/deprecation.rb +4 -43
- data/lib/paper_trail_diff/diagnostics.rb +1 -2
- 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 +40 -45
- data/lib/paper_trail_diff/prepared_activity_index.rb +197 -45
- 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 +20 -31
- data/lib/paper_trail_diff/prepared_history_loader.rb +46 -9
- data/lib/paper_trail_diff/prepared_record_index.rb +137 -47
- 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 +41 -19
- 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 +7 -17
- data/lib/paper_trail_diff/scope_ranking.rb +16 -22
- data/lib/paper_trail_diff/scoped_analysis.rb +27 -4
- data/lib/paper_trail_diff/scoped_analysis_builder.rb +4 -3
- data/lib/paper_trail_diff/scoped_root_selection.rb +60 -41
- 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 +37 -20
- data/lib/paper_trail_diff/time_version_range.rb +5 -10
- data/lib/paper_trail_diff/timeline_builder.rb +3 -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 +192 -91
- 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 +27 -16
- data/lib/paper_trail_diff/version_boundary.rb +37 -21
- 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 +32 -0
- data/lib/paper_trail_diff/version_table.rb +12 -8
- data/lib/paper_trail_diff.rb +28 -42
- 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 +0 -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 +11 -4
- data/sig/generated/paper_trail_diff/activity_event_snapshot_refresher.rbs +0 -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 +36 -2
- 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 +121 -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 +15 -6
- 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 +9 -8
- data/sig/generated/paper_trail_diff/batched_root_versions.rbs +10 -6
- data/sig/generated/paper_trail_diff/branch_snapshot_refresher.rbs +11 -5
- data/sig/generated/paper_trail_diff/change_attribution.rbs +194 -0
- data/sig/generated/paper_trail_diff/change_row.rbs +22 -7
- data/sig/generated/paper_trail_diff/deleted_analysis_batch.rbs +11 -12
- data/sig/generated/paper_trail_diff/deleted_root_filter.rbs +0 -2
- 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 +9 -6
- data/sig/generated/paper_trail_diff/prepared_activity_index.rbs +114 -14
- 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 +9 -12
- data/sig/generated/paper_trail_diff/prepared_history_loader.rbs +28 -3
- data/sig/generated/paper_trail_diff/prepared_record_index.rbs +68 -14
- 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 +27 -8
- 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 +0 -2
- data/sig/generated/paper_trail_diff/scope_ranking.rbs +10 -10
- data/sig/generated/paper_trail_diff/scoped_analysis.rbs +19 -0
- data/sig/generated/paper_trail_diff/scoped_analysis_builder.rbs +2 -2
- data/sig/generated/paper_trail_diff/scoped_root_selection.rbs +37 -14
- 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 -8
- data/sig/generated/paper_trail_diff/time_version_range.rbs +2 -5
- data/sig/generated/paper_trail_diff/timeline_builder.rbs +2 -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 +111 -52
- 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 +10 -9
- data/sig/generated/paper_trail_diff/version_boundary.rbs +15 -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 +13 -0
- data/sig/generated/paper_trail_diff/version_table.rbs +3 -0
- data/sig/generated/paper_trail_diff.rbs +16 -16
- metadata +28 -6
- 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
|
@@ -4,10 +4,109 @@
|
|
|
4
4
|
module PaperTrailDiff
|
|
5
5
|
# Internal helpers for isolating and serializing values held by result objects.
|
|
6
6
|
module Support # rubocop:disable Metrics/ModuleLength
|
|
7
|
-
|
|
7
|
+
# Ids per statement, for the queries that list them in slices. SQL Server
|
|
8
|
+
# compiles every statement afresh, since its ids are written into it, in
|
|
9
|
+
# time that grows with their number; fewer statements than this cost more
|
|
10
|
+
# than they save.
|
|
11
|
+
IDS_PER_STATEMENT = 500
|
|
12
|
+
|
|
13
|
+
# PaperTrail's YAML serializer stores a `time` column's value as this
|
|
14
|
+
# wrapper, which PaperTrail 16 and 17 decode by reading its `@time`. Only
|
|
15
|
+
# some zone-aware times are stored with one, as a TimeWithZone's fields
|
|
16
|
+
# under the wrapper's tag; any other wraps its time, and decodes as nil.
|
|
17
|
+
TIME_VALUE = 'ActiveRecord::Type::Time::Value'
|
|
18
|
+
|
|
19
|
+
# The date a database gives a time of day it reads back.
|
|
20
|
+
TIME_OF_DAY_DATE = { year: 2000, month: 1, day: 1 }.freeze #: Hash[Symbol, Integer]
|
|
21
|
+
|
|
22
|
+
# Answers a question about `value` once for each Active Record class, in
|
|
23
|
+
# `answers`: its respond_to? also looks through the instance's attributes,
|
|
24
|
+
# which costs more than most of what reading a version does, and every
|
|
25
|
+
# instance of a model answers alike, since this gem reads versions with
|
|
26
|
+
# all their columns. Anything else is asked each time.
|
|
27
|
+
#: [T] (Hash[untyped, T], untyped) { (untyped) -> T } -> T
|
|
28
|
+
def self.per_model(answers, value)
|
|
29
|
+
model = value.class
|
|
30
|
+
return yield(value) unless model.respond_to?(:column_names)
|
|
31
|
+
|
|
32
|
+
answers.fetch(model) { answers[model] = yield(value) }
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Stored attributes or changes ready for PaperTrail to decode: keyed by
|
|
36
|
+
# name, with each time of day unwrapped, which then decodes as any value
|
|
37
|
+
# does. A change's values are a pair.
|
|
38
|
+
#: (Hash[untyped, untyped]) -> Hash[String, untyped]
|
|
39
|
+
def self.decodable(stored)
|
|
40
|
+
stored.to_h { |name, value| [name.to_s, unwrapped_time(value)] }
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
#: (untyped) -> untyped
|
|
44
|
+
def self.unwrapped_time(value)
|
|
45
|
+
return value.map { |item| unwrapped_time(item) } if value.instance_of?(Array)
|
|
46
|
+
|
|
47
|
+
TIME_VALUE.eql?(value.class.name) ? recorded_time(value) : value
|
|
48
|
+
end
|
|
49
|
+
private_class_method :unwrapped_time
|
|
50
|
+
|
|
51
|
+
# The time a stored wrapper holds -- the one it wraps, or the `@time`
|
|
52
|
+
# PaperTrail reads -- on 2000-01-01, as the database keeps a time of day.
|
|
53
|
+
# Active Record keeps the date of a time assigned in memory, which
|
|
54
|
+
# PaperTrail stores, but the row holds only the time.
|
|
55
|
+
#: (untyped) -> untyped
|
|
56
|
+
def self.recorded_time(value)
|
|
57
|
+
value.__getobj__ { value.instance_variable_get(:@time) }&.change(**TIME_OF_DAY_DATE)
|
|
58
|
+
end
|
|
59
|
+
private_class_method :recorded_time
|
|
60
|
+
|
|
61
|
+
# PaperTrail's `reify`, with each time of day its version recorded.
|
|
62
|
+
#: (untyped, **untyped) -> untyped
|
|
63
|
+
def self.reify(version, **options)
|
|
64
|
+
with_recorded_times(version.reify(**options))
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# A record PaperTrail rebuilt, with each time of day assigned from the
|
|
68
|
+
# version it was rebuilt from, which PaperTrail can decode as nil. PaperTrail
|
|
69
|
+
# assigns stored attributes after building the record and links it to
|
|
70
|
+
# that version, PT-AT's members too, so this assigns what PaperTrail would
|
|
71
|
+
# if it unwrapped the value. Only a version whose stored text names the
|
|
72
|
+
# wrapper is decoded again; any other record is returned as it is.
|
|
73
|
+
#: [T] (T) -> T
|
|
74
|
+
def self.with_recorded_times(record)
|
|
75
|
+
version = rebuilt_from(record)
|
|
76
|
+
return record unless version
|
|
77
|
+
|
|
78
|
+
version.object_deserialized.each do |name, value|
|
|
79
|
+
next unless TIME_VALUE.eql?(value.class.name)
|
|
80
|
+
|
|
81
|
+
assign_recorded(record, name, recorded_time(value))
|
|
82
|
+
end
|
|
83
|
+
record
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
#: (untyped) -> untyped
|
|
87
|
+
def self.rebuilt_from(record)
|
|
88
|
+
model = record.class
|
|
89
|
+
return unless model.respond_to?(:version_association_name)
|
|
90
|
+
|
|
91
|
+
version = record.public_send(model.version_association_name)
|
|
92
|
+
# A JSON column's Hash is keyed by attribute names, never this one.
|
|
93
|
+
version if version&.object&.include?(TIME_VALUE)
|
|
94
|
+
end
|
|
95
|
+
private_class_method :rebuilt_from
|
|
96
|
+
|
|
97
|
+
# As PaperTrail assigns a stored attribute.
|
|
98
|
+
#: (untyped, String, untyped) -> void
|
|
99
|
+
def self.assign_recorded(record, name, value)
|
|
100
|
+
if record.has_attribute?(name)
|
|
101
|
+
record[name.to_sym] = value
|
|
102
|
+
elsif record.respond_to?(:"#{name}=")
|
|
103
|
+
record.public_send(:"#{name}=", value)
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
private_class_method :assign_recorded
|
|
8
107
|
|
|
9
108
|
#: (untyped) -> untyped
|
|
10
|
-
def immutable_copy(value)
|
|
109
|
+
def self.immutable_copy(value)
|
|
11
110
|
case value
|
|
12
111
|
when Hash
|
|
13
112
|
immutable_hash(value)
|
|
@@ -19,7 +118,7 @@ module PaperTrailDiff
|
|
|
19
118
|
end
|
|
20
119
|
|
|
21
120
|
#: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
|
|
22
|
-
def immutable_hash(value)
|
|
121
|
+
def self.immutable_hash(value)
|
|
23
122
|
copy = {} #: Hash[untyped, untyped]
|
|
24
123
|
value.each do |key, item|
|
|
25
124
|
copy[immutable_copy(key)] = immutable_copy(item)
|
|
@@ -29,7 +128,7 @@ module PaperTrailDiff
|
|
|
29
128
|
private_class_method :immutable_hash
|
|
30
129
|
|
|
31
130
|
#: (untyped) -> untyped
|
|
32
|
-
def serialize(value)
|
|
131
|
+
def self.serialize(value)
|
|
33
132
|
case value
|
|
34
133
|
when Hash
|
|
35
134
|
serialized = {} #: Hash[untyped, untyped]
|
|
@@ -49,7 +148,7 @@ module PaperTrailDiff
|
|
|
49
148
|
# id 10 before id 2, which is deterministic but reads as unsorted wherever a
|
|
50
149
|
# result is rendered.
|
|
51
150
|
#: (untyped, untyped) -> Array[untyped]
|
|
52
|
-
def sortable_identity(type, id)
|
|
151
|
+
def self.sortable_identity(type, id)
|
|
53
152
|
key = case id
|
|
54
153
|
when Numeric then [0, id]
|
|
55
154
|
when String, Symbol then [1, id.to_s]
|
|
@@ -58,13 +157,53 @@ module PaperTrailDiff
|
|
|
58
157
|
[type.to_s, key]
|
|
59
158
|
end
|
|
60
159
|
|
|
160
|
+
# Which loaded row a version or record is, across the lookups of a call:
|
|
161
|
+
# by its class's name rather than the class, so a row still matches after
|
|
162
|
+
# its class is reloaded.
|
|
163
|
+
#: (untyped) -> Array[untyped]
|
|
164
|
+
def self.row_key(row)
|
|
165
|
+
[row.class.name, row.id]
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Which record a model and id name, as Endpoint.identity reads a record:
|
|
169
|
+
# by its base class, so a subclass and its base name the same row.
|
|
170
|
+
#: (untyped, untyped) -> Array[String]
|
|
171
|
+
def self.record_identity(model_class, id)
|
|
172
|
+
[model_class.base_class.name, id.to_s]
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Only quoting helpers are needed where this is used, so the model's
|
|
176
|
+
# connection is borrowed for the block rather than checked out
|
|
177
|
+
# permanently, which Active Record 7.2 and newer can deprecate. Active
|
|
178
|
+
# Record 7.1 has no `with_connection` and reaches the same connection
|
|
179
|
+
# through the accessor.
|
|
180
|
+
#: [T] (untyped) { (untyped) -> T } -> T
|
|
181
|
+
def self.with_connection(model, &block)
|
|
182
|
+
return model.with_connection(&block) if model.respond_to?(:with_connection)
|
|
183
|
+
|
|
184
|
+
yield(model.connection)
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# A constant by its full name, such as a model's or one of Active
|
|
188
|
+
# Record's, untyped: Active Record and the models ship no signatures. Any
|
|
189
|
+
# spelling of the lookup finds the same constant.
|
|
190
|
+
# mutant:disable
|
|
191
|
+
#: (String) -> untyped
|
|
192
|
+
def self.constant(name)
|
|
193
|
+
Object.const_get(name)
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
# Arel, which ships no signatures either.
|
|
197
|
+
#: () -> untyped
|
|
198
|
+
def self.arel = constant('Arel')
|
|
199
|
+
|
|
61
200
|
#: (untyped) -> Array[untyped]
|
|
62
|
-
def chronological_version_key(version)
|
|
201
|
+
def self.chronological_version_key(version)
|
|
63
202
|
version_key(version.created_at, version.id)
|
|
64
203
|
end
|
|
65
204
|
|
|
66
205
|
#: (untyped, untyped) -> Array[untyped]
|
|
67
|
-
def version_key(created_at, id)
|
|
206
|
+
def self.version_key(created_at, id)
|
|
68
207
|
[created_at, id.to_s.rjust(32, '0')]
|
|
69
208
|
end
|
|
70
209
|
|
|
@@ -73,7 +212,7 @@ module PaperTrailDiff
|
|
|
73
212
|
# does; a UUID does not, so a tie between UUID-keyed versions is genuinely
|
|
74
213
|
# unorderable and any timeline built from it would be fiction.
|
|
75
214
|
#: (Array[untyped]) -> Array[untyped]
|
|
76
|
-
def chronological_sort(versions)
|
|
215
|
+
def self.chronological_sort(versions)
|
|
77
216
|
sorted = versions.sort_by { |version| chronological_version_key(version) }
|
|
78
217
|
ambiguous = ambiguous_pair(sorted)
|
|
79
218
|
return sorted unless ambiguous
|
|
@@ -82,7 +221,7 @@ module PaperTrailDiff
|
|
|
82
221
|
end
|
|
83
222
|
|
|
84
223
|
#: (Array[untyped]) -> Array[untyped]?
|
|
85
|
-
def ambiguous_pair(sorted)
|
|
224
|
+
def self.ambiguous_pair(sorted)
|
|
86
225
|
sorted.each_cons(2).find do |left, right|
|
|
87
226
|
left.created_at == right.created_at && !orderable_tie?(left, right)
|
|
88
227
|
end
|
|
@@ -91,14 +230,14 @@ module PaperTrailDiff
|
|
|
91
230
|
# Ids order versions saved in one instant only when they count up in one
|
|
92
231
|
# table. Two version tables count separately, so ids there say nothing.
|
|
93
232
|
#: (untyped, untyped) -> bool
|
|
94
|
-
def orderable_tie?(left, right)
|
|
233
|
+
def self.orderable_tie?(left, right)
|
|
95
234
|
version_table(left) == version_table(right) &&
|
|
96
235
|
sequential_id?(left.id) && sequential_id?(right.id)
|
|
97
236
|
end
|
|
98
237
|
|
|
99
238
|
#: (untyped) -> untyped
|
|
100
|
-
def version_table(version)
|
|
101
|
-
version.class.respond_to?(:table_name) ? version.class.table_name : version.class
|
|
239
|
+
def self.version_table(version)
|
|
240
|
+
version.class.respond_to?(:table_name) ? version.class.table_name : version.class
|
|
102
241
|
end
|
|
103
242
|
private_class_method :version_table
|
|
104
243
|
|
|
@@ -107,7 +246,7 @@ module PaperTrailDiff
|
|
|
107
246
|
# so association state cannot be told apart across such a pair even when the
|
|
108
247
|
# scalar sequence is perfectly recoverable.
|
|
109
248
|
#: (Array[untyped]) -> Array[untyped]?
|
|
110
|
-
def tied_timestamp_pair(versions)
|
|
249
|
+
def self.tied_timestamp_pair(versions)
|
|
111
250
|
versions.each_cons(2).find { |left, right| left.created_at == right.created_at }
|
|
112
251
|
end
|
|
113
252
|
|
|
@@ -120,7 +259,7 @@ module PaperTrailDiff
|
|
|
120
259
|
# distinguish the two, which is why this lives in one place: the predicate is
|
|
121
260
|
# easy to write in a form that looks right and always answers true.
|
|
122
261
|
#: (untyped) -> bool
|
|
123
|
-
def versioned?(model_class)
|
|
262
|
+
def self.versioned?(model_class)
|
|
124
263
|
model_class.respond_to?(:paper_trail_options) && !model_class.paper_trail_options.nil?
|
|
125
264
|
end
|
|
126
265
|
|
|
@@ -129,20 +268,34 @@ module PaperTrailDiff
|
|
|
129
268
|
# is cast to the key's type, or the same record read once from history and
|
|
130
269
|
# once from its live row would count as two.
|
|
131
270
|
#: (untyped, untyped) -> untyped
|
|
132
|
-
def record_id(model_class, id)
|
|
271
|
+
def self.record_id(model_class, id)
|
|
133
272
|
key = model_class.primary_key
|
|
134
|
-
return id
|
|
273
|
+
return id unless key.instance_of?(String)
|
|
135
274
|
|
|
136
275
|
model_class.type_for_attribute(key).cast(id)
|
|
137
276
|
end
|
|
138
277
|
|
|
278
|
+
# A relation's limit and offset as Active Record writes them into SQL.
|
|
279
|
+
# Before 8.1 it keeps a limit as given, as every version keeps an offset,
|
|
280
|
+
# so either may be a String, as request parameters are.
|
|
281
|
+
#: (untyped) -> Integer?
|
|
282
|
+
def self.limit(relation)
|
|
283
|
+
value = relation.limit_value
|
|
284
|
+
Integer(value) unless value.nil?
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
#: (untyped) -> Integer
|
|
288
|
+
def self.offset(relation)
|
|
289
|
+
relation.offset_value.to_i
|
|
290
|
+
end
|
|
291
|
+
|
|
139
292
|
#: (untyped) -> bool
|
|
140
|
-
def sequential_id?(id)
|
|
141
|
-
id.
|
|
293
|
+
def self.sequential_id?(id)
|
|
294
|
+
id.instance_of?(Integer) || id.to_s.match?(/\A\d+\z/)
|
|
142
295
|
end
|
|
143
296
|
|
|
144
297
|
#: (Array[untyped]) -> String
|
|
145
|
-
def ambiguous_message(pair)
|
|
298
|
+
def self.ambiguous_message(pair)
|
|
146
299
|
left, right = pair
|
|
147
300
|
"versions #{left.id.inspect} and #{right.id.inspect} share the timestamp " \
|
|
148
301
|
"#{left.created_at.inspect} and have ids that do not order them, so their " \
|
|
@@ -151,44 +304,41 @@ module PaperTrailDiff
|
|
|
151
304
|
end
|
|
152
305
|
|
|
153
306
|
#: (untyped, untyped) -> Integer
|
|
154
|
-
def compare_versions(left, right)
|
|
307
|
+
def self.compare_versions(left, right)
|
|
155
308
|
chronological_version_key(left) <=> chronological_version_key(right) ||
|
|
156
309
|
raise(ConfigurationError, 'versions have incomparable timestamps')
|
|
157
310
|
end
|
|
158
311
|
|
|
159
312
|
#: (String, String | Symbol) -> String
|
|
160
|
-
def association_path(parent, name)
|
|
313
|
+
def self.association_path(parent, name)
|
|
161
314
|
parent.empty? ? name.to_s : "#{parent}.#{name}"
|
|
162
315
|
end
|
|
163
316
|
|
|
317
|
+
# Groups of one name are joined: their ids, and their owners where both
|
|
318
|
+
# know some. A group that knows none has no :owners key.
|
|
164
319
|
#: (Hash[String, Hash[Symbol, untyped]], Hash[String, Hash[Symbol, untyped]]) -> Hash[String, Hash[Symbol, untyped]]
|
|
165
|
-
def merge_record_groups(existing, incoming)
|
|
320
|
+
def self.merge_record_groups(existing, incoming)
|
|
166
321
|
existing.merge(incoming) do |_name, left, right|
|
|
167
322
|
merged = left.merge(right, ids: (left.fetch(:ids) | right.fetch(:ids)))
|
|
168
|
-
|
|
169
|
-
|
|
323
|
+
next merged unless left.key?(:owners) && right.key?(:owners)
|
|
324
|
+
|
|
325
|
+
owners = left.fetch(:owners).merge(right.fetch(:owners)) do |_owner, first, second|
|
|
326
|
+
first | second
|
|
327
|
+
end
|
|
328
|
+
merged.merge(owners: owners)
|
|
170
329
|
end
|
|
171
330
|
end
|
|
172
331
|
|
|
173
332
|
#: (untyped) -> untyped
|
|
174
|
-
def duplicate_and_freeze(value)
|
|
333
|
+
def self.duplicate_and_freeze(value)
|
|
175
334
|
value.dup.freeze
|
|
176
335
|
rescue TypeError
|
|
177
336
|
value
|
|
178
337
|
end
|
|
179
338
|
private_class_method :duplicate_and_freeze
|
|
180
339
|
|
|
181
|
-
#: (Hash[String, Array[untyped]]?, Hash[String, Array[untyped]]?) -> Hash[String, Array[untyped]]?
|
|
182
|
-
def merge_record_owners(left, right)
|
|
183
|
-
return right unless left
|
|
184
|
-
return left unless right
|
|
185
|
-
|
|
186
|
-
left.merge(right) { |_owner, first, second| first | second }
|
|
187
|
-
end
|
|
188
|
-
private_class_method :merge_record_owners
|
|
189
|
-
|
|
190
340
|
#: (untyped) -> bool
|
|
191
|
-
def paper_trail_diff_value?(value)
|
|
341
|
+
def self.paper_trail_diff_value?(value)
|
|
192
342
|
class_name = value.class.name
|
|
193
343
|
class_name&.start_with?('PaperTrailDiff::') && value.respond_to?(:to_h)
|
|
194
344
|
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# rbs_inline: enabled
|
|
3
|
+
|
|
4
|
+
module PaperTrailDiff
|
|
5
|
+
# Reads every value of a `time` column on 2000-01-01, in its own zone.
|
|
6
|
+
#
|
|
7
|
+
# A time column keeps only the time, but Active Record before 8.1 gives a
|
|
8
|
+
# zone-aware one a date two ways: assigned, it falls on 2000-01-01 in the
|
|
9
|
+
# time zone; read from the database, on 2000-01-01 in UTC. A version rebuilt
|
|
10
|
+
# by assignment and the row read for the same time could then hold it a day
|
|
11
|
+
# apart, east of UTC in the morning and west of it in the evening, and
|
|
12
|
+
# compare as a change. Every side is read the way Active Record 8.1 reads
|
|
13
|
+
# both, which leaves a value already on that date as it is.
|
|
14
|
+
module TimeOfDay
|
|
15
|
+
@columns = {} #: Hash[untyped, Array[String]]
|
|
16
|
+
|
|
17
|
+
#: (untyped, Hash[untyped, untyped]) -> Hash[untyped, untyped]
|
|
18
|
+
def self.apply(model_class, attributes)
|
|
19
|
+
columns = columns(model_class)
|
|
20
|
+
return attributes if columns.empty?
|
|
21
|
+
|
|
22
|
+
attributes.to_h do |name, value|
|
|
23
|
+
[name, columns.include?(name) && value ? value.change(**Support::TIME_OF_DAY_DATE) : value]
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# The model's `time` columns, which a model keeps as it was defined.
|
|
28
|
+
#: (untyped) -> Array[String]
|
|
29
|
+
def self.columns(model_class)
|
|
30
|
+
known = @columns #: Hash[untyped, Array[String]]
|
|
31
|
+
known.fetch(model_class) do
|
|
32
|
+
known[model_class] = model_class.attribute_types.filter_map do |name, type|
|
|
33
|
+
name if type.type == :time
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
private_class_method :columns
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -2,24 +2,27 @@
|
|
|
2
2
|
# rbs_inline: enabled
|
|
3
3
|
|
|
4
4
|
module PaperTrailDiff
|
|
5
|
-
# Validates and applies a
|
|
5
|
+
# Validates and applies a wall-clock range without loading model state.
|
|
6
6
|
#
|
|
7
7
|
# A Date is a whole day and a String a local time, both in Time.zone, as
|
|
8
8
|
# Rails reads them, or in UTC without one: never the server's own zone. An
|
|
9
|
-
# inclusive Date end runs through that day.
|
|
9
|
+
# inclusive Date end runs through that day. An endless range has no end:
|
|
10
|
+
# it runs through every version saved since it began, whatever the clock
|
|
11
|
+
# that dated them read, as a report through the current state does.
|
|
10
12
|
class TimeRange
|
|
11
13
|
attr_reader :begin_time #: Time
|
|
12
|
-
attr_reader :end_time #: Time
|
|
14
|
+
attr_reader :end_time #: Time?
|
|
13
15
|
|
|
14
16
|
#: (untyped) -> void
|
|
15
17
|
def initialize(value)
|
|
16
|
-
unless value.is_a?(Range) && value.begin
|
|
17
|
-
raise InvalidTimeRangeError, '`within` must be a
|
|
18
|
+
unless value.is_a?(Range) && value.begin
|
|
19
|
+
raise InvalidTimeRangeError, '`within` must be a Range with a beginning'
|
|
18
20
|
end
|
|
19
21
|
|
|
20
22
|
@begin_time = coerce_time(value.begin, boundary: :begin)
|
|
21
|
-
|
|
22
|
-
@
|
|
23
|
+
last = value.end
|
|
24
|
+
@exclude_end = !last.nil? && (value.exclude_end? || calendar_date?(last))
|
|
25
|
+
@end_time = (coerce_time(end_value(value), boundary: :end) unless last.nil?)
|
|
23
26
|
validate_order!
|
|
24
27
|
freeze
|
|
25
28
|
end
|
|
@@ -34,7 +37,10 @@ module PaperTrailDiff
|
|
|
34
37
|
timestamp = coerce_time(value, boundary: :timestamp)
|
|
35
38
|
return false if timestamp < begin_time
|
|
36
39
|
|
|
37
|
-
|
|
40
|
+
finish = end_time
|
|
41
|
+
return true unless finish
|
|
42
|
+
|
|
43
|
+
exclude_end? ? timestamp < finish : timestamp <= finish
|
|
38
44
|
end
|
|
39
45
|
|
|
40
46
|
#: (untyped) -> untyped
|
|
@@ -42,15 +48,18 @@ module PaperTrailDiff
|
|
|
42
48
|
relation.where(created_at: to_range)
|
|
43
49
|
end
|
|
44
50
|
|
|
45
|
-
# The window as a Ruby range, its end included or left out as given
|
|
46
|
-
|
|
51
|
+
# The window as a Ruby range, its end included or left out as given, or
|
|
52
|
+
# endless.
|
|
53
|
+
#: () -> Range[Time?]
|
|
47
54
|
def to_range
|
|
48
55
|
exclude_end? ? (begin_time...end_time) : (begin_time..end_time)
|
|
49
56
|
end
|
|
50
57
|
|
|
58
|
+
# The versions after the window; none follows an endless one.
|
|
51
59
|
#: (untyped) -> untyped
|
|
52
60
|
def trailing_scope(relation)
|
|
53
|
-
|
|
61
|
+
finish = end_time
|
|
62
|
+
finish ? after(relation, finish) : relation.none
|
|
54
63
|
end
|
|
55
64
|
|
|
56
65
|
# Each item's earliest version after the range, keyed by item id. One row
|
|
@@ -58,12 +67,14 @@ module PaperTrailDiff
|
|
|
58
67
|
# the query stays portable; a timestamp tie keeps the lower id.
|
|
59
68
|
#: (untyped) -> Hash[String, untyped]
|
|
60
69
|
def first_trailing_versions(relation)
|
|
61
|
-
|
|
62
|
-
first_after = VersionQuery.no_earlier_version(table) do |earlier|
|
|
63
|
-
after_end(earlier[:created_at])
|
|
64
|
-
end
|
|
65
|
-
versions = VersionQuery.chronological(trailing_scope(relation).where(first_after))
|
|
70
|
+
finish = end_time
|
|
66
71
|
first = {} #: Hash[String, untyped]
|
|
72
|
+
return first unless finish
|
|
73
|
+
|
|
74
|
+
first_after = VersionQuery.no_earlier_version(relation.arel_table) do |earlier|
|
|
75
|
+
after_end(earlier[:created_at], finish)
|
|
76
|
+
end
|
|
77
|
+
versions = VersionQuery.chronological(after(relation, finish).where(first_after))
|
|
67
78
|
versions.each { |version| first[version.item_id.to_s] ||= version }
|
|
68
79
|
first
|
|
69
80
|
end
|
|
@@ -72,9 +83,14 @@ module PaperTrailDiff
|
|
|
72
83
|
|
|
73
84
|
# @rbs @exclude_end: bool
|
|
74
85
|
|
|
75
|
-
#: (untyped) -> untyped
|
|
76
|
-
def
|
|
77
|
-
|
|
86
|
+
#: (untyped, Time) -> untyped
|
|
87
|
+
def after(relation, finish)
|
|
88
|
+
relation.where(after_end(relation.arel_table[:created_at], finish))
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
#: (untyped, Time) -> untyped
|
|
92
|
+
def after_end(column, finish)
|
|
93
|
+
exclude_end? ? column.gteq(finish) : column.gt(finish)
|
|
78
94
|
end
|
|
79
95
|
|
|
80
96
|
#: (untyped, boundary: Symbol) -> Time
|
|
@@ -116,7 +132,8 @@ module PaperTrailDiff
|
|
|
116
132
|
|
|
117
133
|
#: () -> void
|
|
118
134
|
def validate_order!
|
|
119
|
-
|
|
135
|
+
finish = end_time
|
|
136
|
+
return unless finish && begin_time > finish
|
|
120
137
|
|
|
121
138
|
raise InvalidTimeRangeError, '`within` beginning must not follow its end'
|
|
122
139
|
end
|
|
@@ -12,10 +12,10 @@ module PaperTrailDiff
|
|
|
12
12
|
@live_endpoint = live_endpoint
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
-
#: (context_required: bool) -> RootVersionPlan
|
|
16
|
-
def select_plan(context_required:)
|
|
15
|
+
#: (context_required: bool, whole: bool) -> RootVersionPlan
|
|
16
|
+
def select_plan(context_required:, whole:)
|
|
17
17
|
relation = Endpoint.versions(@record)
|
|
18
|
-
in_range =
|
|
18
|
+
in_range = @time_range.scope(relation)
|
|
19
19
|
RootVersionSelection.new(
|
|
20
20
|
in_range: in_range,
|
|
21
21
|
selected: VersionScopeFilter.new(@version_scope).call(@time_range.scope(relation),
|
|
@@ -23,8 +23,8 @@ module PaperTrailDiff
|
|
|
23
23
|
after_range: trailing_version(relation),
|
|
24
24
|
windowed: true,
|
|
25
25
|
context_required: context_required,
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
live_endpoint: @live_endpoint,
|
|
27
|
+
whole: whole
|
|
28
28
|
).call
|
|
29
29
|
end
|
|
30
30
|
|
|
@@ -39,10 +39,5 @@ module PaperTrailDiff
|
|
|
39
39
|
def trailing_version(relation)
|
|
40
40
|
VersionQuery.chronological(@time_range.trailing_scope(relation)).first
|
|
41
41
|
end
|
|
42
|
-
|
|
43
|
-
#: (Array[untyped]) -> Array[untyped]
|
|
44
|
-
def ordered(versions)
|
|
45
|
-
Support.chronological_sort(versions)
|
|
46
|
-
end
|
|
47
42
|
end
|
|
48
43
|
end
|
|
@@ -4,16 +4,16 @@
|
|
|
4
4
|
module PaperTrailDiff
|
|
5
5
|
# Selects and compares a chronological slice of a record's version history.
|
|
6
6
|
class TimelineBuilder
|
|
7
|
-
#: (untyped, from: untyped, to: untyped, snapshotter: untyped, ?within: untyped, ?version_scope: untyped, ?plan: RootVersionPlan?, ?live_endpoint: untyped) -> void
|
|
7
|
+
#: (untyped, from: untyped, to: untyped, snapshotter: untyped, ?within: untyped, ?version_scope: untyped, ?plan: RootVersionPlan?, ?live_endpoint: untyped, ?traversal: AssociationTraversal?) -> void
|
|
8
8
|
def initialize( # rubocop:disable Metrics/ParameterLists
|
|
9
9
|
record, from:, to:, snapshotter:, within: nil, version_scope: nil, plan: nil,
|
|
10
|
-
live_endpoint: nil
|
|
10
|
+
live_endpoint: nil, traversal: nil
|
|
11
11
|
)
|
|
12
12
|
@record = record
|
|
13
13
|
@range = TimelineRange.new(
|
|
14
14
|
record, from: from, to: to, within: within,
|
|
15
15
|
version_scope: version_scope, plan: plan,
|
|
16
|
-
live_endpoint: live_endpoint
|
|
16
|
+
live_endpoint: live_endpoint, traversal: traversal
|
|
17
17
|
)
|
|
18
18
|
@snapshotter = snapshotter
|
|
19
19
|
end
|
|
@@ -14,9 +14,12 @@ module PaperTrailDiff
|
|
|
14
14
|
attr_reader :to #: untyped
|
|
15
15
|
attr_reader :time_range #: TimeRange?
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
# `traversal` names the requested paths, which decide where a window's
|
|
18
|
+
# edges move (see TransactionCut).
|
|
19
|
+
#: (untyped, from: untyped, to: untyped, within: untyped, ?version_scope: untyped, ?plan: RootVersionPlan?, ?live_endpoint: untyped, ?traversal: AssociationTraversal?) -> void
|
|
20
|
+
def initialize(record, from:, to:, within:, version_scope: nil, plan: nil, live_endpoint: nil, traversal: nil) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
|
|
19
21
|
@record = record
|
|
22
|
+
@traversal = traversal
|
|
20
23
|
@plan = plan
|
|
21
24
|
@live_endpoint = live_endpoint
|
|
22
25
|
@version_scope = version_scope
|
|
@@ -40,9 +43,10 @@ module PaperTrailDiff
|
|
|
40
43
|
# A batch may have selected these versions already, in which case reselecting
|
|
41
44
|
# them per record would undo the batching.
|
|
42
45
|
# The plan says which pairs of versions become steps, which a filter can
|
|
43
|
-
# make different from adjacent pairs of the selected versions.
|
|
44
|
-
|
|
45
|
-
|
|
46
|
+
# make different from adjacent pairs of the selected versions. A `whole`
|
|
47
|
+
# plan replays every version in the range; see RootVersionSelection.
|
|
48
|
+
#: (?context_required: bool, ?whole: bool) -> RootVersionPlan
|
|
49
|
+
def select_plan(context_required: false, whole: false)
|
|
46
50
|
preselected = @plan
|
|
47
51
|
return preselected if preselected
|
|
48
52
|
|
|
@@ -51,9 +55,9 @@ module PaperTrailDiff
|
|
|
51
55
|
return TimeVersionRange.new(
|
|
52
56
|
@record, time_range: range, version_scope: @version_scope,
|
|
53
57
|
live_endpoint: @live_endpoint
|
|
54
|
-
).select_plan(context_required: context_required)
|
|
58
|
+
).select_plan(context_required: context_required, whole: whole)
|
|
55
59
|
end
|
|
56
|
-
explicit_plan
|
|
60
|
+
explicit_plan(whole)
|
|
57
61
|
end
|
|
58
62
|
|
|
59
63
|
#: () -> bool
|
|
@@ -75,6 +79,7 @@ module PaperTrailDiff
|
|
|
75
79
|
private
|
|
76
80
|
|
|
77
81
|
# @rbs @record: untyped
|
|
82
|
+
# @rbs @traversal: AssociationTraversal?
|
|
78
83
|
# @rbs @plan: RootVersionPlan?
|
|
79
84
|
# @rbs @version_scope: untyped
|
|
80
85
|
# @rbs @live_endpoint: untyped
|
|
@@ -83,17 +88,17 @@ module PaperTrailDiff
|
|
|
83
88
|
# @rbs @from: untyped
|
|
84
89
|
# @rbs @to: untyped
|
|
85
90
|
|
|
86
|
-
#: () -> RootVersionPlan
|
|
87
|
-
def explicit_plan
|
|
91
|
+
#: (bool) -> RootVersionPlan
|
|
92
|
+
def explicit_plan(whole)
|
|
88
93
|
return RootVersionPlan.empty if unresolved?
|
|
89
94
|
if Endpoint.record?(@to)
|
|
90
95
|
return VersionRange.new(@record, from: @from, to: @from, version_scope: @version_scope)
|
|
91
|
-
.select_plan_through_current(@to)
|
|
96
|
+
.select_plan_through_current(@to, whole: whole)
|
|
92
97
|
end
|
|
93
98
|
|
|
94
99
|
VersionRange.new(
|
|
95
100
|
@record, from: @from, to: @to, version_scope: @version_scope
|
|
96
|
-
).select_plan_for_range
|
|
101
|
+
).select_plan_for_range(whole: whole)
|
|
97
102
|
end
|
|
98
103
|
|
|
99
104
|
#: (untyped) -> bool
|
|
@@ -132,7 +137,8 @@ module PaperTrailDiff
|
|
|
132
137
|
range = TimeRange.new(within)
|
|
133
138
|
return range unless Support.versioned?(@record.class)
|
|
134
139
|
|
|
135
|
-
TransactionCut.windows(@record.class, [@record], range
|
|
140
|
+
TransactionCut.windows(@record.class, [@record], range, traversal: @traversal)
|
|
141
|
+
.fetch(@record.id.to_s, range)
|
|
136
142
|
end
|
|
137
143
|
|
|
138
144
|
#: () -> void
|
|
@@ -37,7 +37,7 @@ module PaperTrailDiff
|
|
|
37
37
|
# version, which is the one endpoint no version history can reconstruct.
|
|
38
38
|
#: (untyped) -> RecordSnapshot?
|
|
39
39
|
def call(endpoint)
|
|
40
|
-
key =
|
|
40
|
+
key = Support.row_key(endpoint)
|
|
41
41
|
return @snapshots[key] if @snapshots.key?(key)
|
|
42
42
|
|
|
43
43
|
@snapshots[key] = if Endpoint.record?(endpoint)
|