rbi 0.3.5 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8a42ab1d61b3ca13faf2257a62127bb43088d92aec433711820f68333c1a550
-  data.tar.gz: 86fc4e3e2ad745b719272569426d667195a241ecbfd3aa42703e29819bd23d75
+  metadata.gz: d0977bf3c0892a76c8d66ec2f295a62948530bcd2eee11911c50e36ac1bf5402
+  data.tar.gz: ae51e44eb13fe8045f200a8a0353daa9969c4389f99c73758713fa0a9b2b9b0f
 SHA512:
-  metadata.gz: 9c668f46c96e059154b09afe9e1e33efc8135d5bf8a92debb63a1378a6362004b86fa29df097a1e64fd1db60d7ee243f4560a3ee878f4c40d7aceccfc55755a1
-  data.tar.gz: 1d7248cfa39b703ecd02c444013148b2208dcc560d49f470024a6f718687e4ec7ef336c1cd1fd6161d8e54fc80d1d39484af39076dac82dacb6577eccb9b7965
+  metadata.gz: 32bafbbfffee840fe60a1633eb8b408aca4c8e39b5359ce3deca5185ab3003ac43b6c6cab4c4639d9e87e12afabcf1ee042bc9b5a56a231302354f884b2c27ea
+  data.tar.gz: da025803fafaf40714356d02dfe77a705a0de38050bdce9616c6e35f68479b958aa0eb5b596ddf146ef1493932a70fead22f7cb745a28e7c15a40ee85a850c2e

data/Gemfile

@@ -10,7 +10,7 @@ group(:development, :test) do
   gem("minitest")
   gem("minitest-reporters")
   gem("rake", "~> 13.3")
-  gem("rubocop", "~> 1.76", require: false)
+  gem("rubocop", "~> 1.81", require: false)
   gem("rubocop-shopify", require: false)
   gem("rubocop-sorbet", require: false)
   gem("sorbet", ">= 0.5.9204", require: false)

data/lib/rbi/formatter.rb

@@ -6,7 +6,15 @@ module RBI
     #: Integer?
     attr_accessor :max_line_length
 
-    #: (?add_sig_templates: bool, ?group_nodes: bool, ?max_line_length: Integer?, ?nest_singleton_methods: bool, ?nest_non_public_members: bool, ?sort_nodes: bool, ?replace_attributes_with_methods: bool) -> void
+    #: (
+    #|   ?add_sig_templates: bool,
+    #|   ?group_nodes: bool,
+    #|   ?max_line_length: Integer?,
+    #|   ?nest_singleton_methods: bool,
+    #|   ?nest_non_public_members: bool,
+    #|   ?sort_nodes: bool,
+    #|   ?replace_attributes_with_methods: bool
+    #| ) -> void
     def initialize(
       add_sig_templates: false,
       group_nodes: false,

data/lib/rbi/index.rb

@@ -73,7 +73,7 @@ module RBI
     # getter and the setter.
     # @abstract
     #: -> Array[String]
-    def index_ids; end
+    def index_ids = raise NotImplementedError, "Abstract method called"
   end
 
   class Scope

data/lib/rbi/loc.rb

@@ -22,7 +22,13 @@ module RBI
     #: Integer?
     attr_reader :begin_line, :end_line, :begin_column, :end_column
 
-    #: (?file: String?, ?begin_line: Integer?, ?end_line: Integer?, ?begin_column: Integer?, ?end_column: Integer?) -> void
+    #: (
+    #|   ?file: String?,
+    #|   ?begin_line: Integer?,
+    #|   ?end_line: Integer?,
+    #|   ?begin_column: Integer?,
+    #|   ?end_column: Integer?
+    #| ) -> void
     def initialize(file: nil, begin_line: nil, end_line: nil, begin_column: nil, end_column: nil)
       @file = file
       @begin_line = begin_line

data/lib/rbi/model.rb

@@ -163,7 +163,7 @@ module RBI
   class Scope < Tree
     # @abstract
     #: -> String
-    def fully_qualified_name; end
+    def fully_qualified_name = raise NotImplementedError, "Abstract method called"
 
     # @override
     #: -> String
@@ -240,7 +240,13 @@ module RBI
     #: bool
     attr_accessor :keyword_init
 
-    #: (String name, ?members: Array[Symbol], ?keyword_init: bool, ?loc: Loc?, ?comments: Array[Comment]) ?{ (Struct struct) -> void } -> void
+    #: (
+    #|   String name,
+    #|   ?members: Array[Symbol],
+    #|   ?keyword_init: bool,
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (Struct struct) -> void } -> void
     def initialize(name, members: [], keyword_init: false, loc: nil, comments: [], &block)
       super(loc: loc, comments: comments) {}
       @name = name
