protobuf 1.3.0 → 1.4.0

data/.gitignore

@@ -9,3 +9,4 @@ doc
 .yardoc
 .DS_Store
 *.bin
+Gemfile.lock

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    protobuf (1.3.0)
+    protobuf (1.4.0)
       eventmachine
       eventually
       ffi-rzmq
@@ -10,46 +10,39 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    coderay (1.0.5)
+    coderay (1.0.7)
     diff-lcs (1.1.3)
-    eventmachine (0.12.10)
+    eventmachine (1.0.0)
     eventually (0.1.1)
-    ffi (1.0.11)
-    ffi-rzmq (0.9.3)
+    ffi (1.1.5)
+    ffi-rzmq (0.9.6)
       ffi
-    json_pure (1.7.3)
-    method_source (0.7.1)
-    multi_json (1.2.0)
-    pry (0.9.8.4)
+    json_pure (1.7.5)
+    method_source (0.8)
+    multi_json (1.3.6)
+    pry (0.9.10)
       coderay (~> 1.0.5)
-      method_source (~> 0.7.1)
-      slop (>= 2.4.4, < 3)
-    pry (0.9.8.4-java)
-      coderay (~> 1.0.5)
-      method_source (~> 0.7.1)
-      slop (>= 2.4.4, < 3)
-      spoon (~> 0.0)
-    pry-nav (0.2.0)
-      pry (~> 0.9.8.1)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    pry-nav (0.2.2)
+      pry (~> 0.9.10)
     rake (0.9.2.2)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    simplecov (0.6.1)
+    rspec-mocks (2.11.2)
+    simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    slop (2.4.4)
-    spoon (0.0.1)
-    yard (0.7.5)
+    slop (3.3.3)
+    yard (0.8.2.1)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/bin/rpc_server

