mbeditor 0.12.1 → 0.12.3

data/app/controllers/mbeditor/editors_controller.rb

@@ -1072,6 +1072,19 @@ module Mbeditor
       }
     end
 
+    # GET /mbeditor/routes?path=app/controllers/users_controller.rb
+    #
+    # Which routes reach each action in a controller, for the inline hints the
+    # editor draws beside every `def`. Returns {} for anything that is not a
+    # controller rather than erroring — the client asks for every Ruby file it
+    # opens and should not have to know the convention.
+    def routes
+      key = RouteService.controller_key(params[:path].to_s)
+      return render json: { controller: nil, actions: {} } unless key
+
+      render json: { controller: key, actions: RouteService.for_controller(key) }
+    end
+
     # GET /mbeditor/related_files?path=...
     def related_files
       path = resolve_path(params[:path])

data/app/services/mbeditor/model_graph_service.rb

@@ -22,7 +22,16 @@ module Mbeditor
       SolidQueue SolidCache SolidCable
     ].freeze
 
-    MAX_MODELS = 300
+    # Cap on models drawn. 300 was chosen before the layout could handle that
+    # many; a schema slightly over it silently lost models and only said
+    # "(truncated)". Raised, and configurable for anything larger — the cost of
+    # a bigger graph is now the browser's rendering, not the layout.
+    DEFAULT_MAX_MODELS = 1000
+
+    def self.max_models
+      value = Mbeditor.configuration.model_graph_max_models.to_i
+      value.positive? ? value : DEFAULT_MAX_MODELS
+    end
 
     # Only the first few columns travel: the diagram box shows that many and the
     # full list is a click away in the schema modal, which fetches its own data
@@ -86,7 +95,8 @@ module Mbeditor
         classes = model_classes
         return unavailable("No ActiveRecord models found in this application.") if classes.empty?
 
-        models = classes.first(MAX_MODELS).map { |klass| describe_model(klass, root) }
+        limit = max_models
+        models = classes.first(limit).map { |klass| describe_model(klass, root) }
         known = models.map { |m| m[:name] }.to_set
 
         {
@@ -95,7 +105,7 @@ module Mbeditor
           # Edges to classes outside the graph (a gem's model, or a typo in
           # class_name:) would render as arrows into nowhere.
           edges: models.flat_map { |m| m.delete(:edges) }.select { |e| known.include?(e[:to]) }.uniq,
-          truncated: classes.length > MAX_MODELS,
+          truncated: classes.length > limit,
           generatedAt: Time.now.utc.iso8601
         }
       rescue StandardError => e

data/app/services/mbeditor/route_service.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Mbeditor
+  # Which routes reach a controller's actions, for the inline hints shown beside
+  # each `def` in a controller file.
+  #
+  # Read from the host app's own route set rather than by parsing config/routes.rb.
+  # mbeditor runs inside the host app, so the routes are already built — and they
+  # are the only source that accounts for `resources` expansion, `member`/
+  # `collection` blocks, scopes, constraints, mounted engines and anything a
+  # routes file does in plain Ruby. Parsing the file would get all of that wrong.
+  module RouteService
+    module_function
+
+    # Actions with no route are worth calling out, but only for controllers Rails
+    # would actually dispatch to. These are the inherited ones every controller
+    # has and nobody routes.
+    NON_ACTION_METHODS = %w[
+      new inspect method_of to_s hash class dup freeze
+    ].freeze
+
+    # "app/controllers/admin/users_controller.rb" -> "admin/users", which is the
+    # key Rails stores in a route's defaults.
+    def controller_key(relative_path)
+      path = relative_path.to_s.sub(%r{\A/+}, "")
+      match = path.match(%r{\Aapp/controllers/(.+)_controller\.rb\z})
+      return nil unless match
+
+      match[1]
+    end
+
+    # => { "show" => [{ verb:, path:, name: }], ... }
+    def for_controller(key)
+      return {} if key.nil? || key.empty?
+      return {} unless defined?(Rails) && Rails.respond_to?(:application) && Rails.application
+
+      routes_for(key)
+    rescue StandardError
+      # A broken route set must not take the editor down with it — the file still
+      # opens, just without hints.
+      {}
+    end
+
+    def routes_for(key)
+      out = {}
+      Rails.application.routes.routes.each do |route|
+        defaults = route.defaults
+        next unless defaults[:controller] == key
+
+        action = defaults[:action].to_s
+        next if action.empty?
+
+        (out[action] ||= []) << {
+          verb: verb_for(route),
+          path: path_for(route),
+          name: route.name
+        }
+      end
+      out
+    end
+    private_class_method :routes_for
+
+    # Rails has moved this between a String and a Regexp across versions; both
+    # stringify usefully, but a Regexp needs its slashes stripped.
+    def verb_for(route)
+      verb = route.verb
+      verb = verb.source.gsub(%r{[$^]}, "") if verb.is_a?(Regexp)
+      verb = verb.to_s
+      verb.empty? ? "ANY" : verb
+    end
+    private_class_method :verb_for
+
+    # "(.:format)" is noise in a hint that has to fit on one line.
+    def path_for(route)
+      route.path.spec.to_s.sub(/\(\.:format\)\z/, "")
+    end
+    private_class_method :path_for
+  end
+end

data/lib/mbeditor/configuration.rb