@@ -299,7 +305,14 @@ module RBI
     #: Array[Sig]
     attr_reader :sigs
 
-    #: (Symbol name, Array[Symbol] names, ?visibility: Visibility, ?sigs: Array[Sig], ?loc: Loc?, ?comments: Array[Comment]) -> void
+    #: (
+    #|   Symbol name,
+    #|   Array[Symbol] names,
+    #|   ?visibility: Visibility,
+    #|   ?sigs: Array[Sig],
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) -> void
     def initialize(name, names, visibility: Public.new, sigs: [], loc: nil, comments: [])
       super(loc: loc, comments: comments)
       @names = [name, *names] #: Array[Symbol]
@@ -309,11 +322,18 @@ module RBI
 
     # @abstract
     #: -> Array[String]
-    def fully_qualified_names; end
+    def fully_qualified_names = raise NotImplementedError, "Abstract method called"
   end
 
   class AttrAccessor < Attr
-    #: (Symbol name, *Symbol names, ?visibility: Visibility, ?sigs: Array[Sig], ?loc: Loc?, ?comments: Array[Comment]) ?{ (AttrAccessor node) -> void } -> void
+    #: (
+    #|   Symbol name,
+    #|   *Symbol names,
+    #|   ?visibility: Visibility,
+    #|   ?sigs: Array[Sig],
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (AttrAccessor node) -> void } -> void
     def initialize(name, *names, visibility: Public.new, sigs: [], loc: nil, comments: [], &block)
       super(name, names, loc: loc, visibility: visibility, sigs: sigs, comments: comments)
       block&.call(self)
@@ -335,7 +355,14 @@ module RBI
   end
 
   class AttrReader < Attr
-    #: (Symbol name, *Symbol names, ?visibility: Visibility, ?sigs: Array[Sig], ?loc: Loc?, ?comments: Array[Comment]) ?{ (AttrReader node) -> void } -> void
+    #: (
+    #|   Symbol name,
+    #|   *Symbol names,
+    #|   ?visibility: Visibility,
+    #|   ?sigs: Array[Sig],
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (AttrReader node) -> void } -> void
     def initialize(name, *names, visibility: Public.new, sigs: [], loc: nil, comments: [], &block)
       super(name, names, loc: loc, visibility: visibility, sigs: sigs, comments: comments)
       block&.call(self)
@@ -357,7 +384,14 @@ module RBI
   end
 
   class AttrWriter < Attr
-    #: (Symbol name, *Symbol names, ?visibility: Visibility, ?sigs: Array[Sig], ?loc: Loc?, ?comments: Array[Comment]) ?{ (AttrWriter node) -> void } -> void
+    #: (
+    #|   Symbol name,
+    #|   *Symbol names,
+    #|   ?visibility: Visibility,
+    #|   ?sigs: Array[Sig],
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (AttrWriter node) -> void } -> void
     def initialize(name, *names, visibility: Public.new, sigs: [], loc: nil, comments: [], &block)
       super(name, names, loc: loc, visibility: visibility, sigs: sigs, comments: comments)
       block&.call(self)
@@ -396,7 +430,15 @@ module RBI
     #: Array[Sig]
     attr_accessor :sigs
 
