mbeditor 0.12.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e586fb734529e92147e9fb6935782e79baeb9722c833e8df0a97cc2c86c637
-  data.tar.gz: 5da9242367bd195c715af433c8fb12fa440a610cacb5a1ff871cb8361c82233a
+  metadata.gz: a2d9c1ba81f945f5ce0772455f51e66a110fa43a1e24f62c96e6859312c4a968
+  data.tar.gz: d01eb3a6edd6e221e92c25e093c7c5944b32c50dafad6a4cacfa953e5c0b1925
 SHA512:
-  metadata.gz: f403b63083bc139fc6546477c42fb476283213f0409a287ec3ffe46cc1a90cb10f197d6521216efce8121d910fdb8b2c94eefd8cd0abd8829725c852f043e57a
-  data.tar.gz: 219a64ac7ecf5e2ded2081058f64f0bb4b0ce8373eac4f3cdcd8f9ca87aacd887676e680c31f360848dbcc255cfcdd176eaf67389569c64143639bf2643538f6
+  metadata.gz: f8c189fa9f7215d5a376ab321a10186645c6671a2c1de874c3f3b254e3ebebb20a2c102e0c5357fb0ee0183eb0c634d2f26c7f7860901cec8e941f56ca26bd75
+  data.tar.gz: d0f8bdb6abe76b88e8438c0f31e78055d49fe09dfb3c88df1031312c33985b8ad2906f72482cc32a7c986a4019dee19226e42c96fa6d99b52f1da1cdb4faa790

data/CHANGELOG.md

