deimos-ruby 1.10.2 → 1.12.0

data/spec/schema_classes/my_nested_schema.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+# This file is autogenerated by Deimos, Do NOT modify
+module Schemas
+  ### Secondary Schema Classes ###
+  # Autogenerated Schema for Record at com.my-namespace.MyNestedRecord
+  class MyNestedRecord < Deimos::SchemaClass::Record
+    ### Attribute Accessors ###
+    # @param value [Integer]
+    attr_accessor :some_int
+    # @param value [Float]
+    attr_accessor :some_float
+    # @param value [String]
+    attr_accessor :some_string
+    # @param value [nil, Integer]
+    attr_accessor :some_optional_int
+
+    # @override
+    def initialize(some_int: nil,
+                   some_float: nil,
+                   some_string: nil,
+                   some_optional_int: nil)
+      super
+      self.some_int = some_int
+      self.some_float = some_float
+      self.some_string = some_string
+      self.some_optional_int = some_optional_int
+    end
+
+    # @override
+    def schema
+      'MyNestedRecord'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'some_int' => @some_int,
+        'some_float' => @some_float,
+        'some_string' => @some_string,
+        'some_optional_int' => @some_optional_int
+      }
+    end
+  end
+
+  ### Primary Schema Class ###
+  # Autogenerated Schema for Record at com.my-namespace.MyNestedSchema
+  class MyNestedSchema < Deimos::SchemaClass::Record
+    ### Attribute Readers ###
+    # @return [MyNestedRecord]
+    attr_reader :some_nested_record
+    # @return [nil, MyNestedRecord]
+    attr_reader :some_optional_record
+
+    ### Attribute Accessors ###
+    # @param value [String]
+    attr_accessor :test_id
+    # @param value [Float]
+    attr_accessor :test_float
+    # @param values [Array<String>]
+    attr_accessor :test_array
+
+    ### Attribute Writers ###
+    # @param value [MyNestedRecord]
+    def some_nested_record=(value)
+      @some_nested_record = MyNestedRecord.initialize_from_value(value)
+    end
+
+    # @param value [nil, MyNestedRecord]
+    def some_optional_record=(value)
+      @some_optional_record = MyNestedRecord.initialize_from_value(value)
+    end
+
+    # @override
+    def initialize(test_id: nil,
+                   test_float: nil,
+                   test_array: nil,
+                   some_nested_record: nil,
+                   some_optional_record: nil)
+      super
+      self.test_id = test_id
+      self.test_float = test_float
+      self.test_array = test_array
+      self.some_nested_record = some_nested_record
+      self.some_optional_record = some_optional_record
+    end
+
+    # @override
+    def schema
+      'MyNestedSchema'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'test_id' => @test_id,
+        'test_float' => @test_float,
+        'test_array' => @test_array,
+        'some_nested_record' => @some_nested_record&.to_h,
+        'some_optional_record' => @some_optional_record&.to_h
+      }
+    end
+  end
+end

data/spec/schema_classes/my_schema.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# This file is autogenerated by Deimos, Do NOT modify
+module Schemas
+  ### Primary Schema Class ###
+  # Autogenerated Schema for Record at com.my-namespace.MySchema
+  class MySchema < Deimos::SchemaClass::Record
+    ### Attribute Readers ###
+    # @return [MySchemaKey]
+    attr_reader :payload_key
+
+    ### Attribute Accessors ###
+    # @param value [String]
+    attr_accessor :test_id
+    # @param value [Integer]
+    attr_accessor :some_int
+
+    ### Attribute Writers ###
+    # @param value [MySchemaKey]
+    def payload_key=(value)
+      @payload_key = MySchemaKey.initialize_from_value(value)
+    end
+
+    # @override
+    def initialize(test_id: nil,
+                   some_int: nil,
+                   payload_key: nil)
+      super
+      self.test_id = test_id
+      self.some_int = some_int
+      self.payload_key = payload_key
+    end
+
+    # @override
+    def schema
+      'MySchema'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'test_id' => @test_id,
+        'some_int' => @some_int,
+        'payload_key' => @payload_key&.to_h
+      }
+    end
+  end
+end

data/spec/schema_classes/my_schema_key.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is autogenerated by Deimos, Do NOT modify
+module Schemas
+  ### Primary Schema Class ###
+  # Autogenerated Schema for Record at com.my-namespace.MySchema-key
+  class MySchemaKey < Deimos::SchemaClass::Record
+    ### Attribute Accessors ###
+    # @param value [String]
+    attr_accessor :test_id
+
+    # @override
+    def initialize(test_id: nil)
+      super
+      self.test_id = test_id
+    end
+
+    # @override
+    def schema
+      'MySchema-key'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'test_id' => @test_id
+      }
+    end
+  end
+end

