protobuf 3.7.0.pre2 → 3.7.0.pre3

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

@@ -16,7 +16,7 @@ module Protobuf
           :broadcast_beacons => false,
           :broadcast_busy => false,
           :zmq_inproc => true,
-        }
+        }.freeze
 
         attr_accessor :options, :workers
         attr_reader :zmq_context
@@ -117,7 +117,7 @@ module Protobuf
         def frontend_ip
           @frontend_ip ||= resolve_ip(options[:host])
         end
-        alias_method :backend_ip, :frontend_ip
+        alias :backend_ip frontend_ip
 
         def frontend_port
           options[:port]
@@ -217,11 +217,12 @@ module Protobuf
         end
 
         def timeout
-          if @timeout.nil?
-            @timeout = 0
-          else
-            @timeout = [minimum_timeout, maintenance_timeout].max
-          end
+          @timeout =
+            if @timeout.nil?
+              0
+            else
+              [minimum_timeout, maintenance_timeout].max
+            end
         end
 
         def total_workers

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

@@ -4,12 +4,12 @@ module Protobuf
   module Rpc
     module Zmq
 
-      ADDRESS_MATCH = /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\z/.freeze
-      WORKER_READY_MESSAGE = "\1"
-      CHECK_AVAILABLE_MESSAGE = "\3"
-      NO_WORKERS_AVAILABLE = "\4"
-      WORKERS_AVAILABLE = "\5"
-      EMPTY_STRING = ""
+      ADDRESS_MATCH = /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\z/
+      WORKER_READY_MESSAGE = "\1".freeze
+      CHECK_AVAILABLE_MESSAGE = "\3".freeze
+      NO_WORKERS_AVAILABLE = "\4".freeze
+      WORKERS_AVAILABLE = "\5".freeze
+      EMPTY_STRING = "".freeze
 
       module Util
         include ::Protobuf::Logging

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

@@ -47,7 +47,7 @@ module Protobuf
           loop do
             rc = poller.poll(500)
 
-            if rc == 0 && !running?
+            if rc == 0 && !running? # rubocop:disable Style/GuardClause
               break # The server was shutdown and no requests are pending
             elsif rc == -1
               break # Something went wrong
@@ -68,11 +68,12 @@ module Protobuf
         private
 
         def init_zmq_context
-          if inproc?
-            @zmq_context = @server.zmq_context
-          else
-            @zmq_context = ZMQ::Context.new
-          end
+          @zmq_context =
+            if inproc?
+              @server.zmq_context
+            else
+              ZMQ::Context.new
+            end
         end
 
         def init_backend_socket

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

@@ -60,3 +60,11 @@ module Protobuf
     end
   end
 end
+
+module Protobuf
+  module Rpc
+    module Servers # bad file namespacing
+      ZmqRunner = ::Protobuf::Rpc::ZmqRunner
+    end
+  end
+end

data/lib/protobuf/rpc/service.rb

@@ -2,13 +2,12 @@ require 'protobuf/logging'
 require 'protobuf/message'
 require 'protobuf/rpc/client'
 require 'protobuf/rpc/error'
+require 'protobuf/rpc/rpc_method'
 require 'protobuf/rpc/service_filters'
 
 module Protobuf
   module Rpc
     # Object to encapsulate the request/response types for a given service method
-    #
-    RpcMethod = Struct.new("RpcMethod", :method, :request_type, :response_type)
 
     class Service
       include ::Protobuf::Logging
@@ -103,8 +102,8 @@ module Protobuf
       # This methods is only used by the generated service definitions
       # and not useful for user code.
       #
-      def self.rpc(method, request_type, response_type)
-        rpcs[method] = RpcMethod.new(method, request_type, response_type)
+      def self.rpc(method, request_type, response_type, &options_block)
+        rpcs[method] = RpcMethod.new(method, request_type, response_type, &options_block)
       end
 
       # Hash containing the set of methods defined via `rpc`.
@@ -119,16 +118,8 @@ module Protobuf
         rpcs.key?(name)
       end
 
-      ##
-      # Instance Methods
-      #
-      # Get a callable object that will be used by the dispatcher
-      # to invoke the specified rpc method. Facilitates callback dispatch.
-      # The returned lambda is expected to be called at a later time (which
-      # is why we wrap the method call).
-      #
-      def callable_rpc_method(method_name)
-        -> { run_filters(method_name) }
+      def call(method_name)
+        run_filters(method_name)
       end
 
       # Response object for this rpc cycle. Not assignable.
@@ -162,7 +153,7 @@ module Protobuf
       def respond_with(candidate)
         @response = candidate
       end
-      alias_method :return_from_whence_you_came, :respond_with
+      alias :return_from_whence_you_came respond_with
 
       def response_type
         @response_type ||= env.response_type

data/lib/protobuf/rpc/service_directory.rb

@@ -21,7 +21,7 @@ module Protobuf
       include ::Singleton
       include ::Protobuf::Logging
 
-      DEFAULT_ADDRESS = "0.0.0.0"
+      DEFAULT_ADDRESS = '0.0.0.0'.freeze
       DEFAULT_PORT = 53000
       DEFAULT_TIMEOUT = 1
 

data/lib/protobuf/rpc/service_dispatcher.rb

@@ -12,6 +12,10 @@ module Protobuf
       end
 
       def call(env)
+        dup._call(env)
+      end
+
+      def _call(env)
         @env = env
 
         env.response = dispatch_rpc_request
@@ -24,13 +28,8 @@ module Protobuf
 
       private
 
-      # Call the given service method.
       def dispatch_rpc_request
-        unless rpc_service.respond_to?(method_name)
-          fail MethodNotFound, "#{service_name}##{method_name} is not a publicly defined method."
-        end
-
-        rpc_service.callable_rpc_method(method_name).call
+        rpc_service.call(method_name)
         rpc_service.response
       end
 

data/lib/protobuf/rpc/service_filters.rb

@@ -120,15 +120,9 @@ module Protobuf
         # or an object that responds to `call`.
         #
         def invoke_via_if?(_rpc_method, filter)
-          if_check = filter.fetch(:if) { ->(_service) { return true } }
-          do_invoke = case
-                      when if_check.nil?
-                        true
-                      else
-                        call_or_send(if_check)
-                      end
-
-          do_invoke
+          if_check = filter.fetch(:if, nil)
+          return true if if_check.nil?
+          call_or_send(if_check)
         end
 
         # If the target rpc endpoint method is listed in the :only option,
@@ -150,15 +144,9 @@ module Protobuf
         # or an object that responds to `call`.
         #
         def invoke_via_unless?(_rpc_method, filter)
-          unless_check = filter.fetch(:unless) { ->(_service) { return false } }
-          skip_invoke = case
-                        when unless_check.nil?
-                          false
-                        else
-                          call_or_send(unless_check)
-                        end
-
-          !skip_invoke
+          unless_check = filter.fetch(:unless, nil)
+          return true if unless_check.nil?
+          !call_or_send(unless_check)
         end
 
         def rescue_filters
@@ -253,20 +241,10 @@ module Protobuf
         # __send__ assuming that we respond_to it. Return the call's return value.
         #
         def call_or_send(callable, *args, &block)
-          return_value = case
-                         when callable.respond_to?(:call)
-                           callable.call(self, *args, &block)
-                         when respond_to?(callable, true)
-                           __send__(callable, *args, &block)
-                         else
-                           fail "Object #{callable} is not callable"
-                         end
-
-          return_value
+          return callable.call(self, *args, &block) if callable.respond_to?(:call)
+          __send__(callable, *args, &block)
         end
-
       end
-
     end
   end
 end

data/lib/protobuf/socket.rb

@@ -15,7 +15,7 @@
 #   gem 'protobuf', :require => 'protobuf/socket'
 #
 require 'protobuf'
-::Protobuf.connector_type = :socket
-
 require 'protobuf/rpc/servers/socket/server'
 require 'protobuf/rpc/connectors/socket'
+
+::Protobuf.connector_type_class = ::Protobuf::Rpc::Connectors::Socket

data/lib/protobuf/version.rb

@@ -1,3 +1,3 @@
 module Protobuf
-  VERSION = '3.7.0.pre2'
+  VERSION = '3.7.0.pre3' # rubocop:disable Style/MutableConstant
 end

data/lib/protobuf/zmq.rb

@@ -14,8 +14,8 @@
 #   gem 'protobuf', :require => 'protobuf/zmq'
 #
 require 'protobuf'
-Protobuf.connector_type = :zmq
-
 require 'ffi-rzmq'
 require 'protobuf/rpc/servers/zmq/server'
 require 'protobuf/rpc/connectors/zmq'
+
+Protobuf.connector_type_class = ::Protobuf::Rpc::Connectors::Zmq

