pgoutput-parser 0.1.1 → 0.2.0

data/sig/pgoutput.rbs

@@ -3,10 +3,14 @@ module Pgoutput
 
   type message =
     Messages::Begin |
+    Messages::Message |
+    Messages::Origin |
     Messages::Relation |
+    Messages::Type |
     Messages::Insert |
     Messages::Update |
     Messages::Delete |
+    Messages::Truncate |
     Messages::Commit
 
   class Error < StandardError
@@ -21,6 +25,10 @@ module Pgoutput
   class UnknownRelationError < Error
   end
 
+  class TupleArityError < Error
+  end
+
+  # Immutable message model classes for the PostgreSQL pgoutput protocol.
   module Messages
     class Begin < Data
       attr_reader final_lsn: Integer
@@ -39,6 +47,22 @@ module Pgoutput
       def self.new: (Integer flags, String name, Integer oid, Integer type_modifier) -> Column
     end
 
+    class Message < Data
+      attr_reader flags: Integer
+      attr_reader lsn: Integer
+      attr_reader prefix: String
+      attr_reader content: String
+
+      def self.new: (Integer flags, Integer lsn, String prefix, String content) -> Message
+    end
+
+    class Origin < Data
+      attr_reader origin_lsn: Integer
+      attr_reader name: String
+
+      def self.new: (Integer origin_lsn, String name) -> Origin
+    end
+
     class Relation < Data
       attr_reader relation_id: Integer
       attr_reader schema: String
@@ -46,13 +70,15 @@ module Pgoutput
       attr_reader replica_identity: Integer
       attr_reader columns: Array[Column]
 
-      def self.new: (
-        Integer relation_id,
-        String schema,
-        String table,
-        Integer replica_identity,
-        Array[Column] columns
-      ) -> Relation
+      def self.new: (Integer relation_id, String schema, String table, Integer replica_identity, Array[Column] columns) -> Relation
+    end
+
+    class Type < Data
+      attr_reader oid: Integer
+      attr_reader schema: String
+      attr_reader name: String
+
+      def self.new: (Integer oid, String schema, String name) -> Type
     end
 
     class TupleValue < Data
@@ -60,11 +86,7 @@ module Pgoutput
       attr_reader raw: String?
       attr_reader oid: Integer?
 
-      def self.new: (
-        :null | :unchanged_toast | :text | :binary format,
-        String? raw,
-        Integer? oid
-      ) -> TupleValue
+      def self.new: (:null | :unchanged_toast | :text | :binary format, String? raw, Integer? oid) -> TupleValue
     end
 
     class Insert < Data
@@ -80,12 +102,7 @@ module Pgoutput
       attr_reader old_tuple: Array[TupleValue]?
       attr_reader new_tuple: Array[TupleValue]
 
-      def self.new: (
-        Integer relation_id,
-        Array[TupleValue]? old_key_tuple,
-        Array[TupleValue]? old_tuple,
-        Array[TupleValue] new_tuple
-      ) -> Update
+      def self.new: (Integer relation_id, Array[TupleValue]? old_key_tuple, Array[TupleValue]? old_tuple, Array[TupleValue] new_tuple) -> Update
     end
 
     class Delete < Data
@@ -93,11 +110,14 @@ module Pgoutput
       attr_reader old_key_tuple: Array[TupleValue]?
       attr_reader old_tuple: Array[TupleValue]?
 
-      def self.new: (
-        Integer relation_id,
-        Array[TupleValue]? old_key_tuple,
-        Array[TupleValue]? old_tuple
-      ) -> Delete
+      def self.new: (Integer relation_id, Array[TupleValue]? old_key_tuple, Array[TupleValue]? old_tuple) -> Delete
+    end
+
+    class Truncate < Data
+      attr_reader relation_ids: Array[Integer]
+      attr_reader options: Integer
+
+      def self.new: (Array[Integer] relation_ids, Integer options) -> Truncate
     end
 
     class Commit < Data
@@ -106,24 +126,59 @@ module Pgoutput
       attr_reader transaction_end_lsn: Integer
       attr_reader commit_timestamp: Integer
 
-      def self.new: (
-        Integer flags,
-        Integer commit_lsn,
-        Integer transaction_end_lsn,
-        Integer commit_timestamp
-      ) -> Commit
+      def self.new: (Integer flags, Integer commit_lsn, Integer transaction_end_lsn, Integer commit_timestamp) -> Commit
     end
   end
 
   class BinaryParser
+    @payload: String
+    @offset: Integer
+
     def initialize: (String payload) -> void
 
     def parse: () -> message
+
+    private
+
+    def parse_begin: () -> Messages::Begin
+    def parse_message: () -> Messages::Message
+    def parse_origin: () -> Messages::Origin
+    def parse_relation: () -> Messages::Relation
+    def parse_type: () -> Messages::Type
+    def parse_insert: () -> Messages::Insert
+    def parse_update: () -> Messages::Update
+    def parse_delete: () -> Messages::Delete
+    def parse_truncate: () -> Messages::Truncate
+    def parse_commit: () -> Messages::Commit
+    def parse_tuple_data: () -> Array[Messages::TupleValue]
+    def read_uint8: () -> Integer
+    def read_uint16: () -> Integer
+    def read_uint32: () -> Integer
+    def read_int32: () -> Integer
+    def read_uint64: () -> Integer
+    def read_byte_chr: () -> String
+    def read_cstring: () -> String
+    def read_bytes: (Integer length) -> String
+    def share: [T < message] (T message) -> T
   end
 
   class RelationTracker
-    def initialize: () -> void
+    @relations: Hash[Integer, Messages::Relation]
+
+    def initialize: (?relation_cache: untyped) -> void
 
     def process: (String payload) -> message
+
+    def decode: (String payload) -> message
+
+    private
+
+    def annotate_insert: (Messages::Insert message) -> Messages::Insert
+    def annotate_update: (Messages::Update message) -> Messages::Update
+    def annotate_delete: (Messages::Delete message) -> Messages::Delete
+    def annotate_optional_tuple: (Array[Messages::TupleValue]? tuple, Messages::Relation relation) -> Array[Messages::TupleValue]?
+    def annotate_tuple: (Array[Messages::TupleValue] tuple, Messages::Relation relation) -> Array[Messages::TupleValue]
+    def validate_tuple_arity!: (Array[Messages::TupleValue] tuple, Messages::Relation relation) -> void
+    def relation_for: (Integer relation_id) -> Messages::Relation
   end
 end

metadata

@@ -1,112 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgoutput-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken C. Demanawa
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.27'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.27'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.87'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.87'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: steep
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.44
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.44
+dependencies: []
 description: A pure Ruby parser for PostgreSQL pgoutput logical replication CopyData
   payloads.
 email:
@@ -118,6 +20,9 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- docs/glossary.md
+- docs/index.md
+- docs/relation_tracker.md
 - lib/pgoutput.rb
 - lib/pgoutput/binary_parser.rb
 - lib/pgoutput/errors.rb
@@ -140,14 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Ractor-safe PostgreSQL pgoutput logical replication protocol parser.
 test_files: []