protobuf 3.7.0.pre2 → 3.7.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb324f0fa537308f4f06735a42fe4a73f1483e4
-  data.tar.gz: e1067403611fd86bf86b064115cbd42651aa68d5
+  metadata.gz: f7811480fd5acc23cbffe64a18fa86ae89e0db34
+  data.tar.gz: f6b6a43c768bde92332c8b4c3ec6643cfc8e1b47
 SHA512:
-  metadata.gz: 74422c44f167336cb16897fbe21c77eb89f663f5e4217759eff2499ef2889fffd05529f49ef1586378927b23919f7d97d41bc69b9e187694a72366ddb2bff234
-  data.tar.gz: 9a5436e3e9ead8917e9cff660674494a31e6522d4ba53b9ea31c6ad1643b946507dc947c5878678eda997ae2c70543e71923e7b2727b8801c527754bdc71dac4
+  metadata.gz: 5484610ee1505ef341309a57cd3194dbf887b1034778497a90caecbc427e06fe21f6a033a361e9483e5fde906b2799c4d933e85b7661b01fe5f61c35e5fea4c0
+  data.tar.gz: daa702e3dce267e5c39a6569f42dd34ad62bb9208a897e5c7703833fc8556da1e2b1006b2138f8a679a6234a34dbf1051ac4a073f20e9c3eedbab9897caba8b9

data/.rubocop.yml

@@ -2,6 +2,8 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   DisplayCopNames: true
+  Exclude:
+    - 'spec/support/protos/*.pb.rb'
 
 Lint/EndAlignment:
   AlignWith: keyword
@@ -56,7 +58,10 @@ Style/TrailingBlankLines:
   Exclude:
     - '**/*.pb.rb'
 
-Style/TrailingComma:
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: comma
 
 Style/TrivialAccessors:

data/.rubocop_todo.yml

@@ -43,6 +43,9 @@ Performance/StringReplacement:
   Exclude:
     - 'lib/protobuf/rpc/buffer.rb'
 
+Performance/TimesMap:
+  Enabled: false
+
 # Offense count: 127
 # Configuration parameters: Exclude.
 Style/Documentation:
@@ -113,6 +116,9 @@ Style/ExtraSpacing:
 Style/NumericLiterals:
   MinDigits: 21
 
+Style/SignalException:
+  Enabled: false
+
 # Offense count: 473
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -136,4 +142,4 @@ Style/SymbolProc:
 # Cop supports --auto-correct.
 # Configuration parameters: WordRegex.
 Style/WordArray:
-  MinSize: 2
+  MinSize: 4

data/.travis.yml

@@ -2,6 +2,11 @@ before_install:
   - sudo apt-get update -qq
   - sudo apt-get install -y libzmq3-dev
   - sudo -E ./install-protobuf.sh
+  - java -Xmx1g -version
+  - javac -J-Xmx1g -version
+  - export JRUBY_OPTS=-J-Xmx1g
+  # Required for rainbow installation issue, https://github.com/sickill/rainbow/issues/44
+  - gem update --system
   - gem update bundler
 language: ruby
 rvm:
@@ -9,7 +14,9 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - jruby
+  - 2.2.2
+  - 2.3
+  - jruby-9.1.7.0
   - rbx-2
 env:
   - PROTOBUF_VERSION=2.6.1

data/CHANGES.md