-    #: (String name, ?params: Array[Param], ?is_singleton: bool, ?visibility: Visibility, ?sigs: Array[Sig], ?loc: Loc?, ?comments: Array[Comment]) ?{ (Method node) -> void } -> void
+    #: (
+    #|   String name,
+    #|   ?params: Array[Param],
+    #|   ?is_singleton: bool,
+    #|   ?visibility: Visibility,
+    #|   ?sigs: Array[Sig],
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (Method node) -> void } -> void
     def initialize(
       name,
       params: [],
@@ -456,7 +498,15 @@ module RBI
       @params << BlockParam.new(name)
     end
 
-    #: (?params: Array[SigParam], ?return_type: (String | Type), ?is_abstract: bool, ?is_override: bool, ?is_overridable: bool, ?is_final: bool, ?type_params: Array[String], ?checked: Symbol?) ?{ (Sig node) -> void } -> void
+    #: (
+    #|   ?params: Array[SigParam],
+    #|   ?return_type: (String | Type),
+    #|   ?is_abstract: bool,
+    #|   ?is_override: bool,
+    #|   ?is_overridable: bool,
+    #|   ?is_final: bool,
+    #|   ?type_params: Array[String],
+    #|   ?checked: Symbol?) ?{ (Sig node) -> void } -> void
     def add_sig(
       params: [],
       return_type: "void",
@@ -832,7 +882,25 @@ module RBI
     attr_accessor :return_type
 
     #: bool
-    attr_accessor :is_abstract, :is_override, :is_overridable, :is_final, :allow_incompatible_override, :without_runtime
+    attr_accessor :is_abstract
+
+    #: bool
+    attr_accessor :is_override
+
+    #: bool
+    attr_accessor :is_overridable
+
+    #: bool
+    attr_accessor :is_final
+
+    #: bool
+    attr_accessor :allow_incompatible_override
+
+    #: bool
+    attr_accessor :allow_incompatible_override_visibility
+
+    #: bool
+    attr_accessor :without_runtime
 
     #: Array[String]
     attr_reader :type_params
@@ -840,7 +908,21 @@ module RBI
     #: Symbol?
     attr_accessor :checked
 
-    #: (?params: Array[SigParam], ?return_type: (Type | String), ?is_abstract: bool, ?is_override: bool, ?is_overridable: bool, ?is_final: bool, ?allow_incompatible_override: bool, ?without_runtime: bool, ?type_params: Array[String], ?checked: Symbol?, ?loc: Loc?, ?comments: Array[Comment]) ?{ (Sig node) -> void } -> void
+    #: (
+    #|   ?params: Array[SigParam],
+    #|   ?return_type: (Type | String),
+    #|   ?is_abstract: bool,
+    #|   ?is_override: bool,
+    #|   ?is_overridable: bool,
+    #|   ?is_final: bool,
+    #|   ?allow_incompatible_override: bool,
+    #|   ?allow_incompatible_override_visibility: bool,
+    #|   ?without_runtime: bool,
+    #|   ?type_params: Array[String],
+    #|   ?checked: Symbol?,
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (Sig node) -> void } -> void
     def initialize(
       params: [],
       return_type: "void",
@@ -849,6 +931,7 @@ module RBI
       is_overridable: false,
       is_final: false,
       allow_incompatible_override: false,
+      allow_incompatible_override_visibility: false,
       without_runtime: false,
       type_params: [],
       checked: nil,
@@ -864,6 +947,7 @@ module RBI
       @is_overridable = is_overridable
       @is_final = is_final
       @allow_incompatible_override = allow_incompatible_override
+      @allow_incompatible_override_visibility = allow_incompatible_override_visibility
       @without_runtime = without_runtime
       @type_params = type_params
       @checked = checked
@@ -942,11 +1026,17 @@ module RBI
 
     # @abstract
     #: -> Array[String]
-    def fully_qualified_names; end
+    def fully_qualified_names = raise NotImplementedError, "Abstract method called"
   end
 
   class TStructConst < TStructField
-    #: (String name, (Type | String) type, ?default: String?, ?loc: Loc?, ?comments: Array[Comment]) ?{ (TStructConst node) -> void } -> void
+    #: (
+    #|   String name,
+    #|   (Type | String) type,
+    #|   ?default: String?,
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (TStructConst node) -> void } -> void
     def initialize(name, type, default: nil, loc: nil, comments: [], &block)
       super(name, type, default: default, loc: loc, comments: comments)
       block&.call(self)
@@ -967,7 +1057,13 @@ module RBI
   end
 
   class TStructProp < TStructField
-    #: (String name, (Type | String) type, ?default: String?, ?loc: Loc?, ?comments: Array[Comment]) ?{ (TStructProp node) -> void } -> void
+    #: (
+    #|   String name,
+    #|   (Type | String) type,
+    #|   ?default: String?,
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (TStructProp node) -> void } -> void
     def initialize(name, type, default: nil, loc: nil, comments: [], &block)
       super(name, type, default: default, loc: loc, comments: comments)
       block&.call(self)
