rbi 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3e133057e9df490de9a0757b30f9b1f19ffa3afbca8f16c55c90e1562bffd7
-  data.tar.gz: 835d569c6d20336e4911ef660117cb03af2b5c312e04850058b34402ba94cc34
+  metadata.gz: 30c1564f6fad1d76035f6cd07bf31237251e6c622350aa4911797980b3a17414
+  data.tar.gz: 1d1350fa25cf2dad93c59e74288372701bfe73c6214d46e279350a953269786d
 SHA512:
-  metadata.gz: 6c7d07ae2efbeee1310c61d0fdf440408e755d38febc3ed30a194512df118845d36ea9315142b87239ff1f8856f045bc565ac975683a504c05b05792aed9c4f8
-  data.tar.gz: 9661b08e169d35d2f947e88de33360bd8ba6d5ee522a2b8beccd77c6589bd6ed1fd560c7a665201c8e8d5869f7a8dda872c58fc0009acf6eda86b3e1da0a1fd9
+  metadata.gz: a273b8f7e57c8471e8a9d46f71c7b554e2416243e7ef1c953137720543f7dd70f4166b0c916e327dcb9cf516e0668deaf56027ade2c36485f9fce10cfedb9d9d
+  data.tar.gz: e03adcd232b2557c68d6a18a62c0e0b1977e8f4cccb3a8718f711ae2ec35ded301026021a7d39829da51286348089cdde3593d0b3bb1703da8d69a86af6364c5

data/Gemfile

@@ -10,9 +10,10 @@ group(:development, :test) do
   gem("minitest")
   gem("minitest-reporters")
   gem("rake", "~> 13.2")
-  gem("rubocop", "~> 1.73", require: false)
+  gem("rubocop", "~> 1.75", require: false)
   gem("rubocop-shopify", require: false)
   gem("rubocop-sorbet", require: false)
   gem("sorbet", ">= 0.5.9204", require: false)
+  gem("spoom", ">= 1.6.0", require: false)
   gem("tapioca", require: false)
 end

data/lib/rbi/formatter.rb

@@ -6,14 +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) -> 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,
       max_line_length: nil,
       nest_singleton_methods: false,
       nest_non_public_members: false,
-      sort_nodes: false
+      sort_nodes: false,
+      replace_attributes_with_methods: false
     )
       @add_sig_templates = add_sig_templates
       @group_nodes = group_nodes
@@ -21,6 +22,7 @@ module RBI
       @nest_singleton_methods = nest_singleton_methods
       @nest_non_public_members = nest_non_public_members
       @sort_nodes = sort_nodes
+      @replace_attributes_with_methods = replace_attributes_with_methods
     end
 
     #: (RBI::File file) -> String
@@ -36,6 +38,7 @@ module RBI
 
     #: (RBI::Tree tree) -> void
     def format_tree(tree)
+      tree.replace_attributes_with_methods! if @replace_attributes_with_methods
       tree.add_sig_templates! if @add_sig_templates
       tree.nest_singleton_methods! if @nest_singleton_methods
       tree.nest_non_public_members! if @nest_non_public_members

data/lib/rbi/index.rb

@@ -17,7 +17,7 @@ module RBI
     #: -> void
     def initialize
       super
-      @index = T.let({}, T::Hash[String, T::Array[Node]])
+      @index = {} #: Hash[String, Array[Node]]
     end
 
     #: -> Array[String]
@@ -217,7 +217,17 @@ module RBI
     # @override
     #: -> Array[String]
     def index_ids
-      [to_s]
+      [fully_qualified_name]
+    end
+  end
+
+  class TEnumValue
+    include Indexable
+
+    # @override
+    #: -> Array[String]
+    def index_ids
+      [fully_qualified_name]
     end
   end
 end

data/lib/rbi/loc.rb

@@ -50,7 +50,7 @@ module RBI
 
       string = String.new
       ::File.foreach(file).with_index do |line, line_number|
-        string << line if line_number + 1 >= begin_line && line_number + 1 <= end_line
+        string << line if (line_number + 1).between?(begin_line, end_line)
       end
       string
     end

data/lib/rbi/model.rb

@@ -45,7 +45,7 @@ module RBI
 
     #: -> Scope?
     def parent_scope
-      parent = T.let(parent_tree, T.nilable(Tree))
+      parent = parent_tree #: Tree?
       parent = parent.parent_tree until parent.is_a?(Scope) || parent.nil?
       parent
     end
