oselvar-var-runner 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e42590bbc4c12415be6ca340782799736446b9b4726bcfeb267b739299857374
+  data.tar.gz: 1662affcd72ef5dceda9fe1943b83f70c96bd16031f84a969ddd60424c813b61
+SHA512:
+  metadata.gz: b9c8dbc815fe1b16987c83b8ed26e180453c7b814088c5fc299d6c2d2048640767d44965b9bfd9aa89246c220d51b343377e7fada72d17211d4cc4d058bb192f
+  data.tar.gz: 5c12fd37536504b8c0cdb3303ec86b8971d7132023be2d107c2b495ce2d0915d42d64f369fce7e72f4dea70db53fbdb174961c9310868d75bf2987839b163b56

data/exe/var

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'oselvar/var/runner/cli'
+
+exit Oselvar::Var::Runner::CLI.main(ARGV)

data/lib/oselvar/var/runner/baseline_store.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Oselvar
+  module Var
+    module Runner
+      # The filesystem BaselineStore: the committed drift baseline lives at the
+      # project root as var.lock.json. The core owns the format; this adapter
+      # only moves raw text. Port of baseline_store.py.
+      class FileBaselineStore
+        def initialize(root)
+          @path = File.join(root.to_s, 'var.lock.json')
+        end
+
+        def read
+          File.exist?(@path) ? File.read(@path, encoding: 'UTF-8') : nil
+        end
+
+        def write(contents)
+          File.write(@path, contents)
+        end
+      end
+
+      module_function
+
+      def create_file_baseline_store(root)
+        FileBaselineStore.new(root)
+      end
+    end
+  end
+end

