avro-builder 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12f5d129e7cec1851302f1f7e12213dfef883b95
-  data.tar.gz: 215c3ed97b5a9cf92f10358a79b0e4f857839f38
+  metadata.gz: a2caec0734e6bf6ba5d83e453fe9d067f9f47fa6
+  data.tar.gz: 79fca4e7bf6c5bc9ad9bbcb2425afb902e1b9026
 SHA512:
-  metadata.gz: 049df2685c267dae090617f14208ac986b32040b4dd514a8f5eb86ecfe9e749d685ae9a84c561d23e4421bde15cf6615da0473589fe78bb98d26290eedd51fa6
-  data.tar.gz: b918ca818611bf1762d980a8a7eae900788b83f280d38d6a98bd7090fb5ae4b6585d4bc51a045c16b74820ba7ee4822e15f4f07e0c36dc0e7b5269d9f3aa2332
+  metadata.gz: 73e3846ea11202adb26505a47bc3ec7a7772f10f1ff7560593788926922a9c9b45ece9c49bc2fecb0df48627923b44dcc23603cad25020d7c45314f64fcd191f
+  data.tar.gz: ae4ffe269bbd87c8fdc6f548898eb3fbf3749781604744f8f79deb38133670a5cdc4a5f2dec0347ff94fb568c0e2e2ae5a1411b4d69efecd32db0f4ceff8bd57

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # avro-builder changelog
 
+## v0.4.0
+- Add validation for required DSL attributes that are not specified.
+- Allow name to be configured via a block for top-level record, enum, and fixed
+  types.
+
 ## v0.3.2
 - Fix a bug that allowed the partial matching of filenames.
 - Fix a bug that prevented namespace from being specified as an option on

data/README.md