@@ -105,7 +105,9 @@ module RBI
     def annotations
       comments
         .select { |comment| comment.text.start_with?("@") }
-        .map { |comment| T.must(comment.text[1..]) }
+        .map do |comment|
+          comment.text[1..] #: as !nil
+        end
     end
   end
 
@@ -116,7 +118,7 @@ module RBI
     #: (?loc: Loc?, ?comments: Array[Comment]) ?{ (Tree node) -> void } -> void
     def initialize(loc: nil, comments: [], &block)
       super(loc: loc, comments: comments)
-      @nodes = T.let([], T::Array[Node])
+      @nodes = [] #: Array[Node]
       block&.call(self)
     end
 
@@ -144,7 +146,7 @@ module RBI
 
     #: (?strictness: String?, ?comments: Array[Comment]) ?{ (File file) -> void } -> void
     def initialize(strictness: nil, comments: [], &block)
-      @root = T.let(Tree.new, Tree)
+      @root = Tree.new #: Tree
       @strictness = strictness
       @comments = comments
       block&.call(self)
@@ -313,7 +315,7 @@ module RBI
     #: (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 = T.let([name, *names], T::Array[Symbol])
+      @names = [name, *names] #: Array[Symbol]
       @visibility = visibility
       @sigs = sigs
     end
@@ -671,7 +673,7 @@ module RBI
     #: (String name, Array[String] names, ?loc: Loc?, ?comments: Array[Comment]) -> void
     def initialize(name, names, loc: nil, comments: [])
       super(loc: loc, comments: comments)
-      @names = T.let([name, *names], T::Array[String])
+      @names = [name, *names] #: Array[String]
     end
   end
 
@@ -1037,6 +1039,29 @@ module RBI
     end
   end
 
+  class TEnumValue < NodeWithComments
+    #: String
+    attr_reader :name
+
+    #: (String name, ?loc: Loc?, ?comments: Array[Comment]) ?{ (TEnumValue node) -> void } -> void
+    def initialize(name, loc: nil, comments: [], &block)
+      super(loc: loc, comments: comments)
+      @name = name
+      block&.call(self)
+    end
+
+    #: -> String
+    def fully_qualified_name
+      "#{parent_scope&.fully_qualified_name}::#{name}"
+    end
+
+    # @override
+    #: -> String
+    def to_s
+      fully_qualified_name
+    end
+  end
+
   # Sorbet's misc.
 
   class Helper < NodeWithComments

data/lib/rbi/parser.rb

@@ -136,7 +136,18 @@ module RBI
 
       #: (Prism::Node node) -> String
       def node_string!(node)
-        T.must(node_string(node))
+        node_string(node) #: as !nil
+      end
+
+      #: (Prism::Node node) -> Prism::Location
+      def adjust_prism_location_for_heredoc(node)
+        visitor = HeredocLocationVisitor.new(
+          node.location.send(:source),
+          node.location.start_offset,
+          node.location.end_offset,
+        )
+        visitor.visit(node)
+        visitor.location
       end
     end
 
@@ -151,12 +162,12 @@ module RBI
       def initialize(source, comments:, file:)
         super(source, file: file)
 
-        @comments_by_line = T.let(comments.to_h { |c| [c.location.start_line, c] }, T::Hash[Integer, Prism::Comment])
-        @tree = T.let(Tree.new, Tree)
+        @comments_by_line = comments.to_h { |c| [c.location.start_line, c] } #: Hash[Integer, Prism::Comment]
+        @tree = Tree.new #: Tree
 
-        @scopes_stack = T.let([@tree], T::Array[Tree])
-        @last_node = T.let(nil, T.nilable(Prism::Node))
-        @last_sigs = T.let([], T::Array[RBI::Sig])
+        @scopes_stack = [@tree] #: Array[Tree]
+        @last_node = nil #: Prism::Node?
+        @last_sigs = [] #: Array[RBI::Sig]
       end
 
       # @override
@@ -217,30 +228,51 @@ module RBI
 
         current_scope << if struct
           struct
