avro-builder 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a6a7c469ac63da10199ce29df3e1b6d82e6904a
-  data.tar.gz: aa7a5d4506499cc9a75ce963e54254d6ded16b49
+  metadata.gz: 5420ca208ea3fd4e3656158ed44ef8270eb0d22a
+  data.tar.gz: 74375f766022da155afa1421c0cd6068aa24e812
 SHA512:
-  metadata.gz: 2803b8ebb4bedb1256041eaf4533c2c1309e416fb7152ef3f55e76191e32b1af17608895d42e729b026a1ca0edada181aa779993b4ddfd485dcd594d824c057f
-  data.tar.gz: bba50fb4e40081ab522201c764f90c583e351b3be14b2ec237c850565bc84fad1e12ab42b8f8fc32289286e380f1cd41c2c600a10e5afe3bb316a43726304f67
+  metadata.gz: 4a3f0b4e0f8a9107d56d60e85586295b9ca18ae0c0197a646ee917d6ee9f6617148ab47b02cc3ef017e6298dd611bc1cf8e8ff2d08432ead66f1585d0350f7e4
+  data.tar.gz: 6de4bceaee6e27726d62100cece189dc9ef574c2790b23c495a4cc74d6f9852f03805e819edb0d28c63f67ad1d3d0cce7899edc619290b2905aac03cd37b294f

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # avro-builder changelog
 
+## v0.6.0
+- Support recursive definitions.
+- Coerce aliases to be represented as an array.
+- Only allow name and namespace to be set via options, not via a block, for
+  record, enum, and fixed types.
+- Allow `doc` and `aliases` to be set on both a field and a type defined inline
+  for the field. To set these attributes on the inline type `type_doc` and 
+  `type_aliases` must be used in the DSL.
+
 ## v0.5.0
 - Support references to named types that are defined inline.
 - Raise an error for duplicate definitions with the same fullname.

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/avro-builder.gemspec

@@ -4,26 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'avro/builder/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "avro-builder"
+  spec.name          = 'avro-builder'
   spec.version       = Avro::Builder::VERSION
-  spec.authors       = ["Salsify Engineering"]
-  spec.email         = ["engineering@salsify.com"]
+  spec.authors       = ['Salsify Engineering']
+  spec.email         = ['engineering@salsify.com']
 
-  spec.summary       = %q{Ruby DSL to create Avro schemas}
+  spec.summary       = 'Ruby DSL to create Avro schemas'
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/salsify/avro-builder.git"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/salsify/avro-builder.git'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "avro", ">= 1.7.0"
+  spec.add_runtime_dependency 'avro', '>= 1.7.0'
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "json_spec"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'json_spec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.40.0'
+  spec.add_development_dependency 'overcommit'
 end

data/bin/setup

@@ -4,5 +4,4 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here
+overcommit --install

data/lib/avro/builder/aliasable.rb

@@ -0,0 +1,20 @@
+require 'avro/builder/dsl_attributes'
+
+module Avro
+  module Builder
+
+    # This is a shared concern for objects that support aliases via the DSL.
+    module Aliasable
+      def self.included(base)
+        base.dsl_attribute(:aliases) do |*names|
+          if !names.empty?
+            @aliases = names.flatten
+          else
+            @aliases
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/avro/builder/dsl.rb

@@ -1,5 +1,6 @@
 require 'avro'
 require 'avro/builder/errors'
+require 'avro/builder/dsl_options'
 require 'avro/builder/dsl_attributes'
 require 'avro/builder/namespaceable'
 require 'avro/builder/definition_cache'
@@ -14,6 +15,7 @@ module Avro
     # This class is used to construct Avro schemas (not protocols) using a ruby
     # DSL
     class DSL
+      include Avro::Builder::DslOptions
       include Avro::Builder::DslAttributes
       include Avro::Builder::FileHandler
       include Avro::Builder::TypeFactory
@@ -84,7 +86,7 @@ module Avro
                                           options: options,
                                           &block).tap do |type|
           type.validate!
-          @last_object = cache.add_schema_object(type)
+          @last_object = type
         end
       end
 

data/lib/avro/builder/dsl_attributes.rb

@@ -2,14 +2,14 @@ module Avro
   module Builder
 
     # This module provides methods for defining attributes that can be
-    # set  via the DSL on various objects.
+    # set via the DSL on various objects.
     #
     # The methods generated for DSL attributes are combined getter/setters
     # of the form:
     #
     #   attribute(value = nil)
     #
-    # When value is provided the attribute is set, and when it is nil the
+    # When a value is provided the attribute is set, and when it is nil the
     # current value is returned.
     #
     # When a DSL attribute is defined, the class also keeps track of the
