avro-builder 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 927dca1e52261de526556bb1a692ac90406d10bf
-  data.tar.gz: 89e990b81db93413c7f055c1ec95eb23a237b8f3
+  metadata.gz: 21b042e8f1af75aa7438eca4e949b32a50d691a1
+  data.tar.gz: eedcd4cb2b91b9336ad1688bb3c6bdbb3dec079e
 SHA512:
-  metadata.gz: c69e346811dfbd2574602bd6724b83dc2421a822123c5973b8b6def6b8b9aa552231af78c7778cf2feaac9054ea72145263f2ce41ce5b43eb7351f099dfb480e
-  data.tar.gz: aeb7b896dbe7146a7b4e8d0c4e7eb5533f48c7e15179ff3899ef74f733a91230ec4b9693268bad38792cca40739e7a68265abfcf91cae7c033ebda99d5d51f69
+  metadata.gz: f12ec9cd64725bae339a186f7db26f1c6b16a1c59cdc13d935bde7d62e9195bc2c976e7840e307432a3551ff59ea48d8566c990a882026c4f1970f8419bd250f
+  data.tar.gz: 48a859dbb4d78c94db00220ecedb119e564cac42f16031b258accbc4619844ff6d92c87d8d0f2f28232d67b310a750835074b62afece2fd940af59467991f849

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # avro-builder changelog
 
+## v0.12.0
+- Allow methods for complex and primitive types to be used at the top-level and
+  anywhere that a type name is accepted.
+
 ## v0.11.0
 - Add support for generating schemas that contain logical types. The official
   Ruby `avro` gem does not yet support logical types. The `avro-salsify-fork` gem

data/README.md

