executable-stories-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca5f49335f6bb83179d6c6d3710fa24fc7bc03250dfe0af5722a301e439485ff
-  data.tar.gz: 5e2fee0c6f9ab67787d7f89af3fec3a5e9074a805fbbc577884eba6fc805404a
+  metadata.gz: c19580fd13bac9c4c5921b3302f661b5bfef2d7f17545078347c11b6535011f2
+  data.tar.gz: eec88761630229d37e79df73f2c75c55b14bb37f44a16776fe852eb75134ea04
 SHA512:
-  metadata.gz: 4df5210a06292fe29466f57fb91887450249c6562b239489d90d0ff2259d5581c922782b75d9e66ac0882c9360fb61cb3e4f0ea56940fd7658967b5954a25c27
-  data.tar.gz: ca7e21e81ae8999d8b1117b5fc91706bb85ee9706ff52a6410e878b651d2052fcb32b30c1e1a473c894bd333c57a06ea35f49ca7a614acb555c6ec409595ba02
+  metadata.gz: cbe643054ac61137d863ad19906912c751e581758fc0370501a1c760f5ee9e08d3a59e0ab443f466e600b35bfbd30cd3be4e08f26c817384f9bd297d50844062
+  data.tar.gz: a25c532f7548a8907db9e454e91cf30d7a604d595a9763a0ff401ae8a17cee40ba0c0be3162f1fd187a97b4c08b6c8c7a3b972177dafbf07500cb18029336d74

data/lib/executable_stories/minitest.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require "json"
-require "fileutils"
 require "minitest"
 require_relative "story"
 require_relative "collector"
-require_relative "json_writer"
-require_relative "types"
+require_relative "output"
 
 module ExecutableStories
   module MinitestPlugin
@@ -23,47 +20,7 @@ module ExecutableStories
     end
 
     def write_results(output_path: nil)
-      cases = Collector.all
-      return if cases.empty?
-
-      output_path ||= ENV.fetch("EXECUTABLE_STORIES_OUTPUT", ".executable-stories/raw-run.json")
-
-      started = cases.map(&:start_time).compact.min
-      finished = cases.map(&:end_time).compact.max
-
-      run = RawRun.new(
-        schema_version: 1,
-        test_cases: cases,
-        project_root: Dir.pwd,
-        started_at_ms: started,
-        finished_at_ms: finished,
-        package_version: nil,
-        git_sha: nil,
-        ci: detect_ci
-      )
-
-      JsonWriter.write_raw_run(run, output_path)
-    end
-
-    def detect_ci
-      if ENV["GITHUB_ACTIONS"] == "true"
-        url = nil
-        server = ENV["GITHUB_SERVER_URL"]
-        repo = ENV["GITHUB_REPOSITORY"]
-        run_id = ENV["GITHUB_RUN_ID"]
-        url = "#{server}/#{repo}/actions/runs/#{run_id}" if server && repo && run_id
-        RawCIInfo.new(name: "github", url: url, build_number: ENV["GITHUB_RUN_NUMBER"])
-      elsif ENV["CIRCLECI"] == "true"
-        RawCIInfo.new(name: "circleci", url: ENV["CIRCLE_BUILD_URL"], build_number: ENV["CIRCLE_BUILD_NUM"])
-      elsif !ENV["JENKINS_URL"].nil?
-        RawCIInfo.new(name: "jenkins", url: ENV["BUILD_URL"], build_number: ENV["BUILD_NUMBER"])
-      elsif ENV["TRAVIS"] == "true"
-        RawCIInfo.new(name: "travis", url: ENV["TRAVIS_BUILD_WEB_URL"], build_number: ENV["TRAVIS_BUILD_NUMBER"])
-      elsif ENV["GITLAB_CI"] == "true"
-        RawCIInfo.new(name: "gitlab", url: ENV["CI_PIPELINE_URL"], build_number: ENV["CI_PIPELINE_IID"])
-      elsif ENV["CI"] == "true"
-        RawCIInfo.new(name: "ci")
-      end
+      Output.write_results(cases: Collector.all, output_path: output_path)
     end
   end
 end

data/lib/executable_stories/output.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "types"
+require_relative "json_writer"
+
+module ExecutableStories
+  module Output
+    module_function
+
+    def write_results(cases:, output_path: nil)
+      return if cases.empty?
+
+      output_path ||= ENV.fetch("EXECUTABLE_STORIES_OUTPUT", ".executable-stories/raw-run.json")
+
+      started = cases.map(&:start_time).compact.min
+      finished = cases.map(&:end_time).compact.max
+
+      run = RawRun.new(
+        schema_version: 1,
+        test_cases: cases,
+        project_root: Dir.pwd,
+        started_at_ms: started,
+        finished_at_ms: finished,
+        package_version: nil,
+        git_sha: nil,
+        ci: detect_ci
+      )
+
+      JsonWriter.write_raw_run(run, output_path)
+    end
+
+    def detect_ci
+      if ENV["GITHUB_ACTIONS"] == "true"
+        url = nil
+        server = ENV["GITHUB_SERVER_URL"]
+        repo = ENV["GITHUB_REPOSITORY"]
+        run_id = ENV["GITHUB_RUN_ID"]
+        url = "#{server}/#{repo}/actions/runs/#{run_id}" if server && repo && run_id
+        RawCIInfo.new(name: "github", url: url, build_number: ENV["GITHUB_RUN_NUMBER"])
+      elsif ENV["CIRCLECI"] == "true"
+        RawCIInfo.new(name: "circleci", url: ENV["CIRCLE_BUILD_URL"], build_number: ENV["CIRCLE_BUILD_NUM"])
+      elsif !ENV["JENKINS_URL"].nil?
+        RawCIInfo.new(name: "jenkins", url: ENV["BUILD_URL"], build_number: ENV["BUILD_NUMBER"])
+      elsif ENV["TRAVIS"] == "true"
+        RawCIInfo.new(name: "travis", url: ENV["TRAVIS_BUILD_WEB_URL"], build_number: ENV["TRAVIS_BUILD_NUMBER"])
+      elsif ENV["GITLAB_CI"] == "true"
+        RawCIInfo.new(name: "gitlab", url: ENV["CI_PIPELINE_URL"], build_number: ENV["CI_PIPELINE_IID"])
+      elsif ENV["CI"] == "true"
+        RawCIInfo.new(name: "ci")
+      end
+    end
+  end
+end

data/lib/executable_stories/rspec.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+
+require_relative "story"
+require_relative "collector"
+require_relative "output"
+
+module ExecutableStories
+  module RSpecStoryDSL
+    def story(scenario, tags: nil, ticket: nil, meta: nil, trace_url_template: nil, **example_metadata, &block)
+      it(scenario, **example_metadata, executable_stories: {
+           scenario: scenario,
+           tags: tags,
+           ticket: ticket,
+           meta: meta,
+           trace_url_template: trace_url_template
+         }) do
+        story = ExecutableStories.init(
+          scenario,
+          tags: tags,
+          ticket: ticket,
+          meta: meta,
+          trace_url_template: trace_url_template
+        )
+
+        story.meta ||= {}
+        story.meta["rspec"] = {
+          "fullDescription" => RSpec.current_example.full_description,
+          "description" => RSpec.current_example.description,
+          "filePath" => RSpec.current_example.metadata[:file_path],
+          "lineNumber" => RSpec.current_example.metadata[:line_number],
+          "scopedId" => RSpec.current_example.metadata[:scoped_id]
+        }
+
+        RSpec.current_example.metadata[:executable_stories_story] = story
+        instance_exec(story, &block) if block
+      end
+    end
+  end
+
+  class RSpecFormatter
+    RSpec::Core::Formatters.register self, :start, :example_passed, :example_failed, :example_pending, :dump_summary
+
+    def initialize(output)
+      @output = output
+      @started = false
+    end
+
+    def start(_notification)
+      return if @started
+
+      Collector.reset
+      @started = true
+    end
+
+    def example_passed(notification)
+      record(notification.example, status: "pass")
+    end
+
+    def example_failed(notification)
+      record(notification.example, status: "fail")
+    end
+
+    def example_pending(notification)
+      example = notification.example
+      status = example.metadata[:skip] ? "skip" : "pending"
+      record(example, status: status)
+    end
+
+    def dump_summary(_summary)
+      Output.write_results(cases: Collector.all)
+    end
+
+    private
+
+    def record(example, status:)
+      story = build_story(example)
+      story.record(
+        status: status,
+        title: example.description,
+        suite_path: suite_path_for(example),
+        source_file: example.metadata[:file_path],
+        source_line: example.metadata[:line_number],
+        error: error_for(example, status)
+      )
+    end
+
+    def build_story(example)
+      runtime_story = example.metadata[:executable_stories_story]
+      return runtime_story if runtime_story
+
+      definition = example.metadata[:executable_stories] || {}
+      scenario = definition[:scenario] || example.description
+      tags = normalize_tags(definition[:tags], example.metadata)
+
+      story = ExecutableStories.init(
+        scenario,
+        tags: tags.empty? ? nil : tags,
+        ticket: definition[:ticket],
+        meta: definition[:meta],
+        trace_url_template: definition[:trace_url_template]
+      )
+
+      story.meta ||= {}
+      story.meta["rspec"] = {
+        "fullDescription" => example.full_description,
+        "description" => example.description,
+        "filePath" => example.metadata[:file_path],
+        "lineNumber" => example.metadata[:line_number],
+        "scopedId" => example.metadata[:scoped_id]
+      }
+      story
+    end
+
+    def normalize_tags(explicit_tags, metadata)
+      tags = Array(explicit_tags).compact.map(&:to_s)
+      metadata.each do |key, value|
+        next unless value == true
+        next if reserved_metadata_key?(key)
+
+        tags << key.to_s
+      end
+      tags.uniq
+    end
+
+    def reserved_metadata_key?(key)
+      %i[
+        executable_stories
+        executable_stories_story
+        description
+        description_args
+        block
+        full_description
+        file_path
+        line_number
+        location
+        absolute_file_path
+        rerun_file_path
+        rerun_line_numbers
+        scoped_id
+        execution_result
+        aggregate_failures
+        skip
+      ].include?(key)
+    end
+
+    def suite_path_for(example)
+      example.example_group.parent_groups
+             .reverse
+             .reject { |group| group == RSpec::Core::ExampleGroup }
+             .map(&:description)
+             .reject { |description| description.nil? || description.empty? }
+    end
+
+    def error_for(example, status)
+      return nil unless status == "fail"
+
+      exception = example.exception
+      return nil unless exception
+
+      ExecutableStories::RawError.new(
+        message: exception.message,
+        stack: Array(exception.backtrace).join("\n")
+      )
+    end
+  end
+
+  module RSpecPlugin
+    module_function
+
+    def install!
+      return if @installed
+
+      RSpec.configure do |config|
+        config.extend ExecutableStories::RSpecStoryDSL
+        config.add_formatter ExecutableStories::RSpecFormatter
+      end
+
+      @installed = true
+    end
+  end
+end

data/lib/executable_stories/story.rb

@@ -11,7 +11,7 @@ module ExecutableStories
     attr_accessor :scenario, :steps, :tags, :tickets, :meta, :docs,
                   :current_step, :seen_primary, :start_time, :end_time,
                   :source_order, :step_counter, :attachments, :active_timers,
-                  :timer_counter, :otel_spans, :trace_url_template
+                  :timer_counter, :otel_spans, :trace_url_template, :suite_path
 
     def initialize(scenario, tags: nil, ticket: nil, meta: nil, trace_url_template: nil)
       @scenario = scenario
@@ -30,6 +30,7 @@ module ExecutableStories
       @timer_counter = 0
       @otel_spans = nil
       @trace_url_template = trace_url_template
+      @suite_path = nil
 
       bridge_otel
     end
@@ -260,14 +261,16 @@ module ExecutableStories
         tags: @tags,
         tickets: @tickets,
         meta: @meta,
+        suite_path: @suite_path,
         docs: @docs.empty? ? nil : @docs,
         source_order: @source_order,
         otel_spans: @otel_spans
       )
     end
 
-    def record(status:, title: nil, suite_path: nil, source_file: nil, duration_ms: nil, error: nil)
+    def record(status:, title: nil, suite_path: nil, source_file: nil, source_line: nil, duration_ms: nil, error: nil)
       @end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1000.0
+      @suite_path = suite_path if suite_path
       duration = duration_ms || (@end_time - @start_time)
 
       step_events = @steps.each_with_index.map do |s, i|
@@ -280,6 +283,7 @@ module ExecutableStories
         title_path: suite_path ? suite_path + [@scenario] : [@scenario],
         story: get_meta,
         source_file: source_file,
+        source_line: source_line,
         duration_ms: duration,
         error: error,
         retry: 0,

data/lib/executable_stories.rb

@@ -5,6 +5,7 @@ require_relative "executable_stories/doc_entry"
 require_relative "executable_stories/types"
 require_relative "executable_stories/collector"
 require_relative "executable_stories/json_writer"
+require_relative "executable_stories/output"
 
 module ExecutableStories
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: executable-stories-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jag Reehal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-11 00:00:00.000000000 Z
+date: 2026-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,8 @@ files:
 - lib/executable_stories/doc_entry.rb
 - lib/executable_stories/json_writer.rb
 - lib/executable_stories/minitest.rb
+- lib/executable_stories/output.rb
+- lib/executable_stories/rspec.rb
 - lib/executable_stories/story.rb
 - lib/executable_stories/types.rb
 homepage: https://github.com/jagreehal/executable-stories
@@ -92,5 +108,6 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Ruby-first story/given/when/then helpers for Minitest with doc generation.
+summary: Ruby-first story/given/when/then helpers for Minitest and RSpec with doc
+  generation.
 test_files: []