archsight 0.1.4 → 0.1.5

data/chart/archsight/values.yaml

@@ -0,0 +1,162 @@
+replicaCount: 1
+
+image:
+  repository: ghcr.io/ionos-cloud/archsight
+  pullPolicy: IfNotPresent
+  # Overrides the image tag whose default is the chart appVersion.
+  tag: ""
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+
+podAnnotations: {}
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+service:
+  type: ClusterIP
+  port: 80
+  targetPort: 4567
+
+ingress:
+  enabled: false
+  className: ""
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  hosts:
+    - host: chart-example.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
+resources: {}
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 100
+  targetCPUUtilizationPercentage: 80
+  # targetMemoryUtilizationPercentage: 80
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}
+
+# Application specific configuration
+app:
+  resourcesDir: /resources
+  env: production
+
+# Strategy for populating the /resources directory
+# Options are "emptyDir", "configMap", "persistence" (PVC), or usage of "extraVolumes"
+content:
+  # type: "emptyDir" | "configMap" | "persistence" | "custom"
+  # - emptyDir: Simple, ephemeral. Good if using initContainers to fetch data.
+  # - configMap: Mounts a ConfigMap. Good for small, static datasets.
+  # - persistence: Mounts a PersistentVolumeClaim. Good for large datasets.
+  # - custom: Do not create the main volume automatically; rely on extraVolumes/extraVolumeMounts.
+  type: emptyDir
+
+  configMap:
+    # If true, creating a ConfigMap from the `data` below.
+    create: false
+    # Name of the ConfigMap to mount (if create: false) or create (if create: true)
+    # If create: true and name is empty, fullname + "-resources" is used.
+    name: ""
+    # Data to inject into the ConfigMap (filename: content)
+    data:
+      # sample.yaml: |
+      #   apiVersion: architecture/v1alpha1
+      #   kind: Analysis
+      #   ...
+      {}
+
+  persistence:
+    enabled: false
+    # existingClaim: my-claim
+    storageClass: ""
+    accessModes:
+      - ReadWriteOnce
+    size: 1Gi
+    annotations: {}
+
+# Add sidecars or initContainers (e.g., for git-sync)
+initContainers: []
+  # Example: Fetching from a private repository using a specific Secret
+  # - name: git-sync
+  #   image: alpine/git
+  #   env:
+  #     - name: GIT_TOKEN
+  #       valueFrom:
+  #         secretKeyRef:
+  #           name: my-git-credentials
+  #           key: token
+  #   command: ["/bin/sh", "-c"]
+  #   args:
+  #     - "git clone https://oauth2:$GIT_TOKEN@github.com/my-org/my-private-repo.git /resources"
+  #   volumeMounts:
+  #     - name: resources
+  #       mountPath: /resources
+
+sidecars: []
+  # Example: Periodically update resources from a private repository
+  # - name: git-sync-private
+  #   image: alpine/git
+  #   env:
+  #     - name: GIT_TOKEN
+  #       valueFrom:
+  #         secretKeyRef:
+  #           name: my-git-credentials
+  #           key: token
+  #   command: ["/bin/sh", "-c"]
+  #   args:
+  #     - |
+  #       cd /resources
+  #       # Ensure the remote uses the current token
+  #       git remote set-url origin "https://oauth2:${GIT_TOKEN}@github.com/my-org/my-private-repo.git"
+  #       while true; do
+  #         git pull
+  #         sleep 60
+  #       done
+  #   volumeMounts:
+  #     - name: resources
+  #       mountPath: /resources
+
+# Custom volumes and mounts if you need more control
+extraVolumes: []
+extraVolumeMounts: []
+
+# Command arguments (passed to ENTRYPOINT ["archsight"])
+args: ["web", "--port", "4567", "-H", "0.0.0.0", "--production"]

data/lib/archsight/analysis/executor.rb

@@ -79,9 +79,6 @@ module Archsight
         # Filter by name pattern if provided
         analyses = analyses.select { |a| filter.match?(a.name) } if filter
 
