rbi 0.0.16 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bda85d642d83b25177d24ab2bc789631861302ebc31c862ea40bcd56b034ec68
-  data.tar.gz: 23071846fc0c1edaa681ab3cbb4c2663fc27a00666ef890fcdb404546128307d
+  metadata.gz: 6a2cb2f6b2287a3faed50161d70e0c863892c88c6eef5a3c798ccf8e16e0c441
+  data.tar.gz: e851f3b85aa62534a3a1c867085add40aa7669df3b003f17e62eb81ce36c58ed
 SHA512:
-  metadata.gz: f7678a81e3e9e66a858c72c5093ebc0fdc0bec4d0e4d08ac662341959f1e82dfa5ef5898a5c166442c718907faef2ad826e979dd7dd98a48c5496969209ffdc8
-  data.tar.gz: c4616ce80159a71fea63a23ce90d6eaf7527fabda7200224ea213aedf0926610a974d1a428c569d0f2bfe0b3efa84fd73b7476bd29312189dd3df2e3ef321c56
+  metadata.gz: b566ecfc9c01ebf7524efb055302e3da780caf0e0cc3ab36bdca798ff8390cce5247bce1318c5373c8339fede498f3bc87ffd5071ace658880c0b3724a9f1d15
+  data.tar.gz: d95c6b6ea53cf84c348b2426b9bf10ad8213282f48ec9364cb9b1512aef9dd4c896d18c09c1dac79abe40f136194ab550571ac141e960eab61e4026bdbf3c578

data/Gemfile

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

data/lib/rbi/formatter.rb

@@ -5,8 +5,20 @@ module RBI
   class Formatter
     extend T::Sig
 
-    sig { returns(T::Boolean) }
-    attr_accessor :add_sig_templates, :group_nodes, :nest_singleton_methods, :nest_non_public_methods, :sort_nodes
+    sig { params(sort_nodes: T::Boolean).returns(T::Boolean) }
+    attr_writer :sort_nodes
+
+    sig { params(nest_singleton_methods: T::Boolean).returns(T::Boolean) }
+    attr_writer :nest_singleton_methods
+
+    sig { params(add_sig_templates: T::Boolean).returns(T::Boolean) }
+    attr_writer :add_sig_templates
+
+    sig { params(group_nodes: T::Boolean).returns(T::Boolean) }
+    attr_writer :group_nodes
+
+    sig { params(nest_non_public_methods: T::Boolean).returns(T::Boolean) }
+    attr_writer :nest_non_public_methods
 
     sig { returns(T.nilable(Integer)) }
     attr_accessor :max_line_length
@@ -18,7 +30,7 @@ module RBI
         max_line_length: T.nilable(Integer),
         nest_singleton_methods: T::Boolean,
         nest_non_public_methods: T::Boolean,
-        sort_nodes: T::Boolean
+        sort_nodes: T::Boolean,
       ).void
     end
     def initialize(
@@ -43,12 +55,6 @@ module RBI
       file.string(max_line_length: @max_line_length)
     end
 
-    sig { params(tree: RBI::Tree).returns(String) }
-    def print_tree(tree)
-      format_tree(tree)
-      tree.string(max_line_length: @max_line_length)
-    end
-
     sig { params(file: RBI::File).void }
     def format_file(file)
       format_tree(file.root)

data/lib/rbi/index.rb

@@ -6,11 +6,15 @@ module RBI
     extend T::Sig
     include T::Enumerable
 
-    sig { params(node: Node).returns(Index) }
-    def self.index(*node)
-      index = Index.new
-      index.visit_all(node)
-      index
+    class << self
+      extend T::Sig
+
+      sig { params(node: Node).returns(Index) }
+      def index(*node)
+        index = Index.new
+        index.visit_all(node)
+        index
+      end
     end
 
     sig { void }
@@ -171,6 +175,16 @@ module RBI
     end
   end
 
+  class TypeMember
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      [to_s]
+    end
+  end
+
   class Send
     extend T::Sig
     include Indexable

data/lib/rbi/loc.rb

@@ -5,6 +5,21 @@ module RBI
   class Loc
     extend T::Sig
 
+    class << self
+      extend T::Sig
+
+      sig { params(file: String, yarp_location: YARP::Location).returns(Loc) }
+      def from_yarp(file, yarp_location)
+        new(
+          file: file,
+          begin_line: yarp_location.start_line,
+          end_line: yarp_location.end_line,
+          begin_column: yarp_location.start_column,
+          end_column: yarp_location.end_column + 1, # TODO: Why is this off by one?
+        )
+      end
+    end
+
     sig { returns(T.nilable(String)) }
     attr_reader :file
 
@@ -17,7 +32,7 @@ module RBI
         begin_line: T.nilable(Integer),
         end_line: T.nilable(Integer),
         begin_column: T.nilable(Integer),
-        end_column: T.nilable(Integer)
+        end_column: T.nilable(Integer),
       ).void
     end
     def initialize(file: nil, begin_line: nil, end_line: nil, begin_column: nil, end_column: nil)
