paper_trail_diff 0.1.0

data/sig/generated/paper_trail_diff.rbs

@@ -0,0 +1,56 @@
+# Generated from lib/paper_trail_diff.rb with RBS::Inline
+
+# Structured version comparison for PaperTrail.
+module PaperTrailDiff
+  DEFAULT_IGNORED_ATTRIBUTES: untyped
+
+  SUPPORTED_ASSOCIATION_MACROS: untyped
+
+  # Compares net state between explicit PaperTrail-version or current-record endpoints.
+  # : (untyped, untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option) -> Diff
+  def self.compare: (untyped, untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option) -> Diff
+
+  # Compares every adjacent reconstructed state in an inclusive version range.
+  # : (untyped, from: untyped, to: untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option) -> Array[Step]
+  def self.timeline: (untyped, from: untyped, to: untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option) -> Array[Step]
+
+  # Compares adjacent root and selected-descendant activity boundaries.
+  # : (untyped, from: untyped, to: untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option) -> Array[ActivityStep]
+  def self.activity_timeline: (untyped, from: untyped, to: untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option) -> Array[ActivityStep]
+
+  # Builds an endpoint diff and root-checkpoint timeline while normalizing each version once.
+  # : (untyped, from: untyped, to: untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option, ?activity: bool) -> Analysis
+  def self.analyze: (untyped, from: untyped, to: untyped, ?associations: Array[String | Symbol], ?ignore: ignore_option, ?activity: bool) -> Analysis
+
+  # Returns the association macros this release can normalize.
+  # : () -> Array[Symbol]
+  def self.supported_association_macros: () -> Array[Symbol]
+
+  # Discovers supported, finite association paths for a model or record.
+  # : (untyped, ?max_depth: Integer) -> Array[AssociationDescriptor]
+  def self.association_paths: (untyped, ?max_depth: Integer) -> Array[AssociationDescriptor]
+
+  # Reports known reconstruction hazards without mutating application state.
+  # : (untyped, untyped, ?associations: Array[String | Symbol]) -> DiagnosticReport
+  def self.diagnose: (untyped, untyped, ?associations: Array[String | Symbol]) -> DiagnosticReport
+end
+
+module PaperTrailDiff
+  type snapshot_attributes = Hash[untyped, untyped]
+
+  type snapshot_associations = Hash[untyped, AssociationSnapshot]
+
+  type attribute_changes = Hash[String, ValueChange]
+
+  type association_diff = ToOneAssociationDiff | CollectionAssociationDiff
+
+  type association_diffs = Hash[String, association_diff]
+
+  type association_snapshots = Hash[String, AssociationSnapshot]
+
+  type identity = Array[untyped]
+
+  type ignore_option = Array[String | Symbol] | Hash[String | Symbol, untyped]
+
+  type reference_key = :type | :id | "type" | "id"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: paper_trail_diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Williams
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '18'
+description: |
+  paper_trail_diff compares reified PaperTrail histories and returns structured
+  attribute and explicitly selected association changes.
+email:
+- alex.williams.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/paper_trail_diff.rb
+- lib/paper_trail_diff/activity_boundary.rb
+- lib/paper_trail_diff/activity_event.rb
+- lib/paper_trail_diff/activity_event_snapshot_refresher.rb
+- lib/paper_trail_diff/activity_range.rb
+- lib/paper_trail_diff/activity_root_snapshot_refresher.rb
+- lib/paper_trail_diff/activity_snapshot_sequence.rb
+- lib/paper_trail_diff/activity_timeline_builder.rb
+- lib/paper_trail_diff/activity_version_collector.rb
+- lib/paper_trail_diff/analysis.rb
+- lib/paper_trail_diff/association_discovery.rb
+- lib/paper_trail_diff/association_traversal.rb
+- lib/paper_trail_diff/branch_snapshot_refresher.rb
+- lib/paper_trail_diff/configuration.rb
+- lib/paper_trail_diff/diagnostics.rb
+- lib/paper_trail_diff/endpoint.rb
+- lib/paper_trail_diff/engine.rb
+- lib/paper_trail_diff/errors.rb
+- lib/paper_trail_diff/historical_association_reifier.rb
+- lib/paper_trail_diff/historical_snapshot_store.rb
+- lib/paper_trail_diff/live_association_reader.rb
+- lib/paper_trail_diff/paper_trail_adapter.rb
+- lib/paper_trail_diff/prepared_association_reifier.rb
+- lib/paper_trail_diff/prepared_edge_loader.rb
+- lib/paper_trail_diff/prepared_history.rb
+- lib/paper_trail_diff/prepared_history_loader.rb
+- lib/paper_trail_diff/prepared_record_index.rb
+- lib/paper_trail_diff/snapshot.rb
+- lib/paper_trail_diff/snapshot_normalizer.rb
+- lib/paper_trail_diff/step.rb
+- lib/paper_trail_diff/support.rb
+- lib/paper_trail_diff/timeline_builder.rb
+- lib/paper_trail_diff/timeline_snapshot_provider.rb
+- lib/paper_trail_diff/value_objects.rb
+- lib/paper_trail_diff/version.rb
+- lib/paper_trail_diff/version_range.rb
+- sig/generated/paper_trail_diff.rbs
+- sig/generated/paper_trail_diff/activity_boundary.rbs
+- sig/generated/paper_trail_diff/activity_event.rbs
+- sig/generated/paper_trail_diff/activity_event_snapshot_refresher.rbs
+- sig/generated/paper_trail_diff/activity_range.rbs
+- sig/generated/paper_trail_diff/activity_root_snapshot_refresher.rbs
+- sig/generated/paper_trail_diff/activity_snapshot_sequence.rbs
+- sig/generated/paper_trail_diff/activity_timeline_builder.rbs
+- sig/generated/paper_trail_diff/activity_version_collector.rbs
+- sig/generated/paper_trail_diff/analysis.rbs
+- sig/generated/paper_trail_diff/association_discovery.rbs
+- sig/generated/paper_trail_diff/association_traversal.rbs
+- sig/generated/paper_trail_diff/branch_snapshot_refresher.rbs
+- sig/generated/paper_trail_diff/configuration.rbs
+- sig/generated/paper_trail_diff/diagnostics.rbs
+- sig/generated/paper_trail_diff/endpoint.rbs
+- sig/generated/paper_trail_diff/engine.rbs
+- sig/generated/paper_trail_diff/errors.rbs
+- sig/generated/paper_trail_diff/historical_association_reifier.rbs
+- sig/generated/paper_trail_diff/historical_snapshot_store.rbs
+- sig/generated/paper_trail_diff/live_association_reader.rbs
+- sig/generated/paper_trail_diff/paper_trail_adapter.rbs
+- sig/generated/paper_trail_diff/prepared_association_reifier.rbs
+- sig/generated/paper_trail_diff/prepared_edge_loader.rbs
+- sig/generated/paper_trail_diff/prepared_history.rbs
+- sig/generated/paper_trail_diff/prepared_history_loader.rbs
+- sig/generated/paper_trail_diff/prepared_record_index.rbs
+- sig/generated/paper_trail_diff/snapshot.rbs
+- sig/generated/paper_trail_diff/snapshot_normalizer.rbs
+- sig/generated/paper_trail_diff/step.rbs
+- sig/generated/paper_trail_diff/support.rbs
+- sig/generated/paper_trail_diff/timeline_builder.rbs
+- sig/generated/paper_trail_diff/timeline_snapshot_provider.rbs
+- sig/generated/paper_trail_diff/value_objects.rbs
+- sig/generated/paper_trail_diff/version.rbs
+- sig/generated/paper_trail_diff/version_range.rbs
+homepage: https://github.com/aheathwilliams/paper_trail_diff
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/aheathwilliams/paper_trail_diff/issues
+  changelog_uri: https://github.com/aheathwilliams/paper_trail_diff/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: https://github.com/aheathwilliams/paper_trail_diff/blob/v0.1.0/README.md
+  homepage_uri: https://github.com/aheathwilliams/paper_trail_diff
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/aheathwilliams/paper_trail_diff/tree/v0.1.0
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Structured endpoint and activity diffs for PaperTrail
+test_files: []