avromatic 1.0.0 → 2.0.0

data/lib/avromatic/model/validation.rb

@@ -1,53 +1,74 @@
+# frozen_string_literal: true
+
 module Avromatic
   module Model
     module Validation
       extend ActiveSupport::Concern
+      include ActiveModel::Validations
 
-      module ClassMethods
-
-        # Returns an array of messages
-        def validate_nested_value(value)
-          case value
-          when Avromatic::Model::Attributes
-            validate_record_value(value)
-          when Array
-            value.flat_map.with_index do |element, index|
-              validate_nested_value(element).map do |message|
-                "[#{index}]#{message}"
-              end
-            end
-          when Hash
-            value.flat_map do |key, map_value|
-              # keys for the Avro map type are always strings and do not require
-              # validation
-              validate_nested_value(map_value).map do |message|
-                "['#{key}']#{message}"
-              end
-            end
-          else
-            []
+      EMPTY_ARRAY = [].freeze
+
+      def self.missing_nested_attributes(attribute, value)
+        if value.is_a?(Array)
+          results = []
+          value.each_with_index do |element, index|
+            nested_results = missing_nested_attributes("#{attribute}[#{index}]", element)
+            results.concat(nested_results)
+          end
+          results
+        elsif value.is_a?(Hash)
+          results = []
+          value.each do |key, element|
+            nested_results = missing_nested_attributes("#{attribute}['#{key}']", element)
+            results.concat(nested_results)
           end
+          results
+        elsif value.respond_to?(:missing_avro_attributes)
+          value.missing_avro_attributes.map do |missing_child_attribute|
+            "#{attribute}.#{missing_child_attribute}"
+          end
+        else
+          EMPTY_ARRAY
         end
+      end
 
-        private
-
-        def validate_complex(field_name)
-          validate do |instance|
-            value = instance.send(field_name)
-            messages = self.class.validate_nested_value(value)
-            messages.each { |message| instance.errors.add(field_name.to_sym, message) }
+      included do
+        # Support the ActiveModel::Validations interface for backwards compatibility
+        validate do |model|
+          model.missing_avro_attributes.each do |missing_attribute|
+            errors.add(:base, "#{missing_attribute} can't be nil")
           end
         end
+      end
+
+      def avro_validate!
+        results = missing_avro_attributes
+        if results.present?
+          raise Avromatic::Model::ValidationError.new("#{self.class.name}(#{attributes.inspect}) cannot be " \
+            "serialized because the following attributes are nil: #{results.join(', ')}")
+        end
+      end
+
+      def missing_avro_attributes
+        return @missing_attributes if instance_variable_defined?(:@missing_attributes)
 
-        def validate_record_value(record)
-          if record && record.invalid?
-            record.errors.map do |key, message|
-              ".#{key} #{message}".gsub(' .', '.')
-            end
+        missing_attributes = []
+
+        self.class.attribute_definitions.each_value do |attribute_definition|
+          value = send(attribute_definition.name)
+          field = attribute_definition.field
+          if value.nil? && field.type.type_sym != :null && attribute_definition.required?
+            missing_attributes << field.name
           else
-            []
+            missing_attributes.concat(Avromatic::Model::Validation.missing_nested_attributes(field.name, value))
           end
         end
+
+        unless self.class.config.mutable
+          @missing_attributes = missing_attributes.deep_freeze
+        end
+
+        missing_attributes
       end
     end
   end

data/lib/avromatic/model/validation_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Avromatic
+  module Model
+    class ValidationError < StandardError
+    end
+  end
+end

data/lib/avromatic/model/value_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Avromatic
   module Model
     # This module is used to override the comparisons defined by

data/lib/avromatic/model.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'avromatic/model/builder'
+require 'avromatic/model/coercion_error'
 require 'avromatic/model/message_decoder'
-require 'avromatic/model/type_registry'
-require 'avromatic/model/logical_types'
+require 'avromatic/model/custom_type_registry'
+require 'avromatic/model/validation_error'
+require 'avromatic/model/unknown_attribute_error'
 
 module Avromatic
   module Model

data/lib/avromatic/model_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/access'
 
 module Avromatic

data/lib/avromatic/patches/schema_validator_patch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Avromatic
   module Patches
     module SchemaValidatorPatch

