protobuf 2.3.2 → 2.4.0

data/lib/protobuf/exceptions.rb

@@ -1,11 +1,8 @@
 module Protobuf
-
   class Error < StandardError; end
-
   class InvalidWireType < Error; end
-
   class NotInitializedError < Error; end
-
   class TagCollisionError < Error; end
-
+  class SerializationError < StandardError; end
+  class FieldNotDefinedError < StandardError; end
 end

data/lib/protobuf/field/base_field.rb

@@ -40,7 +40,7 @@ module Protobuf
         @default_value = \
           case @rule
           when :repeated then
-            FieldArray.new(self).freeze
+            ::Protobuf::Field::FieldArray.new(self).freeze
           when :required then
             nil
           when :optional then
@@ -67,31 +67,20 @@ module Protobuf
         @_message = (self.class < ::Protobuf::Field::MessageField)
       end
 
-      def initialized?(message_instance)
-        value = message_instance.__send__(getter_method_name)
-        case @rule
-        when :required then
-          ! value.nil? && (! kind_of?(MessageField) || value.initialized?)
-        when :repeated then
-          value.all? {|msg| ! kind_of?(MessageField) || msg.initialized? }
-        when :optional then
-          value.nil? || ! kind_of?(MessageField) || value.initialized?
-        end
-      end
-
       # Decode +bytes+ and pass to +message_instance+.
       def set(message_instance, bytes)
         if packed?
           array = message_instance.__send__(getter_method_name)
           method = \
             case wire_type
-            when WireType::FIXED32 then :read_fixed32
-            when WireType::FIXED64 then :read_fixed64
-            when WireType::VARINT  then :read_varint
+            when ::Protobuf::WireType::FIXED32 then :read_fixed32
+            when ::Protobuf::WireType::FIXED64 then :read_fixed64
+            when ::Protobuf::WireType::VARINT  then :read_varint
             end
           stream = StringIO.new(bytes)
+
           until stream.eof?
-            array << decode(Decoder.__send__(method, stream))
+            array << decode(::Protobuf::Decoder.__send__(method, stream))
           end
         else
           value = decode(bytes)
@@ -195,8 +184,13 @@ module Protobuf
         @message_class.class_eval do
           define_method(field.setter_method_name) do |val|
             field.warn_if_deprecated
-            @values[field.name] ||= ::Protobuf::Field::FieldArray.new(field)
-            @values[field.name].replace(val)
+
+            if val.nil?
+              @values.delete(field.name)
+            else
+              @values[field.name] ||= ::Protobuf::Field::FieldArray.new(field)
+              @values[field.name].replace(val)
+            end
           end
         end
       end
@@ -216,6 +210,7 @@ module Protobuf
         @message_class.class_eval do
           define_method(field.setter_method_name) do |val|
             field.warn_if_deprecated
+
             if val.nil?
               @values.delete(field.name)
             elsif field.acceptable?(val)

data/lib/protobuf/field/bool_field.rb

@@ -8,8 +8,7 @@ module Protobuf
       end
 
       def acceptable?(val)
-        raise TypeError unless [true, false].include?(val)
-        true
+        [true, false].include?(val)
       end
 
       def decode(value)

data/lib/protobuf/field/bytes_field.rb

@@ -12,9 +12,9 @@ module Protobuf
       def acceptable?(val)
         if val.nil? || val.is_a?(::Protobuf::Message) || val.instance_of?(String)
           return true
+        else
+          raise TypeError, "Cannot set field : #{name} to value : #{val}"
         end
-
-        raise TypeError, "Cannot set field : #{name} to value : #{val}"
       end
 
       def decode(bytes)
@@ -26,7 +26,6 @@ module Protobuf
         if value.is_a?(::Protobuf::Message)
           value = value.serialize_to_string
         else
-          value = value.dup
           value.force_encoding(::Protobuf::Message::STRING_ENCODING) if value.respond_to?(:force_encoding)
         end
 

data/lib/protobuf/field/field_array.rb

@@ -12,24 +12,24 @@ module Protobuf
       # Public Instance Methods
       #
       def []=(nth, val)
-        super(nth, normalize(val))
+        super(nth, normalize(val)) unless val.nil?
       end
 
       def <<(val)