@@ -19,32 +19,38 @@ module Avro
         base.extend ClassMethods
       end
 
-      def has_dsl_attribute?(name)
+      def dsl_attribute?(name)
         self.class.dsl_attribute_names.include?(name.to_sym)
       end
 
       module ClassMethods
-        def dsl_attributes(*names)
-          names.each do |name|
-            dsl_attribute_names << name
-            ivar = :"@#{name}"
-            define_method(name) do |value = nil|
-              value ? instance_variable_set(ivar, value) : instance_variable_get(ivar)
-            end
-          end
-        end
-
         # If a block is specified then it is used to define the
         # combined getter/setter method for the DSL attribute.
         def dsl_attribute(name, &block)
           if block_given?
-            dsl_attribute_names << name
+            add_attribute_name(name)
             define_method(name, &block)
+            alias_writer(name)
           else
             dsl_attributes(name)
           end
         end
 
+        def dsl_attributes(*names)
+          raise 'a block can only be specified with dsl_attribute' if block_given?
+
+          names.each do |name|
+            add_attribute_name(name)
+            define_accessor(name)
+          end
+        end
+
+        def dsl_attribute_alias(new_name, old_name)
+          alias_method(new_name, old_name)
+          alias_writer(new_name)
+          add_attribute_name(new_name)
+        end
+
         def dsl_attribute_names
           @dsl_attribute_names ||=
             if superclass.respond_to?(:dsl_attribute_names)
@@ -53,6 +59,28 @@ module Avro
               Set.new
             end
         end
+
+        private
+
+        def add_attribute_name(name)
+          dsl_attribute_names << name
+          add_option_name(name)
+        end
+
+        def define_accessor(name)
+          ivar = :"@#{name}"
+          define_method(name) do |value = nil|
+            value.nil? ? instance_variable_get(ivar) : instance_variable_set(ivar, value)
+          end
+          alias_writer(name)
+        end
+
+        # The writer (name=) method is used to set attributes via options.
+        def alias_writer(name)
+          writer = "#{name}="
+          alias_method(writer, name)
+          private(writer)
+        end
       end
     end
   end

data/lib/avro/builder/dsl_options.rb

@@ -0,0 +1,72 @@
+module Avro
+  module Builder
+
+    # This module provides methods for defining options that can be
+    # set via the DSL on various objects.
+    #
+    # These attributes can only be set as options via the private
+    # #attribute= methods, and not as methods in DSL block.
+    #
+    # When a DSL option is defined, the class also keeps track of the
+    # option names.
+    module DslOptions
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      def dsl_option?(name)
+        self.class.dsl_option_names.include?(name.to_sym)
+      end
+
+      module ClassMethods
+        # A DSL option is only settable as an option, not as method in a block.
+        def dsl_option(name, &block)
+          add_option_name(name)
+          define_private_writer(name)
+          define_reader(name, &block)
+        end
+
+        def dsl_option_names
+          @dsl_option_names ||=
+            if superclass.respond_to?(:dsl_option_names)
+              superclass.dsl_option_names.dup
+            else
+              Set.new
+            end
+        end
+
+        private
+
+        def add_option_name(name)
+          dsl_option_names << name
+        end
+
+        def define_private_writer(name)
+          attr_writer(name)
+          private("#{name}=")
+        end
+
+        # Define a accessor method that raises an error if called as a writer.
+        # If the optional block is specified then it is evaluated as the reader.
+        def define_reader(name, &block)
+          if block_given?
+            define_method(name) do |value = nil|
+              value ? unsupported_block_attribute(name, type_name) : instance_eval(&block)
+            end
+          else
+            define_method(name) do |value = nil|
+              value ? unsupported_block_attribute(name, type_name) : instance_variable_get("@#{name}")
+            end
+          end
+        end
+      end
+
+      private
+
+      def unsupported_block_attribute(attribute, type)
+        raise UnsupportedBlockAttributeError.new(attribute: attribute,
+                                                 type: type)
+      end
+    end
+  end
+end

data/lib/avro/builder/errors.rb

@@ -28,15 +28,25 @@ module Avro
 
     class DefinitionNotFoundError < StandardError
       def initialize(name)
-        super("definition not found for '#{name.to_s}'.#{suggest_namespace(name)}")
+        super("definition not found for '#{name}'.#{suggest_namespace(name)}")
       end
 
       private
 
       def suggest_namespace(name)
-        unless name.to_s.index('.')
-          ' Try specifying the full namespace.'
-        end
+        ' Try specifying the full namespace.' unless name.to_s.index('.')
+      end
+    end
+
+    class UnsupportedBlockAttributeError < StandardError
+      def initialize(attribute:, type:, field: nil)
+        target = if field
+                   "field '#{field}' of type :#{type}"
+                 else
+                   "type :#{type}"
+                 end
+        super("'#{attribute}' must be set directly using an option on #{target}, "\
+              'not via a block')
       end
     end
   end