data/lib/avromatic/patches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 loaded_avro_patches = begin
     require 'avro-patches'
     true

data/lib/avromatic/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Avromatic
   class Railtie < Rails::Railtie
     initializer 'avromatic.configure' do

data/lib/avromatic/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webmock/rspec'
 require 'avro_schema_registry/test/fake_server'
 

data/lib/avromatic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Avromatic
-  VERSION = '1.0.0'.freeze
+  VERSION = '2.0.0'
 end

data/lib/avromatic.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 require 'avromatic/version'
 require 'avro_schema_registry-client'
+require 'ice_nine'
+require 'ice_nine/core_ext/object'
 require 'avromatic/model'
 require 'avromatic/model_registry'
 require 'avromatic/messaging'
@@ -9,19 +13,20 @@ require 'avromatic/patches'
 module Avromatic
   class << self
     attr_accessor :schema_registry, :registry_url, :schema_store, :logger,
-                  :messaging, :type_registry, :nested_models,
+                  :messaging, :custom_type_registry, :nested_models,
                   :use_custom_datum_reader, :use_custom_datum_writer,
-                  :use_schema_fingerprint_lookup
+                  :use_schema_fingerprint_lookup, :allow_unknown_attributes
 
-    delegate :register_type, to: :type_registry
+    delegate :register_type, to: :custom_type_registry
   end
 
   self.nested_models = ModelRegistry.new
   self.logger = Logger.new($stdout)
-  self.type_registry = Avromatic::Model::TypeRegistry.new
+  self.custom_type_registry = Avromatic::Model::CustomTypeRegistry.new
   self.use_custom_datum_reader = true
   self.use_custom_datum_writer = true
   self.use_schema_fingerprint_lookup = true
+  self.allow_unknown_attributes = false
 
   def self.configure
     yield self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.3'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.3'
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.3'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.3'
@@ -93,7 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: virtus
+  name: ice_nine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -284,28 +284,39 @@ files:
 - lib/avromatic/io/datum_writer.rb
 - lib/avromatic/messaging.rb
 - lib/avromatic/model.rb
-- lib/avromatic/model/allowed_type_validator.rb
-- lib/avromatic/model/allowed_writer_methods_memoization.rb
-- lib/avromatic/model/attribute/abstract_timestamp.rb
-- lib/avromatic/model/attribute/record.rb
-- lib/avromatic/model/attribute/timestamp_micros.rb
-- lib/avromatic/model/attribute/timestamp_millis.rb
-- lib/avromatic/model/attribute/union.rb
-- lib/avromatic/model/attribute_type/union.rb
 - lib/avromatic/model/attributes.rb
 - lib/avromatic/model/builder.rb
+- lib/avromatic/model/coercion_error.rb
 - lib/avromatic/model/configurable.rb
 - lib/avromatic/model/configuration.rb
-- lib/avromatic/model/custom_type.rb
-- lib/avromatic/model/logical_types.rb
+- lib/avromatic/model/custom_type_configuration.rb
+- lib/avromatic/model/custom_type_registry.rb
+- lib/avromatic/model/field_helper.rb
 - lib/avromatic/model/message_decoder.rb
 - lib/avromatic/model/messaging_serialization.rb
 - lib/avromatic/model/nested_models.rb
-- lib/avromatic/model/null_custom_type.rb
-- lib/avromatic/model/passthrough_serializer.rb
 - lib/avromatic/model/raw_serialization.rb
-- lib/avromatic/model/type_registry.rb
+- lib/avromatic/model/types/abstract_timestamp_type.rb
+- lib/avromatic/model/types/abstract_type.rb
+- lib/avromatic/model/types/array_type.rb
+- lib/avromatic/model/types/boolean_type.rb
+- lib/avromatic/model/types/custom_type.rb
+- lib/avromatic/model/types/date_type.rb
+- lib/avromatic/model/types/enum_type.rb
+- lib/avromatic/model/types/fixed_type.rb
+- lib/avromatic/model/types/float_type.rb
+- lib/avromatic/model/types/integer_type.rb
+- lib/avromatic/model/types/map_type.rb
+- lib/avromatic/model/types/null_type.rb
+- lib/avromatic/model/types/record_type.rb
+- lib/avromatic/model/types/string_type.rb
+- lib/avromatic/model/types/timestamp_micros_type.rb
+- lib/avromatic/model/types/timestamp_millis_type.rb
+- lib/avromatic/model/types/type_factory.rb
+- lib/avromatic/model/types/union_type.rb
+- lib/avromatic/model/unknown_attribute_error.rb
 - lib/avromatic/model/validation.rb
