protobuf 3.5.5 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37b8ae0a1e0e242f6e59627e2237e34e046e1ddc
-  data.tar.gz: 64fd74dede3374c1ca631e05f3cc9c2261e9f81d
+  metadata.gz: 465d9557f2fe2a77ba7cffce41ecd05e4b051dc0
+  data.tar.gz: ad19416fb9d66c5282e892d9a8f4da9f1a6df4c1
 SHA512:
-  metadata.gz: 83f929f8fd8a65cfd6e2e5c77218b96df98220335063847b2c1bb7cd1c0cd2207ddc4b0a06781f3a5f915fbe882e352961e04b6244cc7228b3947557a7230316
-  data.tar.gz: 4cbc7cc6f211c1290aa9b7ff3a7477f8d503e79cf8a4b6530eeb48a1390538897ee22390a9b0adcbe8b81fdcc652789795d2694a4a3675e063c7001dfbeca07d
+  metadata.gz: 929245c25d77547a57ad94ab417d2cc9f3d249574b1fd0187159f6a23604b3c73b5fb495baaf13fae798c570293d09612013f98ce1971da62e790d2ad4b897f7
+  data.tar.gz: 11dada3beee45ba720383766fffe623b1c5c910c0a688771d2d23840c51239d1c26cebb3af502a84cc568684444fad9c3c05679e9e743b0d84ed8577682e18b9

data/.travis.yml

@@ -2,6 +2,7 @@ before_install:
   - sudo apt-get update -qq
   - sudo apt-get install -y libzmq3-dev
   - sudo -E ./install-protobuf.sh
+  - gem update bundler
 language: ruby
 rvm:
   - 1.9.3

data/CHANGES.md

@@ -1,5 +1,21 @@
 # Stable (3.x)
 
+3.5.5
+--------
+- Add native Varint for MRI.
+
+3.5.4
+--------
+- Ensures ActiveSupport::Deprecation does not get a stack trace when deprecations are disabled.
+
+3.5.3
+--------
+- Optimized get_extension_field and get_field calls.
+
+3.5.2
+--------
+- Optimized valid_tag?, enums_for_tag and enums_for_tags
+
 3.5.1
 --------
 - Adds compatibility for Rails 4.2+ as CLI options were broken

data/lib/protobuf/cli.rb

@@ -39,7 +39,7 @@ module Protobuf
     option :broadcast_beacons,          :type => :boolean, :desc => 'Broadcast beacons for dynamic discovery (Currently only available with ZeroMQ).'
     option :broadcast_busy,             :type => :boolean, :default => false, :desc => 'Remove busy nodes from cluster when all workers are busy (Currently only available with ZeroMQ).'
     option :debug,                      :type => :boolean, :default => false, :aliases => %w(-d), :desc => 'Debug Mode. Override log level to DEBUG.'
-    option :gc_pause_request,           :type => :boolean, :default => false, :desc => 'Enable/Disable GC pause during request.'
+    option :gc_pause_request,           :type => :boolean, :default => false, :desc => 'DEPRECATED: Enable/Disable GC pause during request.'
     option :print_deprecation_warnings, :type => :boolean, :default => nil, :desc => 'Cause use of deprecated fields to be printed or ignored.'
     option :workers_only,               :type => :boolean, :default => false, :desc => "Starts process with only workers (no broker/frontend is started) only relevant for Zmq Server"
     option :worker_port,                :type => :numeric, :default => nil, :desc => "Port for 'backend' where workers connect (defaults to port + 1)"
@@ -80,6 +80,8 @@ module Protobuf
 
       # If we pause during request we don't need to pause in serialization
       def configure_gc
+        say "DEPRECATED: The gc_pause_request option is deprecated and will be removed in 4.0." if options.gc_pause_request?
+
         debug_say('Configuring gc')
 
         if defined?(JRUBY_VERSION)

data/lib/protobuf/enum.rb

@@ -1,4 +1,5 @@
 require 'delegate'
+require 'protobuf/deprecation'
 require 'protobuf/optionable'
 
 ##

data/lib/protobuf/field/base_field.rb

@@ -1,3 +1,4 @@
+require 'protobuf/deprecation'
 require 'protobuf/field/field_array'
 require 'protobuf/logging'
 require 'protobuf/wire_type'

data/lib/protobuf/field/varint_field.rb

@@ -8,6 +8,7 @@ module Protobuf
       # Constants
       #
 
+      CACHE_LIMIT = 1024
       INT32_MAX  =  2**31 - 1
       INT32_MIN  = -2**31
       INT64_MAX  =  2**63 - 1
@@ -23,7 +24,16 @@ module Protobuf
         0
       end
 
