mendix-ruby-bridge 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6860c21258f02339ff165d3340693f1412e5a65d9d35db0369f266eeb5d3c572
+  data.tar.gz: 8a107799572a75488aa14d6e7d6df05b1c95ffc6cb63065eb871d5b07e4dd9bb
+SHA512:
+  metadata.gz: 3d05d9fe7f68f731350602aaef1cfa14f02c432c746df8b023a1a2b29c91308058c81984a157031e313ef7ae81d7040c2f5ede828e8295551b7203955c68a870
+  data.tar.gz: 41958be09852e670435f0436d371dca0a4caf537bf34ff3c2c820915288038b53c5ac37213d194ca8c6314a0eaa32969d879547788ed2aa24abbe3131d7b88a7

data/.mxcli-version

@@ -0,0 +1,2 @@
+0.16.0
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mykael
+
+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,77 @@
+# Mendix Ruby Bridge
+
+Ruby DSL for describing Mendix application models: create projects from Ruby,
+import existing `.mpr` projects into a searchable Ruby inventory, plan and
+apply changes safely, and explore everything in an integrated web viewer.
+
+## Installation
+
+Install the gem and its pinned `mxcli` tool:
+
+```sh
+gem install mendix-ruby-bridge
+mendix-ruby setup
+```
+
+## Quick start
+
+```ruby
+model = MendixBridge.app("Customer Portal", version: "1.0") do
+  modulo "CRM" do
+    entity "Customer" do
+      attribute "Name", :string, required: true
+      attribute "Active", :boolean, default: true
+      association "Customer_Orders",
+        target: "Sales.Order",
+        cardinality: :many
+    end
+  end
+end
+```
+
+```sh
+# Create a new Mendix project from a Ruby model
+bin/mendix-ruby new examples/customer_app.rb --output ../customer-app --version 11.6.8
+
+# Import an existing project into a Ruby inventory and explore it
+bin/mendix-ruby import ../app/App.mpr --output ../ruby-inventory
+bin/mendix-ruby serve ../ruby-inventory   # http://127.0.0.1:4567
+
+# Preview and apply declarative changes with all safety checks
+bin/mendix-ruby plan examples/sandbox_app.rb --inventory ../ruby-inventory
+bin/mendix-apply examples/sandbox_app.rb --project ../app/App.mpr
+```
+
+## Documentation
+
+- [Getting started](docs/getting-started.md) — installation, creating a
+  project from Ruby, and project configuration.
+- [Ruby DSL guide](docs/dsl.md) — entities, enumerations, microflows, pages,
+  security, navigation, and compiling/applying models.
+- [Explicit migrations and rollback](docs/migrations.md) — destructive and
+  security-sensitive changes (renames, drops, role changes) with backup and
+  rollback.
+- [Git-controlled Mendix branches](docs/git-workflow.md) — guarded branch
+  switching, stash, merge, and rebase with Mendix consistency checks.
+- [Import and the web viewer](docs/import-and-viewer.md) — importing existing
+  projects, dependency queries, search/inspect, and the integrated viewer
+  (domain explorer, ER diagram, page builder, Git panel, Marketplace).
+
+## Safety model
+
+The declarative apply is additive and idempotent; destructive or
+migration-sensitive changes are reported as `BLOCKED` and belong in explicit
+migrations. The web viewer never writes the `.mpr`: visual edits are validated
+with `mxcli check` and stored as reviewable drafts, while real writes go
+through the guarded CLI/Git workflow with Studio Pro closed.
+
+## Development
+
+```sh
+bundle install
+bundle exec rake test
+bundle exec rake build
+```
+
+Tags matching the gem version, such as `v0.1.0`, run the complete test matrix,
+build the gem, and publish it as a GitHub Release.

data/bin/git-mendix

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+exec(File.expand_path("mendix-git", __dir__), *ARGV)

data/bin/mendix-apply

