jazari 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1e44727af4c1cfd7ca851c84618d9015f39aec562c3133301772f6d97b21076
-  data.tar.gz: 8c87563ee6acfbe91b8544274c981dbb98fb24ac05e77cb170f7e33033067f2d
+  metadata.gz: b3e1d3f594584f56c5ea72c8aacd01ce1aa9fc6ddd12b2b1f9c160072dfd9c63
+  data.tar.gz: f5d622adb6252f7465adb0aeab696c9876598bef6a368bf1845dd8a2c896b252
 SHA512:
-  metadata.gz: dec279a4cedbcf0377a512298300487316e04a6ac3dfa9059e37415edcfba07ba0015b11d1d8d2b08d6bf4fd33ec557d87a507a216a095d66a52bdc5a4441f6e
-  data.tar.gz: 148962f5b5f9762f35cc04ba285485c4e76e5de41ef086ea0dafcf4861cd2e9b1110c299ee39ddd45abe491e13a473c0477b66bac914306c7cc9540b6142e382
+  metadata.gz: dfc06b9155a1f706488fa36ee9661c92fb419a27c76cfe6f1e912be31a365ceb6249e24805a92f7e1b9d025511e0559332d6f391f604dbe24e569f46ab886cc1
+  data.tar.gz: f5f37bdc359b9626221055c908a5a0ab59f713ab2238ff5df99a82da9c787e403966ef591e65d25fab45ebd2d9dadb78e2a1fd8af860627c4d8661b589356668

data/CHANGELOG.md

@@ -8,6 +8,53 @@ codes, the resolved-value shape, how revisions are computed, and the schema the
 generator emits — changes to any of those are breaking even when the method
 signatures do not move.
 
+## [0.4.0] - 2026-08-11
+
+### Added
+
+- **`Jazari::RecipeFiles` — recipes as YAML or JSON, without files silently
+  overwriting operators.**
+
+  Nothing ever forbade files: `RecipeRegistry.seed!` takes plain hashes, so
+  `seed!(YAML.load_file(…))` already worked. What was missing was everything
+  that makes it *safe*.
+
+  - **`load(path)`** — a file or a directory of `.yml` / `.yaml` / `.json`.
+    Accepts one recipe, a list, or a list under a `recipes:` key. It validates
+    at LOAD, which is the whole reason it exists rather than "just call
+    `YAML.load_file`": an unknown key is a typo, and a typo that loads silently
+    becomes a recipe resolving to something nobody wrote. Unknown keys, missing
+    topics, bad `run_policy`, duplicate ids and malformed YAML all raise, naming
+    the file.
+  - **`dump(dir)`** — writes what is actually stored back out, one file per
+    recipe. Without this the loop never closes: an operator's runtime fix could
+    not be reviewed or committed, so runtime editing would quietly become the
+    thing you avoid rather than the thing the design is built around.
+  - **`drift(entries)`** — which stored recipes disagree with their file, and in
+    which fields. **Reported, never applied.**
+
+  **Files seed; they do not sync.** `seed!` stays create-if-missing, so a file
+  never overwrites a row an operator edited. That is the same rule the runbook
+  layer already follows — a customisation diverges rather than rebasing, because
+  silently overwriting a deliberate edit with a change nobody saw is the worst
+  available outcome. Applying files on every deploy would do exactly that, one
+  layer up. The cost is drift, so drift is made visible instead of resolved.
+
+  One place the loader is deliberately **stricter than the API**: a malformed
+  checklist id is an error rather than a fixup. `Checklist.normalize` replaces an
+  unusable id with a generated one, which is right when an id is absent and
+  opaque — but in a file someone wrote it, MCP addresses the step by it, and
+  documentation quotes it. Swapping it for a random token would create exactly
+  the file-versus-row disagreement this loader exists to prevent.
+
+### Fixed
+
+- **The boundary check read heredoc bodies as code.** It stripped `"…"` and
+  `'…'` on the stated principle that a capitalised word inside a string is data,
+  but a fixture written as `<<~YML` had its own prose reported as constant
+  references. Heredoc bodies are now skipped. Verified still catching a planted
+  breach.
+
 ## [0.3.0] - 2026-08-11
 
 ### Added

