avro-builder 0.14.1 → 0.15.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d3eb1e937d77bb8d5f3b868509c69dc105b2aa
-  data.tar.gz: f638c4459b959ecb39abad6d311e360a31185d42
+  metadata.gz: 6bd5352172e109727099592f904b03ecfba50d48
+  data.tar.gz: a729d03c744b064c9a9677c88c9c93225c9db52a
 SHA512:
-  metadata.gz: 779bb6e3904c33882b733bde8b2c93b17763c272dbe27191d153b4dafacef47172b491a91dcd3ff98e4c9326a572997eb1b47862ef50f79e78a960d14e9f65fe
-  data.tar.gz: 63680ea96c10abe0848185190df7b0472fef02c6083b3dff9fc75f97d766590edb95026738082b8485c10e1b1e5a0303e5b83d8a55d63be41b73ec9cb773a487
+  metadata.gz: 5f918eb9cbfb7afc951945162092b869819ef3ef3880fca68d49534afc0d3eda73bf0916a75f889c68e98db2a26f551de62e4e08acb3c94198fb92230ef63642
+  data.tar.gz: 6f33b3efe33499c221769e744b5cccd3aa053012adef5f57b75ca12a89590044755a01f02072b1517a96f58449073aea07a134508b8a1bc5660a8968096d0324

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # avro-builder changelog
 
+## v0.15.0
+- Add support for declaring types as abstract.
+
 ## v0.14.1
 - File handling fixes.
 

data/README.md

@@ -316,6 +316,25 @@ record :with_date_array
 end
 ```
 
+### Abstract Types
+
+Types can be declared as abstract in the DSL. Declaring a type as abstract
+prevents the rake task from generating an Avro JSON schema for the type.
+
+A type can be declared as abstract using either an option or a method in the
+DSL when defining the type:
+
+```ruby
+record :unique_id, abstract: true
+  required :uuid, :fixed, size: 38
+end
+
+enum :status do
+  symbols %w(valid invalid)
+  abstract true
+end
+```
+
 ### Type Macros
 
 `avro-builder` allows type macros to be defined that expand to types that
@@ -339,6 +358,9 @@ type_macro :timestamp, long(logical_type: 'timestamp-millis'),
            namespace: 'com.my_company'
 ```
 
+Type macros are always marked as abstract and do not generate an Avro JSON
+schema file when using the rake task.
+
 ### Auto-loading and Imports
 
 Specify paths to search for definitions:

data/avro-builder.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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 'rspec-its'
   spec.add_development_dependency 'json_spec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'salsify_rubocop', '~> 0.47.0'

data/lib/avro/builder.rb

@@ -5,12 +5,17 @@ require 'avro/builder/schema_store'
 module Avro
   module Builder
 
+    # Accepts a string or block to eval and returns the Avro::Builder::DSL object
+    def self.build_dsl(str = nil, filename: nil, &block)
+      Avro::Builder::DSL.new(str, filename: filename, &block)
+    end
+
     # Accepts a string or block to eval to define a JSON schema
     def self.build(str = nil, filename: nil, &block)
       Avro::Builder::DSL.new(str, filename: filename, &block).to_json
     end
 
-    # Accepts a string or block to eval and returns an Avro::Schema
+    # Accepts a string or block to eval and returns an Avro::Schema object
     def self.build_schema(str = nil, filename: nil, &block)
       Avro::Builder::DSL.new(str, filename: filename, &block).as_schema
     end

data/lib/avro/builder/dsl.rb

@@ -38,6 +38,10 @@ module Avro
         end
       end
 
+      def abstract?
+        @last_object && @last_object.abstract?
+      end
+
       # Define an Avro schema record
       def record(name = nil, options = {}, &block)
         create_named_type(name, :record, options, &block)
@@ -92,7 +96,10 @@ module Avro
       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)
+        type_clone = type_object.clone
+        type_clone.send(:abstract=, true)
+        cache.add_type_by_name(type_clone, name, options[:namespace] || namespace)
+        @last_object = type_clone
       end
 
       private

data/lib/avro/builder/rake/avro_generate_task.rb

@@ -35,9 +35,17 @@ module Avro
               Dir["#{root}/**/*.rb"].each do |dsl_file|
                 puts "Generating Avro schema from #{dsl_file}"
                 output_file = dsl_file.sub('/dsl/', '/schema/').sub(/\.rb$/, ".#{filetype}")
-                schema = Avro::Builder.build(filename: dsl_file)
-                FileUtils.mkdir_p(File.dirname(output_file))
-                File.write(output_file, schema.end_with?("\n") ? schema : schema << "\n")
+                dsl = Avro::Builder.build_dsl(filename: dsl_file)
+                if dsl.abstract?
+                  if File.exist?(output_file)
+                    puts "... Removing #{output_file} for abstract type"
+                    FileUtils.rm(output_file)
+                  end
+                else
+                  schema = dsl.to_json
+                  FileUtils.mkdir_p(File.dirname(output_file))
+                  File.write(output_file, schema.end_with?("\n") ? schema : schema << "\n")
+                end
               end
             end
           end

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

@@ -18,7 +18,7 @@ module Avro
 
         dsl_attribute_alias :type_aliases, :aliases
 
-        # This module most be included after options are defined
+        # This module must be included after options are defined
         include Avro::Builder::Types::NamedErrorHandling
 
         def name(value = nil)

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

@@ -8,7 +8,7 @@ module Avro
         include Avro::Builder::DslOptions
         include Avro::Builder::DslAttributes
 
-        dsl_attribute :logical_type
+        dsl_attributes :logical_type, :abstract
 
         attr_reader :avro_type_name
 
@@ -18,6 +18,10 @@ module Avro
           @field = field
         end
 
+        def abstract?
+          !!abstract
+        end
+
         def serialize(_reference_state)
           if logical_type
             { type: avro_type_name, logicalType: logical_type }

data/lib/avro/builder/version.rb

@@ -1,5 +1,5 @@
 module Avro
   module Builder
-    VERSION = '0.14.1'.freeze
+    VERSION = '0.15.0.rc0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0.rc0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
 - !ruby/object:Gem::Dependency
   name: json_spec
   requirement: !ruby/object:Gem::Requirement
@@ -209,9 +223,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.10