protobuf-activerecord 3.0.0.pre → 3.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 222a25f863e0432deaee84af24cdb1afcf54d470
-  data.tar.gz: 2db3c1dce2882e7495cfe2d7b3eed18f01677b19
+  metadata.gz: f05a18edbd1975b9bfa100ca10a9cba378f9bb0c
+  data.tar.gz: 8b5e67786002299711c1166c4138df5b7361f3fc
 SHA512:
-  metadata.gz: 96dd33216999495aca093656d30918711af9c1641e4476ea028b929ba162607510ce0d36253762821e4b48c210c4834188166a3c12e9b7d0a77a6ef58045bdf4
-  data.tar.gz: c0ef76053aff3bcdbf00a3a8d9bb894367491c753a4e583799fef3d1a2d928445306cb898b1cd6b9d1d94ae8795050c016958ad9f262f8419c2671e173f027f0
+  metadata.gz: 020fe794814c24474431013da37691656fdfcf9d6de94daf40fd060c4c7fbdad53678b22dc1d79d13e21eab997cb8e831129879ad0475f70e910de6d8042ad53
+  data.tar.gz: 5ff23bd27c06791f05426c8470812bd6f0c7521616cdcde5ba6cff47208658a97f3d38caf32f8cfda6f862e5cd62cf37eab63500688f3de012fe7ca158706f29

data/lib/protobuf-activerecord.rb

@@ -9,16 +9,6 @@ require 'protobuf/active_record/version'
 
 module Protobuf
   module ActiveRecord
-    module LoadHooks
-      def inherited(klass)
-        super
-
-        klass.class_eval do
-          include Protobuf::ActiveRecord::Model
-        end
-      end
-    end
-
     def self.config
       @config ||= Protobuf::ActiveRecord::Config.new
     end

data/lib/protobuf/active_record/errors.rb

@@ -9,11 +9,30 @@ module Protobuf
     # Raised by `attribute_from_proto` when the transformer method
     # given is not callable.
     class AttributeTransformerError < ProtobufActiveRecordError
+      def message
+        "Attribute transformers must be called with a callable or block!"
+      end
     end
 
     # Raised by `field_from_record` when the convert method
     # given not callable.
     class FieldTransformerError < ProtobufActiveRecordError
+      def message
+        "Field transformers must be called with a callable or block!"
+      end
+    end
+
+    # Raised by `to_proto` when no protobuf message is defined.
+    class MessageNotDefined < ProtobufActiveRecordError
+      attr_reader :class_name
+
+      def initialize(klass)
+        @class_name = klass.name
+      end
+
+      def message
+        "#{class_name} does not define a protobuf message"
+      end
     end
 
     # Raised by `field_scope` when given scope is not defined.

data/lib/protobuf/active_record/railtie.rb

@@ -4,7 +4,11 @@ module Protobuf
       config.protobuf_active_record = Protobuf::ActiveRecord.config
 
       ActiveSupport.on_load(:active_record) do
-        extend Protobuf::ActiveRecord::LoadHooks if Protobuf::ActiveRecord.config.autoload
+        if Protobuf::ActiveRecord.config.autoload
+          on_inherit do
+            include Protobuf::ActiveRecord::Model
+          end
+        end
       end
     end
   end

data/lib/protobuf/active_record/scope.rb

@@ -96,7 +96,7 @@ module Protobuf
             next unless proto.respond_to_and_has_and_present?(field)
 
             unless self.respond_to?(scope_name)
-              raise Protobuf::ActiveRecord::SearchScopeError, "Undefined scope :#{scope_name}."
+              raise SearchScopeError, "Undefined scope :#{scope_name}."
             end
 
             search_values = parse_search_values(proto, field)

data/lib/protobuf/active_record/serialization.rb

@@ -9,19 +9,16 @@ module Protobuf
       included do
         include ::Heredity
 
-        class << self
-          attr_accessor :_protobuf_field_transformers, :_protobuf_field_options
-        end
-
-        @_protobuf_field_transformers = {}
-        @_protobuf_field_options = {}
-
         inheritable_attributes :_protobuf_field_transformers,
                                :_protobuf_field_options,
                                :protobuf_message
 
+        @_protobuf_field_transformers = {}
+        @_protobuf_field_options = {}
+
         private :_protobuf_convert_attributes_to_fields
         private :_protobuf_field_transformers
+        private :_protobuf_message
       end
 
       module ClassMethods
@@ -72,12 +69,33 @@ module Protobuf
           end
 
           unless callable.respond_to?(:call)