@@ -1087,7 +1183,12 @@ module RBI
   end
 
   class MixesInClassMethods < Mixin
-    #: (String name, *String names, ?loc: Loc?, ?comments: Array[Comment]) ?{ (MixesInClassMethods node) -> void } -> void
+    #: (
+    #|   String name,
+    #|   *String names,
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment]
+    #| ) ?{ (MixesInClassMethods node) -> void } -> void
     def initialize(name, *names, loc: nil, comments: [], &block)
       super(name, names, loc: loc, comments: comments)
       block&.call(self)

data/lib/rbi/parser.rb

@@ -946,22 +946,8 @@ module RBI
           end
         when "override"
           @current.is_override = true
-
-          args = node.arguments&.arguments
-
-          keywords_hash = args
-            &.grep(Prism::KeywordHashNode)
-            &.first
-
-          allow_incompatible_override = keywords_hash
-            &.elements
-            &.any? do |assoc|
-              assoc.is_a?(Prism::AssocNode) &&
-                node_string(assoc.key) == "allow_incompatible:" &&
-                node_string(assoc.value) == "true"
-            end
-
-          @current.allow_incompatible_override = !!allow_incompatible_override
+          @current.allow_incompatible_override = allow_incompatible_override?(node, "true")
+          @current.allow_incompatible_override_visibility = allow_incompatible_override?(node, ":visibility")
         when "overridable"
           @current.is_overridable = true
         when "params"
@@ -995,6 +981,23 @@ module RBI
           node_string!(node.value),
         )
       end
+
+      #: (Prism::CallNode node, String value) -> bool
+      def allow_incompatible_override?(node, value)
+        args = node.arguments&.arguments
+
+        keywords_hash = args
+          &.grep(Prism::KeywordHashNode)
+          &.first
+
+        !!keywords_hash
+          &.elements
+          &.any? do |assoc|
+            assoc.is_a?(Prism::AssocNode) &&
+              node_string(assoc.key) == "allow_incompatible:" &&
+              node_string(assoc.value) == value
+          end
+      end
     end
 
     class HeredocLocationVisitor < Prism::Visitor

data/lib/rbi/printer.rb

@@ -800,6 +800,8 @@ module RBI
       if node.is_override
         modifiers << if node.allow_incompatible_override
           "override(allow_incompatible: true)"
+        elsif node.allow_incompatible_override_visibility
+          "override(allow_incompatible: :visibility)"
         else
           "override"
         end

data/lib/rbi/rbs/type_translator.rb

@@ -34,7 +34,7 @@ module RBI
           case type
           when ::RBS::Types::Alias
             # TODO: unsupported yet
-            Type.untyped
+            translate_type_alias(type)
           when ::RBS::Types::Bases::Any
             Type.untyped
           when ::RBS::Types::Bases::Bool
@@ -85,12 +85,24 @@ module RBI
           when ::RBS::Types::Variable
             Type.type_parameter(type.name)
           else
