rbi 0.2.4 → 0.3.0

data/lib/rbi/rewriters/add_sig_templates.rb

@@ -4,15 +4,14 @@
 module RBI
   module Rewriters
     class AddSigTemplates < Visitor
-      extend T::Sig
-
-      sig { params(with_todo_comment: T::Boolean).void }
+      #: (?with_todo_comment: bool) -> void
       def initialize(with_todo_comment: true)
         super()
         @with_todo_comment = with_todo_comment
       end
 
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         case node
         when Tree
@@ -26,7 +25,7 @@ module RBI
 
       private
 
-      sig { params(attr: Attr).void }
+      #: (Attr attr) -> void
       def add_attr_sig(attr)
         return unless attr.sigs.empty?
         return if attr.names.size > 1
@@ -41,7 +40,7 @@ module RBI
         add_todo_comment(attr)
       end
 
-      sig { params(method: Method).void }
+      #: (Method method) -> void
       def add_method_sig(method)
         return unless method.sigs.empty?
 
@@ -52,7 +51,7 @@ module RBI
         add_todo_comment(method)
       end
 
-      sig { params(node: NodeWithComments).void }
+      #: (NodeWithComments node) -> void
       def add_todo_comment(node)
         node.comments << Comment.new("TODO: fill in signature with appropriate type information") if @with_todo_comment
       end
@@ -60,9 +59,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { params(with_todo_comment: T::Boolean).void }
+    #: (?with_todo_comment: bool) -> void
     def add_sig_templates!(with_todo_comment: true)
       visitor = Rewriters::AddSigTemplates.new(with_todo_comment: with_todo_comment)
       visitor.visit(self)

data/lib/rbi/rewriters/annotate.rb

@@ -4,9 +4,7 @@
 module RBI
   module Rewriters
     class Annotate < Visitor
-      extend T::Sig
-
-      sig { params(annotation: String, annotate_scopes: T::Boolean, annotate_properties: T::Boolean).void }
+      #: (String annotation, ?annotate_scopes: bool, ?annotate_properties: bool) -> void
       def initialize(annotation, annotate_scopes: false, annotate_properties: false)
         super()
         @annotation = annotation
@@ -14,7 +12,8 @@ module RBI
         @annotate_properties = annotate_properties
       end
 
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         case node
         when Scope
@@ -27,14 +26,14 @@ module RBI
 
       private
 
-      sig { params(node: NodeWithComments).void }
+      #: (NodeWithComments node) -> void
       def annotate_node(node)
         return if node.annotations.one?(@annotation)
 
         node.comments << Comment.new("@#{@annotation}")
       end
 
-      sig { params(node: Node).returns(T::Boolean) }
+      #: (Node node) -> bool
       def root?(node)
         parent = node.parent_tree
         parent.is_a?(Tree) && parent.parent_tree.nil?
