protobuffy 3.1.0

data/lib/protobuf/field/string_field.rb

@@ -0,0 +1,35 @@
+require 'protobuf/field/bytes_field'
+
+module Protobuf
+  module Field
+    class StringField < BytesField
+
+      ##
+      # Constants
+      #
+
+      ENCODING = 'UTF-8'.freeze
+
+      ##
+      # Public Instance Methods
+      #
+
+      def decode(bytes)
+        bytes_to_decode = bytes.dup
+        bytes_to_decode.force_encoding(::Protobuf::Field::StringField::ENCODING)
+        bytes_to_decode
+      end
+
+      def encode(value)
+        value_to_encode = value.dup
+        value_to_encode.encode!(::Protobuf::Field::StringField::ENCODING, :invalid => :replace, :undef => :replace, :replace => "")
+        value_to_encode.force_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
+
+        string_size = ::Protobuf::Field::VarintField.encode(value_to_encode.size)
+        string_size << value_to_encode
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/field/uint32_field.rb

@@ -0,0 +1,22 @@
+require 'protobuf/field/varint_field'
+
+module Protobuf
+  module Field
+    class Uint32Field < VarintField
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        UINT32_MAX
+      end
+
+      def self.min
+        0
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/field/uint64_field.rb

@@ -0,0 +1,22 @@
+require 'protobuf/field/varint_field'
+
+module Protobuf
+  module Field
+    class Uint64Field < VarintField
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        UINT64_MAX
+      end
+
+      def self.min
+        0
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/field/varint_field.rb

@@ -0,0 +1,68 @@
+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)
+        bytes = []
+        until value < 128
+          bytes << (0x80 | (value & 0x7f))
+          value >>= 7
+        end
+        (bytes << value).pack('C*')
+      end
+
+      ##
+      # Public Instance Methods
+      #
+
+      def acceptable?(val)
+        (val > self.class.min || val < self.class.max)
+      rescue
+        false
+      end
+
+      def decode(value)
+        value
+      end
+
+      def encode(value)
+        return [value].pack('C') if value < 128
+
+        bytes = []
+        until value == 0
+          bytes << (0x80 | (value & 0x7f))
+          value >>= 7
+        end
+        bytes[-1] &= 0x7f
+        bytes.pack('C*')
+      end
+
+      def wire_type
+        ::Protobuf::WireType::VARINT
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/base.rb

@@ -0,0 +1,71 @@
+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')
+          range = (tags.min)..(tags.max)
+          if range.respond_to?(:size)
+            expected_size = range.size
+          else
+            expected_size = range.to_a.size
+          end
+
+          if tags.size < expected_size
+            ::Protobuf::CodeGenerator.print_tag_warning_suppress
+            ::Protobuf::CodeGenerator.warn("#{type_name} object should have #{expected_size} tags (#{range.begin}..#{range.end}), 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, &block)
+        tracker_ivar = "@_#{label}_compiled"
+        value_ivar = "@_#{label}_compiled_value"
+
+        if instance_variable_get(tracker_ivar)
+          return instance_variable_get(value_ivar)
+        else
+          return_value = block.call
+          instance_variable_set(tracker_ivar, true)
+          instance_variable_set(value_ivar, return_value)
+          return return_value
+        end
+      end
+
+      def to_s
+        compile
+        print_contents # see Printable
+      end
+
+      def type_namespace
+        @type_namespace ||= @namespace + [ descriptor.name ]
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/enum_generator.rb

@@ -0,0 +1,42 @@
+require 'protobuf/generators/base'
+
+module Protobuf
+  module Generators
+    class EnumGenerator < Base
+
+      def allow_alias?
+        descriptor.options.try(:allow_alias!) { false }
+      end
+
+      def compile
+        run_once(:compile) do
+          tags = []
+
+          print_class(descriptor.name, :enum) do
+            if allow_alias?
+              puts "set_option :allow_alias"
+              puts
+            end
+
+            descriptor.value.each do |enum_value_descriptor|
+              tags << enum_value_descriptor.number
+              puts build_value(enum_value_descriptor)
+            end
+          end
+
+          unless 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
+        number = enum_value_descriptor.number
+        return "define :#{name}, #{number}"
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/extension_generator.rb

@@ -0,0 +1,28 @@
+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,132 @@
+require 'protobuf/generators/base'
+
+module Protobuf
+  module Generators
+    class FieldGenerator < Base
+
+      ##
+      # Constants
+      #
+      PROTO_INFINITY_DEFAULT          = /^inf$/i.freeze
+      PROTO_NEGATIVE_INFINITY_DEFAULT = /^-inf$/i.freeze
+      PROTO_NAN_DEFAULT               = /^nan$/i.freeze
+      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 applicable_options
+        @applicable_options ||= field_options.map { |k, v| ":#{k} => #{v}" }
+      end
+
+      def default_value
+        @default_value ||= begin
+                             if defaulted?
+                               case descriptor.type.name
+                               when :TYPE_ENUM then
+                                 enum_default_value
+                               when :TYPE_STRING, :TYPE_BYTES then
+                                 string_default_value
+                               when :TYPE_FLOAT, :TYPE_DOUBLE then
+                                 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 = [ "#{label} #{type_name}", name, number, applicable_options ]
+          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}"
+      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?
+                             opts
+                           end
+      end
+
+      def packed?
+        descriptor.options.try(:packed?) { false }
+      end
+
+      # Determine the field type
+      def type_name
+        @type_name ||= begin
+                         case descriptor.type.name
+                         when :TYPE_MESSAGE, :TYPE_ENUM, :TYPE_GROUP then
+                           type_name = modulize(descriptor.type_name)
+                         else
+                           type_name = descriptor.type.name.to_s.downcase.sub(/type_/, '')
+                           type_name = ":#{type_name}"
+                         end
+                       end
+      end
+
+      private
+
+      def enum_default_value
+        "#{type_name}::#{verbatim_default_value}"
+      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
+        %Q{"#{verbatim_default_value.gsub(/'/, '\\\\\'')}"}
+      end
+
+      def verbatim_default_value
+        descriptor.default_value
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/file_generator.rb

@@ -0,0 +1,140 @@
+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 = []
+        @dangling_messages = {}
+      end
+
+      def file_name
+        convert_filename(descriptor.name, false)
+      end
+
+      def compile
+        run_once(:compile) do
+          map_extensions(descriptor, [ descriptor.package ])
+          extract_dangling_extensions
+
+          print_file_comment
+          print_generic_requires
+          print_import_requires
+
+          print_package do
+            group = GroupGenerator.new(current_indent)
+            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(: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 extract_dangling_extensions
+        @unknown_extensions = @extension_fields.select do |k, v|
+          ! @known_messages.include?(k)
+        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)
+        # Record all the message descriptor name's we encounter (should be the whole tree).
+        if descriptor.is_a?(::Google::Protobuf::DescriptorProto)
+          if fully_qualified_token?(descriptor.name)
+            @known_messages << descriptor.name
+          else
+            fully_qualified_namespace = ".#{namespaces.join('.')}"
+            @known_messages << fully_qualified_namespace
+          end
+        end
+
+        descriptor.extension.each do |field_descriptor|
+          @extension_fields[field_descriptor.extendee] << field_descriptor
+        end
+
+        if descriptor.respond_to_has_and_present?(:message_type)
+          descriptor.message_type.each do |message_descriptor|
+            map_extensions(message_descriptor, (namespaces + [ message_descriptor.name ]))
+          end
+        end
+
+        if descriptor.respond_to_has_and_present?(:nested_type)
+          descriptor.nested_type.each do |nested_descriptor|
+            map_extensions(nested_descriptor, (namespaces + [ nested_descriptor.name ]))
+          end
+        end
+      end
+
+      def print_file_comment
+        puts "##"
+        puts "# This file is auto-generated. DO NOT EDIT!"
+        puts "#"
+      end
+
+      def print_generic_requires
+        print_require("protobuf/message")
+        print_require("protobuf/rpc/service") if descriptor.service.count > 0
+        puts
+      end
+
+      def print_import_requires
+        if descriptor.dependency.count > 0
+          header "Imports"
+
+          descriptor.dependency.each do |dependency|
+            print_require(convert_filename(dependency))
+          end
+
+          puts
+        end
+      end
+
+      def print_package(&block)
+        final = lambda { block.call }
+        namespaces = descriptor.package.split('.')
+        namespaces.reverse.inject(final) { |previous, namespace|
+          lambda { print_module(namespace, &previous) }
+        }.call
+      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
+
+    end
+  end
+end
+