archsight 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 637000840e445d9e4582fde99804c50b034adb6696235d957078a5ad40ecfdfb
+  data.tar.gz: 69b13da005d885a1ee2424b37e6d8668bd775e9affff6960a221bd283a33693a
+SHA512:
+  metadata.gz: ca3fd8eb1b454d6db4c82904ebea6753c9404186f0e8fd26a3fd90c1b7d10e0037062c16f40057d403467ea1235e9d981c1ae10feb9182c33c2a74c72f0b6b15
+  data.tar.gz: 85719b9c9f422871c3d96250d276341f7566f53cc24193efdfa8ce3a29ee92c45d674965340e99835eb3c940acecfb947c57f0560ddea28ec2135f020d52aa6d

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-01-07
+
+Initial release. Extracted from internal architecture tooling.
+
+### Features
+
+- **Resource Modeling**: 20+ ArchiMate-inspired resource types (TechnologyArtifact, ApplicationComponent, ApplicationInterface, BusinessRequirement, etc.)
+- **Query Language**: Full-featured query DSL with operators (==, !=, =~, >, <), relation queries (->/<-/~>/<~), logical operators (AND/OR/NOT), and sub-queries
+- **Web Interface**: Browse, search, and visualize architecture resources with interactive GraphViz diagrams
+- **MCP Server**: AI assistant integration via Model Context Protocol with query, analyze_resource, and resource_doc tools
+- **Computed Annotations**: Aggregate values across resource relations (sum, count, min, max, avg, concat)
+- **Validation (Lint)**: YAML syntax checking, resource kind validation, relation reference verification
+- **Template Generation**: Generate YAML templates for any resource type
+- **Docker Support**: Production-ready container with health checks
+- **Dark Mode**: Full dark mode support in web interface
+
+### Documentation
+
+- Modeling guide with resource types and relations
+- Query language reference
+- Computed annotations guide
+- ArchiMate and TOGAF alignment documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"archsight" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please [open a GitHub issue](https://github.com/ionos-cloud/archsight/issues) or contact the maintainers directly.

data/CONTRIBUTING.md

@@ -0,0 +1,186 @@
+# Contributing to Archsight
+
+Thank you for your interest in contributing to Archsight! This guide will help you get started.
+
+## Development Setup
+
+### Prerequisites
+
+- Ruby 3.2 or later
+- Bundler
+- GraphViz (for visualization features)
+
+### Installation
+
+```bash
+git clone https://github.com/ionos-cloud/archsight.git
+cd archsight
+bundle install
+```
+
+### Running Locally
+
+```bash
+# Run tests
+bundle exec rake test
+
+# Start web server with example data
+./exe/archsight web --resources examples/archsight
+
+# Lint example resources
+./exe/archsight lint --resources examples/archsight
+
+# Generate a resource template
+./exe/archsight template ApplicationComponent
+
+# Interactive console
+./exe/archsight console --resources examples/archsight
+```
+
+### Type Checking
+
+The project uses RBS type definitions with Steep:
+
+```bash
+bundle exec steep check
+```
+
+### Linting
+
+```bash
+bundle exec rubocop
+```
+
+### Code Coverage
+
+After running tests, coverage reports are generated in the `coverage/` directory:
+
+```bash
+bundle exec rake test
+open coverage/index.html  # View HTML report
+```
+
+Coverage is grouped by component: Core, Query, Resources, Annotations, MCP, and Web.
+
+## Code Style and Conventions
+
+### Ruby Style
+
+- Follow the RuboCop configuration in `.rubocop.yml`
+- Use compact class/module definitions: `class Archsight::Query::Lexer` instead of nested modules
+- Prefer single-line class definitions where the parent namespace is already defined
+
+### Resource Types
+
+When adding new resource types:
+
+```ruby
+class Archsight::Resources::MyResource < Archsight::Resources::Base
+  include_annotations :git, :architecture, :generated
+
+  icon 'box'  # Iconoir icon name
+
+  annotation 'custom/field',
+    description: 'Custom field description',
+    enum: ['value1', 'value2']
+
+  relation :realizes, :businessRequirements, :BusinessRequirement
+end
+```
+
+### Annotations
+
+- Use namespaced paths: `category/field` (e.g., `activity/status`, `repository/git`)
+- Provide descriptions for all annotations
+- Use `enum` for fields with fixed values
+- Use `computed` for aggregated values
+
+### Tests
+
+- Add tests for new features in the `test/` directory
+- Use Minitest with the existing test helpers
+- The `MockDatabase` helper is available for unit tests
+- Example resources in `examples/archsight/` can be used for integration tests
+
+## Pull Request Process
+
+1. **Fork and Branch**: Create a feature branch from `main`
+
+   ```bash
+   git checkout -b feature/my-feature
+   ```
+
+2. **Make Changes**: Implement your feature or fix
+
+3. **Test**: Ensure all tests pass
+
+   ```bash
+   bundle exec rake test
+   bundle exec rubocop
+   bundle exec steep check
+   ```
+
+4. **Commit**: Write clear commit messages
+
+   ```text
+   Add support for new annotation type
+
+   - Added category/field annotation to ResourceType
+   - Updated documentation
+   - Added tests for new functionality
+   ```
+
+5. **Push and PR**: Open a pull request against `main`
+   - Describe what the PR does
+   - Reference any related issues
+   - Include test coverage for new features
+
+## Issue Reporting Guidelines
+
+### Bug Reports
+
+Include:
+
+- Ruby version (`ruby -v`)
+- Archsight version
+- Steps to reproduce
+- Expected vs actual behavior
+- Relevant YAML resource files (if applicable)
+
+### Feature Requests
+
+Include:
+
+- Use case description
+- Proposed solution (if any)
+- Examples of how the feature would be used
+
+## Project Structure
+
+```text
+archsight/
+├── exe/archsight              # CLI executable
+├── lib/
+│   ├── archsight.rb           # Entry point
+│   └── archsight/
+│       ├── cli.rb             # Thor CLI commands
+│       ├── configuration.rb   # Configuration management
+│       ├── database.rb        # YAML loader and resource registry
+│       ├── query/             # Query language implementation
+│       │   ├── lexer.rb       # Tokenizer
+│       │   ├── parser.rb      # AST builder
+│       │   └── evaluator.rb   # Query execution
+│       ├── resources/         # Resource type definitions
+│       ├── annotations/       # Annotation modules
+│       ├── mcp/               # MCP server implementation
+│       └── web/               # Sinatra web application
+│           ├── doc/           # Documentation (markdown)
+│           └── views/         # Haml templates
+├── examples/archsight/        # Self-documenting example resources
+├── sig/                       # RBS type definitions
+└── test/                      # Test suite
+```
+
+## Questions?
+
+Open an issue on GitHub: <https://github.com/ionos-cloud/archsight/issues>

data/Dockerfile

@@ -0,0 +1,39 @@
+FROM ruby:4.0-alpine3.23
+
+# Install system dependencies required for building gems
+RUN apk add --no-cache \
+    build-base \
+    git \
+    libffi-dev \
+    yaml-dev \
+    graphviz
+
+# Set working directory
+WORKDIR /app
+
+# Copy gemspec and Gemfile for dependency installation
+COPY archsight.gemspec Gemfile Gemfile.lock* ./
+COPY lib/archsight/version.rb lib/archsight/version.rb
+
+# Install Ruby dependencies
+RUN bundle install --jobs 4
+
+# Copy application code
+COPY . .
+
+# Create volume mount point for resources
+RUN mkdir -p /resources
+
+# Set resources directory environment variable
+ENV ARCHSIGHT_RESOURCES_DIR=/resources
+ENV APP_ENV=production
+
+# Expose port for web server
+EXPOSE 4567
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
+    CMD wget --no-verbose --tries=1 --spider http://localhost:4567/ || exit 1
+
+# Default command - use the archsight CLI
+CMD ["bundle", "exec", "exe/archsight", "web", "--port", "4567"]

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,170 @@
+# Archsight
+
+[![CI](https://github.com/ionos-cloud/archsight/actions/workflows/ci.yml/badge.svg)](https://github.com/ionos-cloud/archsight/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/archsight.svg)](https://badge.fury.io/rb/archsight)
+
+*Bringing enterprise architecture into focus.*
+
+Ruby gem for visualizing and managing enterprise architecture documentation using YAML resources with GraphViz visualization. Inspired by ArchiMate 3.2.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'archsight'
+```
+
+Or install directly:
+
+```bash
+gem install archsight
+```
+
+## Quick Start
+
+### Option 1: CLI
+
+```bash
+# Start web server (looks for resources in current directory)
+archsight web
+
+# Start with custom resources path
+archsight web --resources /path/to/resources
+
+# Or use environment variable
+ARCHSIGHT_RESOURCES_DIR=/path/to/resources archsight web
+```
+
+Access at: <http://localhost:4567>
+
+### Option 2: Docker
+
+```bash
+docker build -t archsight .
+docker run -p 4567:4567 -v "/path/to/resources:/resources" archsight
+```
+
+Access at: <http://localhost:4567>
+
+**Notes:**
+
+- The volume mount `-v "/path/to/resources:/resources"` mounts your resources directory
+- Resources are accessible at `/resources` inside the container
+- Live YAML updates are reflected without rebuilding
+- Health check verifies the service is running
+
+## CLI Commands
+
+```bash
+archsight web [--resources PATH] [--port PORT]  # Start web server
+archsight lint [--resources PATH]               # Validate YAML and relations
+archsight template KIND                         # Generate YAML template for a resource type
+archsight console [--resources PATH]            # Interactive Ruby console
+archsight version                               # Show version
+```
+
+## Features
+
+### MCP Server
+
+The tool includes an MCP (Model Context Protocol) server that enables AI assistants to query and analyze the architecture data programmatically.
+
+**Start the server:**
+
+```bash
+archsight web
+```
+
+**Add to Claude Code:**
+
+```bash
+claude mcp add --transport sse ionos-architecture http://localhost:4567/mcp/sse
+```
+
+**Available tools:**
+
+- `query` - Search and filter resources using the query language
+- `analyze_resource` - Get detailed resource information and impact analysis
+- `resource_doc` - Get documentation for resource kinds
+
+### Web Interface
+
+**Browse & Search:**
+
+- Browse resources by type (Products, Services, Components, Requirements, etc.)
+- Search by name or tag using the [query language](lib/archsight/web/doc/search.md)
+- Filter by annotations (quality attributes, status, frameworks)
+
+**Visualization:**
+
+- Interactive GraphViz diagrams showing relationships
+- Zoom/pan controls for large diagrams
+- Dark mode support
+- Layer-based color scheme (Business, Application, Technology, Data)
+
+### Validation
+
+Validate YAML syntax and verify all relationship references:
+
+```bash
+archsight lint
+```
+
+**Checks:**
+
+- YAML syntax correctness
+- Resource kind definitions exist
+- All relation references point to existing resources
+- Prevents broken links between resources
+
+## Documentation
+
+Detailed documentation is available in the web interface under the Help menu:
+
+| Guide | Description |
+|-------|-------------|
+| [Modeling Guide](lib/archsight/web/doc/modeling.md) | How to model architecture using resource types and relations |
+| [Query Language](lib/archsight/web/doc/search.md) | Full query syntax reference for searching resources |
+| [Computed Annotations](lib/archsight/web/doc/computed_annotations.md) | Aggregating values across relations |
+| [ArchiMate Reference](lib/archsight/web/doc/archimate.md) | ArchiMate concepts and mapping |
+| [TOGAF Reference](lib/archsight/web/doc/togaf.md) | TOGAF alignment and concepts |
+
+## Architecture
+
+### Technology Stack
+
+- **Web Framework**: Sinatra
+- **Templating**: Haml
+- **Styling**: Pico CSS v2.x
+- **Interactivity**: HTMX
+- **Icons**: Iconoir (1,671+ icons)
+- **Visualization**: GraphViz (@hpcc-js/wasm for client-side SVG)
+
+### Directory Structure
+
+```text
+archsight/
+├── exe/archsight              # CLI executable
+├── lib/
+│   ├── archsight.rb           # Entry point
+│   └── archsight/
+│       ├── cli.rb             # Thor CLI
+│       ├── configuration.rb   # Resources path config
+│       ├── database.rb        # YAML loader and validator
+│       ├── query/             # Query language (lexer, parser, evaluator)
+│       ├── resources/         # Resource types (20+)
+│       ├── annotations/       # Annotation modules
+│       ├── mcp/               # MCP server tools
+│       └── web/               # Sinatra app, views, assets
+│           └── doc/           # Documentation (markdown)
+└── test/                      # Test suite
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, code style guidelines, and pull request process.
+
+## License
+
+Apache 2.0 License. See LICENSE.txt for details.

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in archsight, please report it responsibly:
+
+1. **Do not** open a public GitHub issue for security vulnerabilities
+2. Email the maintainers with details of the vulnerability
+3. Include steps to reproduce the issue if possible
+4. Allow reasonable time for a fix before public disclosure
+
+We will acknowledge receipt within 48 hours and provide an estimated timeline for a fix.
+
+## Security Considerations
+
+Archsight processes YAML files from the local filesystem. When deploying the web interface:
+
+- Run behind a reverse proxy with authentication in production environments
+- Limit access to trusted users who should have visibility into architecture data
+- The tool does not execute arbitrary code from YAML files
+- GraphViz rendering is performed client-side using WebAssembly

data/exe/archsight

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "archsight"
+require "archsight/cli"
+
+Archsight::CLI.start(ARGV)