-      def self.encode(value)
+      # Because all tags and enums are calculated as VarInt it is "most common" to have
+      # values < CACHE_LIMIT (low numbers) which is defaulting to 1024
+      def self.cached_varint(value)
+        @_varint_cache ||= {}
+        (@_varint_cache[value] ||= encode(value, false)).dup
+      end
+
+      def self.encode(value, use_cache = true)
+        return cached_varint(value) if use_cache && value >= 0 && value <= CACHE_LIMIT
+
         bytes = []
         until value < 128
           bytes << (0x80 | (value & 0x7f))
@@ -32,6 +42,11 @@ module Protobuf
         (bytes << value).pack('C*')
       end
 
+      # Load the cache of VarInts on load of file
+      (0..CACHE_LIMIT).to_a.each do |cached_value|
+        cached_varint(cached_value)
+      end
+
       ##
       # Public Instance Methods
       #

data/lib/protobuf/message.rb

@@ -1,4 +1,5 @@
 require 'protobuf/field'
+require 'protobuf/deprecation'
 require 'protobuf/enum'
 require 'protobuf/exceptions'
 require 'protobuf/message/fields'
@@ -73,6 +74,8 @@ module Protobuf
     # Iterate over every field, invoking the given block
     #
     def each_field
+      return to_enum(:each_field) unless block_given?
+
       self.class.all_fields.each do |field|
         value = __send__(field.getter)
         yield(field, value)
@@ -81,15 +84,11 @@ module Protobuf
 
     def each_field_for_serialization
       self.class.all_fields.each do |field|
-        next unless field_must_be_serialized?(field)
-
         value = @values[field.getter]
+        fail ::Protobuf::SerializationError, "Required field #{self.class.name}##{field.name} does not have a value." if value.nil? && field.required?
+        next if value.nil?
 
-        if value.nil?
-          fail ::Protobuf::SerializationError, "Required field #{self.class.name}##{field.name} does not have a value."
-        else
-          yield(field, value)
-        end
+        yield(field, value)
       end
     end
 

data/lib/protobuf/message/serialization.rb

@@ -75,10 +75,6 @@ module Protobuf
 
       private
 
-      def field_must_be_serialized?(field)
-        field.required? || ! @values[field.name].nil?
-      end
-
       def set_field_bytes(tag, bytes)
         field = self.class.get_field(tag, true)
         field.set(self, bytes) if field

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

@@ -0,0 +1,87 @@
+require "socket"
+
+module Protobuf
+  module Rpc
+    module Connectors
+      class Ping
+        attr_reader :host, :port
+
+        def initialize(host, port)
+          @host = host
+          @port = port
+        end
+
+        def online?
+          socket = tcp_socket
+          socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_LINGER, [1, 0].pack('ii'))
+
+          true
+        rescue
+          false
+        ensure
+          begin
+            socket && socket.close
+          rescue IOError
+            nil
+          end
+        end
+
+        def timeout
+          @timeout ||= begin
+            if ::ENV.key?("PB_RPC_PING_PORT_TIMEOUT")
+              ::ENV["PB_RPC_PING_PORT_TIMEOUT"].to_i
+            else
+              5 # 5 seconds
+            end
+          end
+        end
+
+        private
+
+        def tcp_socket
+          # Reference: http://stackoverflow.com/a/21014439/1457934
+          socket = ::Socket.new(family, ::Socket::SOCK_STREAM, 0)
+          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
+          socket.connect_nonblock(sockaddr)
+        rescue ::IO::WaitWritable
+          # IO.select will block until the socket is writable or the timeout
+          # is exceeded - whichever comes first.
+          if ::IO.select(nil, [socket], nil, timeout)
+            begin
+              # Verify there is now a good connection
+              socket.connect_nonblock(sockaddr)
+            rescue ::Errno::EISCONN
+              # Socket is connected.
+              socket
+            rescue
+              # An unexpected exception was raised - the connection is no good.
+              socket.close
+              raise
+            end
+          else
+            # IO.select returns nil when the socket is not ready before timeout
+            # seconds have elapsed
+            socket.close
+            raise "Connection Timeout"
+          end
+        end
+
+        def family
+          @family ||= ::Socket.const_get(addrinfo[0][0])
+        end
+
+        def addrinfo
+          @addrinfo ||= ::Socket.getaddrinfo(host, nil)
+        end
+
+        def ip
+          @ip ||= addrinfo[0][3]
+        end
+
+        def sockaddr
+          @sockaddr ||= ::Socket.pack_sockaddr_in(port, ip)
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
-require 'thread_safe'
-require 'protobuf/rpc/connectors/base'
-require 'protobuf/rpc/service_directory'
+require "thread_safe"
+require "protobuf/rpc/connectors/base"
+require "protobuf/rpc/connectors/ping"
+require "protobuf/rpc/service_directory"
 
 module Protobuf
   module Rpc
