mxrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 132cfec5b4d87e5d5efc2e9257d588952e7b8653b5fde7042dabadcd95da7ed0
+  data.tar.gz: d0e5191a8ad4f7f11a870ee7bd66d39b797a48326727d32e559827007724f462
+SHA512:
+  metadata.gz: 309fd50dab116e2bd6c97ec070322e350147e9a360f93b22ed9c215309bc832a3241edc9dd1942af8b225da5b0e216fd3829a88be464d22f112506833dcd10b4
+  data.tar.gz: 8e99f2ebfaaef5b11956ad4c3698d7a03153a98c62c8bfb23915bc964a2128a7531ba8f54b2e92306aa3e59c742871f533da8e48b83db20c0220b95a2b5a0b0c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lucas Moura
+
+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.de-DE.md

@@ -0,0 +1,108 @@
+# MXRB
+
+[English](README.md) · [Português](README.pt-BR.md) · **Deutsch**
+
+MXRB ist ein Ruby-First-Werkzeug zum Lesen, Schreiben, Exportieren, Validieren
+und Testen von Mendix-Projekten (`.mpr`) ohne MDL oder `mxcli`.
+
+## Funktionen
+
+- tiefes Lesen und Schreiben von MPR v1/v2;
+- Export in bearbeitbare Ruby-Projekte;
+- idempotente Generierung mit Ruby-DSL;
+- Scaffold für neue Projekte mit PascalCase-Hauptmodul;
+- tiefe Ruby-Bearbeitung jeder nativen Unit mit verlustfreier Baseline;
+- Vergleich, semantischer Diff, Referenzen und Impact-Analyse;
+- sichere Umbenennung mit Vorschau;
+- Verschieben eigenständiger Units zwischen Ordnern desselben Moduls;
+- Entfernen eigenständiger Units nach Referenz- und Kind-Unit-Prüfung;
+- Lint und ausführbare Modellbewertungen;
+- Erkennung von nativem OQL und logische SQL-Ansicht nur bei vorhandenem OQL;
+- isolierte, durch das Runtime synchronisierte PostgreSQL für direkte SQL-Abfragen;
+- Analyse von PostgreSQL-/SQL-Server-Plänen und kumulativem PostgreSQL-Workload;
+- funktionale Microflow-Tests lokal oder in Docker.
+- Suche und Installation wiederverwendbarer Ruby-Module mit SHA-256-Lock.
+
+Die Matrix bewahrt Mendix-5.21–11.12-Projekte strukturell. Eine exakte native
+Mendix-5-Prüfung erfordert weiterhin Windows/Studio Pro und ist eine
+ausdrückliche MXRB-Einschränkung; sie gehört nicht zum direkten automatischen
+Toolchain-Gate.
+
+## Voraussetzungen
+
+Ruby 4.0+, SQLite3 und für offizielle Gates das exakte Mendix-Toolchain. Lokal
+wird kompatibles Java benötigt; Docker stellt JDK und Runtime bereit.
+
+```sh
+bundle install
+bundle exec mxrb validate App.mpr
+bundle exec mxrb export App.mpr app-ruby
+bundle exec mxrb compare original.mpr rebuilt.mpr
+bundle exec mxrb module search
+bundle exec mxrb module add shared-kernel
+bundle exec mxrb cache status App.mpr
+bundle exec mxrb cache warm App.mpr
+bundle exec mxrb cache clear App.mpr
+bundle exec mxrb oql App.mpr --dialect postgresql
+bundle exec mxrb db up App.mpr
+bundle exec mxrb db sql App.mpr 'SELECT * FROM "sales$order" LIMIT 20'
+```
+
+Die MPR speichert das Modell, nicht die Anwendungsdaten. `db up` baut das
+exakte portable Runtime und lässt es ein isoliertes PostgreSQL-Volume
+synchronisieren. Der Zugriff ist auf Loopback beschränkt und verwendet ohne
+ausdrückliches `--write` eine schreibgeschützte Rolle. Siehe
+[OQL und lokaler SQL-Zugriff](docs/de-DE/oql-sql.md).
+
+## Ruby-DSL
+
+```ruby
+Mxrb.define("Shop.mpr") do
+  mendix_version "11.12.1"
+  self.module :Sales do
+    entity :Order do
+      string :Number, documentation: "Stabile Bestellnummer"
+      decimal :Total, default: 0
+    end
+  end
+end
+```
+
+## Bewertungen und Funktionstests
+
+```ruby
+artifact "Sales.Order", kind: :entity
+no_call_cycles
+no_missing_internal_references
+```
+
+```ruby
+microflow "erstellt Bestellung", call: "Sales.ACT_CreateOrder"
+```
+
+```sh
+bundle exec mxrb evaluate Shop.mpr evaluation.rb
+bundle exec mxrb test Shop.mpr functional_test.rb --docker
+```
+
+JUnit und MDL sind nicht erforderlich. Instrumentierung, Paket, Datenbank und
+Uploads existieren nur in der wegwerfbaren Kopie; das Original bleibt unverändert.
+Assertions prüfen Rückgabewerte und persistierten Zustand über
+Entitäts-/XPath-Zählungen.
+
+## Entwicklung
+
+```sh
+bundle exec rspec
+MXRB_COVERAGE=1 bundle exec rspec
+bundle exec ruby script/branch_report.rb
+bundle exec rubocop
+```
+
+Die Suite erzwingt 100 % Zeilen- und Branch-Abdeckung.
+
+Siehe die [vollständige deutsche Dokumentation](docs/de-DE/README.md).
+
+## Lizenz
+
+MIT.

data/README.md

@@ -0,0 +1,172 @@
+# MXRB
+
+**English** · [Português](README.pt-BR.md) · [Deutsch](README.de-DE.md)
+
+MXRB is a Ruby-first toolkit for reading, writing, exporting, validating and
+testing Mendix project models (`.mpr`) without using MDL or `mxcli`.
+
+Ruby is the public interface. The official Mendix `mx`, `mxbuild` and Runtime
+remain optional external gates for compatibility and functional execution.
+
+## Current capabilities
+
+- read and write MPR v1 and v2 projects;
+- export complete projects into editable Ruby;
+- generate idempotent MPRs from a Ruby DSL;
+- scaffold a new Ruby-first project with its PascalCase application module;
+- expose every native unit as editable deep Ruby while retaining a lossless baseline;
+- compare structural snapshots and produce typed semantic diffs;
+- inspect references, callers, callees and transitive impact;
+- rename artifacts with a preview before applying changes;
+- read and write native navigation profiles, role homes and recursive menus;
+- preserve theme, widget, resource and Java assets with SHA-256 manifests;
+- inventory design tokens, check contrast and preview atomic literal migration;
+- discover native OQL and render safe logical SQL views only when OQL exists;
+- materialize an isolated, Runtime-synchronized PostgreSQL for direct SQL inspection;
+- analyze PostgreSQL/SQL Server plans and rank cumulative PostgreSQL workload pressure;
+- move standalone units between folders in the same module with a preview;
+- remove standalone units only after reference and child-unit safety checks;
+- run static analysis and executable model evaluations in Ruby;
+- execute functional microflow tests locally or in disposable containers.
+- search and install reusable Ruby modules with a locked SHA-256 digest.
+- write, inspect and compare deterministic MDA containers without invoking `mxbuild`;
+- assemble executable portable Runtime ZIPs from materialized deployments and
+  installed version-matched Runtime files without invoking `mx` or `mxbuild`;
+- preflight an existing MPR against its version-selected native web pipeline,
+  with precise unsupported widget, action, layout and nanoflow findings;
+- clone, inspect and synchronize official Team Server Git repositories while
+  keeping PAT values in user-managed files.
+
+The public validation matrix currently covers structural v1/v2 round trips
+from Mendix 5.21 through 11.12 and official MxBuild checks where the native
+toolchain is supported. Exact Mendix 5 validation still depends on
+Windows/Studio Pro and remains a documented legacy limitation, but it is not a
+current delivery gate. See
+[the validation matrix](docs/en-US/validation-matrix.md) for the exact evidence and
+confidence boundaries.
+
+## Requirements
+
+- Ruby 4.0 or newer;
+- SQLite3;
+- the exact Mendix Linux toolchain for official checks;
+- Java matching the project when running locally, or Docker for containerized
+  builds and runtime tests.
+
+Install dependencies:
+
+```sh
+bundle install
+```
+
+## Ruby DSL
+
+```ruby
+Mxrb.define("Shop.mpr") do
+  mendix_version "11.12.1"
+
+  self.module :Sales do
+    entity :Order do
+      string :Number, documentation: "Stable order number"
+      decimal :Total, default: 0
+    end
+
+    microflow :CreateOrder do
+      return_type :Order
+      create_object "Sales.Order", as: :order
+      return_value :order
+    end
+  end
+end
+```
+
+```sh
+bundle exec mxrb generate shop.rb
+bundle exec mxrb validate Shop.mpr
+bundle exec mxrb export Shop.mpr exported-shop
+bundle exec mxrb compare original.mpr rebuilt.mpr
+bundle exec mxrb module search
+bundle exec mxrb module add shared-kernel
+bundle exec mxrb cache status Shop.mpr
+bundle exec mxrb cache warm Shop.mpr
+bundle exec mxrb cache clear Shop.mpr
+bundle exec mxrb oql Shop.mpr --dialect postgresql
+bundle exec mxrb db up Shop.mpr
+bundle exec mxrb db sql Shop.mpr 'SELECT * FROM "sales$order" LIMIT 20'
+bundle exec mxrb pack Shop.mpr --output build/Shop.mda
+bundle exec mxrb portable Shop.mpr --output build/runtime.zip
+bundle exec mxrb team-server clone APP_ID ./shop --pat-file /secure/team-server.env
+```
+
+The MPR stores the model, not application data. `db up` builds the exact
+portable Runtime and lets it synchronize an isolated PostgreSQL volume.
+Database access is loopback-only and uses a read-only analyst role unless
+`--write` is explicitly requested. See
+[OQL and local SQL access](docs/en-US/oql-sql.md).
+
+## Model evaluations
+
+```ruby
+# evaluation.rb
+artifact "Sales.Order", kind: :entity
+no_call_cycles
+no_missing_internal_references
+
+check "Order has a total" do |project|
+  project.find_artifact("Sales.Order.Total", kind: :attribute)
+end
+```
+
+```sh
+bundle exec mxrb evaluate Shop.mpr evaluation.rb
+```
+
+## Functional microflow tests
+
+Functional definitions are Ruby and do not require JUnit:
+
+```ruby
+# functional_test.rb
+microflow "creates an order", call: "Sales.ACT_CreateOrder"
+```
+
+Run with the local toolchain:
+
+```sh
+JAVA_HOME=/path/to/jdk \
+  bundle exec mxrb test Shop.mpr functional_test.rb
+```
+
+Or build and run inside disposable containers:
+
+```sh
+bundle exec mxrb test Shop.mpr functional_test.rb --docker
+```
+
+The source project is copied before instrumentation. Structural validation is
+performed natively by MXRB. The instrumented functional build still requires
+materializing changed microflows; that build, runtime database and uploaded
+files are discarded after execution.
+The functional scope verifies completion, exception handling, return values
+and persisted state through entity/XPath count assertions.
+
+## Development
+
+```sh
+bundle exec rspec
+MXRB_COVERAGE=1 MXRB_LINE_COVERAGE_MIN=100 MXRB_BRANCH_COVERAGE_MIN=100 bundle exec rspec
+bundle exec ruby script/branch_report.rb
+bundle exec rubocop
+```
+
+CI and the local coverage helper enforce 100% line and 100% branch coverage.
+The branch report lists any regression by source file and line.
+
+Architecture and deeper writing guidance are available in
+[the English documentation](docs/en-US/README.md). The complete documentation
+is also available in [Portuguese](docs/pt-BR/README.md) and
+[German](docs/de-DE/README.md).
+
+## License
+
+MXRB is available under the MIT License.