@@ -36,8 +51,8 @@ module RBI
     sig { returns(T.nilable(String)) }
     def source
       file = self.file
-      return nil unless file
-      return nil unless ::File.file?(file)
+      return unless file
+      return unless ::File.file?(file)
 
       return ::File.read(file) unless begin_line && end_line
 

data/lib/rbi/model.rb

@@ -24,6 +24,7 @@ module RBI
     def detach
       tree = parent_tree
       return unless tree
+
       tree.nodes.delete(self)
       self.parent_tree = nil
     end
@@ -32,8 +33,10 @@ module RBI
     def replace(node)
       tree = parent_tree
       raise unless tree
+
       index = tree.nodes.index(self)
       raise unless index
+
       tree.nodes[index] = node
       node.parent_tree = tree
       self.parent_tree = nil
@@ -62,6 +65,7 @@ module RBI
     sig { params(other: Object).returns(T::Boolean) }
     def ==(other)
       return false unless other.is_a?(Comment)
+
       text == other.text
     end
   end
@@ -109,7 +113,7 @@ module RBI
       params(
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Tree).void)
+        block: T.nilable(T.proc.params(node: Tree).void),
       ).void
     end
     def initialize(loc: nil, comments: [], &block)
@@ -146,7 +150,7 @@ module RBI
       params(
         strictness: T.nilable(String),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(file: File).void)
+        block: T.nilable(T.proc.params(file: File).void),
       ).void
     end
     def initialize(strictness: nil, comments: [], &block)
@@ -194,7 +198,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Module).void)
+        block: T.nilable(T.proc.params(node: Module).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -206,6 +210,7 @@ module RBI
     sig { override.returns(String) }
     def fully_qualified_name
       return name if name.start_with?("::")
+
       "#{parent_scope&.fully_qualified_name}::#{name}"
     end
   end
@@ -225,7 +230,7 @@ module RBI
         superclass_name: T.nilable(String),
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Class).void)
+        block: T.nilable(T.proc.params(node: Class).void),
       ).void
     end
     def initialize(name, superclass_name: nil, loc: nil, comments: [], &block)
@@ -238,6 +243,7 @@ module RBI
     sig { override.returns(String) }
     def fully_qualified_name
       return name if name.start_with?("::")
+
       "#{parent_scope&.fully_qualified_name}::#{name}"
     end
   end
@@ -249,7 +255,7 @@ module RBI
       params(
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: SingletonClass).void)
+        block: T.nilable(T.proc.params(node: SingletonClass).void),
       ).void
     end
     def initialize(loc: nil, comments: [], &block)
@@ -282,7 +288,7 @@ module RBI
         keyword_init: T::Boolean,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(struct: Struct).void)
+        block: T.nilable(T.proc.params(struct: Struct).void),
       ).void
     end
     def initialize(name, members: [], keyword_init: false, loc: nil, comments: [], &block)
@@ -296,6 +302,7 @@ module RBI
     sig { override.returns(String) }
     def fully_qualified_name
       return name if name.start_with?("::")
+
       "#{parent_scope&.fully_qualified_name}::#{name}"
     end
   end
@@ -314,7 +321,7 @@ module RBI
         value: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Const).void)
+        block: T.nilable(T.proc.params(node: Const).void),
       ).void
     end
     def initialize(name, value, loc: nil, comments: [], &block)
@@ -327,6 +334,7 @@ module RBI
     sig { returns(String) }
     def fully_qualified_name
       return name if name.start_with?("::")
+
       "#{parent_scope&.fully_qualified_name}::#{name}"
     end
 
@@ -360,7 +368,7 @@ module RBI
         visibility: Visibility,
         sigs: T::Array[Sig],
         loc: T.nilable(Loc),
