spoom 1.5.4 → 1.6.1

data/lib/spoom/coverage/d3/timeline.rb

@@ -7,21 +7,18 @@ module Spoom
   module Coverage
     module D3
       class Timeline < Base
-        extend T::Sig
         extend T::Helpers
 
         abstract!
 
-        sig { params(id: String, data: T.untyped, keys: T::Array[String]).void }
+        #: (String id, untyped data, Array[String] keys) -> void
         def initialize(id, data, keys)
           super(id, data)
           @keys = keys
         end
 
         class << self
-          extend T::Sig
-
-          sig { returns(String) }
+          #: -> String
           def header_style
             <<~CSS
               .domain {
@@ -75,7 +72,7 @@ module Spoom
             CSS
           end
 
-          sig { returns(String) }
+          #: -> String
           def header_script
             <<~JS
               var parseVersion = function(version) {
@@ -97,7 +94,8 @@ module Spoom
           end
         end
 
-        sig { override.returns(String) }
+        # @override
+        #: -> String
         def script
           <<~HTML
             #{tooltip}
@@ -125,7 +123,7 @@ module Spoom
         sig { abstract.returns(String) }
         def plot; end
 
-        sig { returns(String) }
+        #: -> String
         def x_scale
           <<~HTML
             var xScale_#{id} = d3.scaleTime()
@@ -141,7 +139,7 @@ module Spoom
           HTML
         end
 
-        sig { returns(String) }
+        #: -> String
         def x_ticks
           <<~HTML
             svg_#{id}.append("g")
@@ -154,7 +152,7 @@ module Spoom
           HTML
         end
 
-        sig { params(min: String, max: String, ticks: String).returns(String) }
+        #: (min: String, max: String, ticks: String) -> String
         def y_scale(min:, max:, ticks:)
           <<~HTML
             var yScale_#{id} = d3.scaleLinear()
@@ -170,7 +168,7 @@ module Spoom
           HTML
         end
 
-        sig { params(ticks: String, format: String, padding: Integer).returns(String) }
+        #: (ticks: String, format: String, padding: Integer) -> String
         def y_ticks(ticks:, format:, padding:)
           <<~HTML
             svg_#{id}.append("g")
@@ -183,7 +181,7 @@ module Spoom
           HTML
         end
 
-        sig { params(y: String, color: String, curve: String).returns(String) }
+        #: (y: String, ?color: String, ?curve: String) -> String
         def area(y:, color: "#ccc", curve: "curveCatmullRom.alpha(1)")
           <<~HTML
             svg_#{id}.append("path")
@@ -199,7 +197,7 @@ module Spoom
           HTML
         end
 
-        sig { params(y: String, color: String, curve: String).returns(String) }
+        #: (y: String, ?color: String, ?curve: String) -> String
         def line(y:, color: "#ccc", curve: "curveCatmullRom.alpha(1)")
           <<~HTML
             svg_#{id}.append("path")
@@ -213,7 +211,7 @@ module Spoom
           HTML
         end
 
-        sig { params(y: String).returns(String) }
+        #: (y: String) -> String
         def points(y:)
           <<~HTML
             svg_#{id}.selectAll("circle")
@@ -230,9 +228,7 @@ module Spoom
         end
 
         class Versions < Timeline
-          extend T::Sig
-
-          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          #: (String id, Array[Snapshot] snapshots) -> void
           def initialize(id, snapshots)
             data = snapshots.map do |snapshot|
               {
@@ -245,7 +241,8 @@ module Spoom
             super(id, data, [])
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -259,7 +256,8 @@ module Spoom
             JS
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def plot
             <<~JS
               #{x_scale}
@@ -280,9 +278,7 @@ module Spoom
         end
 
         class Runtimes < Timeline
-          extend T::Sig
-
-          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          #: (String id, Array[Snapshot] snapshots) -> void
           def initialize(id, snapshots)
             data = snapshots.map do |snapshot|
               {
@@ -294,7 +290,8 @@ module Spoom
             super(id, data, [])
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -307,7 +304,8 @@ module Spoom
             JS
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def plot
             <<~JS
               #{x_scale}
@@ -327,12 +325,12 @@ module Spoom
         end
 
         class Stacked < Timeline
-          extend T::Sig
           extend T::Helpers
 
           abstract!
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def script
             <<~JS
               #{tooltip}
@@ -373,7 +371,8 @@ module Spoom
             JS
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def plot
             <<~JS
               #{x_scale}
@@ -384,7 +383,8 @@ module Spoom
             JS
           end
 
-          sig { override.params(y: String, color: String, curve: String).returns(String) }
+          # @override
+          #: (y: String, ?color: String, ?curve: String) -> String
           def line(y:, color: "strictnessColor(d.key)", curve: "curveCatmullRom.alpha(1)")
             <<~JS
               var area_#{id} = d3.area()
@@ -419,9 +419,7 @@ module Spoom
         end
 
         class Sigils < Stacked
-          extend T::Sig
-
-          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          #: (String id, Array[Snapshot] snapshots) -> void
           def initialize(id, snapshots)
             keys = Snapshot::STRICTNESSES
             data = snapshots.map do |snapshot|
@@ -435,7 +433,8 @@ module Spoom
             super(id, data, keys)
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -446,9 +445,7 @@ module Spoom
         end
 
         class Calls < Stacked
-          extend T::Sig
-
-          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          #: (String id, Array[Snapshot] snapshots) -> void
           def initialize(id, snapshots)
             keys = ["false", "true"]
             data = snapshots.map do |snapshot|
@@ -462,7 +459,8 @@ module Spoom
             super(id, data, keys)
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -473,9 +471,7 @@ module Spoom
         end
 
         class Sigs < Stacked
-          extend T::Sig
-
-          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          #: (String id, Array[Snapshot] snapshots) -> void
           def initialize(id, snapshots)
             keys = ["false", "true"]
             data = snapshots.map do |snapshot|
@@ -492,7 +488,8 @@ module Spoom
             super(id, data, keys)
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -503,9 +500,7 @@ module Spoom
         end
 
         class RBIs < Stacked
-          extend T::Sig
-
-          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          #: (String id, Array[Snapshot] snapshots) -> void
           def initialize(id, snapshots)
             keys = ["rbis", "files"]
             data = snapshots.map do |snapshot|
@@ -519,7 +514,8 @@ module Spoom
             super(id, data, keys)
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -533,7 +529,8 @@ module Spoom
             JS
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def script
             <<~JS
               #{tooltip}
@@ -573,7 +570,8 @@ module Spoom
             JS
           end
 
-          sig { override.params(y: String, color: String, curve: String).returns(String) }
+          # @override
+          #: (y: String, ?color: String, ?curve: String) -> String
           def line(y:, color: "strictnessColor(d.key)", curve: "curveCatmullRom.alpha(1)")
             <<~JS
               var area_#{id} = d3.area()
@@ -613,7 +611,8 @@ module Spoom
             JS
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def plot
             <<~JS
               #{x_scale}

data/lib/spoom/coverage/d3.rb

@@ -15,9 +15,7 @@ module Spoom
       COLOR_STRONG = "#064828"
 
       class << self
-        extend T::Sig
-
-        sig { returns(String) }
+        #: -> String
         def header_style
           <<~CSS
             svg {
@@ -57,7 +55,7 @@ module Spoom
           CSS
         end
 
-        sig { params(palette: ColorPalette).returns(String) }
+        #: (ColorPalette palette) -> String
         def header_script(palette)
           <<~JS
             var parseDate = d3.timeParse("%s");

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
@@ -43,35 +42,35 @@ module Spoom
 
       TEMPLATE = T.let("#{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
@@ -91,10 +90,10 @@ module Spoom
 
         TEMPLATE = T.let("#{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 = 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
@@ -29,26 +27,24 @@ module Spoom
       # The strictness name as found in the Sorbet metrics file
       STRICTNESSES = T.let(["ignore", "false", "true", "strict", "strong", "stdlib"].freeze, T::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