varar-rspec 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b961e876b1d743de61bd0e13488b95dc81b1d1a8d9fc39fba1e68ed2f6f013
-  data.tar.gz: fab933429196fa7029389fd41ab9552e09ead4138bc531813e5e8def47b5b711
+  metadata.gz: dd1931c8d54abf4bdaae28a8e8f136e3d6991b03ba6cf1a22cc49d5f658c8bfe
+  data.tar.gz: 0dd3622959aa6b187cc593223850229ab598fd0870c24f943f87e4779b8d31c8
 SHA512:
-  metadata.gz: 2ab8f0033a6a386068c7a67abbcf0f3a154e3cfd5f7f893f4afa9828ce63ed06aea7ee28e2d30431d4d42d95a0fbdade66772be93ceabb28d3979bdf29635626
-  data.tar.gz: d5158e4074826c9e8af3cf99d73d0cf1da9cb8f2ef8350e6f7a3612fb9dbd192ce8f6599cf5031969a00a35d2c6c31fd12e4fd8779b5c1d324b797c697ff8353
+  metadata.gz: cc553518b90a17dc6bd813462ccdea3bd1a4f004b1dc0cd6ec1de78c4879522eb3e6c55c73964f4cbbfed577dd8c7cedda22b12955756a9f60b2dcb3362674ef
+  data.tar.gz: 5a38ebeb4b9cfb4c78bf3ebd54327875f509ca74dc0de2926f8f1ae45daf59f98365b61d8389d8348817193c4bea8fca014e5e1ab0df91bd937fc86f13a472a5

data/lib/varar/rspec.rb

@@ -4,48 +4,102 @@ require 'rspec/core'
 require 'varar/runner'
 
 module Varar
-  # RSpec adapter. One call defines an RSpec example group per spec matched by
+  # RSpec adapter. One call defines an RSpec example group per oath matched by
   # varar.config.json, with one `it` per Markdown example (header-bound rows are
   # separate examples) and a drift gate. See ADR 0005.
   #
-  #   # spec/var_spec.rb
+  #   # spec/varar_spec.rb
   #   require "varar/rspec"
   #   Varar::RSpec.generate
   module RSpec
-    VERSION = '0.7.0'
+    VERSION = '0.8.1'
 
     module_function
 
     def generate(root: nil)
       root ||= File.dirname(caller_locations(1, 1).first.path)
       root = File.expand_path(root)
-      cfg = Config.read_var_config(root)
+      cfg = Config.read_config(root)
       loaded = Runner.load_steps(cfg.steps, root)
       store = Runner.create_file_baseline_store(root)
       update = %w[1 true].include?(ENV.fetch('VARAR_UPDATE', nil))
 
-      Runner.find_specs(cfg.docs_include, cfg.docs_exclude, root).each do |spec_path|
-        define_group(spec_path, root, loaded, store, update)
+      oaths = Runner.find_oaths(cfg.docs_include, cfg.docs_exclude, root)
+      # Run results for the language server (ADR 0014). RSpec has no per-oath
+      # completion hook here, so each group flushes its own oath in after(:all).
+      results = Runner::Results.new
+
+      # Drop baselines for oaths the config no longer discovers. Reconciliation is
+      # per-oath and never sees a path that has gone, so the lock would otherwise
+      # accumulate dead entries forever (#70). Once per run, keyed off the config
+      # globs — which here IS the full set, since generate always discovers
+      # everything.
+      Core::Drifts.prune_baselines(store, oaths.map { |p| Runner.rel_posix(p, root) }, update: update)
+
+      workspace = project_workspace(oaths, root)
+
+      oaths.each do |oath_path|
+        define_group(oath_path, root, loaded, store, update, results, workspace)
+      end
+    end
+
+    # Whether a section is a standalone example depends on whether another oath
+    # references it, which is whole-project knowledge (ADR 0016). Built from the
+    # config globs — the full set, for the same reason baseline pruning is.
+    # The sources of every oath this plan's steps were spliced in from (ADR
+    # 0016). Their hashes go in the run record, so a consumer can tell a stale
+    # failure from a live one.
+    def referenced_sources(plan, workspace)
+      plan.examples.flat_map { |ex| ex.steps.map(&:doc_path) }.compact.uniq.each_with_object({}) do |path, out|
+        doc = workspace.docs[path]
+        out[path] = doc.source if doc
       end
     end
 
-    def define_group(spec_path, root, loaded, store, update)
-      rel = Runner.rel_posix(spec_path, root)
-      source = File.read(spec_path, encoding: 'UTF-8')
-      plan = Runner.plan_spec(File.basename(spec_path), source, loaded.registry)
+    def project_workspace(oaths, root)
+      docs = oaths.filter_map do |path|
+        Core::Parse.parse(Runner.rel_posix(path, root), File.read(path, encoding: 'UTF-8'))
+      rescue SystemCallError
+        nil
+      end
+      Core::Reference.build_workspace(docs)
+    end
+
+    def define_group(oath_path, root, loaded, store, update, results, workspace)
+      rel = Runner.rel_posix(oath_path, root)
+      source = File.read(oath_path, encoding: 'UTF-8')
+      # `rel`, not the basename: doc.path is an oath's identity in every port,
+      # so a relative reference resolves alike and two same-named oaths in
+      # different directories stay distinct (ADR 0016).
+      plan = Runner.plan_oath(rel, source, loaded.registry, workspace)
+      referenced = referenced_sources(plan, workspace)
       pairs = Runner.examples_with_runs(plan, loaded.create_context, Runner::RecordingReporter.new)
-      drifts = Core::Drifts.reconcile_drift(store, rel, source, plan.var_doc, plan, update: update)
+      drifts = Core::Drifts.reconcile_drift(store, rel, source, plan.doc, plan, update: update)
 
       ::RSpec.describe(rel) do
         pairs.each do |example, run|
+          # Lines in THIS oath: a step a reference block spliced in from
+          # another oath (ADR 0016) contributes none, since its line is not in
+          # this file.
+          lines = example.steps.reject(&:doc_path).map { |s| s.match_span.start_line }.uniq
           # A var diff surfaces as a failure carrying the span-anchored render;
           # any other exception propagates. RSpec reports both as failures.
           it(example.name) do
             run.call
           rescue StandardError => e
+            # Recorded here, where the error object is still in hand: to_failure
+            # reads the anchor the executor attached to it.
+            results.record(rel, source, Core::ExampleResult.new(
+                                          name: example.name, status: 'failed', lines: lines,
+                                          failure: Core::Failures.to_failure(e, rel, lines.first || 0)
+                                        ), referenced)
             raise Runner.render_failure(e, source, rel) if RSpec.var_diff_error?(e)
 
             raise
+          else
+            results.record(rel, source, Core::ExampleResult.new(
+                                          name: example.name, status: 'passed', lines: lines, failure: nil
+                                        ), referenced)
           end
         end
 
@@ -53,6 +107,11 @@ module Varar
           message = Core::Diagnostics.drift_detected(drift.name, drift.span).message
           it("var drift at line #{drift.line}") { raise message }
         end
+
+        # This oath's examples are all in — write its results. A passing oath is
+        # written too: a stale file would keep a diagnostic on screen that this
+        # run has just cleared.
+        after(:all) { results.flush(root, rel) }
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: varar-rspec
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.1
 description: 'RSpec adapter: one selectable example per Markdown example, with a drift
   gate.'
 email:
@@ -67,5 +67,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.16
 specification_version: 4
-summary: Markdown-native BDD — run Markdown specs as RSpec examples
+summary: Markdown-native BDD — run Markdown oaths as RSpec examples
 test_files: []