paper_trail_diff 0.13.1 → 0.15.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.
Files changed (181) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +630 -0
  3. data/QUICKSTART.md +30 -10
  4. data/README.md +91 -13
  5. data/docs/architecture.md +62 -18
  6. data/docs/performance.md +116 -298
  7. data/docs/reference.md +554 -102
  8. data/docs/testing.md +93 -14
  9. data/lib/paper_trail_diff/activity_belongs_to_event_applier.rb +19 -9
  10. data/lib/paper_trail_diff/activity_boundary.rb +83 -26
  11. data/lib/paper_trail_diff/activity_child_candidate_loader.rb +2 -1
  12. data/lib/paper_trail_diff/activity_collection_event_applier.rb +11 -1
  13. data/lib/paper_trail_diff/activity_collection_record_updater.rb +16 -2
  14. data/lib/paper_trail_diff/activity_event.rb +41 -10
  15. data/lib/paper_trail_diff/activity_event_record_resolver.rb +20 -1
  16. data/lib/paper_trail_diff/activity_event_route_finder.rb +2 -1
  17. data/lib/paper_trail_diff/activity_event_snapshot_refresher.rb +1 -1
  18. data/lib/paper_trail_diff/activity_history.rb +34 -9
  19. data/lib/paper_trail_diff/activity_range.rb +32 -5
  20. data/lib/paper_trail_diff/activity_relationship.rb +12 -0
  21. data/lib/paper_trail_diff/activity_root_snapshot_refresher.rb +5 -2
  22. data/lib/paper_trail_diff/activity_snapshot_sequence.rb +76 -37
  23. data/lib/paper_trail_diff/activity_target_candidate_loader.rb +131 -0
  24. data/lib/paper_trail_diff/activity_timeline_builder.rb +281 -120
  25. data/lib/paper_trail_diff/activity_transaction_grouper.rb +2 -1
  26. data/lib/paper_trail_diff/activity_tree_filter.rb +114 -0
  27. data/lib/paper_trail_diff/activity_version_collector.rb +37 -24
  28. data/lib/paper_trail_diff/activity_view.rb +69 -0
  29. data/lib/paper_trail_diff/analysis.rb +13 -1
  30. data/lib/paper_trail_diff/analysis_batch.rb +24 -30
  31. data/lib/paper_trail_diff/approximate_paths.rb +48 -0
  32. data/lib/paper_trail_diff/association_activity_edge.rb +236 -0
  33. data/lib/paper_trail_diff/association_activity_selection.rb +197 -0
  34. data/lib/paper_trail_diff/association_discovery.rb +14 -11
  35. data/lib/paper_trail_diff/association_key.rb +56 -0
  36. data/lib/paper_trail_diff/association_traversal.rb +180 -47
  37. data/lib/paper_trail_diff/batch_boundary_resolver.rb +3 -4
  38. data/lib/paper_trail_diff/batch_preload.rb +53 -0
  39. data/lib/paper_trail_diff/batched_root_analyzer.rb +12 -14
  40. data/lib/paper_trail_diff/batched_root_versions.rb +53 -47
  41. data/lib/paper_trail_diff/change_row.rb +133 -0
  42. data/lib/paper_trail_diff/collection_comparator.rb +5 -32
  43. data/lib/paper_trail_diff/comparison_batch.rb +37 -10
  44. data/lib/paper_trail_diff/configuration.rb +35 -12
  45. data/lib/paper_trail_diff/deleted_analysis_batch.rb +45 -27
  46. data/lib/paper_trail_diff/deleted_root_filter.rb +79 -0
  47. data/lib/paper_trail_diff/deprecation.rb +61 -0
  48. data/lib/paper_trail_diff/diagnostics.rb +105 -102
  49. data/lib/paper_trail_diff/direct_record_state_loader.rb +10 -1
  50. data/lib/paper_trail_diff/endpoint.rb +26 -3
  51. data/lib/paper_trail_diff/errors.rb +5 -2
  52. data/lib/paper_trail_diff/fallback_paths.rb +38 -0
  53. data/lib/paper_trail_diff/habtm_transaction_owners.rb +68 -0
  54. data/lib/paper_trail_diff/historical_association_reifier.rb +34 -6
  55. data/lib/paper_trail_diff/historical_filter.rb +19 -10
  56. data/lib/paper_trail_diff/historical_snapshot_store.rb +63 -76
  57. data/lib/paper_trail_diff/live_endpoint_batch_loader.rb +12 -13
  58. data/lib/paper_trail_diff/live_graph_collector.rb +1 -1
  59. data/lib/paper_trail_diff/nested_comparator.rb +19 -18
  60. data/lib/paper_trail_diff/paper_trail_adapter.rb +136 -125
  61. data/lib/paper_trail_diff/preloaded_endpoint_batch_loader.rb +14 -2
  62. data/lib/paper_trail_diff/prepared_activity_index.rb +110 -36
  63. data/lib/paper_trail_diff/prepared_edge_loader.rb +31 -46
  64. data/lib/paper_trail_diff/prepared_history.rb +70 -53
  65. data/lib/paper_trail_diff/prepared_history_loader.rb +34 -43
  66. data/lib/paper_trail_diff/prepared_record_index.rb +64 -7
  67. data/lib/paper_trail_diff/prepared_snapshot_builder.rb +1 -1
  68. data/lib/paper_trail_diff/prepared_state_association_reader.rb +119 -29
  69. data/lib/paper_trail_diff/recorded_changes.rb +83 -0
  70. data/lib/paper_trail_diff/recorded_class.rb +53 -0
  71. data/lib/paper_trail_diff/root_version_selection.rb +4 -2
  72. data/lib/paper_trail_diff/scope_condition.rb +386 -0
  73. data/lib/paper_trail_diff/scope_ranking.rb +206 -0
  74. data/lib/paper_trail_diff/scoped_analysis.rb +11 -0
  75. data/lib/paper_trail_diff/scoped_analysis_builder.rb +20 -11
  76. data/lib/paper_trail_diff/scoped_root_selection.rb +105 -49
  77. data/lib/paper_trail_diff/snapshot.rb +16 -1
  78. data/lib/paper_trail_diff/snapshot_normalizer.rb +10 -3
  79. data/lib/paper_trail_diff/support.rb +38 -6
  80. data/lib/paper_trail_diff/time_range.rb +37 -18
  81. data/lib/paper_trail_diff/time_version_range.rb +5 -5
  82. data/lib/paper_trail_diff/timeline_builder.rb +7 -7
  83. data/lib/paper_trail_diff/timeline_range.rb +9 -1
  84. data/lib/paper_trail_diff/timeline_snapshot_provider.rb +24 -17
  85. data/lib/paper_trail_diff/transaction_cut.rb +181 -0
  86. data/lib/paper_trail_diff/traversal_preparer.rb +134 -29
  87. data/lib/paper_trail_diff/version.rb +1 -1
  88. data/lib/paper_trail_diff/version_association_candidate_scope.rb +13 -3
  89. data/lib/paper_trail_diff/version_boundary.rb +37 -8
  90. data/lib/paper_trail_diff/version_query.rb +34 -10
  91. data/lib/paper_trail_diff/version_range.rb +8 -15
  92. data/lib/paper_trail_diff/version_scope_filter.rb +20 -13
  93. data/lib/paper_trail_diff/version_sequence_diagnostics.rb +31 -16
  94. data/lib/paper_trail_diff/version_table.rb +60 -0
  95. data/lib/paper_trail_diff.rb +126 -55
  96. data/sig/generated/paper_trail_diff/activity_belongs_to_event_applier.rbs +10 -2
  97. data/sig/generated/paper_trail_diff/activity_boundary.rbs +54 -19
  98. data/sig/generated/paper_trail_diff/activity_collection_event_applier.rbs +5 -0
  99. data/sig/generated/paper_trail_diff/activity_collection_record_updater.rbs +5 -0
  100. data/sig/generated/paper_trail_diff/activity_event.rbs +25 -4
  101. data/sig/generated/paper_trail_diff/activity_event_record_resolver.rbs +7 -0
  102. data/sig/generated/paper_trail_diff/activity_history.rbs +21 -6
  103. data/sig/generated/paper_trail_diff/activity_range.rbs +14 -3
  104. data/sig/generated/paper_trail_diff/activity_relationship.rbs +3 -0
  105. data/sig/generated/paper_trail_diff/activity_root_snapshot_refresher.rbs +2 -0
  106. data/sig/generated/paper_trail_diff/activity_snapshot_sequence.rbs +48 -9
  107. data/sig/generated/paper_trail_diff/activity_target_candidate_loader.rbs +79 -0
  108. data/sig/generated/paper_trail_diff/activity_timeline_builder.rbs +138 -28
  109. data/sig/generated/paper_trail_diff/activity_tree_filter.rbs +73 -0
  110. data/sig/generated/paper_trail_diff/activity_version_collector.rbs +12 -4
  111. data/sig/generated/paper_trail_diff/activity_view.rbs +42 -0
  112. data/sig/generated/paper_trail_diff/analysis.rbs +8 -1
  113. data/sig/generated/paper_trail_diff/analysis_batch.rbs +8 -15
  114. data/sig/generated/paper_trail_diff/approximate_paths.rbs +23 -0
  115. data/sig/generated/paper_trail_diff/association_activity_edge.rbs +148 -0
  116. data/sig/generated/paper_trail_diff/association_activity_selection.rbs +112 -0
  117. data/sig/generated/paper_trail_diff/association_discovery.rbs +8 -5
  118. data/sig/generated/paper_trail_diff/association_key.rbs +29 -0
  119. data/sig/generated/paper_trail_diff/association_traversal.rbs +88 -9
  120. data/sig/generated/paper_trail_diff/batch_preload.rbs +29 -0
  121. data/sig/generated/paper_trail_diff/batched_root_analyzer.rbs +9 -10
  122. data/sig/generated/paper_trail_diff/batched_root_versions.rbs +14 -10
  123. data/sig/generated/paper_trail_diff/change_row.rbs +86 -0
  124. data/sig/generated/paper_trail_diff/collection_comparator.rbs +2 -16
  125. data/sig/generated/paper_trail_diff/comparison_batch.rbs +22 -4
  126. data/sig/generated/paper_trail_diff/configuration.rbs +19 -3
  127. data/sig/generated/paper_trail_diff/deleted_analysis_batch.rbs +20 -8
  128. data/sig/generated/paper_trail_diff/deleted_root_filter.rbs +48 -0
  129. data/sig/generated/paper_trail_diff/deprecation.rbs +35 -0
  130. data/sig/generated/paper_trail_diff/diagnostics.rbs +44 -32
  131. data/sig/generated/paper_trail_diff/direct_record_state_loader.rbs +6 -0
  132. data/sig/generated/paper_trail_diff/endpoint.rbs +11 -2
  133. data/sig/generated/paper_trail_diff/errors.rbs +5 -2
  134. data/sig/generated/paper_trail_diff/fallback_paths.rbs +22 -0
  135. data/sig/generated/paper_trail_diff/habtm_transaction_owners.rbs +40 -0
  136. data/sig/generated/paper_trail_diff/historical_association_reifier.rbs +13 -0
  137. data/sig/generated/paper_trail_diff/historical_filter.rbs +12 -2
  138. data/sig/generated/paper_trail_diff/historical_snapshot_store.rbs +36 -30
  139. data/sig/generated/paper_trail_diff/live_endpoint_batch_loader.rbs +5 -3
  140. data/sig/generated/paper_trail_diff/nested_comparator.rbs +10 -7
  141. data/sig/generated/paper_trail_diff/paper_trail_adapter.rbs +55 -48
  142. data/sig/generated/paper_trail_diff/preloaded_endpoint_batch_loader.rbs +9 -1
  143. data/sig/generated/paper_trail_diff/prepared_activity_index.rbs +52 -10
  144. data/sig/generated/paper_trail_diff/prepared_edge_loader.rbs +4 -12
  145. data/sig/generated/paper_trail_diff/prepared_history.rbs +40 -24
  146. data/sig/generated/paper_trail_diff/prepared_history_loader.rbs +15 -13
  147. data/sig/generated/paper_trail_diff/prepared_record_index.rbs +34 -2
  148. data/sig/generated/paper_trail_diff/prepared_state_association_reader.rbs +56 -11
  149. data/sig/generated/paper_trail_diff/recorded_changes.rbs +47 -0
  150. data/sig/generated/paper_trail_diff/recorded_class.rbs +22 -0
  151. data/sig/generated/paper_trail_diff/root_version_selection.rbs +2 -0
  152. data/sig/generated/paper_trail_diff/scope_condition.rbs +219 -0
  153. data/sig/generated/paper_trail_diff/scope_ranking.rbs +125 -0
  154. data/sig/generated/paper_trail_diff/scoped_analysis.rbs +6 -0
  155. data/sig/generated/paper_trail_diff/scoped_analysis_builder.rbs +8 -3
  156. data/sig/generated/paper_trail_diff/scoped_root_selection.rbs +49 -11
  157. data/sig/generated/paper_trail_diff/snapshot.rbs +8 -0
  158. data/sig/generated/paper_trail_diff/snapshot_normalizer.rbs +6 -0
  159. data/sig/generated/paper_trail_diff/support.rbs +20 -2
  160. data/sig/generated/paper_trail_diff/time_range.rbs +20 -2
  161. data/sig/generated/paper_trail_diff/time_version_range.rbs +4 -4
  162. data/sig/generated/paper_trail_diff/timeline_builder.rbs +2 -2
  163. data/sig/generated/paper_trail_diff/timeline_range.rbs +2 -0
  164. data/sig/generated/paper_trail_diff/timeline_snapshot_provider.rbs +17 -7
  165. data/sig/generated/paper_trail_diff/transaction_cut.rbs +94 -0
  166. data/sig/generated/paper_trail_diff/traversal_preparer.rbs +66 -8
  167. data/sig/generated/paper_trail_diff/version_association_candidate_scope.rbs +7 -0
  168. data/sig/generated/paper_trail_diff/version_boundary.rbs +20 -3
  169. data/sig/generated/paper_trail_diff/version_query.rbs +18 -2
  170. data/sig/generated/paper_trail_diff/version_range.rbs +4 -2
  171. data/sig/generated/paper_trail_diff/version_scope_filter.rbs +7 -4
  172. data/sig/generated/paper_trail_diff/version_sequence_diagnostics.rbs +16 -9
  173. data/sig/generated/paper_trail_diff/version_table.rbs +30 -0
  174. data/sig/generated/paper_trail_diff.rbs +47 -25
  175. metadata +62 -10
  176. data/lib/paper_trail_diff/activity_grouping.rb +0 -38
  177. data/lib/paper_trail_diff/batch_safety.rb +0 -55
  178. data/lib/paper_trail_diff/time_activity_timeline_builder.rb +0 -224
  179. data/sig/generated/paper_trail_diff/activity_grouping.rbs +0 -22
  180. data/sig/generated/paper_trail_diff/batch_safety.rbs +0 -24
  181. data/sig/generated/paper_trail_diff/time_activity_timeline_builder.rbs +0 -92
@@ -1,224 +0,0 @@
1
- # frozen_string_literal: true
2
- # rbs_inline: enabled
3
-
4
- module PaperTrailDiff
5
- # Builds activity views for mutations selected by a wall-clock range.
6
- class TimeActivityTimelineBuilder
7
- include ActivityGrouping
8
-
9
- #: (untyped, range: TimelineRange, tree: AssociationTree, snapshotter: untyped, ?snapshots: bool, ?group: Symbol?) -> void
10
- def initialize(record, range:, tree:, snapshotter:, snapshots: false, group: nil) # rubocop:disable Metrics/ParameterLists
11
- @snapshots = snapshots
12
- @group = group
13
- # Merging a group compares its outer states, so the snapshots must survive
14
- # the build even when the caller did not ask to keep them.
15
- @retain = snapshots || grouping?
16
- @record = record
17
- @range = range
18
- @tree = tree
19
- @snapshotter = snapshotter
20
- end
21
-
22
- #: () -> Array[ActivityStep]
23
- def build
24
- history, _plan, closing, = history_and_versions
25
- activity_steps(history, closing)
26
- end
27
-
28
- #: () -> Analysis
29
- def analyze
30
- history, plan, closing, closing_snapshot, captured_at = history_and_versions
31
- final = plan.closes_on_destroy ? nil : closing_snapshot || history.last_snapshot
32
- Analysis.new(
33
- diff: Engine.compare(history.first_snapshot, final),
34
- timeline: ActivityRootSteps.call(
35
- plan, history.root_snapshots,
36
- closing_snapshot: closing_snapshot, captured_at: captured_at
37
- ),
38
- activity_timeline: activity_steps(history, closing),
39
- from_snapshot: history.first_snapshot,
40
- to_snapshot: final
41
- )
42
- end
43
-
44
- private
45
-
46
- # @rbs @record: untyped
47
- # @rbs @range: TimelineRange
48
- # @rbs @tree: AssociationTree
49
- # @rbs @snapshotter: untyped
50
- # @rbs @snapshots: bool
51
-
52
- #: () -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
53
- def history_and_versions
54
- plan = @range.select_plan(context_required: !@tree.empty?)
55
- reject_live_habtm! if plan.closing_record
56
- if plan.reconstruction_versions.empty? && !plan.closing_record
57
- return [ActivityHistory.empty, plan, nil, nil, nil]
58
- end
59
-
60
- # A window closing on current state runs to the instant it is captured,
61
- # not to the last root version, or descendants that moved after that
62
- # version would be missing from a report that claims to reach now.
63
- history_for(plan, plan.closing_record ? Time.now.utc : nil)
64
- end
65
-
66
- #: () -> void
67
- def reject_live_habtm!
68
- AssociationTraversal.new(@tree).reject_live_habtm_activity!(@record.class)
69
- end
70
-
71
- #: (RootVersionPlan, untyped) -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
72
- def history_for(plan, captured_at)
73
- root_versions = plan.reconstruction_versions
74
- events = events_through(root_versions, captured_at)
75
- selected = selected_events(events, plan)
76
- unless time_events?(selected, events, plan)
77
- return [ActivityHistory.empty, plan, nil, nil, nil]
78
- end
79
-
80
- history = build_history(root_versions, events, current: plan.closing_record)
81
- snapshot = current_snapshot(plan)
82
- closing = closing_step(history, selected.last, plan, captured_at, snapshot)
83
- [history, plan, closing, snapshot, captured_at]
84
- end
85
-
86
- # One live read serves both the closing activity step and the endpoint the
87
- # analysis reports, which would otherwise reconstruct the graph twice.
88
- #: (RootVersionPlan) -> RecordSnapshot?
89
- def current_snapshot(plan)
90
- record = plan.closing_record
91
- return unless record
92
-
93
- @snapshotter.call(record, record)
94
- end
95
-
96
- #: (Array[untyped], untyped) -> Array[ActivityEvent]
97
- def events_through(root_versions, captured_at)
98
- prepare_history(root_versions, end_at: captured_at)
99
- collect_events(root_versions, range_end: captured_at)
100
- end
101
-
102
- # Events after the last root version read the root from the live record
103
- # when the window closes on it, as an explicit `to: record` range does.
104
- #: (Array[untyped], Array[ActivityEvent], ?current: untyped) -> ActivityHistory
105
- def build_history(root_versions, events, current: nil)
106
- ActivityHistoryBuilder.new(
107
- root_versions,
108
- events,
109
- @snapshotter,
110
- current: current,
111
- include_step: ->(event) { @range.include?(event.version) },
112
- snapshots: @retain
113
- ).call
114
- end
115
-
116
- #: (ActivityHistory, ActivityStep?) -> Array[ActivityStep]
117
- def activity_steps(history, closing)
118
- steps = closing ? history.steps + [closing] : history.steps
119
- group_steps(steps).freeze
120
- end
121
-
122
- # Root versions inside the window that the plan does not report are context
123
- # rather than mutations: the version appended to reveal the last selected
124
- # change, and anything a filter excluded but the replay still walks. Neither
125
- # may be counted as a selected mutation. Descendant events are not filtered,
126
- # so window membership is the whole test for them.
127
- #: (Array[ActivityEvent], RootVersionPlan) -> Array[ActivityEvent]
128
- def selected_events(events, plan)
129
- events.select do |event|
130
- next false unless @range.include?(event.version)
131
-
132
- !event.root? || plan.mutation?(event.version)
133
- end
134
- end
135
-
136
- # A window either closes on the absence its final destruction leaves, or on
137
- # current state when it reaches past everything recorded. Both are boundaries
138
- # no version can supply.
139
- #: (ActivityHistory, ActivityEvent?, RootVersionPlan, untyped, RecordSnapshot?) -> ActivityStep?
140
- def closing_step(history, event, plan, captured_at, snapshot)
141
- return unless event
142
- return destroyed_step(history, event) if terminal_destroy?(event)
143
- return unless plan.closing_record
144
-
145
- current_step(history, plan.closing_record, captured_at, snapshot)
146
- end
147
-
148
- #: (ActivityHistory, ActivityEvent) -> ActivityStep
149
- def destroyed_step(history, event)
150
- version = event.version
151
- ActivityStep.between(
152
- from_boundary: ActivityBoundary.from_version(version),
153
- to_boundary: ActivityBoundary.destroyed(version),
154
- from_snapshot: history.root_snapshots[ActivityRootSteps.version_key(version)],
155
- to_snapshot: nil, retain: @retain
156
- )
157
- end
158
-
159
- # The last boundary reached is where current state is compared from, which
160
- # is the final event rather than the final root version once descendants
161
- # have moved since it.
162
- #: (ActivityHistory, untyped, untyped, RecordSnapshot?) -> ActivityStep?
163
- def current_step(history, record, captured_at, snapshot)
164
- previous = history.last_boundary
165
- return unless previous
166
-
167
- ActivityStep.between(
168
- from_boundary: previous,
169
- to_boundary: ActivityBoundary.current(record, captured_at: captured_at),
170
- from_snapshot: history.last_event_snapshot, to_snapshot: snapshot, retain: @retain
171
- )
172
- end
173
-
174
- #: (ActivityEvent?) -> bool
175
- def terminal_destroy?(event)
176
- return false unless event
177
-
178
- event.root? && event.version.event.to_s == 'destroy'
179
- end
180
-
181
- #: (Array[untyped], ?end_at: untyped) -> void
182
- def prepare_history(root_versions, end_at: nil)
183
- return unless @snapshotter.respond_to?(:prepare)
184
-
185
- start_at = @range.begin_time
186
- return @snapshotter.prepare(@record, root_versions, start_at: start_at) unless end_at
187
-
188
- @snapshotter.prepare(@record, root_versions, start_at: start_at, end_at: end_at)
189
- end
190
-
191
- #: (Array[untyped], ?range_end: untyped) -> Array[ActivityEvent]
192
- def collect_events(root_versions, range_end: nil)
193
- ActivityVersionCollector.new(
194
- @record,
195
- root_versions: root_versions,
196
- tree: @tree,
197
- traversal: AssociationTraversal.new(@tree),
198
- prepared: (@snapshotter.activity_index if @snapshotter.respond_to?(:activity_index)),
199
- range_start: @range.begin_time,
200
- range_end: range_end || root_versions.last
201
- ).call
202
- end
203
-
204
- #: (Array[ActivityEvent], Array[ActivityEvent], RootVersionPlan) -> bool
205
- def time_events?(selected, events, plan)
206
- return false if selected.empty?
207
- return true if later_event?(selected.last, events)
208
- return true if terminal_destroy?(selected.last)
209
- return true if plan.closing_record
210
-
211
- message = 'time range requires a later activity boundary to reconstruct its ' \
212
- 'final change: pass close_on: :current to end at current state, ' \
213
- 'or narrow the window to end before the last recorded boundary'
214
- raise IncompleteTimeRangeError, message
215
- end
216
-
217
- #: (ActivityEvent, Array[ActivityEvent]) -> bool
218
- def later_event?(selected, events)
219
- events.any? do |event|
220
- Support.compare_versions(selected.version, event.version).negative?
221
- end
222
- end
223
- end
224
- end
@@ -1,22 +0,0 @@
1
- # Generated from lib/paper_trail_diff/activity_grouping.rb with RBS::Inline
2
-
3
- module PaperTrailDiff
4
- # Shared by the two activity builders. They differ in how they choose
5
- # boundaries -- one from an explicit version range, one from a wall-clock
6
- # window -- but a transaction has to collapse the same way in both, or the
7
- # same history would read differently depending on how it was asked for.
8
- module ActivityGrouping
9
- # : (Symbol?, ?activity: bool, ?snapshots: bool) -> void
10
- def self.validate!: (Symbol?, ?activity: bool, ?snapshots: bool) -> void
11
-
12
- private
13
-
14
- # : () -> bool
15
- def grouping?: () -> bool
16
-
17
- # Applied last, to finished steps, so grouping sees the same timeline the
18
- # caller would otherwise have received.
19
- # : (Array[ActivityStep]) -> Array[ActivityStep]
20
- def group_steps: (Array[ActivityStep]) -> Array[ActivityStep]
21
- end
22
- end
@@ -1,24 +0,0 @@
1
- # Generated from lib/paper_trail_diff/batch_safety.rb with RBS::Inline
2
-
3
- module PaperTrailDiff
4
- # Refuses known per-record association loading before a batch reconstructs it.
5
- class BatchSafety
6
- # : (AssociationTraversal, allow_expensive: bool) -> void
7
- def initialize: (AssociationTraversal, allow_expensive: bool) -> void
8
-
9
- # : (untyped, ?historical: bool) -> void
10
- def call: (untyped, ?historical: bool) -> void
11
-
12
- private
13
-
14
- @allow_expensive: bool
15
-
16
- @traversal: AssociationTraversal
17
-
18
- # : (untyped, String, bool) -> void
19
- def check: (untyped, String, bool) -> void
20
-
21
- # : (untyped, bool) -> String?
22
- def reason_for: (untyped, bool) -> String?
23
- end
24
- end
@@ -1,92 +0,0 @@
1
- # Generated from lib/paper_trail_diff/time_activity_timeline_builder.rb with RBS::Inline
2
-
3
- module PaperTrailDiff
4
- # Builds activity views for mutations selected by a wall-clock range.
5
- class TimeActivityTimelineBuilder
6
- include ActivityGrouping
7
-
8
- # : (untyped, range: TimelineRange, tree: AssociationTree, snapshotter: untyped, ?snapshots: bool, ?group: Symbol?) -> void
9
- def initialize: (untyped, range: TimelineRange, tree: AssociationTree, snapshotter: untyped, ?snapshots: bool, ?group: Symbol?) -> void
10
-
11
- # : () -> Array[ActivityStep]
12
- def build: () -> Array[ActivityStep]
13
-
14
- # : () -> Analysis
15
- def analyze: () -> Analysis
16
-
17
- private
18
-
19
- @range: TimelineRange
20
-
21
- @record: untyped
22
-
23
- @snapshots: bool
24
-
25
- @snapshotter: untyped
26
-
27
- @tree: AssociationTree
28
-
29
- # : () -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
30
- def history_and_versions: () -> [ ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped ]
31
-
32
- # : () -> void
33
- def reject_live_habtm!: () -> void
34
-
35
- # : (RootVersionPlan, untyped) -> [ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped]
36
- def history_for: (RootVersionPlan, untyped) -> [ ActivityHistory, RootVersionPlan, ActivityStep?, RecordSnapshot?, untyped ]
37
-
38
- # One live read serves both the closing activity step and the endpoint the
39
- # analysis reports, which would otherwise reconstruct the graph twice.
40
- # : (RootVersionPlan) -> RecordSnapshot?
41
- def current_snapshot: (RootVersionPlan) -> RecordSnapshot?
42
-
43
- # : (Array[untyped], untyped) -> Array[ActivityEvent]
44
- def events_through: (Array[untyped], untyped) -> Array[ActivityEvent]
45
-
46
- # Events after the last root version read the root from the live record
47
- # when the window closes on it, as an explicit `to: record` range does.
48
- # : (Array[untyped], Array[ActivityEvent], ?current: untyped) -> ActivityHistory
49
- def build_history: (Array[untyped], Array[ActivityEvent], ?current: untyped) -> ActivityHistory
50
-
51
- # : (ActivityHistory, ActivityStep?) -> Array[ActivityStep]
52
- def activity_steps: (ActivityHistory, ActivityStep?) -> Array[ActivityStep]
53
-
54
- # Root versions inside the window that the plan does not report are context
55
- # rather than mutations: the version appended to reveal the last selected
56
- # change, and anything a filter excluded but the replay still walks. Neither
57
- # may be counted as a selected mutation. Descendant events are not filtered,
58
- # so window membership is the whole test for them.
59
- # : (Array[ActivityEvent], RootVersionPlan) -> Array[ActivityEvent]
60
- def selected_events: (Array[ActivityEvent], RootVersionPlan) -> Array[ActivityEvent]
61
-
62
- # A window either closes on the absence its final destruction leaves, or on
63
- # current state when it reaches past everything recorded. Both are boundaries
64
- # no version can supply.
65
- # : (ActivityHistory, ActivityEvent?, RootVersionPlan, untyped, RecordSnapshot?) -> ActivityStep?
66
- def closing_step: (ActivityHistory, ActivityEvent?, RootVersionPlan, untyped, RecordSnapshot?) -> ActivityStep?
67
-
68
- # : (ActivityHistory, ActivityEvent) -> ActivityStep
69
- def destroyed_step: (ActivityHistory, ActivityEvent) -> ActivityStep
70
-
71
- # The last boundary reached is where current state is compared from, which
72
- # is the final event rather than the final root version once descendants
73
- # have moved since it.
74
- # : (ActivityHistory, untyped, untyped, RecordSnapshot?) -> ActivityStep?
75
- def current_step: (ActivityHistory, untyped, untyped, RecordSnapshot?) -> ActivityStep?
76
-
77
- # : (ActivityEvent?) -> bool
78
- def terminal_destroy?: (ActivityEvent?) -> bool
79
-
80
- # : (Array[untyped], ?end_at: untyped) -> void
81
- def prepare_history: (Array[untyped], ?end_at: untyped) -> void
82
-
83
- # : (Array[untyped], ?range_end: untyped) -> Array[ActivityEvent]
84
- def collect_events: (Array[untyped], ?range_end: untyped) -> Array[ActivityEvent]
85
-
86
- # : (Array[ActivityEvent], Array[ActivityEvent], RootVersionPlan) -> bool
87
- def time_events?: (Array[ActivityEvent], Array[ActivityEvent], RootVersionPlan) -> bool
88
-
89
- # : (ActivityEvent, Array[ActivityEvent]) -> bool
90
- def later_event?: (ActivityEvent, Array[ActivityEvent]) -> bool
91
- end
92
- end