protobuf-cucumber 3.10.4

data/lib/protobuf/field/varint_field.rb

@@ -0,0 +1,77 @@
+require 'protobuf/field/base_field'
+
+module Protobuf
+  module Field
+    class VarintField < BaseField
+
+      ##
+      # Constants
+      #
+      INT32_MAX  =  2**31 - 1
+      INT32_MIN  = -2**31
+      INT64_MAX  =  2**63 - 1
+      INT64_MIN  = -2**63
+      UINT32_MAX =  2**32 - 1
+      UINT64_MAX =  2**64 - 1
+
+      ##
+      # Class Methods
+      #
+
+      def self.default
+        0
+      end
+
+      def self.encode(value)
+        ::Protobuf::Varint.encode(value)
+      end
+
+      ##
+      # Public Instance Methods
+      #
+      def acceptable?(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)
+        if val.is_a?(Integer) && val >= 0 && val <= INT32_MAX
+          val
+        else
+          fail TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'" unless acceptable?(val)
+
+          if val.is_a?(Integer) || val.is_a?(Numeric)
+            val.to_i
+          else
+            Integer(val, 10)
+          end
+        end
+      rescue ArgumentError
+        fail TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'"
+      end
+
+      def decode(value)
+        value
+      end
+
+      def encode(value)
+        ::Protobuf::Field::VarintField.encode(value)
+      end
+
+      def wire_type
+        ::Protobuf::WireType::VARINT
+      end
+
+    end
+  end
+end

data/lib/protobuf/generators/base.rb

@@ -0,0 +1,85 @@
+require 'protobuf/generators/printable'
+
+module Protobuf
+  module Generators
+    class Base
+      include ::Protobuf::Generators::Printable
+
+      def self.validate_tags(type_name, tags)
+        return if tags.empty?
+
+        unique_tags = tags.uniq
+
+        if unique_tags.size < tags.size
+          ::Protobuf::CodeGenerator.fatal("#{type_name} object has duplicate tags. Expected #{unique_tags.size} tags, but got #{tags.size}. Suppress with PB_NO_TAG_WARNINGS=1.")
+        end
+
+        unless ENV.key?('PB_NO_TAG_WARNINGS')
+          expected_size = tags.max - tags.min + 1
+          if tags.size < expected_size
+            ::Protobuf::CodeGenerator.print_tag_warning_suppress
+            ::Protobuf::CodeGenerator.warn("#{type_name} object should have #{expected_size} tags (#{tags.min}..#{tags.max}), but found #{tags.size} tags.")
+          end
+        end
+      end
+
+      attr_reader :descriptor, :namespace, :options
+
+      def initialize(descriptor, indent_level = 0, options = {})
+        @descriptor = descriptor
+        @options = options
+        @namespace = @options.fetch(:namespace) { [] }
+        init_printer(indent_level)
+      end
+
+      def fully_qualified_type_namespace
+        ".#{type_namespace.join('.')}"
+      end
+
+      def run_once(label)
+        tracker_ivar = "@_#{label}_compiled"
+        value_ivar = "@_#{label}_compiled_value"
+
+        if instance_variable_get(tracker_ivar)
+          return instance_variable_get(value_ivar)
+        end
+
+        return_value = yield
+        instance_variable_set(tracker_ivar, true)
+        instance_variable_set(value_ivar, return_value)
+        return_value
+      end
+
+      def to_s
+        compile
+        print_contents # see Printable
+      end
+
+      def type_namespace
+        @type_namespace ||= @namespace + [descriptor.name]
+      end
+
+      def serialize_value(value)
+        case value
+        when Message
+          fields = value.each_field.map do |field, inner_value|
+            next unless value.field?(field.name)
+            serialized_inner_value = serialize_value(inner_value)
+            "#{field.fully_qualified_name.inspect} => #{serialized_inner_value}"
+          end.compact
+          "{ #{fields.join(', ')} }"
+        when Enum
+          "::#{value.parent_class}::#{value.name}"
+        when String
+          value.inspect
+        when nil
+          "nil"
+        when Array
+          '[' + value.map { |x| serialize_value(x) }.join(', ') + ']'
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/protobuf/generators/enum_generator.rb

@@ -0,0 +1,39 @@
+require 'protobuf/generators/base'
+require 'protobuf/generators/option_generator'
+
+module Protobuf
+  module Generators
+    class EnumGenerator < Base
+
+      def compile
+        run_once(:compile) do
+          tags = []
+
+          print_class(descriptor.name, :enum) do
+            if descriptor.options
+              print OptionGenerator.new(descriptor.options, current_indent).to_s
+              puts
+            end
+
+            descriptor.value.each do |enum_value_descriptor|
+              tags << enum_value_descriptor.number
+              puts build_value(enum_value_descriptor)
+            end
+          end
+
+          unless descriptor.options.try(:allow_alias)
+            self.class.validate_tags(fully_qualified_type_namespace, tags)
+          end
+        end
+      end
+
+      def build_value(enum_value_descriptor)
+        name = enum_value_descriptor.name
+        name.upcase! if ENV.key?('PB_UPCASE_ENUMS')
+        number = enum_value_descriptor.number
+        "define :#{name}, #{number}"
+      end
+
+    end
+  end
+end

data/lib/protobuf/generators/extension_generator.rb

@@ -0,0 +1,27 @@
+require 'protobuf/generators/base'
+require 'protobuf/generators/group_generator'
+
+module Protobuf
+  module Generators
+    class ExtensionGenerator < Base
+
+      def initialize(message_type, field_descriptors, indent_level)
+        super(nil, indent_level)
+        @message_type = modulize(message_type)
+        @field_descriptors = field_descriptors
+      end
+
+      def compile
+        run_once(:compile) do
+          print_class(@message_type, :message) do
+            group = GroupGenerator.new(current_indent)
+            group.add_extension_fields(@field_descriptors)
+            group.order = [:extension_field]
+            print group.to_s
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/protobuf/generators/field_generator.rb

@@ -0,0 +1,193 @@
+require 'protobuf/generators/base'
+
+module Protobuf
+  module Generators
+    class FieldGenerator < Base
+
+      ##
+      # Constants
+      #
+      PROTO_INFINITY_DEFAULT          = /^inf$/i
+      PROTO_NEGATIVE_INFINITY_DEFAULT = /^-inf$/i
+      PROTO_NAN_DEFAULT               = /^nan$/i
+      RUBY_INFINITY_DEFAULT           = '::Float::INFINITY'.freeze
+      RUBY_NEGATIVE_INFINITY_DEFAULT  = '-::Float::INFINITY'.freeze
+      RUBY_NAN_DEFAULT                = '::Float::NAN'.freeze
+
+      ##
+      # Attributes
+      #
+      attr_reader :field_options
+
+      def initialize(field_descriptor, enclosing_msg_descriptor, indent_level)
+        super(field_descriptor, indent_level)
+        @enclosing_msg_descriptor = enclosing_msg_descriptor
+      end
+
+      def applicable_options
+        # Note on the strange use of `#inspect`:
+        #   :boom.inspect #=> ":boom"
+        #   :".boom.foo".inspect #=> ":\".boom.foo\""
+        # An alternative to `#inspect` would be always adding double quotes,
+        # but the generatated code looks un-idiomatic:
+        #   ":\"#{:boom}\"" #=> ":\"boom\"" <-- Note the unnecessary double quotes
+        @applicable_options ||= field_options.map { |k, v| "#{k.inspect} => #{v}" }
+      end
+
+      def default_value
+        @default_value ||= begin
+                             if defaulted?
+                               case descriptor.type.name
+                               when :TYPE_ENUM
+                                 enum_default_value
+                               when :TYPE_STRING, :TYPE_BYTES
+                                 string_default_value
+                               when :TYPE_FLOAT, :TYPE_DOUBLE
+                                 float_double_default_value
+                               else
+                                 verbatim_default_value
+                               end
+                             end
+                           end
+      end
+
+      def defaulted?
+        descriptor.respond_to_has_and_present?(:default_value)
+      end
+
+      def deprecated?
+        descriptor.options.try(:deprecated?) { false }
+      end
+
+      def extension?
+        descriptor.respond_to_has_and_present?(:extendee)
+      end
+
+      def compile
+        run_once(:compile) do
+          field_definition = if map?
+                               ["map #{map_key_type_name}", map_value_type_name, name, number, applicable_options]
+                             else
+                               ["#{label} #{type_name}", name, number, applicable_options]
+                             end
+          puts field_definition.flatten.compact.join(', ')
+        end
+      end
+
+      def label
+        @label ||= descriptor.label.name.to_s.downcase.sub(/label_/, '') # required, optional, repeated
+      end
+
+      def name
+        @name ||= descriptor.name.to_sym.inspect
+      end
+
+      def number
+        @number ||= descriptor.number
+      end
+
+      def field_options
+        @field_options ||= begin
+                             opts = {}
+                             opts[:default] = default_value if defaulted?
+                             opts[:packed] = 'true' if packed?
+                             opts[:deprecated] = 'true' if deprecated?
+                             opts[:extension] = 'true' if extension?
+                             if descriptor.options
+                               descriptor.options.each_field do |field_option|
+                                 next unless descriptor.options.field?(field_option.name)
+                                 option_value = descriptor.options[field_option.name]
+                                 opts[field_option.fully_qualified_name] = serialize_value(option_value)
+                               end
+                             end
+                             opts
+                           end
+      end
+
+      def packed?
+        descriptor.options.try(:packed?) { false }
+      end
+
+      # Determine the field type
+      def type_name
+        @type_name ||= determine_type_name(descriptor)
+      end
+
+      # If this field is a map field, this returns a message descriptor that
+      # represents the entries in the map. Returns nil if this field is not
+      # a map field.
+      def map_entry
+        @map_entry ||= determine_map_entry
+      end
+
+      def map?
+        !map_entry.nil?
+      end
+
+      def map_key_type_name
+        return nil if map_entry.nil?
+        determine_type_name(map_entry.field.find { |v| v.name == 'key' && v.number == 1 })
+      end
+
+      def map_value_type_name
+        return nil if map_entry.nil?
+        determine_type_name(map_entry.field.find { |v| v.name == 'value' && v.number == 2 })
+      end
+
+      private
+
+      def enum_default_value
+        optionally_upcased_default =
+          if ENV.key?('PB_UPCASE_ENUMS')
+            verbatim_default_value.upcase
+          else
+            verbatim_default_value
+          end
+        "#{type_name}::#{optionally_upcased_default}"
+      end
+
+      def float_double_default_value
+        case verbatim_default_value
+        when PROTO_INFINITY_DEFAULT then
+          RUBY_INFINITY_DEFAULT
+        when PROTO_NEGATIVE_INFINITY_DEFAULT then
+          RUBY_NEGATIVE_INFINITY_DEFAULT
+        when PROTO_NAN_DEFAULT then
+          RUBY_NAN_DEFAULT
+        else
+          verbatim_default_value
+        end
+      end
+
+      def string_default_value
+        %("#{verbatim_default_value.gsub(/'/, '\\\\\'')}")
+      end
+
+      def verbatim_default_value
+        descriptor.default_value
+      end
+
+      def determine_type_name(descriptor)
+        case descriptor.type.name
+        when :TYPE_MESSAGE, :TYPE_ENUM, :TYPE_GROUP then
+          modulize(descriptor.type_name)
+        else
+          type_name = descriptor.type.name.to_s.downcase.sub(/^type_/, '')
+          ":#{type_name}"
+        end
+      end
+
+      def determine_map_entry
+        return nil if @enclosing_msg_descriptor.nil?
+        return nil unless descriptor.label.name == :LABEL_REPEATED && descriptor.type.name == :TYPE_MESSAGE
+        # find nested message type
+        name_parts = descriptor.type_name.split(".")
+        return nil if name_parts.size < 2 || name_parts[-2] != @enclosing_msg_descriptor.name
+        nested = @enclosing_msg_descriptor.nested_type.find { |e| e.name == name_parts[-1] }
+        return nested if !nested.nil? && nested.options.try(:map_entry?)
+        nil
+      end
+
+    end
+  end
+end

data/lib/protobuf/generators/file_generator.rb

@@ -0,0 +1,262 @@
+require 'set'
+require 'protobuf/generators/base'
+require 'protobuf/generators/group_generator'
+
+module Protobuf
+  module Generators
+    class FileGenerator < Base
+
+      attr_reader :output_file
+
+      def initialize(*args)
+        super
+        @output_file = ::Google::Protobuf::Compiler::CodeGeneratorResponse::File.new(:name => file_name)
+        @extension_fields = Hash.new { |h, k| h[k] = [] }
+        @known_messages = {}
+        @known_enums = {}
+        @dangling_messages = {}
+      end
+
+      def file_name
+        convert_filename(descriptor.name, false)
+      end
+
+      def compile
+        run_once(:compile) do
+          map_extensions(descriptor, [descriptor.package])
+
+          print_file_comment
+          print_generic_requires
+          print_import_requires
+
+          print_package do
+            inject_optionable
+            group = GroupGenerator.new(current_indent)
+            group.add_options(descriptor.options) if descriptor.options
+            group.add_enums(descriptor.enum_type, :namespace => [descriptor.package])
+            group.add_message_declarations(descriptor.message_type)
+            group.add_messages(descriptor.message_type, :extension_fields => @extension_fields, :namespace => [descriptor.package])
+            group.add_extended_messages(unknown_extensions)
+            group.add_services(descriptor.service)
+
+            group.add_header(:enum, 'Enum Classes')
+            group.add_header(:message_declaration, 'Message Classes')
+            group.add_header(:options, 'File Options')
+            group.add_header(:message, 'Message Fields')
+            group.add_header(:extended_message, 'Extended Message Fields')
+            group.add_header(:service, 'Service Classes')
+            print group.to_s
+          end
+
+        end
+      end
+
+      def unknown_extensions
+        @unknown_extensions ||= @extension_fields.map do |message_name, fields|
+          message_klass = modulize(message_name).safe_constantize
+          if message_klass
+            unknown_fields = fields.reject do |field|
+              @known_messages[message_name] && message_klass.get_field(field.name, true)
+            end
+            [message_name, unknown_fields]
+          else
+            [message_name, fields]
+          end
+        end
+      end
+
+      def generate_output_file
+        compile
+        output_file.content = to_s
+        output_file
+      end
+
+      # Recursively map out all extensions known in this file.
+      # The key is the type_name of the message being extended, and
+      # the value is an array of field descriptors.
+      #
+      def map_extensions(descriptor, namespaces)
+        if fully_qualified_token?(descriptor.name)
+          fully_qualified_namespace = descriptor.name
+        elsif !(namespace = namespaces.reject(&:empty?).join(".")).empty?
+          fully_qualified_namespace = ".#{namespace}"
+        end
+        # Record all the message descriptor name's we encounter (should be the whole tree).
+        if descriptor.is_a?(::Google::Protobuf::DescriptorProto)
+          @known_messages[fully_qualified_namespace || descriptor.name] = descriptor
+        elsif descriptor.is_a?(::Google::Protobuf::EnumDescriptorProto)
+          @known_enums[fully_qualified_namespace || descriptor.name] = descriptor
+          return
+        end
+
+        descriptor.extension.each do |field_descriptor|
+          unless fully_qualified_token?(field_descriptor.name) && fully_qualified_namespace
+            field_descriptor.name = "#{fully_qualified_namespace}.#{field_descriptor.name}"
+          end
+          @extension_fields[field_descriptor.extendee] << field_descriptor
+        end
+
+        [:message_type, :nested_type, :enum_type].each do |type|
+          next unless descriptor.respond_to_has_and_present?(type)
+
+          descriptor.public_send(type).each do |type_descriptor|
+            map_extensions(type_descriptor, (namespaces + [type_descriptor.name]))
+          end
+        end
+      end
+
+      def print_file_comment
+        puts "# encoding: utf-8"
+        puts
+        puts "##"
+        puts "# This file is auto-generated. DO NOT EDIT!"
+        puts "#"
+      end
+
+      def print_generic_requires
+        print_require("protobuf")
+        print_require("protobuf/rpc/service") if descriptor.service.count > 0
+        puts
+      end
+
+      def print_import_requires
+        return if descriptor.dependency.empty?
+
+        header "Imports"
+
+        descriptor.dependency.each do |dependency|
+          print_require(convert_filename(dependency), ENV.key?('PB_REQUIRE_RELATIVE'))
+        end
+
+        puts
+      end
+
+      def print_package(&block)
+        namespaces = descriptor.package.split('.')
+        if namespaces.empty? && ENV.key?('PB_ALLOW_DEFAULT_PACKAGE_NAME')
+          namespaces = [File.basename(descriptor.name).sub('.proto', '')]
+        end
+        namespaces.reverse.reduce(block) do |previous, namespace|
+          -> { print_module(namespace, &previous) }
+        end.call
+      end
+
+      def eval_unknown_extensions!
+        @@evaled_dependencies ||= Set.new # rubocop:disable Style/ClassVars
+        @@all_messages ||= {} # rubocop:disable Style/ClassVars
+        @@all_enums ||= {} # rubocop:disable Style/ClassVars
+
+        map_extensions(descriptor, [descriptor.package])
+        @known_messages.each do |name, descriptor|
+          @@all_messages[name] = descriptor
+        end
+        @known_enums.each do |name, descriptor|
+          @@all_enums[name] = descriptor
+        end
+
+        # create package namespace
+        print_package {}
+        eval_code
+
+        unknown_extensions.each do |extendee, fields|
+          eval_dependencies(extendee)
+          fields.each do |field|
+            eval_dependencies(field.type_name)
+          end
+        end
+        group = GroupGenerator.new(0)
+        group.add_extended_messages(unknown_extensions, false)
+        print group.to_s
+        eval_code
+      rescue => e
+        warn "Error loading unknown extensions #{descriptor.name.inspect} error=#{e}"
+        raise e
+      end
+
+      private
+
+      def convert_filename(filename, for_require = true)
+        filename.sub(/\.proto/, (for_require ? '.pb' : '.pb.rb'))
+      end
+
+      def fully_qualified_token?(token)
+        token[0] == '.'
+      end
+
+      def eval_dependencies(name, namespace = nil)
+        name = "#{namespace}.#{name}" if namespace && !fully_qualified_token?(name)
+        return if name.empty? || @@evaled_dependencies.include?(name) || modulize(name).safe_constantize
+
+        # if name = .foo.bar.Baz look for classes / modules named ::Foo::Bar and ::Foo
+        # module == pure namespace (e.g. the descriptor package name)
+        # class == nested messages
+        create_ruby_namespace_heiarchy(name)
+
+        if (message = @@all_messages[name])
+          # Create the blank namespace in case there are nested types
+          eval_message_code(name)
+
+          message.nested_type.each do |nested_type|
+            eval_dependencies(nested_type.name, name) unless nested_type.name.empty?
+          end
+          message.field.each do |field|
+            eval_dependencies(field.type_name, name) unless field.type_name.empty?
+          end
+          message.enum_type.each do |enum_type|
+            eval_dependencies(enum_type.name, name)
+          end
+
+          # Check @@evaled_dependencies again in case there was a dependency
+          # loop that already loaded this message
+          return if @@evaled_dependencies.include?(name)
+          eval_message_code(name, message.field)
+          @@evaled_dependencies << name
+
+        elsif (enum = @@all_enums[name])
+          # Check @@evaled_dependencies again in case there was a dependency
+          # loop that already loaded this enum
+          return if @@evaled_dependencies.include?(name)
+          namespace = name.split(".")
+          eval_enum_code(enum, namespace[0..-2].join("."))
+          @@evaled_dependencies << name
+        else
+          fail "Error loading unknown dependencies, could not find message or enum #{name.inspect}"
+        end
+      end
+
+      def eval_message_code(fully_qualified_namespace, fields = [])
+        group = GroupGenerator.new(0)
+        group.add_extended_messages({ fully_qualified_namespace => fields }, false)
+        print group.to_s
+        eval_code
+      end
+
+      def eval_enum_code(enum, fully_qualified_namespace)
+        group = GroupGenerator.new(0)
+        group.add_enums([enum], :namespace => [fully_qualified_namespace])
+        print group.to_s
+        eval_code(modulize(fully_qualified_namespace).safe_constantize || Object)
+      end
+
+      def eval_code(context = Object)
+        warn "#{context.inspect}.module_eval #{print_contents.inspect}" if ENV['PB_DEBUG']
+        context.module_eval print_contents.to_s
+        @io.truncate(0)
+        @io.rewind
+      end
+
+      def create_ruby_namespace_heiarchy(namespace)
+        loop do
+          namespace, _match, _tail = namespace.rpartition(".")
+          break if namespace.empty?
+          eval_dependencies(namespace)
+        end
+      end
+
+      def inject_optionable
+        return if descriptor.package.empty? && !ENV.key?('PB_ALLOW_DEFAULT_PACKAGE_NAME')
+        puts "::Protobuf::Optionable.inject(self) { ::Google::Protobuf::FileOptions }"
+      end
+    end
+  end
+end