protobuf 2.4.2-java → 2.4.3-java

data/lib/protobuf/field/base_field.rb

@@ -4,6 +4,15 @@ require 'protobuf/field/field_array'
 module Protobuf
   module Field
     class BaseField
+      ##
+      # Constants
+      #
+      PACKED_TYPES = [
+        ::Protobuf::WireType::VARINT,
+        ::Protobuf::WireType::FIXED32,
+        ::Protobuf::WireType::FIXED64
+      ].freeze
+
       ##
       # Attributes
       #
@@ -29,24 +38,11 @@ module Protobuf
         @extension = options.delete(:extension)
         @packed    = repeated? && options.delete(:packed)
         @deprecated = options.delete(:deprecated)
-        unless options.empty?
-          warn "WARNING: Invalid options: #{options.inspect} (in #{@message_class.name.split('::').last}.#{@name})"
-        end
-
-        if packed? && ! [WireType::VARINT, WireType::FIXED32, WireType::FIXED64].include?(wire_type)
-          raise "Can't use packed encoding for `#{@type}' type"
-        end
-
-        @default_value = \
-          case @rule
-          when :repeated then
-            ::Protobuf::Field::FieldArray.new(self).freeze
-          when :required then
-            nil
-          when :optional then
-            typed_default_value
-          end
 
+        set_rule_predicates
+        set_default_value
+        warn_excess_options(options) unless options.empty?
+        validate_packed_field if packed?
         define_accessor
       end
 
@@ -58,13 +54,11 @@ module Protobuf
       end
 
       def enum?
-        return @_enum unless @_enum.nil?
-        @_enum = (self.class < ::Protobuf::Field::EnumField)
+        false
       end
 
       def message?
-        return @_message unless @_message.nil?
-        @_message = (self.class < ::Protobuf::Field::MessageField)
+        false
       end
 
       # Decode +bytes+ and pass to +message_instance+.
@@ -103,25 +97,22 @@ module Protobuf
       end
 
       def extension?
-        !!@extension
+        !! @extension
       end
 
       # Is this a repeated field?
       def repeated?
-        return @_repeated unless @_repeated.nil?
-        @_repeated = (@rule == :repeated)
+        !! @repeated
       end
 
       # Is this a required field?
       def required?
-        return @_required unless @_required.nil?
-        @_required = (@rule == :required)
+        !! @required
       end
 
       # Is this a optional field?
       def optional?
-        return @_optional unless @_optional.nil?
-        @_optional = (@rule == :optional)
+        !! @optional
       end
 
       # Is this a deprecated field?
@@ -184,8 +175,9 @@ module Protobuf
         @message_class.class_eval do
           define_method(field.setter_method_name) do |val|
             field.warn_if_deprecated
+            val.compact! if val.respond_to?(:compact!)
 
-            if val.nil?
+            if val.nil? || (val.respond_to?(:empty?) && val.empty?)
               @values.delete(field.name)
             else
               @values[field.name] ||= ::Protobuf::Field::FieldArray.new(field)
@@ -211,7 +203,7 @@ module Protobuf
           define_method(field.setter_method_name) do |val|
             field.warn_if_deprecated
 
-            if val.nil?
+            if val.nil? || (val.respond_to?(:empty?) && val.empty?)
               @values.delete(field.name)
             elsif field.acceptable?(val)
               @values[field.name] = val
@@ -222,6 +214,28 @@ module Protobuf
         end
       end
 
+      def set_default_value
+        @default_value = case 
+                         when repeated? then ::Protobuf::Field::FieldArray.new(self).freeze
+                         when required? then nil
+                         when optional? then typed_default_value
+                         end
+      end
+
+      def set_rule_predicates
+        case @rule
+        when :repeated then
+          @required = @optional = false
+          @repeated = true
+        when :required then
+          @repeated = @optional = false
+          @required = true
+        when :optional then
+          @repeated = @required = false
+          @optional = true
+        end
+      end
+
       def typed_default_value
         if @default.nil?
           self.class.default
@@ -230,6 +244,16 @@ module Protobuf
         end
       end
 
+      def validate_packed_field
+        if packed? && ! ::Protobuf::Field::BaseField::PACKED_TYPES.include?(wire_type)
+          raise "Can't use packed encoding for `#{@type}' type"
+        end
+      end
+
+      def warn_excess_options(options)
+        warn "WARNING: Invalid options: #{options.inspect} (in #{@message_class.name.split('::').last}.#{@name})"
+      end
+
     end
   end
 end

data/lib/protobuf/field/bytes_field.rb

