aa2img 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cffb5142c6353b13b54d484e6879b928bf2618ca9b48263506dfec84d9addacd
+  data.tar.gz: 9309a77b67f39e24c44b42243ee9b057132527fae99e3a86a8131d2de6df1383
+SHA512:
+  metadata.gz: 4260c2b672c7f533008bb53bc016e1420392e80adef03bcdc63cff64688e326dee7ea3bce363991e0b8a402ce9ea3ccf3e8005ff9bf5e3f959c377faaa340cc1
+  data.tar.gz: 0f6d68dd8ce1f000f56925606ca9c83fe67debaff6dcfb8ef05750942060c8f19ab9c03e526370bdd61dcdd8f70f73884a0a47db65bcd205ac0a2a9bb02d5326

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.1.0 (2026-02-07)
+
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,247 @@
+<h1 align="center">aa2img</h1>
+<p align="center">
+  <strong>Convert ASCII/Unicode diagrams into clean SVG and PNG images</strong>
+</p>
+<p align="center">
+  <img src="https://img.shields.io/badge/ruby-%3E%3D%203.2-red.svg" alt="Ruby 3.2+">
+  <img src="https://img.shields.io/badge/output-SVG%20%2F%20PNG-2f855a.svg" alt="Output SVG/PNG">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License MIT">
+  <a href="https://github.com/ydah/aa2img/actions/workflows/main.yml">
+    <img src="https://github.com/ydah/aa2img/actions/workflows/main.yml/badge.svg" alt="CI">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#diagram-syntax">Diagram Syntax</a> •
+  <a href="#themes">Themes</a>
+</p>
+
+---
+
+`aa2img` parses text-based box diagrams and renders them as themed images.
+It is useful for docs, README files, and architecture notes where you want to keep diagrams editable as plain text.
+
+## Features
+
+- Parses both Unicode and ASCII box-drawing styles (`┌─┐ │ └─┘` and `+--+ |  | +--+`)
+- Detects section separators (`├──┤`) inside boxes
+- Detects nested parent-child box structures
+- Renders right-side annotations in `← note` format
+- Handles full-width characters, including Japanese labels
+- Supports `SVG` and `PNG` output
+- Ships with 4 built-in themes: `default`, `blueprint`, `monochrome`, `modern`
+- Supports vertical label alignment: `top`, `center`, `bottom`
+
+## Installation
+
+### Requirements
+
+- Ruby `3.2+`
+- ImageMagick (required only for PNG output)
+
+```bash
+# macOS
+brew install imagemagick
+
+# Ubuntu / Debian
+sudo apt install imagemagick
+```
+
+### Add to Gemfile
+
+```ruby
+gem "aa2img", github: "ydah/aa2img"
+```
+
+After the gem is published to RubyGems, you can also install it with:
+
+```bash
+gem install aa2img
+```
+
+## Usage
+
+### Quick Start (CLI)
+
+1. Create a text diagram file:
+
+```txt
+┌────────────────────────────┐
+│        API Gateway         │
+├────────────────────────────┤
+│        Application         │
+│  ┌──────────────────────┐  │
+│  │       Database       │  │
+│  └──────────────────────┘  │
+└────────────────────────────┘
+```
+
+2. Convert to SVG:
+
+```bash
+aa2img convert diagram.txt output.svg
+```
+
+3. Convert to PNG:
+
+```bash
+aa2img convert diagram.txt output.png --scale 3
+```
+
+### Commands
+
+| Command | Description |
+|---|---|
+| `aa2img convert INPUT_FILE OUTPUT_FILE` | Convert text diagram to image (format inferred from extension) |
+| `aa2img themes` | List available themes |
+| `aa2img preview INPUT_FILE` | Show parsed AST tree for debugging |
+| `aa2img version` | Show version |
+
+### `convert` Options
+
+| Option | Description |
+|---|---|
+| `--theme NAME_OR_PATH` | Built-in theme name (`default`, `blueprint`, `monochrome`, `modern`) or YAML file path |
+| `--scale N` | Scale factor for PNG output (default: `2`) |
+| `--valign POS` | Vertical label alignment (`top`, `center`, `bottom`) |
+
+Notes:
+- Use `-` as `INPUT_FILE` to read from stdin.
+- Output format is inferred from `OUTPUT_FILE` extension (`.svg` or `.png`).
+
+```bash
+# Read from stdin
+cat diagram.txt | aa2img convert - output.svg
+
+# Use blueprint theme
+aa2img convert diagram.txt blueprint.svg --theme blueprint
+
+# Use custom theme file
+aa2img convert diagram.txt custom.svg --theme ./themes/my-theme.yml
+
+# Center label alignment
+aa2img convert diagram.txt centered.svg --valign center
+```
+
+### Ruby API
+
+```ruby
+require "aa2img"
+
+aa = <<~AA
+  ┌──────┐
+  │ Test │
+  └──────┘
+AA
+
+# Get SVG string
+svg = AA2img.convert(aa, format: :svg, theme: "default", valign: :center)
+
+# Write to file (format inferred from extension)
+AA2img.convert_to_file(aa, "diagram.png", theme: "monochrome", scale: 2, valign: :top)
+```
+
+## Diagram Syntax
+
+### Basic Boxes
+
+Unicode:
+
+```txt
+┌──────┐
+│ API  │
+└──────┘
+```
+
+ASCII:
+
+```txt
++------+
+| API  |
++------+
+```
+
+### Sectioned Boxes
+
+```txt
+┌────────────────┐
+│ Presentation   │
+├────────────────┤
+│ Application    │
+├────────────────┤
+│ Infrastructure │
+└────────────────┘
+```
+
+### Annotations
+
+```txt
+┌──────────┐  ← user input
+│  REPL    │
+└──────────┘
+```
+
+## Themes
+
+Built-in themes:
+
+- `default`: balanced light theme
+- `blueprint`: deep-blue blueprint-like style
+- `monochrome`: print-friendly grayscale style
+- `modern`: clean, rounded, modern UI style
+
+```bash
+aa2img themes
+```
+
+CLI also accepts a YAML path for custom themes:
+
+```bash
+aa2img convert diagram.txt output.svg --theme ./themes/my-theme.yml
+```
+
+You can also pass a custom theme hash from Ruby:
+
+```ruby
+custom_theme = {
+  "background_color" => "#ffffff",
+  "box_fill" => "#f8fafc",
+  "box_stroke" => "#334155",
+  "text_color" => "#0f172a",
+  "font_family" => "'Noto Sans JP', sans-serif"
+}
+
+svg = AA2img.convert(aa, format: :svg, theme: custom_theme)
+```
+
+## Notes
+
+- Current parser behavior is optimized for box/layer diagrams.
+- Annotation detection currently supports right-side `←` markers.
+- `preview --format` is reserved for future expansion; current output is tree-style.
+
+## Development
+
+```bash
+git clone https://github.com/ydah/aa2img.git
+cd aa2img
+bin/setup
+bundle exec rspec
+```
+
+Run the example script:
+
+```bash
+bundle exec ruby examples/basic_usage.rb
+```
+
+## Contributing
+
+Issues and pull requests are welcome at `https://github.com/ydah/aa2img`.
+
+## License
+
+[MIT License](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/examples/basic_usage.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "aa2img"
+
+aa_text = <<~'AA'
+┌─────────────────────────────────────┐
+│            REPL (UI)                │
+├─────────────────────────────────────┤
+│         Command Parser              │
+├─────────────────────────────────────┤
+│           Database                  │
+│  ┌─────────────────────────────┐    │
+│  │       StringHashMap         │    │
+│  └─────────────────────────────┘    │
+└─────────────────────────────────────┘
+AA
+
+svg = AA2img.convert(aa_text, format: :svg, valign: :center, theme: :modern)
+File.write("output.svg", svg)
+puts "Generated output.svg"

data/examples/sample_diagrams/architecture.txt

@@ -0,0 +1,10 @@
+┌─────────────────────────────────────┐
+│            REPL (UI)                │  ← ユーザーとの対話
+├─────────────────────────────────────┤
+│         Command Parser              │  ← コマンド解析
+├─────────────────────────────────────┤
+│           Database                  │  ← コア機能
+│  ┌─────────────────────────────┐    │
+│  │       StringHashMap         │    │  ← データ保存
+│  └─────────────────────────────┘    │
+└─────────────────────────────────────┘

data/examples/sample_diagrams/flowchart.txt

@@ -0,0 +1,3 @@
+┌──────┐     ┌──────┐     ┌──────┐
+│Start │---->│Process│---->│ End  │
+└──────┘     └──────┘     └──────┘

data/exe/aa2img

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "aa2img"
+
+AA2img::CLI.start(ARGV)

data/lib/aa2img/ast/annotation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class Annotation < BaseElement
+      attr_accessor :text, :row, :arrow_col
+    end
+  end
+end

data/lib/aa2img/ast/base_element.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class BaseElement
+      def initialize(**attrs)
+        attrs.each do |key, value|
+          send(:"#{key}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/aa2img/ast/box.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class Box < BaseElement
+      attr_accessor :top, :left, :bottom, :right
+      attr_accessor :sections, :children, :labels, :annotations
+
+      def initialize(**attrs)
+        @sections = []
+        @children = []
+        @labels = []
+        @annotations = []
+        super
+      end
+
+      def area
+        (bottom - top) * (right - left)
+      end
+
+      def contains?(other)
+        top < other.top && bottom > other.bottom &&
+          left < other.left && right > other.right
+      end
+
+      def add_child(child)
+        @children << child
+      end
+
+      def all_labels
+        own = labels || []
+        from_sections = (sections || []).flat_map { |s| s.labels || [] }
+        own + from_sections
+      end
+
+      def all_annotations
+        own = annotations || []
+        from_sections = (sections || []).flat_map { |s| s.annotation ? [s.annotation] : [] }
+        own + from_sections
+      end
+    end
+  end
+end

data/lib/aa2img/ast/edge.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class Edge < BaseElement
+      attr_accessor :from, :to, :style, :arrow
+
+      def initialize(**attrs)
+        @style = :solid
+        @arrow = :none
+        super
+      end
+    end
+  end
+end

data/lib/aa2img/ast/label.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class Label < BaseElement
+      attr_accessor :text, :row, :col, :align
+
+      def initialize(**attrs)
+        @align = :center
+        super
+      end
+    end
+  end
+end

data/lib/aa2img/ast/scene.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class Scene
+      attr_accessor :elements, :width, :height
+
+      def initialize
+        @elements = []
+        @width = 0
+        @height = 0
+      end
+
+      def boxes
+        elements.select { |e| e.is_a?(Box) }
+      end
+
+      def edges
+        elements.select { |e| e.is_a?(Edge) }
+      end
+
+      def all_boxes
+        result = []
+        boxes.each do |box|
+          result << box
+          result.concat(collect_nested_boxes(box))
+        end
+        result
+      end
+
+      def to_tree_string(indent = 0)
+        lines = []
+        prefix = "  " * indent
+        lines << "#{prefix}Scene (width: #{width}, height: #{height})"
+        elements.each do |el|
+          lines << element_to_tree(el, indent + 1)
+        end
+        lines.join("\n")
+      end
+
+      private
+
+      def collect_nested_boxes(box)
+        result = []
+        (box.children || []).each do |child|
+          result << child
+          result.concat(collect_nested_boxes(child))
+        end
+        result
+      end
+
+      def element_to_tree(el, indent)
+        prefix = "  " * indent
+        case el
+        when Box
+          box_to_tree(el, indent)
+        when Edge
+          "#{prefix}Edge #{el.from} -> #{el.to} (#{el.style}, #{el.arrow})"
+        else
+          "#{prefix}#{el.class.name}"
+        end
+      end
+
+      def box_to_tree(box, indent)
+        prefix = "  " * indent
+        lines = ["#{prefix}└── Box (#{box.top},#{box.left})-(#{box.bottom},#{box.right})"]
+        (box.sections || []).each_with_index do |section, i|
+          section_labels = (section.labels || []).map(&:text).join(", ")
+          ann_text = section.annotation ? " + annotation \"#{section.annotation.text}\"" : ""
+          lines << "#{prefix}    ├── Section[#{i}] (row #{section.top}..#{section.bottom}): \"#{section_labels}\"#{ann_text}"
+        end
+        (box.children || []).each do |child|
+          lines << box_to_tree(child, indent + 2)
+        end
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/aa2img/ast/section.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AA2img
+  module AST
+    class Section < BaseElement
+      attr_accessor :top, :bottom
+      attr_accessor :labels, :annotation
+
+      def initialize(**attrs)
+        @labels = []
+        @annotation = nil
+        super
+      end
+    end
+  end
+end

data/lib/aa2img/char_width.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "unicode/display_width"
+
+module AA2img
+  module CharWidth
+    def self.width(char)
+      Unicode::DisplayWidth.of(char)
+    end
+
+    def self.wide?(char)
+      width(char) > 1
+    end
+  end
+end

data/lib/aa2img/cli.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module AA2img
+  class CLI < Thor
+    desc "convert INPUT_FILE OUTPUT_FILE", "Convert AA text file to image"
+    option :theme, type: :string, default: "default", desc: "Theme name or YAML path"
+    option :scale, type: :numeric, default: 2, desc: "PNG scale factor"
+    option :valign, type: :string, default: "top", desc: "Vertical text alignment (top / center / bottom)"
+    def convert(input_file, output_file)
+      text = if input_file == "-"
+               $stdin.read
+             else
+               File.read(input_file)
+             end
+      AA2img.convert_to_file(text, output_file,
+                             theme: options[:theme],
+                             scale: options[:scale],
+                             valign: options[:valign].to_sym)
+      puts "✓ #{output_file} generated"
+    end
+
+    desc "themes", "List available themes"
+    def themes
+      Theme.available.each { |t| puts "  - #{t}" }
+    end
+
+    desc "preview INPUT_FILE", "Parse AA and display AST (debug)"
+    option :format, type: :string, default: "tree", desc: "Output format (tree / json)"
+    def preview(input_file)
+      text = File.read(input_file)
+      grid = Grid.new(text)
+      parser = AA2img::Parser::Orchestrator.new(grid)
+      scene = parser.parse
+      puts scene.to_tree_string
+    end
+
+    desc "version", "Show version"
+    def version
+      puts "aa2img #{AA2img::VERSION}"
+    end
+  end
+end

data/lib/aa2img/grid.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "unicode/display_width"
+
+module AA2img
+  class Grid
+    attr_reader :rows, :width, :height
+
+    def initialize(text)
+      lines = text.lines.map(&:chomp)
+      @height = lines.size
+      @rows = lines.map { |line| normalize_line(line) }
+      @width = @rows.map(&:size).max || 0
+      @rows.each { |row| row.fill(" ", row.size...@width) }
+    end
+
+    def at(row, col)
+      return nil if row < 0 || row >= @height || col < 0 || col >= @width
+
+      @rows[row][col]
+    end
+
+    private
+
+    def normalize_line(line)
+      cells = []
+      line.each_char do |ch|
+        w = Unicode::DisplayWidth.of(ch)
+        cells << ch
+        (w - 1).times { cells << :wide_placeholder }
+      end
+      cells
+    end
+  end
+end