rbs_protobuf 0.3.0 → 1.0.0

data/lib/rbs_protobuf/version.rb

@@ -1,3 +1,3 @@
 module RBSProtobuf
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/rbs_protobuf.rb

@@ -3,7 +3,7 @@ require "rbs_protobuf/version"
 require "logger"
 
 require "protobuf/descriptors"
-require "active_support/inflector"
+require "active_support"
 require "rbs"
 
 module RBSProtobuf
@@ -14,6 +14,7 @@ module RBSProtobuf
   @logger = Logger.new(STDERR)
 end
 
+require "rbs_protobuf/name"
 require "rbs_protobuf/rbs_factory"
 require "rbs_protobuf/translator/base"
 require "rbs_protobuf/translator/protobuf_gem"

data/rbs_collection.lock.yaml

@@ -7,7 +7,7 @@ sources:
 path: ".gem_rbs_collection"
 gems:
 - name: rbs
-  version: 2.3.1
+  version: 2.3.2
   source:
     type: rubygems
 - name: activesupport
@@ -15,15 +15,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
-    remote: https://github.com/ruby/gem_rbs_collection.git
-    repo_dir: gems
-- name: protobuf
-  version: 3.10.3
-  source:
-    type: git
-    name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: ast
@@ -31,7 +23,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: i18n
@@ -39,7 +31,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: listen
@@ -47,7 +39,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: parallel
@@ -55,7 +47,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rainbow
@@ -63,7 +55,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: f43bb5ffee382df94113f44c7555027d7089912a
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: logger

data/rbs_collection.yaml

@@ -14,5 +14,6 @@ gems:
   - name: rbs
   - name: activesupport
   - name: protobuf
+    ignore: true
   - name: rbs_protobuf
     ignore: true

data/sig/rbs_protobuf/name.rbs

@@ -0,0 +1,45 @@
+module RBSProtobuf
+  module Name
+    class Class
+      attr_reader name: RBS::TypeName
+
+      def initialize: (RBS::TypeName) -> void
+
+      def instance_type: (*RBS::Types::t args) -> RBS::Types::ClassInstance
+
+      def singleton_type: () -> RBS::Types::ClassSingleton
+
+      def instance_type?: (RBS::Types::t) -> bool
+
+      def singleton_type?: (RBS::Types::t) -> bool
+
+      alias [] instance_type
+
+      def super_class: (*RBS::Types::t args) -> RBS::AST::Declarations::Class::Super
+    end
+
+    class Alias
+      attr_reader name: RBS::TypeName
+
+      def initialize: (RBS::TypeName) -> void
+
+      def []: (*RBS::Types::t args) -> RBS::Types::Alias
+
+      def type?: (RBS::Types::t) -> bool
+
+      alias === type?
+    end
+
+    class Interface
+      attr_reader name: RBS::TypeName
+
+      def initialize: (RBS::TypeName) -> void
+
+      def []: (*RBS::Types::t args) -> RBS::Types::Interface
+
+      def type?: (RBS::Types::t) -> bool
+
+      alias === type?
+    end
+  end
+end

data/sig/rbs_protobuf/translator/protobuf_gem.rbs

@@ -1,53 +1,122 @@
 module RBSProtobuf
   module Translator
     class ProtobufGem < Base
+      # Protobuf::Field::FieldArray[R, W]
+      FIELD_ARRAY: Name::Class
+
+      # Protobuf::Field::FieldHash[K, RV, WV]
+      FIELD_HASH: Name::Class
+
+      # Protobuf::Enum
+      ENUM: Name::Class
+
+      # Protobuf::Message
+      MESSAGE: Name::Class
+
+      # _ToProto
+      TO_PROTO: Name::Interface
+
+      # Protobuf::field_array[T]
+      FIELD_ARRAY_a: Name::Alias
+
+      # Protobuf::field_hash[K, V]
+      FIELD_HASH_a: Name::Alias
+
       attr_reader stderr: IO
 
+      attr_reader accept_nil_writer: bool
+
       def initialize: (
         untyped input,
         upcase_enum: bool,
         nested_namespace: bool,
         extension: bool | :print | nil,
-        ?stderr: IO
+        accept_nil_writer: bool,
+        ?stderr: IO,
       ) -> void
 
       @upcase_enum: bool
 
-      @pnested_namespace: bool
+      @nested_namespace: bool
 
       @extension: bool | :print | nil
 
+      # Returns true if extension should be ignored.
+      #
       def ignore_extension?: () -> bool
 
+      # Returns true if documentation message about extension is requested.
       def print_extension_message?: () -> bool
 
+      # Returns true if extension should be printed to stderr.
+      #
       def print_extension?: () -> bool
 
