avro-builder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc0e206e5b0cfe57f356bcc17de31819fc2db7ea
-  data.tar.gz: c7ebe9cd48e6ea8a55762d71d1349405e78d022a
+  metadata.gz: a72124e0979079150b62e4ca3f8f6c727b7bb39c
+  data.tar.gz: 158fc532ae1587737c415069bdcbf3ae136deeaa
 SHA512:
-  metadata.gz: b02e6bf7877bb667d2602c871aceda94b5943adbbe356ca80b7479044dab2dbdaa05d130d9f4732dee2314aa87484159195a845c1af354db0855105259fe2e06
-  data.tar.gz: b22b39dae5253d9b021fe4deabd8b50ef3757dff483cf0a10ef28612045c32f8ed149db761b68427eb191c8df7751bdabf5e8e98dce88e0b2ccac5180ad9d2a4
+  metadata.gz: 7f40595449fa8ce0db3ef04d35d96bd3dd133484a383ff1873bdb3c5f1061124c5398b17d31f881e479df603f940c7b3068e9112dbf2156b1a8659e537669b09
+  data.tar.gz: 7d363c07489a17ca4142c34e8a7928f5f737fac535553326d6a2c63007d1c3d0f3b6c6034f1879c9eded1281a2d08d5a51cbac3ef0a7057978edf847ba8ef340

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.2.4
+  - 2.3.0
 before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 # avro-builder changelog
 
+## v0.2.0
+- Add support for `:union` type.
+- Make `fixed` syntax more flexible. Both `fixed :f, 7` and `fixed :f, size: 7`
+  are now supported and equivalent.
+
 ## v0.1.0
 - Initial release

data/README.md

@@ -1,5 +1,9 @@
 # Avro::Builder
 
+[![Build Status](https://travis-ci.org/salsify/avro-builder.svg?branch=master)][travis]
+
+[travis]: http://travis-ci.org/salsify/avro-builder
+
 `Avro::Builder` provides a Ruby DSL to create [Apache Avro](https://avro.apache.org/docs/current/) Schemas.
 
 This DSL was created because:
@@ -112,7 +116,7 @@ This generates the following Avro JSON schema:
 
 ### Required and Optional
 
-Fields for a record a specified as `required` or `optional`. Optional fields are
+Fields for a record are specified as `required` or `optional`. Optional fields are
 implemented as a union in Avro, where `null` is the first type in the union.
 
 ### Named Types
@@ -120,6 +124,38 @@ implemented as a union in Avro, where `null` is the first type in the union.
 `fixed` and `enum` fields may be specified inline as part of a record
 or as standalone named types.
 
+```ruby
+# Either syntax is supported for specifying the size
+fixed :f, 4
+fixed :g, size: 8
+
+# Either syntax is supported for specifying symbols
+enum :e, :X, :Y, :Z
+enum :d, symbols: [:A, :B]
+
+record :my_record_with_named do
+  required :f_ref, :f
+  required :fixed_inline, :fixed, size: 9
+  required :e_ref, :e
+  required :enum_inline, :enum, symbols: [:P, :Q]
+end
+```
+
+### Unions
+
+A union may be specified within a record using `required` and `optional` with
+the `:union` type:
+
+```ruby
+record :my_record_with_unions do
+  required :req_union, :union, types: [:string, :int]
+  optional :opt_union, :union, types: [:float, :long]
+end
+```
+
+For an optional union, `null` is automatically added as the first type for
+the union.
+
 ### Auto-loading and Imports
 
 Specify paths to search for definitions:

data/lib/avro/builder/dsl.rb

@@ -44,7 +44,8 @@ module Avro
       end
 
       def fixed(name, size = nil, options = {}, &block)
-        type(name, :fixed, { size: size }.merge(options), &block)
+        size_option = size.is_a?(Hash) ? size : { size: size }
+        type(name, :fixed, size_option.merge(options), &block)
       end
 
       def type(name, type_name, options = {}, &block)

data/lib/avro/builder/field.rb

@@ -68,10 +68,10 @@ module Avro
 
       private
 
-      # Optional types must be serialized as an array.
+      # Optional types must be serialized as a union -- an array of types.
       def serialized_type(reference_state)
         result = type.serialize(reference_state)
-        optional ? [:null, result] : result
+        optional ? type.class.union_with_null(result) : result
       end
     end
   end

data/lib/avro/builder/types.rb

@@ -1,7 +1,10 @@
 require 'avro/builder/types/type'
 require 'avro/builder/types/specific_type'
+require 'avro/builder/types/configurable_type'
+require 'avro/builder/types/type_referencer'
 require 'avro/builder/types/named_type'
 require 'avro/builder/types/enum_type'
 require 'avro/builder/types/fixed_type'
 require 'avro/builder/types/array_type'
 require 'avro/builder/types/map_type'
+require 'avro/builder/types/union_type'

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

@@ -1,6 +1,3 @@
-require 'avro/builder/types/configurable_type'
-require 'avro/builder/types/type_referencer'
-
 module Avro
   module Builder
     module Types

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

@@ -1,6 +1,3 @@
-require 'avro/builder/types/configurable_type'
-require 'avro/builder/types/type_referencer'
-
 module Avro
   module Builder
     module Types

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

@@ -25,6 +25,11 @@ module Avro
         def configure_options(_options = {})
           # No-op
         end
+
+        # Optional fields are represented as a union of the type with :null.
+        def self.union_with_null(serialized)
+          [:null, serialized]
+        end
       end
     end
   end

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

@@ -0,0 +1,30 @@
+module Avro
+  module Builder
+    module Types
+      class UnionType < Type
+        include Avro::Builder::Types::SpecificType
+        include Avro::Builder::Types::ConfigurableType
+        include Avro::Builder::Types::TypeReferencer
+
+        dsl_attribute :types do |*types|
+          if !types.empty?
+            @types = types.flatten.map { |type| find_or_create_type(type) }
+          else
+            @types
+          end
+        end
+
+        # Unions are serialized as an array of types
+        def serialize(referenced_state)
+          types.map { |type| type.serialize(referenced_state) }
+        end
+
+        # serialized will be an array of types. If the array includes
+        # :null then it is moved to the beginning of the array.
+        def self.union_with_null(serialized)
+          serialized.reject { |type| type == :null }.unshift(:null)
+        end
+      end
+    end
+  end
+end

data/lib/avro/builder/version.rb

@@ -1,5 +1,5 @@
 module Avro
   module Builder
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -130,6 +130,7 @@ files:
 - lib/avro/builder/types/specific_type.rb
 - lib/avro/builder/types/type.rb
 - lib/avro/builder/types/type_referencer.rb
+- lib/avro/builder/types/union_type.rb
 - lib/avro/builder/version.rb
 homepage: https://github.com/salsify/avro-builder.git
 licenses: