duel 0.1.0 → 0.1.1

data/sig/duel/init.rbs

@@ -63,9 +63,15 @@ module Duel
 
     def render: (String name) -> String
 
+    # The project's configuration, as the conventions have it.
+    def config: () -> Config
+
     # The library the gemspec names, or nil.
     def library: () -> String?
 
+    # The glob release tags match, for the workflow.
+    def release_tags: () -> String
+
     # The library, without a gemspec: lib/'s only Ruby file, or nil.
     def guess: () -> String?
 

data/sig/duel/json_report.rbs

@@ -15,16 +15,18 @@ module Duel
     @results: Array[Result]
     @settings: Settings
     @exit: Integer
+    @comment: String
     @versions: Hash[String, Hash[String, String | bool | nil]]
 
-    # A run that didn't compare: +status+, its +exit+ status, and what it
-    # said.
-    def self.note: (String status, Integer exit, String message, Settings settings) -> report
+    # A run that didn't compare: +status+, its +exit+ status, what it
+    # said, and what the workflow does about its comment.
+    def self.note: (String status, Integer exit, String message, Settings settings, String comment) -> report
 
     # What every report starts with.
-    def self.head: (String status, Integer exit, String? message, Settings settings) -> report
+    def self.head: (String status, Integer exit, String? message, Settings settings, String comment) -> report
 
-    def initialize: (Runner runner, Array[Result] results, settings: Settings, exit: Integer, baseline: Hash[String, String?],
+    def initialize: (Runner runner, Array[Result] results, settings: Settings, exit: Integer, comment: String,
+                     baseline: Hash[String, String?],
                      candidate: Hash[String, String | bool | nil]) -> void
 
     def to_h: () -> report

data/sig/duel/runner.rbs

@@ -18,7 +18,7 @@ module Duel
 
   # How a run is set up (see Duel::CLI for where each comes from).
   # @api private
-  class Settings < Struct[String | Regexp | Integer | Float | bool | Config::ruby | nil]
+  class Settings < Struct[String | Regexp | Integer | Float | bool | Config::ruby | Config::comment | nil]
     attr_accessor base: String?
     attr_accessor base_dir: String?
     attr_accessor candidate_dir: String?
@@ -33,13 +33,16 @@ module Duel
     attr_accessor timeout: Float
     # Each version's Ruby (--ruby), over Config#ruby.
     attr_accessor ruby: Config::ruby
+    # When the workflow comments on a pull request (--comment), over
+    # Config#comment.
+    attr_accessor comment: Config::comment?
 
     def self.new: (?String? base, ?String? base_dir, ?String? candidate_dir, ?Regexp filter, ?Integer jobs,
                    ?Integer processes, ?Float limit, ?Float confidence, ?Float? warm, ?bool force, ?String? config_path,
-                   ?Float timeout, ?Config::ruby ruby) -> instance
+                   ?Float timeout, ?Config::ruby ruby, ?Config::comment? comment) -> instance
                 | (?base: String?, ?base_dir: String?, ?candidate_dir: String?, ?filter: Regexp, ?jobs: Integer,
                    ?processes: Integer, ?limit: Float, ?confidence: Float, ?warm: Float?, ?force: bool,
-                   ?config_path: String?, ?timeout: Float, ?ruby: Config::ruby) -> instance
+                   ?config_path: String?, ?timeout: Float, ?ruby: Config::ruby, ?comment: Config::comment?) -> instance
 
     def self.defaults: () -> Settings
   end

data/sig/duel/summary.rbs

@@ -14,17 +14,33 @@ module Duel
     # The verdicts that fail a run.
     FAILED: Array[String]
 
+    # What the heading starts with.
+    PASSED_MARK: String
+    FAILED_MARK: String
+    NEUTRAL_MARK: String
+
+    # What an unsettled timing means.
+    UNSETTLED: String
+
+    # How Duel decides that a timing is slower, in its docs.
+    DECIDES: String
+
     @runner: Runner
     @results: Array[Result]
     @settings: Settings
-    @versions: Hash[String, String]
+    @baseline: String
+    @candidate: String
     @regressed: Array[Result]
+    @failed: Array[Result]
 
     # +text+ as code, in Markdown.
     def self.code: (String text) -> String
 
-    # A run that didn't compare, with what it said.
-    def self.note: (String title, String message) -> String
+    # +text+ as it is, in Markdown.
+    def self.escape: (String text) -> String
+
+    # A run that didn't compare, and why.
+    def self.note: (String mark, String title, String reason) -> String
 
     # +text+ in a fenced block of its own.
     def self.block: (String text) -> String
@@ -45,26 +61,35 @@ module Duel
     # The Markdown, with the first +explained+ regressions explained.
     def render: (Integer explained) -> String
 
+    # The verdict.
     def heading: () -> String
 
-    # Each version, on its Ruby where theirs differ.
-    def versions: () -> String
+    # The two versions, and why any benchmark was skipped.
+    def compared: () -> String
+
+    # The benchmarks that failed.
+    def failures: () -> String?
 
-    def overview: () -> String
+    # What got worse, or the error's first line.
+    def failure: (Result result) -> String
+
+    # The frame whose own share of the CPU grew the most.
+    def top: (Result result) -> String
+
+    # The rest, collapsed.
+    def details: (Integer explained) -> String
 
     # The results, by verdict.
     def sorted: () -> Array[Result]
 
-    def table: (Array[Result] changed) -> String?
-
-    # Those that didn't change, collapsed.
-    def unchanged: (Array[Result] same) -> String?
+    # Every benchmark.
+    def table: () -> String?
 
     # A table's row of +cells+.
-    def row: (*String cells) -> String
+    def row: (Array[String] cells) -> String
 
-    # A benchmark's name, for a table's cell.
-    def name: (Result result) -> String
+    # +text+ for a table's cell, on one line.
+    def cell: (String text) -> String
 
     # Each timed measure's ratio and its interval.
     def timings: (Result result) -> String
@@ -75,13 +100,18 @@ module Duel
     def mb: (Integer bytes) -> String
 
     # The first +explained+ regressions, explained.
-    def regressions: (Integer explained) -> String?
+    def regressions: (Integer explained) -> Array[String]
 
     # The verdicts across the board.
-    def across: () -> String?
+    def across: (confirmed: bool) -> String?
+
+    # The errors of more than a line.
+    def errors: () -> Array[String]
 
-    def unsettled: () -> String?
+    # Each version's Ruby, where they differ.
+    def rubies: () -> String?
 
-    def errors: () -> String?
+    # How Duel decides that a timing is slower.
+    def decides: () -> String
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Erik Berlin