Feature/editor 2 (#28)

* feat: Add editor option to annotations and update editable annotations logic
* feat: Implement inline editing feature for YAML documents and add file writer functionality
* feat: Remove inline edit flag from YAML output and form partials

Author: ionos-landgraf-vin

lib/archsight/annotations/annotation.rb

@@ -4,7 +4,7 @@
 
 # Annotation represents a single annotation definition with its schema and behavior
 class Archsight::Annotations::Annotation
-  attr_reader :key, :description, :filter, :format, :enum, :sidebar, :type, :list
+  attr_reader :key, :description, :filter, :format, :enum, :sidebar, :type, :list, :editor
 
   def initialize(key, options = {})
     @key = key
@@ -14,6 +14,7 @@ def initialize(key, options = {})
     @enum = options[:enum]
     @sidebar = options.fetch(:sidebar, true)
     @list = options.fetch(:list, false)
+    @editor = options.fetch(:editor, true)
     @type = options[:type]
 
     # Auto-add filter if enum present

lib/archsight/annotations/generated_annotations.rb

@@ -7,15 +7,18 @@ def self.included(base)
       annotation "generated/script",
                  description: "Name of the script that generated this resource",
                  title: "Generated By",
-                 sidebar: false
+                 sidebar: false,
+                 editor: false
       annotation "generated/at",
                  description: "Timestamp when this resource was generated (ISO8601)",
                  title: "Generated At",
-                 sidebar: false
+                 sidebar: false,
+                 editor: false
       annotation "generated/configHash",
                  description: "Hash of configuration used to generate this resource (for change detection)",
                  title: "Config Hash",
-                 sidebar: false
+                 sidebar: false,
+                 editor: false
     end
   end
 end

lib/archsight/annotations/git_annotations.rb

@@ -6,16 +6,20 @@ def self.included(base)
     base.class_eval do
       annotation "git/updatedAt",
                  description: "Date when the resource was last updated",
-                 title: "Updated At"
+                 title: "Updated At",
+                 editor: false
       annotation "git/updatedBy",
                  description: "Email of person who last updated the resource",
-                 title: "Updated By"
+                 title: "Updated By",
+                 editor: false
       annotation "git/reviewedAt",
                  description: "Date when the resource was last reviewed",
-                 title: "Reviewed At"
+                 title: "Reviewed At",
+                 editor: false
       annotation "git/reviewedBy",
                  description: "Email of person who last reviewed the resource",
-                 title: "Reviewed By"
+                 title: "Reviewed By",
+                 editor: false
     end
   end
 end

lib/archsight/cli.rb

@@ -19,13 +19,15 @@ def self.exit_on_failure?
     option :production, type: :boolean, default: false, desc: "Run in production mode"
     option :disable_reload, type: :boolean, default: false, desc: "Disable the reload button in the UI"
     option :enable_logging, type: :boolean, default: nil, desc: "Enable request logging (default: false in dev, true in prod)"
+    option :inline_edit, type: :boolean, default: false, desc: "Enable inline editing (save directly to source files)"
     def web
       configure_resources
       require "archsight/web/application"
 
       env = options[:production] ? :production : :development
       Archsight::Web::Application.configure_environment!(env, logging: options[:enable_logging])
       Archsight::Web::Application.set :reload_enabled, !options[:disable_reload]
+      Archsight::Web::Application.set :inline_edit_enabled, options[:inline_edit]
       Archsight::Web::Application.setup_mcp!
       Archsight::Web::Application.run!(port: options[:port], bind: options[:host])
     rescue Archsight::ResourceError => e

lib/archsight/editor.rb

@@ -2,6 +2,7 @@
 
 require "yaml"
 require_relative "resources"
+require_relative "editor/file_writer"
 
 module Archsight
   # Editor handles building and validating resources for the web editor
@@ -92,19 +93,8 @@ def self.apply_block_scalar_style(node)
       end
     end
 
-    # Annotation keys that should not be editable (system-managed fields)
-    EXCLUDED_ANNOTATION_PREFIXES = %w[
-      git/updatedAt
-      git/updatedBy
-      git/reviewedAt
-      git/reviewedBy
-      generated/script
-      generated/at
-      generated/configHash
-    ].freeze
-
     # Get editable annotations for a resource kind
-    # Excludes pattern annotations, computed annotations, and system-managed fields
+    # Excludes pattern annotations, computed annotations, and annotations with editor: false
     # @param kind [String] Resource kind
     # @return [Array<Archsight::Annotations::Annotation>]
     def self.editable_annotations(kind)
@@ -118,8 +108,8 @@ def self.editable_annotations(kind)
       computed_keys = klass.computed_annotations.map(&:key)
       annotations = annotations.reject { |a| computed_keys.include?(a.key) }
 
-      # Filter out system-managed annotations
-      annotations.reject { |a| EXCLUDED_ANNOTATION_PREFIXES.include?(a.key) }
+      # Filter out non-editable annotations
+      annotations.reject { |a| a.editor == false }
     end
 
     # Get available relations for a resource kind

lib/archsight/editor/file_writer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Archsight
+  class Editor
+    # FileWriter handles writing YAML documents back to multi-document files
+    module FileWriter
+      class WriteError < StandardError; end
+
+      # Replace a YAML document in a file starting at a given line
+      # @param path [String] File path
+      # @param start_line [Integer] Line number where document starts (1-indexed)
+      # @param new_yaml [String] New YAML content (without leading ---)
+      # @raise [WriteError] if file cannot be written or document not found at expected line
+      def self.replace_document(path:, start_line:, new_yaml:)
+        raise WriteError, "File not found: #{path}" unless File.exist?(path)
+        raise WriteError, "File not writable: #{path}" unless File.writable?(path)
+
+        lines = File.readlines(path)
+        start_idx = start_line - 1 # Convert to 0-indexed
+
+        raise WriteError, "Line #{start_line} is beyond end of file" if start_idx >= lines.length
+
+        # Find the end of this document (next --- or EOF)
+        end_idx = find_document_end(lines, start_idx)
+
+        # Build the new content
+        # Ensure new_yaml ends with a newline
+        new_yaml = "#{new_yaml}\n" unless new_yaml.end_with?("\n")
+
+        # Replace the document
+        new_lines = lines[0...start_idx] + [new_yaml] + lines[end_idx..]
+
+        # Write atomically by writing to temp file then renaming
+        File.write(path, new_lines.join)
+      end
+
+      # Find the end index of a document (the line index of the next --- or EOF)
+      # @param lines [Array<String>] File lines
+      # @param start_idx [Integer] Starting line index (0-indexed)
+      # @return [Integer] End index (exclusive - the line after the document ends)
+      def self.find_document_end(lines, start_idx)
+        # Start searching from the line after start_idx
+        idx = start_idx + 1
+
+        while idx < lines.length
+          # Check if this line is a document separator
+          return idx if lines[idx].strip == "---"
+
+          idx += 1
+        end
+
+        # No separator found, document goes to EOF
+        lines.length
+      end
+    end
+  end
+end

lib/archsight/resources/base.rb

@@ -25,10 +25,10 @@ def self.relations
 
       # Define an annotation using the Annotation class
       def self.annotation(key, description: nil, filter: nil, title: nil, format: nil, enum: nil, sidebar: true,
-                          type: nil, list: false)
+                          type: nil, list: false, editor: true)
         @annotations ||= []
         options = { description: description, filter: filter, title: title, format: format, enum: enum,
-                    sidebar: sidebar, type: type, list: list }
+                    sidebar: sidebar, type: type, list: list, editor: editor }
         @annotations << Archsight::Annotations::Annotation.new(key, options)
       end
 