+- lib/avromatic/model/validation_error.rb
 - lib/avromatic/model/value_object.rb
 - lib/avromatic/model_registry.rb
 - lib/avromatic/patches.rb
@@ -326,7 +337,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/avromatic/model/allowed_type_validator.rb

@@ -1,7 +0,0 @@
-class AllowedTypeValidator < ActiveModel::EachValidator
-  def validate_each(record, name, value)
-    if options[:in].find { |klass| value.is_a?(klass) }.nil?
-      record.errors[name] << "does not have the expected type #{options[:in]}"
-    end
-  end
-end

data/lib/avromatic/model/allowed_writer_methods_memoization.rb

@@ -1,16 +0,0 @@
-module Avromatic
-  module Model
-    module AllowedWriterMethodsMemoization
-      def self.included(base)
-        base.class_attribute :virtus_object_allowed_writer_methods
-        base.prepend(InstanceMethods)
-      end
-
-      module InstanceMethods
-        def allowed_writer_methods
-          self.class.virtus_object_allowed_writer_methods ||= super
-        end
-      end
-    end
-  end
-end

data/lib/avromatic/model/attribute/abstract_timestamp.rb

@@ -1,26 +0,0 @@
-module Avromatic
-  module Model
-    module Attribute
-
-      # This subclass of Virtus::Attribute is used to truncate timestamp values
-      # to the supported precision.
-      class AbstractTimestamp < Virtus::Attribute
-        def coerce(value)
-          return value if value.nil? || value_coerced?(value)
-
-          value.is_a?(Time) ? coerce_time(value) : value
-        end
-
-        def value_coerced?(_value)
-          raise "#{__method__} must be overridden by #{self.class.name}"
-        end
-
-        private
-
-        def coerce_time(_value)
-          raise "#{__method__} must be overridden by #{self.class.name}"
-        end
-      end
-    end
-  end
-end

data/lib/avromatic/model/attribute/record.rb

@@ -1,26 +0,0 @@
-module Avromatic
-  module Model
-    module Attribute
-
-      # This subclass of Virtus::Attribute is defined to ensure that Avromatic
-      # generated models (identified by their inclusion of
-      # Avromatic::Model::Attributes) are always coerced by identifying an
-      # instance of the model or creating a new one.
-      # This is required to coerce models correctly with nested complex types
-      # with Virtus.
-      class Record < Virtus::Attribute
-        primitive Avromatic::Model::Attributes
-
-        def coerce(value)
-          return value if value.nil? || value.is_a?(primitive)
-
-          primitive.new(value)
-        end
-
-        def value_coerced?(value)
-          value.is_a?(primitive)
-        end
-      end
-    end
-  end
-end

data/lib/avromatic/model/attribute/timestamp_micros.rb

@@ -1,26 +0,0 @@
-require 'avromatic/model/attribute/abstract_timestamp'
-
-module Avromatic
-  module Model
-    module Attribute
-
-      # This subclass is used to truncate timestamp values to microseconds.
-      class TimestampMicros < AbstractTimestamp
-
-        def value_coerced?(value)
-          value.is_a?(Time) && value.nsec % 1000 == 0
-        end
-
-        private
-
-        def coerce_time(value)
-          # value is coerced to a local Time
-          # The Avro representation of a timestamp is Epoch seconds, independent
-          # of time zone.
-          Time.at(value.to_i, value.usec)
-        end
-
-      end
-    end
-  end
-end

data/lib/avromatic/model/attribute/timestamp_millis.rb

@@ -1,26 +0,0 @@
-require 'avromatic/model/attribute/abstract_timestamp'
-
-module Avromatic
-  module Model
-    module Attribute
-
-      # This subclass is used to truncate timestamp values to milliseconds.
-      class TimestampMillis < AbstractTimestamp
-
-        def value_coerced?(value)
-          value.is_a?(Time) && value.usec % 1000 == 0
-        end
-
-        private
-
-        def coerce_time(value)
-          # value is coerced to a local Time
-          # The Avro representation of a timestamp is Epoch seconds, independent
-          # of time zone.
-          Time.at(value.to_i, value.usec / 1000 * 1000)
-        end
-
-      end
-    end
-  end
-end

