oselvar-var-config 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 629548dd7c8715ea670c8ecae6d14a6f7ea94f2e3603722aca05b0d3f0f7a7a3
+  data.tar.gz: 0e48cba6cf67f2be4b89b866dc29ad21f041b52a77e6acf81e6e6e115a88922c
+SHA512:
+  metadata.gz: 46fd0a17b288a0d142f9fd5d769659a815f80500e59f21f673c1a39a70d84467b970fbdf8bc429e11fef9fed8433eb6fc7411f54f9a43e7a76379a768a648e0e
+  data.tar.gz: 426a067d9d9c601c6501b0a23f03647c5345eb8a19a53a19ff85e3d2e2568cb17c1fcba57f69058fa1ce7fa5398cdc349335db0c7a9fc326f5353652e461f1c7

data/lib/oselvar/var/config.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Oselvar
+  module Var
+    # Strict, fail-loud reader for the shared var.config.json format. Missing
+    # file → empty config; malformed JSON, wrong types, or unknown keys → an
+    # error starting with the file path. See conformance/config/README.md.
+    module Config
+      VERSION = '0.3.2'
+
+      # The parsed config. All fields default to empty.
+      VarConfig = Data.define(:docs_include, :docs_exclude, :steps, :snippets, :scanner_plugins) do
+        def initialize(docs_include: [], docs_exclude: [], steps: [], snippets: {}, scanner_plugins: [])
+          super
+        end
+      end
+
+      KNOWN_KEYS = %w[$schema docs steps snippets scannerPlugins].freeze
+      KNOWN_DOCS_KEYS = %w[include exclude].freeze
+
+      module_function
+
+      def read_var_config(root)
+        path = File.join(root.to_s, 'var.config.json')
+        return VarConfig.new unless File.file?(path)
+
+        data = begin
+          JSON.parse(File.read(path, encoding: 'UTF-8'))
+        rescue JSON::ParserError => e
+          raise ArgumentError, "#{path}: invalid JSON: #{e.message}"
+        end
+        raise ArgumentError, "#{path}: top level must be an object" unless data.is_a?(::Hash)
+
+        unknown = data.keys - KNOWN_KEYS
+        raise ArgumentError, "#{path}: unknown key(s): #{unknown.sort.join(', ')}" unless unknown.empty?
+
+        docs = data['docs'] || {}
+        raise ArgumentError, "#{path}: 'docs' must be an object" unless docs.is_a?(::Hash)
+
+        unknown_docs = docs.keys - KNOWN_DOCS_KEYS
+        raise ArgumentError, "#{path}: unknown docs key(s): #{unknown_docs.sort.join(', ')}" unless unknown_docs.empty?
+
+        snippets = data['snippets'] || {}
+        unless snippets.is_a?(::Hash) && snippets.all? { |k, v| k.is_a?(String) && v.is_a?(String) }
+          raise ArgumentError, "#{path}: 'snippets' must be an object of strings"
+        end
+
+        VarConfig.new(
+          docs_include: string_array(docs['include'], 'docs.include', path),
+          docs_exclude: string_array(docs['exclude'], 'docs.exclude', path),
+          steps: string_array(data['steps'], 'steps', path),
+          snippets: snippets,
+          scanner_plugins: string_array(data['scannerPlugins'], 'scannerPlugins', path)
+        )
+      end
+
+      def string_array(value, key, path)
+        return [] if value.nil?
+        unless value.is_a?(Array) && value.all?(String)
+          raise ArgumentError, "#{path}: '#{key}' must be an array of strings"
+        end
+
+        value
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: oselvar-var-config
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Aslak Hellesøy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-07 00:00:00.000000000 Z
+dependencies: []
+description: Strict, fail-loud reader for the shared var.config.json format.
+email:
+- aslak@oselvar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/oselvar/var/config.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 — var.config.json reader
+test_files: []