@@ -7,6 +7,118 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.2] - 2026-08-03
+
+### Added
+- **Inline route hints in controllers.** Every action in a controller file is
+  annotated with the verb and path that reach it — `GET /orders/:id` beside
+  `def show` — and a public action nothing routes to is flagged `no route`.
+  Hovering adds the named-route helper. Answering "is this actually reachable?"
+  previously meant reading `config/routes.rb` and expanding `resources` in your
+  head.
+
+  Routes come from the host app's own route set rather than by parsing
+  `config/routes.rb`. mbeditor runs inside the app, so the routes are already
+  built — and they are the only source that accounts for `resources` expansion,
+  `member`/`collection` blocks, scopes, constraints and mounted engines.
+
+- **`config.model_graph_max_models`** (default 1000, was a hard-coded 300).
+  A schema over the cap silently lost models and only said "(truncated)".
+
+### Changed
+- **Model boxes are sized to their contents** rather than all being one width,
+  so a long model or column name is no longer truncated while a model called
+  `Tag` wastes most of its box. Layer positions accumulate per layer, since a
+  fixed stride would let a wide box overlap the next layer.
+- **Cluster blocks are packed in two dimensions** instead of stacked in a single
+  column, which left a schema with one big core and several small islands
+  running off the bottom with the right-hand side empty.
+- **The dummy app now carries a real ActiveRecord schema** — 20 models and 44
+  associations covering a hub, a chain, a self-reference, a join table, a
+  polymorphic association and unconnected islands — so the model graph can be
+  demonstrated and tested against something representative.
+
+### Fixed
+- **mbeditor could stop a host app from booting.** The pending-migrations
+  middleware was installed whenever `ActiveRecord::Migration::CheckPending` was
+  defined, but Rails only puts that middleware in the stack when
+  `config.active_record.migration_error` is `:page_load`. Any app loading
+  ActiveRecord with a different setting raised "No such middleware to insert
+  before" during boot. It now tests the same condition Rails does.
+- **Long labels drew straight out past the edge of their model box.** SVG text
+  neither wraps nor ellipsises; labels are now measured against the font the
+  theme actually resolves and cut to fit.
+- **"no database connection" hung below the box it belonged to** — the box
+  height did not count that placeholder line.
+- **The model search is a real dropdown.** The native `<datalist>` rendered in
+  the browser's own chrome: unstyleable, and unable to show the table name and
+  column count beside each model. Arrow keys and Enter work as before.
+- **The titlebar wrapped to two lines in a narrow window**, pushing the toolbar
+  out of its 32px row. It no longer wraps, and below the width where the toolbar
+  drops its button labels the title gives way to the icon alone.
+
+## [0.12.1] - 2026-08-03
+
+### Added
+- **The collaboration name now comes from the signed-in user automatically.**
+  Previously it required a `user_name_callback`; with none set the editor fell
+  straight through to a generated name like "Witty Operator" even on an
+  authenticated instance. When no callback is configured, the name is now read
+  off `current_user`, trying `name`, `full_name`, `display_name`, `username`,
+  `login` and `email` in order. New `config.user_name_methods` names your own
+  column instead — `%w[preferred_name]` — so the common case no longer needs a
+  callback at all. An explicit `user_name_callback` still wins.
+
+  This works when your auth library exposes `current_user` to an
+  `ActionController::Base` subclass, which Devise and Sorcery do. A
+  `current_user` written by hand on your own `ApplicationController` is **not**
+  reachable — the engine's controllers do not inherit from it — so that case
+  still needs a callback reading `session` directly.
+
+### Changed
+- **The model graph is laid out by dependency, not by traversal order.** It now
+  uses the Sugiyama layered method — break cycles, layer by longest path, cut
+  crossings with the median heuristic, then straighten — which is what Graphviz
+  `dot`, and so Rails ERD, uses for this picture. The previous radial layout
+  became one enormous circle on a real schema, fitted so far out that no box was
+  legible. A model's position now tells you something: depth reads left to
+  right, and each connected part of the schema is drawn as its own area.
+
+- **Your own presence chip only appears once someone else is connected.** Action
+  Cable is up in any normal dev setup, so it used to sit in the toolbar
+  permanently announcing a session of one.
+
+### Fixed
+- **The model graph was unusable on a large schema.** On 300 models and 513
+  associations a single zoom tick cost 27 ms; it is now 0.2 ms. Three causes,
+  all compounding: the entire layout ran on every render, the pan/zoom transform
+  sat in the render output so each tick rebuilt ~7,000 SVG elements, and the
+  wheel handler read `getBoundingClientRect()` per tick, forcing a synchronous
+  reflow of the whole scene.
+- **Fit-to-pane produced a zoom the controls refused to honour.** It clamped to
+  `min(1, ...)` but not to the minimum zoom, so a large graph fitted at ~0.04
+  against a 0.2 floor — and the first scroll snapped up to the floor, a fivefold
+  jump anchored on the cursor that looked like the diagram leaping somewhere
+  random. The floor is now low enough to frame a few hundred models, and the fit
+  clamps to the same range the wheel enforces. Opening the tab also no longer
+  leaves the graph unfitted when the pane has not been sized yet.
+- **Hovering a model now shows what its associations actually are** — macro,
+  name, direction and `through:` — and dims every unrelated edge, which is the
+  only way to follow one model's relationships among hundreds of lines.
+- **Clicking a model zooms to it** instead of opening its schema; the schema is
+  an explicit button in the model's header, so navigating no longer throws a
+  modal at you.
+- **The model-graph search field drew its text over a magnifier icon.** The icon
+  comes from the vendored Pico stylesheet, whose selector outranks a plain class
+  rule — disabling the browser's own `type="search"` decorations did not touch
+  it.
+- **A failing `user_name_callback` was swallowed silently.** Any exception
+  returned a bare `nil`, which made a broken callback indistinguishable from an
+  unconfigured one: you got the generated name and no clue why. The usual cause
+  is a `NameError` on a `current_user` the engine cannot see. It is now logged
+  as `[mbeditor] user name lookup failed: ...` and still never breaks the
+  request.
+
 ## [0.12.0] - 2026-07-31
 
 ### Added
@@ -50,9 +162,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **A model graph — an entity diagram of the host app's ActiveRecord models.**
   The activity-bar button opens it as a full-width editor tab, drawing each
-  model with its fields and laying them out radially around whichever model has
-  the most associations. Search centres the view on a model; hovering an edge
-  names the relation.
+  model with its fields. Search centres the view on a model; hovering an edge
+  names the relation. (Released with a radial layout; replaced by a layered one
+  in the next version — see Unreleased.)
 
   Associations are read by **reflection, not by parsing model files**. mbeditor
   runs inside the host app, so `reflect_on_all_associations` is right there and

data/README.md

