rbs_protobuf 0.1.0 → 1.0.0

data/lib/rbs_protobuf/version.rb

@@ -1,3 +1,3 @@
 module RBSProtobuf
-  VERSION = "0.1.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

@@ -0,0 +1,108 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: rbs
+  version: 2.3.2
+  source:
+    type: rubygems
+- name: activesupport
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: listen
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c7b9329222debd0b8a4a85c0ccdae6588fedd57a
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: set
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: rubygems
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+  - name: activesupport
+  - name: protobuf
+    ignore: true
+  - name: rbs_protobuf
+    ignore: true

data/rbs_protobuf.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Generate RBS files from .proto files"
   spec.homepage      = "https://github.com/square/rbs_protobuf"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/square/rbs_protobuf"
@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rbs", ">=1.0.4"
+  spec.add_runtime_dependency "rbs", ">=2.2.0"
   spec.add_runtime_dependency "activesupport", ">=4.0"
 end

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/rbs_factory.rbs

@@ -0,0 +1,41 @@
+module RBSProtobuf
+  class RBSFactory
+    include RBS
+
+    def type_name: (String) -> RBS::TypeName
+
+    def namespace: (String) -> RBS::Namespace
+
+    def instance_type: (String | RBS::TypeName name, *RBS::Types::t args) -> RBS::Types::ClassInstance
+
+    def singleton_type: (String | RBS::TypeName name) -> RBS::Types::ClassSingleton
+
+    def union_type: (RBS::Types::t `type`, *RBS::Types::t types) -> RBS::Types::t
+
+    def nil_type: (?location: RBS::Location[untyped, untyped]?) -> RBS::Types::Bases::Nil
+
+    def bool_type: (?location: RBS::Location[untyped, untyped]?) -> RBS::Types::Bases::Bool
+
+    def alias_type: (String | RBS::TypeName name, ?location: RBS::Location[untyped, untyped]?) -> RBS::Types::Alias
+
+    def function: (?RBS::Types::t return_type) -> RBS::Types::Function
+
+    def param: (RBS::Types::t type, ?name: Symbol?) -> RBS::Types::Function::Param
+
+    def block: (RBS::Types::Function function, ?required: bool) -> RBS::Types::Block
+
+    def untyped: (?location: RBS::Location[untyped, untyped]?) -> RBS::Types::Bases::Any
+
+    def method_type: (?params: Array[Symbol], type: RBS::Types::Function, ?block: RBS::Types::Block?, ?location: RBS::Location[untyped, untyped]?) -> RBS::MethodType
+
+    def literal_type: (RBS::Types::Literal::literal) -> RBS::Types::Literal
+
+    def optional_type: (RBS::Types::t, ?location: RBS::Location[untyped, untyped]?) -> RBS::Types::Optional
+
+    def type_var: (Symbol name, ?location: RBS::Location[untyped, untyped]?) -> RBS::Types::Variable
+
+    def module_type_params: (*Symbol params) -> Array[RBS::AST::TypeParam]
+
+    def unwrap_optional: (RBS::Types::t) -> RBS::Types::t
+  end
+end

data/sig/rbs_protobuf/translator/base.rbs

@@ -0,0 +1,35 @@
+module RBSProtobuf
+  module Translator
+    class Base
+      FieldDescriptorProto: untyped
+
+      attr_reader input: untyped
+
+      def initialize: (untyped input) -> void
+
+      @factory: RBSFactory
+
+      def factory: () -> RBSFactory
+
+      @response: untyped
+
+      def response: () -> untyped
+
+      def generate_rbs!: () -> void
+
+      def rbs_name: (String proto_name) -> String
+
+      def rbs_suffix: () -> ::String
+
+      def rbs_content: (String file) -> String
+
+      def comment_for_path: (untyped source_code_info, Array[Integer] path, options: untyped) -> RBS::AST::Comment?
+
+      def each_options_field: (untyped) { (Symbol, untyped) -> void } -> void
+
+      def base_type: (untyped `type`) -> RBS::Types::t
+
+      def message_type: (String) -> RBS::Types::ClassInstance
+    end
+  end
+end

data/sig/rbs_protobuf/translator/protobuf_gem.rbs

@@ -0,0 +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,
+        accept_nil_writer: bool,
+        ?stderr: IO,
+      ) -> void
+
+      @upcase_enum: 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
+
+      # 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
+
+      # 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
+
+      # 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
+
+      # 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 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
+
+      # 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
+
+      # 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
+    end
+  end
+end

data/sig/rbs_protobuf/version.rbs

@@ -0,0 +1,3 @@
+module RBSProtobuf
+  VERSION: String
+end

data/sig/rbs_protobuf.rbs

@@ -0,0 +1,5 @@
+module RBSProtobuf
+  attr_reader self.logger: Logger
+
+  self.@logger: Logger
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_protobuf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -52,26 +52,40 @@ files:
 - ".protoc-version"
 - ".rakeTasks"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/protoc-gen-dumper
 - bin/protoc-gen-ruby
 - bin/rpc_server
 - bin/setup
+- bin/steep
 - example/Steepfile
 - example/a.proto
 - example/b.proto
+- example/c.proto
 - 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
 - lib/rbs_protobuf/version.rb
+- rbs_collection.lock.yaml
+- 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
+- sig/rbs_protobuf/version.rbs
 homepage: https://github.com/square/rbs_protobuf
 licenses:
 - MIT
@@ -87,14 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generate RBS files from .proto files