-            T.absurd(type)
+            type #: absurd
           end
         end
 
         private
 
+        #: (::RBS::Types::Alias) -> Type
+        def translate_type_alias(type)
+          name = ::RBS::TypeName.new(
+            namespace: type.name.namespace,
+            name: type.name.name.to_s.gsub(/(?:^|_)([a-z\d]*)/i) do |match|
+              match = match.delete_prefix("_")
+              !match.empty? ? match[0].upcase.concat(match[1..-1]) : +""
+            end,
+          )
+          Type.simple(name.to_s)
+        end
+
         #: (::RBS::Types::ClassInstance) -> Type
         def translate_class_instance(type)
           return Type.simple(type.name.to_s) if type.args.empty?

data/lib/rbi/rbs_printer.rb

@@ -337,6 +337,8 @@ module RBI
       if node.sigs.any?(&:is_override)
         if node.sigs.any?(&:allow_incompatible_override)
           printl("# @override(allow_incompatible: true)")
+        elsif node.sigs.any?(&:allow_incompatible_override_visibility)
+          printl("# @override(allow_incompatible: :visibility)")
         else
           printl("# @override")
         end

data/lib/rbi/rewriters/attr_to_methods.rb

@@ -56,7 +56,7 @@ module RBI
   class Attr
     # @abstract
     #: -> Array[Method]
-    def convert_to_methods; end
+    def convert_to_methods = raise NotImplementedError, "Abstract method called"
 
     private
 
@@ -88,7 +88,14 @@ module RBI
       )
     end
 
-    #: (String name, Sig? sig, (Type | String)? attribute_type, Visibility visibility, Loc? loc, Array[Comment] comments) -> Method
+    #: (
+    #|   String name,
+    #|   Sig? sig,
+    #|   (Type | String)? attribute_type,
+    #|   Visibility visibility,
+    #|   Loc? loc,
+    #|   Array[Comment] comments
+    #| ) -> Method
     def create_setter_method(name, sig, attribute_type, visibility, loc, comments) # rubocop:disable Metrics/ParameterLists
       sig = if sig # Modify the original sig to correct the name, and remove the return type
         params = attribute_type ? [SigParam.new(name, attribute_type)] : []

data/lib/rbi/rewriters/merge_trees.rb

@@ -330,7 +330,11 @@ module RBI
     #: Array[Rewriters::Merge::Conflict]
     attr_reader :conflicts
 
-    #: (?loc: Loc?, ?comments: Array[Comment], ?conflicts: Array[Rewriters::Merge::Conflict]) ?{ (Tree node) -> void } -> void
+    #: (
+    #|   ?loc: Loc?,
+    #|   ?comments: Array[Comment],
+    #|   ?conflicts: Array[Rewriters::Merge::Conflict]
+    #| ) ?{ (Tree node) -> void } -> void
     def initialize(loc: nil, comments: [], conflicts: [], &block)
       super(loc: loc, comments: comments)
       @conflicts = conflicts

data/lib/rbi/type.rb

@@ -583,6 +583,46 @@ module RBI
       end
     end
 
+    # A type alias that references another type by name like `MyTypeAlias`.
+    class TypeAlias < Type
+      #: String
+      attr_reader :name
+
+      #: Type
+      attr_reader :aliased_type
+
+      #: (String name, Type aliased_type) -> void
+      def initialize(name, aliased_type)
+        super()
+        @name = name
+        @aliased_type = aliased_type
+      end
+
+      # @override
+      #: (BasicObject other) -> bool
+      def ==(other)
+        TypeAlias === other && @name == other.name && @aliased_type == other.aliased_type
+      end
+
+      # @override
+      #: -> String
+      def to_rbi
+        "#{name} = T.type_alias { #{aliased_type.to_rbi} }"
+      end
+
+      # @override
+      #: -> Type
+      def normalize
+        TypeAlias.new(name, aliased_type.normalize)
+      end
+
+      # @override
+      #: -> Type
+      def simplify
+        TypeAlias.new(name, aliased_type.simplify)
+      end
+    end
+
     # Tuples and shapes
 
     # A tuple type like `[String, Integer]`.
