google-protobuf 3.14.0 → 4.31.1

data/lib/google/protobuf/well_known_types.rb

@@ -1,33 +1,10 @@
 #!/usr/bin/ruby
 # Protocol Buffers - Google's data interchange format
 # Copyright 2008 Google Inc.  All rights reserved.
-# https://developers.google.com/protocol-buffers/
 #
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#     * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#     * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
 
 require 'google/protobuf/any_pb'
 require 'google/protobuf/duration_pb'
@@ -72,19 +49,18 @@ module Google
     end
 
     Timestamp.class_eval do
-      if RUBY_VERSION < "2.5"
-        def to_time
-          Time.at(self.to_f)
-        end
-      else
-        def to_time
-          Time.at(seconds, nanos, :nanosecond)
-        end
+      def to_time
+        Time.at(seconds, nanos, :nanosecond)
+      end
+
+      def self.from_time(time)
+        new.from_time(time)
       end
 
       def from_time(time)
         self.seconds = time.to_i
         self.nanos = time.nsec
+        self
       end
 
       def to_i
@@ -132,10 +108,14 @@ module Google
         end
       end
 
+      def self.from_ruby(value)
+        self.new.from_ruby(value)
+      end
+
       def from_ruby(value)
         case value
         when NilClass
-          self.null_value = 0
+          self.null_value = :NULL_VALUE
         when Numeric
           self.number_value = value
         when String
@@ -155,6 +135,8 @@ module Google
         else
           raise UnexpectedStructType
         end
+
+        self
       end
     end
 
@@ -225,6 +207,5 @@ module Google
         ret
       end
     end
-
   end
 end

data/lib/google/protobuf/wrappers_pb.rb

@@ -1,39 +1,14 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/protobuf/wrappers.proto
 
 require 'google/protobuf'
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/protobuf/wrappers.proto", :syntax => :proto3) do
-    add_message "google.protobuf.DoubleValue" do
-      optional :value, :double, 1
-    end
-    add_message "google.protobuf.FloatValue" do
-      optional :value, :float, 1
-    end
-    add_message "google.protobuf.Int64Value" do
-      optional :value, :int64, 1
-    end
-    add_message "google.protobuf.UInt64Value" do
-      optional :value, :uint64, 1
-    end
-    add_message "google.protobuf.Int32Value" do
-      optional :value, :int32, 1
-    end
-    add_message "google.protobuf.UInt32Value" do
-      optional :value, :uint32, 1
-    end
-    add_message "google.protobuf.BoolValue" do
-      optional :value, :bool, 1
-    end
-    add_message "google.protobuf.StringValue" do
-      optional :value, :string, 1
-    end
-    add_message "google.protobuf.BytesValue" do
-      optional :value, :bytes, 1
-    end
-  end
-end
+
+descriptor_data = "\n\x1egoogle/protobuf/wrappers.proto\x12\x0fgoogle.protobuf\"\x1c\n\x0b\x44oubleValue\x12\r\n\x05value\x18\x01 \x01(\x01\"\x1b\n\nFloatValue\x12\r\n\x05value\x18\x01 \x01(\x02\"\x1b\n\nInt64Value\x12\r\n\x05value\x18\x01 \x01(\x03\"\x1c\n\x0bUInt64Value\x12\r\n\x05value\x18\x01 \x01(\x04\"\x1b\n\nInt32Value\x12\r\n\x05value\x18\x01 \x01(\x05\"\x1c\n\x0bUInt32Value\x12\r\n\x05value\x18\x01 \x01(\r\"\x1a\n\tBoolValue\x12\r\n\x05value\x18\x01 \x01(\x08\"\x1c\n\x0bStringValue\x12\r\n\x05value\x18\x01 \x01(\t\"\x1b\n\nBytesValue\x12\r\n\x05value\x18\x01 \x01(\x0c\x42\x83\x01\n\x13\x63om.google.protobufB\rWrappersProtoP\x01Z1google.golang.org/protobuf/types/known/wrapperspb\xf8\x01\x01\xa2\x02\x03GPB\xaa\x02\x1eGoogle.Protobuf.WellKnownTypesb\x06proto3"
+
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
 
 module Google
   module Protobuf