@@ -43,9 +42,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { params(annotation: String, annotate_scopes: T::Boolean, annotate_properties: T::Boolean).void }
+    #: (String annotation, ?annotate_scopes: bool, ?annotate_properties: bool) -> void
     def annotate!(annotation, annotate_scopes: false, annotate_properties: false)
       visitor = Rewriters::Annotate.new(
         annotation,

data/lib/rbi/rewriters/attr_to_methods.rb

@@ -3,10 +3,10 @@
 
 module RBI
   class UnexpectedMultipleSigsError < Error
-    sig { returns(Node) }
+    #: Node
     attr_reader :node
 
-    sig { params(node: Node).void }
+    #: (Node node) -> void
     def initialize(node)
       super(<<~MSG)
         This declaration cannot have more than one sig.
@@ -20,9 +20,8 @@ module RBI
 
   module Rewriters
     class AttrToMethods < Visitor
-      extend T::Sig
-
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         case node
         when Tree
@@ -35,7 +34,7 @@ module RBI
 
       private
 
-      sig { params(node: Node, with: T::Array[Node]).void }
+      #: (Node node, with: Array[Node]) -> void
       def replace(node, with:)
         tree = node.parent_tree
         raise ReplaceNodeError, "Can't replace #{self} without a parent tree" unless tree
@@ -47,9 +46,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { void }
+    #: -> void
     def replace_attributes_with_methods!
       visitor = Rewriters::AttrToMethods.new
       visitor.visit(self)
@@ -62,7 +59,8 @@ module RBI
 
     private
 
-    sig(:final) { returns([T.nilable(Sig), T.nilable(T.any(Type, String))]) }
+    # @final
+    #: -> [Sig?, (Type | String)?]
     def parse_sig
       raise UnexpectedMultipleSigsError, self if 1 < sigs.count
 
@@ -77,15 +75,7 @@ module RBI
       [sig, attribute_type]
     end
 
-    sig do
-      params(
-        name: String,
-        sig: T.nilable(Sig),
-        visibility: Visibility,
-        loc: T.nilable(Loc),
-        comments: T::Array[Comment],
-      ).returns(Method)
-    end
+    #: (String name, Sig? sig, Visibility visibility, Loc? loc, Array[Comment] comments) -> Method
     def create_getter_method(name, sig, visibility, loc, comments)
       Method.new(
         name,
@@ -97,16 +87,7 @@ module RBI
       )
     end
 
-    sig do
-      params(
-        name: String,
-        sig: T.nilable(Sig),
-        attribute_type: T.nilable(T.any(Type, String)),
-        visibility: Visibility,
-        loc: T.nilable(Loc),
-        comments: T::Array[Comment],
-      ).returns(Method)
-    end
+    #: (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)] : []
@@ -136,7 +117,8 @@ module RBI
   end
 
   class AttrAccessor
-    sig { override.returns(T::Array[Method]) }
+    # @override
+    #: -> Array[Method]
     def convert_to_methods
       sig, attribute_type = parse_sig
 
@@ -150,7 +132,8 @@ module RBI
   end
 
   class AttrReader
-    sig { override.returns(T::Array[Method]) }
+    # @override
+    #: -> Array[Method]
     def convert_to_methods
       sig, _ = parse_sig
 
@@ -159,7 +142,8 @@ module RBI
   end
 
   class AttrWriter
-    sig { override.returns(T::Array[Method]) }
+    # @override
+    #: -> Array[Method]
     def convert_to_methods
       sig, attribute_type = parse_sig
 

data/lib/rbi/rewriters/deannotate.rb

@@ -4,15 +4,14 @@
 module RBI
   module Rewriters
     class Deannotate < Visitor
-      extend T::Sig
-
-      sig { params(annotation: String).void }
+      #: (String annotation) -> void
       def initialize(annotation)
         super()
         @annotation = annotation
       end
 
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         case node
         when Scope, Const, Attr, Method, TStructField, TypeMember
@@ -23,7 +22,7 @@ module RBI
 
       private
 
-      sig { params(node: NodeWithComments).void }
+      #: (NodeWithComments node) -> void
       def deannotate_node(node)
         return unless node.annotations.one?(@annotation)
 
@@ -35,9 +34,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { params(annotation: String).void }
+    #: (String annotation) -> void
     def deannotate!(annotation)
       visitor = Rewriters::Deannotate.new(annotation)
       visitor.visit(self)

data/lib/rbi/rewriters/filter_versions.rb

@@ -55,27 +55,24 @@ module RBI
     # RBI with no versions:
     # - RBI with no version annotations are automatically counted towards ALL versions
     class FilterVersions < Visitor
-      extend T::Sig
-
       VERSION_PREFIX = "version "
 
       class << self
-        extend T::Sig
-
-        sig { params(tree: Tree, version: Gem::Version).void }
+        #: (Tree tree, Gem::Version version) -> void
         def filter(tree, version)
           v = new(version)
           v.visit(tree)
         end
       end
 
-      sig { params(version: Gem::Version).void }
+      #: (Gem::Version version) -> void
       def initialize(version)
         super()
         @version = version
       end
 
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         return unless node
 
@@ -90,7 +87,7 @@ module RBI
   end
 
   class Node
-    sig { params(version: Gem::Version).returns(T::Boolean) }
+    #: (Gem::Version version) -> bool
     def satisfies_version?(version)
       return true unless is_a?(NodeWithComments)
 
@@ -100,7 +97,7 @@ module RBI
   end
 
   class NodeWithComments
-    sig { returns(T::Array[Gem::Requirement]) }
+    #: -> Array[Gem::Requirement]
     def version_requirements
       annotations.select do |annotation|
         annotation.start_with?(Rewriters::FilterVersions::VERSION_PREFIX)
@@ -112,9 +109,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { params(version: Gem::Version).void }
+    #: (Gem::Version version) -> void
     def filter_versions!(version)
       visitor = Rewriters::FilterVersions.new(version)
       visitor.visit(self)

data/lib/rbi/rewriters/flatten_singleton_methods.rb

@@ -28,9 +28,8 @@ module RBI
     # end
     # ~~~
     class FlattenSingletonMethods < Visitor
-      extend T::Sig
-
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         return unless node
 
@@ -54,9 +53,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { void }
+    #: -> void
     def flatten_singleton_methods!
       visitor = Rewriters::FlattenSingletonMethods.new
       visitor.visit(self)

data/lib/rbi/rewriters/flatten_visibilities.rb

@@ -25,16 +25,15 @@ module RBI
     # end
     # ~~~
     class FlattenVisibilities < Visitor
-      extend T::Sig
-
-      sig { void }
+      #: -> void
       def initialize
         super
 
         @current_visibility = T.let([Public.new], T::Array[Visibility])
       end
 
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         return unless node
 
@@ -54,9 +53,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { void }
+    #: -> void
     def flatten_visibilities!
       visitor = Rewriters::FlattenVisibilities.new
       visitor.visit(self)

data/lib/rbi/rewriters/group_nodes.rb

@@ -6,9 +6,8 @@ module RBI
 
   module Rewriters
     class GroupNodes < Visitor
-      extend T::Sig
-
-      sig { override.params(node: T.nilable(Node)).void }
+      # @override
+      #: (Node? node) -> void
       def visit(node)
         return unless node
 
@@ -32,7 +31,7 @@ module RBI
 
       private
 
-      sig { params(node: Node).returns(Group::Kind) }
+      #: (Node node) -> Group::Kind
       def group_kind(node)
         case node
         when Group
@@ -75,9 +74,7 @@ module RBI
   end
 
   class Tree
-    extend T::Sig
-
-    sig { void }
+    #: -> void
     def group_nodes!
       visitor = Rewriters::GroupNodes.new
       visitor.visit(self)
@@ -85,12 +82,10 @@ module RBI
   end
 
   class Group < Tree
-    extend T::Sig
-
-    sig { returns(Kind) }
+    #: Kind
     attr_reader :kind
 
-    sig { params(kind: Kind).void }
+    #: (Kind kind) -> void
     def initialize(kind)
       super()
       @kind = kind