data/lib/avro/builder/field.rb

@@ -1,4 +1,5 @@
 require 'avro/builder/type_factory'
+require 'avro/builder/aliasable'
 
 module Avro
   module Builder
@@ -6,13 +7,17 @@ module Avro
     # This class represents a field in a record.
     # A field must be initialized with a type.
     class Field
+      include Avro::Builder::DslOptions
       include Avro::Builder::DslAttributes
       include Avro::Builder::TypeFactory
+      include Avro::Builder::Aliasable
 
-      INTERNAL_ATTRIBUTES = Set.new(%i(optional_field)).freeze
+      INTERNAL_ATTRIBUTES = %i(optional_field).to_set.freeze
 
       # These attributes may be set as options or via a block in the DSL
-      dsl_attributes :doc, :aliases, :default, :order
+      dsl_attributes :doc, :default, :order
+
+      attr_reader :name
 
       def initialize(name:, type_name:, record:, cache:, internal: {}, options: {}, &block)
         @cache = cache
@@ -23,8 +28,9 @@ module Avro
           send("#{key}=", value) if INTERNAL_ATTRIBUTES.include?(key)
         end
 
-        options.each do |key, value|
-          send(key, value) if has_dsl_attribute?(key)
+        type_options = options.dup
+        options.keys.each do |key|
+          send(key, type_options.delete(key)) if dsl_attribute?(key)
         end
 
         @type = if builtin_type?(type_name)
@@ -32,26 +38,24 @@ module Avro
                                                     field: self,
                                                     cache: cache,
                                                     internal: internal,
-                                                    options: options)
+                                                    options: type_options)
                 else
-                  named_type = true
                   cache.lookup_named_type(type_name, namespace)
                 end
 
         # DSL calls must be evaluated after the type has been constructed
         instance_eval(&block) if block_given?
         @type.validate!
-        @type.cache! unless named_type
       end
 
       ## Delegate additional DSL calls to the type
 
-      def respond_to_missing?(id, include_all = false)
-        super || type.respond_to?(id, include_all)
+      def respond_to_missing?(id, _include_all)
+        type.dsl_respond_to?(id) || super
       end
 
       def method_missing(id, *args, &block)
-        type.respond_to?(id) ? type.send(id, *args, &block) : super
+        type.dsl_respond_to?(id) ? type.send(id, *args, &block) : super
       end
 
       def name_fragment
@@ -62,7 +66,9 @@ module Avro
       # and return the namespace value from the enclosing record.
       def namespace(value = nil)
         if value
-          type.namespace(value)
+          raise UnsupportedBlockAttributeError.new(attribute: :namespace,
+                                                   field: @name,
+                                                   type: type.type_name)
         else
           record.namespace
         end
@@ -71,7 +77,9 @@ module Avro
       # Delegate setting name explicitly via DSL to type
       def name(value = nil)
         if value
-          type.name(value)
+          raise UnsupportedBlockAttributeError.new(attribute: :name,
+                                                   field: @name,
+                                                   type: type.type_name)
         else
           # Return the name of the field
           @name
@@ -79,6 +87,7 @@ module Avro
       end
 
       def serialize(reference_state)
+        # TODO: order is not included here
         {
           name: name,
           type: serialized_type(reference_state),

data/lib/avro/builder/file_handler.rb

@@ -26,7 +26,7 @@ module Avro
         # and ends with a .rb extension. Additionally, if the name contains
         # a namespace then ensure that periods (.) are replaced by forward
         # slashes. E.g. for 'test.example' search for '/test/example.rb'.
-        file_name = "/#{name.to_s.gsub('.', '/').sub(/^\//, '').sub(/\.rb$/, '')}.rb"
+        file_name = "/#{name.to_s.tr('.', '/').sub(/^\//, '').sub(/\.rb$/, '')}.rb"
         matches = self.class.load_paths.flat_map do |load_path|
           Dir["#{load_path}/**/*.rb"].select do |file_path|
             file_path.end_with?(file_name)

data/lib/avro/builder/type_factory.rb

@@ -12,10 +12,9 @@ module Avro
       # Return a new Type instance
       def create_builtin_type(type_name, field:, cache:)
         name = type_name.to_s.downcase
-        case
-        when Avro::Schema::PRIMITIVE_TYPES.include?(name)
+        if Avro::Schema::PRIMITIVE_TYPES.include?(name)
           Avro::Builder::Types::Type.new(name, field: field, cache: cache)
-        when COMPLEX_TYPES.include?(name)
+        elsif COMPLEX_TYPES.include?(name)
           Avro::Builder::Types.const_get("#{name.capitalize}Type").new(field: field, cache: cache)
         else
           raise "Invalid builtin type: #{type_name}"
@@ -32,6 +31,7 @@ module Avro
                                             &block)
         create_builtin_type(type_name, field: field, cache: cache).tap do |type|
           type.configure_options(internal.merge(options))
