kensho-rspec 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97dc4db016aa21aa420a9b63740cabe981c268aae5327934f4ee2e3df61d7ab
-  data.tar.gz: 9a93a8174851bc749cb9a645ad50a981cb649773ca4e88735fd83f1b63e6e995
+  metadata.gz: dc8ed4404cde5d65a57ddb790ff3b68319a83330d58ae0d515e056da5870440f
+  data.tar.gz: 6edce31e3dbf35cea860c234a3e750d0abf6db0113fa90e9eab4cfdcca08e8e9
 SHA512:
-  metadata.gz: 0143d4de5952dcaefa21537e0a7a99b473c67eacff4fd8d77490dbb4e8becbab56039df5461bd4b62cdfb4a6bc5f6b157cb450e5b763eb268e483acbb9e783be
-  data.tar.gz: 9af59332e7f1687b4368bd28d6873dc5dbbe3e3d41e5da2823ef548732f8ed0edfc8a0c5b33ea8ffae72f159158e9d952286b783d587b69aae659c82268092b3
+  metadata.gz: 1ddb9d7d37d26699ed24366ebdc8756c6349872888183c0c2831f7afe17baacbb0ae9c38be9c7ada015be6de97e4eee433722bb18bee8b6f6edb7966ff3c9b1e
+  data.tar.gz: 36e0e59ff362f2e29a0720b3a8eb6f8c9af8e0bc4fa1b8ef73e3dac9cb44d50b0c87caf6c6372f190fe5132c721550d43bf3c02dd3233cc23eebc61b1dbf2004

data/lib/kensho/rspec/formatter.rb

@@ -330,6 +330,27 @@ module Kensho
           case_obj['links'] = existing + scratch.links
         end
 
+        # Runtime annotations win over metadata-derived values.
+        unless scratch.behavior.empty?
+          existing = case_obj['behavior'] || {}
+          case_obj['behavior'] = existing.merge(scratch.behavior)
+        end
+        unless scratch.parameters.empty?
+          existing = case_obj['parameters'] || []
+          case_obj['parameters'] = existing + scratch.parameters
+        end
+        unless scratch.tags.empty?
+          existing = case_obj['tags'] || []
+          merged = existing.dup
+          scratch.tags.each { |t| merged << t unless merged.include?(t) }
+          case_obj['tags'] = merged
+        end
+        case_obj['severity']    = scratch.severity    if scratch.severity
+        case_obj['owner']       = scratch.owner       if scratch.owner
+        case_obj['description'] = scratch.description  if scratch.description
+        case_obj['flaky']       = true                if scratch.flaky
+        case_obj['muted']       = true                if scratch.muted
+
         # Stdout/stderr captured by RSpec is wired up by an around-each
         # hook (see Kensho::RSpec::Formatter.install_capture_hook) — see
         # below.

data/lib/kensho/rspec/helpers.rb

@@ -92,14 +92,114 @@ module Kensho
       nil
     end
 
-    def link(url, kind: nil, label: nil)
+    # Add a hyperlink to the running case. Positional `name` is the human
+    # label (legacy `label:`/`kind:` keywords still work). Default kind is
+    # 'link'.
+    def link(url, name = nil, kind: nil, label: nil)
+      add_link(url, kind: kind || 'link', label: name || label)
+    end
+
+    # A Jira/issue link. `id_or_url` may be a bare ticket id ('PROJ-1') or a
+    # full URL. Kind 'issue'.
+    def jira_link(id_or_url, label = nil)
+      add_link(id_or_url, kind: 'issue', label: label || id_or_url)
+    end
+
+    # A reference/documentation link. Kind 'reference'.
+    def reference_link(url, label = nil)
+      add_link(url, kind: 'reference', label: label)
+    end
+
+    # behavior.epic + labels.epic
+    def epic(name)
+      apply_behavior_runtime('epic', 'epic', name)
+    end
+
+    # behavior.feature + labels.feature
+    def feature(name)
+      apply_behavior_runtime('feature', 'feature', name)
+    end
+
+    # behavior.scenario + labels.story
+    def story(name)
+      apply_behavior_runtime('scenario', 'story', name)
+    end
+
+    # Set case.severity. Only the five canonical names are accepted; anything
+    # else is ignored.
+    def severity(value)
       scratch = Kensho::RSpec::State.current
-      return if scratch.nil? || url.nil? || url.to_s.empty?
+      return if scratch.nil? || value.nil?
 
-      entry = { 'url' => url.to_s }
-      entry['kind']  = kind.to_s  if kind
-      entry['label'] = label.to_s if label
-      scratch.links << entry
+      v = value.to_s
+      scratch.severity = v if Kensho::Schema::SEVERITY.include?(v)
+      nil
+    end
+
+    # Set case.owner.
+    def owner(value)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil? || value.nil?
+
+      scratch.owner = value.to_s
+      nil
+    end
+
+    # Set case.description.
+    def description(text)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil? || text.nil?
+
+      scratch.description = text.to_s
+      nil
+    end
+
+    # Add a tag to the running case. Strips a leading '@' and de-dupes.
+    def tag(name)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil? || name.nil?
+
+      t = name.to_s.sub(/\A@/, '')
+      return if t.empty?
+
+      scratch.tags << t unless scratch.tags.include?(t)
+      nil
+    end
+
+    # Add a parameter (name/value) to the running case. No kind.
+    def parameter(name, value)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil? || name.nil? || name.to_s.empty?
+
+      scratch.parameters << { 'name' => name.to_s, 'value' => value.to_s }
+      nil
+    end
+
+    # Mark the running case as flaky.
+    def flaky
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil?
+
+      scratch.flaky = true
+      nil
+    end
+
+    # Mark the running case as muted (known failure not counted by the gate).
+    def muted
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil?
+
+      scratch.muted = true
+      nil
+    end
+
+    # A known issue: mutes the case and records an 'issue' link.
+    def known_issue(id_or_url, label = nil)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil?
+
+      scratch.muted = true
+      jira_link(id_or_url, label)
       nil
     end
 
@@ -110,6 +210,26 @@ module Kensho
 
     private
 
+    def add_link(url, kind:, label:)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil? || url.nil? || url.to_s.empty?
+
+      entry = { 'url' => url.to_s }
+      entry['kind']  = kind.to_s  if kind && !kind.to_s.empty?
+      entry['label'] = label.to_s if label && !label.to_s.empty?
+      scratch.links << entry
+      nil
+    end
+
+    def apply_behavior_runtime(behavior_key, label_key, value)
+      scratch = Kensho::RSpec::State.current
+      return if scratch.nil? || value.nil? || value.to_s.empty?
+
+      scratch.behavior[behavior_key] = value.to_s
+      scratch.labels[label_key] = value.to_s
+      nil
+    end
+
     def monotonic_now
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
@@ -144,13 +264,6 @@ module Kensho
     group.metadata[key] = value.to_s
     nil
   end
-
-  # Lowercase aliases for callers who'd rather not use uppercase methods.
-  class << self
-    alias_method :feature, :Feature
-    alias_method :epic,    :Epic
-    alias_method :story,   :Story
-  end
 end
 
 # Hook into RSpec's example-group definition so we can track the

data/lib/kensho/rspec/state.rb

@@ -15,7 +15,9 @@ module Kensho
   module RSpec
     class CaseScratch
       attr_accessor :case_id, :example_id, :started_at_ms,
-                    :steps, :step_stack, :attachments, :logs, :labels, :links
+                    :steps, :step_stack, :attachments, :logs, :labels, :links,
+                    :parameters, :tags, :behavior, :severity, :owner,
+                    :description, :flaky, :muted
 
       def initialize(case_id:, example_id:, started_at_ms:)
         @case_id = case_id
@@ -27,6 +29,14 @@ module Kensho
         @logs = []
         @labels = {}
         @links = []
+        @parameters = []
+        @tags = []
+        @behavior = {}
+        @severity = nil
+        @owner = nil
+        @description = nil
+        @flaky = false
+        @muted = false
       end
     end
 

data/lib/kensho/rspec/version.rb

@@ -2,6 +2,6 @@
 
 module Kensho
   module RSpec
-    VERSION = '0.1.1'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kensho-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - KaizenReport
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-07 00:00:00.000000000 Z
+date: 2026-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core