-            raise FieldTransformerError, 'Attribute transformers need a callable or block!'
+            raise FieldTransformerError
           end
 
           _protobuf_field_transformers[field.to_sym] = callable
         end
 
+        # Define the protobuf fields that will be automatically serialized (by default,
+        # all fields will be serialized). Accepts any number of field names and is
+        # equivalent to passing the :only option to `protobuf_message`.
+        #
+        # If :except is specified, all fields except the specified fields will be serialized.
+        #
+        # By default, deprecated fields will be serialized. To exclude deprecated
+        # fields, pass :deprecated => false in the options hash.
+        #
+        # Examples:
+        #   protobuf_fields :guid, :name
+        #   protobuf_fields :except => :email_domain
+        #   protobuf_fields :except => :email_domain, :deprecated => false
+        #
+        def protobuf_fields(*fields)
+          options = fields.extract_options!
+          options[:only] = fields
+
+          self._protobuf_field_options = options
+        end
+
         # Define the protobuf message class that should be used to serialize the
         # object to protobuf. Accepts a string or symbol and an options hash.
         #
@@ -104,12 +122,7 @@ module Protobuf
         def protobuf_message(message = nil, options = {})
           unless message.nil?
             @protobuf_message = message.to_s.classify.constantize
-
             self._protobuf_field_options = options
-
-            define_method(:to_proto) do |options = {}|
-              self.class.protobuf_message.new(self.fields_from_record(options))
-            end
           end
 
           @protobuf_message
@@ -189,6 +202,19 @@ module Protobuf
       def _protobuf_field_transformers
         self.class._protobuf_field_transformers
       end
+
+      # :nodoc:
+      def _protobuf_message
+        self.class.protobuf_message
+      end
+
+      # :nodoc:
+      def to_proto(options = {})
+        raise MessageNotDefined.new(self.class) if _protobuf_message.nil?
+
+        fields = self.fields_from_record(options)
+        _protobuf_message.new(fields)
+      end
     end
   end
 end

data/lib/protobuf/active_record/transformation.rb

@@ -100,7 +100,7 @@ module Protobuf
           end
 
           unless callable.respond_to?(:call)
-            raise AttributeTransformerError, 'Attribute transformers need a callable or block!'
+            raise AttributeTransformerError
           end
 
           _protobuf_attribute_transformers[attribute.to_sym] = callable

data/lib/protobuf/active_record/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module ActiveRecord
-    VERSION = "3.0.0.pre"
+    VERSION = "3.0.0.rc2"
   end
 end

data/protobuf-activerecord.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   #
   gem.add_dependency "activerecord", ">= 3.2.0"
   gem.add_dependency "activesupport", ">= 3.2.0"
-  gem.add_dependency "heredity"
+  gem.add_dependency "heredity", ">= 0.1.1"
   gem.add_dependency "protobuf", ">= 2.2.0"
 
   ##

data/spec/protobuf/active_record/serialization_spec.rb

@@ -1,5 +1,10 @@
 require 'spec_helper'
 
+# Used to test calling #to_proto when no protobuf message is configured.
+class UnconfiguredUser
+  include Protobuf::ActiveRecord::Model
+end
+
 describe Protobuf::ActiveRecord::Serialization do
   let(:protobuf_message) { UserMessage }
 
@@ -233,13 +238,23 @@ describe Protobuf::ActiveRecord::Serialization do
     end
 
     describe "#to_proto" do
-      let(:proto) { protobuf_message.new(proto_hash) }
-      let(:proto_hash) { { :name => "foo" } }
+      context "when a protobuf message is configured" do
+        let(:proto) { protobuf_message.new(proto_hash) }
+        let(:proto_hash) { { :name => "foo" } }
 
-      before { user.stub(:fields_from_record).and_return(proto_hash) }
+        before { user.stub(:fields_from_record).and_return(proto_hash) }
 
-      it "intializes a new protobuf message with attributes from #to_proto_hash" do
-        user.to_proto.should eq proto
+        it "intializes a new protobuf message with attributes from #to_proto_hash" do
+          user.to_proto.should eq proto
+        end
+      end
+
+      context "when a protobuf message is not configured" do
+        let(:user) { UnconfiguredUser.new }
+
+        it "raises an exception" do
+          expect { user.to_proto }.to raise_exception(Protobuf::ActiveRecord::MessageNotDefined)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-activerecord
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre
+  version: 3.0.0.rc2
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: protobuf
   requirement: !ruby/object:Gem::Requirement