@@ -1,14 +1,14 @@
+require 'protobuf/wire_type'
+
 module Protobuf
   module Field
     class BytesField < BaseField
+      BYTES_ENCODING = "ASCII-8BIT".freeze
+
       def self.default
         ''
       end
 
-      def wire_type
-        WireType::LENGTH_DELIMITED
-      end
-
       def acceptable?(val)
         if val.nil? || val.is_a?(::Protobuf::Message) || val.instance_of?(String)
           return true
@@ -18,20 +18,21 @@ module Protobuf
       end
 
       def decode(bytes)
-        bytes.force_encoding(::Protobuf::Message::STRING_ENCODING) if bytes.respond_to?(:force_encoding)
+        bytes.force_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING) 
         bytes
       end
 
       def encode(value)
-        if value.is_a?(::Protobuf::Message)
-          value = value.serialize_to_string
-        else
-          value.force_encoding(::Protobuf::Message::STRING_ENCODING) if value.respond_to?(:force_encoding)
-        end
+        value = value.serialize_to_string if value.is_a?(::Protobuf::Message)
+        value.force_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING) 
 
-        string_size = VarintField.encode(value.size)
+        string_size = ::Protobuf::Field::VarintField.encode(value.size)
         string_size << value
       end
+
+      def wire_type
+        ::Protobuf::WireType::LENGTH_DELIMITED
+      end
     end
   end
 end

data/lib/protobuf/field/enum_field.rb

@@ -19,6 +19,10 @@ module Protobuf
         super(value.to_i)
       end
 
+      def enum?
+        true
+      end
+
       private
 
       def typed_default_value

data/lib/protobuf/field/field_array.rb

@@ -28,7 +28,7 @@ module Protobuf
       end
 
       def replace(val)
-        raise TypeError unless val.is_a?(Array)
+        raise_type_error(val) unless val.is_a?(Array)
         val = val.map { |v| normalize(v) }
         super(val)
       end
@@ -60,6 +60,15 @@ module Protobuf
           value
         end
       end
+
+      def raise_type_error(val)
+        error_text = <<-TYPE_ERROR
+          Expected value of type '#{@field.type}'
+          Got '#{val.class}' for protobuf field #{@field.name}
+        TYPE_ERROR
+
+        raise TypeError, error_text
+      end
     end
   end
 end

data/lib/protobuf/field/message_field.rb

@@ -21,10 +21,14 @@ module Protobuf
       
       def encode(value)
         bytes = value.serialize_to_string
-        result = VarintField.encode(bytes.size)
+        result = ::Protobuf::Field::VarintField.encode(bytes.size)
         result << bytes
       end
 
+      def message?
+        true
+      end
+
       def wire_type
         ::Protobuf::WireType::LENGTH_DELIMITED
       end

data/lib/protobuf/field/string_field.rb

@@ -6,9 +6,15 @@ module Protobuf
       ENCODING = 'UTF-8'.freeze
 
       def decode(bytes)
-        bytes.force_encoding(::Protobuf::Field::StringField::ENCODING) if bytes.respond_to?(:force_encoding)
+        bytes.force_encoding(::Protobuf::Field::StringField::ENCODING) 
         bytes
       end
+
+      def encode(value)
+        value.force_encoding(::Protobuf::Field::StringField::ENCODING) 
+        string_size = ::Protobuf::Field::VarintField.encode(value.size)
+        string_size << value
+      end
     end
   end
 end

data/lib/protobuf/field/varint_field.rb

@@ -49,7 +49,15 @@ module Protobuf
       end
 
       def encode(value)
-        self.class.encode(value)
+        return [value].pack('C') if value < 128
+
+        bytes = []
+        until value == 0
+          bytes << (0x80 | (value & 0x7f))
+          value >>= 7
+        end
+        bytes[-1] &= 0x7f
+        bytes.pack('C*')
       end
 
       def wire_type

data/lib/protobuf/message.rb

@@ -6,10 +6,6 @@ require 'protobuf/message/decoder'
 
 module Protobuf
   class Message
-    ##
-    # Constants
-    #
-    STRING_ENCODING = "ASCII-8BIT".freeze
 
     ##
     # Class Methods
@@ -129,7 +125,7 @@ module Protobuf
 
     def clear!
       @values.delete_if do |_, value|
-        if value.is_a?(Field::FieldArray)
+        if value.is_a?(::Protobuf::Field::FieldArray)
           value.clear
           false
         else
@@ -160,7 +156,7 @@ module Protobuf
 
     def each_field_for_serialization
       all_fields.each do |field|
-        next unless _field_must_be_serialized?(field)
+        next unless __field_must_be_serialized__?(field)
 
         value = @values[field.name]
 
@@ -225,15 +221,17 @@ module Protobuf
         (self.__send__(key).present? || [true, false].include?(self.__send__(key)))
     end
 
-    def serialize_to(stream)
+    def serialize_to_string
+      stream = ""
+
       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)
+            stream << ::Protobuf::Field::VarintField.encode(key)
+            stream << ::Protobuf::Field::VarintField.encode(packed_value.size)
+            stream << packed_value
           else
             value.each { |val| write_pair(stream, field, val) }
           end
@@ -241,14 +239,8 @@ module Protobuf
           write_pair(stream, field, value)
         end
       end
-    end
 
-    def serialize_to_string(string = '')
-      io = StringIO.new(string)
-      serialize_to(io)
-      result = io.string
-      result.force_encoding(::Protobuf::Message::STRING_ENCODING) if result.respond_to?(:force_encoding)
-      result
+      return stream
     end
 
     def set_field(tag, bytes)
@@ -273,6 +265,10 @@ module Protobuf
       to_hash.to_json
     end
 
+    def to_proto
+      self
+    end
+
     def ==(obj)
       return false unless obj.is_a?(self.class)
       each_field do |field, value|
@@ -301,6 +297,7 @@ module Protobuf
     # Instance Aliases
     #
     alias_method :to_hash_value, :to_hash
+    alias_method :to_proto_hash, :to_hash
     alias_method :to_s, :serialize_to_string
     alias_method :bytes, :serialize_to_string
     alias_method :serialize, :serialize_to_string
@@ -329,7 +326,7 @@ module Protobuf
 
       object.__send__(:initialize)
       @values.each do |name, value|
-        if value.is_a?(Field::FieldArray)
+        if value.is_a?(::Protobuf::Field::FieldArray)
           object.__send__(name).replace(value.map {|v| duplicate.call(v)})
         else
           object.__send__("#{name}=", duplicate.call(value))
@@ -338,24 +335,20 @@ module Protobuf
       object
     end
 
-    def _field_must_be_serialized?(field)
-      return true if field.required?
-
-      if field.repeated? && has_field?(field.name)
-        @values[field.name].compact!
-        @values.delete(field.name) if @values[field.name].empty?
-      end
+    def __field_must_be_serialized__?(field)
+      field.required? || __field_value_is_present__?(field)
+    end
 
-      return has_field?(field.name)
+    def __field_value_is_present__?(field)
+      value = @values[field.name]
+      !value.nil? && (value.present? || [true, false].include?(value))
     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)
+      stream << ::Protobuf::Field::VarintField.encode(key)
+      stream << field.encode(value)
     end
 
   end

data/lib/protobuf/message/decoder.rb

@@ -43,10 +43,9 @@ module Protobuf
 
     # Read varint integer value from +stream+.
     def read_varint(stream)
-      read_method = stream.respond_to?(:readbyte) ? :readbyte : :readchar
       value = index = 0
       begin
-        byte = stream.__send__(read_method)
+        byte = stream.readbyte
         value |= (byte & 0x7f) << (7 * index)
         index += 1
       end while (byte & 0x80).nonzero?

data/lib/protobuf/rpc/buffer.rb

@@ -44,7 +44,7 @@ module Protobuf
       end
 
       def set_data(data)
-        @data = data.is_a?(::Protobuf::Message) ? data.serialize_to_string : data.to_s
+        @data = data.to_s
         @size = @data.size
       end
 

data/lib/protobuf/rpc/client.rb

@@ -10,7 +10,7 @@ module Protobuf
       extend Forwardable
       include Protobuf::Logger::LogMethods
 
-      delegate [:options, :complete_cb, :success_cb, :failure_cb] => :@connector
+      def_delegators :@connector, :options, :complete_cb, :success_cb, :failure_cb
       attr_reader :connector
 
       # Create a new client with default options (defined in ClientConnection)

data/lib/protobuf/rpc/connectors/common.rb

@@ -104,10 +104,10 @@ module Protobuf
         def rpc_request_data
           validate_request_type
 