-        comments: T::Array[Comment]
+        comments: T::Array[Comment],
       ).void
     end
     def initialize(name, names, visibility: Public.new, sigs: [], loc: nil, comments: [])
@@ -385,7 +393,7 @@ module RBI
         sigs: T::Array[Sig],
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: AttrAccessor).void)
+        block: T.nilable(T.proc.params(node: AttrAccessor).void),
       ).void
     end
     def initialize(name, *names, visibility: Public.new, sigs: [], loc: nil, comments: [], &block)
@@ -417,7 +425,7 @@ module RBI
         sigs: T::Array[Sig],
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: AttrReader).void)
+        block: T.nilable(T.proc.params(node: AttrReader).void),
       ).void
     end
     def initialize(name, *names, visibility: Public.new, sigs: [], loc: nil, comments: [], &block)
@@ -449,7 +457,7 @@ module RBI
         sigs: T::Array[Sig],
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: AttrWriter).void)
+        block: T.nilable(T.proc.params(node: AttrWriter).void),
       ).void
     end
     def initialize(name, *names, visibility: Public.new, sigs: [], loc: nil, comments: [], &block)
@@ -499,7 +507,7 @@ module RBI
         sigs: T::Array[Sig],
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Method).void)
+        block: T.nilable(T.proc.params(node: Method).void),
       ).void
     end
     def initialize(
@@ -576,7 +584,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: ReqParam).void)
+        block: T.nilable(T.proc.params(node: ReqParam).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -602,7 +610,7 @@ module RBI
         value: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: OptParam).void)
+        block: T.nilable(T.proc.params(node: OptParam).void),
       ).void
     end
     def initialize(name, value, loc: nil, comments: [], &block)
@@ -613,7 +621,7 @@ module RBI
 
     sig { params(other: T.nilable(Object)).returns(T::Boolean) }
     def ==(other)
-      OptParam === other && name == other.name && value == other.value
+      OptParam === other && name == other.name
     end
   end
 
@@ -625,7 +633,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: RestParam).void)
+        block: T.nilable(T.proc.params(node: RestParam).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -652,7 +660,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: KwParam).void)
+        block: T.nilable(T.proc.params(node: KwParam).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -683,7 +691,7 @@ module RBI
         value: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: KwOptParam).void)
+        block: T.nilable(T.proc.params(node: KwOptParam).void),
       ).void
     end
     def initialize(name, value, loc: nil, comments: [], &block)
@@ -699,7 +707,7 @@ module RBI
 
     sig { params(other: T.nilable(Object)).returns(T::Boolean) }
     def ==(other)
-      KwOptParam === other && name == other.name && value == other.value
+      KwOptParam === other && name == other.name
     end
   end
 
@@ -711,7 +719,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: KwRestParam).void)
+        block: T.nilable(T.proc.params(node: KwRestParam).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -738,7 +746,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: BlockParam).void)
+        block: T.nilable(T.proc.params(node: BlockParam).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -773,7 +781,7 @@ module RBI
         name: String,
         names: T::Array[String],
         loc: T.nilable(Loc),
-        comments: T::Array[Comment]
+        comments: T::Array[Comment],
       ).void
     end
     def initialize(name, names, loc: nil, comments: [])
@@ -791,7 +799,7 @@ module RBI
         names: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Include).void)
+        block: T.nilable(T.proc.params(node: Include).void),
       ).void
     end
     def initialize(name, *names, loc: nil, comments: [], &block)
@@ -814,7 +822,7 @@ module RBI
         names: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Extend).void)
+        block: T.nilable(T.proc.params(node: Extend).void),
       ).void
     end
     def initialize(name, *names, loc: nil, comments: [], &block)
@@ -873,7 +881,7 @@ module RBI
       params(
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Public).void)
+        block: T.nilable(T.proc.params(node: Public).void),
       ).void
     end
     def initialize(loc: nil, comments: [], &block)
@@ -889,7 +897,7 @@ module RBI
       params(
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Protected).void)
+        block: T.nilable(T.proc.params(node: Protected).void),
       ).void
     end
     def initialize(loc: nil, comments: [], &block)
@@ -905,7 +913,7 @@ module RBI
       params(
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Private).void)
+        block: T.nilable(T.proc.params(node: Private).void),
       ).void
     end
     def initialize(loc: nil, comments: [], &block)
