textus 0.10.5 → 0.12.1

data/lib/textus/manifest/schema.rb

@@ -0,0 +1,49 @@
+module Textus
+  class Manifest
+    module Schema
+      ROOT_KEYS    = %w[version zones entries rules].freeze
+      ZONE_KEYS    = %w[name write_policy read_policy].freeze
+      ENTRY_KEYS   = %w[
+        key path zone schema owner nested format
+        compute template publish_to publish_each
+        intake events inject_intro index_filename
+      ].freeze
+      COMPUTE_KEYS = %w[kind select pluck sort_by limit transform command sources].freeze
+      INTAKE_KEYS  = %w[handler config].freeze
+      RULE_KEYS    = %w[match refresh intake_handler_allowlist promotion retention].freeze
+      REFRESH_KEYS = %w[ttl on_stale sync_budget_ms].freeze
+      PROMOTION_KEYS = %w[requires].freeze
+
+      def self.validate!(raw)
+        raise BadManifest.new("manifest must be a hash") unless raw.is_a?(Hash)
+
+        walk(raw, ROOT_KEYS, "$")
+        Array(raw["zones"]).each_with_index do |z, i|
+          walk(z, ZONE_KEYS, "$.zones[#{i}]")
+        end
+        Array(raw["entries"]).each_with_index do |e, i|
+          path = "$.entries[#{i}]"
+          walk(e, ENTRY_KEYS, path)
+          walk(e["compute"], COMPUTE_KEYS, "#{path}.compute") if e["compute"].is_a?(Hash)
+          walk(e["intake"], INTAKE_KEYS, "#{path}.intake") if e["intake"].is_a?(Hash)
+        end
+        Array(raw["rules"]).each_with_index do |r, i|
+          path = "$.rules[#{i}]"
+          walk(r, RULE_KEYS, path)
+          walk(r["refresh"], REFRESH_KEYS, "#{path}.refresh") if r["refresh"].is_a?(Hash)
+          walk(r["promotion"], PROMOTION_KEYS, "#{path}.promotion") if r["promotion"].is_a?(Hash)
+        end
+      end
+
+      def self.walk(hash, allowed, path)
+        return unless hash.is_a?(Hash)
+
+        hash.each_key do |k|
+          next if allowed.include?(k)
+
+          raise BadManifest.new("unknown key '#{k}' at '#{path}'")
+        end
+      end
+    end
+  end
+end

data/lib/textus/manifest.rb

@@ -1,4 +1,5 @@
 require "yaml"
+require_relative "manifest/schema"
 
 module Textus
   class Manifest
@@ -10,10 +11,26 @@ module Textus
       ".txt" => "text",
     }.freeze
 
+    TEXTUS_2_HINT = "Install textus 0.11.x to run the migrator, then upgrade to this version. " \
+                    "See https://github.com/patrick204nqh/textus/blob/main/CHANGELOG.md#0110".freeze
+
+    def self.version_hint_for(version)
+      version == "textus/2" ? TEXTUS_2_HINT : nil
+    end
+
+    private_class_method :version_hint_for
+
     attr_reader :root, :entries, :raw
 
     def zones
-      @zones ||= Array(@raw["zones"]).to_h { |z| [z["name"], Array(z["writable_by"])] }
+      @zones ||= Array(@raw["zones"]).to_h { |z| [z["name"], Array(z["write_policy"])] }
+    end
+
+    def zone_readers
+      @zone_readers ||= Array(@raw["zones"]).to_h do |z|
+        rp = z["read_policy"]
+        [z["name"], rp.nil? ? :all : Array(rp)]
+      end
     end
 
     def zone_writers(zone_name)
@@ -23,18 +40,35 @@ module Textus
     def permission_for(zone_name)
       Textus::Domain::Permission.new(
         zone: zone_name,
-        writable_by: zone_writers(zone_name),
-        readable_by: :all,
+        write_policy: zone_writers(zone_name),
+        read_policy: zone_readers[zone_name] || :all,
       )
     end
 
+    def self.parse(yaml_text, root: ".")
+      raw = YAML.safe_load(yaml_text, aliases: false)
+      unless raw["version"] == PROTOCOL
+        raise BadFrontmatter.new(
+          "<string>",
+          "unsupported manifest version #{raw["version"].inspect}; expected #{PROTOCOL.inspect}",
+          hint: version_hint_for(raw["version"]),
+        )
+      end
+
+      new(root, raw)
+    end
+
     def self.load(root)
       manifest_path = File.join(root, "manifest.yaml")
       raise IoError.new("manifest not found: #{manifest_path}") unless File.exist?(manifest_path)
 
       raw = YAML.safe_load_file(manifest_path, aliases: false)
       unless raw["version"] == PROTOCOL