data/lib/oselvar/var/runner/cli.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Oselvar
+  module Var
+    module Runner
+      # The `var` command-line entry point (exposed by the `exe/var`
+      # executable). Today it offers a single sub-command, `var init`, which
+      # scaffolds a new project: a `var.config.json`, one Markdown spec, its
+      # step definitions, and a framework bridge that turns the specs into
+      # RSpec examples or Minitest tests.
+      #
+      # The config, spec and steps mirror the TypeScript CLI (`@oselvar/var-cli`)
+      # so a project started with `var 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.
+      module CLI
+        CONFIG = <<~JSON
+          {
+            "docs": { "include": ["var-examples/**/*.md"], "exclude": [] },
+            "steps": ["var-examples/**/*.steps.rb"]
+          }
+        JSON
+
+        EXAMPLE_MD = <<~MARKDOWN
+          # Hello, BDD
+
+          Given I greet "world"
+          Then the greeting is "Hello, world!"
+        MARKDOWN
+
+        EXAMPLE_STEPS = <<~RUBY
+          # frozen_string_literal: true
+
+          require 'oselvar/var'
+
+          steps(greeting: '') do
+            stimulus('I greet {string}') { |_state, name| { greeting: "Hello, \#{name}!" } }
+            sensor('the greeting is {string}') { |state, _expected| state[:greeting] }
+          end
+        RUBY
+
+        RSPEC_BRIDGE = <<~RUBY
+          # frozen_string_literal: true
+
+          # Turn every Markdown spec matched by var.config.json into RSpec examples —
+          # one `it` per Markdown example, discovered when this file loads.
+          require 'oselvar/var/rspec'
+
+          # var.config.json lives at the project root (the parent of spec/).
+          Oselvar::Var::RSpec.generate(root: File.expand_path('..', __dir__))
+        RUBY
+
+        MINITEST_BRIDGE = <<~RUBY
+          # frozen_string_literal: true
+
+          require 'minitest/autorun'
+          require 'oselvar/var/minitest'
+
+          # Turn every Markdown spec matched by var.config.json into Minitest tests —
+          # var.config.json lives at the project root (the parent of test/).
+          Oselvar::Var::Minitest.generate_tests(Object, root: File.expand_path('..', __dir__))
+        RUBY
+
+        USAGE = <<~TEXT
+          var — scaffold and run Markdown specs
+
+          Usage:
+            var init               scaffold a new project
+        TEXT
+
+        def self.main(argv, cwd: Dir.pwd, out: $stdout)
+          case argv.first
+          when 'init'
+            run_init(cwd, out)
+          else
+            out.print(USAGE)
+            argv.empty? || %w[help -h --help].include?(argv.first) ? 0 : 1
+          end
+        end
+
+        # Write the scaffold into +cwd+, skipping any file that already exists.
+        # The framework bridge matches whichever adapter gem is installed
+        # (RSpec by default).
+        def self.run_init(cwd, out, framework: detect_framework)
+          files = [
+            ['var.config.json', CONFIG],
+            ['var-examples/01-hello.md', EXAMPLE_MD],
+            ['var-examples/steps/01-hello.steps.rb', EXAMPLE_STEPS]
+          ]
+          files << if framework == :minitest
+                     ['test/var_test.rb', MINITEST_BRIDGE]
+                   else
+                     ['spec/var_spec.rb', RSPEC_BRIDGE]
+                   end
+
+          files.each do |rel, content|
+            target = File.join(cwd, rel)
+            if File.exist?(target)
+              out.puts "skipped #{rel} (already exists)"
+              next
+            end
+            FileUtils.mkdir_p(File.dirname(target))
+            File.write(target, content)
+            out.puts "created #{rel}"
+          end
+          0
+        end
+
+        # RSpec when its adapter is installed, Minitest when only that one is,
+        # RSpec as the fallback (matching the tutorial's default track).
+        def self.detect_framework
+          return :rspec if gem_present?('oselvar-var-rspec')
+          return :minitest if gem_present?('oselvar-var-minitest')
+
+          :rspec
+        end
+
+        def self.gem_present?(name)
+          Gem::Specification.find_all_by_name(name).any?
+        rescue StandardError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/oselvar/var/runner/discovery.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Oselvar
+  module Var
+    module Runner
+      module_function
+
+      # Translate a glob with **, *, ? to an anchored regex (PEP 428 / pathlib
+      # full_match semantics), matching the other ports' hand-rolled compiler
+      # rather than Ruby's Dir glob. Port of _glob_to_regex.
+      def glob_to_regex(pattern)
+        result = +''
+        i = 0
+        n = pattern.length
+        while i < n
+          c = pattern[i]
+          if c == '/' && pattern[i, 4] == '/**/'
+            result << '/(?:.+/)?'
+            i += 4
+          elsif c == '/' && pattern[i, 3] == '/**' && i + 3 == n
+            result << '(?:/.*)?'
+            i += 3
+          elsif c == '*' && pattern[i, 3] == '**/'
+            result << '(?:.*/)?'
+            i += 3
+          elsif c == '*' && pattern[i, 2] == '**'
+            result << '.*'
+            i += 2
+          elsif c == '*'
+            result << '[^/]*'
+            i += 1
+          elsif c == '?'
+            result << '[^/]'
+            i += 1
+          else
+            result << Regexp.escape(c)
+            i += 1
+          end
+        end
+        /\A#{result}\z/
+      end
+
+      # Relative POSIX path of +path+ within +root+, without dereferencing
+      # symlinks; yields a ../ prefix when +path+ is outside +root+.
+      def rel_posix(path, root)
+        Pathname.new(File.expand_path(path))
+                .relative_path_from(Pathname.new(File.expand_path(root))).to_s
+      end
+
+      def matches_any?(rel, globs)
+        globs.any? { |g| glob_to_regex(g).match?(rel) }
+      end
+
+      # True iff +path+ matches an include glob and no exclude glob.
+      def match_spec?(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)
+        out = []
+        include.each do |g|
+          out.concat(Dir.glob(g, base: root).map { |rel| File.join(root, rel) })
+        end
+        out = out.select { |p| File.file?(p) }.uniq
+        out.reject { |p| matches_any?(rel_posix(p, root), exclude) }.sort
+      end
+    end
+  end
+end