data/lib/protobuf.rb

@@ -30,12 +30,6 @@ require 'protobuf/descriptors'
 
 module Protobuf
 
-  # See Protobuf#connector_type documentation.
-  CONNECTORS = [:socket, :zmq].freeze
-
-  # Default is Socket as it has no external dependencies.
-  DEFAULT_CONNECTOR = :socket
-
   class << self
     # Client Host
     #
@@ -49,19 +43,12 @@ module Protobuf
     @client_host ||= Socket.gethostname
   end
 
-  # Connector Type
-  #
-  # Default: socket
-  #
-  # Symbol value which denotes the type of connector to use
-  # during client requests to an RPC server.
-  def self.connector_type
-    @connector_type ||= DEFAULT_CONNECTOR
+  def self.connector_type_class
+    @connector_type_class ||= ::Protobuf::Rpc::Connectors::Socket
   end
 
-  def self.connector_type=(type)
-    fail ArgumentError, 'Invalid connector type given' unless CONNECTORS.include?(type)
-    @connector_type = type
+  def self.connector_type_class=(type_class)
+    @connector_type_class = type_class
   end
 
   # GC Pause during server requests
@@ -101,17 +88,15 @@ unless ENV.key?('PB_NO_NETWORKING')
   require 'protobuf/rpc/service'
 
   env_connector_type = ENV.fetch('PB_CLIENT_TYPE') do
-    ::Protobuf::DEFAULT_CONNECTOR
-  end.to_s.downcase.strip.to_sym
+    :socket
+  end
 
-  if ::Protobuf::CONNECTORS.include?(env_connector_type)
-    require "protobuf/#{env_connector_type}"
+  symbolized_connector_type = env_connector_type.to_s.downcase.strip.to_sym
+  if [:zmq, :socket].include?(symbolized_connector_type)
+    require "protobuf/#{symbolized_connector_type}"
   else
-    $stderr.puts <<-WARN
-    [WARNING] Require attempted on an invalid connector type '#{env_connector_type}'.
-              Falling back to default '#{::Protobuf::DEFAULT_CONNECTOR}' connector.
-    WARN
-
-    require "protobuf/#{::Protobuf::DEFAULT_CONNECTOR}"
+    require "#{env_connector_type}" # rubocop:disable Style/UnneededInterpolation
+    classified = env_connector_type.classify
+    ::Protobuf.connector_type_class = classified.constantize
   end
 end

data/protobuf.gemspec

@@ -19,15 +19,17 @@ require "protobuf/version"
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', '>= 3.2'
+  # Hack, as Rails 5 requires Ruby version >= 2.2.2.
+  active_support_max_version = "< 5" if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2")
+  s.add_dependency "activesupport", '>= 3.2', active_support_max_version
   s.add_dependency 'middleware'
   s.add_dependency 'thor'
   s.add_dependency 'thread_safe'
 
   s.add_development_dependency 'ffi-rzmq'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake', '< 11.0' # Rake 11.0.1 removes the last_comment method which rspec-core (< 3.4.4) uses
   s.add_development_dependency 'rspec', '>= 3.0'
-  s.add_development_dependency "rubocop", "~> 0.35.0"
+  s.add_development_dependency "rubocop", "~> 0.38.0"
   s.add_development_dependency "parser", "2.3.0.6" # Locked this down since 2.3.0.7 causes issues. https://github.com/bbatsov/rubocop/pull/2984
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'timecop'

data/spec/benchmark/tasks.rb

@@ -1,4 +1,5 @@
 require 'benchmark'
+require 'protobuf'
 require 'protobuf/socket'
 require 'support/all'
 require 'spec_helper'

data/spec/functional/code_generator_spec.rb

@@ -0,0 +1,38 @@
+# encoding: binary
+
+require 'spec_helper'
+require 'protobuf/code_generator'
+
+RSpec.describe 'code generation' do
+  it "generates code for google's unittest.proto" do
+    bytes = IO.read(PROTOS_PATH.join('google_unittest.bin'), :mode => 'rb')
+
+    expected_files =
+      ["google_unittest_import_public.pb.rb", "google_unittest_import.pb.rb", "google_unittest.pb.rb"]
+
+    expected_file_descriptors = expected_files.map do |file_name|
+      file_content = File.open(PROTOS_PATH.join(file_name), "r:UTF-8", &:read)
+      ::Google::Protobuf::Compiler::CodeGeneratorResponse::File.new(
+        :name => "protos/" + file_name, :content => file_content)
+    end
+
+    expected_output =
+      ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(:file => expected_file_descriptors)
+
+    code_generator = ::Protobuf::CodeGenerator.new(bytes)
+    code_generator.eval_unknown_extensions!
+    expect(code_generator.response_bytes).to eq(expected_output)
+  end
+
+  it "generates code (including service stubs) with custom field and method options" do
+    expected_unittest_custom_options =
+      File.open(PROTOS_PATH.join('google_unittest_custom_options.pb.rb'), "r:UTF-8", &:read)
+
+    bytes = IO.read(PROTOS_PATH.join('google_unittest_custom_options.bin'), :mode => 'rb')
+    code_generator = ::Protobuf::CodeGenerator.new(bytes)
+    code_generator.eval_unknown_extensions!
+    response = ::Google::Protobuf::Compiler::CodeGeneratorResponse.decode(code_generator.response_bytes)
+    expect(response.file.find { |f| f.name == 'protos/google_unittest_custom_options.pb.rb' }.content)
+      .to eq(expected_unittest_custom_options)
+  end
+end

data/spec/lib/protobuf/cli_spec.rb

@@ -170,6 +170,25 @@ RSpec.describe ::Protobuf::CLI do
 
     context 'run modes' do
 
+      context "extension" do
+        let(:runner) { ::Protobuf::Rpc::Servers::SocketRunner }
+
+        it "loads the runner specified by PB_SERVER_TYPE" do
+          ENV['PB_SERVER_TYPE'] = "protobuf/rpc/servers/socket_runner"
+          expect(runner).to receive(:new).and_return(sock_runner)
+          described_class.start(args)
+          ENV.delete('PB_SERVER_TYPE')
+        end
+
+        context "without extension loaded" do
+          it "will throw a LoadError when extension is not loaded" do
+            ENV['PB_SERVER_TYPE'] = "socket_to_load"
+            expect { described_class.start(args) }.to raise_error(LoadError, /socket_to_load/)
+            ENV.delete("PB_SERVER_TYPE")
+          end
+        end
+      end
+
       context 'socket' do
         let(:test_args) { ['--socket'] }
         let(:runner) { ::Protobuf::Rpc::SocketRunner }
@@ -189,11 +208,6 @@ RSpec.describe ::Protobuf::CLI do
           described_class.start(args)
           ENV.delete('PB_SERVER_TYPE')
         end
-
-        it 'configures the connector type to be socket' do
-          load "protobuf/socket.rb"
-          expect(::Protobuf.connector_type).to eq(:socket)
-        end
       end
 
       context 'zmq workers only' do
@@ -259,11 +273,6 @@ RSpec.describe ::Protobuf::CLI do
           described_class.start(args)
           ENV.delete('PB_SERVER_TYPE')
         end
-
-        it 'configures the connector type to be zmq' do
-          load "protobuf/zmq.rb"
-          expect(::Protobuf.connector_type).to eq(:zmq)
-        end
       end
 
     end

data/spec/lib/protobuf/code_generator_spec.rb

@@ -37,6 +37,34 @@ RSpec.describe ::Protobuf::CodeGenerator do
     end
   end
 
+  describe '#eval_unknown_extensions' do
+    let(:input_file) do
+      DESCRIPTOR::FileDescriptorProto.new(
+        :name => 'test/boom.proto',
+        :package => 'test.pkg.code_generator_spec',
+        :extension => [{
+          :name => 'boom',
+          :number => 20100,
+          :label => Google::Protobuf::FieldDescriptorProto::Label::LABEL_OPTIONAL,
+          :type => Google::Protobuf::FieldDescriptorProto::Type::TYPE_STRING,
+          :extendee => '.google.protobuf.FieldOptions',
+        }],
+      )
+    end
+    let(:request_bytes) { COMPILER::CodeGeneratorRequest.encode(:proto_file => [input_file]) }
+
+    it 'evals files as they are generated' do
+      described_class.new(request_bytes).eval_unknown_extensions!
+      expect(Google::Protobuf::FieldOptions.extension_fields.map(&:fully_qualified_name)).to include(:'.test.pkg.code_generator_spec.boom')
+      expect(Google::Protobuf::FieldOptions.extension_fields.map(&:name)).to include(:boom)
+      added_extension = Google::Protobuf::FieldOptions.extension_fields.detect { |f| f.fully_qualified_name == :'.test.pkg.code_generator_spec.boom' }
+      expect(added_extension.name).to eq(:boom)
+      expect(added_extension.rule).to eq(:optional)
+      expect(added_extension.type_class).to eq(::Protobuf::Field::StringField)
+      expect(added_extension.tag).to eq(20100)
+    end
+  end
+
   context 'class-level printing methods' do
     describe '.fatal' do
       it 'raises a CodeGeneratorFatalError error' do

