spoom 1.5.4 → 1.6.0

data/lib/spoom/file_tree.rb

@@ -4,16 +4,14 @@
 module Spoom
   # Build a file hierarchy from a set of file paths.
   class FileTree
-    extend T::Sig
-
-    sig { params(paths: T::Enumerable[String]).void }
+    #: (?T::Enumerable[String] paths) -> void
     def initialize(paths = [])
       @roots = T.let({}, T::Hash[String, Node])
       add_paths(paths)
     end
 
     # Add all `paths` to the tree
-    sig { params(paths: T::Enumerable[String]).void }
+    #: (T::Enumerable[String] paths) -> void
     def add_paths(paths)
       paths.each { |path| add_path(path) }
     end
@@ -21,7 +19,7 @@ module Spoom
     # Add a `path` to the tree
     #
     # This will create all nodes until the root of `path`.
-    sig { params(path: String).returns(Node) }
+    #: (String path) -> Node
     def add_path(path)
       parts = path.split("/")
       if path.empty? || parts.size == 1
@@ -35,13 +33,13 @@ module Spoom
     end
 
     # All root nodes
-    sig { returns(T::Array[Node]) }
+    #: -> Array[Node]
     def roots
       @roots.values
     end
 
     # All the nodes in this tree
-    sig { returns(T::Array[Node]) }
+    #: -> Array[Node]
     def nodes
       v = CollectNodes.new
       v.visit_tree(self)
@@ -49,13 +47,13 @@ module Spoom
     end
 
     # All the paths in this tree
-    sig { returns(T::Array[String]) }
+    #: -> Array[String]
     def paths
       nodes.map(&:path)
     end
 
     # Return a map of typing scores for each node in the tree
-    sig { params(context: Context).returns(T::Hash[Node, Float]) }
+    #: (Context context) -> Hash[Node, Float]
     def nodes_strictness_scores(context)
       v = CollectScores.new(context)
       v.visit_tree(self)
@@ -63,12 +61,12 @@ module Spoom
     end
 
     # Return a map of typing scores for each path in the tree
-    sig { params(context: Context).returns(T::Hash[String, Float]) }
+    #: (Context context) -> Hash[String, Float]
     def paths_strictness_scores(context)
       nodes_strictness_scores(context).map { |node, score| [node.path, score] }.to_h
     end
 
-    sig { params(out: T.any(IO, StringIO), colors: T::Boolean).void }
+    #: (?out: (IO | StringIO), ?colors: bool) -> void
     def print(out: $stdout, colors: true)
       printer = Printer.new({}, out: out, colors: colors)
       printer.visit_tree(self)
@@ -76,8 +74,6 @@ module Spoom
 
     # A node representing either a file or a directory inside a FileTree
     class Node < T::Struct
-      extend T::Sig
-
       # Node parent or `nil` if the node is a root one
       const :parent, T.nilable(Node)
 
@@ -88,7 +84,7 @@ module Spoom
       const :children, T::Hash[String, Node], default: {}
 
       # Full path to this node from root
-      sig { returns(String) }
+      #: -> String
       def path
         parent = self.parent
         return name unless parent
@@ -99,22 +95,21 @@ module Spoom
 
     # An abstract visitor for FileTree
     class Visitor
-      extend T::Sig
       extend T::Helpers
 
       abstract!
 
-      sig { params(tree: FileTree).void }
+      #: (FileTree tree) -> void
       def visit_tree(tree)
         visit_nodes(tree.roots)
       end
 
-      sig { params(node: FileTree::Node).void }
+      #: (FileTree::Node node) -> void
       def visit_node(node)
         visit_nodes(node.children.values)
       end
 
-      sig { params(nodes: T::Array[FileTree::Node]).void }
+      #: (Array[FileTree::Node] nodes) -> void
       def visit_nodes(nodes)
         nodes.each { |node| visit_node(node) }
       end
@@ -122,18 +117,17 @@ module Spoom
 
     # A visitor that collects all the nodes in a tree
     class CollectNodes < Visitor
-      extend T::Sig
-
-      sig { returns(T::Array[FileTree::Node]) }
+      #: Array[FileTree::Node]
       attr_reader :nodes
 