-        raise BadFrontmatter.new(manifest_path, "unsupported manifest version #{raw["version"].inspect}; expected #{PROTOCOL.inspect}")
+        raise BadFrontmatter.new(
+          manifest_path,
+          "unsupported manifest version #{raw["version"].inspect}; expected #{PROTOCOL.inspect}",
+          hint: version_hint_for(raw["version"]),
+        )
       end
 
       new(root, raw)
@@ -45,16 +79,18 @@ module Textus
       @raw = raw
       raise BadFrontmatter.new(File.join(root, "manifest.yaml"), "manifest must declare zones:") if Array(raw["zones"]).empty?
 
+      Schema.validate!(raw)
+
       @entries = Array(raw["entries"]).map { |e| Manifest::Entry.new(self, e) }
       validate_declared_keys!
     end
 
-    def policies
-      @policies ||= Textus::Manifest::Policies.parse(@raw["policies"] || [])
+    def rules
+      @rules ||= Textus::Manifest::Rules.parse(@raw["rules"] || [])
     end
 
-    def policies_for(key)
-      policies.for(key)
+    def rules_for(key)
+      rules.for(key)
     end
 
     # Returns [Manifest::Entry, resolved_path, remaining_segments]
@@ -135,7 +171,7 @@ module Textus
 
       illegal = segs.find { |s| !valid_segment?(s) }
       if illegal
-        warn("textus: skipping illegal key segment '#{illegal}' at #{path} — run 'textus key migrate --dry-run'")
+        warn("textus: skipping illegal key segment '#{illegal}' at #{path} — run 'textus key normalize --dry-run'")
         return nil
       end
 

data/lib/textus/migrate_keys.rb

@@ -122,7 +122,7 @@ module Textus
         File.rename(from, to)
         new_key = compute_new_key(r, renames)
         audit.append(
-          role: "script",
+          role: "runner",
           verb: "migrate-keys",
           key: new_key,
           etag_before: nil,

data/lib/textus/projection.rb

@@ -38,14 +38,14 @@ module Textus
     private
 
     def apply_reducer(rows)
-      name = @spec["reduce"] or return rows
-      callable = @store.registry.rpc_callable(:reduce, name)
+      name = @spec["transform"] or return rows
+      callable = @store.registry.rpc_callable(:transform_rows, name)
       view = Application::Context.new(store: @store, role: "human")
       Timeout.timeout(REDUCER_TIMEOUT_SECONDS) do
-        callable.call(store: view, rows: rows, config: @spec["reduce_config"] || {})
+        callable.call(store: view, rows: rows, config: @spec["transform_config"] || {})
       end
     rescue Timeout::Error
-      raise UsageError.new("reduce '#{name}' exceeded #{REDUCER_TIMEOUT_SECONDS}s timeout")
+      raise UsageError.new("transform_rows '#{name}' exceeded #{REDUCER_TIMEOUT_SECONDS}s timeout")
     end
 
     def collect_keys

data/lib/textus/refresh.rb

@@ -5,7 +5,7 @@ module Textus
       Textus::Composition.refresh_worker(ctx).run(key)
     end
 
-    def self.refresh_stale(store, prefix: nil, zone: nil, as: "script")
+    def self.refresh_stale(store, prefix: nil, zone: nil, as: "runner")
       ctx = Textus::Composition.context(store, role: as)
       Textus::Application::Refresh::All.call(ctx, prefix: prefix, zone: zone)
     end

data/lib/textus/store/mover.rb

@@ -112,7 +112,7 @@ module Textus
         )
         new_envelope = @reader.get(plan.new_key)
         @store.fire_event(
-          :mv,
+          :entry_renamed,
           key: plan.new_key, from_key: plan.old_key, to_key: plan.new_key,
           envelope: new_envelope
         )

data/lib/textus/store/staleness/intake_check.rb

@@ -13,7 +13,7 @@ module Textus
         def rows_for(mentry)
           return [] unless mentry.intake_handler
 
-          ttl = @manifest.policies_for(mentry.key).refresh&.ttl_seconds
+          ttl = @manifest.rules_for(mentry.key).refresh&.ttl_seconds
           return [] unless ttl
 
           path = Textus::Key::Path.resolve(@manifest, mentry)

data/lib/textus/store/writer.rb

@@ -163,7 +163,7 @@ module Textus
         target_key = proposal["target_key"] or raise ProposalError.new("proposal missing target_key")
 
         delete(pending_key, as: as)
-        @store.fire_event(:reject, key: pending_key, target_key: target_key)
+        @store.fire_event(:proposal_rejected, key: pending_key, target_key: target_key)
         { "protocol" => PROTOCOL, "rejected" => pending_key, "target_key" => target_key }
       end
     end