+      # Returns true if enum names should be `upcase`.
+      #
       def upcase_enum?: () -> bool
 
+      # Returns true if printing nested namespace is preferred.
+      #
       def nested_namespace?: () -> bool
 
+      # The entry point.
+      # Generate RBS declarations from the `file` and returns the string representation of the declarations.
+      #
       def rbs_content: (untyped file) -> String
 
-      def message_base_class: () -> RBS::AST::Declarations::Class::Super
+      # Returns the class declaration for given message.
+      #
+      def message_to_decl: (untyped message, prefix: RBS::Namespace, message_path: untyped, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
 
-      def repeated_field_type: (RBS::Types::t `type`, ?RBS::Types::t wtype) -> RBS::Types::ClassInstance
+      # Returns the class declaration for given enum.
+      #
+      def enum_type_to_decl: (untyped enum_type, prefix: RBS::Namespace, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
 
-      def message_to_decl: (untyped message, prefix: RBS::Namespace, message_path: untyped, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
+      # Returns the class declaration for given extension.
+      #
+      def extension_to_decl: (untyped extension, prefix: RBS::Namespace, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
 
-      def field_type: (untyped field, Hash[String, [RBS::Types::t, RBS::Types::t]] maps) -> [RBS::Types::t, RBS::Types::t]
+      # Returns service class stub.
+      #
+      def service_to_decl: (untyped service, prefix: RBS::Namespace, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
+
+      # Returns a triple of types of a field.
+      #
+      # - The first one is the type of the attribute. (read and write)
+      # - The second one is the array of type of additional possibilities for write.
+      # - The last one is the type of `initialize` parameter.
+      #
+      def field_type: (untyped field, Hash[String, [untyped, untyped]] maps) -> [RBS::Types::t, Array[RBS::Types::t], RBS::Types::t]
+
+      def message_to_proto_type: (RBS::Types::ClassInstance) -> RBS::Types::Interface
+
+      def message_array_type: (RBS::Types::ClassInstance) -> RBS::Types::Alias
+
+      def message_field_array_type: (RBS::Types::ClassInstance) -> RBS::Types::Alias
 
-      def enum_base_class: () -> RBS::AST::Declarations::Class::Super
+      def message_hash_type: (RBS::Types::ClassInstance, RBS::Types::t key) -> RBS::Types::Alias
 
+      def message_field_hash_type: (RBS::Types::ClassInstance, RBS::Types::t key) -> RBS::Types::Alias
+
+      def message_init_type: (RBS::Types::ClassInstance) -> RBS::Types::Alias
+
+      # Returns enum names with respect to `#upcase_enum?`.
+      #
       def enum_name: (String name) -> Symbol
 
-      def enum_type_to_decl: (untyped enum_type, prefix: RBS::Namespace, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
+      # Add field to `members`. It adds
+      #
+      # - `attr_accessor` of the field `name` with `read_type`
+      # - Overloads for attribute writer with `write_types`
+      #
+      def add_field: (Array[RBS::AST::Declarations::Class::member] members, name: Symbol, read_type: RBS::Types::t, write_types: Array[RBS::Types::t], comment: RBS::AST::Comment?) -> void
 
-      def extension_to_decl: (String extendee_name, Array[untyped] extensions, prefix: RBS::Namespace, source_code_info: untyped, path: Array[Integer]) -> Array[RBS::AST::Declarations::Class]
+      # Returns true if `write_type` is an _interface type_ or an optional type of _interface type_.
+      #
+      def interface_type?: (RBS::Types::t write_type) -> [RBS::AST::TypeParam, RBS::Types::t]?
 
       def service_base_class: () -> RBS::AST::Declarations::Class::Super
-
-      def service_to_decl: (untyped service, prefix: RBS::Namespace, source_code_info: untyped, path: Array[Integer]) -> RBS::AST::Declarations::Class
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_protobuf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -72,6 +72,7 @@ files:
 - example/protobuf_gem_example.rb
 - exe/protoc-gen-rbs
 - lib/rbs_protobuf.rb
+- lib/rbs_protobuf/name.rb
 - lib/rbs_protobuf/rbs_factory.rb
 - lib/rbs_protobuf/translator/base.rb
 - lib/rbs_protobuf/translator/protobuf_gem.rb
@@ -80,6 +81,7 @@ files:
 - rbs_collection.yaml
 - rbs_protobuf.gemspec
 - sig/rbs_protobuf.rbs
+- sig/rbs_protobuf/name.rbs
 - sig/rbs_protobuf/rbs_factory.rbs
 - sig/rbs_protobuf/translator/base.rbs
 - sig/rbs_protobuf/translator/protobuf_gem.rbs