@@ -871,6 +911,12 @@ module RBI
         TypeParameter.new(name)
       end
 
+      # Builds a type that represents a type alias like `MyTypeAlias`.
+      #: (String name, Type aliased_type) -> TypeAlias
+      def type_alias(name, aliased_type)
+        TypeAlias.new(name, aliased_type)
+      end
+
       # Tuples and shapes
 
       # Builds a type that represents a tuple type like `[String, Integer]`.
@@ -957,7 +1003,7 @@ module RBI
     #
     # @abstract
     #: -> Type
-    def normalize; end
+    def normalize = raise NotImplementedError, "Abstract method called"
 
     # Returns a simplified version of the type.
     #
@@ -969,11 +1015,11 @@ module RBI
     #
     # @abstract
     #: -> Type
-    def simplify; end
+    def simplify = raise NotImplementedError, "Abstract method called"
 
     # @abstract
     #: (BasicObject) -> bool
-    def ==(other); end
+    def ==(other) = raise NotImplementedError, "Abstract method called"
 
     #: (BasicObject other) -> bool
     def eql?(other)
@@ -988,7 +1034,7 @@ module RBI
 
     # @abstract
     #: -> String
-    def to_rbi; end
+    def to_rbi = raise NotImplementedError, "Abstract method called"
 
     # @override
     #: -> String

data/lib/rbi/type_parser.rb

@@ -27,6 +27,8 @@ module RBI
         case node
         when Prism::ConstantReadNode, Prism::ConstantPathNode
           parse_constant(node)
+        when Prism::ConstantWriteNode, Prism::ConstantPathWriteNode
+          parse_constant_assignment(node)
         when Prism::CallNode
           parse_call(node)
         when Prism::ArrayNode
@@ -67,6 +69,29 @@ module RBI
         end
       end
 
+      #: (Prism::ConstantWriteNode | Prism::ConstantPathWriteNode node) -> Type
+      def parse_constant_assignment(node)
+        if t_type_alias?(node.value)
+          value = node.value #: as Prism::CallNode
+          name = if node.is_a?(Prism::ConstantPathWriteNode)
+            node.target.full_name
+          else
+            node.full_name
+          end
+
+          body = value.block
+
+          if body.is_a?(Prism::BlockNode) && (stmts = body.body).is_a?(Prism::StatementsNode)
+            body_node = stmts.body.first #: as !nil
+            Type::TypeAlias.new(name, parse_node(body_node))
+          else
+            Type::Simple.new(node.slice)
+          end
+        else
+          Type::Simple.new(node.slice)
+        end
+      end
+
       #: (Prism::CallNode node) -> Type
       def parse_call(node)
         recv = node.receiver
@@ -310,6 +335,13 @@ module RBI
         false
       end
 
+      #: (Prism::Node? node) -> bool
+      def t_type_alias?(node)
+        return false unless node.is_a?(Prism::CallNode)
+
+        t?(node.receiver) && node.name == :type_alias
+      end
+
       #: (Prism::Node? node) -> bool
       def t_boolean?(node)
         return false unless node.is_a?(Prism::ConstantPathNode)

data/lib/rbi/type_visitor.rb

@@ -45,6 +45,8 @@ module RBI
           visit_type_parameter(node)
         when Type::Class
           visit_class(node)
+        when Type::TypeAlias
+          visit_type_alias(node)
         else
           raise Error, "Unhandled node: #{node.class}"
         end
@@ -105,6 +107,9 @@ module RBI
 
       #: (Type::Untyped type) -> void
       def visit_untyped(type); end
+
+      #: (Type::TypeAlias type) -> void
+      def visit_type_alias(type); end
     end
   end
 end

data/lib/rbi/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.3.5"
+  VERSION = "0.3.7"
 end