data/lib/google/protobuf.rb

@@ -1,35 +1,13 @@
 # Protocol Buffers - Google's data interchange format
 # Copyright 2008 Google Inc.  All rights reserved.
-# https://developers.google.com/protocol-buffers/
 #
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#     * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#     * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
 
 # require mixins before we hook them into the java & c code
 require 'google/protobuf/message_exts'
+require 'google/protobuf/internal/object_cache'
 
 # We define these before requiring the platform-specific modules.
 # That way the module init can grab references to these.
@@ -38,110 +16,46 @@ module Google
     class Error < StandardError; end
     class ParseError < Error; end
     class TypeError < ::TypeError; end
-  end
-end
-
-if RUBY_PLATFORM == "java"
-  require 'json'
-  require 'google/protobuf_java'
-else
-  begin
-    require "google/#{RUBY_VERSION.sub(/\.\d+$/, '')}/protobuf_c"
-  rescue LoadError
-    require 'google/protobuf_c'
-  end
-
-  module Google
-    module Protobuf
-      module Internal
-        def self.infer_package(names)
-          # Package is longest common prefix ending in '.', if any.
-          if not names.empty?
-            min, max = names.minmax
-            last_common_dot = nil
-            min.size.times { |i|
-              if min[i] != max[i] then break end
-              if min[i] == ?. then last_common_dot = i end
-            }
-            if last_common_dot
-              return min.slice(0, last_common_dot)
-            end
-          end
-
-          nil
-        end
-
-        class NestingBuilder
-          def initialize(msg_names, enum_names)
-            @to_pos = {nil=>nil}
-            @msg_children = Hash.new { |hash, key| hash[key] = [] }
-            @enum_children = Hash.new { |hash, key| hash[key] = [] }
-
-            msg_names.each_with_index { |name, idx| @to_pos[name] = idx }
-            enum_names.each_with_index { |name, idx| @to_pos[name] = idx }
-
-            msg_names.each { |name| @msg_children[parent(name)] << name }
-            enum_names.each { |name| @enum_children[parent(name)] << name }
-          end
-
-          def build(package)
-            return build_msg(package)
-          end
-
-          private
-          def build_msg(msg)
-            return {
-              :pos => @to_pos[msg],
-              :msgs => @msg_children[msg].map { |child| build_msg(child) },
-              :enums => @enum_children[msg].map { |child| @to_pos[child] },
-            }
-          end
-
-          private
-          def parent(name)
-            idx = name.rindex(?.)
-            if idx
-              return name.slice(0, idx)
-            else
-              return nil
-            end
-          end
-        end
 
-        def self.fixup_descriptor(package, msg_names, enum_names)
-          if package.nil?
-            package = self.infer_package(msg_names + enum_names)
-          end
-
-          nesting = NestingBuilder.new(msg_names, enum_names).build(package)
-
-          return package, nesting
-        end
-      end
-    end
-  end
-end
-
-require 'google/protobuf/repeated_field'
-
-module Google
-  module Protobuf
-
-    def self.encode(msg)
-      msg.to_proto
+    PREFER_FFI = case ENV['PROTOCOL_BUFFERS_RUBY_IMPLEMENTATION']
+                 when nil, "", /^native$/i
+                   false
+                 when /^ffi$/i
+                   true
+                 else
+                   warn "Unexpected value `#{ENV['PROTOCOL_BUFFERS_RUBY_IMPLEMENTATION']}` for environment variable `PROTOCOL_BUFFERS_RUBY_IMPLEMENTATION`. Should be either \"FFI\", \"NATIVE\"."
+                   false
+                 end
+
+    def self.encode(msg, options = {})
+      msg.to_proto(options)
     end
 
     def self.encode_json(msg, options = {})
       msg.to_json(options)
     end
 
-    def self.decode(klass, proto)
-      klass.decode(proto)
+    def self.decode(klass, proto, options = {})
+      klass.decode(proto, options)
     end
 
     def self.decode_json(klass, json, options = {})
       klass.decode_json(json, options)
     end
 
+    IMPLEMENTATION = if PREFER_FFI
+      begin
+        require 'google/protobuf_ffi'
+        :FFI
+      rescue LoadError
+        warn "Caught exception `#{$!.message}` while loading FFI implementation of google/protobuf."
+        warn "Falling back to native implementation."
+        require 'google/protobuf_native'
+        :NATIVE
+      end
+    else
+      require 'google/protobuf_native'
+      :NATIVE
+    end
   end
 end

data/lib/google/protobuf_ffi.rb

@@ -0,0 +1,52 @@
+# Protocol Buffers - Google's data interchange format
+# Copyright 2023 Google Inc.  All rights reserved.
+#
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
+
+require 'ffi-compiler/loader'
+require 'google/protobuf/ffi/ffi'
+require 'google/protobuf/ffi/internal/type_safety'
+require 'google/protobuf/ffi/internal/pointer_helper'
+require 'google/protobuf/ffi/internal/arena'
+require 'google/protobuf/ffi/internal/convert'
+require 'google/protobuf/ffi/descriptor'
+require 'google/protobuf/ffi/enum_descriptor'
+require 'google/protobuf/ffi/field_descriptor'
+require 'google/protobuf/ffi/oneof_descriptor'
+require 'google/protobuf/ffi/method_descriptor'
+require 'google/protobuf/ffi/service_descriptor'
+require 'google/protobuf/ffi/file_descriptor'
+require 'google/protobuf/ffi/descriptor_pool'
+require 'google/protobuf/ffi/map'
+require 'google/protobuf/ffi/object_cache'
+require 'google/protobuf/ffi/repeated_field'
+require 'google/protobuf/ffi/message'
+
+module Google
+  module Protobuf
+    def self.deep_copy(object)
+      case object
+      when RepeatedField
+        RepeatedField.send(:deep_copy, object)
+      when Google::Protobuf::Map
+        Google::Protobuf::Map.deep_copy(object)
+      when Google::Protobuf::MessageExts
+        object.class.send(:deep_copy, object.instance_variable_get(:@msg))
+      else
+        raise NotImplementedError
+      end
+    end
+
+    def self.discard_unknown(message)
+      raise FrozenError if message.frozen?
+      raise ArgumentError.new "Expected message, got #{message.class} instead." if message.instance_variable_get(:@msg).nil?
+      pool_def = message.class.descriptor.instance_variable_get(:@descriptor_pool).descriptor_pool
+      unless Google::Protobuf::FFI.message_discard_unknown(message.instance_variable_get(:@msg), message.class.descriptor, pool_def, 128)
+        raise RuntimeError.new "Messages nested too deeply."
+      end
+      nil
+    end
+  end
+end

data/lib/google/protobuf_native.rb

@@ -0,0 +1,19 @@
+# Protocol Buffers - Google's data interchange format
+# Copyright 2023 Google Inc.  All rights reserved.
+#
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
+
+if RUBY_PLATFORM == "java"
+  require 'json'
+  require 'google/protobuf_java'
+else
+  begin
+    require "google/#{RUBY_VERSION.sub(/\.\d+$/, '')}/protobuf_c"
+  rescue LoadError
+    require 'google/protobuf_c'
+  end
+end
+
+require 'google/protobuf/repeated_field'

data/lib/google/tasks/ffi.rake

@@ -0,0 +1,100 @@
+# # @param task [FFI::Compiler::CompileTask] task to configure
+def configure_common_compile_task(task)
+  if FileUtils.pwd.include? 'ext'
+    src_dir = '.'
+    third_party_path = 'third_party/utf8_range'
+  else
+    src_dir = 'ext/google/protobuf_c'
+    third_party_path = 'ext/google/protobuf_c/third_party/utf8_range'
+  end
+
+  task.add_include_path third_party_path
+  task.add_define 'NDEBUG'
+  task.cflags << "-std=gnu99 -O3"
+  [
+    :convert, :defs, :map, :message, :protobuf, :repeated_field, :wrap_memcpy
+  ].each { |file| task.exclude << "/#{file}.c" }
+  task.ext_dir = src_dir
+  task.source_dirs = [src_dir]
+  if RbConfig::CONFIG['target_os'] =~ /darwin|linux/
+    task.cflags << "-Wall -Wsign-compare -Wno-declaration-after-statement"
+  end
+end
+
+# FFI::CompilerTask's constructor walks the filesystem at task definition time
+# to create subtasks for each source file, so files from third_party must be
+# copied into place before the task is defined for it to work correctly.
+# TODO Is there a sane way to check for generated protos under lib too?
+def with_generated_files
+  expected_path = FileUtils.pwd.include?('ext') ? 'third_party/utf8_range' : 'ext/google/protobuf_c/third_party/utf8_range'
+  if File.directory?(expected_path)
+    yield
+  else
+    task :default do
+      # It is possible, especially in cases like the first invocation of
+      # `rake test` following `rake clean` or a fresh checkout that the
+      # `copy_third_party` task has been executed since initial task definition.
+      # If so, run the task definition block now and invoke it explicitly.
+      if File.directory?(expected_path)
+        yield
+        Rake::Task[:default].invoke
+      else
+        raise "Missing directory #{File.absolute_path(expected_path)}." +
+                " Did you forget to run `rake copy_third_party` before building" +
+                " native extensions?"
+      end
+    end
+  end
+end
+
+begin
+  require "ffi-compiler/compile_task"
+
+  desc "Compile Protobuf library for FFI"
+  namespace "ffi-protobuf" do
+    with_generated_files do
+      # Compile Ruby UPB separately in order to limit use of -DUPB_BUILD_API to one
+      # compilation unit.
+      desc "Compile UPB library for FFI"
+      namespace "ffi-upb" do
+        with_generated_files do
+          FFI::Compiler::CompileTask.new('ruby-upb') do |c|
+            configure_common_compile_task c
+            c.add_define "UPB_BUILD_API"
+            c.exclude << "/glue.c"
+            c.exclude << "/shared_message.c"
+            c.exclude << "/shared_convert.c"
+            if RbConfig::CONFIG['target_os'] =~ /darwin|linux/
+              c.cflags << "-fvisibility=hidden"
+            end
+          end
+        end
+      end
+
+      FFI::Compiler::CompileTask.new 'protobuf_c_ffi' do |c|
+        configure_common_compile_task c
+        # Ruby UPB was already compiled with different flags.
+        c.exclude << "/utf8_range.c"
+        c.exclude << "/ruby-upb.c"
+      end
+
+      # Setup dependencies so that the .o files generated by building ffi-upb are
+      # available to link here.
+      # TODO Can this be simplified? Can the single shared library be used
+      # instead of the object files?
+      protobuf_c_task = Rake::Task[:default]
+      protobuf_c_shared_lib_task = Rake::Task[protobuf_c_task.prereqs.last]
+      ruby_upb_shared_lib_task = Rake::Task[:"ffi-upb:default"].prereqs.first
+      Rake::Task[ruby_upb_shared_lib_task].prereqs.each do |dependency|
+        protobuf_c_shared_lib_task.prereqs.prepend dependency
+      end
+    end
+  end
+rescue LoadError
+  desc "Compile Protobuf library for FFI"
+  namespace "ffi-protobuf" do
+    task :default do
+      warn "Skipping build of FFI; `gem install ffi-compiler` to enable."
+    end
+  end
+end