data/spec/lib/protobuf/enum_spec.rb

@@ -53,11 +53,12 @@ RSpec.describe Protobuf::Enum do
       it 'provides an array of defined Enums' do
         expect(Test::EnumTestType.enums).to eq(
           [
+            Test::EnumTestType::ZERO,
             Test::EnumTestType::ONE,
             Test::EnumTestType::TWO,
             Test::EnumTestType::MINUS_ONE,
             Test::EnumTestType::THREE,
-          ]
+          ],
         )
       end
 
@@ -68,7 +69,7 @@ RSpec.describe Protobuf::Enum do
               EnumAliasTest::FOO,
               EnumAliasTest::BAR,
               EnumAliasTest::BAZ,
-            ]
+            ],
           )
         end
       end
@@ -76,6 +77,7 @@ RSpec.describe Protobuf::Enum do
 
     describe '.enums_for_tag' do
       it 'returns an array of Enums for the given tag, if any' do
+        expect(EnumAliasTest.enums_for_tag(nil)).to eq([])
         expect(EnumAliasTest.enums_for_tag(1)).to eq([EnumAliasTest::FOO, EnumAliasTest::BAR])
         expect(EnumAliasTest.enums_for_tag(2)).to eq([EnumAliasTest::BAZ])
         expect(EnumAliasTest.enums_for_tag(3)).to eq([])
@@ -124,6 +126,7 @@ RSpec.describe Protobuf::Enum do
       it 'gets the Enum corresponding to the given tag' do
         expect(Test::EnumTestType.enum_for_tag(tag)).to eq(Test::EnumTestType.const_get(name))
         expect(Test::EnumTestType.enum_for_tag(-5)).to be_nil
+        expect(Test::EnumTestType.enum_for_tag(nil)).to be_nil
       end
     end
 
@@ -186,6 +189,7 @@ RSpec.describe Protobuf::Enum do
       it 'provides a hash of defined Enums' do
         expect(Test::EnumTestType.values).to eq(
           :MINUS_ONE => Test::EnumTestType::MINUS_ONE,
+          :ZERO      => Test::EnumTestType::ZERO,
           :ONE       => Test::EnumTestType::ONE,
           :TWO       => Test::EnumTestType::TWO,
           :THREE     => Test::EnumTestType::THREE,

data/spec/lib/protobuf/field/bool_field_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 RSpec.describe Protobuf::Field::BoolField do
 
+  it_behaves_like :packable_field, described_class do
+    let(:value) { [true, false] }
+  end
+
   class SomeBoolMessage < ::Protobuf::Message
     optional :bool, :some_bool, 1
     required :bool, :required_bool, 2

data/spec/lib/protobuf/field/double_field_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe Protobuf::Field::DoubleField do
+
+  it_behaves_like :packable_field, described_class do
+    let(:value) { [1.0, 2.0, 3.0] }
+  end
+
+end

data/spec/lib/protobuf/field/fixed32_field_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Protobuf::Field::Fixed32Field do
+
+  it_behaves_like :packable_field, described_class
+
+end

data/spec/lib/protobuf/field/fixed64_field_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Protobuf::Field::Fixed64Field do
+
+  it_behaves_like :packable_field, described_class
+
+end

data/spec/lib/protobuf/field/float_field_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 RSpec.describe Protobuf::Field::FloatField do
 
+  it_behaves_like :packable_field, described_class do
+    let(:value) { [1.0, 2.0, 3.0] }
+  end
+
   class SomeFloatMessage < ::Protobuf::Message
     optional :float, :some_float, 1
   end
@@ -39,7 +43,7 @@ RSpec.describe Protobuf::Field::FloatField do
       let(:value) { "aaaa" }
 
       it 'throws an error' do
-        expect { subject }.to raise_error(ArgumentError)
+        expect { subject }.to raise_error(TypeError)
       end
     end
 

data/spec/lib/protobuf/field/int64_field_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Protobuf::Field::Int64Field do
+
+  it_behaves_like :packable_field, described_class
+
+end