varar-config 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c2c0da492569d54a8b33324db73cc6019de71d7ff09c8036227c0e7b04533fc
+  data.tar.gz: 5e174fa1a9fa0b8d70d8a389e67e9d9be2021d2a25334d0e34a87bb0d35d5c18
+SHA512:
+  metadata.gz: c8a08392f6626526013badf54370564a4bb4c40ce237d8aeb55ebd191bcbe9f806b55c325f1813f9be97e72347424e2740b5d263fe6dac2d9315466b701394ce
+  data.tar.gz: 67e1e9d43475caf0d9eaa0e8b986c2634bcfd1259ca0f389b2540929e1a47eca867d878f34af501c0b4ddec7dda708a2a9fb393c76fdcaf814170de818ca75d3

data/lib/varar/config.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Varar
+  # Strict, fail-loud reader for the shared varar.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.5.0'
+
+    # 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, 'varar.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

metadata

@@ -0,0 +1,42 @@
+--- !ruby/object:Gem::Specification
+name: varar-config
+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: []
+description: Strict, fail-loud reader for the shared varar.config.json format.
+email:
+- aslak@oselvar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/varar/config.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 — varar.config.json reader
+test_files: []