spoom 1.5.0 → 1.7.2

data/lib/spoom/coverage/report.rb

@@ -8,28 +8,27 @@ require "erb"
 module Spoom
   module Coverage
     class Template
-      extend T::Sig
       extend T::Helpers
 
       abstract!
 
       # Create a new template from an Erb file path
-      sig { params(template: String).void }
+      #: (template: String) -> void
       def initialize(template:)
         @template = template
       end
 
-      sig { returns(String) }
+      #: -> String
       def erb
         File.read(@template)
       end
 
-      sig { returns(String) }
+      #: -> String
       def html
         ERB.new(erb).result(get_binding)
       end
 
-      sig { returns(Binding) }
+      #: -> Binding
       def get_binding # rubocop:disable Naming/AccessorMethodName
         binding
       end
@@ -41,37 +40,37 @@ module Spoom
 
       abstract!
 
-      TEMPLATE = T.let("#{Spoom::SPOOM_PATH}/templates/page.erb", String)
+      TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/page.erb" #: String
 
-      sig { returns(String) }
+      #: String
       attr_reader :title
 
-      sig { returns(D3::ColorPalette) }
+      #: D3::ColorPalette
       attr_reader :palette
 
-      sig { params(title: String, palette: D3::ColorPalette, template: String).void }
+      #: (title: String, palette: D3::ColorPalette, ?template: String) -> void
       def initialize(title:, palette:, template: TEMPLATE)
         super(template: template)
         @title = title
         @palette = palette
       end
 
-      sig { returns(String) }
+      #: -> String
       def header_style
         D3.header_style
       end
 
-      sig { returns(String) }
+      #: -> String
       def header_script
         D3.header_script(palette)
       end
 
-      sig { returns(String) }
+      #: -> String
       def header_html
         "<h1 class='display-3'>#{title}</h1>"
       end
 
-      sig { returns(String) }
+      #: -> String
       def body_html
         cards.map(&:html).join("\n")
       end
@@ -79,7 +78,7 @@ module Spoom
       sig { abstract.returns(T::Array[Cards::Card]) }
       def cards; end
 
-      sig { returns(String) }
+      #: -> String
       def footer_html
         "Generated by <a href='https://github.com/Shopify/spoom'>spoom</a> on #{Time.now.utc}."
       end
@@ -89,12 +88,12 @@ module Spoom
       class Card < Template
         extend T::Sig
 
-        TEMPLATE = T.let("#{Spoom::SPOOM_PATH}/templates/card.erb", String)
+        TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card.erb" #: String
 
-        sig { returns(T.nilable(String)) }
+        #: String?
         attr_reader :title, :body
 
-        sig { params(template: String, title: T.nilable(String), body: T.nilable(String)).void }
+        #: (?template: String, ?title: String?, ?body: String?) -> void
         def initialize(template: TEMPLATE, title: nil, body: nil)
           super(template: template)
           @title = title
@@ -103,15 +102,15 @@ module Spoom
       end
 
       class Erb < Card
-        extend T::Sig
         extend T::Helpers
 
         abstract!
 
-        sig { void }
+        #: -> void
         def initialize; end # rubocop:disable Lint/MissingSuper
 
-        sig { override.returns(String) }
+        # @override
+        #: -> String
         def html
           ERB.new(erb).result(get_binding)
         end
@@ -121,46 +120,35 @@ module Spoom
       end
 
       class Snapshot < Card
-        extend T::Sig
+        TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card_snapshot.erb" #: String
 
-        TEMPLATE = T.let("#{Spoom::SPOOM_PATH}/templates/card_snapshot.erb", String)
-
-        sig { returns(Coverage::Snapshot) }
+        #: Coverage::Snapshot
         attr_reader :snapshot
 
-        sig { params(snapshot: Coverage::Snapshot, title: String).void }
+        #: (snapshot: Coverage::Snapshot, ?title: String) -> void
         def initialize(snapshot:, title: "Snapshot")
           super(template: TEMPLATE, title: title)
           @snapshot = snapshot
         end
 
-        sig { returns(D3::Pie::Sigils) }
+        #: -> D3::Pie::Sigils
         def pie_sigils
           D3::Pie::Sigils.new("pie_sigils", "Sigils", snapshot)
         end
 
-        sig { returns(D3::Pie::Calls) }
+        #: -> D3::Pie::Calls
         def pie_calls
           D3::Pie::Calls.new("pie_calls", "Calls", snapshot)
         end
 
-        sig { returns(D3::Pie::Sigs) }
+        #: -> D3::Pie::Sigs
         def pie_sigs
           D3::Pie::Sigs.new("pie_sigs", "Sigs", snapshot)
         end
       end
 
       class Map < Card
-        extend T::Sig
-
-        sig do
-          params(
-            file_tree: FileTree,
-            nodes_strictnesses: T::Hash[FileTree::Node, T.nilable(String)],
-            nodes_strictness_scores: T::Hash[FileTree::Node, Float],
-            title: String,
-          ).void
-        end
+        #: (file_tree: FileTree, nodes_strictnesses: Hash[FileTree::Node, String?], nodes_strictness_scores: Hash[FileTree::Node, Float], ?title: String) -> void
         def initialize(file_tree:, nodes_strictnesses:, nodes_strictness_scores:, title: "Strictness Map")
           super(
             title: title,
@@ -175,62 +163,48 @@ module Spoom
       end
 
       class Timeline < Card
-        extend T::Sig
-
-        sig { params(title: String, timeline: D3::Timeline).void }
+        #: (title: String, timeline: D3::Timeline) -> void
         def initialize(title:, timeline:)
           super(title: title, body: timeline.html)
         end
 
         class Sigils < Timeline
-          extend T::Sig
-
-          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          #: (snapshots: Array[Coverage::Snapshot], ?title: String) -> void
           def initialize(snapshots:, title: "Sigils Timeline")
             super(title: title, timeline: D3::Timeline::Sigils.new("timeline_sigils", snapshots))
           end
         end
 
         class Calls < Timeline
-          extend T::Sig
-
-          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          #: (snapshots: Array[Coverage::Snapshot], ?title: String) -> void
           def initialize(snapshots:, title: "Calls Timeline")
             super(title: title, timeline: D3::Timeline::Calls.new("timeline_calls", snapshots))
           end
         end
 
         class Sigs < Timeline
-          extend T::Sig
-
-          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          #: (snapshots: Array[Coverage::Snapshot], ?title: String) -> void
           def initialize(snapshots:, title: "Signatures Timeline")
             super(title: title, timeline: D3::Timeline::Sigs.new("timeline_sigs", snapshots))
           end
         end
 
         class RBIs < Timeline
-          extend T::Sig
-
-          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          #: (snapshots: Array[Coverage::Snapshot], ?title: String) -> void
           def initialize(snapshots:, title: "RBIs Timeline")
             super(title: title, timeline: D3::Timeline::RBIs.new("timeline_rbis", snapshots))
           end
         end
 
         class Versions < Timeline
-          extend T::Sig
-
-          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          #: (snapshots: Array[Coverage::Snapshot], ?title: String) -> void
           def initialize(snapshots:, title: "Sorbet Versions Timeline")
             super(title: title, timeline: D3::Timeline::Versions.new("timeline_versions", snapshots))
           end
         end
 
         class Runtimes < Timeline
-          extend T::Sig
-
-          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          #: (snapshots: Array[Coverage::Snapshot], ?title: String) -> void
           def initialize(snapshots:, title: "Sorbet Typechecking Time")
             super(title: title, timeline: D3::Timeline::Runtimes.new("timeline_runtimes", snapshots))
           end
@@ -238,15 +212,14 @@ module Spoom
       end
 
       class SorbetIntro < Erb
-        extend T::Sig
-
-        sig { params(sorbet_intro_commit: T.nilable(String), sorbet_intro_date: T.nilable(Time)).void }
+        #: (?sorbet_intro_commit: String?, ?sorbet_intro_date: Time?) -> void
         def initialize(sorbet_intro_commit: nil, sorbet_intro_date: nil) # rubocop:disable Lint/MissingSuper
           @sorbet_intro_commit = sorbet_intro_commit
           @sorbet_intro_date = sorbet_intro_date
         end
 
-        sig { override.returns(String) }
+        # @override
+        #: -> String
         def erb
           <<~ERB
             <div class="text-center" style="margin-top: 30px">
@@ -259,20 +232,7 @@ module Spoom
     end
 
     class Report < Page
-      extend T::Sig
-
-      sig do
-        params(
-          project_name: String,
-          palette: D3::ColorPalette,
-          snapshots: T::Array[Snapshot],
-          file_tree: FileTree,
-          nodes_strictnesses: T::Hash[FileTree::Node, T.nilable(String)],
-          nodes_strictness_scores: T::Hash[FileTree::Node, Float],
-          sorbet_intro_commit: T.nilable(String),
-          sorbet_intro_date: T.nilable(Time),
-        ).void
-      end
+      #: (project_name: String, palette: D3::ColorPalette, snapshots: Array[Snapshot], file_tree: FileTree, nodes_strictnesses: Hash[FileTree::Node, String?], nodes_strictness_scores: Hash[FileTree::Node, Float], ?sorbet_intro_commit: String?, ?sorbet_intro_date: Time?) -> void
       def initialize(
         project_name:,
         palette:,
@@ -293,7 +253,8 @@ module Spoom
         @sorbet_intro_date = sorbet_intro_date
       end
 
-      sig { override.returns(String) }
+      # @override
+      #: -> String
       def header_html
         last = T.must(@snapshots.last)
         <<~ERB
@@ -304,7 +265,8 @@ module Spoom
         ERB
       end
 
-      sig { override.returns(T::Array[Cards::Card]) }
+      # @override
+      #: -> Array[Cards::Card]
       def cards
         last = T.must(@snapshots.last)
         cards = []

data/lib/spoom/coverage/snapshot.rb

@@ -4,8 +4,6 @@
 module Spoom
   module Coverage
     class Snapshot < T::Struct
-      extend T::Sig
-
       prop :timestamp, Integer, default: Time.new.getutc.to_i
       prop :version_static, T.nilable(String), default: nil
       prop :version_runtime, T.nilable(String), default: nil
@@ -27,28 +25,26 @@ module Spoom
       prop :sigils_excluding_rbis, T::Hash[String, Integer], default: Hash.new(0)
 
       # The strictness name as found in the Sorbet metrics file
-      STRICTNESSES = T.let(["ignore", "false", "true", "strict", "strong", "stdlib"].freeze, T::Array[String])
+      STRICTNESSES = ["ignore", "false", "true", "strict", "strong", "stdlib"].freeze #: Array[String]
 
-      sig { params(out: T.any(IO, StringIO), colors: T::Boolean, indent_level: Integer).void }
+      #: (?out: (IO | StringIO), ?colors: bool, ?indent_level: Integer) -> void
       def print(out: $stdout, colors: true, indent_level: 0)
         printer = SnapshotPrinter.new(out: out, colors: colors, indent_level: indent_level)
         printer.print_snapshot(self)
       end
 
-      sig { params(arg: T.untyped).returns(String) }
+      #: (*untyped arg) -> String
       def to_json(*arg)
         serialize.to_json(*arg)
       end
 
       class << self
-        extend T::Sig
-
-        sig { params(json: String).returns(Snapshot) }
+        #: (String json) -> Snapshot
         def from_json(json)
           from_obj(JSON.parse(json))
         end
 
-        sig { params(obj: T::Hash[String, T.untyped]).returns(Snapshot) }
+        #: (Hash[String, untyped] obj) -> Snapshot
         def from_obj(obj)
           snapshot = Snapshot.new
           snapshot.timestamp = obj.fetch("timestamp", 0)
@@ -93,9 +89,7 @@ module Spoom
     end
 
     class SnapshotPrinter < Spoom::Printer
-      extend T::Sig
-
-      sig { params(snapshot: Snapshot).void }
+      #: (Snapshot snapshot) -> void
       def print_snapshot(snapshot)
         methods = snapshot.methods_with_sig + snapshot.methods_without_sig
         methods_excluding_rbis = snapshot.methods_with_sig_excluding_rbis + snapshot.methods_without_sig_excluding_rbis
@@ -143,7 +137,7 @@ module Spoom
 
       private
 
-      sig { params(hash: T::Hash[String, Integer], total: Integer).void }
+      #: (Hash[String, Integer] hash, Integer total) -> void
       def print_map(hash, total)
         indent
         hash.each do |key, value|
@@ -154,7 +148,7 @@ module Spoom
         dedent
       end
 
-      sig { params(value: T.nilable(Integer), total: T.nilable(Integer)).returns(String) }
+      #: (Integer? value, Integer? total) -> String
       def percent(value, total)
         return "" if value.nil? || total.nil? || total == 0
 

data/lib/spoom/coverage.rb

@@ -10,9 +10,7 @@ require "date"
 module Spoom
   module Coverage
     class << self
-      extend T::Sig
-
-      sig { params(context: Context, rbi: T::Boolean, sorbet_bin: T.nilable(String)).returns(Snapshot) }
+      #: (Context context, ?rbi: bool, ?sorbet_bin: String?) -> Snapshot
       def snapshot(context, rbi: true, sorbet_bin: nil)
         config = context.sorbet_config
         config.allowed_extensions.push(".rb", ".rbi") if config.allowed_extensions.empty?
@@ -79,7 +77,7 @@ module Spoom
         snapshot
       end
 
-      sig { params(context: Context, snapshots: T::Array[Snapshot], palette: D3::ColorPalette).returns(Report) }
+      #: (Context context, Array[Snapshot] snapshots, palette: D3::ColorPalette) -> Report
       def report(context, snapshots, palette:)
         intro_commit = context.sorbet_intro_commit
 
@@ -99,7 +97,7 @@ module Spoom
         )
       end
 
-      sig { params(context: Context).returns(FileTree) }
+      #: (Context context) -> FileTree
       def file_tree(context)
         config = context.sorbet_config
         config.ignore += ["test"]

data/lib/spoom/deadcode/definition.rb

@@ -5,8 +5,6 @@ module Spoom
   module Deadcode
     # A definition is a class, module, method, constant, etc. being defined in the code
     class Definition < T::Struct
-      extend T::Sig
-
       class Kind < T::Enum
         enums do
           AttrReader = new("attr_reader")
@@ -37,66 +35,66 @@ module Spoom
 
       # Kind
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def attr_reader?
         kind == Kind::AttrReader
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def attr_writer?
         kind == Kind::AttrWriter
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def class?
         kind == Kind::Class
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def constant?
         kind == Kind::Constant
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def method?
         kind == Kind::Method
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def module?
         kind == Kind::Module
       end
 
       # Status
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def alive?
         status == Status::ALIVE
       end
 
-      sig { void }
+      #: -> void
       def alive!
         @status = Status::ALIVE
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def dead?
         status == Status::DEAD
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def ignored?
         status == Status::IGNORED
       end
 
-      sig { void }
+      #: -> void
       def ignored!
         @status = Status::IGNORED
       end
 
       # Utils
 
-      sig { params(args: T.untyped).returns(String) }
+      #: (*untyped args) -> String
       def to_json(*args)
         {
           kind: kind,

data/lib/spoom/deadcode/erb.rb

@@ -27,9 +27,7 @@ module Spoom
   module Deadcode
     # Custom engine to handle ERB templates as used by Rails
     class ERB < ::Erubi::Engine
-      extend T::Sig
-
-      sig { params(input: T.untyped, properties: T.untyped).void }
+      #: (untyped input, ?untyped properties) -> void
       def initialize(input, properties = {})
         @newline_pending = 0
 
@@ -44,7 +42,8 @@ module Spoom
 
       private
 
-      sig { override.params(text: T.untyped).void }
+      # @override
+      #: (untyped text) -> void
       def add_text(text)
         return if text.empty?
 
@@ -62,7 +61,8 @@ module Spoom
 
       BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/
 
-      sig { override.params(indicator: T.untyped, code: T.untyped).void }
+      # @override
+      #: (untyped indicator, untyped code) -> void
       def add_expression(indicator, code)
         flush_newline_if_pending(src)
 
@@ -79,19 +79,21 @@ module Spoom
         end
       end
 
-      sig { override.params(code: T.untyped).void }
+      # @override
+      #: (untyped code) -> void
       def add_code(code)
         flush_newline_if_pending(src)
         super
       end
 
-      sig { override.params(_: T.untyped).void }
+      # @override
+      #: (untyped _) -> void
       def add_postamble(_)
         flush_newline_if_pending(src)
         super
       end
 
-      sig { params(src: T.untyped).void }
+      #: (untyped src) -> void
       def flush_newline_if_pending(src)
         if @newline_pending > 0
           src << bufvar << ".safe_append='#{"\n" * @newline_pending}'.freeze;"

data/lib/spoom/deadcode/index.rb

@@ -4,38 +4,34 @@
 module Spoom
   module Deadcode
     class Index
-      extend T::Sig
-
       class Error < Spoom::Error
-        extend T::Sig
-
-        sig { params(message: String, parent: Exception).void }
+        #: (String message, parent: Exception) -> void
         def initialize(message, parent:)
           super(message)
           set_backtrace(parent.backtrace)
         end
       end
 
-      sig { returns(Model) }
+      #: Model
       attr_reader :model
 
-      sig { returns(T::Hash[String, T::Array[Definition]]) }
+      #: Hash[String, Array[Definition]]
       attr_reader :definitions
 
-      sig { returns(T::Hash[String, T::Array[Model::Reference]]) }
+      #: Hash[String, Array[Model::Reference]]
       attr_reader :references
 
-      sig { params(model: Model).void }
+      #: (Model model) -> void
       def initialize(model)
         @model = model
-        @definitions = T.let({}, T::Hash[String, T::Array[Definition]])
-        @references = T.let({}, T::Hash[String, T::Array[Model::Reference]])
-        @ignored = T.let(Set.new, T::Set[Model::SymbolDef])
+        @definitions = {} #: Hash[String, Array[Definition]]
+        @references = {} #: Hash[String, Array[Model::Reference]]
+        @ignored = Set.new #: Set[Model::SymbolDef]
       end
 
       # Indexing
 
-      sig { params(file: String, plugins: T::Array[Plugins::Base]).void }
+      #: (String file, ?plugins: Array[Plugins::Base]) -> void
       def index_file(file, plugins: [])
         if file.end_with?(".erb")
           erb = File.read(file)
@@ -46,14 +42,14 @@ module Spoom
         end
       end
 
-      sig { params(erb: String, file: String, plugins: T::Array[Plugins::Base]).void }
+      #: (String erb, file: String, ?plugins: Array[Plugins::Base]) -> void
       def index_erb(erb, file:, plugins: [])
         index_ruby(Deadcode::ERB.new(erb).src, file: file, plugins: plugins)
       end
 
-      sig { params(rb: String, file: String, plugins: T::Array[Plugins::Base]).void }
+      #: (String rb, file: String, ?plugins: Array[Plugins::Base]) -> void
       def index_ruby(rb, file:, plugins: [])
-        node = Spoom.parse_ruby(rb, file: file)
+        node = Spoom.parse_ruby(rb, file: file, comments: true)
 
         # Index definitions
         model_builder = Model::Builder.new(@model, file)
@@ -75,27 +71,27 @@ module Spoom
         raise Error.new("Error while indexing #{file} (#{e.message})", parent: e)
       end
 
-      sig { params(definition: Definition).void }
+      #: (Definition definition) -> void
       def define(definition)
         (@definitions[definition.name] ||= []) << definition
       end
 
-      sig { params(name: String, location: Location).void }
+      #: (String name, Location location) -> void
       def reference_constant(name, location)
         (@references[name] ||= []) << Model::Reference.constant(name, location)
       end
 
-      sig { params(name: String, location: Location).void }
+      #: (String name, Location location) -> void
       def reference_method(name, location)
         (@references[name] ||= []) << Model::Reference.method(name, location)
       end
 
-      sig { params(symbol_def: Model::SymbolDef).void }
+      #: (Model::SymbolDef symbol_def) -> void
       def ignore(symbol_def)
         @ignored << symbol_def
       end
 
-      sig { params(plugins: T::Array[Plugins::Base]).void }
+      #: (Array[Plugins::Base] plugins) -> void
       def apply_plugins!(plugins)
         @model.symbols.each do |_full_name, symbol|
           symbol.definitions.each do |symbol_def|
@@ -118,7 +114,7 @@ module Spoom
       # Mark all definitions having a reference of the same name as `alive`
       #
       # To be called once all the files have been indexed and all the definitions and references discovered.
-      sig { void }
+      #: -> void
       def finalize!
         @model.symbols.each do |_full_name, symbol|
           symbol.definitions.each do |symbol_def|
@@ -210,17 +206,17 @@ module Spoom
 
       # Utils
 
-      sig { params(name: String).returns(T::Array[Definition]) }
+      #: (String name) -> Array[Definition]
       def definitions_for_name(name)
         @definitions[name] || []
       end
 
-      sig { returns(T::Array[Definition]) }
+      #: -> Array[Definition]
       def all_definitions
         @definitions.values.flatten
       end
 
-      sig { returns(T::Array[Model::Reference]) }
+      #: -> Array[Model::Reference]
       def all_references
         @references.values.flatten
       end