-        elsif type_variable_definition?(node.value)
-          TypeMember.new(
+        elsif t_enum_value?(node)
+          TEnumValue.new(
             case node
             when Prism::ConstantWriteNode
               node.name.to_s
             when Prism::ConstantPathWriteNode
               node_string!(node.target)
             end,
-            node_string!(node.value),
             loc: node_loc(node),
             comments: node_comments(node),
           )
         else
-          Const.new(
-            case node
-            when Prism::ConstantWriteNode
-              node.name.to_s
-            when Prism::ConstantPathWriteNode
-              node_string!(node.target)
-            end,
-            node_string!(node.value),
-            loc: node_loc(node),
-            comments: node_comments(node),
+          adjusted_node_location = adjust_prism_location_for_heredoc(node)
+
+          adjusted_value_location = Prism::Location.new(
+            node.value.location.send(:source),
+            node.value.location.start_offset,
+            adjusted_node_location.end_offset - node.value.location.start_offset,
           )
+
+          if type_variable_definition?(node.value)
+            TypeMember.new(
+              case node
+              when Prism::ConstantWriteNode
+                node.name.to_s
+              when Prism::ConstantPathWriteNode
+                node_string!(node.target)
+              end,
+              adjusted_value_location.slice,
+              loc: Loc.from_prism(@file, adjusted_node_location),
+              comments: node_comments(node),
+            )
+          else
+            Const.new(
+              case node
+              when Prism::ConstantWriteNode
+                node.name.to_s
+              when Prism::ConstantPathWriteNode
+                node_string!(node.target)
+              end,
+              adjusted_value_location.slice,
+              loc: Loc.from_prism(@file, adjusted_node_location),
+              comments: node_comments(node),
+            )
+          end
         end
       end
 
@@ -509,7 +541,7 @@ module RBI
       # Collect all the remaining comments after visiting the tree
       #: -> void
       def collect_orphan_comments
-        last_line = T.let(nil, T.nilable(Integer))
+        last_line = nil #: Integer?
         last_node_end = @tree.nodes.last&.loc&.end_line
 
         @comments_by_line.each do |line, comment|
@@ -532,7 +564,7 @@ module RBI
 
       #: -> Tree
       def current_scope
-        T.must(@scopes_stack.last) # Should never be nil since we create a Tree as the root
+        @scopes_stack.last #: as !nil # Should never be nil since we create a Tree as the root
       end
 
       #: -> Array[Sig]
@@ -544,7 +576,7 @@ module RBI
 
       #: (Array[Sig] sigs) -> Array[Comment]
       def detach_comments_from_sigs(sigs)
-        comments = T.let([], T::Array[Comment])
+        comments = [] #: Array[Comment]
 
         sigs.each do |sig|
           comments += sig.comments.dup
@@ -576,7 +608,9 @@ module RBI
       def parse_comment(node)
         loc = Loc.from_prism(@file, node.location)
         string = node.location.slice
-        if string.start_with?("#:")
+        # We also ignore RDoc directives such as `:nodoc:`
+        # See https://ruby.github.io/rdoc/RDoc/MarkupReference.html#class-RDoc::MarkupReference-label-Directives
+        if string.start_with?("#:") && !(string =~ /^#:[a-z_]+:/)
           RBSComment.new(string.gsub(/^#: ?/, "").rstrip, loc: loc)
         else
           Comment.new(string.gsub(/^# ?/, "").rstrip, loc: loc)
@@ -585,7 +619,7 @@ module RBI
 
       #: (Prism::Node? node) -> Array[Arg]
       def parse_send_args(node)
-        args = T.let([], T::Array[Arg])
+        args = [] #: Array[Arg]
         return args unless node.is_a?(Prism::ArgumentsNode)
 
         node.arguments.each do |arg|
@@ -596,11 +630,13 @@ module RBI
 
               args << KwArg.new(
                 node_string!(assoc.key).delete_suffix(":"),
-                T.must(node_string(assoc.value)),
+                node_string(assoc.value), #: as !nil
               )
             end
           else
-            args << Arg.new(T.must(node_string(arg)))
+            args << Arg.new(
+              node_string(arg), #: as !nil
+            )
           end
         end
 
@@ -701,7 +737,7 @@ module RBI
         return unless node_string(recv) =~ /(::)?Struct/
 
         members = []
-        keyword_init = T.let(false, T::Boolean)
+        keyword_init = false #: bool
 
         args = send.arguments
         if args.is_a?(Prism::ArgumentsNode)
@@ -751,7 +787,7 @@ module RBI
         type = node_string!(type_arg)
         loc = node_loc(send)
         comments = node_comments(send)
-        default_value = T.let(nil, T.nilable(String))
+        default_value = nil #: String?
 
         rest.each do |arg|
           next unless arg.is_a?(Prism::KeywordHashNode)
@@ -817,6 +853,19 @@ module RBI
       def type_variable_definition?(node)
         node.is_a?(Prism::CallNode) && (node.message == "type_member" || node.message == "type_template")
       end
+
+      #: (Prism::Node? node) -> bool
+      def t_enum_value?(node)
+        return false unless current_scope.is_a?(TEnumBlock)
+
+        return false unless node.is_a?(Prism::ConstantWriteNode)
+
+        value = node.value
+        return false unless value.is_a?(Prism::CallNode)
+        return false unless value.message == "new"
+
+        true
+      end
     end
 
     class SigBuilder < Visitor
@@ -827,7 +876,7 @@ module RBI
       def initialize(content, file:)
         super
 
-        @current = T.let(Sig.new, Sig)
+        @current = Sig.new #: Sig
       end
 
       # @override
@@ -901,5 +950,57 @@ module RBI
         )
       end
     end
+
+    class HeredocLocationVisitor < Prism::Visitor
+      #: (Prism::Source source, Integer begin_offset, Integer end_offset) -> void
+      def initialize(source, begin_offset, end_offset)
+        super()
+        @source = source
+        @begin_offset = begin_offset
+        @end_offset = end_offset
+        @offset_last_newline = false #: bool
+      end
+
+      #: (Prism::StringNode node) -> void
+      def visit_string_node(node)
+        return unless node.heredoc?
+
+        closing_loc = node.closing_loc
+        return unless closing_loc
+
+        handle_string_node(node)
+      end
+
+      #: (Prism::InterpolatedStringNode node) -> void
+      def visit_interpolated_string_node(node)
+        return super unless node.heredoc?
+
+        closing_loc = node.closing_loc
+        return super unless closing_loc
+
+        handle_string_node(node)
+      end
+
+      #: -> Prism::Location
+      def location
+        Prism::Location.new(
+          @source,
+          @begin_offset,
+          @end_offset - @begin_offset - (@offset_last_newline ? 1 : 0),
+        )
+      end
+
+      private
+
+      #: (Prism::StringNode | Prism::InterpolatedStringNode node) -> void
+      def handle_string_node(node)
+        closing_loc = node.closing_loc #: as !nil
+
+        if closing_loc.end_offset > @end_offset
+          @end_offset = closing_loc.end_offset
+          @offset_last_newline = true if node.closing_loc&.slice&.end_with?("\n")
+        end
+      end
+    end
   end
 end

data/lib/rbi/printer.rb

@@ -23,8 +23,8 @@ module RBI
       @out = out
       @current_indent = indent
       @print_locs = print_locs
-      @in_visibility_group = T.let(false, T::Boolean)
-      @previous_node = T.let(nil, T.nilable(Node))
+      @in_visibility_group = false #: bool
+      @previous_node = nil #: Node?
       @max_line_length = max_line_length
     end
 
@@ -542,6 +542,16 @@ module RBI
       printl("end")
     end
 
+    # @override
+    #: (TEnumValue node) -> void
+    def visit_tenum_value(node)
+      print_blank_line_before(node)
+      print_loc(node)
+      visit_all(node.comments)
+
+      printl("#{node.name} = new")
+    end
+
     # @override
     #: (TypeMember node) -> void
     def visit_type_member(node)
@@ -675,6 +685,13 @@ module RBI
         node.comments.empty? && node.empty?
       when Attr
         node.comments.empty? && node.sigs.empty?
+      when Const
+        return false unless node.comments.empty?
+
+        loc = node.loc
+        return true unless loc
+
+        loc.begin_line == loc.end_line
       when Method
         node.comments.empty? && node.sigs.empty? && node.params.all? { |p| p.comments.empty? }
       when Sig
@@ -722,7 +739,9 @@ module RBI
       printn(" do")
       indent
       if modifiers.any?
-        printl(T.must(modifiers.first))
+        printl(
+          modifiers.first, #: as !nil
+        )
         indent
         modifiers[1..]&.each do |modifier|
           printl(".#{modifier}")
@@ -771,7 +790,7 @@ module RBI
 
     #: (Sig node) -> Array[String]
     def sig_modifiers(node)
-      modifiers = T.let([], T::Array[String])
+      modifiers = [] #: Array[String]
       modifiers << "abstract" if node.is_abstract
 
       if node.is_override

data/lib/rbi/rbs/method_type_translator.rb

@@ -21,7 +21,7 @@ module RBI
       #: (Method) -> void
       def initialize(method)
         @method = method
-        @result = T.let(Sig.new, Sig)
+        @result = Sig.new #: Sig
       end
 
       #: (::RBS::MethodType) -> void
@@ -44,7 +44,7 @@ module RBI
         raise Error, "No block param found" unless block_param
 
         block_name = block_param.name
-        block_type = T.cast(translate_type(type.type), RBI::Type::Proc)
+        block_type = translate_type(type.type) #: as RBI::Type::Proc
 
         bind = type.self_type
         block_type.bind(translate_type(bind)) if bind

data/lib/rbi/rbs/type_translator.rb

@@ -75,7 +75,7 @@ module RBI
           when ::RBS::Types::Optional
             Type.nilable(translate(type.type))
           when ::RBS::Types::Proc
-            proc = T.cast(translate(type.type), Type::Proc)
+            proc = translate(type.type) #: as Type::Proc
             proc.bind(translate(type.self_type)) if type.self_type
             proc
           when ::RBS::Types::Record

data/lib/rbi/rbs_printer.rb

@@ -23,9 +23,9 @@ module RBI
       @out = out
       @current_indent = indent
       @print_locs = print_locs
-      @in_visibility_group = T.let(false, T::Boolean)
-      @previous_node = T.let(nil, T.nilable(Node))
-      @positional_names = T.let(positional_names, T::Boolean)
+      @in_visibility_group = false #: bool
+      @previous_node = nil #: Node?
+      @positional_names = positional_names #: bool
     end
 
     # Printing
@@ -349,7 +349,10 @@ module RBI
       print(": ")
       if sigs.any?
         first, *rest = sigs
-        print_method_sig(node, T.must(first))
+        print_method_sig(
+          node,
+          first, #: as !nil
+        )
         if rest.any?
           spaces = node.name.size + 4
           rest.each do |sig|
@@ -645,19 +648,22 @@ module RBI
     # @override
     #: (TEnumBlock node) -> void
     def visit_tenum_block(node)
-      node.nodes.each do |child|
-        child = if child.is_a?(Const) && child.value == "new"
-          parent = node.parent_scope
-          Const.new(
-            child.name,
-            "T.let(nil, #{parent.is_a?(TEnum) ? parent.name : "T.untyped"})",
-            comments: child.comments,
-          )
-        else
-          child
-        end
-        visit(child)
-        @previous_node = child
+      visit_all(node.nodes)
+    end
+
+    # @override
+    #: (TEnumValue node) -> void
+    def visit_tenum_value(node)
+      print_blank_line_before(node)
+      print_loc(node)
+      visit_all(node.comments)
+
+      t_enum = node.parent_scope&.parent_scope
+
+      if t_enum.is_a?(TEnum)
+        printl("#{node.name}: #{t_enum.name}")
+      else
+        printl("#{node.name}: untyped")
       end
     end
 
@@ -882,7 +888,7 @@ module RBI
 
     #: -> void
     def initialize
-      @string = T.let(String.new, String)
+      @string = String.new #: String
     end
 
     #: (Type node) -> void

data/lib/rbi/rewriters/flatten_singleton_methods.rb

@@ -41,7 +41,8 @@ module RBI
 
             child.detach
             child.is_singleton = true
-            T.must(node.parent_tree) << child
+            parent_tree = node.parent_tree #: as !nil
+            parent_tree << child
           end
 
           node.detach if node.nodes.empty?

data/lib/rbi/rewriters/flatten_visibilities.rb

@@ -29,7 +29,7 @@ module RBI
       def initialize
         super
 
-        @current_visibility = T.let([Public.new], T::Array[Visibility])
+        @current_visibility = [Public.new] #: Array[Visibility]
       end
 
       # @override
@@ -46,7 +46,7 @@ module RBI
           visit_all(node.nodes.dup)
           @current_visibility.pop
         when Attr, Method
-          node.visibility = T.must(@current_visibility.last)
+          node.visibility = @current_visibility.last #: as !nil
         end
       end
     end