ea 0.3.1 → 0.5.0

data/lib/ea/diagram/display_config.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Ea
+  module Diagram
+    # Models the behavioral display flags from t_diagram.Style and
+    # t_diagram.StyleEx. Controls WHAT is rendered (compartments,
+    # visibility levels, notes) — distinct from Theme which controls
+    # HOW it looks (colors, fonts, stroke widths).
+    #
+    # Style (a.k.a. Style1) carries the per-diagram visibility
+    # toggles set via the "Features" panel:
+    #
+    #   HideAtts=1   → hide attribute compartment
+    #   HideOps=1    → hide operation compartment
+    #   HideStereo=1 → hide stereotype labels
+    #
+    # StyleEx carries extended flags including the theme identifier
+    # and notes/labels visibility:
+    #
+    #   Theme=:119    → theme id (consumed by Ea::Theme::Registry)
+    #   SuppressFOC=1 → suppress foreign object content (images, OLE)
+    #   AttPub=1      → show public attributes
+    #   AttPri=1      → show private attributes
+    #   AttPro=1      → show protected attributes
+    #   ShowNotes=0   → hide element notes
+    #   ShowBorder=1  → render diagram frame
+    #   HideQuals=0   → show qualifier names
+    #   SuppConnLbls=0 → show connector labels
+    #
+    # Usage:
+    #   config = DisplayConfig.from_style(style: diagram.style,
+    #                                      style_ex: diagram.style_ex)
+    #   config.show_attributes?  # → false iff Style has HideAtts=1
+    #
+    class DisplayConfig
+      DEFAULT_SHOW_PUBLIC = "1"
+      DEFAULT_SHOW_PRIVATE = "1"
+      DEFAULT_SHOW_PROTECTED = "1"
+      DEFAULT_SHOW_BORDER = "1"
+      DEFAULT_SUPPRESS_CONN_LABELS = "0"
+      DEFAULT_SHOW_NOTES = "0"
+
+      attr_reader :style_flags, :style_ex_flags
+
+      def initialize(style_flags: {}, style_ex_flags: {})
+        @style_flags = style_flags
+        @style_ex_flags = style_ex_flags
+      end
+
+      # Build a DisplayConfig from the raw Style and StyleEx strings.
+      # Both are optional; missing strings produce an empty flag set.
+      #
+      # @param style [String, nil] t_diagram.Style content
+      # @param style_ex [String, nil] t_diagram.StyleEx content
+      # @return [DisplayConfig]
+      def self.from_style(style:, style_ex:)
+        new(style_flags: parse_flags(style),
+            style_ex_flags: parse_flags(style_ex))
+      end
+
+      # Backwards-compatible single-arg form: treats the argument as
+      # StyleEx. New callers should pass both style: and style_ex:.
+      def self.from_style_ex(style_ex)
+        from_style(style: nil, style_ex: style_ex)
+      end
+
+      # ---- Feature visibility (Style) ----
+
+      def show_attributes?
+        style_flags["HideAtts"] != "1"
+      end
+
+      def show_operations?
+        style_flags["HideOps"] != "1"
+      end
+
+      def show_stereotypes?
+        style_flags["HideStereo"] != "1"
+      end
+
+      # Tagged values compartment. EA defaults to hiding it; the user
+      # explicitly opts in via Style1 ShowTags=1.
+      def show_tagged_values?
+        style_flags["ShowTags"] == "1"
+      end
+
+      # Extended stereotype labels (e.g., profile-specific stereotypes
+      # beyond UML's standard set). EA defaults to showing them.
+      def show_extended_stereotypes?
+        style_flags["HideEStereo"] != "1"
+      end
+
+      # Sequence numbers on elements. EA defaults to hiding them.
+      def show_sequence_numbers?
+        style_flags["ShowSN"] == "1"
+      end
+
+      # Operation parameter type list. When false, EA shows `op()`
+      # instead of `op(name: Type)`. Defaults to true.
+      def show_operation_parameters?
+        style_flags["OpParams"] != "0"
+      end
+
+      # Element Alias instead of Name in the header. Defaults to false
+      # — most diagrams show the Name.
+      def use_alias?
+        style_flags["UseAlias"] == "1"
+      end
+
+      # Connector role/name labels. EA defaults to showing them.
+      def show_connector_names?
+        style_flags["SuppCN"] != "1"
+      end
+
+      # Constraints compartment (OCL invariants). Defaults to false.
+      def show_constraints?
+        style_flags["ShowCons"] == "1"
+      end
+
+      # Page indicator scaling (Print... → Show Page Breaks).
+      def scale_page_indicators?
+        style_flags["ScalePI"] == "1"
+      end
+
+      # ---- Attribute visibility levels (StyleEx) ----
+
+      def show_public_attributes?
+        style_ex_flags.fetch("AttPub", DEFAULT_SHOW_PUBLIC) == "1"
+      end
+
+      def show_private_attributes?
+        style_ex_flags.fetch("AttPri", DEFAULT_SHOW_PRIVATE) == "1"
+      end
+
+      def show_protected_attributes?
+        style_ex_flags.fetch("AttPro", DEFAULT_SHOW_PROTECTED) == "1"
+      end
+
+      # ---- Diagram decorations (StyleEx) ----
+
+      def show_notes?
+        style_ex_flags.fetch("ShowNotes", DEFAULT_SHOW_NOTES) == "1"
+      end
+
+      def show_border?
+        style_ex_flags.fetch("ShowBorder", DEFAULT_SHOW_BORDER) == "1"
+      end
+
+      def show_connector_labels?
+        style_ex_flags.fetch("SuppConnectorLabels",
+                              DEFAULT_SUPPRESS_CONN_LABELS) != "1"
+      end
+
+      def hide_qualifiers?
+        style_ex_flags["HideQuals"] == "1"
+      end
+
+      def suppress_foreign_object_content?
+        style_ex_flags["SuppressFOC"] == "1"
+      end
+
+      # Serialize the union of flags back to a StyleEx-shaped string.
+      # Style and StyleEx are merged because EA serializes them as
+      # one string when round-tripped through some tools.
+      def to_style_ex
+        style_flags.merge(style_ex_flags).map { |k, v| "#{k}=#{v}" }.join(";")
+      end
+
+      # ---- private ----
+
+      def self.parse_flags(raw)
+        return {} if raw.nil? || raw.empty?
+
+        raw.split(";").filter_map do |pair|
+          next nil unless pair.include?("=")
+
+          key, value = pair.split("=", 2)
+          [key, value.to_s] if key && !key.empty?
+        end.to_h
+      end
+      private_class_method :parse_flags
+    end
+  end
+end