@@ -51,15 +51,15 @@ def self.annotations
       # @param list [Boolean] Whether values are lists (default false)
       # @yield Block that computes the annotation value, evaluated in Evaluator context
       def self.computed_annotation(key, description: nil, filter: nil, title: nil, format: nil, enum: nil,
-                                   sidebar: false, type: nil, list: false, &)
+                                   sidebar: false, type: nil, list: false, editor: true, &)
         require_relative "../annotations/computed"
         @computed_annotations ||= []
         @computed_annotations << Archsight::Annotations::Computed.new(key, description: description, type: type, &)
 
         # Also register as a regular annotation so it passes validation and is recognized
         @annotations ||= []
         options = { description: description, filter: filter, title: title, format: format, enum: enum,
-                    sidebar: sidebar, type: type, list: list }
+                    sidebar: sidebar, type: type, list: list, editor: editor }
         @annotations << Archsight::Annotations::Annotation.new(key, options)
       end
 

lib/archsight/web/application.rb

@@ -60,6 +60,7 @@ def configure_environment!(env, logging: nil)
     set :haml, format: :html5
     set :server, :puma
     set :reload_enabled, true
+    set :inline_edit_enabled, false
   end
 
   # MCP Server setup
@@ -97,6 +98,10 @@ def reload_enabled?
       settings.reload_enabled
     end
 