-        super(normalize(val))
+        super(normalize(val)) unless val.nil?
       end
 
       def push(val)
-        super(normalize(val))
+        super(normalize(val)) unless val.nil?
       end
 
       def unshift(val)
-        super(normalize(val))
+        super(normalize(val)) unless val.nil?
       end
 
       def replace(val)
         raise TypeError unless val.is_a?(Array)
-        val = val.map { |v| normalize(v)}
+        val = val.map { |v| normalize(v) }
         super(val)
       end
 

data/lib/protobuf/field/float_field.rb

@@ -22,9 +22,7 @@ module Protobuf
       end
 
       def acceptable?(val)
-        raise TypeError, val.class.name unless val.is_a?(Numeric)
-        raise RangeError if val < min || max < val
-        true
+        (val > min || val < max) rescue false
       end
     end
   end

data/lib/protobuf/message.rb

@@ -1,16 +1,11 @@
 require 'set'
 require 'protobuf/field'
 require 'protobuf/enum'
+require 'protobuf/exceptions'
 require 'protobuf/message/decoder'
-require 'protobuf/message/encoder'
 
 module Protobuf
   class Message
-    ##
-    # Error Classes
-    #
-    class FieldNotDefinedError < StandardError; end
-
     ##
     # Constants
     #
@@ -165,14 +160,16 @@ module Protobuf
 
     def each_field_for_serialization
       all_fields.each do |field|
-        next unless has_field?(field.name)
+        next unless has_field_or_required_field?(field)
 
         value = __send__(field.name)
+        value.compact! if field.repeated?
 
         if value.present? || [true, false].include?(value)
           yield(field, value) 
         else
-          raise "#{field.name} is required on #{field.message_class}" if field.required?
+          # Only way you can get here is if you are required and not present
+          raise ::Protobuf::SerializationError, "#{field.name} is required on #{field.message_class}"
         end
       end
     end
@@ -208,22 +205,18 @@ module Protobuf
       @values.has_key?(name)
     end
 
-    def initialized?
-      all_fields.all? { |field| field.initialized?(self) }
-    end
-
     def inspect
       to_hash.inspect
     end
 
-    def parse_from_string(string)
-      parse_from(StringIO.new(string))
-    end
-
     def parse_from(stream)
       Decoder.decode(stream, self)
     end
 
+    def parse_from_string(string)
+      parse_from(StringIO.new(string))
+    end
+
     def respond_to_has?(key)
       self.respond_to?(key) && self.has_field?(key)
     end
@@ -234,10 +227,24 @@ module Protobuf
     end
 
     def serialize_to(stream)
-      Encoder.encode(stream, self)
+      each_field_for_serialization do |field, value|
+        if field.repeated?
+          if field.packed?
+            key = (field.tag << 3) | ::Protobuf::WireType::LENGTH_DELIMITED
+            packed_value = value.map { |val| field.encode(val) }.join
+            stream.write(::Protobuf::Field::VarintField.encode(key))
+            stream.write(::Protobuf::Field::VarintField.encode(packed_value.size))
+            stream.write(packed_value)
+          else
+            value.each { |val| write_pair(stream, field, val) }
+          end
+        else
+          write_pair(stream, field, value)
+        end
+      end
     end
 
-    def serialize_to_string(string='')
+    def serialize_to_string(string = '')
       io = StringIO.new(string)
       serialize_to(io)
       result = io.string
@@ -296,6 +303,8 @@ module Protobuf
     #
     alias_method :to_hash_value, :to_hash
     alias_method :to_s, :serialize_to_string
+    alias_method :bytes, :serialize_to_string
+    alias_method :serialize, :serialize_to_string
     alias_method :responds_to_has?, :respond_to_has?
     alias_method :respond_to_and_has?, :respond_to_has?
     alias_method :responds_to_and_has?, :respond_to_has?
@@ -330,5 +339,18 @@ module Protobuf
       object
     end
 
+    def has_field_or_required_field?(field)
+      has_field?(field.name) || field.required?  
+    end
+
+    # Encode key and value, and write to +stream+.
+    def write_pair(stream, field, value)
+      key = (field.tag << 3) | field.wire_type
+      key_bytes = ::Protobuf::Field::VarintField.encode(key)
+      stream.write(key_bytes)
+      bytes = field.encode(value)
+      stream.write(bytes)
+    end
+
   end
 end