-        # Filter to enabled analyses
-        analyses = analyses.select { |a| analysis_enabled?(a) }
-
         analyses.map { |analysis| execute(analysis) }
       end
 
@@ -100,13 +97,6 @@ module Archsight
 
         DEFAULT_TIMEOUT
       end
-
-      # Check if analysis is enabled
-      # @param analysis [Object] Analysis instance
-      # @return [Boolean] true if enabled
-      def analysis_enabled?(analysis)
-        analysis.annotations["analysis/enabled"] != "false"
-      end
     end
   end
 end

data/lib/archsight/annotations/annotation.rb

@@ -4,7 +4,7 @@ require_relative "email_recipient"
 
 # 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 @@ class Archsight::Annotations::Annotation
     @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
@@ -80,43 +81,12 @@ class Archsight::Annotations::Annotation
 
   # Validate a value and return array of error messages (empty if valid)
   def validate(value)
-    errors = []
+    errors = [] #: Array[String]
     return errors if value.nil?
 
-    # Check enum constraint
-    if @enum
-      values = list? ? value.to_s.split(",").map(&:strip) : [value.to_s]
-      invalid_values = values.reject { |v| @enum.include?(v) }
-      invalid_values.each do |v|
-        errors << "invalid value '#{v}'. Expected one of: #{@enum.join(", ")}"
-      end
-    end
-
-    # Check type constraint
-    if @type.is_a?(Class) && errors.empty?
-      values_to_check = list? ? value.to_s.split(/,|\n/).map(&:strip).reject(&:empty?) : [value.to_s]
-
-      values_to_check.each do |string_value|
-        valid = case @type.to_s
-                when "Integer"
-                  string_value.match?(/\A-?\d+\z/)
-                when "Float"
-                  string_value.match?(/\A-?\d+(\.\d+)?\z/)
-                when "URI"
-                  begin
-                    URI.parse(string_value)
-                    string_value.match?(%r{\Ahttps?://})
-                  rescue URI::InvalidURIError
-                    false
-                  end
-                when "Archsight::Annotations::EmailRecipient"
-                  Archsight::Annotations::EmailRecipient.valid?(string_value)
-                else
-                  true
-                end
-        errors << "invalid value '#{string_value}'. #{type_error_message}" unless valid
-      end
-    end
+    validate_enum(value, errors)
+    validate_type(value, errors) if errors.empty?
+    validate_code(value, errors) if errors.empty?
 
     errors
   end
@@ -130,6 +100,18 @@ class Archsight::Annotations::Annotation
     @format == :markdown
   end
 
+  def code?
+    @format == :ruby
+  end
+
+  def multiline?
+    @format == :multiline
+  end
+
+  def code_language
+    @format if code?
+  end
+
   # Example value for templates
   def example_value
     if @enum
@@ -155,6 +137,49 @@ class Archsight::Annotations::Annotation
     end
   end
 
+  def validate_enum(value, errors)
+    return unless @enum
+
+    values = list? ? value.to_s.split(",").map(&:strip) : [value.to_s]
+    invalid_values = values.reject { |v| @enum.include?(v) }
+    invalid_values.each do |v|
+      errors << "invalid value '#{v}'. Expected one of: #{@enum.join(", ")}"
+    end
+  end
+
+  def validate_type(value, errors)
+    return unless @type.is_a?(Class)
+
+    values_to_check = list? ? value.to_s.split(/,|\n/).map(&:strip).reject(&:empty?) : [value.to_s]
+    values_to_check.each do |string_value|
+      errors << "invalid value '#{string_value}'. #{type_error_message}" unless valid_type_value?(string_value)
+    end
+  end
+
+  def valid_type_value?(string_value)
+    case @type.to_s
+    when "Integer" then string_value.match?(/\A-?\d+\z/)
+    when "Float" then string_value.match?(/\A-?\d+(\.\d+)?\z/)
+    when "URI" then valid_uri?(string_value)
+    when "Archsight::Annotations::EmailRecipient" then Archsight::Annotations::EmailRecipient.valid?(string_value)
+    else true
+    end
+  end
+
+  def valid_uri?(string_value)
+    URI.parse(string_value)
+    string_value.match?(%r{\Ahttps?://})
+  rescue URI::InvalidURIError
+    false
+  end
+
+  def validate_code(value, errors)
+    return unless code? && !value.to_s.strip.empty?
+
+    syntax_error = validate_code_syntax(value.to_s)
+    errors << syntax_error if syntax_error
+  end
+
   def derive_format
     case @filter
     when :word then :tag_word
@@ -165,4 +190,28 @@ class Archsight::Annotations::Annotation
   def build_regex
     Regexp.new("^#{Regexp.escape(key).gsub('\*', ".+")}$")
   end
+
+  # Validate code syntax based on format
+  # @param code [String] The code to validate
+  # @return [String, nil] Error message or nil if valid
+  def validate_code_syntax(code)
+    case @format
+    when :ruby
+      validate_ruby_syntax(code)
+    end
+  end
+
+  # Validate Ruby syntax using RubyVM
+  # @param code [String] Ruby code to validate
+  # @return [String, nil] Error message or nil if valid
+  def validate_ruby_syntax(code)
+    # steep:ignore:start
+    RubyVM::InstructionSequence.compile(code)
+    # steep:ignore:end
+    nil
+  rescue SyntaxError => e
+    # Extract just the error message without the full backtrace
+    message = e.message.lines.first&.strip || "Syntax error"
+    "Ruby syntax error: #{message}"
+  end
 end

data/lib/archsight/annotations/architecture_annotations.rb

@@ -9,12 +9,8 @@ module Archsight::Annotations::Architecture
       annotation "architecture/abbr",
                  description: "Abbreviation or short name",
                  title: "Abbreviation"
-      annotation "architecture/evidence",
-                 description: "Supporting evidence or notes",
-                 title: "Evidence",
-                 format: :markdown
       annotation "architecture/description",
-                 description: "Textual description of the interface",
+                 description: "Textual description of the resource",
                  title: "Description",
                  format: :markdown
       annotation "architecture/documentation",
@@ -25,35 +21,6 @@ module Archsight::Annotations::Architecture
                  description: "Comma-separated tags",
                  filter: :list,
                  title: "Tags"
-      annotation "architecture/encoding",
-                 description: "Data encoding format",
-                 filter: :list,
-                 title: "Encoding"
-      annotation "architecture/title",
-                 description: "Interface title",
-                 title: "Title"
-      annotation "architecture/openapi",
-                 description: "OpenAPI specification version",
-                 filter: :word,
-                 title: "OpenAPI"
-      annotation "architecture/version",
-                 description: "API or interface version",
-                 filter: :word,
-                 title: "Version",
-                 sidebar: false
-      annotation "architecture/status",
-                 description: "Lifecycle status (General-Availability, Early-Access, Development)",
-                 filter: :word,
-                 title: "Status"
-      annotation "architecture/visibility",
-                 description: "API visibility (public, private, internal)",
-                 filter: :word,
-                 enum: %w[public private internal],
-                 title: "Visibility"
-      annotation "architecture/applicationSets",
-                 description: "Related ArgoCD ApplicationSets",
-                 title: "ApplicationSets",
-                 format: :markdown
     end
   end
 end

data/lib/archsight/annotations/computed.rb

@@ -212,7 +212,7 @@ class Archsight::Annotations::ComputedManager
     @computing.add(cache_key)
     begin
       evaluator = Archsight::Annotations::ComputedEvaluator.new(instance, @database, self)
-      value = evaluator.instance_eval(&definition.block)
+      value = evaluator.instance_eval(&definition.block) # steep:ignore BlockTypeMismatch
 
       # Apply type coercion if specified
       value = coerce_value(value, definition.type) if definition.type

data/lib/archsight/annotations/generated_annotations.rb

@@ -7,15 +7,18 @@ module Archsight::Annotations::Generated
       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

data/lib/archsight/annotations/git_annotations.rb

@@ -6,16 +6,20 @@ module Archsight::Annotations::Git
     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

data/lib/archsight/annotations/interface_annotations.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Interface module adds interface-specific annotations to resource classes
+module Archsight::Annotations::Interface
+  def self.included(base)
+    base.class_eval do
+      annotation "architecture/encoding",
+                 description: "Data encoding format",
+                 filter: :list,
+                 title: "Encoding"
+      annotation "architecture/title",
+                 description: "Interface title",
+                 title: "Title"
+      annotation "architecture/openapi",
+                 description: "OpenAPI specification version",
+                 filter: :word,
+                 title: "OpenAPI"
+      annotation "architecture/version",
+                 description: "API or interface version",
+                 filter: :word,
+                 title: "Version",
+                 sidebar: false
+      annotation "architecture/status",
+                 description: "Lifecycle status",
+                 filter: :word,
+                 enum: %w[General-Availability Early-Access Development],
+                 title: "Status"
+      annotation "architecture/visibility",
+                 description: "API visibility (public, private, internal)",
+                 filter: :word,
+                 enum: %w[public private internal],
+                 title: "Visibility"
+    end
+  end
+end

data/lib/archsight/cli.rb

@@ -19,6 +19,7 @@ module Archsight
     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"
@@ -26,6 +27,7 @@ module Archsight
       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
@@ -191,7 +193,7 @@ module Archsight
     def filter_analyses(db)
       analyses = db.instances_by_kind("Analysis").values
       analyses = analyses.select { |a| Regexp.new(options[:filter], Regexp::IGNORECASE).match?(a.name) } if options[:filter]
-      analyses.reject { |a| a.annotations["analysis/enabled"] == "false" }
+      analyses
     end
 
     def print_analysis_dry_run(analyses)

data/lib/archsight/editor/content_hasher.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Archsight
+  module Editor
+    # ContentHasher generates SHA256 hashes for optimistic locking
+    module ContentHasher
+      module_function
+
+      # Generate a hash of YAML content for comparison
+      # Normalizes line endings before hashing to ensure consistency across platforms
+      # @param content [String] YAML content
+      # @return [String] 16-character hex hash
+      def hash(content)
+        normalized = content.gsub("\r\n", "\n").gsub("\r", "\n")
+        Digest::SHA256.hexdigest(normalized)[0, 16]
+      end
+
+      # Validate that content hasn't changed since expected_hash was computed
+      # @param path [String] File path
+      # @param start_line [Integer] Line number where document starts
+      # @param expected_hash [String, nil] Expected content hash
+      # @return [Hash, nil] Error hash with :conflict and :error keys, or nil if valid
+      def validate(path:, start_line:, expected_hash:)
+        return nil unless expected_hash
+
+        current_content = FileWriter.read_document(path: path, start_line: start_line)
+        current_hash = hash(current_content)
+
+        return nil if current_hash == expected_hash
+
+        { conflict: true, error: "Conflict: The resource has been modified. Please reload the page and try again." }
+      end
+    end
+  end
+end

data/lib/archsight/editor/file_writer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Archsight
+  module Editor
+    # FileWriter handles reading and writing YAML documents in multi-document files
+    module FileWriter
+      class WriteError < StandardError; end
+
+      module_function
+
+      # Read a YAML document from a file starting at a given line
+      # @param path [String] File path
+      # @param start_line [Integer] Line number where document starts (1-indexed)
+      # @return [String] Document content
+      # @raise [WriteError] if file not found or line out of bounds
+      def read_document(path:, start_line:)
+        raise WriteError, "File not found: #{path}" unless File.exist?(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)
+
+        # Extract and join the document lines
+        lines[start_idx...end_idx].join
+      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 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 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