data/lib/jazari/recipe_files.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "json"
+
+module Jazari
+  # Recipes as FILES — the version-controlled, reviewable form of the same data.
+  #
+  # This does not make files a second source of truth. `seed!` has always been
+  # create-if-missing, so a file is a SEED, not a sync: the row wins once it
+  # exists, because an operator editing a procedure at runtime is the whole
+  # reason recipes are data rather than code.
+  #
+  # That is deliberate and it is the same rule the runbook layer already follows —
+  # a customised runbook diverges permanently rather than rebasing, because
+  # silently overwriting a deliberate edit with a change nobody saw is the worst
+  # available outcome. Applying files on every deploy would do exactly that, one
+  # layer up.
+  #
+  # The cost of that choice is drift: a file and a row can disagree and nothing
+  # says so. So drift is REPORTED (`drift`) rather than resolved, and there is a
+  # way back out (`dump`) — edit at runtime, export, review the diff in a pull
+  # request, commit. The loop closes without anyone's work being overwritten.
+  module RecipeFiles
+    EXTENSIONS = %w[.yml .yaml .json].freeze
+
+    # Keys a recipe file may carry. Anything else is a typo, and a typo that
+    # loads silently becomes a recipe that resolves to something nobody wrote.
+    KEYS = %i[id version topic description checklist run_policy].freeze
+
+    module_function
+
+    # Reads one file or every recipe file in a directory. Returns plain hashes,
+    # ready for `RecipeRegistry.seed!` — which is why this is a loader and not a
+    # registry: producing the data and storing it are separate concerns.
+    def load(path)
+      entries = Array(paths_for(path)).flat_map { |file| parse(file) }
+      entries.each { |entry| validate!(entry) }
+      ids = entries.map { |entry| entry[:id] }
+      duplicated = ids.tally.select { |_, count| count > 1 }.keys
+      raise InvalidRunbook, "duplicate recipe ids: #{duplicated.join(', ')}" if duplicated.any?
+
+      entries
+    end
+
+    # Writes what is actually stored back out as YAML, one file per recipe.
+    # This is the half that makes runtime editing safe to allow: whatever an
+    # operator changed can be exported, diffed and committed.
+    def dump(directory, recipes: RecipeRecord.order(:recipe_id))
+      dir = File.expand_path(directory.to_s)
+      Dir.mkdir(dir) unless Dir.exist?(dir)
+      recipes.map do |record|
+        file = File.join(dir, "#{record.recipe_id}.yml")
+        File.write(file, YAML.dump(stringify(to_entry(record))))
+        file
+      end
+    end
+
+    # Which stored recipes disagree with their file definition, and how.
+    #
+    # Reported, never applied. A host decides what a difference means: on one
+    # fleet a file is the reviewed truth and a divergent row is an incident; on
+    # another the row is an operator's fix and the file is simply stale.
+    def drift(entries)
+      Array(entries).filter_map do |entry|
+        attributes = normalize(entry)
+        record = RecipeRecord.find_by(recipe_id: attributes[:id].to_s)
+        next { id: attributes[:id], state: :missing } if record.nil?
+
+        differing = KEYS.reject { |key| same?(key, attributes, record) }
+        next if differing.empty?
+
+        { id: attributes[:id], state: :differs, fields: differing }
+      end
+    end
+
+    # -- internals ---------------------------------------------------------
+
+    def paths_for(path)
+      expanded = File.expand_path(path.to_s)
+      return [ expanded ] if File.file?(expanded)
+      raise InvalidRunbook, "no such recipe path: #{path}" unless File.directory?(expanded)
+
+      Dir.children(expanded).sort
+         .select { |name| EXTENSIONS.include?(File.extname(name)) }
+         .map { |name| File.join(expanded, name) }
+    end
+
+    def parse(file)
+      raw = File.read(file)
+      data = if File.extname(file) == ".json"
+        JSON.parse(raw)
+      else
+        # safe_load: a recipe file is operational content, never a place to
+        # instantiate arbitrary objects.
+        YAML.safe_load(raw, permitted_classes: [], aliases: false)
+      end
+      # A file is either one recipe, a list of them, or a list under a `recipes:`
+      # key. `Array(hash)` would explode a single recipe into key/value pairs, so
+      # the Hash cases are named rather than coerced.
+      entries = if data.is_a?(Hash)
+        data.key?("recipes") ? Array(data["recipes"]) : [ data ]
+      else
+        Array(data)
+      end
+      entries.map { |entry| normalize(entry) }
+    rescue JSON::ParserError, Psych::SyntaxError => error
+      raise InvalidRunbook, "#{File.basename(file)}: #{error.message}"
+    end
+
+    def normalize(entry)
+      entry.to_h.transform_keys { |key| key.to_s.to_sym }
+    end
+
+    def validate!(entry)
+      unknown = entry.keys - KEYS
+      raise InvalidRunbook, "unknown recipe keys: #{unknown.join(', ')}" if unknown.any?
+      raise InvalidRunbook, "recipe id is required" if entry[:id].to_s.empty?
+      raise InvalidRunbook, "recipe #{entry[:id]} has no topic" if entry[:topic].to_s.empty?
+
+      policy = entry.fetch(:run_policy, RunPolicy::UNRESTRICTED).to_s
+      unless RunPolicy::ALL.include?(policy)
+        raise InvalidRunbook, "recipe #{entry[:id]} has unknown run_policy #{policy}"
+      end
+
+      # Reuse the one checklist validator rather than writing a second, laxer
+      # one here — a file must not be able to store an item the API would reject.
+      items = entry.fetch(:checklist, [])
+      Checklist.normalize(items)
+
+      # STRICTER than the API on one point, deliberately. `normalize` REPLACES an
+      # unusable id with a generated one, which is right when an id is absent and
+      # opaque. In a file it is neither: someone wrote it, MCP addresses the step
+      # by it, and documentation quotes it. Silently swapping it for a random
+      # token would put the file and the row into exactly the disagreement this
+      # loader exists to prevent — so a malformed id is an error, not a fixup.
+      Array(items).each do |item|
+        id = (item[:id] || item["id"]).to_s
+        next if id.empty? || id.match?(Checklist::ID_FORMAT)
+
+        raise InvalidRunbook, "recipe #{entry[:id]}: checklist id #{id.inspect} is not a valid token"
+      end
+
+      entry
+    end
+
+    def to_entry(record)
+      { id: record.recipe_id, version: record.version, topic: record.topic,
+        description: record.description, run_policy: record.run_policy,
+        checklist: Checklist.normalize(record.checklist) }
+    end
+
+    def stringify(value)
+      case value
+      when Hash then value.to_h { |key, inner| [ key.to_s, stringify(inner) ] }
+      when Array then value.map { |inner| stringify(inner) }
+      when Symbol then value.to_s
+      else value
+      end
+    end
+
+    def same?(key, attributes, record)
+      stored = case key
+      when :id then record.recipe_id
+      when :checklist then Checklist.normalize(record.checklist)
+      else record.public_send(key)
+      end
+      expected = key == :checklist ? Checklist.normalize(attributes.fetch(key, [])) : attributes[key]
+      return true if expected.nil? && key != :id
+
+      stringify(stored) == stringify(expected)
+    end
+  end
+end

data/lib/jazari/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jazari
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/jazari.rb

@@ -8,6 +8,7 @@ require "jazari/targets"
 require "jazari/anchors"
 require "jazari/resolved_runbook"
 require "jazari/recipe_registry"
+require "jazari/recipe_files"
 require "jazari/runs"
 require "jazari/operations"
 # The MCP layer is OPTIONAL. Descriptors are cheap and a host may want them to

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazari
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nauman Tariq
@@ -67,6 +67,7 @@ files:
 - lib/jazari/operations.rb
 - lib/jazari/railtie.rb
 - lib/jazari/recipe.rb
+- lib/jazari/recipe_files.rb
 - lib/jazari/recipe_registry.rb
 - lib/jazari/resolved_runbook.rb
 - lib/jazari/runs.rb