@@ -0,0 +1,145 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "open3"
+require "optparse"
+require "pathname"
+require "tempfile"
+require_relative "../lib/mendix_bridge"
+
+options = { allow_dirty: false }
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: mendix-apply APP.rb --project APP.mpr"
+
+  opts.on("-p", "--project FILE", "Target Mendix .mpr file") do |file|
+    options[:project] = File.expand_path(file)
+  end
+
+  opts.on("--allow-dirty", "Allow a target repository with uncommitted changes") do
+    options[:allow_dirty] = true
+  end
+end
+
+parser.parse!
+project_config = MendixBridge::Config.find
+dsl_file = ARGV.shift || project_config&.model
+options[:project] ||= project_config&.project
+
+unless dsl_file && options[:project] && ARGV.empty?
+  warn parser
+  exit 1
+end
+
+dsl_file = File.expand_path(dsl_file)
+project_file = options.fetch(:project)
+project_dir = File.dirname(project_file)
+bridge_dir = File.expand_path("..", __dir__)
+mxcli = File.join(bridge_dir, "bin", "mxcli")
+version_file = File.join(project_dir, ".mendix-version")
+
+abort "DSL file does not exist: #{dsl_file}" unless File.file?(dsl_file)
+abort "Mendix project does not exist: #{project_file}" unless File.file?(project_file)
+abort "Missing #{version_file}" unless File.file?(version_file)
+
+git_root, git_error, git_status = Open3.capture3(
+  "git", "-C", project_dir, "rev-parse", "--show-toplevel"
+)
+abort "Target project must be inside a Git repository: #{git_error}" unless git_status.success?
+
+git_root = git_root.strip
+dirty, = Open3.capture2("git", "-C", git_root, "status", "--porcelain")
+if !options[:allow_dirty] && !dirty.empty?
+  abort "Target repository has uncommitted changes; commit them or use --allow-dirty"
+end
+
+version = File.read(version_file).strip
+mx = File.join(Dir.home, ".mxcli", "mxbuild", version, "modeler", "mx")
+abort "Mendix mx #{version} is not installed: #{mx}" unless File.executable?(mx)
+
+model = MendixBridge.load_file(dsl_file)
+
+existing_associations = model.modules.flat_map do |app_module|
+  output, error, status = Open3.capture3(
+    mxcli,
+    "-p", project_file,
+    "-c", "SHOW ASSOCIATIONS IN #{app_module.name}"
+  )
+  abort "Could not inspect associations: #{error}" unless status.success?
+
+  output.scan(/^\|\s+([A-Za-z_][A-Za-z0-9_]*\.[A-Za-z_][A-Za-z0-9_]*)\s+\|/).flatten
+end
+
+declared_associations = model.modules.flat_map do |app_module|
+  app_module.entities.flat_map do |entity|
+    entity.associations.map { |association| "#{app_module.name}.#{association.name}" }
+  end
+end
+skipped_associations = declared_associations & existing_associations
+
+unless skipped_associations.empty?
+  puts "Keeping existing associations: #{skipped_associations.join(', ')}"
+end
+
+existing_module_roles = model.modules.flat_map do |app_module|
+  output, error, status = Open3.capture3(
+    mxcli,
+    "-p", project_file,
+    "-c", "SHOW MODULE ROLES IN #{app_module.name};"
+  )
+  abort "Could not inspect module roles: #{error}" unless status.success?
+
+  output.scan(
+    /^\|\s+([A-Za-z_][A-Za-z0-9_]*\.[A-Za-z_][A-Za-z0-9_]*)\s+\|/
+  ).flatten
+end
+declared_module_roles = model.modules.flat_map do |app_module|
+  app_module.module_roles.map { |role| "#{app_module.name}.#{role.name}" }
+end
+skipped_module_roles = declared_module_roles & existing_module_roles
+
+user_role_output, user_role_error, user_role_status = Open3.capture3(
+  mxcli,
+  "-p", project_file,
+  "-c", "SHOW USER ROLES;"
+)
+abort "Could not inspect user roles: #{user_role_error}" unless user_role_status.success?
+existing_user_roles = user_role_output.scan(/^\|\s+([A-Za-z_][A-Za-z0-9_]*)\s+\|/).flatten
+declared_user_roles = model.user_roles.map(&:name)
+skipped_user_roles = declared_user_roles & existing_user_roles
+
+unless skipped_module_roles.empty?
+  puts "Keeping existing module roles: #{skipped_module_roles.join(', ')}"
+end
+unless skipped_user_roles.empty?
+  puts "Keeping existing user roles: #{skipped_user_roles.join(', ')}"
+end
+
+mdl = MendixBridge.compile(
+  model,
+  format: :mdl,
+  skip_associations: skipped_associations,
+  skip_module_roles: skipped_module_roles,
+  skip_user_roles: skipped_user_roles
+)
+
+Tempfile.create(["mendix-ruby-bridge-", ".mdl"]) do |file|
+  file.write(mdl)
+  file.flush
+
+  puts "1/3 Validating generated MDL..."
+  abort "MDL validation failed" unless system(mxcli, "check", file.path)
+
+  puts "2/3 Applying MDL to #{File.basename(project_file)}..."
+  abort "mxcli could not apply the model" unless system(
+    mxcli, "exec", file.path, "-p", project_file
+  )
+
+  puts "3/3 Running official Mendix consistency check..."
+  abort "Mendix consistency check failed" unless system(
+    mx, "check", project_file, chdir: project_dir
+  )
+end
+
+puts "Application completed successfully."
+puts "Review the changes with: git -C #{git_root} status --short"