@@ -931,7 +939,7 @@ module RBI
         args: T::Array[Arg],
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Send).void)
+        block: T.nilable(T.proc.params(node: Send).void),
       ).void
     end
     def initialize(method, args = [], loc: nil, comments: [], &block)
@@ -966,7 +974,7 @@ module RBI
     sig do
       params(
         value: String,
-        loc: T.nilable(Loc)
+        loc: T.nilable(Loc),
       ).void
     end
     def initialize(value, loc: nil)
@@ -995,7 +1003,7 @@ module RBI
       params(
         keyword: String,
         value: String,
-        loc: T.nilable(Loc)
+        loc: T.nilable(Loc),
       ).void
     end
     def initialize(keyword, value, loc: nil)
@@ -1045,7 +1053,7 @@ module RBI
         type_params: T::Array[String],
         checked: T.nilable(Symbol),
         loc: T.nilable(Loc),
-        block: T.nilable(T.proc.params(node: Sig).void)
+        block: T.nilable(T.proc.params(node: Sig).void),
       ).void
     end
     def initialize(
@@ -1080,6 +1088,7 @@ module RBI
     sig { params(other: Object).returns(T::Boolean) }
     def ==(other)
       return false unless other.is_a?(Sig)
+
       params == other.params && return_type == other.return_type && is_abstract == other.is_abstract &&
         is_override == other.is_override && is_overridable == other.is_overridable && is_final == other.is_final &&
         type_params == other.type_params && checked == other.checked
@@ -1098,7 +1107,7 @@ module RBI
         type: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: SigParam).void)
+        block: T.nilable(T.proc.params(node: SigParam).void),
       ).void
     end
     def initialize(name, type, loc: nil, comments: [], &block)
@@ -1124,7 +1133,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(klass: TStruct).void)
+        block: T.nilable(T.proc.params(klass: TStruct).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -1151,7 +1160,7 @@ module RBI
         type: String,
         default: T.nilable(String),
         loc: T.nilable(Loc),
-        comments: T::Array[Comment]
+        comments: T::Array[Comment],
       ).void
     end
     def initialize(name, type, default: nil, loc: nil, comments: [])
@@ -1175,7 +1184,7 @@ module RBI
         default: T.nilable(String),
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: TStructConst).void)
+        block: T.nilable(T.proc.params(node: TStructConst).void),
       ).void
     end
     def initialize(name, type, default: nil, loc: nil, comments: [], &block)
@@ -1205,7 +1214,7 @@ module RBI
         default: T.nilable(String),
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: TStructProp).void)
+        block: T.nilable(T.proc.params(node: TStructProp).void),
       ).void
     end
     def initialize(name, type, default: nil, loc: nil, comments: [], &block)
@@ -1235,7 +1244,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(klass: TEnum).void)
+        block: T.nilable(T.proc.params(klass: TEnum).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -1255,7 +1264,7 @@ module RBI
         names: T::Array[String],
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: TEnumBlock).void)
+        block: T.nilable(T.proc.params(node: TEnumBlock).void),
       ).void
     end
     def initialize(names = [], loc: nil, comments: [], &block)
@@ -1293,7 +1302,7 @@ module RBI
         name: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: Helper).void)
+        block: T.nilable(T.proc.params(node: Helper).void),
       ).void
     end
     def initialize(name, loc: nil, comments: [], &block)
@@ -1320,7 +1329,7 @@ module RBI
         value: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: TypeMember).void)
+        block: T.nilable(T.proc.params(node: TypeMember).void),
       ).void
     end
     def initialize(name, value, loc: nil, comments: [], &block)
@@ -1333,6 +1342,7 @@ module RBI
     sig { returns(String) }
     def fully_qualified_name
       return name if name.start_with?("::")
+
       "#{parent_scope&.fully_qualified_name}::#{name}"
     end
 
@@ -1351,7 +1361,7 @@ module RBI
         names: String,
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
-        block: T.nilable(T.proc.params(node: MixesInClassMethods).void)
+        block: T.nilable(T.proc.params(node: MixesInClassMethods).void),
       ).void
     end
     def initialize(name, *names, loc: nil, comments: [], &block)
@@ -1375,7 +1385,7 @@ module RBI
       params(
         name: String,
         loc: T.nilable(Loc),
-        comments: T::Array[Comment]
+        comments: T::Array[Comment],
       ).void
     end
     def initialize(name, loc: nil, comments: [])