data/lib/oselvar/var/runner/render.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'oselvar/var/core'
+
+module Oselvar
+  module Var
+    module Runner
+      module_function
+
+      # Render a step failure as a human-readable, markdown-anchored string,
+      # dispatching on the concrete error type. Port of render.py.
+      def render_failure(error, _source, path)
+        case error
+        when Core::CellMismatchError
+          lines = ["Cell mismatch in #{path}:"]
+          failing = error.cells.reject(&:ok)
+          lines << '  (no failing cells)' if failing.empty?
+          failing.each do |cell|
+            lines << "  line #{cell.span.start_line} | column '#{cell.column}' — " \
+                     "expected: #{cell.expected.inspect}, actual: #{cell.actual.inspect}"
+          end
+          lines.join("\n")
+        when Core::DocStringMismatchError
+          diff = error.diff
+          "Doc string mismatch at line #{diff.span.start_line}:\n  " \
+            "expected: #{diff.expected.inspect}\n  actual:   #{diff.actual.inspect}"
+        when Core::ReturnShapeError
+          error.message
+        else
+          "#{error.class}: #{error.message}"
+        end
+      end
+    end
+  end
+end

data/lib/oselvar/var/runner/run.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'oselvar/var/core'
+
+module Oselvar
+  module Var
+    module Runner
+      # Collects diagnostics emitted during planning/execution.
+      class RecordingReporter
+        attr_reader :diagnostics
+
+        def initialize
+          @diagnostics = []
+        end
+
+        def diagnostic(diagnostic)
+          @diagnostics << diagnostic
+        end
+      end
+
+      module_function
+
+      def plan_spec(path, source, registry)
+        Core::Plan.plan(Core::Parse.parse(path, source), registry)
+      end
+
+      # Pair each PlannedExample with its lazy run closure, in plan order.
+      def examples_with_runs(execution_plan, create_context, reporter)
+        reporter_cb = ->(d) { reporter.diagnostic(d) }
+        queue = Core::Execute.collect_examples(execution_plan, create_context: create_context, reporter: reporter_cb)
+        execution_plan.examples.zip(queue).map { |example, queued| [example, queued.run] }
+      end
+    end
+  end
+end

data/lib/oselvar/var/runner/steps.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'oselvar/var'
+require 'oselvar/var/registry'
+
+module Oselvar
+  module Var
+    module Runner
+      # The registry + per-file context factory built from loaded step files.
+      LoadedSteps = Data.define(:registry, :create_context)
+
+      module_function
+
+      # Reset the accumulator, load (execute) every step file matching
+      # +step_globs+ under +root+, and build the registry + context factory.
+      def load_steps(step_globs, root)
+        RegistryGlue.reset_builder
+        files = []
+        step_globs.each do |g|
+          files.concat(Dir.glob(g, base: root).map { |rel| File.join(root, rel) })
+        end
+        files.select { |p| File.file?(p) }.uniq.sort.each { |path| load path }
+        LoadedSteps.new(registry: RegistryGlue.build_registry, create_context: RegistryGlue.context_factory)
+      end
+    end
+  end
+end

data/lib/oselvar/var/runner.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'oselvar/var'
+require 'oselvar/var/config'
+require 'oselvar/var/core'
+
+module Oselvar
+  module Var
+    # 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.
+    module Runner
+      VERSION = '0.3.2'
+    end
+  end
+end
+
+require 'oselvar/var/runner/discovery'
+require 'oselvar/var/runner/steps'
+require 'oselvar/var/runner/run'
+require 'oselvar/var/runner/render'
+require 'oselvar/var/runner/baseline_store'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: oselvar-var-runner
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Aslak Hellesøy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oselvar-var
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: oselvar-var-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+description: Spec/step discovery, step loading, planning, failure rendering, and the
+  drift baseline store.
+email:
+- aslak@oselvar.com
+executables:
+- var
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/var
+- lib/oselvar/var/runner.rb
+- lib/oselvar/var/runner/baseline_store.rb
+- lib/oselvar/var/runner/cli.rb
+- lib/oselvar/var/runner/discovery.rb
+- lib/oselvar/var/runner/render.rb
+- lib/oselvar/var/runner/run.rb
+- lib/oselvar/var/runner/steps.rb
+homepage: https://var.oselvar.com
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Markdown-native BDD — imperative shell (discovery, loading, drift)
+test_files: []