+          type.cache!
           type.instance_eval(&block) if block_given?
         end
       end

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

@@ -2,12 +2,12 @@ module Avro
   module Builder
     module Types
 
-      # This concern is used by Types that can be configured using DSL
-      # attributes.
+      # This concern is used by Types that can be configured via the DSL.
+      # Only attributes that can be set via options are configured here.
       module ConfigurableType
         def configure_options(options = {})
           options.each do |key, value|
-            send(key, value) if has_dsl_attribute?(key)
+            send("#{key}=", value) if dsl_option?(key)
           end
         end
       end

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

@@ -1,5 +1,6 @@
 require 'avro/builder/types/configurable_type'
 require 'avro/builder/namespaceable'
+require 'avro/builder/aliasable'
 
 module Avro
   module Builder
@@ -11,17 +12,15 @@ module Avro
         include Avro::Builder::Types::ComplexType
         include Avro::Builder::Namespaceable
         include Avro::Builder::Types::ConfigurableType
+        include Avro::Builder::Aliasable
 
-        dsl_attributes :namespace, :aliases
-
-        dsl_attribute :name do |value = nil|
-          if value
-            @name = value
-          else
-            @name || "__#{name_fragment}_#{type_name}"
-          end
+        dsl_option :namespace
+        dsl_option :name do
+          @name || "__#{name_fragment}_#{type_name}"
         end
 
+        dsl_attribute_alias :type_aliases, :aliases
+
         def validate!
           required_attribute_error!(:name) if field.nil? && @name.nil?
         end

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

@@ -1,11 +1,14 @@
 module Avro
   module Builder
     module Types
-    # This class represents a record in an Avro schema. Records may be defined
-    # at the top-level or as the type for a field in a record.
+      # This class represents a record in an Avro schema. Records may be defined
+      # at the top-level or as the type for a field in a record.
       class RecordType < Avro::Builder::Types::NamedType
 
-        dsl_attributes :doc
+        DSL_METHODS = %i(required optional extends).to_set.freeze
+
+        dsl_attribute :doc
+        dsl_attribute_alias :type_doc, :doc
 
         def initialize(name = nil, options: {}, cache:, field: nil, &block)
           @type_name = :record
@@ -17,6 +20,10 @@ module Avro
           instance_eval(&block) if block_given?
         end
 
+        def dsl_method?(name)
+          DSL_METHODS.include?(name)
+        end
+
         # Add a required field to the record
         def required(name, type_name, options = {}, &block)
           new_field = Avro::Builder::Field.new(name: name,

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

@@ -5,6 +5,7 @@ module Avro
       # type is constructed. The type has no additional attributes, and
       # the type is serialized as just the type name.
       class Type
+        include Avro::Builder::DslOptions
         include Avro::Builder::DslAttributes
 
         attr_reader :type_name
@@ -42,6 +43,17 @@ module Avro
         def cache!
         end
 
+        # Subclasses can override this method to indicate that the name
+        # is a method that the type exposes in the DSL. These methods are in
+        # addition to the methods for setting attributes on a type.
+        def dsl_method?(_name)
+          false
+        end
+
+        def dsl_respond_to?(name)
+          dsl_attribute?(name) || dsl_method?(name)
+        end
+
         private
 
         def required_attribute_error!(attribute_name)
@@ -58,8 +70,6 @@ module Avro
           end
         end
 
-        private
-
         attr_accessor :field, :cache
       end
     end

data/lib/avro/builder/version.rb

@@ -1,5 +1,5 @@
 module Avro
   module Builder
-    VERSION = "0.5.0"
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby DSL to create Avro schemas
 email:
 - engineering@salsify.com
@@ -102,7 +130,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".overcommit.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -113,9 +143,11 @@ files:
 - bin/console
 - bin/setup
 - lib/avro/builder.rb
+- lib/avro/builder/aliasable.rb
 - lib/avro/builder/definition_cache.rb
 - lib/avro/builder/dsl.rb
 - lib/avro/builder/dsl_attributes.rb
+- lib/avro/builder/dsl_options.rb
 - lib/avro/builder/errors.rb
 - lib/avro/builder/field.rb
 - lib/avro/builder/file_handler.rb