data/spec/schema_classes/my_schema_with_complex_types.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# This file is autogenerated by Deimos, Do NOT modify
+module Schemas
+  ### Secondary Schema Classes ###
+  # Autogenerated Schema for Record at com.my-namespace.ARecord
+  class ARecord < Deimos::SchemaClass::Record
+    ### Attribute Accessors ###
+    # @param value [String]
+    attr_accessor :a_record_field
+
+    # @override
+    def initialize(a_record_field: nil)
+      super
+      self.a_record_field = a_record_field
+    end
+
+    # @override
+    def schema
+      'ARecord'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'a_record_field' => @a_record_field
+      }
+    end
+  end
+
+  # Autogenerated Schema for Enum at com.my-namespace.AnEnum
+  class AnEnum < Deimos::SchemaClass::Enum
+    # @return ['sym1', 'sym2']
+    attr_accessor :an_enum
+
+    # :nodoc:
+    def initialize(an_enum)
+      super
+      self.an_enum = an_enum
+    end
+
+    # @override
+    def symbols
+      %w(sym1 sym2)
+    end
+
+    # @override
+    def to_h
+      @an_enum
+    end
+  end
+
+  ### Primary Schema Class ###
+  # Autogenerated Schema for Record at com.my-namespace.MySchemaWithComplexTypes
+  class MySchemaWithComplexTypes < Deimos::SchemaClass::Record
+    ### Attribute Readers ###
+    # @return [ARecord]
+    attr_reader :some_record
+    # @return [nil, ARecord]
+    attr_reader :some_optional_record
+    # @return [Array<ARecord>]
+    attr_reader :some_record_array
+    # @return [Hash<String, ARecord>]
+    attr_reader :some_record_map
+    # @return [Array<AnEnum>]
+    attr_reader :some_enum_array
+
+    ### Attribute Accessors ###
+    # @param value [String]
+    attr_accessor :test_id
+    # @param value [Float]
+    attr_accessor :test_float
+    # @param values [Array<String>]
+    attr_accessor :test_string_array
+    # @param values [Array<Integer>]
+    attr_accessor :test_int_array
+    # @param value [Integer, nil]
+    attr_accessor :test_optional_int
+    # @param values [Hash<String, Integer>]
+    attr_accessor :some_integer_map
+
+    ### Attribute Writers ###
+    # @param value [ARecord]
+    def some_record=(value)
+      @some_record = ARecord.initialize_from_value(value)
+    end
+
+    # @param value [nil, ARecord]
+    def some_optional_record=(value)
+      @some_optional_record = ARecord.initialize_from_value(value)
+    end
+
+    # @param values [Array<ARecord>]
+    def some_record_array=(values)
+      @some_record_array = values.map do |value|
+        ARecord.initialize_from_value(value)
+      end
+    end
+
+    # @param values [Hash<String, ARecord>]
+    def some_record_map=(values)
+      @some_record_map = values.transform_values do |value|
+        ARecord.initialize_from_value(value)
+      end
+    end
+
+    # @param values [Array<AnEnum>]
+    def some_enum_array=(values)
+      @some_enum_array = values.map do |value|
+        AnEnum.initialize_from_value(value)
+      end
+    end
+
+    # @override
+    def initialize(test_id: nil,
+                   test_float: nil,
+                   test_string_array: ["test"],
+                   test_int_array: [123],
+                   test_optional_int: 123,
+                   some_integer_map: {"abc"=>123},
+                   some_record: {"a_record_field"=>"Test String"},
+                   some_optional_record: nil,
+                   some_record_array: nil,
+                   some_record_map: nil,
+                   some_enum_array: nil)
+      super
+      self.test_id = test_id
+      self.test_float = test_float
+      self.test_string_array = test_string_array
+      self.test_int_array = test_int_array
+      self.test_optional_int = test_optional_int
+      self.some_integer_map = some_integer_map
+      self.some_record = some_record
+      self.some_optional_record = some_optional_record
+      self.some_record_array = some_record_array
+      self.some_record_map = some_record_map
+      self.some_enum_array = some_enum_array
+    end
+
+    # @override
+    def schema
+      'MySchemaWithComplexTypes'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'test_id' => @test_id,
+        'test_float' => @test_float,
+        'test_string_array' => @test_string_array,
+        'test_int_array' => @test_int_array,
+        'test_optional_int' => @test_optional_int,
+        'some_integer_map' => @some_integer_map,
+        'some_record' => @some_record&.to_h,
+        'some_optional_record' => @some_optional_record&.to_h,
+        'some_record_array' => @some_record_array.map { |v| v&.to_h },
+        'some_record_map' => @some_record_map.transform_values { |v| v&.to_h },
+        'some_enum_array' => @some_enum_array.map { |v| v&.to_h }
+      }
+    end
+  end
+end