-      sig { void }
+      #: -> void
       def initialize
         super()
         @nodes = T.let([], T::Array[FileTree::Node])
       end
 
-      sig { override.params(node: FileTree::Node).void }
+      # @override
+      #: (FileTree::Node node) -> void
       def visit_node(node)
         @nodes << node
         super
@@ -142,19 +136,18 @@ module Spoom
 
     # A visitor that collects the strictness of each node in a tree
     class CollectStrictnesses < Visitor
-      extend T::Sig
-
-      sig { returns(T::Hash[Node, T.nilable(String)]) }
+      #: Hash[Node, String?]
       attr_reader :strictnesses
 
-      sig { params(context: Context).void }
+      #: (Context context) -> void
       def initialize(context)
         super()
         @context = context
         @strictnesses = T.let({}, T::Hash[Node, T.nilable(String)])
       end
 
-      sig { override.params(node: FileTree::Node).void }
+      # @override
+      #: (FileTree::Node node) -> void
       def visit_node(node)
         path = node.path
         @strictnesses[node] = @context.read_file_strictness(path) if @context.file?(path)
@@ -165,19 +158,18 @@ module Spoom
 
     # A visitor that collects the typing score of each node in a tree
     class CollectScores < CollectStrictnesses
-      extend T::Sig
-
-      sig { returns(T::Hash[Node, Float]) }
+      #: Hash[Node, Float]
       attr_reader :scores
 
-      sig { params(context: Context).void }
+      #: (Context context) -> void
       def initialize(context)
         super
         @context = context
         @scores = T.let({}, T::Hash[Node, Float])
       end
 
-      sig { override.params(node: FileTree::Node).void }
+      # @override
+      #: (FileTree::Node node) -> void
       def visit_node(node)
         super
 
@@ -186,7 +178,7 @@ module Spoom
 
       private
 
-      sig { params(node: Node).returns(Float) }
+      #: (Node node) -> Float
       def node_score(node)
         if @context.file?(node.path)
           strictness_score(@strictnesses[node])
@@ -195,7 +187,7 @@ module Spoom
         end
       end
 
-      sig { params(strictness: T.nilable(String)).returns(Float) }
+      #: (String? strictness) -> Float
       def strictness_score(strictness)
         case strictness
         when "true", "strict", "strong"
@@ -210,15 +202,7 @@ module Spoom
     #
     # See `FileTree#print`
     class Printer < Visitor
-      extend T::Sig
-
-      sig do
-        params(
-          strictnesses: T::Hash[FileTree::Node, T.nilable(String)],
-          out: T.any(IO, StringIO),
-          colors: T::Boolean,
-        ).void
-      end
+      #: (Hash[FileTree::Node, String?] strictnesses, ?out: (IO | StringIO), ?colors: bool) -> void
       def initialize(strictnesses, out: $stdout, colors: true)
         super()
         @strictnesses = strictnesses
@@ -226,7 +210,8 @@ module Spoom
         @printer = T.let(Spoom::Printer.new(out: out, colors: colors), Spoom::Printer)
       end
 
-      sig { override.params(node: FileTree::Node).void }
+      # @override
+      #: (FileTree::Node node) -> void
       def visit_node(node)
         @printer.printt
         if node.children.empty?
@@ -251,7 +236,7 @@ module Spoom
 
       private
 
-      sig { params(strictness: T.nilable(String)).returns(Color) }
+      #: (String? strictness) -> Color
       def strictness_color(strictness)
         case strictness
         when "false"

data/lib/spoom/location.rb

@@ -3,16 +3,12 @@
 
 module Spoom
   class Location
-    extend T::Sig
-
     include Comparable
 
     class LocationError < Spoom::Error; end
 
     class << self
-      extend T::Sig
-
-      sig { params(location_string: String).returns(Location) }
+      #: (String location_string) -> Location
       def from_string(location_string)
         file, rest = location_string.split(":", 2)
         raise LocationError, "Invalid location string `#{location_string}`: missing file name" unless file
@@ -43,7 +39,7 @@ module Spoom
         )
       end
 
-      sig { params(file: String, location: Prism::Location).returns(Location) }
+      #: (String file, Prism::Location location) -> Location
       def from_prism(file, location)
         new(
           file,
@@ -55,21 +51,13 @@ module Spoom
       end
     end
 
-    sig { returns(String) }
+    #: String
     attr_reader :file
 
-    sig { returns(T.nilable(Integer)) }
+    #: Integer?
     attr_reader :start_line, :start_column, :end_line, :end_column
 
-    sig do
-      params(
-        file: String,
-        start_line: T.nilable(Integer),
-        start_column: T.nilable(Integer),
-        end_line: T.nilable(Integer),
-        end_column: T.nilable(Integer),
-      ).void
-    end
+    #: (String file, ?start_line: Integer?, ?start_column: Integer?, ?end_line: Integer?, ?end_column: Integer?) -> void
     def initialize(file, start_line: nil, start_column: nil, end_line: nil, end_column: nil)
       raise LocationError,
         "Invalid location: end line is required if start line is provided" if start_line && !end_line
@@ -89,7 +77,7 @@ module Spoom
       @end_column = end_column
     end
 
-    sig { params(other: Location).returns(T::Boolean) }
+    #: (Location other) -> bool
     def include?(other)
       return false unless @file == other.file
       return false if (@start_line || -Float::INFINITY) > (other.start_line || -Float::INFINITY)
@@ -102,7 +90,8 @@ module Spoom
       true
     end
 
-    sig { override.params(other: BasicObject).returns(T.nilable(Integer)) }
+    # @override
+    #: (BasicObject other) -> Integer?
     def <=>(other)
       return unless Location === other
 
@@ -125,7 +114,7 @@ module Spoom
       comparison_array_self <=> comparison_array_other
     end
 
-    sig { returns(String) }
+    #: -> String
     def to_s
       if @start_line && @start_column
         "#{@file}:#{@start_line}:#{@start_column}-#{@end_line}:#{@end_column}"

data/lib/spoom/model/builder.rb

@@ -5,14 +5,18 @@ module Spoom
   class Model
     # Populate a Model by visiting the nodes from a Ruby file
     class Builder < NamespaceVisitor
-      extend T::Sig
-
-      sig { params(model: Model, file: String).void }
-      def initialize(model, file)
+      #: (Model model, String file, ?comments: Array[Prism::Comment]) -> void
+      def initialize(model, file, comments:)
         super()
 
         @model = model
         @file = file
+        @comments_by_line = T.let(
+          comments.to_h do |c|
+            [c.location.start_line, c]
+          end,
+          T::Hash[Integer, Prism::Comment],
+        )
         @namespace_nesting = T.let([], T::Array[Namespace])
         @visibility_stack = T.let([Visibility::Public], T::Array[Visibility])
         @last_sigs = T.let([], T::Array[Sig])
@@ -20,13 +24,15 @@ module Spoom
 
       # Classes
 
-      sig { override.params(node: Prism::ClassNode).void }
+      # @override
+      #: (Prism::ClassNode node) -> void
       def visit_class_node(node)
         @namespace_nesting << Class.new(
           @model.register_symbol(@names_nesting.join("::")),
           owner: @namespace_nesting.last,
           location: node_location(node),
           superclass_name: node.superclass&.slice,
+          comments: node_comments(node),
         )
         @visibility_stack << Visibility::Public
         super
@@ -35,12 +41,14 @@ module Spoom
         @last_sigs.clear
       end
 
-      sig { override.params(node: Prism::SingletonClassNode).void }
+      # @override
+      #: (Prism::SingletonClassNode node) -> void
       def visit_singleton_class_node(node)
         @namespace_nesting << SingletonClass.new(
           @model.register_symbol(@names_nesting.join("::")),
           owner: @namespace_nesting.last,
           location: node_location(node),
+          comments: node_comments(node),
         )
         @visibility_stack << Visibility::Public
         super
@@ -51,12 +59,14 @@ module Spoom
 
       # Modules
 
-      sig { override.params(node: Prism::ModuleNode).void }
+      # @override
+      #: (Prism::ModuleNode node) -> void
       def visit_module_node(node)
         @namespace_nesting << Module.new(
           @model.register_symbol(@names_nesting.join("::")),
           owner: @namespace_nesting.last,
           location: node_location(node),
+          comments: node_comments(node),
         )
         @visibility_stack << Visibility::Public
         super
@@ -67,7 +77,8 @@ module Spoom
 
       # Constants
 
-      sig { override.params(node: Prism::ConstantPathWriteNode).void }
+      # @override
+      #: (Prism::ConstantPathWriteNode node) -> void
       def visit_constant_path_write_node(node)
         @last_sigs.clear
 
@@ -83,12 +94,14 @@ module Spoom
           owner: @namespace_nesting.last,
           location: node_location(node),
           value: node.value.slice,
+          comments: node_comments(node),
         )
 
         super
       end
 
-      sig { override.params(node: Prism::ConstantWriteNode).void }
+      # @override
+      #: (Prism::ConstantWriteNode node) -> void
       def visit_constant_write_node(node)
         @last_sigs.clear
 
@@ -97,12 +110,14 @@ module Spoom
           owner: @namespace_nesting.last,
           location: node_location(node),
           value: node.value.slice,
+          comments: node_comments(node),
         )
 
         super
       end
 
-      sig { override.params(node: Prism::MultiWriteNode).void }
+      # @override
+      #: (Prism::MultiWriteNode node) -> void
       def visit_multi_write_node(node)
         @last_sigs.clear
 
@@ -114,6 +129,7 @@ module Spoom
               owner: @namespace_nesting.last,
               location: node_location(const),
               value: node.value.slice,
+              comments: node_comments(const),
             )
           end
         end
@@ -123,7 +139,8 @@ module Spoom
 
       # Methods
 
-      sig { override.params(node: Prism::DefNode).void }
+      # @override
+      #: (Prism::DefNode node) -> void
       def visit_def_node(node)
         recv = node.receiver
 
@@ -134,6 +151,7 @@ module Spoom
             location: node_location(node),
             visibility: current_visibility,
             sigs: collect_sigs,
+            comments: node_comments(node),
           )
         end
 
@@ -142,7 +160,8 @@ module Spoom
 
       # Accessors
 
-      sig { override.params(node: Prism::CallNode).void }
+      # @override
+      #: (Prism::CallNode node) -> void
       def visit_call_node(node)
         return if node.receiver && !node.receiver.is_a?(Prism::SelfNode)
 
@@ -160,6 +179,7 @@ module Spoom
               location: node_location(arg),
               visibility: current_visibility,
               sigs: sigs,
+              comments: node_comments(node),
             )
           end
         when :attr_reader
@@ -173,6 +193,7 @@ module Spoom
               location: node_location(arg),
               visibility: current_visibility,
               sigs: sigs,
+              comments: node_comments(node),
             )
           end
         when :attr_writer
@@ -186,6 +207,7 @@ module Spoom
               location: node_location(arg),
               visibility: current_visibility,
               sigs: sigs,
+              comments: node_comments(node),
             )
           end
         when :include
@@ -225,22 +247,45 @@ module Spoom
 
       private
 
-      sig { returns(Visibility) }
+      #: -> Visibility
       def current_visibility
         T.must(@visibility_stack.last)
       end
 
-      sig { returns(T::Array[Sig]) }
+      #: -> Array[Sig]
       def collect_sigs
         sigs = @last_sigs
         @last_sigs = []
         sigs
       end
 
-      sig { params(node: Prism::Node).returns(Location) }
+      #: (Prism::Node node) -> Location
       def node_location(node)
         Location.from_prism(@file, node.location)
       end
+
+      #: (Prism::Node node) -> Array[Comment]
+      def node_comments(node)
+        comments = []
+
+        start_line = node.location.start_line
+        start_line -= 1 unless @comments_by_line.key?(start_line)
+
+        start_line.downto(1) do |line|
+          comment = @comments_by_line[line]
+          break unless comment
+
+          spoom_comment = Comment.new(
+            comment.slice.gsub(/^#\s?/, "").rstrip,
+            Location.from_prism(@file, comment.location),
+          )
+
+          comments.unshift(spoom_comment)
+          @comments_by_line.delete(line)
+        end
+
+        comments
+      end
     end
   end
 end