data/lib/textus/store.rb

@@ -45,7 +45,7 @@ module Textus
       load_hooks
       @reader = Reader.new(self)
       @writer = Writer.new(self)
-      fire_event(:loaded)
+      fire_event(:store_loaded)
     end
 
     def load_hooks

data/lib/textus/version.rb

@@ -1,4 +1,4 @@
 module Textus
-  VERSION = "0.10.5"
-  PROTOCOL = "textus/2"
+  VERSION = "0.12.1"
+  PROTOCOL = "textus/3"
 end

data/lib/textus.rb

@@ -7,6 +7,7 @@ loader.inflector.inflect(
   "cli" => "CLI",
   "json" => "Json",
   "yaml" => "Yaml",
+  "hook_dsl_scanner" => "HookDSLScanner",
 )
 loader.ignore(File.expand_path("textus/errors.rb", __dir__))
 loader.setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textus
 version: !ruby/object:Gem::Version
-  version: 0.10.5
+  version: 0.12.1
 platform: ruby
 authors:
 - Patrick
@@ -133,7 +133,8 @@ files:
 - lib/textus/cli/group.rb
 - lib/textus/cli/group/hook.rb
 - lib/textus/cli/group/key.rb
-- lib/textus/cli/group/policy.rb
+- lib/textus/cli/group/refresh.rb
+- lib/textus/cli/group/rule.rb
 - lib/textus/cli/group/schema.rb
 - lib/textus/cli/verb.rb
 - lib/textus/cli/verb/accept.rb
@@ -149,17 +150,17 @@ files:
 - lib/textus/cli/verb/hooks.rb
 - lib/textus/cli/verb/init.rb
 - lib/textus/cli/verb/intro.rb
+- lib/textus/cli/verb/key_normalize.rb
 - lib/textus/cli/verb/list.rb
-- lib/textus/cli/verb/migrate_keys.rb
 - lib/textus/cli/verb/mv.rb
-- lib/textus/cli/verb/policy_explain.rb
-- lib/textus/cli/verb/policy_list.rb
 - lib/textus/cli/verb/published.rb
 - lib/textus/cli/verb/put.rb
 - lib/textus/cli/verb/rdeps.rb
 - lib/textus/cli/verb/refresh.rb
 - lib/textus/cli/verb/refresh_stale.rb
 - lib/textus/cli/verb/reject.rb
+- lib/textus/cli/verb/rule_explain.rb
+- lib/textus/cli/verb/rule_list.rb
 - lib/textus/cli/verb/schema.rb
 - lib/textus/cli/verb/schema_diff.rb
 - lib/textus/cli/verb/schema_init.rb
@@ -176,7 +177,8 @@ files:
 - lib/textus/doctor/check/illegal_keys.rb
 - lib/textus/doctor/check/intake_registration.rb
 - lib/textus/doctor/check/manifest_files.rb
-- lib/textus/doctor/check/policy_ambiguity.rb
+- lib/textus/doctor/check/protocol_version.rb
+- lib/textus/doctor/check/rule_ambiguity.rb
 - lib/textus/doctor/check/schema_parse_error.rb
 - lib/textus/doctor/check/schema_violations.rb
 - lib/textus/doctor/check/schemas.rb
@@ -192,7 +194,10 @@ files:
 - lib/textus/domain/policy.rb
 - lib/textus/domain/policy/handler_allowlist.rb
 - lib/textus/domain/policy/matcher.rb
+- lib/textus/domain/policy/predicates/human_accept.rb
+- lib/textus/domain/policy/predicates/schema_valid.rb
 - lib/textus/domain/policy/promote.rb
+- lib/textus/domain/policy/promotion.rb
 - lib/textus/domain/policy/refresh.rb
 - lib/textus/entry.rb
 - lib/textus/entry/base.rb
@@ -220,7 +225,8 @@ files:
 - lib/textus/key/path.rb
 - lib/textus/manifest.rb
 - lib/textus/manifest/entry.rb
-- lib/textus/manifest/policies.rb
+- lib/textus/manifest/rules.rb
+- lib/textus/manifest/schema.rb
 - lib/textus/migrate_keys.rb
 - lib/textus/mustache.rb
 - lib/textus/projection.rb

data/lib/textus/cli/group/policy.rb

@@ -1,11 +0,0 @@
-module Textus
-  class CLI
-    class Group
-      class Policy < Group
-        self.cli_name = "policy"
-        subcommands["list"]    = Verb::PolicyList
-        subcommands["explain"] = Verb::PolicyExplain
-      end
-    end
-  end
-end