protobuffy 3.6.0 → 4.0.0

data/lib/protobuf/code_generator.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/module/aliasing'
 require 'protobuf/generators/file_generator'
 
 module Protobuf
@@ -6,36 +7,86 @@ module Protobuf
     CodeGeneratorFatalError = Class.new(RuntimeError)
 
     def self.fatal(message)
-      raise CodeGeneratorFatalError, message
+      fail CodeGeneratorFatalError, message
     end
 
     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)
       STDERR.puts("[WARN] #{message}")
     end
 
+    private
+
+    attr_accessor :request
+
+    public
+
     def initialize(request_bytes)
-      @request = ::Google::Protobuf::Compiler::CodeGeneratorRequest.decode(request_bytes)
-      @generated_files = []
+      @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)
-      file_generator = ::Protobuf::Generators::FileGenerator.new(file_descriptor)
-      @generated_files << file_generator.generate_output_file
+      ::Protobuf::Generators::FileGenerator.new(file_descriptor).generate_output_file
     end
 
     def response_bytes
-      @request.proto_file.each do |file_descriptor|
+      generated_files = request.proto_file.map do |file_descriptor|
         generate_file(file_descriptor)
       end
 
-      return ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(:file => @generated_files)
+      ::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/decoder.rb

@@ -1,74 +1,28 @@
-require 'protobuf/wire_type'
-require 'protobuf/exceptions'
-
 module Protobuf
   class Decoder
 
     # Read bytes from +stream+ and pass to +message+ object.
-    def self.decode_each_field(stream, &block)
+    def self.decode_each_field(stream)
       until stream.eof?
-        tag, bytes = read_field(stream)
-        block.call(tag, bytes)
+        bits = Varint.decode(stream)
+        wire_type = bits & 0x07
+        tag = bits >> 3
+
+        bytes = if wire_type == ::Protobuf::WireType::VARINT
+                  Varint.decode(stream)
+                elsif wire_type == ::Protobuf::WireType::LENGTH_DELIMITED
+                  value_length = Varint.decode(stream)
+                  stream.read(value_length)
+                elsif wire_type == ::Protobuf::WireType::FIXED64
+                  stream.read(8)
+                elsif wire_type == ::Protobuf::WireType::FIXED32
+                  stream.read(4)
+                else
+                  fail InvalidWireType, wire_type
+                end
+
+        yield(tag, bytes)
       end
     end
-
-    def self.read_field(stream)
-      tag, wire_type = read_key(stream)
-      bytes = case wire_type
-              when ::Protobuf::WireType::VARINT then
-                read_varint(stream)
-              when ::Protobuf::WireType::FIXED64 then
-                read_fixed64(stream)
-              when ::Protobuf::WireType::LENGTH_DELIMITED then
-                read_length_delimited(stream)
-              when ::Protobuf::WireType::FIXED32 then
-                read_fixed32(stream)
-              when ::Protobuf::WireType::START_GROUP then
-                raise NotImplementedError, 'Group is deprecated.'
-              when ::Protobuf::WireType::END_GROUP then
-                raise NotImplementedError, 'Group is deprecated.'
-              else
-                raise InvalidWireType, wire_type
-              end
-
-      return tag, bytes
-    end
-
-    # Read 32-bit string value from +stream+.
-    def self.read_fixed32(stream)
-      stream.read(4)
-    end
-
-    # Read 64-bit string value from +stream+.
-    def self.read_fixed64(stream)
-      stream.read(8)
-    end
-
-    # Read key pair (tag and wire-type) from +stream+.
-    def self.read_key(stream)
-      bits = read_varint(stream)
-      wire_type = bits & 0x07
-      tag = bits >> 3
-      [tag, wire_type]
-    end
-
-    # Read length-delimited string value from +stream+.
-    def self.read_length_delimited(stream)
-      value_length = read_varint(stream)
-      stream.read(value_length)
-    end
-
-    # Read varint integer value from +stream+.
-    def self.read_varint(stream)
-      value = index = 0
-      begin
-        byte = stream.readbyte
-        value |= (byte & 0x7f) << (7 * index)
-        index += 1
-      end while (byte & 0x80).nonzero?
-      value
-    end
-
   end
 end
-

data/lib/protobuf/deprecation.rb

@@ -0,0 +1,117 @@
+require 'active_support/deprecation'
+
+module Protobuf
+  if ::ActiveSupport::Deprecation.is_a?(Class)
+    class DeprecationBase < ::ActiveSupport::Deprecation
+      def deprecate_methods(*args)
+        deprecation_options = { :deprecator => self }
+
+        if args.last.is_a?(Hash)
+          args.last.merge!(deprecation_options)
+        else
+          args.push(deprecation_options)
+        end
+
+        super
+      end
+
+      def deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil)
+        # This ensures ActiveSupport::Deprecation doesn't look for the caller, which is very costly.
+        super(deprecated_method_name, message, caller_backtrace) unless ENV.key?('PB_IGNORE_DEPRECATIONS')
+      end
+    end
+
+    class Deprecation < DeprecationBase
+      def define_deprecated_methods(target_module, method_hash)
+        target_module.module_eval do
+          method_hash.each do |old_method, new_method|
+            alias_method old_method, new_method
+          end
+        end
+
+        deprecate_methods(target_module, method_hash)
+      end
+    end
+
+    class FieldDeprecation < DeprecationBase
+      # this is a convenience deprecator for deprecated proto fields
+
+      def deprecate_method(target_module, method_name)
+        deprecate_methods(target_module, method_name => target_module)
+      end
+
+      private
+
+      def deprecated_method_warning(method_name, target_module)
+        "#{target_module.name}##{method_name} field usage is deprecated"
+      end
+    end
+  else
+    # TODO: remove this clause when Rails < 4 support is no longer needed
+    deprecator = ::ActiveSupport::Deprecation.clone
+    deprecator.instance_eval do
+      def new(deprecation_horizon = nil, *)
+        self.deprecation_horizon = deprecation_horizon if deprecation_horizon
+        self
+      end
+    end
+    Deprecation = deprecator.clone
+    FieldDeprecation = deprecator.clone
+
+    Deprecation.instance_eval do
+      def define_deprecated_methods(target_module, method_hash)
+        target_module.module_eval do
+          method_hash.each do |old_method, new_method|
+            alias_method old_method, new_method
+          end
+        end
+
+        deprecate_methods(target_module, method_hash)
+      end
+    end
+
+    FieldDeprecation.instance_eval do
+      def deprecate_method(target_module, method_name)
+        deprecate_methods(target_module, method_name => target_module)
+      end
+
+      private
+
+      def deprecated_method_warning(method_name, target_module)
+        "#{target_module.name}##{method_name} field usage is deprecated"
+      end
+    end
+  end
+
+  def self.deprecator
+    @deprecator ||= Deprecation.new('4.0', to_s).tap do |deprecation|
+      deprecation.silenced = ENV.key?('PB_IGNORE_DEPRECATIONS')
+      deprecation.behavior = :stderr
+    end
+  end
+
+  def self.field_deprecator
+    @field_deprecator ||= FieldDeprecation.new.tap do |deprecation|
+      deprecation.silenced = ENV.key?('PB_IGNORE_DEPRECATIONS')
+      deprecation.behavior = :stderr
+    end
+  end
+
+  # Print Deprecation Warnings
+  #
+  # Default: true
+  #
+  # Simple boolean to define whether we want field deprecation warnings to
+  # be printed to stderr or not. The rpc_server has an option to set this value
+  # explicitly, or you can turn this option off by setting
+  # ENV['PB_IGNORE_DEPRECATIONS'] to a non-empty value.
+  #
+  # The rpc_server option will override the ENV setting.
+  def self.print_deprecation_warnings?
+    !field_deprecator.silenced
+  end
+
+  def self.print_deprecation_warnings=(value)
+    field_deprecator.silenced = !value
+  end
+end

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

@@ -1,7 +1,9 @@
+# encoding: utf-8
+
 ##
 # This file is auto-generated. DO NOT EDIT!
 #
-require 'protobuf/message'
+require 'protobuf'
 
 
 ##
@@ -12,6 +14,7 @@ require 'google/protobuf/descriptor.pb'
 module Google
   module Protobuf
     module Compiler
+      ::Protobuf::Optionable.inject(self) { ::Google::Protobuf::FileOptions }
 
       ##
       # Message Classes
@@ -24,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

@@ -1,10 +1,13 @@
+# encoding: utf-8
+
 ##
 # 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
@@ -13,6 +16,7 @@ module Google
     class FileDescriptorProto < ::Protobuf::Message; end
     class DescriptorProto < ::Protobuf::Message
       class ExtensionRange < ::Protobuf::Message; end
+      class ReservedRange < ::Protobuf::Message; end
 
     end
 
@@ -46,6 +50,7 @@ module Google
 
     end
 
+    class OneofDescriptorProto < ::Protobuf::Message; end
     class EnumDescriptorProto < ::Protobuf::Message; end
     class EnumValueDescriptorProto < ::Protobuf::Message; end
     class ServiceDescriptorProto < ::Protobuf::Message; end
@@ -67,6 +72,12 @@ module Google
         define :STRING_PIECE, 2
       end
 
+      class JSType < ::Protobuf::Enum
+        define :JS_NORMAL, 0
+        define :JS_STRING, 1
+        define :JS_NUMBER, 2
+      end
+
     end
 
     class EnumOptions < ::Protobuf::Message; end
@@ -85,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
     #
@@ -104,6 +126,7 @@ module Google
       repeated ::Google::Protobuf::FieldDescriptorProto, :extension, 7
       optional ::Google::Protobuf::FileOptions, :options, 8
       optional ::Google::Protobuf::SourceCodeInfo, :source_code_info, 9
+      optional :string, :syntax, 12
     end
 
     class DescriptorProto
@@ -112,13 +135,21 @@ module Google
         optional :int32, :end, 2
       end
 
+      class ReservedRange
+        optional :int32, :start, 1
+        optional :int32, :end, 2
+      end
+
       optional :string, :name, 1
       repeated ::Google::Protobuf::FieldDescriptorProto, :field, 2
       repeated ::Google::Protobuf::FieldDescriptorProto, :extension, 6
       repeated ::Google::Protobuf::DescriptorProto, :nested_type, 3
       repeated ::Google::Protobuf::EnumDescriptorProto, :enum_type, 4
       repeated ::Google::Protobuf::DescriptorProto::ExtensionRange, :extension_range, 5
+      repeated ::Google::Protobuf::OneofDescriptorProto, :oneof_decl, 8
       optional ::Google::Protobuf::MessageOptions, :options, 7
+      repeated ::Google::Protobuf::DescriptorProto::ReservedRange, :reserved_range, 9
+      repeated :string, :reserved_name, 10
     end
 
     class FieldDescriptorProto
@@ -129,9 +160,15 @@ module Google
       optional :string, :type_name, 6
       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
 
+    class OneofDescriptorProto
+      optional :string, :name, 1
+    end
+
     class EnumDescriptorProto
       optional :string, :name, 1
       repeated ::Google::Protobuf::EnumValueDescriptorProto, :value, 2
@@ -155,6 +192,8 @@ module Google
       optional :string, :input_type, 2
       optional :string, :output_type, 3
       optional ::Google::Protobuf::MethodOptions, :options, 4
+      optional :bool, :client_streaming, 5, :default => false
+      optional :bool, :server_streaming, 6, :default => false
     end
 
     class FileOptions
@@ -162,11 +201,17 @@ module Google
       optional :string, :java_outer_classname, 8
       optional :bool, :java_multiple_files, 10, :default => false
       optional :bool, :java_generate_equals_and_hash, 20, :default => false
+      optional :bool, :java_string_check_utf8, 27, :default => false
       optional ::Google::Protobuf::FileOptions::OptimizeMode, :optimize_for, 9, :default => ::Google::Protobuf::FileOptions::OptimizeMode::SPEED
       optional :string, :go_package, 11
       optional :bool, :cc_generic_services, 16, :default => false
       optional :bool, :java_generic_services, 17, :default => false
       optional :bool, :py_generic_services, 18, :default => false
+      optional :bool, :deprecated, 23, :default => false
+      optional :bool, :cc_enable_arenas, 31, :default => false
+      optional :string, :objc_class_prefix, 36
+      optional :string, :csharp_namespace, 37
+      optional :bool, :javanano_use_deprecated_package, 38
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
@@ -175,6 +220,8 @@ module Google
     class MessageOptions
       optional :bool, :message_set_wire_format, 1, :default => false
       optional :bool, :no_standard_descriptor_accessor, 2, :default => false
+      optional :bool, :deprecated, 3, :default => false
+      optional :bool, :map_entry, 7
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
@@ -183,9 +230,9 @@ module Google
     class FieldOptions
       optional ::Google::Protobuf::FieldOptions::CType, :ctype, 1, :default => ::Google::Protobuf::FieldOptions::CType::STRING
       optional :bool, :packed, 2
+      optional ::Google::Protobuf::FieldOptions::JSType, :jstype, 6, :default => ::Google::Protobuf::FieldOptions::JSType::JS_NORMAL
       optional :bool, :lazy, 5, :default => false
       optional :bool, :deprecated, 3, :default => false
-      optional :string, :experimental_map_key, 9
       optional :bool, :weak, 10, :default => false
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
@@ -193,25 +240,29 @@ module Google
     end
 
     class EnumOptions
-      optional :bool, :allow_alias, 2, :default => true
+      optional :bool, :allow_alias, 2
+      optional :bool, :deprecated, 3, :default => false
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
     end
 
     class EnumValueOptions
+      optional :bool, :deprecated, 1, :default => false
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
     end
 
     class ServiceOptions
+      optional :bool, :deprecated, 33, :default => false
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
     end
 
     class MethodOptions
+      optional :bool, :deprecated, 33, :default => false
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
@@ -238,6 +289,7 @@ module Google
         repeated :int32, :span, 2, :packed => true
         optional :string, :leading_comments, 3
         optional :string, :trailing_comments, 4
+        repeated :string, :leading_detached_comments, 6
       end
 
       repeated ::Google::Protobuf::SourceCodeInfo::Location, :location, 1