@@ -161,19 +162,7 @@ module Protobuf
         end
 
         def ping_port_open?(host)
-          socket = TCPSocket.new(host, ping_port.to_i)
-          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
-          socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_LINGER, [1, 0].pack('ii'))
-
-          true
-        rescue
-          false
-        ensure
-          begin
-            socket && socket.close
-          rescue IOError
-            nil
-          end
+          Ping.new(host, ping_port.to_i).online?
         end
 
         def rcv_timeout

data/lib/protobuf/version.rb

@@ -1,3 +1,3 @@
 module Protobuf
-  VERSION = '3.5.5'
+  VERSION = '3.6.0'
 end

data/spec/benchmark/tasks.rb

@@ -1,7 +1,8 @@
 require 'benchmark'
 require 'protobuf/socket'
 require 'support/all'
-require 'support/test/resource_service'
+require 'spec_helper'
+require SUPPORT_PATH.join('resource_service')
 
 case RUBY_ENGINE.to_sym
 when :ruby

data/spec/encoding/all_types_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
+require PROTOS_PATH.join('google_unittest.pb')
 
 RSpec.describe ::Protobuf do
   it "correctly encodes all types" do
-    message = GoogleUnittest::TestAllTypes.new(
+    message = Protobuf_unittest::TestAllTypes.new(
       :optional_int32 => 101,
       :optional_int64 => 102,
       :optional_uint32 => 103,
@@ -18,16 +19,16 @@ RSpec.describe ::Protobuf do
       :optional_bool => true,
       :optional_string => "115",
       :optional_bytes => "116",
-      :optional_nested_message => GoogleUnittest::TestAllTypes::NestedMessage.new(:bb => 118),
-      :optional_foreign_message => GoogleUnittest::ForeignMessage.new(:c => 119),
-      :optional_import_message => GoogleUnittestImport::ImportMessage.new(:d => 120),
-      :optional_nested_enum => GoogleUnittest::TestAllTypes::NestedEnum::BAZ,
-      :optional_foreign_enum => GoogleUnittest::ForeignEnum::FOREIGN_BAZ,
-      :optional_import_enum => GoogleUnittestImport::ImportEnum::IMPORT_BAZ,
+      :optional_nested_message => Protobuf_unittest::TestAllTypes::NestedMessage.new(:bb => 118),
+      :optional_foreign_message => Protobuf_unittest::ForeignMessage.new(:c => 119),
+      :optional_import_message => Protobuf_unittest_import::ImportMessage.new(:d => 120),
+      :optional_nested_enum => Protobuf_unittest::TestAllTypes::NestedEnum::BAZ,
+      :optional_foreign_enum => Protobuf_unittest::ForeignEnum::FOREIGN_BAZ,
+      :optional_import_enum => Protobuf_unittest_import::ImportEnum::IMPORT_BAZ,
       :optional_string_piece => "124",
       :optional_cord => "125",
-      :optional_public_import_message => GoogleUnittestImport::PublicImportMessage.new(:e => 126),
-      :optional_lazy_message => GoogleUnittest::TestAllTypes::NestedMessage.new(:bb => 127),
+      :optional_public_import_message => Protobuf_unittest_import::PublicImportMessage.new(:e => 126),
+      :optional_lazy_message => Protobuf_unittest::TestAllTypes::NestedMessage.new(:bb => 127),
       :repeated_int32 => [201, 301],
       :repeated_int64 => [202, 302],
       :repeated_uint32 => [203, 303],
@@ -44,34 +45,34 @@ RSpec.describe ::Protobuf do
       :repeated_string => ["215", "315"],
       :repeated_bytes => ["216", "316"],
       :repeated_nested_message => [
-        ::GoogleUnittest::TestAllTypes::NestedMessage.new(:bb => 218),
-        ::GoogleUnittest::TestAllTypes::NestedMessage.new(:bb => 318),
+        ::Protobuf_unittest::TestAllTypes::NestedMessage.new(:bb => 218),
+        ::Protobuf_unittest::TestAllTypes::NestedMessage.new(:bb => 318),
       ],
       :repeated_foreign_message => [
-        ::GoogleUnittest::ForeignMessage.new(:c => 219),
-        ::GoogleUnittest::ForeignMessage.new(:c => 319),
+        ::Protobuf_unittest::ForeignMessage.new(:c => 219),
+        ::Protobuf_unittest::ForeignMessage.new(:c => 319),
       ],
       :repeated_import_message => [
-        ::GoogleUnittestImport::ImportMessage.new(:d => 220),
-        ::GoogleUnittestImport::ImportMessage.new(:d => 320),
+        ::Protobuf_unittest_import::ImportMessage.new(:d => 220),
+        ::Protobuf_unittest_import::ImportMessage.new(:d => 320),
       ],
       :repeated_nested_enum => [
-        ::GoogleUnittest::TestAllTypes::NestedEnum::BAR,
-        ::GoogleUnittest::TestAllTypes::NestedEnum::BAZ,
+        ::Protobuf_unittest::TestAllTypes::NestedEnum::BAR,
+        ::Protobuf_unittest::TestAllTypes::NestedEnum::BAZ,
       ],
       :repeated_foreign_enum => [
-        ::GoogleUnittest::ForeignEnum::FOREIGN_BAR,
-        ::GoogleUnittest::ForeignEnum::FOREIGN_BAZ,
+        ::Protobuf_unittest::ForeignEnum::FOREIGN_BAR,
+        ::Protobuf_unittest::ForeignEnum::FOREIGN_BAZ,
       ],
       :repeated_import_enum => [
-        ::GoogleUnittestImport::ImportEnum::IMPORT_BAR,
-        ::GoogleUnittestImport::ImportEnum::IMPORT_BAZ,
+        ::Protobuf_unittest_import::ImportEnum::IMPORT_BAR,
+        ::Protobuf_unittest_import::ImportEnum::IMPORT_BAZ,
       ],
       :repeated_string_piece => ["224", "324"],
       :repeated_cord => ["225", "325"],
       :repeated_lazy_message => [
-        ::GoogleUnittest::TestAllTypes::NestedMessage.new(:bb => 227),
-        ::GoogleUnittest::TestAllTypes::NestedMessage.new(:bb => 327),
+        ::Protobuf_unittest::TestAllTypes::NestedMessage.new(:bb => 227),
+        ::Protobuf_unittest::TestAllTypes::NestedMessage.new(:bb => 327),
       ],
       :default_int32 => 401,
       :default_int64 => 402,
@@ -88,14 +89,14 @@ RSpec.describe ::Protobuf do
       :default_bool => false,
       :default_string => "415",
       :default_bytes => "416",
-      :default_nested_enum => ::GoogleUnittest::TestAllTypes::NestedEnum::FOO,
-      :default_foreign_enum => ::GoogleUnittest::ForeignEnum::FOREIGN_FOO,
-      :default_import_enum => ::GoogleUnittestImport::ImportEnum::IMPORT_FOO,
+      :default_nested_enum => ::Protobuf_unittest::TestAllTypes::NestedEnum::FOO,
+      :default_foreign_enum => ::Protobuf_unittest::ForeignEnum::FOREIGN_FOO,
+      :default_import_enum => ::Protobuf_unittest_import::ImportEnum::IMPORT_FOO,
       :default_string_piece => "424",
       :default_cord => "425",
     )
 
-    data_file_path = File.expand_path('../../support/test/all_types.data.bin', __FILE__)
+    data_file_path = PROTOS_PATH.join('all_types.data.bin')
     data = File.open(data_file_path, 'rb', &:read)
     expect(data).to eq(message.serialize_to_string)
   end

data/spec/functional/class_inheritance_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'spec/support/test/resource_service'
+require SUPPORT_PATH.join('resource_service')
 
 RSpec.describe 'works through class inheritance' do
   module Corp

data/spec/functional/socket_server_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'spec/support/test/resource_service'
+require SUPPORT_PATH.join('resource_service')
 
 RSpec.describe 'Functional Socket Client' do
   before(:all) do

data/spec/functional/zmq_server_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-require 'spec/support/test/resource_service'
 require 'protobuf/rpc/service_directory'
+require SUPPORT_PATH.join('resource_service')
 
 RSpec.describe 'Functional ZMQ Client' do
   before(:all) do

data/spec/lib/protobuf/field_spec.rb

@@ -182,7 +182,7 @@ RSpec.describe ::Protobuf::Field do
       it 'raises an ArgumentError' do
         expect do
           subject.field_class("boom")
-        end.to raise_error
+        end.to raise_error(ArgumentError)
       end
     end
 

data/spec/lib/protobuf/generators/base_spec.rb

@@ -74,6 +74,8 @@ RSpec.describe ::Protobuf::Generators::Base do
 
     context 'when tags are missing in the range' do
       it 'prints a warning' do
+        allow(ENV).to receive(:key?).and_call_original
+        allow(ENV).to receive(:key?).with("PB_NO_TAG_WARNINGS").and_return(false)
         expect(::Protobuf::CodeGenerator).to receive(:print_tag_warning_suppress)
         expect(::Protobuf::CodeGenerator).to receive(:warn).with(/FooBar object should have 5 tags \(1\.\.5\), but found 4 tags/)
         described_class.validate_tags("FooBar", [1, 2, 4, 5])