@@ -185,6 +185,16 @@ record :complex_types do
 end
 ```
 
+Methods may also be used for complex types instead of separately specifying the
+type name and options:
+
+```ruby
+record :complex_types do
+  required :array_of_unions, array(union(:int, :string))
+  required :array_or_map, union(array(:int), map(:int))
+end
+```
+
 For more on unions see [below](#unions).
 
 ### Nested Records
@@ -254,6 +264,16 @@ end
 For an optional union, `null` is automatically added as the first type for
 the union and the field defaults to `null`.
 
+Unions may also be defined using the `union` method instead of specifying the
+`:union` type and member types separately:
+
+```ruby
+record :my_record_with_unions do
+  required :req_union, union(:string, :int)
+  optional :opt_union, union(:float, :long)
+end
+```
+
 ### Logical Types
 
 The DSL supports setting a logical type on any type except a union. The logical

data/lib/avro/builder/dsl.rb

@@ -22,7 +22,7 @@ module Avro
       include Avro::Builder::DslOptions
       include Avro::Builder::DslAttributes
       include Avro::Builder::FileHandler
-      include Avro::Builder::TypeFactory
+      include Avro::Builder::AnonymousTypes
 
       dsl_attribute :namespace
 
@@ -83,6 +83,12 @@ module Avro
         Avro::Schema.parse(to_json(validate: false))
       end
 
+      # Override the type method from AnonymousTypes to store a reference to the
+      # last type defined.
+      def type(*)
+        @last_object = super
+      end
+
       private
 
       def cache

data/lib/avro/builder/field.rb

@@ -17,7 +17,7 @@ module Avro
       # These attributes may be set as options or via a block in the DSL
       dsl_attributes :doc, :default, :order
 
-      def initialize(name:, avro_type_name:, record:, cache:, internal: {}, options: {}, &block)
+      def initialize(name:, avro_type_or_name:, record:, cache:, internal: {}, options: {}, &block)
         @cache = cache
         @record = record
         @name = name.to_s
@@ -31,19 +31,16 @@ module Avro
           send(key, type_options.delete(key)) if dsl_attribute?(key)
         end
 
-        @field_type = if builtin_type?(avro_type_name)
-                        create_and_configure_builtin_type(avro_type_name,
-                                                          field: self,
-                                                          cache: cache,
-                                                          internal: internal,
-                                                          validate_type: false,
-                                                          options: type_options)
-                      elsif avro_type_name.is_a?(Avro::Builder::Types::Type)
-                        raise 'Type name must be an Avro builtin type '\
-                              "or a previously defined type name. Got #{avro_type_name}"
-                      else
-                        cache.lookup_named_type(avro_type_name, namespace)
-                      end
+        # Find existing Type or build a new instance of a builtin Type using
+        # the supplied block
+        @field_type = type_lookup(avro_type_or_name, namespace) do |avro_type_name|
+          create_and_configure_builtin_type(avro_type_name,
+                                            field: self,
+                                            cache: cache,
+                                            internal: internal,
+                                            validate_type: false,
+                                            options: type_options)
+        end
 
         # DSL calls must be evaluated after the type has been constructed
         instance_eval(&block) if block_given?

data/lib/avro/builder/type_factory.rb

@@ -10,6 +10,21 @@ module Avro
 
       private
 
+      # Determine if avro_type_or_name is an existing Type, the name of a builtin
+      # type or a previously defined named type.
+      # If avro_type_or_name is the name of a builtin type, then that type name
+      # is yielded to build the type using a block provided by the caller using,
+      # for example, create_builtin_type or create_and_configure_builtin_type.
+      def type_lookup(avro_type_or_name, namespace = nil)
+        if avro_type_or_name.is_a?(Avro::Builder::Types::Type)
+          avro_type_or_name
+        elsif builtin_type?(avro_type_or_name)
+          yield(avro_type_or_name)
+        else
+          cache.lookup_named_type(avro_type_or_name, namespace)
+        end
+      end
+
       # Return a new Type instance
       def create_builtin_type(avro_type_name, field:, cache:)
         name = avro_type_name.to_s.downcase

data/lib/avro/builder/types/array_type.rb

@@ -7,7 +7,7 @@ module Avro
 
         dsl_attribute :items do |items_type = nil|
           if items_type
-            @items = create_builtin_or_lookup_named_type(items_type)
+            @items = create_builtin_or_lookup_type(items_type)
           else
             @items
           end

data/lib/avro/builder/types/complex_type.rb

@@ -26,6 +26,10 @@ module Avro
           }.merge(overrides).reject { |_, v| v.nil? }
         end
 
+        def to_h(reference_state)
+          serialize(reference_state)
+        end
+
         module ClassMethods
 
           # Infer avro_type_name based on class

data/lib/avro/builder/types/map_type.rb

@@ -7,7 +7,7 @@ module Avro
 
         dsl_attribute :values do |value_type = nil|
           if value_type
-            @values = create_builtin_or_lookup_named_type(value_type)
+            @values = create_builtin_or_lookup_type(value_type)
           else
             @values
           end

data/lib/avro/builder/types/record_type.rb

@@ -26,9 +26,9 @@ module Avro
         end
 
         # Add a required field to the record
-        def required(name, avro_type_name, options = {}, &block)
+        def required(name, avro_type_or_name, options = {}, &block)
           new_field = Avro::Builder::Field.new(name: name,
-                                               avro_type_name: avro_type_name,
+                                               avro_type_or_name: avro_type_or_name,
                                                record: self,
                                                cache: cache,
                                                internal: { type_namespace: namespace },
@@ -39,9 +39,9 @@ module Avro
 
         # Add an optional field to the record. In Avro this is represented
         # as a union of null and the type specified here.
-        def optional(name, avro_type_name, options = {}, &block)
+        def optional(name, avro_type_or_name, options = {}, &block)
           new_field = Avro::Builder::Field.new(name: name,
-                                               avro_type_name: avro_type_name,
+                                               avro_type_or_name: avro_type_or_name,
                                                record: self,
                                                cache: cache,
                                                internal: { type_namespace: namespace,

data/lib/avro/builder/types/type.rb

@@ -26,6 +26,11 @@ module Avro
           end
         end
 
+        def to_h(_reference_state)
+          { type: avro_type_name, logicalType: logical_type }
+            .reject { |_, v| v.nil? }
+        end
+
         def namespace
           nil
         end

data/lib/avro/builder/types/type_referencer.rb

@@ -8,13 +8,13 @@ module Avro
       module TypeReferencer
         include Avro::Builder::TypeFactory
 
-        def create_builtin_or_lookup_named_type(avro_type_or_name)
-          if avro_type_or_name.is_a?(Avro::Builder::Types::Type)
-            avro_type_or_name
-          elsif builtin_type?(avro_type_or_name)
-            create_builtin_type(avro_type_or_name, field: field, cache: cache)
-          else
-            cache.lookup_named_type(avro_type_or_name)
+        private
+
+        def create_builtin_or_lookup_type(avro_type_or_name)
+          # Find existing Type or build a new instance of a builtin Type using
+          # the supplied block
+          type_lookup(avro_type_or_name) do |avro_type_name|
+            create_builtin_type(avro_type_name, field: field, cache: cache)
           end
         end
       end

data/lib/avro/builder/types/union_type.rb

@@ -9,7 +9,7 @@ module Avro
 
         dsl_attribute :types do |*types|
           if !types.empty?
-            @types = types.flatten.map { |type| create_builtin_or_lookup_named_type(type) }
+            @types = types.flatten.map { |type| create_builtin_or_lookup_type(type) }
           else
             @types
           end

data/lib/avro/builder/version.rb

@@ -1,5 +1,5 @@
 module Avro
   module Builder
-    VERSION = '0.11.0'.freeze
+    VERSION = '0.12.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro