Class: Tapioca::Compilers::Dsl::Protobuf

Inherits:
Base
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/tapioca/compilers/dsl/protobuf.rb

Overview

`Tapioca::Compilers::Dsl::Protobuf` decorates RBI files for subclasses of [`Google::Protobuf::MessageExts`](github.com/protocolbuffers/protobuf/tree/master/ruby).

For example, with the following “cart.rb” file:

~~~rb Google::Protobuf::DescriptorPool.generated_pool.build do

add_file("cart.proto", :syntax => :proto3) do
  add_message "MyCart" do
    optional :shop_id, :int32, 1
    optional :customer_id, :int64, 2
    optional :number_value, :double, 3
    optional :string_value, :string, 4
  end
end

end ~~~

this generator will produce the RBI file `cart.rbi` with the following content:

~~~rbi # cart.rbi # typed: strong class Cart

sig { returns(Integer) }
def customer_id; end

sig { params(month: Integer).returns(Integer) }
def customer_id=(value); end

sig { returns(Integer) }
def shop_id; end

sig { params(value: Integer).returns(Integer) }
def shop_id=(value); end

sig { returns(String) }
def string_value; end

sig { params(value: String).returns(String) }
def string_value=(value); end

sig { returns(Float) }
def number_value; end

sig { params(value: Float).returns(Float) }
def number_value=(value); end

end ~~~

Defined Under Namespace

Classes: Field

Constant Summary

Constants included from Reflection

Reflection::ANCESTORS_METHOD, Reflection::CLASS_METHOD, Reflection::CONSTANTS_METHOD, Reflection::EQUAL_METHOD, Reflection::METHOD_METHOD, Reflection::NAME_METHOD, Reflection::OBJECT_ID_METHOD, Reflection::PRIVATE_INSTANCE_METHODS_METHOD, Reflection::PROTECTED_INSTANCE_METHODS_METHOD, Reflection::PUBLIC_INSTANCE_METHODS_METHOD, Reflection::SINGLETON_CLASS_METHOD, Reflection::SUPERCLASS_METHOD

Instance Attribute Summary

Attributes inherited from Base

#errors, #processable_constants

Instance Method Summary collapse

Methods inherited from Base

#add_error, #handles?, #initialize

Methods included from Reflection

#ancestors_of, #are_equal?, #class_of, #constants_of, #descendants_of, #inherited_ancestors_of, #method_of, #name_of, #name_of_type, #object_id_of, #private_instance_methods_of, #protected_instance_methods_of, #public_instance_methods_of, #qualified_name_of, #signature_of, #singleton_class_of, #superclass_of

Constructor Details

This class inherits a constructor from Tapioca::Compilers::Dsl::Base

Instance Method Details

#decorate(root, constant) ⇒ Object


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/tapioca/compilers/dsl/protobuf.rb', line 74

def decorate(root, constant)
  root.create_path(constant) do |klass|
    if constant == Google::Protobuf::RepeatedField
      create_type_members(klass, "Elem")
    elsif constant == Google::Protobuf::Map
      create_type_members(klass, "Key", "Value")
    else
      descriptor = T.let(T.unsafe(constant).descriptor, Google::Protobuf::Descriptor)
      fields = descriptor.map { |desc| create_descriptor_method(klass, desc) }
      fields.sort_by!(&:name)

      parameters = fields.map do |field|
        create_kw_opt_param(field.name, type: field.init_type, default: field.default)
      end

      klass.create_method("initialize", parameters: parameters, return_type: "void")
    end
  end
end

#gather_constantsObject


95
96
97
98
99
# File 'lib/tapioca/compilers/dsl/protobuf.rb', line 95

def gather_constants
  marker = Google::Protobuf::MessageExts::ClassMethods
  results = T.cast(ObjectSpace.each_object(marker).to_a, T::Array[Module])
  results.any? ? results + [Google::Protobuf::RepeatedField, Google::Protobuf::Map] : []
end