avro-builder 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21b042e8f1af75aa7438eca4e949b32a50d691a1
-  data.tar.gz: eedcd4cb2b91b9336ad1688bb3c6bdbb3dec079e
+  metadata.gz: 8672dba84b4ee61d299c99f3fe0ced401b3817b4
+  data.tar.gz: dcdcf44d8c0f11c3b2d9b828738047a037df0caa
 SHA512:
-  metadata.gz: f12ec9cd64725bae339a186f7db26f1c6b16a1c59cdc13d935bde7d62e9195bc2c976e7840e307432a3551ff59ea48d8566c990a882026c4f1970f8419bd250f
-  data.tar.gz: 48a859dbb4d78c94db00220ecedb119e564cac42f16031b258accbc4619844ff6d92c87d8d0f2f28232d67b310a750835074b62afece2fd940af59467991f849
+  metadata.gz: e3f8f47f84aa98101454de16745b084e07f3342f0c97f69597cf378ef0906b1deeafe730a96562e478daac34b0f78f1ad47565eded84c2bc3dafaa72c6223408
+  data.tar.gz: 3116b64339e0afb980ced2790f2e71e626983fc976a1b519edf5656e4dabb09b2175dc9545bdba7942df2223920d78813cb10cb5688bc7f7880f6c5a51498adc

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # avro-builder changelog
 
+## v0.13.0
+- Add support for type macros.
+
 ## 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.

data/README.md

@@ -316,6 +316,29 @@ record :with_date_array
 end
 ```
 
+### Type Macros
+
+`avro-builder` allows type macros to be defined that expand to types that
+cannot normally be named in Avro schemas. These macro names are not retained
+in generated schemas but allow definitions to be reused across DSL files:
+
+```ruby
+type_macro :timestamp, long(logical_type: 'timestamp-millis')
+
+record :user do
+  required :created_at, :timestamp
+  required :updated_at, :timestamp
+end
+```
+
+Type macros inherit the namespace from the context where they are defined or
+an explicit namespace option may be specified:
+
+```ruby
+type_macro :timestamp, long(logical_type: 'timestamp-millis'),
+           namespace: 'com.my_company'
+```
+
 ### Auto-loading and Imports
 
 Specify paths to search for definitions:

data/lib/avro/builder/definition_cache.rb

@@ -32,26 +32,34 @@ module Avro
         object || lookup_named_type(key, nil)
       end
 
+      # Add a type object directly with the specified name.
+      # The type_object may not have a name or namespace.
+      def add_type_by_name(type_object, name, namespace = nil)
+        fullname = Avro::Name.make_fullname(name.to_s, namespace && namespace.to_s)
+        name = fullname.split('.').last
+
+        store_by_name(type_object, name)
+        store_by_fullname(type_object, fullname) if name != fullname
+      end
+
       private
 
       # Schemas are stored by name, provided that the name is unique.
       # If the unqualified name is ambiguous then it is removed from the cache.
       # A set of unqualified names is kept to avoid reloading files for
       # ambiguous references.
-      def store_by_name(object)
-        key = object.name.to_s
-        if schema_objects.key?(key)
-          schema_objects.delete(key)
-        elsif !schema_names.include?(key)
-          schema_objects.store(key, object)
+      def store_by_name(object, name = object.name.to_s)
+        if schema_objects.key?(name)
+          schema_objects.delete(name)
+        elsif !schema_names.include?(name)
+          schema_objects.store(name, object)
         end
-        schema_names.add(key)
+        schema_names.add(name)
       end
 
-      def store_by_fullname(object)
-        key = object.fullname
-        raise DuplicateDefinitionError.new(key, object, schema_objects[key]) if schema_objects.key?(key)
-        schema_objects.store(key, object)
+      def store_by_fullname(object, fullname = object.fullname)
+        raise DuplicateDefinitionError.new(fullname, object, schema_objects[fullname]) if schema_objects.key?(fullname)
+        schema_objects.store(fullname, object)
       end
 
       attr_reader :schema_objects, :schema_names, :builder

data/lib/avro/builder/dsl.rb

@@ -89,6 +89,12 @@ module Avro
         @last_object = super
       end
 
+      def type_macro(name, type_object, options = {})
+        raise "#{type_object.inspect} must be a type object" unless type_object.is_a?(Types::Type)
+        raise "namespace cannot be included in name: #{name}" if name.to_s.index('.')
+        cache.add_type_by_name(type_object, name, options[:namespace] || namespace)
+      end
+
       private
 
       def cache

data/lib/avro/builder/version.rb

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

metadata

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