@@ -24,7 +24,7 @@ This DSL was created because:
 * Only Avro Schemas, not Protocols are supported.
 * See [Issues](https://github.com/salsify/avro-builder/issues) for functionality
   that has yet to be implemented.
-* This is alpha quality code. There may be breaking changes until version 1.0 is
+* This is beta quality code. There may be breaking changes until version 1.0 is
   released.
 
 ## Installation
@@ -60,6 +60,8 @@ record :user do
   required :type, :user_type, default: :REGULAR
   required :pw, :password
   optional :full_name, :string
+  required :nicknames, :array, items: :string
+  required :permissions, :map, values: :bytes
 end
 ```
 
@@ -110,6 +112,20 @@ This generates the following Avro JSON schema:
         "string"
       ],
       "default": null
+    },
+    {
+      "name": "nicknames",
+      "type": {
+        "type": "array",
+        "items": "string"
+      }
+    },
+    {
+      "name": "permissions",
+      "type": {
+        "type": "map",
+        "values": "bytes"
+      }
     }
   ]
 }
@@ -243,4 +259,3 @@ Issues and pull requests are welcome on GitHub at https://github.com/salsify/avr
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/avro/builder/dsl.rb

@@ -1,4 +1,5 @@
 require 'avro'
+require 'avro/builder/errors'
 require 'avro/builder/dsl_attributes'
 require 'avro/builder/namespaceable'
 require 'avro/builder/type_factory'
@@ -25,8 +26,8 @@ module Avro
       end
 
       # Define an Avro schema record
-      def record(name, options = {}, &block)
-        add_schema_object(build_record(name, options, &block))
+      def record(name = nil, options = {}, &block)
+        create_named_type(name, :record, options, &block)
       end
 
       # Imports from the file with specified name fragment.
@@ -38,11 +39,11 @@ module Avro
 
       ## DSL methods for Types
 
-      def enum(name, *symbols, **options, &block)
+      def enum(name = nil, *symbols, **options, &block)
         create_named_type(name, :enum, { symbols: symbols }.merge(options), &block)
       end
 
-      def fixed(name, size = nil, options = {}, &block)
+      def fixed(name = nil, size = nil, options = {}, &block)
         size_option = size.is_a?(Hash) ? size : { size: size }
         create_named_type(name, :fixed, size_option.merge(options), &block)
       end
@@ -104,18 +105,11 @@ module Avro
                                           internal: { name: name, namespace: namespace },
                                           options: options,
                                           &block).tap do |type|
+          type.validate!
           add_schema_object(type)
         end
       end
 
-      def build_record(name, options, &block)
-        Avro::Builder::Types::RecordType
-          .new(name, { namespace: namespace }.merge(options)).tap do |record|
-            record.builder = builder
-            record.instance_eval(&block)
-          end
-      end
-
       def eval_file(name)
         instance_eval(read_file(name))
       end

data/lib/avro/builder/errors.rb

@@ -0,0 +1,15 @@
+module Avro
+  module Builder
+
+    class RequiredAttributeError < StandardError
+      def initialize(type:, attribute:, field: nil, name: nil)
+        location = if field
+                     "field '#{field}' of "
+                   elsif name
+                     "'#{name}' of "
+                   end
+        super("attribute :#{attribute} missing for #{location}type :#{type}")
+      end
+    end
+  end
+end

data/lib/avro/builder/field.rb

@@ -41,6 +41,7 @@ module Avro
 
         # DSL calls must be evaluated after the type has been constructed
         instance_eval(&block) if block_given?
+        @type.validate!
       end
 
       ## Delegate additional DSL calls to the type

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

@@ -14,6 +14,10 @@ module Avro
           end
         end
 
+        def validate!
+          validate_required_attribute!(:items)
+        end
+
         def serialize(referenced_state)
           {
             type: type_name,

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

@@ -22,6 +22,11 @@ module Avro
           super(reference_state, overrides: serialized_attributes)
         end
 
+        def validate!
+          super
+          validate_required_attribute!(:symbols)
+        end
+
         private
 
         def serialized_attributes

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

@@ -13,6 +13,11 @@ module Avro
           super(reference_state, overrides: serialized_attributes)
         end
 
+        def validate!
+          super
+          validate_required_attribute!(:size)
+        end
+
         private
 
         def serialized_attributes

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

@@ -20,6 +20,10 @@ module Avro
             values: values.serialize(referenced_state)
           }
         end
+
+        def validate!
+          validate_required_attribute!(:values)
+        end
       end
     end
   end

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

@@ -22,6 +22,10 @@ module Avro
           end
         end
 
+        def validate!
+          required_attribute_error!(:name) if field.nil? && @name.nil?
+        end
+
         # Named types that do not have an explicit name are assigned
         # a named based on the field and its nesting.
         def name_fragment

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

@@ -30,6 +30,27 @@ module Avro
         def self.union_with_null(serialized)
           [:null, serialized]
         end
+
+        # Subclasses should override this method to check for the presence
+        # of required DSL attributes.
+        def validate!
+        end
+
+        private
+
+        def required_attribute_error!(attribute_name)
+          raise RequiredAttributeError.new(type: type_name,
+                                           attribute: attribute_name,
+                                           field: field && field.name,
+                                           name: @name)
+        end
+
+        def validate_required_attribute!(attribute_name)
+          value = public_send(attribute_name)
+          if value.nil? || value.respond_to?(:empty?) && value.empty?
+            required_attribute_error!(attribute_name)
+          end
+        end
       end
     end
   end

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

@@ -26,6 +26,10 @@ module Avro
         def self.union_with_null(serialized)
           serialized.reject { |type| type.to_s == NULL_TYPE }.unshift(:null)
         end
+
+        def validate!
+          validate_required_attribute!(:types)
+        end
       end
     end
   end

data/lib/avro/builder/version.rb

@@ -1,5 +1,5 @@
 module Avro
   module Builder
-    VERSION = "0.3.2"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -114,6 +115,7 @@ files:
 - lib/avro/builder.rb
 - lib/avro/builder/dsl.rb
 - lib/avro/builder/dsl_attributes.rb
+- lib/avro/builder/errors.rb
 - lib/avro/builder/field.rb
 - lib/avro/builder/file_handler.rb
 - lib/avro/builder/namespaceable.rb