@@ -162,7 +162,8 @@ See [Resilient Routing](#resilient-routing) for details.
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `user_name_callback` | `nil` | Proc resolving the display name shown on your caret during realtime collaboration. Executed via `instance_exec` inside the controller (like `authenticate_with`), so it can read `session`, `cookies`, `current_user`, etc. — e.g. `proc { current_user&.name }`. When `nil` or it returns a blank value, each browser falls back to a generated, locally-persisted, user-editable name. Collaboration activates once another participant actually connects, not merely when Action Cable is up (see [Collaborative pairing](#collaborative-pairing-optional)). |
+| `user_name_callback` | `nil` | Proc resolving the display name shown on your caret during realtime collaboration. Only needed when the automatic lookup can't reach your user — see `user_name_methods` below. Executed via `instance_exec` inside the engine's controller (like `authenticate_with`), so it can read `session`, `cookies`, `params`, and anything your auth library exposes to an `ActionController::Base` subclass — e.g. `proc { User.find_by(id: session[:user_id])&.name }`. **It cannot see helper methods defined on your own `ApplicationController`**, because the engine's controllers do not inherit from it; a hand-rolled `current_user` living there will raise `NameError`, which is logged as `[mbeditor] user name lookup failed` and falls back to the generated name. |
+| `user_name_methods` | `%w[name full_name display_name username login email]` | Attributes tried on `current_user`, in order, when no `user_name_callback` is set — the first non-blank one becomes your collaboration display name. This is what makes an authenticated editor show real names with no extra wiring, provided your auth library exposes `current_user` to `ActionController::Base` (Devise and Sorcery do; a `current_user` you wrote yourself on `ApplicationController` does not). Set it to your own column instead of writing a callback, e.g. `%w[preferred_name]`. |
 
 ## JavaScript intelligence
 
@@ -376,6 +377,42 @@ common cause of *"the other person's edits never show up."* For pairing, run a s
 worker (`WEB_CONCURRENCY=0`, or `bundle exec rails server` which is single-process by
 default). A multi-worker setup would additionally need a cross-process cable adapter, but
 the in-memory buffer still would not be shared — single-process is the supported mode.
+
+#### Showing real usernames
+
+Each participant's caret and presence chip are labelled. With no configuration
+the label is a generated name like *Witty Operator*, persisted per browser and
+editable by clicking your own chip.
+
+**If your auth library exposes `current_user` to controllers** — Devise and
+Sorcery both do, because they include their helpers into `ActionController::Base`
+— it already works with no configuration at all. mbeditor reads the first
+non-blank of `name`, `full_name`, `display_name`, `username`, `login`, `email`.
+
+To point it at a different column:
+
+```ruby
+Mbeditor.configure do |c|
+  c.user_name_methods = %w[preferred_name email]
+end
+```
+
+**If `current_user` is your own method on `ApplicationController`**, mbeditor
+cannot see it — the engine's controllers inherit from `ActionController::Base`,
+not from your `ApplicationController`. Resolve the user yourself instead; the
+proc runs in the engine's controller, so `session`, `cookies` and `params` are
+all available:
+
+```ruby
+Mbeditor.configure do |c|
+  c.user_name_callback = proc { User.find_by(id: session[:user_id])&.name }
+end
+```
+
+An explicit `user_name_callback` always wins over the automatic lookup. If it
+raises or returns blank you get the generated name, and the reason is logged as
+`[mbeditor] user name lookup failed: …` rather than silently swallowed.
+
 ## Search performance
 
 Project search and JS definition lookups pick a backend per call:

data/app/assets/javascripts/mbeditor/components/EditorPanel.js

@@ -90,6 +90,7 @@ var EditorPanel = function EditorPanel(_ref) {
 
   var blameDecorationsRef = useRef([]);
   var gitLineDecorationsRef = useRef([]);
+  var routeDecorationsRef = useRef([]);
   // Latest git line-diff refresh, read by the poll effect so its interval does
   // not have to be torn down whenever the active tab changes.
   var gitLineRefreshRef = useRef(null);
@@ -1530,6 +1531,83 @@ var EditorPanel = function EditorPanel(_ref) {
     }
   }, [isBlameVisible, tab.path, blameData, isBlameLoading]);
 
+  // Inline route hints for controllers.
+  //
+  // Every `def` in a controller gets the verb and path that reach it drawn after
+  // the line, and a public action nothing routes to is called out — the question
+  // "is this actually reachable?" otherwise means reading config/routes.rb and
+  // mentally expanding `resources`. Routes come from the host app's own route
+  // set, which is the only thing that knows how those expand.
+  //
+  // Decorations, not view zones: a hint belongs on the line, and a zone would
+  // push the code around every time a file was opened.
+  useEffect(function () {
+    var editor = monacoRef.current;
+    if (!editor || !window.monaco) return;
+
+    var clear = function () {
+      if (!routeDecorationsRef.current.length) return;
+      routeDecorationsRef.current = editor.deltaDecorations(routeDecorationsRef.current, []);
+    };
+
+    if (!tab.path || !/^app\/controllers\/.+_controller\.rb$/.test(tab.path)) {
+      clear();
+      return;
+    }
+
+    var cancelled = false;
+    FileService.getRoutes(tab.path).then(function (data) {
+      if (cancelled) return;
+      var actions = (data && data.actions) || {};
+      var model = editor.getModel();
+      if (!model) return;
+
+      var decorations = [];
+      var text = model.getValue().split('\n');
+      // Only methods above the first `private`/`protected` are candidates for a
+      // route; flagging a helper below it as unrouted would be noise.
+      var visibilityEnded = false;
+
+      text.forEach(function (line, i) {
+        if (/^\s*(private|protected)\s*$/.test(line)) { visibilityEnded = true; return; }
+        var m = line.match(/^\s*def\s+(?:self\.)?([a-zA-Z_][a-zA-Z0-9_]*[?!=]?)/);
+        if (!m) return;
+
+        var name = m[1];
+        var routes = actions[name];
+        var lineNo = i + 1;
+        var col = line.length + 1;
+
+        if (routes && routes.length) {
+          var label = routes.map(function (r) { return r.verb + ' ' + r.path; }).join('  ·  ');
+          decorations.push({
+            range: new window.monaco.Range(lineNo, col, lineNo, col),
+            options: {
+              after: { content: '  ' + label, inlineClassName: 'mbeditor-route-hint' },
+              hoverMessage: routes.map(function (r) {
+                return { value: '`' + r.verb + ' ' + r.path + '`' + (r.name ? ' — `' + r.name + '_path`' : '') };
+              }),
+              showIfCollapsed: true
+            }
+          });
+        } else if (!visibilityEnded && !/[?!=]$/.test(name) && name !== 'initialize') {
+          decorations.push({
+            range: new window.monaco.Range(lineNo, col, lineNo, col),
+            options: {
+              after: { content: '  no route', inlineClassName: 'mbeditor-route-hint-none' },
+              hoverMessage: [{ value: 'No route in this application dispatches to this action.' }],
+              showIfCollapsed: true
+            }
+          });
+        }
+      });
+
+      routeDecorationsRef.current = editor.deltaDecorations(routeDecorationsRef.current, decorations);
+    }).catch(function () { /* hints are additive; a failure just means none */ });
+
+    return function () { cancelled = true; clear(); };
+  }, [tab.path, tab.externalContentVersion, monacoReady]);
+
   // Render Blame block headers (author + summary) above contiguous commit regions.
   useEffect(function () {
     if (!monacoRef.current || !window.monaco || !isBlameVisible || !blameData) return;

data/app/assets/javascripts/mbeditor/components/MbeditorApp.js

@@ -4217,7 +4217,12 @@ var MbeditorApp = function MbeditorApp() {
             !toolbarIconOnly && " Git"
           )
         ),
-        collabEnabled && collabIdentity && React.createElement(
+        // Your own chip appears only once someone else is actually connected.
+        // Alone it told you nothing — Action Cable is up in any normal dev setup,
+        // so it sat in the toolbar permanently announcing a session of one. While
+        // pairing it earns its place: it is how your peers see you, and it is the
+        // control for renaming yourself.
+        collabEnabled && collabIdentity && collabPeerIds.length > 0 && React.createElement(
           React.Fragment,
           null,
           React.createElement("div", { className: "statusbar-sep" }),