protobuf-activerecord 1.1.1 → 1.2.0.rc1

data/lib/protobuf/activerecord/protoable/errors.rb

@@ -20,6 +20,11 @@ module Protoable
   # given not callable.
   class FieldConverterError < ProtoableError
   end
+  
+  # Raised by Protoable.field_from_record when the convert method
+  # given not callable.
+  class FieldTransformerError < ProtoableError
+  end
 
   # Raised by Protoable.field_scope when given scope is not defined.
   class SearchScopeError < ProtoableError

data/lib/protobuf/activerecord/protoable/fields.rb

@@ -84,12 +84,12 @@ module Protoable
       #
       # Examples:
       #   attribute_from_proto :public_key, :extract_public_key_from_proto
-      #   attribute_from_proto :status, lambda { |proto_field| # Do some stuff... }
-      #   attribute_from_proto :status do |proto_field|
+      #   attribute_from_proto :status, lambda { |proto| # Do some stuff... }
+      #   attribute_from_proto :status do |proto|
       #     # Do some blocky stuff...
       #   end
       #
-      def attribute_from_proto(field, transformer = nil, &blk)
+      def attribute_from_proto(attribute, transformer = nil, &blk)
         transformer ||= blk
 
         if transformer.is_a?(Symbol)
@@ -102,12 +102,7 @@ module Protoable
           raise AttributeTransformerError, 'Attribute transformers need a callable or block!'
         end
 
-        _protobuf_attribute_transformers[field.to_sym] = callable
-      end
-
-      def transform_column(field, transformer = nil, &blk)
-        warn "[DEPRECATION] `transform_column` is deprecated and will be removed in v1.2.  Please use `attribute_from_proto` instead."
-        attribute_from_proto(field, transformer, &blk)
+        _protobuf_attribute_transformers[attribute.to_sym] = callable
       end
     end
   end

data/lib/protobuf/activerecord/protoable/persistence.rb

@@ -2,6 +2,18 @@ module Protoable
   module Persistence
     def self.included(klass)
       klass.extend Protoable::Persistence::ClassMethods
+
+      klass.class_eval do
+        # Override Active Record's initialize method so it can accept a protobuf
+        # message as it's attributes. Need to do it in class_eval block since initialize
+        # is defined in ActiveRecord::Base.
+        # :noapi:
+        def initialize(*args)
+          args[0] = attributes_from_proto(args.first) if args.first.is_a?(::Protobuf::Message)
+
+          super(*args)
+        end
+      end
     end
 
     module ClassMethods

data/lib/protobuf/activerecord/protoable/serialization.rb

@@ -8,20 +8,51 @@ module Protoable
 
       klass.class_eval do
         class << self
-          attr_accessor :_protobuf_attribute_converters, :protobuf_fields
+          attr_accessor :_protobuf_attribute_converters,
+            :_protobuf_field_transformers, :protobuf_fields
         end
 
         @_protobuf_attribute_converters = {}
+        @_protobuf_field_transformers = {}
         @protobuf_fields = []
 
-        inheritable_attributes :_protobuf_attribute_converters, :protobuf_fields, :protobuf_message
+        inheritable_attributes :_protobuf_attribute_converters,
+          :_protobuf_field_transformers, :protobuf_fields, :protobuf_message
       end
     end
 
     module ClassMethods
-      def convert_column(field, converter = nil, &blk)
-        warn "[DEPRECATION] `convert_column` is deprecated and will be removed in v1.2.  Please use `protoable_attribute` instead."
-        protoable_attribute(field, converter, &blk)
+      # Define a field transformation from a record. Accepts a Symbol,
+      # callable, or block that is called with the record being serialized.
+      #
+      # When given a callable or block, it is directly used to convert the field.
+      #
+      # When a symbol is given, it extracts the method with the same name.
+      #
+      # The callable or method must accept a single parameter, which is the
+      # proto message.
+      #
+      # Examples:
+      #   field_from_record :public_key, :convert_public_key_to_proto
+      #   field_from_record :status, lambda { |record| # Do some stuff... }
+      #   field_from_record :status do |record|
+      #     # Do some blocky stuff...
+      #   end
+      #
+      def field_from_record(field, transformer = nil, &blk)
+        transformer ||= blk
+
+        if transformer.is_a?(Symbol)
+          callable = lambda { |value| self.__send__(transformer, value) }
+        else
+          callable = transformer
+        end
+
+        unless callable.respond_to?(:call)
+          raise FieldTransformerError, 'Attribute transformers need a callable or block!'
+        end
+
+        _protobuf_field_transformers[field.to_sym] = callable
       end
 
       # Define a custom attribute conversion for serialization to protobuf.
@@ -98,8 +129,12 @@ module Protoable
     #
     def protoable_attributes
       protoable_attributes = protobuf_fields.inject({}) do |hash, field|
-        value = respond_to?(field) ? __send__(field) : nil
-        hash[field] = _protobuf_convert_attributes_to_fields(field, value)
+        if _protobuf_field_transformers.has_key?(field)
+          hash[field] = _protobuf_field_transformers[field].call(self)
+        else
+          value = respond_to?(field) ? __send__(field) : nil
+          hash[field] = _protobuf_convert_attributes_to_fields(field, value)
+        end
         hash
       end
 
@@ -112,6 +147,10 @@ module Protoable
       self.class._protobuf_convert_attributes_to_fields(field, value)
     end
 
+    def _protobuf_field_transformers
+      self.class._protobuf_field_transformers
+    end
+
     def protobuf_fields
       self.class.protobuf_fields
     end

data/lib/protobuf/activerecord/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module ActiveRecord
-    VERSION = "1.1.1"
+    VERSION = "1.2.0.rc1"
   end
 end

