varar-rspec 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b76a0b607c4dc1b8203c124ae93bd454630718a051b309841bcf35bb7a7d2b6d
+  data.tar.gz: 884bd2f2f4fc3e623e12130f5e5ef35e2468c7b4ac5e0b0afed4fd3d27fbb96d
+SHA512:
+  metadata.gz: 0e4888dc59caba0bd611d8cffb87865be40f2cdf3938b4ef542a4d82a0d160a9716fff7ebc8fad296bf2329eff2da05feaa5781a4f12c6895c5273d058397ba8
+  data.tar.gz: 3394c3029ebe391403ba7bb8787ca4bf5bb275a0daf7913ef3bb51f1ddc7bba9a17f973c828b6d9f8600d332ab227a7744e68d920651bed8bf2eecab2917d2ee

data/lib/varar/rspec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'varar/runner'
+
+module Varar
+  # RSpec adapter. One call defines an RSpec example group per spec 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
+  #   require "varar/rspec"
+  #   Varar::RSpec.generate
+  module RSpec
+    VERSION = '0.5.0'
+
+    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)
+      loaded = Runner.load_steps(cfg.steps, root)
+      store = Runner.create_file_baseline_store(root)
+      update = %w[1 true].include?(ENV.fetch('VAR_UPDATE', nil))
+
+      Runner.find_specs(cfg.docs_include, cfg.docs_exclude, root).each do |spec_path|
+        define_group(spec_path, root, loaded, store, update)
+      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)
+      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)
+
+      ::RSpec.describe(rel) do
+        pairs.each do |example, run|
+          # 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
+            raise Runner.render_failure(e, source, rel) if RSpec.var_diff_error?(e)
+
+            raise
+          end
+        end
+
+        drifts.each do |drift|
+          message = Core::Diagnostics.drift_detected(drift.name, drift.span).message
+          it("var drift at line #{drift.line}") { raise message }
+        end
+      end
+    end
+
+    def var_diff_error?(error)
+      error.is_a?(Core::CellMismatchError) || error.is_a?(Core::DocStringMismatchError) ||
+        error.is_a?(Core::ReturnShapeError) || error.is_a?(Core::UnexpectedPassError)
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: varar-rspec
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Aslak Hellesøy
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: varar-runner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: 'RSpec adapter: one selectable example per Markdown example, with a drift
+  gate.'
+email:
+- aslak@oselvar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/varar/rspec.rb
+homepage: https://varar.dev
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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: 4.0.16
+specification_version: 4
+summary: Markdown-native BDD — run Markdown specs as RSpec examples
+test_files: []