@@ -12,6 +12,8 @@ require 'protobuf/rpc/servers/zmq_runner'
 server = OpenStruct.new({
   :app => nil,
   :env => ENV['RPC_SERVER_ENV'] || 'development',
+  :gc_pause_during_request => false,
+  :gc_pause_during_serialization => false,
   :host => '127.0.0.1',
   :port => 9595,
   :backlog => 100,
@@ -76,6 +78,14 @@ parser = OptionParser.new do |opts|
 
     server.runner = ::Protobuf::Rpc::ZmqRunner
   end
+
+  opts.on("--[no-]gc-pause-request", "Enable/Disable GC pause during request.") do |v|
+    server.gc_pause_during_request = v
+  end
+
+  opts.on("--[no-]gc-pause-serialization", "Enable/Disable GC pause during serialization.") do |v|
+    server.gc_pause_during_serialization = v
+  end
   
   opts.on("-d", "--[no-]debug", "Debug Mode. Override log level to DEBUG.") do |v|
     server.debug = v
@@ -120,6 +130,13 @@ elsif(ENV['PB_SERVER_TYPE'] =~ /socket/i)
   server.runner = ::Protobuf::Rpc::SocketRunner
 end
 
+##
+# Setup GC settings
+# 
+::Protobuf::Rpc::GC_PAUSE_REQUEST = server.gc_pause_during_request
+# If we pause during request we don't need to pause in serialization
+::Protobuf::Rpc::GC_PAUSE_SERIALIZATION = (!server.gc_pause_during_request && server.gc_pause_during_serialization)
+
 # protobuf.rb picks up PB_CLIENT_TYPE and PB_SERVER_TYPE and does something
 # useful with them
 require 'protobuf'
@@ -141,11 +158,11 @@ begin
   end
 
   # Configure the ::Protobuf::Logger
-  ::Protobuf::Logger.configure :file => server.log, :level => server.debug ? ::Logger::DEBUG : server.level
+  ::Protobuf::Logger.configure(:file => server.log, :level => server.debug ? ::Logger::DEBUG : server.level)
 
   # Output the server opts
-  ::Protobuf::Logger.debug 'Debugging options:'
-  ::Protobuf::Logger.debug server.inspect
+  ::Protobuf::Logger.debug { 'Debugging options:' }
+  ::Protobuf::Logger.debug { server.inspect }
   
   # Set the name of the process
   $0 = 'rpc_server %s:%d %s' % [server.host, server.port, server.app]
@@ -156,8 +173,8 @@ begin
   server.runner.run(server)
 rescue
   msg = 'ERROR: RPC Server failed to start. %s' % $!.inspect
-  $stderr.puts msg, *($!.backtrace)
-  ::Protobuf::Logger.error msg
-  ::Protobuf::Logger.error $!.backtrace.join("\n")
+  $stderr.puts(msg, *($!.backtrace))
+  ::Protobuf::Logger.error { msg }
+  ::Protobuf::Logger.error { $!.backtrace.join("\n") }
   exit 1
 end

data/lib/protobuf/message/enum.rb

@@ -4,7 +4,7 @@ require 'protobuf/message/protoable'
 
 module Protobuf
   class Enum
-    class <<self
+    class << self
       include Protoable
 
       attr_reader :values

data/lib/protobuf/message/field.rb

@@ -120,28 +120,26 @@ module Protobuf
         raise NotImplementedError, "#{self.class.name}\#encode"
       end
 
-      # Merge +value+ with +message_instance+.
-      def merge(message_instance, value)
-        if repeated?
-          merge_array(message_instance, value)
-        else
-          merge_value(message_instance, value)
-        end
+      def extension?
+        !!@extension
       end
 
       # Is this a repeated field?
       def repeated?
-        @rule == :repeated
+        return @_repeated unless @_repeated.nil?
+        @_repeated = (@rule == :repeated)
       end
 
       # Is this a required field?
       def required?
-        @rule == :required
+        return @_required unless @_required.nil?
+        @_required = (@rule == :required)
       end
 
       # Is this a optional field?
       def optional?
-        @rule == :optional
+        return @_optional unless @_optional.nil?
+        @_optional = (@rule == :optional)
       end
 
       # Is this a packed repeated field?
@@ -183,11 +181,12 @@ module Protobuf
         field = self
         @message_class.class_eval do
           define_method(field.name) do
-            if @values.has_key?(field.name)
-              @values[field.name]
-            else
-              field.default_value
-            end
+            @values[field.name] || field.default_value
+#            if @values.has_key?(field.name)
+#              @values[field.name]
+#            else
+#              field.default_value
+#            end
           end
         end
       end
@@ -214,14 +213,6 @@ module Protobuf
         end
       end
 
-      def merge_array(message_instance, value)
-        message_instance.__send__(@name).concat(value)
-      end
-
-      def merge_value(message_instance, value)
-        message_instance.__send__("#{@name}=", value)
-      end
-
       def typed_default_value
         if @default.nil?
           self.class.default
@@ -365,7 +356,7 @@ module Protobuf
       UINT32_MAX =  2**32 - 1
       UINT64_MAX =  2**64 - 1
 
-      class <<self
+      class << self
         def default
           0
         end
@@ -638,9 +629,6 @@ module Protobuf
         end
       end
 
-      def merge_value(message_instance, value)
-        message_instance.__send__(@name).merge_from(value)
-      end
     end
 
 

data/lib/protobuf/message/message.rb

@@ -28,6 +28,14 @@ module Protobuf
     class << self
       include Protoable
 
+      def all_fields
+        @all_fields ||= begin
+            fields_hash = fields.merge(extension_fields)
+            ordered_keys = fields_hash.keys.sort
+            ordered_keys.map { |key| fields_hash[key] }
+          end
+      end
+
       # Reserve field numbers for extensions. Don't use this method directly.
       def extensions(range)
         @extension_fields = ExtensionFields.new(range)
@@ -48,33 +56,58 @@ module Protobuf
         define_field(:repeated, type, name, tag, options)
       end
 
+      def descriptor
+        @descriptor ||= Descriptor::Descriptor.new(self)
+      end
+
       # Define a field. Don't use this method directly.
       def define_field(rule, type, fname, tag, options)
         field_hash = options[:extension] ? extension_fields : fields
+        field_name_hash = options[:extension] ? extension_fields_by_name : fields_by_name
+
         if field_hash.keys.include?(tag)
           raise TagCollisionError, %!{Field number #{tag} has already been used in "#{self.name}" by field "#{fname}".!
         end
-        field_hash[tag] = Field.build(self, rule, type, fname, tag, options)
+
+        field_definition = Field.build(self, rule, type, fname, tag, options)
+        field_name_hash[fname.to_sym] = field_definition
+        field_hash[tag] = field_definition
       end
 
       def extension_tag?(tag)
         extension_fields.include_tag?(tag)
       end
+      
+      # An extension field object.
+      def extension_fields
+        @extension_fields ||= ExtensionFields.new
+      end
+
+      def extension_fields_by_name
+        @extension_fields_by_name ||= {}
+      end
 
       # A collection of field object.
       def fields
         @fields ||= {}
       end
 
-      # An extension field object.
-      def extension_fields
-        @extension_fields ||= ExtensionFields.new
+      def fields_by_name
+        @field_by_name ||= {}
+      end
+
+      def repeated_fields
+        @repeated_fields ||= []
+      end
+
+      def repeated_extension_fields
+        @repeated_extension_fields ||= []
       end
 
       # Find a field object by +name+.
       def get_field_by_name(name)
-        name = name.to_sym
-        fields.values.find {|field| field.name == name}
+        # Check if the name has been used before, if not then set it to the sym value
+        fields_by_name[name] ||= fields_by_name[name.to_sym]
       end
 
       # Find a field object by +tag+ number.
@@ -82,9 +115,13 @@ module Protobuf
         fields[tag]
       end
 
+      def field_cache
+        @field_cache ||= {}
+      end
+
       # Find a field object by +tag_or_name+.
       def get_field(tag_or_name)
-        case tag_or_name
+        field_cache[tag_or_name] ||= case tag_or_name
         when Integer        then get_field_by_tag(tag_or_name)
         when String, Symbol then get_field_by_name(tag_or_name)
         else                     raise TypeError, tag_or_name.class
@@ -93,8 +130,8 @@ module Protobuf
 
       #TODO merge to get_field_by_name
       def get_ext_field_by_name(name)
-        name = name.to_sym
-        extension_fields.values.find {|field| field.name == name}
+        # Check if the name has been used before, if not then set it to the sym value
+        extension_fields_by_name[name] ||= extension_fields_by_name[name.to_sym]
       end
 
       #TODO merge to get_field_by_tag
@@ -111,36 +148,68 @@ module Protobuf
         end
       end
 
-      def descriptor
-        @descriptor ||= Descriptor::Descriptor.new(self)
+      def initialize_unready_fields
+        unless @unready_initialized
+          initialize_type_fields
+          initialize_type_extension_fields
+          @unready_initialized = true
+        end
+      end
+
+      def initialize_type_fields
+        fields.each do |tag, field|
+          unless field.ready?
+            field = field.setup
+            fields[tag] = field
+            fields_by_name[field.name.to_sym] = field
+            fields_by_name[field.name] = field
+          end
+        end
+      end
+
+      def initialize_type_extension_fields
+        extension_fields.each do |tag, field|
+          unless field.ready?
+            field = field.setup
+            extension_fields[tag] = field
+            extension_fields_by_name[field.name.to_sym] = field
+            extension_fields_by_name[field.name] = field
+          end
+        end
+      end
+
+      def setup_repeated_field_arrays
+        unless @repeated_fields_setup
+          all_fields.each do |field|
+            next unless field.repeated?
+
+            if field.extension?
+              repeated_extension_fields << field
+            else
+              repeated_fields << field
+            end
+          end
+
+          @repeated_fields_setup = true
+        end
       end
     end
 
     def initialize(values={})
       @values = {}
 
-      self.class.fields.each do |tag, field|
-        unless field.ready?
-          field = field.setup
-          self.class.class_eval {@fields[tag] = field}
-        end
-        if field.repeated?
-          @values[field.name] = Field::FieldArray.new(field)
-        end
+      self.class.initialize_unready_fields
+      self.class.setup_repeated_field_arrays
+
+      self.class.repeated_fields.each do |field|
+        @values[field.name] = Field::FieldArray.new(field)
       end
 
-      # TODO
-      self.class.extension_fields.each do |tag, field|
-        unless field.ready?
-          field = field.setup
-          self.class.class_eval {@extension_fields[tag] = field}
-        end
-        if field.repeated?
-          @values[field.name] = Field::FieldArray.new(field)
-        end
+      self.class.repeated_extension_fields.each do |field|
+        @values[field.name] = Field::FieldArray.new(field)
       end
 
-      values.each {|tag, val| self[tag] = val}
+      values.each { |tag, val| self[tag] = val}
     end
 
     def initialized?
@@ -205,7 +274,7 @@ module Protobuf
     def inspect(indent=0)
       result = []
       i = '  ' * indent
-      field_value_to_string = lambda {|field, value|
+      field_value_to_string = lambda { |field, value|
         result << \
           if field.optional? && ! has_field?(field.name)
             ''
@@ -281,22 +350,11 @@ module Protobuf
       Encoder.encode(stream, self)
     end
 
-    def merge_from(message)
-      # TODO
-      fields.each {|tag, field| merge_field(tag, message.__send__(field.name))}
-      extension_fields.each {|tag, field| merge_field(tag, message.__send__(field.name))}
-    end
-
     def set_field(tag, bytes)
       field = (get_field_by_tag(tag) || get_ext_field_by_tag(tag))
       field.set(self, bytes) if field
     end
 
-    def merge_field(tag, value)
-      #get_field_by_tag(tag).merge self, bytes #TODO
-      (get_field_by_tag(tag) || get_ext_field_by_tag(tag)).merge(self, value)
-    end
-
     def [](tag_or_name)
       if field = get_field(tag_or_name) || get_ext_field(tag_or_name)
         __send__(field.name)
@@ -314,8 +372,12 @@ module Protobuf
     end
 
     # Returns a hash; which key is a tag number, and value is a field object.
+    def all_fields
+      @_all_fields ||= self.class.all_fields
+    end
+
     def fields
-      self.class.fields
+      @_fields ||= self.class.fields
     end
 
     # Returns field object or +nil+.
@@ -355,7 +417,7 @@ module Protobuf
     #     # do something
     #   end
     def each_field
-      fields.merge(extension_fields).sort_by {|tag, _| tag}.each do |_, field|
+      all_fields.each do |field|
         value = __send__(field.name)
         yield(field, value)
       end
@@ -363,7 +425,7 @@ module Protobuf
     
     def to_hash
       result = {}
-      build_value = lambda {|field, value|
+      build_value = lambda { |field, value|
         if !field.optional? || (field.optional? && has_field?(field.name))
           case field
           when Field::MessageField then

data/lib/protobuf/rpc/server.rb

@@ -8,6 +8,16 @@ module Protobuf
   module Rpc
     module Server
 
+      def _gc_pause_request
+        return @_gc_pause_request unless @_gc_pause_request.nil?
+        @_gc_pause_request ||= (defined?(::Protobuf::Rpc::GC_PAUSE_REQUEST) && ::Protobuf::Rpc::GC_PAUSE_REQUEST)
+      end
+
+      def _gc_pause_serialization
+        return @_gc_pause_serialization unless @_gc_pause_serialization.nil?
+        @_gc_pause_serialization ||= (defined?(::Protobuf::Rpc::GC_PAUSE_SERIALIZATION) && ::Protobuf::Rpc::GC_PAUSE_SERIALIZATION)
+      end
+
       # Invoke the service method dictated by the proto wrapper request object
       def handle_client
         # Parse the protobuf request from the socket
@@ -20,6 +30,7 @@ module Protobuf
 
         # Call the service method
         log_debug { "[#{log_signature}] Dispatching client request to service" }
+        GC.disable if _gc_pause_request 
         invoke_rpc_method
       rescue => error
         # Ensure we're handling any errors that try to slip out the back door
@@ -132,13 +143,18 @@ module Protobuf
         @stats.end
         @stats.log_stats
         @did_respond = true
+      ensure
+        GC.enable if _gc_pause_request 
       end
 
       def serialize_response(response)
+        GC.disable if _gc_pause_serialization 
         log_debug { "[#{log_signature}] serializing response: %s" % response.inspect }
         @response.response_proto = response.serialize_to_string
       rescue
         raise BadResponseProto, $!.message
+      ensure
+        GC.enable if _gc_pause_serialization
       end
     end
   end

data/lib/protobuf/rpc/servers/socket_runner.rb

@@ -3,12 +3,12 @@ module Protobuf
     class SocketRunner 
 
       def self.stop
-        Protobuf::Rpc::Socket::Server.stop 
-        Protobuf::Logger.info 'Shutdown complete'
+        ::Protobuf::Rpc::Socket::Server.stop 
+        ::Protobuf::Logger.info { 'Shutdown complete' }
       end
 
       def self.run(server)
-        Protobuf::Logger.info "Socket::Server Running"
+        ::Protobuf::Logger.info { "Socket::Server Running" }
         server_config = case 
                         when server.is_a?(OpenStruct) then 
                           server.marshal_dump
@@ -20,9 +20,9 @@ module Protobuf
                           raise "Cannot parser Socket Server - server options"
                         end
 
-        Protobuf::Rpc::Socket::Server.run(server_config)
+        ::Protobuf::Rpc::Socket::Server.run(server_config)
       end
-    end
 
+    end
   end
 end

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

@@ -12,7 +12,6 @@ module Protobuf
         # Constructor
         #
         def initialize(opts={})
-
           @options = opts
           host = @options.fetch(:host, "127.0.0.1")
           port = @options.fetch(:port, 9400)
@@ -60,7 +59,7 @@ module Protobuf
         end
 
         def send_data
-          response_data = @response.is_a?(Protobuf::Message) ? @response.serialize_to_string : @response.to_s
+          response_data = @response.is_a?(::Protobuf::Message) ? @response.serialize_to_string : @response.to_s
           @stats.response_size = response_data.size
           zmq_error_check(@socket.send_string(response_data))
           @did_respond = true

data/lib/protobuf/version.rb

@@ -1,3 +1,3 @@
 module Protobuf
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/spec/unit/common/logger_spec.rb

@@ -76,7 +76,7 @@ describe Protobuf::Logger do
         subject.fatal 'No errors here'
         subject.add 'No errors here'
         subject.log 'No errors here'
-      }.should_not raise_error
+      }.to_not raise_error
     end
     
     it 'logs correctly when instance is valid' do
@@ -118,4 +118,4 @@ describe Protobuf::Logger do
     
   end
   
-end
+end

data/spec/unit/rpc/client_spec.rb

@@ -161,7 +161,7 @@ describe Protobuf::Rpc::Client do
     it 'should respond to defined service methods' do
       client = Spec::Proto::TestService.client
       client.should_receive(:send_request).and_return(nil)
-      expect { client.find(nil) }.should_not raise_error
+      expect { client.find(nil) }.to_not raise_error
     end
 
     it 'raises a NameError when accessing a var that does not exist' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000Z
+date: 2012-09-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2160220480 !ruby/object:Gem::Requirement
+  requirement: &2161594760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160220480
+  version_requirements: *2161594760
 - !ruby/object:Gem::Dependency
   name: eventually
-  requirement: &2160220060 !ruby/object:Gem::Requirement
+  requirement: &2161594340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160220060
+  version_requirements: *2161594340
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &2160219640 !ruby/object:Gem::Requirement
+  requirement: &2161593920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160219640
+  version_requirements: *2161593920
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
-  requirement: &2160219220 !ruby/object:Gem::Requirement
+  requirement: &2161593500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160219220
+  version_requirements: *2161593500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160218800 !ruby/object:Gem::Requirement
+  requirement: &2161593080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160218800
+  version_requirements: *2161593080
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2160218380 !ruby/object:Gem::Requirement
+  requirement: &2161592660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160218380
+  version_requirements: *2161592660
 - !ruby/object:Gem::Dependency
   name: pry-nav
-  requirement: &2160217960 !ruby/object:Gem::Requirement
+  requirement: &2161592240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160217960
+  version_requirements: *2161592240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160217540 !ruby/object:Gem::Requirement
+  requirement: &2161591820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160217540
+  version_requirements: *2161591820
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2160217120 !ruby/object:Gem::Requirement
+  requirement: &2161591400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160217120
+  version_requirements: *2161591400
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2160216700 !ruby/object:Gem::Requirement
+  requirement: &2161590980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,7 +121,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160216700
+  version_requirements: *2161590980
 description: ! 'Ruby implementation for Protocol Buffers. Works with other protobuf
   rpc implementations (e.g. Java, Python, C++).