data/spec/protoable/persistence_spec.rb

@@ -31,14 +31,14 @@ describe Protoable::Persistence do
   end
 
   describe ".attributes_from_proto" do
-    context "when a attribute transformer is defined for the field" do
+    context "when a transformer is defined for the attribute" do
       it "transforms the field value" do
         attribute_fields = User.attributes_from_proto(proto)
         attribute_fields[:first_name].should eq user_attributes[:first_name]
       end
     end
 
-    context "when attribute transformer is not defined for the field" do
+    context "when a transformer is not defined for the attribute" do
       before {
         User.stub(:_protobuf_convert_fields_to_columns) do |key, value|
           value

data/spec/protoable/serialization_spec.rb

@@ -3,6 +3,38 @@ require 'spec_helper'
 describe Protoable::Serialization do
   let(:protobuf_message) { UserMessage }
 
+  describe ".field_from_record" do
+    context "when the given converter is a symbol" do
+      let(:callable) { lambda { |value| User.__send__(:extract_first_name) } }
+
+      before { User.field_from_record :first_name, :extract_first_name }
+
+      it "creates a callable method object from the converter" do
+        User.should_receive(:extract_first_name)
+        User._protobuf_field_transformers[:first_name].call(1)
+      end
+    end
+
+    context "when the given converter is not callable" do
+      it "raises an exception" do
+        expect { User.field_from_record :name, nil }.to raise_exception(Protoable::FieldTransformerError)
+      end
+    end
+
+    context "when the given transformer is callable" do
+      let(:callable) { lambda { |proto| nil } }
+
+      before {
+        User.stub(:_protobuf_field_transformers).and_return(Hash.new)
+        User.field_from_record :account_id, callable
+      }
+
+      it "adds the given converter to the list of protobuf field transformers" do
+        User._protobuf_field_transformers[:account_id] = callable
+      end
+    end
+  end
+
   describe ".protoable_attribute" do
     context "when the given converter is a hash" do
       let(:method) { lambda { |value| User.__send__(:convert_base64_to_string, value) } }
@@ -47,7 +79,7 @@ describe Protoable::Serialization do
     before { User.protobuf_message(protobuf_message) }
 
     context "given a value" do
-      let(:protobuf_fields) { [ :guid, :name, :email ] }
+      let(:protobuf_fields) { [ :guid, :name, :email, :email_domain ] }
 
       it "sets .protobuf_fields" do
         User.protobuf_fields.should =~ protobuf_fields
@@ -74,23 +106,46 @@ describe Protoable::Serialization do
     before { User.protobuf_message(protobuf_message) }
 
     describe "#protoable_attributes" do
-      let(:attributes) {
-        {
-          :guid => "foo",
-          :first_name => "bar",
-          :last_name => "baz",
-          :email => "foo@test.co"
+      context "when a transformer is defined for the field" do
+        let(:attributes) {
+          {
+            :guid => "foo",
+            :first_name => "bar",
+            :last_name => "baz",
+            :email => "foo@test.co"
+          }
+        }
+        let(:protoable_attributes) { { :guid => user.guid, :name => user.name, :email => user.email, :email_domain => 'test.co' } }
+        let(:transformer) { { :email_domain => lambda { |record| record.email.split('@').last } } }
+
+        before {
+          User.stub(:_protobuf_field_transformers).and_return(transformer)
         }
-      }
-      let(:protoable_attributes) { { :guid => user.guid, :name => user.name, :email => user.email } }
 
-      it "returns a hash of protobuf fields that this object has getters for" do
-        user.protoable_attributes.should eq protoable_attributes
+        it "gets the field from the transformer" do
+          user.protoable_attributes.should eq protoable_attributes
+        end
       end
 
-      it "converts attributes values for protobuf messages" do
-        user.should_receive(:_protobuf_convert_attributes_to_fields).any_number_of_times
-        user.protoable_attributes
+      context "when a transformer is not defined for the field" do
+        let(:attributes) {
+          {
+            :guid => "foo",
+            :first_name => "bar",
+            :last_name => "baz",
+            :email => "foo@test.co"
+          }
+        }
+        let(:protoable_attributes) { { :guid => user.guid, :name => user.name, :email => user.email, :email_domain => nil } }
+
+        it "returns a hash of protobuf fields that this object has getters for" do
+          user.protoable_attributes.should eq protoable_attributes
+        end
+
+        it "converts attributes values for protobuf messages" do
+          user.should_receive(:_protobuf_convert_attributes_to_fields).any_number_of_times
+          user.protoable_attributes
+        end
       end
     end
 

data/spec/support/definitions/user.proto

@@ -1,7 +1,8 @@
 message UserMessage {
-  optional string guid        = 1;
-  optional string name        = 2;
-  optional string email       = 3;
+  optional string guid         = 1;
+  optional string name         = 2;
+  optional string email        = 3;
+  optional string email_domain = 4;
 }
 
 message UserSearchMessage {

data/spec/support/protobuf.rb

@@ -1,2 +1 @@
-require 'protobuf'
 require 'support/protobuf/user.pb'

data/spec/support/protobuf/user.pb.rb

@@ -17,6 +17,7 @@ class UserMessage
   optional ::Protobuf::Field::StringField, :guid, 1
   optional ::Protobuf::Field::StringField, :name, 2
   optional ::Protobuf::Field::StringField, :email, 3
+  optional ::Protobuf::Field::StringField, :email_domain, 4
 end
 
 class UserSearchMessage

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 1.2.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -240,16 +240,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 471675617945359118
+      hash: -3851235925633840978
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 471675617945359118
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24