data/lib/ea/diagram.rb

@@ -1,47 +1,10 @@
 # frozen_string_literal: true
 
 module Ea
+  # Ea::Diagram holds display-layer helpers shared between sources
+  # and emitters. Distinct from Ea::Svg::EaEmitter which produces
+  # the standalone SVG output.
   module Diagram
-    autoload :SvgRenderer, "ea/diagram/svg_renderer"
-    autoload :LayoutEngine, "ea/diagram/layout_engine"
-    autoload :StyleParser, "ea/diagram/style_parser"
-    autoload :PathBuilder, "ea/diagram/path_builder"
-    autoload :StyleResolver, "ea/diagram/style_resolver"
-    autoload :Configuration, "ea/diagram/configuration"
-    autoload :Util, "ea/diagram/util"
-    autoload :Extractor, "ea/diagram/extractor"
-    autoload :ElementRenderers, "ea/diagram/element_renderers"
-
-    class DiagramRenderer
-      attr_reader :diagram_data, :layout_engine, :style_parser
-
-      def initialize(diagram_data)
-        @diagram_data = diagram_data
-        @layout_engine = LayoutEngine.new
-        @style_parser = StyleParser.new
-      end
-
-      def render_svg(options = {})
-        svg_renderer = SvgRenderer.new(self, options)
-        svg_renderer.render
-      end
-
-      def bounds
-        layout_engine.calculate_bounds(diagram_data)
-      end
-
-      def elements
-        diagram_data[:elements] || []
-      end
-
-      def connectors
-        diagram_data[:connectors] || []
-      end
-    end
-
-    def self.render(diagram_data, options = {})
-      renderer = DiagramRenderer.new(diagram_data)
-      renderer.render_svg(options)
-    end
+    autoload :DisplayConfig, "ea/diagram/display_config"
   end
 end

data/lib/ea/diff/change.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Ea
+  module Diff
+    # One structural change between two EA databases.
+    #
+    # `change` is one of: :added, :removed, :renamed, :modified.
+    # `kind` is the collection name (e.g. :packages, :classes).
+    # `id` is the entity's primary key (string or int).
+    # `name` is a human-readable label for the entity.
+    Change = Struct.new(:change, :kind, :id, :name, :details,
+                        keyword_init: true) do
+      def added?
+        change == :added
+      end
+
+      def removed?
+        change == :removed
+      end
+
+      def renamed?
+        change == :renamed
+      end
+
+      def modified?
+        change == :modified
+      end
+    end
+  end
+end

data/lib/ea/diff/comparator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Ea
+  module Diff
+    # Compares two Ea::Qea::Database instances and produces a list of
+    # structural changes. Identity is keyed by primary-key value within
+    # each collection; renaming surfaces as :removed + :added unless the
+    # name change happens with the same PK (then it's :renamed).
+    #
+    # OCP: new entity types are added by registering a comparator entry
+    # in COLLECTIONS, not by modifying this class.
+    class Comparator
+      attr_reader :old_db, :new_db, :differences
+
+      # Each entry maps a collection name to the attribute used as the
+      # human-readable label. Add new collections here without touching
+      # the diff algorithm.
+      COLLECTIONS = {
+        packages: :name,
+        objects: :name,
+        attributes: :name,
+        operations: :name,
+        connectors: :name,
+        diagrams: :name
+      }.freeze
+
+      def initialize(old_db, new_db)
+        @old_db = old_db
+        @new_db = new_db
+        @differences = []
+        compare_all
+      end
+
+      def identical?
+        @differences.empty?
+      end
+
+      private
+
+      def compare_all
+        COLLECTIONS.each do |collection, label_attr|
+          compare_collection(collection, label_attr)
+        end
+      end
+
+      def compare_collection(name, label_attr)
+        old_records = index_by_id(old_db, name, label_attr)
+        new_records = index_by_id(new_db, name, label_attr)
+
+        old_records.each do |id, old_entry|
+          new_entry = new_records.delete(id)
+          if new_entry.nil?
+            add(:removed, name, id, old_entry[:label])
+          elsif new_entry[:label] != old_entry[:label]
+            add(:renamed, name, id, "#{old_entry[:label]} → #{new_entry[:label]}")
+          end
+        end
+
+        new_records.each_value do |entry|
+          add(:added, name, entry[:id], entry[:label])
+        end
+      end
+
+      def index_by_id(db, collection_name, label_attr)
+        records = db.collections[collection_name] || []
+        records.each_with_object({}) do |record, acc|
+          id = record.public_send(record.class.primary_key_column)
+          next if id.nil?
+
+          acc[id] = {
+            id: id,
+            label: record.public_send(label_attr).to_s
+          }
+        end
+      end
+
+      def add(change, kind, id, name)
+        @differences << Change.new(change: change, kind: kind, id: id, name: name)
+      end
+    end
+  end
+end

data/lib/ea/diff/html_reporter.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Ea
+  module Diff
+    # Renders a Comparator's differences as an HTML report with
+    # color-coded rows. Useful for CI artifacts and PR review.
+    class HtmlReporter
+      attr_reader :comparator
+
+      def initialize(comparator)
+        @comparator = comparator
+      end
+
+      # @return [String] standalone HTML document
+      def render
+        <<~HTML
+          <!DOCTYPE html>
+          <html lang="en">
+          <head>
+            <meta charset="utf-8">
+            <title>EA Diff Report</title>
+            <style>#{css}</style>
+          </head>
+          <body>
+            <h1>EA Diff Report</h1>
+            #{summary_section}
+            #{table_section}
+          </body>
+          </html>
+        HTML
+      end
+
+      private
+
+      def summary_section
+        added = comparator.differences.count(&:added?)
+        removed = comparator.differences.count(&:removed?)
+        renamed = comparator.differences.count(&:renamed?)
+        <<~HTML
+          <section class="summary">
+            <span class="added">+#{added} added</span>
+            <span class="removed">-#{removed} removed</span>
+            <span class="renamed">~#{renamed} renamed</span>
+          </section>
+        HTML
+      end
+
+      def table_section
+        rows = comparator.differences.map do |diff|
+          %(<tr class="#{diff.change}"><td>#{escape(diff.change)}</td>" \
+            "<td>#{escape(diff.kind)}</td><td>#{escape(diff.id)}</td>" \
+            "<td>#{escape(diff.name)}</td></tr>")
+        end.join("\n")
+        <<~HTML
+          <table>
+            <thead><tr><th>Change</th><th>Kind</th><th>ID</th><th>Name</th></tr></thead>
+            <tbody>
+            #{rows}
+            </tbody>
+          </table>
+        HTML
+      end
+
+      def css
+        <<~CSS
+          body { font-family: -apple-system, system-ui, sans-serif; margin: 2em; }
+          table { border-collapse: collapse; width: 100%; }
+          th, td { border: 1px solid #ddd; padding: 0.5em; text-align: left; }
+          tr.added { background: #e6ffe6; }
+          tr.removed { background: #ffe6e6; }
+          tr.renamed { background: #fff9e6; }
+          .summary { margin: 1em 0; }
+          .summary span { padding: 0.25em 0.5em; margin-right: 0.5em; border-radius: 3px; }
+          .added { background: #d4edda; color: #155724; }
+          .removed { background: #f8d7da; color: #721c24; }
+          .renamed { background: #fff3cd; color: #856404; }
+        CSS
+      end
+
+      def escape(text)
+        return "" if text.nil?
+
+        text.to_s
+            .gsub("&", "&amp;")
+            .gsub("<", "&lt;")
+            .gsub(">", "&gt;")
+            .gsub('"', "&quot;")
+      end
+    end
+  end
+end

data/lib/ea/diff.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ea
+  # Structural diff between two EA databases (or pre-parsed models).
+  # Returns a list of `Diff::Change` records describing what was added,
+  # removed, or modified.
+  #
+  # Compares by entity identity (table + primary key) and surfaces
+  # human-readable change descriptions.
+  module Diff
+    autoload :Change, "ea/diff/change"
+    autoload :Comparator, "ea/diff/comparator"
+    autoload :HtmlReporter, "ea/diff/html_reporter"
+  end
+end

data/lib/ea/export/json/generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Ea
+  module Export
+    module Json
+      # Generates a JSON snapshot of a parsed QEA model.
+      # Walks each collection and emits array entries with the row's
+      # lutaml-model hash representation.
+      class Generator
+        def self.call(model, **_opts)
+          new(model).call
+        end
+
+        attr_reader :model
+
+        def initialize(model)
+          @model = model
+        end
+
+        def call
+          JSON.pretty_generate(document_hash)
+        end
+
+        private
+
+        def document_hash
+          model.collections.each_with_object({}) do |(name, records), acc|
+            acc[name] = records.map { |r| record_hash(r) }
+          end
+        end
+
+        def record_hash(record)
+          hash = record.to_hash
+          hash["record_type"] = record.class.name.split("::").last
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/ea/export/json.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ea
+  module Export
+    # JSON serialization namespace. Produces a JSON document of the
+    # model's collections, suitable for downstream tools (web apps,
+    # diff tools, etc.).
+    module Json
+      autoload :Generator, "ea/export/json/generator"
+    end
+  end
+end

data/lib/ea/export/json_schema/generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Ea
+  module Export
+    module JsonSchema
+      # Generates a JSON Schema (draft 2020-12) document from a
+      # parsed QEA model. Each UML Class becomes a `$defs` entry
+      # with `properties` derived from its attributes.
+      class Generator
+        SCHEMA_URI = "https://json-schema.org/draft/2020-12/schema".freeze
+
+        # EA primitive → JSON Schema type
+        TYPE_MAP = {
+          "int" => "integer", "Integer" => "integer",
+          "long" => "integer", "Long" => "integer",
+          "double" => "number", "Double" => "number",
+          "float" => "number", "Float" => "number",
+          "boolean" => "boolean", "Boolean" => "boolean",
+          "String" => "string", "string" => "string",
+          "char" => "string", "Character" => "string",
+          "Date" => "string", "DateTime" => "string"
+        }.freeze
+
+        def self.call(model, **_opts)
+          new(model).call
+        end
+
+        attr_reader :model
+
+        def initialize(model)
+          @model = model
+        end
+
+        def call
+          classes = (model.collections[:objects] || [])
+                     .select { |o| o.object_type == "Class" }
+          defs = classes.each_with_object({}) do |klass, acc|
+            acc[klass.name] = class_schema(klass)
+          end
+
+          {
+            "$schema" => SCHEMA_URI,
+            "$id" => "https://example.com/schema.json",
+            "type" => "object",
+            "$defs" => defs
+          }.to_json
+        end
+
+        private
+
+        def class_schema(klass)
+          attrs = attribute_map[klass.object_id] || []
+          {
+            "type" => "object",
+            "title" => klass.name,
+            "properties" => attrs.each_with_object({}) do |a, props|
+              props[a.name] = { "type" => json_type(a.type) }
+            end
+          }
+        end
+
+        def json_type(ea_type)
+          TYPE_MAP[ea_type] || "string"
+        end
+
+        def attribute_map
+          @attribute_map ||= begin
+            attrs = model.collections[:attributes] || []
+            attrs.group_by(&:object_id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ea/export/json_schema.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Ea
+  module Export
+    # JSON Schema (draft 2020-12) export namespace.
+    module JsonSchema
+      autoload :Generator, "ea/export/json_schema/generator"
+    end
+  end
+end

data/lib/ea/export/plantuml/generator.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Ea
+  module Export
+    module PlantUml
+      # Generates PlantUML class diagram text from a parsed QEA model.
+      #
+      # Example output:
+      #   @startuml
+      #   class Person {
+      #     +name: String
+      #     +age: Integer
+      #   }
+      #   Person "1" --> "0..*" Address : lives_at
+      #   @enduml
+      class Generator
+        def self.call(model, **_opts)
+          new(model).call
+        end
+
+        attr_reader :model
+
+        def initialize(model)
+          @model = model
+        end
+
+        def call
+          lines = ["@startuml"]
+          lines.concat(class_lines)
+          lines.concat(connector_lines)
+          lines << "@enduml"
+          lines.join("\n") + "\n"
+        end
+
+        private
+
+        def class_lines
+          classes.map do |klass|
+            attrs = class_attributes(klass)
+            body = attrs.map { |a| "  +#{a.name}: #{a.type || 'String'}" }
+            ["class #{klass.name} {", *body, "}"].join("\n")
+          end
+        end
+
+        def connector_lines
+          (model.collections[:connectors] || []).map do |conn|
+            source_obj = find_object(conn.start_object_id)
+            target_obj = find_object(conn.end_object_id)
+            next nil unless source_obj && target_obj
+
+            label = conn.name ? " : #{conn.name}" : ""
+            %Q{#{source_obj.name} --> #{target_obj.name}#{label}}
+          end.compact
+        end
+
+        def classes
+          (model.collections[:objects] || [])
+            .select { |o| o.object_type == "Class" }
+        end
+
+        def class_attributes(klass)
+          attrs = model.collections[:attributes] || []
+          attrs.select { |a| a.object_id == klass.object_id }
+        end
+
+        def find_object(object_id)
+          (model.collections[:objects] || [])
+            .find { |o| o.object_id == object_id }
+        end
+      end
+    end
+  end
+end

data/lib/ea/export/plantuml.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ea
+  module Export
+    # PlantUML text-format exporter. Produces a `.puml` file
+    # documenting the model's classes, attributes, and relationships
+    # in PlantUML syntax (rendered by plantuml.com/plantuml).
+    module PlantUml
+      autoload :Generator, "ea/export/plantuml/generator"
+    end
+  end
+end