@@ -1,4 +1,26 @@
-# Stable (3.x)
+# Beta (3.7.x)
+
+3.7.0 (pre3)
+-----------
+- Evaluate extension fields in code generation (#329)
+- Change the ping port to use ms timeout and make the default 200ms (#332)
+- Fix build failures caused by Rails 5 requirement of Ruby 2.2.2 (#343)
+- Add functional tests (#346)
+- Extract client and server (#347) (#348)
+- BUG: Fix decoding of packed fields (#349)
+- Add support for custom file options (#350)
+- BUG: enum_for_tags returns nil if tag nil (#352)
+- Update rubocop and fix cops (#353)
+- Optimization for varint (#356)
+- Add support for custom field options (#357)
+- Add support for custom enum options (#359)
+- Add support for custom message options (#360)
+- Acceptable check is not needed most places as coerce runs the same logic (#361)
+- Encode straight to stream without intermediary copies (#362)
+- Move dynamic rule checks to the initialize method (#363)
+- Add support for custom service options (#364)
+- Add support for custom method options (#365)
+- Upcase enum default (#366)
 
 3.7.0 (pre2)
 -----------
@@ -20,6 +42,8 @@
 - Refresh google/protobuf/descriptor.{proto,pb.rb}
 - Properly encode and decode negative enum values.
 
+# Stable (3.6.x)
+
 3.6.9
 --------
 - Make protobuf serivce directory pluggable.

data/bin/protoc-gen-ruby

@@ -18,5 +18,5 @@ STDOUT.binmode
 
 request_bytes = STDIN.read
 code_generator = ::Protobuf::CodeGenerator.new(request_bytes)
-response_bytes = code_generator.response_bytes
-STDOUT.print(response_bytes)
+code_generator.eval_unknown_extensions!
+STDOUT.print(code_generator.response_bytes)

data/lib/protobuf/cli.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/hash/keys'
+require 'active_support/inflector'
 
 require 'thor'
 require 'protobuf/version'
@@ -71,11 +72,12 @@ module Protobuf
 
       # Tell protobuf how to handle the printing of deprecated field usage.
       def configure_deprecation_warnings
-        if options.print_deprecation_warnings.nil?
-          ::Protobuf.print_deprecation_warnings = !ENV.key?("PB_IGNORE_DEPRECATIONS")
-        else
-          ::Protobuf.print_deprecation_warnings = options.print_deprecation_warnings?
-        end
+        ::Protobuf.print_deprecation_warnings =
+          if options.print_deprecation_warnings.nil?
+            !ENV.key?("PB_IGNORE_DEPRECATIONS")
+          else
+            options.print_deprecation_warnings?
+          end
       end
 
       # If we pause during request we don't need to pause in serialization
@@ -84,12 +86,13 @@ module Protobuf
 
         debug_say('Configuring gc')
 
-        if defined?(JRUBY_VERSION)
-          # GC.enable/disable are noop's on Jruby
-          ::Protobuf.gc_pause_server_request = false
-        else
-          ::Protobuf.gc_pause_server_request = options.gc_pause_request?
-        end
+        ::Protobuf.gc_pause_server_request =
+          if defined?(JRUBY_VERSION)
+            # GC.enable/disable are noop's on Jruby
+            false
+          else
+            options.gc_pause_request?
+          end
       end
 
       # Setup the protobuf logger.
@@ -114,6 +117,7 @@ module Protobuf
       # Configure the mode of the server and the runner class.
       def configure_runner_mode
         debug_say('Configuring runner mode')
+        server_type = ENV["PB_SERVER_TYPE"]
 
         self.mode = if multi_mode?
                       say('WARNING: You have provided multiple mode options. Defaulting to socket mode.', :yellow)
@@ -121,14 +125,14 @@ module Protobuf
                     elsif options.zmq?
                       :zmq
                     else
-                      case server_type = ENV["PB_SERVER_TYPE"]
-                      when nil, /socket/i
+                      case server_type
+                      when nil, /\Asocket[[:space:]]*\z/i
                         :socket
-                      when /zmq/i
+                      when /\Azmq[[:space:]]*\z/i
                         :zmq
                       else
-                        say "WARNING: You have provided incorrect option 'PB_SERVER_TYPE=#{server_type}'. Defaulting to socket mode.", :yellow
-                        :socket
+                        require server_type.to_s
+                        server_type
                       end
                     end
       end
@@ -160,7 +164,8 @@ module Protobuf
                       when :socket
                         create_socket_runner
                       else
-                        say_and_exit("Unknown runner mode: #{mode}")
+                        say("Extension runner mode: #{mode}")
+                        create_extension_server_runner
                       end
       end
 
@@ -206,6 +211,13 @@ module Protobuf
         exit(1)
       end
 
+      def create_extension_server_runner
+        classified = mode.classify
+        extension_server_class = classified.constantize
+
+        self.runner = extension_server_class.new(runner_options)
+      end
+
       def create_socket_runner
         require 'protobuf/socket'
 

data/lib/protobuf/code_generator.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/module/aliasing'
 require 'protobuf/generators/file_generator'
 
 module Protobuf
@@ -11,7 +12,7 @@ module Protobuf
 
     def self.print_tag_warning_suppress
       STDERR.puts "Suppress tag warning output with PB_NO_TAG_WARNINGS=1."
-      def self.print_tag_warning_suppress; end
+      def self.print_tag_warning_suppress; end # rubocop:disable Lint/DuplicateMethods, Lint/NestedMethodDefinition
     end
 
     def self.warn(message)
@@ -25,9 +26,17 @@ module Protobuf
     public
 
     def initialize(request_bytes)
+      @request_bytes = request_bytes
       self.request = ::Google::Protobuf::Compiler::CodeGeneratorRequest.decode(request_bytes)
     end
 
+    def eval_unknown_extensions!
+      request.proto_file.each do |file_descriptor|
+        ::Protobuf::Generators::FileGenerator.new(file_descriptor).eval_unknown_extensions!
+      end
+      self.request = ::Google::Protobuf::Compiler::CodeGeneratorRequest.decode(@request_bytes)
+    end
+
     def generate_file(file_descriptor)
       ::Protobuf::Generators::FileGenerator.new(file_descriptor).generate_output_file
     end
@@ -40,5 +49,44 @@ module Protobuf
       ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(:file => generated_files)
     end
 
+    Protobuf::Field::BaseField.module_eval do
+      # Sets a MessageField that is known to be an option.
+      # We must allow fields to be set one at a time, as option syntax allows us to
+      # set each field within the option using a separate "option" line.
+      def set_with_options(message_instance, bytes)
+        if message_instance[name].is_a?(::Protobuf::Message)
+          gp = Google::Protobuf
+          if message_instance.is_a?(gp::EnumOptions) || message_instance.is_a?(gp::EnumValueOptions) ||
+             message_instance.is_a?(gp::FieldOptions) || message_instance.is_a?(gp::FileOptions) ||
+             message_instance.is_a?(gp::MethodOptions) || message_instance.is_a?(gp::ServiceOptions) ||
+             message_instance.is_a?(gp::MessageOptions)
+
+            original_field = message_instance[name]
+            decoded_field = decode(bytes)
+            decoded_field.each_field do |subfield, subvalue|
+              option_set(original_field, subfield, subvalue) { decoded_field.field?(subfield.tag) }
+            end
+            return
+          end
+        end
+
+        set_without_options(message_instance, bytes)
+      end
+
+      def option_set(message_field, subfield, subvalue)
+        return unless yield
+        if subfield.repeated?
+          message_field[subfield.tag].concat(subvalue)
+        elsif message_field[subfield.tag] && subvalue.is_a?(::Protobuf::Message)
+          subvalue.each_field do |f, v|
+            option_set(message_field[subfield.tag], f, v) { subvalue.field?(f.tag) }
+          end
+        else
+          message_field[subfield.tag] = subvalue
+        end
+      end
+
+      alias_method_chain :set, :options
+    end
   end
 end

data/lib/protobuf/descriptors/google/protobuf/compiler/plugin.pb.rb

@@ -3,7 +3,7 @@
 ##
 # This file is auto-generated. DO NOT EDIT!
 #
-require 'protobuf/message'
+require 'protobuf'
 
 
 ##
@@ -14,6 +14,7 @@ require 'google/protobuf/descriptor.pb'
 module Google
   module Protobuf
     module Compiler
+      ::Protobuf::Optionable.inject(self) { ::Google::Protobuf::FileOptions }
 
       ##
       # Message Classes
@@ -26,6 +27,13 @@ module Google
 
 
 
+      ##
+      # File Options
+      #
+      set_option :java_package, "com.google.protobuf.compiler"
+      set_option :java_outer_classname, "PluginProtos"
+
+
       ##
       # Message Fields
       #

data/lib/protobuf/descriptors/google/protobuf/descriptor.pb.rb

@@ -3,10 +3,11 @@
 ##
 # This file is auto-generated. DO NOT EDIT!
 #
-require 'protobuf/message'
+require 'protobuf'
 
 module Google
   module Protobuf
+    ::Protobuf::Optionable.inject(self) { ::Google::Protobuf::FileOptions }
 
     ##
     # Message Classes
@@ -95,6 +96,17 @@ module Google
 
 
 
+    ##
+    # File Options
+    #
+    set_option :java_package, "com.google.protobuf"
+    set_option :java_outer_classname, "DescriptorProtos"
+    set_option :optimize_for, ::Google::Protobuf::FileOptions::OptimizeMode::SPEED
+    set_option :go_package, "descriptor"
+    set_option :objc_class_prefix, "GPB"
+    set_option :csharp_namespace, "Google.Protobuf.Reflection"
+
+
     ##
     # Message Fields
     #
@@ -149,6 +161,7 @@ module Google
       optional :string, :extendee, 2
       optional :string, :default_value, 7
       optional :int32, :oneof_index, 9
+      optional :string, :json_name, 10
       optional ::Google::Protobuf::FieldOptions, :options, 8
     end
 

data/lib/protobuf/encoder.rb

@@ -8,11 +8,11 @@ module Protobuf
             stream << "#{field.tag_encoded}#{::Protobuf::Field::VarintField.encode(packed_value.size)}#{packed_value}"
           else
             value.each do |val|
-              stream << "#{field.tag_encoded}#{field.encode(val)}"
+              field.encode_to_stream(val, stream)
             end
           end
         else
-          stream << "#{field.tag_encoded}#{field.encode(value)}"
+          field.encode_to_stream(value, stream)
         end
       end
 

data/lib/protobuf/enum.rb

@@ -94,7 +94,7 @@ module Protobuf
     # Returns an array with zero or more Enum objects or nil.
     #
     def self.enums_for_tag(tag)
-      mapped_enums[tag.to_i] || []
+      tag && mapped_enums[tag.to_i] || []
     end
 
     # Public: Get the Enum associated with the given name.
@@ -129,7 +129,7 @@ module Protobuf
     #   Enums, the first enum defined will be returned.
     #
     def self.enum_for_tag(tag)
-      (mapped_enums[tag.to_i] || []).first
+      tag && (mapped_enums[tag.to_i] || []).first
     end
 
     # Public: Get an Enum by a variety of type-checking mechanisms.
@@ -309,6 +309,6 @@ module Protobuf
     ##
     # Instance Aliases
     #
-    alias_method :to_hash_value, :to_i
+    alias :to_hash_value to_i
   end
 end

data/lib/protobuf/field/base_field.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/hash/slice'
 require 'protobuf/field/field_array'
 module Protobuf
   module Field
@@ -39,7 +40,19 @@ module Protobuf
         @rule          = rule
         @tag           = tag
         @type_class    = type_class
-        @options       = options
+        # Populate the option hash with all the original default field options, for backwards compatibility.
+        # However, both default and custom options should ideally be accessed through the Optionable .{get,get!}_option functions.
+        @options = options.slice(:ctype, :packed, :deprecated, :lazy, :jstype, :weak, :uninterpreted_option, :default, :extension)
+        options.each do |option_name, value|
+          set_option(option_name, value)
+        end
+
+        @extension = options.key?(:extension)
+        @deprecated = options.key?(:deprecated)
+        @required = rule == :required
+        @repeated = rule == :repeated
+        @optional = rule == :optional
+        @packed = @repeated && options.key?(:packed)
 
         validate_packed_field if packed?
         define_accessor(simple_name, fully_qualified_name) if simple_name
@@ -77,39 +90,39 @@ module Protobuf
       end
 
       def deprecated?
-        options.key?(:deprecated)
+        @deprecated
       end
 
       def encode(_value)
         fail NotImplementedError, "#{self.class.name}##{__method__}"
       end
 
+      def encode_to_stream(value, stream)
+        stream << tag_encoded << encode(value)
+      end
+
       def extension?
-        options.key?(:extension)
+        @extension
       end
 
       def enum?
         false
       end
 
-      def getter
-        name
-      end
-
       def message?
         false
       end
 
       def optional?
-        rule == :optional
+        @optional
       end
 
       def packed?
-        repeated? && options.key?(:packed)
+        @packed
       end
 
       def repeated?
-        rule == :repeated
+        @repeated
       end
 
       def repeated_message?
@@ -117,7 +130,7 @@ module Protobuf
       end
 
       def required?
-        rule == :required
+        @required
       end
 
       # FIXME: need to cleanup (rename) this warthog of a method.
@@ -129,18 +142,14 @@ module Protobuf
         stream = StringIO.new(bytes)
 
         if wire_type == ::Protobuf::WireType::VARINT
-          array << Varint.decode(stream) until stream.eof?
+          array << decode(Varint.decode(stream)) until stream.eof?
         elsif wire_type == ::Protobuf::WireType::FIXED64
-          array << stream.read(8) until stream.eof?
+          array << decode(stream.read(8)) until stream.eof?
         elsif wire_type == ::Protobuf::WireType::FIXED32
-          array << stream.read(4) until stream.eof?
+          array << decode(stream.read(4)) until stream.eof?
         end
       end
 
-      def setter
-        @setter ||= "#{name}="
-      end
-
       def tag_encoded
         @tag_encoded ||= begin
                            case
@@ -205,7 +214,6 @@ module Protobuf
           fail "Can't use packed encoding for '#{type_class}' type"
         end
       end
-
     end
   end
 end

data/lib/protobuf/field/bool_field.rb

@@ -3,7 +3,9 @@ require 'protobuf/field/varint_field'
 module Protobuf
   module Field
     class BoolField < VarintField
+      FALSE_ENCODE = [0].pack('C')
       FALSE_STRING = "false".freeze
+      TRUE_ENCODE = [1].pack('C')
       TRUE_STRING = "true".freeze
 
       ##
@@ -19,16 +21,16 @@ module Protobuf
       # #
 
       def acceptable?(val)
-        [true, false].include?(val) || %w(true false).include?(val)
+        val == true || val == false || val == TRUE_STRING || val == FALSE_STRING
       end
 
       def coerce!(val)
-        case val
-        when String
-          val == TRUE_STRING
-        else
-          val
-        end
+        return true if val == true
+        return false if val == false
+        return true if val == TRUE_STRING
+        return false if val == FALSE_STRING
+
+        fail TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'"
       end
 
       def decode(value)
@@ -36,7 +38,7 @@ module Protobuf
       end
 
       def encode(value)
-        [value ? 1 : 0].pack('C')
+        value ? TRUE_ENCODE : FALSE_ENCODE
       end
 
       private

data/lib/protobuf/field/bytes_field.rb

@@ -33,11 +33,12 @@ module Protobuf
       end
 
       def encode(value)
-        if value.is_a?(::Protobuf::Message)
-          value_to_encode = value.encode
-        else
-          value_to_encode = value.dup
-        end
+        value_to_encode =
+          if value.is_a?(::Protobuf::Message)
+            value.encode
+          else
+            value.dup
+          end
 
         value_to_encode.force_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
         string_size = ::Protobuf::Field::VarintField.encode(value_to_encode.size)
@@ -45,6 +46,13 @@ module Protobuf
         "#{string_size}#{value_to_encode}"
       end
 
+      def encode_to_stream(value, stream)
+        value = value.encode if value.is_a?(::Protobuf::Message)
+        byte_size = ::Protobuf::Field::VarintField.encode(value.bytesize)
+
+        stream << tag_encoded << byte_size << value
+      end
+
       def wire_type
         ::Protobuf::WireType::LENGTH_DELIMITED
       end
@@ -52,7 +60,7 @@ module Protobuf
       def coerce!(value)
         case value
         when String, Symbol
-          "#{value}"
+          value.to_s
         when NilClass
           nil
         when ::Protobuf::Message

data/lib/protobuf/field/float_field.rb

@@ -22,6 +22,8 @@ module Protobuf
 
       def coerce!(val)
         Float(val)
+      rescue ArgumentError
+        fail TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'"
       end
 
       def decode(bytes)

data/lib/protobuf/field/string_field.rb

@@ -28,6 +28,16 @@ module Protobuf
         "#{::Protobuf::Field::VarintField.encode(value_to_encode.size)}#{value_to_encode}"
       end
 
+      def encode_to_stream(value, stream)
+        if value.encoding != ::Protobuf::Field::StringField::ENCODING
+          value = value.dup
+          value.encode!(::Protobuf::Field::StringField::ENCODING, :invalid => :replace, :undef => :replace, :replace => "")
+        end
+
+        byte_size = ::Protobuf::Field::VarintField.encode(value.bytesize)
+        stream << tag_encoded << byte_size << value
+      end
+
     end
   end
 end

data/lib/protobuf/field/varint_field.rb

@@ -50,17 +50,27 @@ module Protobuf
       ##
       # Public Instance Methods
       #
-
       def acceptable?(val)
-        int_val = coerce!(val)
+        int_val = if val.is_a?(Integer)
+                    return true if val >= 0 && val < INT32_MAX # return quickly for smallest integer size, hot code path
+                    val
+                  elsif val.is_a?(Numeric)
+                    val.to_i
+                  else
+                    Integer(val, 10)
+                  end
+
         int_val >= self.class.min && int_val <= self.class.max
       rescue
         false
       end
 
       def coerce!(val)
+        fail TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'" unless acceptable?(val)
         return val.to_i if val.is_a?(Numeric)
         Integer(val, 10)
+      rescue ArgumentError
+        fail TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'"
       end
 
       def decode(value)