Add support for logical types

Appraisals

@@ -11,7 +11,7 @@ appraise 'rails4_2' do
 end
 
 appraise 'avro-salsify-fork' do
-  gem 'avro-salsify-fork', '1.9.0.0', require: 'avro'
+  gem 'avro-salsify-fork', '1.9.0.1', require: 'avro'
   gem 'activesupport', '~> 4.2.6'
   gem 'activemodel', '~> 4.2.6'
 end

CHANGELOG.md

@@ -1,5 +1,9 @@
 # avromatic changelog
 
+## v0.8.0
+- Add support for logical types. Currently this requires using the
+  `avro-salsify-fork` gem for logical support with Ruby.
+
 ## v0.7.1
 - Raise a more descriptive error when attempting to generate a model for a
   non-record Avro type.

avromatic.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'avro-builder', '>= 0.7.0'
+  spec.add_development_dependency 'avro-builder', '>= 0.11.0'
   # For FakeSchemaRegistryServer
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'salsify_rubocop', '~> 0.42.0'

gemfiles/avro_salsify_fork.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "avro-salsify-fork", "1.9.0.0", :require => "avro"
+gem "avro-salsify-fork", "1.9.0.1", :require => "avro"
 gem "activesupport", "~> 4.2.6"
 gem "activemodel", "~> 4.2.6"
 

lib/avromatic/model.rb

@@ -1,6 +1,7 @@
 require 'avromatic/model/builder'
 require 'avromatic/model/message_decoder'
 require 'avromatic/model/type_registry'
+require 'avromatic/model/logical_types'
 
 module Avromatic
   module Model

lib/avromatic/model/attributes.rb

@@ -100,6 +100,11 @@ def avro_field_class(field_type)
           custom_type = Avromatic.type_registry.fetch(field_type)
           return custom_type.value_class if custom_type.value_class
 
+          if field_type.respond_to?(:logical_type)
+            value_class = Avromatic::Model::LogicalTypes.value_class(field_type.logical_type)
+            return value_class if value_class
+          end
+
           case field_type.type_sym
           when :string, :bytes, :fixed
             String

lib/avromatic/model/logical_types.rb

@@ -0,0 +1,16 @@
+module Avromatic
+  module Model
+    module LogicalTypes
+
+      LOGICAL_TYPE_MAP = {
+        'date' => Date,
+        'timestamp-micros' => Time,
+        'timestamp-millis' => Time
+      }.freeze
+
+      def self.value_class(logical_type)
+        LOGICAL_TYPE_MAP.fetch(logical_type, nil)
+      end
+    end
+  end
+end

lib/avromatic/version.rb

@@ -1,3 +1,3 @@
 module Avromatic
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.8.0'.freeze
 end

spec/avro/dsl/test/logical_types.rb

@@ -0,0 +1,6 @@
+record :logical_types, namespace: :test do
+  required :date, :int, logical_type: 'date'
+  required :ts_msec, :long, logical_type: 'timestamp-millis'
+  required :ts_usec, :long, logical_type: 'timestamp-micros'
+  required :unknown, :int, logical_type: 'foobar'
+end

spec/avro/schema/test/logical_types.avsc

@@ -0,0 +1,35 @@
+{
+  "type": "record",
+  "name": "logical_types",
+  "namespace": "test",
+  "fields": [
+    {
+      "name": "date",
+      "type": {
+        "type": "int",
+        "logicalType": "date"
+      }
+    },
+    {
+      "name": "ts_msec",
+      "type": {
+        "type": "long",
+        "logicalType": "timestamp-millis"
+      }
+    },
+    {
+      "name": "ts_usec",
+      "type": {
+        "type": "long",
+        "logicalType": "timestamp-micros"
+      }
+    },
+    {
+      "name": "unknown",
+      "type": {
+        "type": "int",
+        "logicalType": "foobar"
+      }
+    }
+  ]
+}

spec/avromatic/model/builder_spec.rb

@@ -181,6 +181,12 @@
         end
       end
     end
+
+    context "logical types" do
+      let(:schema_name) { 'test.logical_types' }
+
+      it_behaves_like "a generated model"
+    end
   end
 
   context "validation" do

spec/avromatic/model/messaging_serialization_spec.rb

@@ -170,6 +170,11 @@
     end
   end
 
+  it_behaves_like "logical type encoding and decoding" do
+    let(:encoded_value) { instance.avro_message_value }
+    let(:decoded) { test_class.avro_message_decode(encoded_value) }
+  end
+
   context "custom types" do
     let(:schema_name) { 'test.named_type' }
     let(:test_class) do

spec/avromatic/model/raw_serialization_spec.rb

@@ -130,6 +130,11 @@
     end
   end
 
+  it_behaves_like "logical type encoding and decoding" do
+    let(:encoded_value) { instance.avro_raw_value }
+    let(:decoded) { test_class.avro_raw_decode(value: encoded_value) }
+  end
+
   context "custom types" do
     let(:schema_name) { 'test.named_type' }
     let(:test_class) do

spec/spec_helper.rb

@@ -1,11 +1,18 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'simplecov'
 
-SimpleCov.start
+SimpleCov.start do
+  add_filter 'spec'
+  minimum_coverage 99
+end
 
 require 'avromatic'
 
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
 RSpec.configure do |config|
+  config.extend LogicalTypesHelper
+
   config.before do
     Avromatic.logger = Logger.new('log/test.log')
     Avromatic.registry_url = 'http://registry.example.com'

spec/support/contexts/logical_types_serialization.rb

@@ -0,0 +1,45 @@
+# This examples expects let-variables to be defined for:
+#   decoded: a model instance based on the encoded_value
+shared_examples_for "logical type encoding and decoding" do
+  context "logical types" do
+    let(:schema_name) { 'test.logical_types' }
+    let(:test_class) do
+      Avromatic::Model.model(schema_name: schema_name)
+    end
+    let(:now) { Time.now }
+
+    with_logical_types do
+      context "supported" do
+        let(:values) do
+          {
+            date: Date.today,
+            ts_msec: Time.at(now.to_i, now.usec / 1000 * 1000),
+            ts_usec: now,
+            unknown: 42
+          }
+        end
+
+        it "encodes and decodes instances" do
+          expect(decoded).to eq(instance)
+        end
+      end
+    end
+
+    without_logical_types do
+      context "unsupported" do
+        let(:values) do
+          {
+            date: (Date.today - Date.new(1970, 1, 1)).to_i,
+            ts_msec: now.to_i + now.usec / 1000 * 1000,
+            ts_usec: now.to_i * 1_000_000 + now.usec,
+            unknown: 42
+          }
+        end
+
+        it "encodes and decodes instances" do
+          expect(decoded).to eq(instance)
+        end
+      end
+    end
+  end
+end

spec/support/helpers/logical_types_helper.rb

@@ -0,0 +1,16 @@
+module LogicalTypesHelper
+
+  def with_logical_types
+    yield if logical_types?
+  end
+
+  def without_logical_types
+    yield unless logical_types?
+  end
+
+  private
+
+  def logical_types?
+    Avro::Schema.instance_methods.include?(:logical_type)
+  end
+end