-          return Protobuf::Socketrpc::Request.new(
+          return ::Protobuf::Socketrpc::Request.new(
             :service_name => @options[:service].name,
             :method_name => @options[:method].to_s,
-            :request_proto => @options[:request].serialize_to_string
+            :request_proto => @options[:request]
           ).serialize_to_string
         rescue => e
           fail(:INVALID_REQUEST_PROTO, "Could not set request proto: #{e.message}")

data/lib/protobuf/rpc/server.rb

@@ -86,4 +86,3 @@ module Protobuf
     end
   end
 end
-

data/lib/protobuf/rpc/servers/socket/server.rb

@@ -9,7 +9,7 @@ module Protobuf
         include ::Protobuf::Rpc::Server
         include ::Protobuf::Logger::LogMethods
 
-        AUTO_COLLECT_TIMEOUT = 20 # seconds
+        AUTO_COLLECT_TIMEOUT = 5 # seconds
 
         def self.cleanup?
           # every 10 connections run a cleanup routine after closing the response

data/lib/protobuf/rpc/servers/zmq/worker.rb

@@ -49,7 +49,7 @@ module Protobuf
         end
 
         def send_data
-          response_data = @response.is_a?(::Protobuf::Message) ? @response.serialize_to_string : @response.to_s
+          response_data = @response.to_s # to_s is aliases as serialize_to_string in Message
           @stats.response_size = response_data.size
           zmq_error_check(@socket.send_string(response_data))
         end

data/lib/protobuf/version.rb

@@ -1,4 +1,4 @@
 module Protobuf
-  VERSION = '2.4.2'
+  VERSION = '2.4.3'
   PROTOC_VERSION = '2.4.1'
 end

data/spec/benchmark/tasks.rb

@@ -140,6 +140,17 @@ namespace :benchmark do
     puts args[:profile_output]
   end
 
+  desc "benchmark Protobuf Message #serialize"
+  task :profile_protobuf_serialize, [:number, :profile_output] do |t, args|
+    args.with_defaults(:number => 1000, :profile_output => "/tmp/profiler_new_#{Time.now.to_i}")
+    create_params = { :name => "The name that we set", :date_created => Time.now.to_i, :status => 2 }
+    ::PerfTools::CpuProfiler.start(args[:profile_output]) do
+      args[:number].to_i.times { Test::Resource.new(create_params).serialize }
+    end
+
+    puts args[:profile_output]
+  end
+
   desc "benchmark EventMachine client with EventMachine server"
   task :em_client_em_server, [:number, :length] do |t, args|
     args.with_defaults(:number => 1000, :length => 100)

data/spec/lib/protobuf/message_spec.rb

@@ -23,25 +23,34 @@ describe Protobuf::Message 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 {
-          message.serialize_to(stream)
+          message.serialize_to_string
         }.to raise_error(Protobuf::SerializationError, /required/i)
       end
     end
 
     context "repeated fields" do 
       let(:message) { ::Test::Resource.new(:name => "something") }
-      let(:stream) { StringIO.new }
 
       it "does not raise an error when repeated fields are []" do
         expect {
           message.repeated_enum = []
-          message.serialize_to(stream)
+          message.serialize_to_string
         }.to_not raise_error
       end
+
+      it "sets the value to nil when empty array is passed" do 
+        message.repeated_enum = []
+        message.instance_variable_get("@values")[:repeated_enum].should be_nil
+      end
+
+      it "raises TypeError when a non-array replaces it" do 
+        expect {
+          message.repeated_enum = 2
+        }.to raise_error(/value of type/)
+      end
     end
   end
 

data/spec/lib/protobuf/rpc/client_spec.rb

@@ -9,7 +9,7 @@ describe Protobuf::Rpc::Client do
   context "when using fiber based calls" do
     it "waits for response" do
       EventMachine.fiber_run do
-        StubServer.new(:delay => 3) do |server|
+        StubServer.new(:delay => 1) do |server|
           client = Test::ResourceService.client
           start = now
 

metadata

@@ -2,7 +2,7 @@
 name: protobuf
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.4.2
+  version: 2.4.3
 platform: java
 authors: 
   - BJ Neilsen
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-16 00:00:00 Z
+date: 2012-11-17 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: activesupport
@@ -305,7 +305,6 @@ files:
   - lib/protobuf/logger.rb
   - lib/protobuf/message.rb
   - lib/protobuf/message/decoder.rb
-  - lib/protobuf/message/extend.rb
   - lib/protobuf/message/message.rb
   - lib/protobuf/rpc/buffer.rb
   - lib/protobuf/rpc/client.rb

data/lib/protobuf/message/extend.rb

@@ -1,8 +0,0 @@
-require 'protobuf/message/message'
-
-module Protobuf
-  class Extend < Message
-    MIN = -1.0/0
-    MAX = 1.0/0
-  end
-end