avro-builder 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 102f64b688e2d8f26a65c2235860d4c161f41645
-  data.tar.gz: 48f49e771a762072dab576f79ccdfd2f951b3dfa
+  metadata.gz: 6ce24d8f81a853345491ca01f3f152bea7c322e6
+  data.tar.gz: 699ae7ae471b75260c8975e9762648c4dfaeed03
 SHA512:
-  metadata.gz: c93f99d97e6e63d0bae808f7608cf4f627fb5efe928ef7ba6da4ef00fda6119e29b94802bda1d21c0a86bd1fc184f102aa4ebdf79688d55df10b3b4534b7680d
-  data.tar.gz: 78dd456fa89680f448ac176e58e3ae3bfadf3954fcb2ea044406db22bdaf65a5d74924d3354c7bbe3e0dd46e00d8afb5f06d7cac215cf30fe47c9042466db846
+  metadata.gz: 0a45f164f8639364362fb34546c29ee79a6e352058c14e766958aee088a7e5ffd5bb56cdf9cc5e9986ba277407a45115e2a12bb8508a04aa36442080a7bee7d2
+  data.tar.gz: 373081fd2648cadfb035bde881e14c71cd69c30d1feb350cf6ff0a831851167cbb24279316520740609bb77cc9d59a1616796309aff2618bf27f5dc51d6ac166

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # avro-builder changelog
 
+## v0.9.0
+- Add rake task to generate Avro JSON schema files for all DSL files under a
+  configurable root directory.
+- Add Railtie to configure `#{Rails.root}/avro/dsl` as a load path, and define
+  `avro:generate` rake task.
+
 ## v0.8.0
 - Add `Avro::Builder::SchemaStore` to load DSL files and return schema objects.
 

data/README.md

@@ -1,6 +1,7 @@
 # Avro::Builder
 
 [![Build Status](https://travis-ci.org/salsify/avro-builder.svg?branch=master)][travis]
+[![Gem Version](https://badge.fury.io/rb/avro-builder.svg)](https://badge.fury.io/rb/avro-builder)
 
 [travis]: http://travis-ci.org/salsify/avro-builder
 
@@ -48,6 +49,14 @@ Or install it yourself as:
 
     $ gem install avro-builder
 
+## Railtie
+
+When included in a Rails project, `#{Rails.root}/avro/dsl` is configured as a
+load path for the DSL.
+
+A [rake task](#avro-generate-rake-task) is also defined for generating Avro JSON
+schemas from the DSL.
+
 ## Usage
 
 To use `Avro::Builder`, define a schema:
@@ -276,6 +285,26 @@ Avromatic.configure do |config|
 end
 ```
 
+### Avro Generate Rake Task
+
+There is a rake task that can be used to generate Avro schemas from all DSL
+files.
+
+A rake task is automatically defined via a Railtie for Rails projects that uses
+`#{Rails.root}/avro/dsl` as the root for Avro DSL files.
+
+Custom rake tasks can also be defined:
+
+```ruby
+require 'avro/builder/rake/avro_generate_task'
+Avro::Builder::Rake::AvroGenerateTask.new(name: :custom_gen,
+                                          dependencies: [:load_app]) do |task|
+  task.root = '/path/to/dsl/files'
+  task.load_paths << '/additional/dsl/files'
+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/railtie.rb

@@ -0,0 +1,14 @@
+module Avro
+  module Builder
+    class Railtie < Rails::Railtie
+
+      initializer 'salsify_avro.avro_builder_load_path' do
+        Avro::Builder.add_load_path("#{Rails.root}/avro/dsl")
+      end
+
+      rake_tasks do
+        load File.expand_path('../rake/rails_avro_generate_task.rake', __FILE__)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'rake/tasklib'
+require 'avro/builder'
+
+module Avro
+  module Builder
+    module Rake
+      class AvroGenerateTask < ::Rake::TaskLib
+
+        attr_accessor :name, :task_namespace, :task_desc, :root,
+                      :load_paths, :dependencies
+
+        def initialize(name: :generate, dependencies: [])
+          @name = name
+          @task_namespace = :avro
+          @task_desc = 'Generate Avro schema files from Avro::Builder DSL'
+          @load_paths = []
+          @root = "#{Rails.root}/avro/dsl" if defined?(Rails)
+          @dependencies = dependencies
+
+          yield self if block_given?
+
+          define
+        end
+
+        private
+
+        # Define the rake task
+        def define
+          namespace task_namespace do
+            desc task_desc
+            task(name.to_sym => dependencies) do
+              raise '"root" must be specified for Avro DSL files' unless root
+              Avro::Builder.add_load_path(*[root, load_paths].flatten)
+              Dir["#{root}/**/*.rb"].each do |dsl_file|
+                puts "Generating Avro schema from #{dsl_file}"
+                output_file = dsl_file.sub('/dsl/', '/schema/').sub(/\.rb$/, '.avsc')
+                schema = Avro::Builder.build(File.read(dsl_file))
+                FileUtils.mkdir_p(File.dirname(output_file))
+                File.write(output_file, schema.end_with?("\n") ? schema : schema << "\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avro/builder/rake/rails_avro_generate_task.rake

@@ -0,0 +1,2 @@
+require 'avro/builder/rake/avro_generate_task'
+Avro::Builder::Rake::AvroGenerateTask.new(dependencies: %i(environment))

data/lib/avro/builder/version.rb

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

data/lib/avro/builder.rb

@@ -21,3 +21,5 @@ module Avro
     end
   end
 end
+
+require 'avro/builder/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -155,6 +155,9 @@ files:
 - lib/avro/builder/file_handler.rb
 - lib/avro/builder/fixed.rb
 - lib/avro/builder/namespaceable.rb
+- lib/avro/builder/railtie.rb
+- lib/avro/builder/rake/avro_generate_task.rb
+- lib/avro/builder/rake/rails_avro_generate_task.rake
 - lib/avro/builder/record.rb
 - lib/avro/builder/schema_serializer_reference_state.rb
 - lib/avro/builder/schema_store.rb
@@ -194,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Ruby DSL to create Avro schemas