data/spec/schemas/com/my-namespace/Generated.avsc

@@ -24,6 +24,12 @@
       "name": "a_double",
       "type": "double"
     },
+    {
+      "name": "an_optional_int",
+      "type": [ "null", "int" ],
+      "doc": "an optional int",
+      "default": null
+    },
     {
       "name": "an_enum",
       "type": {

data/spec/schemas/com/my-namespace/MySchemaWithComplexTypes.avsc

@@ -0,0 +1,95 @@
+{
+  "namespace": "com.my-namespace",
+  "name": "MySchemaWithComplexTypes",
+  "type": "record",
+  "doc": "Test schema",
+  "fields": [
+    {
+      "name": "test_id",
+      "type": "string",
+      "doc": "test string"
+    },
+    {
+      "name": "test_float",
+      "type": "float",
+      "doc": "test float"
+    },
+    {
+      "name": "test_string_array",
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "default": ["test"]
+    },
+    {
+      "name": "test_int_array",
+      "type": {
+        "type": "array",
+        "items": "int"
+      },
+      "default": [123]
+    },
+    {
+      "name": "test_optional_int",
+      "type": [ "int", "null" ],
+      "default": 123
+    },
+    {
+      "name": "some_integer_map",
+      "doc": "some record map",
+      "type": {
+        "type": "map",
+        "values": "int"
+      },
+      "default": {"abc": 123}
+    },
+    {
+      "name": "some_record",
+      "type": {
+        "type": "record",
+        "name": "ARecord",
+        "fields": [
+          {
+            "name": "a_record_field",
+            "type": "string"
+          }
+        ]
+      },
+      "default": {"a_record_field": "Test String"}
+    },
+    {
+      "name": "some_optional_record",
+      "doc": "some optional record",
+      "type": [ "null", "ARecord" ],
+      "default": null
+    },
+    {
+      "name": "some_record_array",
+      "doc": "some record array",
+      "type": {
+        "type": "array",
+        "items": "ARecord"
+      }
+    },
+    {
+      "name": "some_record_map",
+      "doc": "some record map",
+      "type": {
+        "type": "map",
+        "values": "ARecord"
+      }
+    },
+    {
+      "name": "some_enum_array",
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "enum",
+          "name": "AnEnum",
+          "symbols": ["sym1", "sym2"]
+        }
+      }
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -13,6 +13,10 @@ require 'activerecord-import'
 require 'handlers/my_batch_consumer'
 require 'handlers/my_consumer'
 require 'rspec/rails'
+Dir['./spec/schema_classes/**/*.rb'].sort.each { |f| require f }
+
+# Constants used for consumer specs
+SCHEMA_CLASS_SETTINGS = { off: false, on: true }.freeze
 
 class DeimosApp < Rails::Application
 end
@@ -100,7 +104,7 @@ module DbConfigs
     DB_OPTIONS.each do |options|
       describe subject, :integration, db_config: options do
 
-        include_context 'with DB'
+        include_context('with DB')
         describe options[:adapter] do # rubocop:disable RSpec/EmptyExampleGroup
           self.instance_eval(&block)
         end
@@ -192,6 +196,7 @@ RSpec.configure do |config|
       deimos_config.logger = Logger.new('/dev/null')
       deimos_config.logger.level = Logger::INFO
       deimos_config.schema.backend = :avro_validation
+      deimos_config.schema.generated_class_path = 'spec/schema_classes'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.12.0
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf
@@ -302,14 +302,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 0.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 0.89.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -409,6 +409,9 @@ files:
 - lib/deimos/schema_backends/avro_validation.rb
 - lib/deimos/schema_backends/base.rb
 - lib/deimos/schema_backends/mock.rb
+- lib/deimos/schema_class/base.rb
+- lib/deimos/schema_class/enum.rb
+- lib/deimos/schema_class/record.rb
 - lib/deimos/shared_config.rb
 - lib/deimos/test_helpers.rb
 - lib/deimos/tracing/datadog.rb
@@ -419,6 +422,7 @@ files:
 - lib/deimos/utils/deadlock_retry.rb
 - lib/deimos/utils/inline_consumer.rb
 - lib/deimos/utils/lag_reporter.rb
+- lib/deimos/utils/schema_class.rb
 - lib/deimos/utils/schema_controller_mixin.rb
 - lib/deimos/version.rb
 - lib/generators/deimos/active_record/templates/migration.rb.tt
@@ -430,6 +434,10 @@ files:
 - lib/generators/deimos/db_poller/templates/migration
 - lib/generators/deimos/db_poller/templates/rails3_migration
 - lib/generators/deimos/db_poller_generator.rb
+- lib/generators/deimos/schema_class/templates/schema_class.rb.tt
+- lib/generators/deimos/schema_class/templates/schema_enum.rb.tt
+- lib/generators/deimos/schema_class/templates/schema_record.rb.tt
+- lib/generators/deimos/schema_class_generator.rb
 - lib/tasks/deimos.rake
 - spec/active_record_batch_consumer_spec.rb
 - spec/active_record_consume/batch_slicer_spec.rb
@@ -445,6 +453,8 @@ files:
 - spec/consumer_spec.rb
 - spec/deimos_spec.rb
 - spec/generators/active_record_generator_spec.rb
+- spec/generators/schema_class/my_schema_with_complex_types_spec.rb
+- spec/generators/schema_class_generator_spec.rb
 - spec/handlers/my_batch_consumer.rb
 - spec/handlers/my_consumer.rb
 - spec/kafka_listener_spec.rb
@@ -460,12 +470,18 @@ files:
 - spec/schema_backends/avro_schema_registry_spec.rb
 - spec/schema_backends/avro_validation_spec.rb
 - spec/schema_backends/base_spec.rb
+- spec/schema_classes/generated.rb
+- spec/schema_classes/my_nested_schema.rb
+- spec/schema_classes/my_schema.rb
+- spec/schema_classes/my_schema_key.rb
+- spec/schema_classes/my_schema_with_complex_types.rb
 - spec/schemas/com/my-namespace/Generated.avsc
 - spec/schemas/com/my-namespace/MyNestedSchema.avsc
 - spec/schemas/com/my-namespace/MySchema-key.avsc
 - spec/schemas/com/my-namespace/MySchema.avsc
 - spec/schemas/com/my-namespace/MySchemaCompound-key.avsc
 - spec/schemas/com/my-namespace/MySchemaWithBooleans.avsc
+- spec/schemas/com/my-namespace/MySchemaWithComplexTypes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithDateTimes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithId.avsc
 - spec/schemas/com/my-namespace/MySchemaWithUniqueId.avsc
@@ -528,6 +544,8 @@ test_files:
 - spec/consumer_spec.rb
 - spec/deimos_spec.rb
 - spec/generators/active_record_generator_spec.rb
+- spec/generators/schema_class/my_schema_with_complex_types_spec.rb
+- spec/generators/schema_class_generator_spec.rb
 - spec/handlers/my_batch_consumer.rb
 - spec/handlers/my_consumer.rb
 - spec/kafka_listener_spec.rb
@@ -543,12 +561,18 @@ test_files:
 - spec/schema_backends/avro_schema_registry_spec.rb
 - spec/schema_backends/avro_validation_spec.rb
 - spec/schema_backends/base_spec.rb
+- spec/schema_classes/generated.rb
+- spec/schema_classes/my_nested_schema.rb
+- spec/schema_classes/my_schema.rb
+- spec/schema_classes/my_schema_key.rb
+- spec/schema_classes/my_schema_with_complex_types.rb
 - spec/schemas/com/my-namespace/Generated.avsc
 - spec/schemas/com/my-namespace/MyNestedSchema.avsc
 - spec/schemas/com/my-namespace/MySchema-key.avsc
 - spec/schemas/com/my-namespace/MySchema.avsc
 - spec/schemas/com/my-namespace/MySchemaCompound-key.avsc
 - spec/schemas/com/my-namespace/MySchemaWithBooleans.avsc
+- spec/schemas/com/my-namespace/MySchemaWithComplexTypes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithDateTimes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithId.avsc
 - spec/schemas/com/my-namespace/MySchemaWithUniqueId.avsc