kensho-cucumber-ruby 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c834a2f3e16b91817b5ff5a0f3501db6a4bce89b6be298daa6c276cc1a3c29
-  data.tar.gz: 1de5746a0de6e3df020b69d13b34ec7d40c9d428afe1d4ec5e5f0ad09b9bbcd1
+  metadata.gz: 01db9e872e361ae51b6f4006652dcb87c864de8d223cb942253dd5832fc08a2c
+  data.tar.gz: ceb1feb628390738c358524d4abdc7efb99440f69eedc9c4281a8276953c08f0
 SHA512:
-  metadata.gz: 24e3668821a7b5c15a5cd615c1ff0ccc1c0a4ccdc7ef1354c15cca658a8778b4160b7ca9490cd80f591984dcfd26c4a3e005e46c85429866fcc6f559257ec47d
-  data.tar.gz: eb708f88ed8a8764587979513f8162af62ee9ecd7ed77c71f3e305d00c87d1cc2356872eb249b32e2fdc3aa2fb8440edfc86f7a2f8125883b79c42a2a90cbf69
+  metadata.gz: df8c6820ade8df4ff763beba11d068b4e0e113e446c9396fb6b6badc37579bd63b5712ac8da9675aad13a8180a4d20984fd26ca05c36004e675a1cd0931cb549
+  data.tar.gz: 113ef8ab53e5bd3bc6f6e020b8a920a6f459f3f90d49d27ef136cc8140fd61447a3b2f578761a6ed00bc7440d580ce6ad26816f97a4b6b6925be9717094bd3a5

data/lib/kensho/cucumber/formatter.rb

@@ -4,6 +4,8 @@ require 'json'
 require 'fileutils'
 require 'securerandom'
 require_relative '../_schema'
+require_relative 'state'
+require_relative 'helpers'
 
 # Cucumber 7+ formatter that emits Kensho v1 results.
 #
@@ -145,9 +147,20 @@ module Kensho
           worst_status: 'pass',
           first_error: nil,
           first_exception: nil,
-          attachments: []
+          attachments: [],
+          rt_labels: {},
+          rt_links: [],
+          rt_parameters: [],
+          rt_tags: [],
+          rt_behavior: {},
+          rt_severity: nil,
+          rt_owner: nil,
+          rt_description: nil,
+          flaky: false,
+          muted: false
         }
         @scratch[test_case.object_id] = scratch
+        Kensho::Cucumber::State.current = scratch
       end
 
       def on_test_step_finished(event)
@@ -243,8 +256,35 @@ module Kensho
 
         case_obj['attachments'] = scratch[:attachments] unless scratch[:attachments].empty?
 
+        # Runtime annotations (Kensho.* helpers) win over tag-derived values.
+        unless scratch[:rt_labels].empty?
+          case_obj['labels'] = (case_obj['labels'] || {}).merge(scratch[:rt_labels])
+        end
+        unless scratch[:rt_links].empty?
+          case_obj['links'] = (case_obj['links'] || []) + scratch[:rt_links]
+        end
+        unless scratch[:rt_parameters].empty?
+          case_obj['parameters'] = (case_obj['parameters'] || []) + scratch[:rt_parameters]
+        end
+        unless scratch[:rt_tags].empty?
+          existing = case_obj['tags'] || []
+          merged = existing.dup
+          scratch[:rt_tags].each { |t| merged << t unless merged.include?(t) }
+          case_obj['tags'] = merged
+        end
+        unless scratch[:rt_behavior].empty?
+          case_obj['behavior'] = (case_obj['behavior'] || {}).merge(scratch[:rt_behavior])
+        end
+        case_obj['severity']    = scratch[:rt_severity]    if scratch[:rt_severity]
+        case_obj['owner']       = scratch[:rt_owner]       if scratch[:rt_owner]
+        case_obj['description'] = scratch[:rt_description]  if scratch[:rt_description]
+        case_obj['flaky']       = true                     if scratch[:flaky]
+        case_obj['muted']       = true                     if scratch[:muted]
+
         @cases_by_id[case_obj['id']] = case_obj
         write_case(case_obj)
+      ensure
+        Kensho::Cucumber::State.current = nil
       end
 
       def on_test_run_finished

data/lib/kensho/cucumber/helpers.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require_relative '../_schema'
+require_relative 'state'
+
+# Public helper API usable from inside Cucumber step definitions.
+#
+#   Kensho.label('team', 'growth')
+#   Kensho.link('https://example.com/docs', 'Docs')
+#   Kensho.jira_link('PROJ-123')
+#   Kensho.epic('Checkout'); Kensho.feature('Cart'); Kensho.story('Empty cart')
+#   Kensho.severity('critical'); Kensho.owner('alice')
+#   Kensho.flaky; Kensho.muted; Kensho.known_issue('PROJ-1')
+#
+# All helpers are no-ops outside a running scenario, so they're safe to call
+# from shared support code. Runtime annotations win over tag-derived values.
+
+module Kensho
+  class << self
+    def label(key, value)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || key.nil? || key.to_s.empty?
+
+      (scratch[:rt_labels] ||= {})[key.to_s] = value.to_s
+      nil
+    end
+
+    # Add a hyperlink. Positional `name` is the human label. Kind '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 or a full URL.
+    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.
+    def severity(value)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || value.nil?
+
+      v = value.to_s
+      scratch[:rt_severity] = v if Kensho::Schema::SEVERITY.include?(v)
+      nil
+    end
+
+    # Set case.owner.
+    def owner(value)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || value.nil?
+
+      scratch[:rt_owner] = value.to_s
+      nil
+    end
+
+    # Set case.description.
+    def description(text)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || text.nil?
+
+      scratch[:rt_description] = text.to_s
+      nil
+    end
+
+    # Add a tag. Strips a leading '@' and de-dupes.
+    def tag(name)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || name.nil?
+
+      t = name.to_s.sub(/\A@/, '')
+      return if t.empty?
+
+      tags = (scratch[:rt_tags] ||= [])
+      tags << t unless tags.include?(t)
+      nil
+    end
+
+    # Add a parameter (name/value). No kind.
+    def parameter(name, value)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || name.nil? || name.to_s.empty?
+
+      (scratch[:rt_parameters] ||= []) << { 'name' => name.to_s, 'value' => value.to_s }
+      nil
+    end
+
+    # Mark the running scenario flaky.
+    def flaky
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil?
+
+      scratch[:flaky] = true
+      nil
+    end
+
+    # Mark the running scenario muted (known failure not counted by the gate).
+    def muted
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil?
+
+      scratch[:muted] = true
+      nil
+    end
+
+    # A known issue: mutes the scenario and records an 'issue' link.
+    def known_issue(id_or_url, label = nil)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil?
+
+      scratch[:muted] = true
+      jira_link(id_or_url, label)
+      nil
+    end
+
+    def current_case_id
+      scratch = Kensho::Cucumber::State.current
+      scratch && scratch[:case_obj] ? scratch[:case_obj]['id'] : nil
+    end
+
+    private
+
+    def add_link(url, kind:, label:)
+      scratch = Kensho::Cucumber::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[:rt_links] ||= []) << entry
+      nil
+    end
+
+    def apply_behavior_runtime(behavior_key, label_key, value)
+      scratch = Kensho::Cucumber::State.current
+      return if scratch.nil? || value.nil? || value.to_s.empty?
+
+      (scratch[:rt_behavior] ||= {})[behavior_key] = value.to_s
+      (scratch[:rt_labels] ||= {})[label_key] = value.to_s
+      nil
+    end
+  end
+end

data/lib/kensho/cucumber/state.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Per-scenario state pointer used by the public Kensho.* helper API.
+#
+# The formatter stores its per-scenario scratch (a plain Hash) and points
+# State.current at it on :test_case_started, clearing it on
+# :test_case_finished. While a scenario runs the Kensho.label / Kensho.link /
+# Kensho.flaky / etc. helpers mutate that Hash directly so the formatter can
+# fold the data into the case when it finalizes.
+#
+# Cucumber-Ruby runs scenarios sequentially; we still key off Thread.current
+# so step definitions running on a fixture thread (rare) don't race.
+
+module Kensho
+  module Cucumber
+    module State
+      THREAD_KEY = :__kensho_cucumber_scratch__
+
+      def self.current
+        Thread.current[THREAD_KEY]
+      end
+
+      def self.current=(scratch)
+        Thread.current[THREAD_KEY] = scratch
+      end
+    end
+  end
+end

data/lib/kensho/cucumber/version.rb

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

data/lib/kensho/cucumber.rb

@@ -7,6 +7,8 @@
 
 require_relative '_schema'
 require_relative 'cucumber/version'
+require_relative 'cucumber/state'
+require_relative 'cucumber/helpers'
 require_relative 'cucumber/formatter'
 
 module Kensho

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kensho-cucumber-ruby
 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: cucumber
@@ -38,6 +38,8 @@ files:
 - lib/kensho/_schema.rb
 - lib/kensho/cucumber.rb
 - lib/kensho/cucumber/formatter.rb
+- lib/kensho/cucumber/helpers.rb
+- lib/kensho/cucumber/state.rb
 - lib/kensho/cucumber/version.rb
 homepage: https://github.com/brandon1794/kensho
 licenses: