deimos-ruby 1.24.2 → 2.0.0.pre.alpha1

data/lib/deimos/schema_backends/base.rb

@@ -79,7 +79,7 @@ module Deimos
       # Indicate a class which should act as a mocked version of this backend.
       # This class should perform all validations but not actually do any
       # encoding.
-      # Note that the "mock" version (e.g. avro_validation) should return
+      # Note that the "mock" version should return
       # its own symbol when this is called, since it may be called multiple
       # times depending on the order of RSpec helpers.
       # @return [Symbol]
@@ -90,7 +90,7 @@ module Deimos
       # The content type to use when encoding / decoding requests over HTTP via ActionController.
       # @return [String]
       def self.content_type
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Converts your schema to String form for generated YARD docs.
@@ -98,7 +98,7 @@ module Deimos
       # @param schema [Object]
       # @return [String] A string representation of the Type
       def self.field_type(schema)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Encode a payload. To be defined by subclass.
@@ -107,7 +107,7 @@ module Deimos
       # @param topic [String]
       # @return [String]
       def encode_payload(payload, schema:, topic: nil)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Decode a payload. To be defined by subclass.
@@ -115,7 +115,7 @@ module Deimos
       # @param schema [String,Symbol]
       # @return [Hash]
       def decode_payload(payload, schema:)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Validate that a payload matches the schema. To be defined by subclass.
@@ -123,13 +123,13 @@ module Deimos
       # @param schema [String,Symbol]
       # @return [void]
       def validate(payload, schema:)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # List of field names belonging to the schema. To be defined by subclass.
       # @return [Array<SchemaField>]
       def schema_fields
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Given a value and a field definition (as defined by whatever the
@@ -139,7 +139,7 @@ module Deimos
       # @param value [Object]
       # @return [Object]
       def coerce_field(field, value)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Given a field definition, return the SQL type that might be used in
@@ -150,7 +150,14 @@ module Deimos
       # @param field [SchemaField]
       # @return [Symbol]
       def sql_type(field)
-        raise NotImplementedError
+        raise MissingImplementationError
+      end
+
+      # Generate a key schema from the given value schema and key ID. This
+      # is used when encoding or decoding keys from an existing value schema.
+      # @param field_name [Symbol]
+      def generate_key_schema(field_name)
+        raise MissingImplementationError
       end
 
       # Encode a message key. To be defined by subclass.
@@ -159,7 +166,7 @@ module Deimos
       # @param topic [String]
       # @return [String]
       def encode_key(key, key_id, topic: nil)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Decode a message key. To be defined by subclass.
@@ -167,13 +174,13 @@ module Deimos
       # @param key_id [String,Symbol] the field in the message to decode.
       # @return [String]
       def decode_key(payload, key_id)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Forcefully loads the schema into memory.
       # @return [Object] The schema that is of use.
       def load_schema
-        raise NotImplementedError
+        raise MissingImplementationError
       end
     end
   end

data/lib/deimos/schema_backends/mock.rb

@@ -4,6 +4,11 @@ module Deimos
   module SchemaBackends
     # Mock implementation of a schema backend that does no encoding or validation.
     class Mock < Base
+
+      # @override
+      def generate_key_schema(field_name)
+      end
+
       # @override
       def decode_payload(payload, schema:)
         payload.is_a?(String) ? 'payload-decoded' : payload.map { |k, v| [k, "decoded-#{v}"] }
@@ -11,7 +16,7 @@ module Deimos
 
       # @override
       def encode_payload(payload, schema:, topic: nil)
-        payload.is_a?(String) ? 'payload-encoded' : payload.map { |k, v| [k, "encoded-#{v}"] }
+        payload.is_a?(String) ? 'payload-encoded' : payload.map { |k, v| [k, "encoded-#{v}"] }.to_json
       end
 
       # @override

data/lib/deimos/schema_backends/plain.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Deimos
+  module SchemaBackends
+    # Schema backend that passes through as a basic string.
+    class Plain < Base
+
+      # @override
+      def generate_key_schema(field_name)
+      end
+
+      # @override
+      def decode_payload(payload, schema:)
+        payload
+      end
+
+      # @override
+      def encode_payload(payload, schema:, topic: nil)
+        payload.to_s
+      end
+
+      # @override
+      def validate(payload, schema:)
+      end
+
+      # @override
+      def schema_fields
+        []
+      end
+
+      # @override
+      def coerce_field(_field, value)
+        value
+      end
+
+      # @override
+      def encode_key(key_id, key, topic: nil)
+        key
+      end
+
+      # @override
+      def decode_key(payload, key_id)
+        payload[key_id]
+      end
+    end
+  end
+end

data/lib/deimos/schema_class/base.rb

@@ -15,7 +15,7 @@ module Deimos
       # @param _opts [Hash]
       # @return [Hash] a hash representation of the payload
       def as_json(_opts={})
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # @param key [String,Symbol]
@@ -46,7 +46,7 @@ module Deimos
       # @param value [Object]
       # @return [SchemaClass::Base]
       def self.initialize_from_value(value)
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
     protected

data/lib/deimos/schema_class/enum.rb

@@ -30,7 +30,7 @@ module Deimos
       # Returns all the valid symbols for this enum.
       # @return [Array<String>]
       def symbols
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # @return [String]

data/lib/deimos/schema_class/record.rb

@@ -46,13 +46,13 @@ module Deimos
       # Returns the schema name of the inheriting class.
       # @return [String]
       def schema
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Returns the namespace for the schema of the inheriting class.
       # @return [String]
       def namespace
-        raise NotImplementedError
+        raise MissingImplementationError
       end
 
       # Returns the full schema name of the inheriting class.