data/README.pt-BR.md

@@ -0,0 +1,109 @@
+# MXRB
+
+[English](README.md) · **Português** · [Deutsch](README.de-DE.md)
+
+MXRB é uma ferramenta Ruby-first para ler, escrever, exportar, validar e testar
+projetos Mendix (`.mpr`) sem MDL ou `mxcli`.
+
+## Capacidades
+
+- leitura e escrita profunda de MPR v1/v2;
+- exportação de projetos para Ruby editável;
+- geração idempotente por DSL Ruby;
+- scaffold de projeto novo com módulo principal em PascalCase;
+- edição profunda em Ruby de toda unit nativa, com baseline sem perdas;
+- comparação, diff semântico, referências e análise de impacto;
+- renomeação segura com prévia;
+- movimentação de units entre pastas do mesmo módulo com prévia;
+- remoção de units independentes com verificação de referências e filhos;
+- lint e avaliações executáveis de modelo;
+- descoberta de OQL nativo e visão SQL lógica somente quando o projeto contém OQL;
+- PostgreSQL isolado e sincronizado pelo Runtime para consultas SQL diretas;
+- análise de planos PostgreSQL/SQL Server e workload cumulativo PostgreSQL;
+- testes funcionais de microflows localmente ou em Docker.
+- busca e instalação de módulos Ruby reutilizáveis com SHA-256 travado.
+
+A matriz preserva estruturalmente projetos Mendix 5.21–11.12. A validação
+nativa exata do Mendix 5 ainda depende de Windows/Studio Pro e é uma limitação
+explícita do MXRB; ela não faz parte do gate automatizado direto.
+
+## Requisitos
+
+Ruby 4.0+, SQLite3 e, para gates oficiais, o toolchain Mendix exato. O modo
+local precisa do Java compatível; o modo Docker fornece JDK e Runtime.
+
+```sh
+bundle install
+bundle exec mxrb init vet_clinic
+bundle exec mxrb validate App.mpr
+bundle exec mxrb export App.mpr app-ruby
+bundle exec mxrb compare original.mpr reconstruido.mpr
+bundle exec mxrb module search
+bundle exec mxrb module add shared-kernel
+bundle exec mxrb cache status App.mpr
+bundle exec mxrb cache warm App.mpr
+bundle exec mxrb cache clear App.mpr
+bundle exec mxrb oql App.mpr --dialect postgresql
+bundle exec mxrb db up App.mpr
+bundle exec mxrb db sql App.mpr 'SELECT * FROM "sales$order" LIMIT 20'
+```
+
+O MPR armazena o modelo, não os dados da aplicação. `db up` compila o Runtime
+portátil exato e permite que ele sincronize um volume PostgreSQL isolado. O
+acesso é restrito a loopback e usa um papel somente leitura, salvo quando
+`--write` é solicitado explicitamente. Consulte
+[OQL e acesso SQL local](docs/pt-BR/oql-sql.md).
+
+## Ruby DSL
+
+```ruby
+Mxrb.define("Shop.mpr") do
+  mendix_version "11.12.1"
+  self.module :Sales do
+    entity :Order do
+      string :Number, documentation: "Número estável do pedido"
+      decimal :Total, default: 0
+    end
+  end
+end
+```
+
+## Avaliações e testes funcionais
+
+```ruby
+artifact "Sales.Order", kind: :entity
+no_call_cycles
+no_missing_internal_references
+```
+
+```ruby
+microflow "cria pedido", call: "Sales.ACT_CreateOrder"
+```
+
+```sh
+bundle exec mxrb evaluate Shop.mpr evaluation.rb
+bundle exec mxrb test Shop.mpr functional_test.rb --docker
+```
+
+Não há JUnit ou MDL. A instrumentação, o pacote, o banco e os uploads existem
+somente na cópia descartável; o projeto original não é alterado.
+As asserções cobrem retorno do microflow e estado persistido por contagens
+de entidade/XPath.
+
+## Desenvolvimento
+
+```sh
+bundle exec rspec
+MXRB_COVERAGE=1 bundle exec rspec
+bundle exec ruby script/branch_report.rb
+bundle exec rubocop
+```
+
+A suíte exige 100% de cobertura de linhas e branches. O relatório de branches
+lista qualquer regressão por arquivo e linha.
+
+Consulte a [documentação completa em português](docs/pt-BR/README.md).
+
+## Licença
+
+MIT.