avro-builder 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55be55b48ed971e75719a7c77d72002a384ae371
-  data.tar.gz: 164cddb8d0eb7ab54df709751bc0bd3d0b9a4164
+  metadata.gz: 102f64b688e2d8f26a65c2235860d4c161f41645
+  data.tar.gz: 48f49e771a762072dab576f79ccdfd2f951b3dfa
 SHA512:
-  metadata.gz: af77d1df17425d13af42225a8c1ca04e99464e1a907c588699159cf0b0b6248e1fa1af1443f1de64ec186680ec03a895547157e1923cef62132d49e69552e16f
-  data.tar.gz: 31bd7491a67a0cd075fbf193aa896cadb27ca0ce9c68851bf1e2aa4b302678ae14c34cc81ae1b327523f4c7d450df8f2eeba1f42cff0b6d491826c21c4785e1c
+  metadata.gz: c93f99d97e6e63d0bae808f7608cf4f627fb5efe928ef7ba6da4ef00fda6119e29b94802bda1d21c0a86bd1fc184f102aa4ebdf79688d55df10b3b4534b7680d
+  data.tar.gz: 78dd456fa89680f448ac176e58e3ae3bfadf3954fcb2ea044406db22bdaf65a5d74924d3354c7bbe3e0dd46e00d8afb5f06d7cac215cf30fe47c9042466db846

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
   - 2.2.4
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.3.1
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # avro-builder changelog
 
+## v0.8.0
+- Add `Avro::Builder::SchemaStore` to load DSL files and return schema objects.
+
 ## v0.7.0
 - Only allow `type_name` and `type_namespace` options for naming named types
   defined inline.

data/README.md

@@ -12,12 +12,17 @@ This DSL was created because:
 * Schemas can be extracted as JSON from an IDL Protocol but support
   for imports is still limited.
 
+Additional background on why we developed `avro-builder` is provided
+[here](http://blog.salsify.com/engineering/adventures-in-avro).
+
 ## Features
 * The syntax is designed for ease-of-use.
 * Definitions can be imported by name. This includes auto-loading from a configured
   set of paths. This allows definitions to split across files and even reused
   between projects.
 * Record definitions can inherit from other record definitions.
+* [Schema Store](#schema-store) to load files written in the DSL and return
+  `Avro::Schema` objects.
 
 ## Limitations
 
@@ -45,7 +50,7 @@ Or install it yourself as:
 
 ## Usage
 
-To use `Avro::Builder` define a schema:
+To use `Avro::Builder`, define a schema:
 
 ```ruby
 namespace 'com.example'
@@ -246,6 +251,31 @@ record using `extends <record_name>`. This adds all of the fields from
 the referenced record to the current record. The current record may override
 fields in the record that it extends.
 
+## Schema Store
+
+The `Avro::Builder::SchemaStore` can be used to load DSL files and return cached
+`Avro::Schema` objects. This schema store can be used as the schema store for
+[avromatic](https://github.com/salsify/avromatic)
+to generate models directly from schemas defined using the DSL.
+
+The schema store must be initialized with the path where DSL files are located:
+
+```ruby
+schema_store = Avro::Builder::SchemaStore.new(path: '/path/to/dsl/files')
+schema_store.find('schema_name', 'my_namespace')
+#=> Avro::Schema (for file at '/path/to/dsl/files/my_namespace/schema_name.rb')
+```
+
+To configure `Avromatic` to use this schema store and its Messaging API:
+
+```ruby
+Avromatic.configure do |config|
+  config.schema_store = Avro::Builder::SchemaStore.new(path: 'avro/dsl')
+  config.registry_url = 'https://builder:avro@avro-schema-registry.salsify.com'
+  config.build_messaging!
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/avro/builder.rb

@@ -1,5 +1,6 @@
 require 'avro/builder/version'
 require 'avro/builder/dsl'
+require 'avro/builder/schema_store'
 
 module Avro
   module Builder

data/lib/avro/builder/errors.rb

@@ -38,6 +38,12 @@ module Avro
       end
     end
 
+    class SchemaError < StandardError
+      def initialize(actual, expected)
+        super("expected schema '#{actual}' to define type '#{expected}'")
+      end
+    end
+
     AttributeError = Class.new(StandardError)
   end
 end

data/lib/avro/builder/schema_store.rb

@@ -0,0 +1,24 @@
+module Avro
+  module Builder
+    # This class implements a schema store that loads Avro::Builder
+    # DSL files and returns Avro::Schema objects.
+    # It implements the same API as AvroTurf::SchemaStore.
+    class SchemaStore
+      def initialize(path: nil)
+        Avro::Builder.add_load_path(path) if path
+        @schemas = {}
+      end
+
+      def find(name, namespace = nil)
+        fullname = Avro::Name.make_fullname(name, namespace)
+
+        @schemas[fullname] ||= Avro::Builder::DSL.new { eval_file(fullname) }
+          .as_schema.tap do |schema|
+            if schema.respond_to?(:fullname) && schema.fullname != fullname
+              raise SchemaError.new(schema.fullname, fullname)
+            end
+          end
+      end
+    end
+  end
+end

data/lib/avro/builder/version.rb

@@ -1,5 +1,5 @@
 module Avro
   module Builder
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -157,6 +157,7 @@ files:
 - lib/avro/builder/namespaceable.rb
 - lib/avro/builder/record.rb
 - lib/avro/builder/schema_serializer_reference_state.rb
+- lib/avro/builder/schema_store.rb
 - lib/avro/builder/type_factory.rb
 - lib/avro/builder/types.rb
 - lib/avro/builder/types/array_type.rb