data/lib/avromatic/model/attribute/union.rb

@@ -1,66 +0,0 @@
-require 'avromatic/model/attribute_type/union'
-require 'avromatic/io'
-
-module Avromatic
-  module Model
-    module Attribute
-
-      # This subclass of Virtus::Attribute is used for any unions that are
-      # defined as subclasses of the primitive Avromatic::Model::AttributeType::Union.
-      # Values are coerced by first checking if they already match one of the
-      # member types, and then by attempting to coerce to each member type in
-      # order.
-      class Union < Virtus::Attribute
-        primitive Avromatic::Model::AttributeType::Union
-
-        MEMBER_INDEX = ::Avromatic::IO::DatumReader::UNION_MEMBER_INDEX
-
-        def initialize(*)
-          super
-
-          primitive.types.each do |type|
-            member_attributes << Virtus::Attribute.build(type)
-          end
-        end
-
-        def coerce(input)
-          return input if value_coerced?(input)
-
-          result = nil
-          if input && input.key?(MEMBER_INDEX)
-            result = safe_coerce(member_attributes[input.delete(MEMBER_INDEX)], input)
-          else
-            member_attributes.find do |union_attribute|
-              result = safe_coerce(union_attribute, input)
-            end
-          end
-          result
-        end
-
-        def value_coerced?(value)
-          member_attributes.any? do |union_attribute|
-            union_attribute.value_coerced?(value)
-          end
-        end
-
-        private
-
-        def safe_coerce(member_attribute, input)
-          coerced = member_attribute.coerce(input)
-
-          if coerced.is_a?(Avromatic::Model::Attributes)
-            coerced if coerced.valid?
-          elsif member_attribute.coerced?(coerced)
-            coerced
-          end
-        rescue StandardError
-          nil
-        end
-
-        def member_attributes
-          @member_attributes ||= Array.new
-        end
-      end
-    end
-  end
-end

data/lib/avromatic/model/attribute_type/union.rb

@@ -1,29 +0,0 @@
-module Avromatic
-  module Model
-    module AttributeType
-
-      # This class is used as the base class for Virtus attributes that
-      # represent unions. A subclass is generated using Union[*types]. This
-      # subclass is specified when defining a Virtus attribute.
-      class Union
-        class << self
-          attr_reader :types
-
-          protected
-
-          attr_writer :types
-        end
-
-        # Factory method to define Union types with the specified list of
-        # types (classes).
-        def self.[](*types)
-          Class.new(self).tap do |klass|
-            klass.types = types
-            # See https://github.com/solnic/virtus/issues/284#issuecomment-56405137
-            Axiom::Types::Object.new { primitive(klass) }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/avromatic/model/logical_types.rb

@@ -1,19 +0,0 @@
-require 'avromatic/model/attribute/timestamp_micros'
-require 'avromatic/model/attribute/timestamp_millis'
-
-module Avromatic
-  module Model
-    module LogicalTypes
-
-      LOGICAL_TYPE_MAP = {
-        'date' => Date,
-        'timestamp-micros' => Avromatic::Model::Attribute::TimestampMicros,
-        'timestamp-millis' => Avromatic::Model::Attribute::TimestampMillis
-      }.freeze
-
-      def self.value_class(logical_type)
-        LOGICAL_TYPE_MAP[logical_type]
-      end
-    end
-  end
-end

data/lib/avromatic/model/null_custom_type.rb

@@ -1,21 +0,0 @@
-module Avromatic
-  module Model
-
-    # This module is used to implement the null object pattern for a CustomType.
-    module NullCustomType
-      class << self
-        def value_class
-          nil
-        end
-
-        def deserializer
-          nil
-        end
-
-        def serializer
-          nil
-        end
-      end
-    end
-  end
-end

data/lib/avromatic/model/passthrough_serializer.rb

@@ -1,10 +0,0 @@
-module Avromatic
-  module Model
-    # This trivial serializer simply returns the value provided.
-    module PassthroughSerializer
-      def self.call(value)
-        value
-      end
-    end
-  end
-end