data/bin/mendix-desktop

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "../lib/mendix_bridge"
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: mendix-desktop [IMPORTED_DIR]"
+  opts.on("-v", "--version", "Print version") do
+    puts MendixBridge::VERSION
+    exit
+  end
+end
+parser.parse!
+
+unless ARGV.length <= 1
+  warn parser
+  exit 1
+end
+
+inventory_dir = File.expand_path(
+  ARGV.shift || MendixBridge::Config.find&.inventory || "."
+)
+bridge_dir = File.expand_path("..", __dir__)
+
+MendixBridge::DesktopApp.new(inventory_dir:, bridge_dir:).run

data/bin/mendix-git

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+require "optparse"
+require_relative "../lib/mendix_bridge"
+
+options = { studio_closed: false, fetch: false }
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: mendix-git COMMAND [ARGUMENTS] [--project APP.mpr] [options]"
+  opts.on("-p", "--project FILE", "Mendix .mpr file") { |file| options[:project] = File.expand_path(file) }
+  opts.on("-i", "--inventory DIR", "Refresh this Ruby inventory after switching") do |dir|
+    options[:inventory] = File.expand_path(dir)
+  end
+  opts.on("--studio-closed", "Confirm Studio Pro is closed") { options[:studio_closed] = true }
+  opts.on("--fetch", "Fetch and prune origin before the command") { options[:fetch] = true }
+  opts.on("--json", "Print machine-readable JSON") { options[:json] = true }
+  opts.on("-m", "--message MESSAGE", "Stash message") { |message| options[:message] = message }
+  opts.on("-u", "--include-untracked", "Include untracked files in stash push") do
+    options[:include_untracked] = true
+  end
+end
+
+parser.parse!
+command = ARGV.shift
+arguments = ARGV.dup
+unless options[:project]
+  candidates = Dir[File.join(Dir.pwd, "*.mpr")]
+  options[:project] = candidates.first if candidates.length == 1
+end
+unless command && options[:project]
+  warn parser
+  warn "Run inside a directory containing one .mpr file or pass --project."
+  exit 1
+end
+
+bridge_dir = File.expand_path("..", __dir__)
+begin
+workflow = MendixBridge::GitWorkflow.new(
+  options.fetch(:project),
+  inventory_dir: options[:inventory],
+  mxcli: File.join(bridge_dir, "bin", "mxcli")
+)
+workflow.fetch if options[:fetch]
+
+result = case command
+when "status"
+  abort "status does not accept arguments" unless arguments.empty?
+  workflow.status
+when "branches"
+  abort "branches does not accept arguments" unless arguments.empty?
+  workflow.branches
+when "switch"
+  branch = arguments.shift
+  abort "switch requires a branch" unless branch
+  abort "switch accepts only one branch" unless arguments.empty?
+  workflow.switch(branch, studio_closed: options[:studio_closed])
+when "new"
+  branch = arguments.shift
+  abort "new requires a branch" unless branch
+  abort "new accepts only one branch" unless arguments.empty?
+  workflow.create(branch, studio_closed: options[:studio_closed])
+when "stash"
+  action = arguments.shift
+  reference = arguments.shift
+  abort "stash accepts at most an action and reference" unless arguments.empty?
+  case action
+  when "push"
+    abort "stash push does not accept a reference" if reference
+    workflow.stash_push(
+      studio_closed: options[:studio_closed],
+      message: options[:message],
+      include_untracked: options[:include_untracked]
+    )
+  when "list"
+    abort "stash list does not accept a reference" if reference
+    workflow.stash_list
+  when "show"
+    workflow.stash_show(reference || "stash@{0}")
+  when "apply"
+    workflow.stash_apply(
+      reference || "stash@{0}",
+      studio_closed: options[:studio_closed]
+    )
+  when "pop"
+    workflow.stash_apply(
+      reference || "stash@{0}",
+      studio_closed: options[:studio_closed],
+      drop: true
+    )
+  when "drop"
+    workflow.stash_drop(reference || "stash@{0}")
+  else
+    abort "stash expects push, list, show, apply, pop, or drop"
+  end
+when "merge"
+  branch = arguments.shift
+  abort "merge requires a branch" unless branch
+  abort "merge accepts only one branch" unless arguments.empty?
+  workflow.merge(branch, studio_closed: options[:studio_closed])
+when "rebase"
+  branch = arguments.shift
+  abort "rebase requires a branch" unless branch
+  abort "rebase accepts only one branch" unless arguments.empty?
+  workflow.rebase(branch, studio_closed: options[:studio_closed])
+else
+  abort "unknown command: #{command}; expected status, branches, switch, new, stash, merge, or rebase"
+end
+
+if options[:json]
+  puts JSON.pretty_generate(result)
+elsif result.is_a?(Array)
+  puts result
+elsif result.is_a?(String)
+  puts result
+else
+  result.each { |key, value| puts "#{key}: #{value}" }
+end
+rescue MendixBridge::GitWorkflowError => error
+  abort error.message
+end