avromatic 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c482b56c1e0e8d3f9271d7a7e61e763a9dffdd83
-  data.tar.gz: 0005f4ef6ff0abdc4a484b67873de53fab595244
+  metadata.gz: c9b90e592c9479ce33ee18c69e7015e9f6f1a555
+  data.tar.gz: 681a4f77f781c1c005425f949f385cd51bf666d3
 SHA512:
-  metadata.gz: 3ad6910fa3bda579cc807aec5b2e374d7821f7fb8c47b43de99b58c738b822b4f95d884594ec89a6f083baac97b018621d6ff70e9795caf8c050b96f3c4cc974
-  data.tar.gz: d11cb1499b84dc7b4dfea172f0391eeee61e4f161d35a5e8e44c8181c775693b86902e2b0825e31fe4829058fbef51299a65da1d262c1aacfd689d74cacc9b43
+  metadata.gz: c8b9458f552eba32b660d9e40a35ec5f7c0d528dc5a516b0ec4b18d671a299da550233afce32701cec063f1bfae16de0c4f8015aba80acc29e2269776d88b769
+  data.tar.gz: 7d8b0347c8db2c7a59c17b34fc9ba96f8956f037db7c108dbaded473ea2fe6f66e6fa503ebd989f55c174fe202679dd58cd139787168e4773276a75d2e4c9fca

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # avromatic changelog
 
+## v0.25.0
+- Disallow optional fields in schemas used for keys by default.
+
 ## v0.24.0
 - Add `Avromatic::IO::DatumWriter` to optimize the encoding of Avro unions
   from Avromatic models.

data/README.md

@@ -150,6 +150,21 @@ end
 When key and value schemas are both specified, attributes are added to the model
 for the union of the fields in the two schemas.
 
+By default, optional fields are not allowed in key schemas since their values may
+be accidentally omitted leading to problems if data is partitioned based on the
+key values.
+
+This behavior can be overridden by specifying the `:allow_optional_key_fields`
+option for the model:
+
+```ruby
+class MyTopic
+  include Avromatic::Model.build(value_schema_name: :topic_value,
+                                 key_schema_name: :topic_key,
+                                 allow_optional_key_fields: true)
+end
+```
+
 A model can also be generated as an anonymous class that can be assigned to a
 constant:
 

data/lib/avromatic/model/attributes.rb

@@ -9,6 +9,15 @@ module Avromatic
     module Attributes
       extend ActiveSupport::Concern
 
+      class OptionalFieldError < StandardError
+        attr_reader :field
+
+        def initialize(field)
+          @field = field
+          super("Optional field not allowed: #{field}")
+        end
+      end
+
       def self.first_union_schema(field_type)
         # TODO: This is a hack until I find a better solution for unions with
         # Virtus. This only handles a union for an optional field with :null
@@ -27,7 +36,12 @@ module Avromatic
 
           if key_avro_schema
             check_for_field_conflicts!
-            define_avro_attributes(key_avro_schema)
+            begin
+              define_avro_attributes(key_avro_schema,
+                                     allow_optional: config.allow_optional_key_fields)
+            rescue OptionalFieldError => ex
+              raise "Optional field '#{ex.field.name}' not allowed in key schema."
+            end
           end
           define_avro_attributes(avro_schema)
         end
@@ -55,12 +69,14 @@ module Avromatic
             value_avro_fields_by_name[name].to_avro
         end
 
-        def define_avro_attributes(schema)
+        def define_avro_attributes(schema, allow_optional: true)
           if schema.type_sym != :record
             raise "Unsupported schema type '#{schema.type_sym}', only 'record' schemas are supported."
           end
 
           schema.fields.each do |field|
+            raise OptionalFieldError.new(field) if !allow_optional && optional?(field)
+
             field_class = avro_field_class(field.type)
 
             attribute(field.name,

data/lib/avromatic/model/configuration.rb

@@ -4,7 +4,8 @@ module Avromatic
     # This class holds configuration for a model built from Avro schema(s).
     class Configuration
 
-      attr_reader :avro_schema, :key_avro_schema, :nested_models, :mutable
+      attr_reader :avro_schema, :key_avro_schema, :nested_models, :mutable,
+                  :allow_optional_key_fields
       delegate :schema_store, to: Avromatic
 
       # Either schema(_name) or value_schema(_name), but not both, must be
@@ -19,12 +20,14 @@ module Avromatic
       # @option options [String, Symbol] :key_schema_name
       # @option options [Avromatic::ModelRegistry] :nested_models
       # @option options [Boolean] :mutable, default false
+      # @option options [Boolean] :allow_optional_key_fields, default false
       def initialize(**options)
         @avro_schema = find_avro_schema(**options)
         raise ArgumentError.new('value_schema(_name) or schema(_name) must be specified') unless avro_schema
         @key_avro_schema = find_schema_by_option(:key_schema, **options)
         @nested_models = options[:nested_models]
         @mutable = options.fetch(:mutable, false)
+        @allow_optional_key_fields = options.fetch(:allow_optional_key_fields, false)
       end
 
       alias_method :value_avro_schema, :avro_schema

data/lib/avromatic/version.rb

@@ -1,3 +1,3 @@
 module Avromatic
-  VERSION = '0.24.0'.freeze
+  VERSION = '0.25.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro