varar-runner 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ae12821737b62647a5de4a1110d369489c88609a2ccb7fa7415b37aa1ad8af2
-  data.tar.gz: 8756dbd8aaa0524aa5951e36f0702eda6fdd5968383ec33d82b579df60dfa10e
+  metadata.gz: 46298c6e8b7301ae6a5853dec7ffd596f5a6d9025536eb8932af54bac545944d
+  data.tar.gz: 67beb4b0519aece1442ab3ec0972eb6a5f41d6f5a68b72db022732f795a084bf
 SHA512:
-  metadata.gz: f935803abd5a035507875613e97491b981f06c65ee8b8e8d46720b9d1e85f80ddfb1bb54406e9d6efb880f7d0d8e8b2adcceef9b8269173de6919de2408b1196
-  data.tar.gz: cb62488852e40a160950a716ca3690a3e874443f8678fbd6c7c312e8558343ef01078910662c062ed29245e2a3363c27f2509fa2c976cce05d9441be6b8e4946
+  metadata.gz: f5c0baf64a0643451fd6b0f70e482818086d609e8ff9168c5e9654e061ac7452d55a576301da196a5b6654731e19d47c953ff25c388f34267eb642d90f2afef6
+  data.tar.gz: e701f85184c8738acd5dda28eda4a9b37db06c667c5e839224bc292c556bb9ef173095899fbe395e393f3691a9325e663411c69f971a1170c005832ba4bf0e42

data/lib/varar/runner/cli.rb

@@ -6,27 +6,35 @@ module Varar
   module Runner
     # The `var` command-line entry point (exposed by the `exe/var`
     # executable). Today it offers a single sub-command, `varar init`, which
-    # scaffolds a new project: a `varar.config.json`, one Markdown spec, its
-    # step definitions, and a framework bridge that turns the specs into
+    # scaffolds a new project: a `varar.config.json`, one Markdown oath, its
+    # step definitions, and a framework bridge that turns the oaths into
     # RSpec examples or Minitest tests.
     #
-    # The config, spec and steps mirror the TypeScript CLI (`@varar/cli`)
+    # The config, oath and steps mirror the TypeScript CLI (`@varar/cli`)
     # so a project started with `varar init` looks the same in every language;
     # only the bridge is Ruby-specific, because RSpec/Minitest — unlike
-    # pytest — need an explicit generator call to discover the specs.
+    # pytest — need an explicit generator call to discover the oaths.
     module CLI
-      CONFIG = <<~JSON
-        {
-          "docs": { "include": ["varar-examples/**/*.md"], "exclude": [] },
-          "steps": ["varar-examples/**/*.steps.rb"]
-        }
-      JSON
+      # The steps live under the framework's conventional root (spec/ for
+      # RSpec, test/ for Minitest), so the config depends on the framework.
+      def self.config_for(framework)
+        root = framework == :minitest ? 'test' : 'spec'
+        <<~JSON
+          {
+            "docs": { "include": ["varar/**/*.md"], "exclude": [] },
+            "steps": ["#{root}/varar/**/*.steps.rb"]
+          }
+        JSON
+      end
 
       EXAMPLE_MD = <<~MARKDOWN
-        # Hello, BDD
+        # Deep Thought
+
+        You're really not going to like it.
+
+        The answer to the great question of life, the universe and everything is 42.
 
-        Given I greet "world"
-        Then the greeting is "Hello, world!"
+        It was a tough assignment.
       MARKDOWN
 
       EXAMPLE_STEPS = <<~RUBY
@@ -34,16 +42,15 @@ module Varar
 
         require 'varar'
 
-        steps(-> { { greeting: '' } }) do
-          stimulus('I greet {string}') { |_state, name| { greeting: "Hello, \#{name}!" } }
-          sensor('the greeting is {string}') { |state, _expected| state[:greeting] }
+        steps do
+          sensor('life, the universe and everything is {int}') { 42 }
         end
       RUBY
 
       RSPEC_BRIDGE = <<~RUBY
         # frozen_string_literal: true
 
-        # Turn every Markdown spec matched by varar.config.json into RSpec examples —
+        # Turn every Markdown oath matched by varar.config.json into RSpec examples —
         # one `it` per Markdown example, discovered when this file loads.
         require 'varar/rspec'
 
@@ -57,13 +64,13 @@ module Varar
         require 'minitest/autorun'
         require 'varar/minitest'
 
-        # Turn every Markdown spec matched by varar.config.json into Minitest tests —
+        # Turn every Markdown oath matched by varar.config.json into Minitest tests —
         # varar.config.json lives at the project root (the parent of test/).
         Varar::Minitest.generate_tests(Object, root: File.expand_path('..', __dir__))
       RUBY
 
       USAGE = <<~TEXT
-        varar — scaffold and run Markdown specs
+        varar — scaffold and run Markdown oaths
 
         Usage:
           varar init               scaffold a new project
@@ -83,15 +90,16 @@ module Varar
       # The framework bridge matches whichever adapter gem is installed
       # (RSpec by default).
       def self.run_init(cwd, out, framework: detect_framework)
+        root = framework == :minitest ? 'test' : 'spec'
         files = [
-          ['varar.config.json', CONFIG],
-          ['varar-examples/01-hello.md', EXAMPLE_MD],
-          ['varar-examples/steps/01-hello.steps.rb', EXAMPLE_STEPS]
+          ['varar.config.json', config_for(framework)],
+          ['varar/deep-thought.md', EXAMPLE_MD],
+          ["#{root}/varar/deep_thought.steps.rb", EXAMPLE_STEPS]
         ]
         files << if framework == :minitest
-                   ['test/var_test.rb', MINITEST_BRIDGE]
+                   ['test/varar_test.rb', MINITEST_BRIDGE]
                  else
-                   ['spec/var_spec.rb', RSPEC_BRIDGE]
+                   ['spec/varar_spec.rb', RSPEC_BRIDGE]
                  end
 
         files.each do |rel, content|

data/lib/varar/runner/discovery.rb

@@ -53,13 +53,13 @@ module Varar
     end
 
     # True iff +path+ matches an include glob and no exclude glob.
-    def match_spec?(path, include, exclude, root)
+    def match_oath?(path, include, exclude, root)
       rel = rel_posix(path, root)
       matches_any?(rel, include) && !matches_any?(rel, exclude)
     end
 
     # Existing files under +root+ matching any include glob, minus excludes; sorted.
-    def find_specs(include, exclude, root)
+    def find_oaths(include, exclude, root)
       out = []
       include.each do |g|
         out.concat(Dir.glob(g, base: root).map { |rel| File.join(root, rel) })

data/lib/varar/runner/results.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require 'varar/core'
+
+module Varar
+  module Runner
+    # Persists run results for the language server (ADR 0014) — the shell half of
+    # the contract the core builds the payload for. Writes
+    # `<root>/.varar/<oath_path>.json`, which the (language-neutral) LSP reads to
+    # turn a failure into an editor diagnostic.
+    #
+    # Lives in the runner so both adapters — RSpec and Minitest — feed the same
+    # collector and cannot drift from each other, or from the TypeScript
+    # reporter this is a port of.
+    class Results
+      def initialize
+        @sources = {}
+        @examples = {}
+      end
+
+      # `<root>/.varar/<oath_path>.json` — the file the LSP watches.
+      def self.result_file_path(root, oath_path)
+        File.join(root, '.varar', "#{oath_path}.json")
+      end
+
+      # Writes one oath's results: 2-space indent plus a trailing newline,
+      # matching `JSON.stringify(results, null, 2)` in the TypeScript port.
+      def self.write(root, results)
+        out = result_file_path(root, results.oath_path)
+        FileUtils.mkdir_p(File.dirname(out))
+        File.write(out, "#{JSON.pretty_generate(Core::Results.to_wire(results))}\n", encoding: 'UTF-8')
+        out
+      end
+
+      # Examples in document order.
+      #
+      # A test framework reports examples in ITS order — minitest randomises by
+      # design — so the order they are recorded in is not the order they appear
+      # in the oath. The file is a cross-port contract read by tools that diff
+      # runs, so it is written in document order everywhere. Name breaks ties
+      # for examples sharing a line.
+      def self.document_order(examples)
+        examples.sort_by { |r| [r.lines.first || 0, r.name] }
+      end
+
+      # Accumulates one example's outcome; the oath's file is written once its
+      # examples are in.
+      def record(oath_path, source, result)
+        @sources[oath_path] = source
+        (@examples[oath_path] ||= []) << result
+      end
+
+      # Writes what has been recorded for `oath_path` and forgets it. Passing
+      # oaths are written too — a stale file would keep a diagnostic on screen
+      # that the run has just cleared.
+      def flush(root, oath_path)
+        recorded = @examples.delete(oath_path)
+        return nil if recorded.nil? || recorded.empty?
+
+        self.class.write(root, Core::OathResults.new(
+                                 version: 1,
+                                 oath_path: oath_path,
+                                 source_hash: Core::Hash32.hash_source(@sources[oath_path]),
+                                 examples: self.class.document_order(recorded)
+                               ))
+      end
+
+      # Writes every oath still held — for a runner with no per-file completion hook.
+      def flush_all(root)
+        @examples.keys.to_a.each { |oath_path| flush(root, oath_path) }
+      end
+    end
+  end
+end

data/lib/varar/runner/run.rb

@@ -19,7 +19,7 @@ module Varar
 
     module_function
 
-    def plan_spec(path, source, registry)
+    def plan_oath(path, source, registry)
       Core::Plan.plan(Core::Parse.parse(path, source), registry)
     end
 

data/lib/varar/runner.rb

@@ -7,9 +7,9 @@ require 'varar/core'
 module Varar
   # The imperative shell: discovery, step loading, planning, failure
   # rendering, and the filesystem drift baseline store. Depends on the facade
-  # and config; never on a test framework. Port of var-runner.
+  # and config; never on a test framework. Port of varar-runner.
   module Runner
-    VERSION = '0.7.0'
+    VERSION = '0.8.0'
   end
 end
 
@@ -18,3 +18,4 @@ require 'varar/runner/steps'
 require 'varar/runner/run'
 require 'varar/runner/render'
 require 'varar/runner/baseline_store'
+require 'varar/runner/results'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: varar-runner
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -15,29 +15,29 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: varar-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
-description: Spec/step discovery, step loading, planning, failure rendering, and the
+        version: 0.8.0
+description: Oath/step discovery, step loading, planning, failure rendering, and the
   drift baseline store.
 email:
 - aslak@oselvar.com
@@ -52,6 +52,7 @@ files:
 - lib/varar/runner/cli.rb
 - lib/varar/runner/discovery.rb
 - lib/varar/runner/render.rb
+- lib/varar/runner/results.rb
 - lib/varar/runner/run.rb
 - lib/varar/runner/steps.rb
 homepage: https://varar.dev