data/lib/protobuf/message/decoder.rb

@@ -13,18 +13,18 @@ module Protobuf
         tag, wire_type = read_key(stream)
         bytes =
           case wire_type
-          when WireType::VARINT then
+          when ::Protobuf::WireType::VARINT then
             read_varint(stream)
-          when WireType::FIXED64 then
+          when ::Protobuf::WireType::FIXED64 then
             read_fixed64(stream)
-          when WireType::LENGTH_DELIMITED then
+          when ::Protobuf::WireType::LENGTH_DELIMITED then
             read_length_delimited(stream)
-          when WireType::START_GROUP then
-            read_start_group(stream)
-          when WireType::END_GROUP then
-            read_end_group(stream)
-          when WireType::FIXED32 then
+          when ::Protobuf::WireType::FIXED32 then
             read_fixed32(stream)
+          when ::Protobuf::WireType::START_GROUP then
+            raise NotImplementedError, 'Group is deprecated.'
+          when ::Protobuf::WireType::END_GROUP then
+            raise NotImplementedError, 'Group is deprecated.'
           else
             raise InvalidWireType, wire_type
           end
@@ -69,15 +69,5 @@ module Protobuf
       stream.read(value_length)
     end
 
-    # Not implemented.
-    def read_start_group(stream)
-      raise NotImplementedError, 'Group is deprecated.'
-    end
-
-    # Not implemented.
-    def read_end_group(stream)
-      raise NotImplementedError, 'Group is deprecated.'
-    end
-
   end
 end

data/lib/protobuf/version.rb

@@ -1,4 +1,4 @@
 module Protobuf
-  VERSION = '2.3.2'
+  VERSION = '2.4.0'
   PROTOC_VERSION = '2.4.1'
 end

data/spec/functional/evented_server_spec.rb

@@ -42,7 +42,7 @@ describe 'Functional EventMachine Client' do
       end
       EM.stop
     end
-    error.message.should =~ /ResourceFindRequest.*fields.*improperly set/
+    error.message.should =~ /name.*required/
   end
 
   it 'calls the on_failure callback when the request type is wrong' do

data/spec/functional/socket_server_spec.rb

@@ -41,7 +41,7 @@ describe 'Functional Socket Client' do
       c.on_success { raise "shouldn't pass"}
       c.on_failure {|e| error = e}
     end
-    error.message.should =~ /ResourceFindRequest.*fields.*improperly set/
+    error.message.should =~ /name.*required/
   end
 
   it 'calls the on_failure callback when the request type is wrong' do

data/spec/functional/zmq_server_spec.rb

@@ -41,7 +41,7 @@ describe 'Functional ZMQ Client' do
       c.on_success { raise "shouldn't pass"}
       c.on_failure {|e| error = e}
     end
-    error.message.should =~ /ResourceFindRequest.*fields.*improperly set/
+    error.message.should =~ /name.*required/
   end
 
   it 'calls the on_failure callback when the request type is wrong' do

data/spec/lib/protobuf/message_spec.rb

@@ -20,6 +20,19 @@ describe Protobuf::Message do
     end
   end
 
+  describe '#encode' do
+    context "when there's no value for a required field" do
+      let(:message) { ::Test::Resource.new }
+      let(:stream) { StringIO.new }
+
+      it "raises a 'message not initialized' error" do
+        expect {
+          message.serialize_to(stream)
+        }.to raise_error(Protobuf::SerializationError, /required/i)
+      end
+    end
+  end
+
   describe "boolean predicate methods" do 
     subject { Test::ResourceFindRequest.new(:name => "resource") }
 
@@ -152,19 +165,19 @@ describe Protobuf::Message do
       specify do
         expect {
           subject.get_field_by_name(1)
-        }.to raise_error(::Protobuf::Message::FieldNotDefinedError, /.*1.*#{subject.class.name}/)
+        }.to raise_error(::Protobuf::FieldNotDefinedError, /.*1.*#{subject.class.name}/)
       end
 
       specify do
         expect {
           subject.get_field_by_name(:nothere)
-        }.to raise_error(::Protobuf::Message::FieldNotDefinedError, /.*nothere.*#{subject.class.name}/)
+        }.to raise_error(::Protobuf::FieldNotDefinedError, /.*nothere.*#{subject.class.name}/)
       end
 
       specify do
         expect {
           subject.get_field_by_name(nil)
-        }.to raise_error(::Protobuf::Message::FieldNotDefinedError, /.*nil.*#{subject.class.name}/)
+        }.to raise_error(::Protobuf::FieldNotDefinedError, /.*nil.*#{subject.class.name}/)
       end
     end
   end
@@ -206,13 +219,13 @@ describe Protobuf::Message do
       specify do
         expect {
           subject.get_field_by_tag("not a number")
-        }.to raise_error(::Protobuf::Message::FieldNotDefinedError, /.*not a number.*#{subject.class.name}/)
+        }.to raise_error(::Protobuf::FieldNotDefinedError, /.*not a number.*#{subject.class.name}/)
       end
 
       specify do
         expect {
           subject.get_field_by_tag(nil)
-        }.to raise_error(::Protobuf::Message::FieldNotDefinedError, /.*nil.*#{subject.class.name}/)
+        }.to raise_error(::Protobuf::FieldNotDefinedError, /.*nil.*#{subject.class.name}/)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -369,7 +369,6 @@ files:
 - lib/protobuf/logger.rb
 - lib/protobuf/message.rb
 - lib/protobuf/message/decoder.rb
-- lib/protobuf/message/encoder.rb
 - lib/protobuf/message/extend.rb
 - lib/protobuf/message/message.rb
 - lib/protobuf/rpc/buffer.rb
@@ -416,7 +415,6 @@ files:
 - spec/lib/protobuf/enum_spec.rb
 - spec/lib/protobuf/enum_value_spec.rb
 - spec/lib/protobuf/logger_spec.rb
-- spec/lib/protobuf/message/encoder_spec.rb
 - spec/lib/protobuf/message_spec.rb
 - spec/lib/protobuf/rpc/client_spec.rb
 - spec/lib/protobuf/rpc/connector_spec.rb
@@ -501,7 +499,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2306560722844978679
+      hash: 1889105763094487003
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -510,7 +508,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2306560722844978679
+      hash: 1889105763094487003
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/protobuf/message/encoder.rb

@@ -1,46 +0,0 @@
-require 'protobuf/wire_type'
-require 'protobuf/exceptions'
-
-module Protobuf
-
-  module Encoder
-
-    module_function
-
-    # Encode +message+ and write to +stream+.
-    def encode(stream, message)
-      # FIXME make this not as ghetto
-      unless message.initialized?
-        raise NotInitializedError, "Message #{message.class.name} is not initialized (one or more fields is improperly set): #{JSON.parse(message.to_json)}"
-      end
-
-      message.each_field_for_serialization do |field, value|
-        if field.repeated?
-          if field.packed?
-            key = (field.tag << 3) | WireType::LENGTH_DELIMITED
-            packed_value = value.map {|val| field.encode(val) }.join
-            stream.write(Field::VarintField.encode(key))
-            stream.write(Field::VarintField.encode(packed_value.size))
-            stream.write(packed_value)
-          else
-            value.each do |val|
-              write_pair(stream, field, val)
-            end
-          end
-        else
-          write_pair(stream, field, value)
-        end
-      end
-    end
-
-    # Encode key and value, and write to +stream+.
-    def write_pair(stream, field, value)
-      key = (field.tag << 3) | field.wire_type
-      key_bytes = Field::VarintField.encode(key)
-      stream.write(key_bytes)
-      bytes = field.encode(value)
-      stream.write(bytes)
-    end
-
-  end
-end

data/spec/lib/protobuf/message/encoder_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-class EncoderTest
-  extend ::Protobuf::Encoder
-end
-
-describe Protobuf::Encoder do
-  describe '#encode' do
-    context "when there's no value for a required field" do
-      let(:message) { ::Test::Resource.new }
-      let(:stream) { StringIO.new }
-      it "raises a 'message not initialized' error" do
-        expect {
-          EncoderTest.__send__(:encode, stream, message)
-        }.to raise_error(Protobuf::NotInitializedError, /message.*not initialized/i)
-      end
-    end
-  end
-end