+    def inline_edit_enabled?
+      settings.inline_edit_enabled
+    end
+
     def production?
       settings.environment == :production
     end

lib/archsight/web/editor/routes.rb

@@ -144,6 +144,10 @@ def parse_form_relations(params)
           @klass = Archsight::Resources[@kind]
           halt 404, "Kind not found" unless @klass
 
+          # Get original instance for path_ref (for inline save)
+          original_instance = db.instance_by_kind(@kind, @instance_name)
+          @path_ref = original_instance&.path_ref
+
           @editor_mode = true
           @mode = :edit
           @name = (params["name_field"] || @instance_name).strip
@@ -173,6 +177,39 @@ def parse_form_relations(params)
           haml :index
         end
 
+        # Save YAML to source file (inline edit)
+        post "/api/v1/editor/kinds/:kind/instances/:name/save" do
+          content_type :json
+
+          # Check if inline edit is enabled
+          halt 403, JSON.generate({ success: false, error: "Inline edit is disabled. Start server with --inline-edit flag." }) unless settings.inline_edit_enabled
+
+          kind = params["kind"]
+          name = params["name"]
+
+          begin
+            yaml_content = JSON.parse(request.body.read)["yaml"]
+          rescue JSON::ParserError
+            halt 400, JSON.generate({ success: false, error: "Invalid JSON" })
+          end
+
+          instance = db.instance_by_kind(kind, name)
+          halt 404, JSON.generate({ success: false, error: "Instance not found" }) unless instance
+
+          begin
+            Archsight::Editor::FileWriter.replace_document(
+              path: instance.path_ref.path,
+              start_line: instance.path_ref.line_no,
+              new_yaml: yaml_content
+            )
+            db.reload!
+            JSON.generate({ success: true, message: "Saved to #{instance.path_ref}" })
+          rescue Archsight::Editor::FileWriter::WriteError => e
+            status 400
+            JSON.generate({ success: false, error: e.message })
+          end
+        end
+
         # HTMX API - Get instance names for a kind (for relation dropdown)
         get "/api/v1/editor/kinds/:kind/instances" do
           kind = params["kind"]

lib/archsight/web/public/css/editor.css

@@ -299,30 +299,45 @@
   display: flex;
   justify-content: space-between;
   align-items: center;
-  margin: 0 calc(var(--block-spacing-horizontal) * -1);
-  padding: 1rem var(--block-spacing-horizontal);
   gap: 1rem;
 }
 
+.yaml-file-info,
 .yaml-instructions {
   display: flex;
-  align-items: flex-start;
   gap: 0.5rem;
   margin: 0;
   font-size: 0.9em;
   color: var(--muted-color);
   flex: 1;
+  min-width: 0;
   line-height: 1.5;
 }
 
+.yaml-file-info {
+  align-items: center;
+}
+
+.yaml-instructions {
+  align-items: flex-start;
+}
+
+.yaml-file-info > span,
+.yaml-instructions > span {
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
+.yaml-file-info > i,
 .yaml-instructions > i {
-  line-height: 1.5;
   flex-shrink: 0;
 }
 
 .yaml-actions {
   display: flex;
   gap: 0.5rem;
+  flex-shrink: 0;
 }
 
 .yaml-actions button,