@@ -5,14 +5,14 @@ module Mbeditor
     attr_accessor :allowed_environments, :workspace_root, :excluded_paths, :rubocop_command, :rubocop_server,
                   :redmine_enabled, :redmine_url, :redmine_api_key, :redmine_ticket_source,
                   :test_framework, :test_command, :test_timeout,
-                  :authenticate_with, :authentication_cache_ttl, :user_name_callback, :user_name_methods,
+                  :authenticate_with, :cable_authenticate_with, :authentication_cache_ttl, :user_name_callback, :user_name_methods,
                   :lint_timeout, :base_branch_candidates, :git_timeout, :search_timeout,
                   :ruby_def_include_dirs, :related_files_custom_paths,
                   :mount_path, :resilient_routing, :js_global_identifiers,
                   :js_program, :js_program_exclude,
                   :js_syntax_check, :babel_standalone_path,
                   :ruby_lsp, :ruby_lsp_command, :ruby_lsp_timeout,
-                  :exception_capture,
+                  :exception_capture, :model_graph_max_models,
                   :search_respect_gitignore, :ripgrep_command
 
     def initialize
@@ -58,6 +58,16 @@ module Mbeditor
       @ruby_def_include_dirs  = %w[app/models app/controllers app/helpers app/concerns]
       @related_files_custom_paths = []
       @authentication_cache_ttl = 0
+      # Authentication for the collaboration WebSocket. nil falls back to
+      # authenticate_with.
+      #
+      # Exists because the two contexts genuinely differ: a WebSocket subscribe
+      # runs no controller, so anything a before_action populates —
+      # ActiveSupport::CurrentAttributes, an Authlogic session, a memoised
+      # current_user — is nil or raises here, and the hook then denies the socket
+      # while working perfectly over HTTP. Set this to a proc that resolves the
+      # user from `session` directly when the HTTP hook cannot.
+      @cable_authenticate_with = nil
       @user_name_callback = nil # proc resolved in controller context (instance_exec) → collaboration display name; nil falls through to current_user, then to the client-generated name
       # Attributes tried on current_user, in order, when no user_name_callback
       # is set. First non-blank one wins. Name your own column here rather than
@@ -84,6 +94,9 @@ module Mbeditor
       # same exposure the log panel already has, since it tails the dev log.
       # Set to false to record nothing.
       @exception_capture = :auto
+      # Models drawn in the model graph before it reports itself truncated.
+      # nil uses ModelGraphService::DEFAULT_MAX_MODELS.
+      @model_graph_max_models = nil
       @mount_path = nil # explicit URL prefix override; nil falls through to detection/"/mbeditor"
       @resilient_routing = true # serve /mbeditor from middleware so the editor survives a broken host routes.rb; false is the escape hatch
     end

data/lib/mbeditor/engine.rb

@@ -54,9 +54,23 @@ module Mbeditor
       # Insert before CheckPending so our middleware wraps it and can rescue
       # the error it raises. Falls back silently if CheckPending is absent
       # (e.g. host app does not use ActiveRecord).
-      # Note: app.middleware is a MiddlewareStackProxy during initializers and
-      # does not support .to_a — rely solely on defined? to detect ActiveRecord.
-      if defined?(ActiveRecord::Migration::CheckPending)
+      #
+      # The constant being defined is not enough: Rails only puts CheckPending
+      # in the stack when config.active_record.migration_error is :page_load, so
+      # an app that loads ActiveRecord with any other setting has the constant
+      # but no middleware — and insert_before then raises "No such middleware",
+      # taking the host app's boot down with it. app.middleware is a
+      # MiddlewareStackProxy here and cannot be inspected, so the only way to
+      # know is to try it. Losing this middleware costs a friendlier pending-
+      # migration page, which is never worth failing to boot over.
+      # Rescuing the call is not an option: app.middleware is a
+      # MiddlewareStackProxy, so insert_before only records the operation and the
+      # "No such middleware" error surfaces later, during merge_into. Test the
+      # same condition Rails uses to add CheckPending in the first place.
+      migration_error = app.config.respond_to?(:active_record) &&
+                        app.config.active_record[:migration_error]
+
+      if defined?(ActiveRecord::Migration::CheckPending) && migration_error == :page_load
         app.middleware.insert_before ActiveRecord::Migration::CheckPending,
                                      Mbeditor::Rack::HandlePendingMigrations
       end

data/lib/mbeditor/route_map.rb

@@ -44,6 +44,7 @@ module Mbeditor
     get    'client_config',   to: 'editors#client_config'
     get    'related_files',   to: 'editors#related_files'
     get    'model_schema',    to: 'editors#model_schema'
+    get    'routes',          to: 'editors#routes'
     get    'changelog',       to: 'editors#changelog'
     get    'git_info',        to: 'editors#git_info'
     get    'git_status',      to: 'editors#git_status'

data/lib/mbeditor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mbeditor
-  VERSION = "0.12.1"
+  VERSION = "0.12.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbeditor
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.3
 platform: ruby
 authors:
 - Oliver Noonan
@@ -133,6 +133,7 @@ files:
 - app/services/mbeditor/rails_related_files_service.rb
 - app/services/mbeditor/redmine_service.rb
 - app/services/mbeditor/ri_definition_service.rb
+- app/services/mbeditor/route_service.rb
 - app/services/mbeditor/ruby_definition_service.rb
 - app/services/mbeditor/safe_path.rb
 - app/services/mbeditor/schema_service.rb