markdowndocs 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cebbfbc9bd8562902775c6661f2241c7c5556b1ccecdc4cc6b993804d4c58e02
-  data.tar.gz: af7ab61db222e6dbd9dbecb557cc713068809fdd26604ed629c7b6a49c122e42
+  metadata.gz: 1a94678490cfbf0ad5351412ccb04dcf9938d0bfae47184b333a18f06d8a605c
+  data.tar.gz: 9214f78fe1209a67c633909bbe8abd2e09af3fc229e3aee016cbb59604e79b77
 SHA512:
-  metadata.gz: 5389780ce9d8ad500df799b93bc5790cbca71651f2d320249be1d77cccb85124a484fc519c889e3fd2d8a8d1ec4458d9b65ba0925e706af2835261468e65bbdf
-  data.tar.gz: 9ccbdda3525cc1bd2268214dd684643d5c200da356495cdeeb8f99fa364bee4615910ad20334ee943dd95b75502bc20afb8a5888ab95ed7f45cb0baa0b92804e
+  metadata.gz: 24d803af2159fc9deedb4a2b681d2689b4329a88fb384391e820df9adeff787ca9c2206bfae41f511340b0b78d4c0066f1639b0f48462ab42fcb2e80b021ec90
+  data.tar.gz: '02359d490827c09532c4e063e6fc1596cbdaa89b0632404fe18d40cdb16513780f4b19029e60e9b3619174f8f3cc1f4186b91f476b7d799a3d833e41ee4f7b35'

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2026-03-18
+
+### Changed
+
+- Stimulus controllers now auto-register via a single JS entry point (`import "markdowndocs"`), following the ActionText/Trix pattern. Host apps no longer need to pin individual controllers in their importmap.
+- Install generator adds `import "markdowndocs"` to the host app's `application.js` instead of injecting importmap pins.
+- Added engine and generator specs for the new JS registration flow.
+
 ## [0.2.1] - 2026-02-21
 
 ### Fixed
@@ -76,6 +84,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - i18n support for all UI strings
 - Install generator (`rails generate markdowndocs:install`)
 
+[0.2.2]: https://github.com/dschmura/markdowndocs/releases/tag/v0.2.2
 [0.2.1]: https://github.com/dschmura/markdowndocs/releases/tag/v0.2.1
 [0.2.0]: https://github.com/dschmura/markdowndocs/releases/tag/v0.2.0
 [0.1.5]: https://github.com/dschmura/markdowndocs/releases/tag/v0.1.5

data/app/assets/javascripts/markdowndocs/application.js

@@ -0,0 +1,11 @@
+import DocsSearchController from "markdowndocs/controllers/docs_search_controller"
+import DocsModeController from "markdowndocs/controllers/docs_mode_controller"
+
+// Auto-register if Stimulus application exists on window, otherwise
+// the host app can import and register these controllers manually.
+if (window.Stimulus) {
+  window.Stimulus.register("docs-search", DocsSearchController)
+  window.Stimulus.register("docs-mode", DocsModeController)
+}
+
+export { DocsSearchController, DocsModeController }

data/app/controllers/markdowndocs/application_controller.rb

@@ -4,37 +4,19 @@ module Markdowndocs
   class ApplicationController < ::ApplicationController
     protect_from_forgery with: :exception
 
-    # Delegate unresolved route helpers to the host app via main_app.
-    # isolate_namespace blocks host helpers by default, and the commonly-used
-    # `helper Rails.application.routes.url_helpers` doesn't reliably win the
-    # method-lookup race — so host-app links like about_path can resolve
-    # against the engine's catch-all :slug route instead.  This delegation
-    # ensures host app route helpers always work correctly in engine views.
-    helper do
-      # Explicitly delegate root_path/root_url to the host app.
-      # The engine defines its own root route, so these helpers exist in the
-      # engine scope and method_missing won't intercept them — but they resolve
-      # to /docs/ instead of /. Engine views use markdowndocs.root_path directly.
-      def root_path(*args)
-        main_app.root_path(*args)
-      end
-
-      def root_url(*args)
-        main_app.root_url(*args)
-      end
-
-      def method_missing(method, *args, &block)
-        if main_app.respond_to?(method)
-          main_app.send(method, *args, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method, include_private = false)
-        main_app.respond_to?(method, include_private) || super
-      end
-    end
+    # Fix route helper isolation caused by isolate_namespace.
+    #
+    # The problem: host app route helpers (about_path, contact_path, etc.)
+    # exist in the view context but resolve against the engine's namespace,
+    # so about_path returns "/docs/about" instead of "/about".
+    #
+    # method_missing doesn't help because the methods already exist —
+    # they just resolve wrong. We need to override them explicitly.
+    #
+    # This before_action builds a helper module on first request (when
+    # routes are fully loaded) that defines every host app route helper
+    # as a delegation to main_app.
+    before_action :ensure_host_route_helpers
 
     # Support Rails 8 built-in authentication (allow_unauthenticated_access)
     # without requiring it — works with any auth system or none at all
@@ -44,5 +26,21 @@ module Markdowndocs
 
     # Resume session if the host app supports it (Rails 8 auth)
     before_action :resume_session, if: -> { respond_to?(:resume_session, true) }
+
+    private
+
+    def ensure_host_route_helpers
+      return if self.class.instance_variable_get(:@host_routes_delegated)
+
+      helper_module = Module.new do
+        Rails.application.routes.named_routes.names.each do |name|
+          define_method(:"#{name}_path") { |*args, **kwargs| main_app.send(:"#{name}_path", *args, **kwargs) }
+          define_method(:"#{name}_url") { |*args, **kwargs| main_app.send(:"#{name}_url", *args, **kwargs) }
+        end
+      end
+
+      self.class.helper(helper_module)
+      self.class.instance_variable_set(:@host_routes_delegated, true)
+    end
   end
 end

data/config/importmap.rb

@@ -3,6 +3,7 @@
 # Importmap pins for Markdowndocs engine.
 # These are automatically registered with the host app when importmap-rails is present.
 
+pin "markdowndocs", to: "markdowndocs/application.js"
 pin "markdowndocs/controllers/docs_search_controller", to: "markdowndocs/controllers/docs_search_controller.js"
 pin "markdowndocs/controllers/docs_mode_controller", to: "markdowndocs/controllers/docs_mode_controller.js"
 pin "minisearch", to: "markdowndocs/vendor/minisearch.min.js"

data/lib/generators/markdowndocs/install/install_generator.rb

@@ -20,25 +20,18 @@ module Markdowndocs
         route 'mount Markdowndocs::Engine, at: "/docs"'
       end
 
-      def pin_importmap_assets
-        importmap_file = Rails.root.join("config/importmap.rb").to_s
-        return unless File.exist?(importmap_file)
-
-        importmap_content = File.read(importmap_file)
-
-        pins = {
-          'pin "markdowndocs/controllers/docs_search_controller", to: "markdowndocs/controllers/docs_search_controller.js"' => "docs_search_controller",
-          'pin "markdowndocs/controllers/docs_mode_controller", to: "markdowndocs/controllers/docs_mode_controller.js"' => "docs_mode_controller",
-          'pin "minisearch", to: "markdowndocs/vendor/minisearch.min.js"' => "minisearch"
-        }
-
-        pins.each do |pin_line, name|
-          if importmap_content.include?(pin_line)
-            say_status :skip, "importmap pin for #{name} already present", :yellow
-          else
-            append_to_file importmap_file, "\n#{pin_line}\n"
-            say_status :pin, name, :green
-          end
+      def add_markdowndocs_import
+        js_file = Rails.root.join("app/javascript/application.js").to_s
+        return unless File.exist?(js_file)
+
+        js_content = File.read(js_file)
+        import_line = 'import "markdowndocs"'
+
+        if js_content.include?(import_line)
+          say_status :skip, "markdowndocs import already present in application.js", :yellow
+        else
+          append_to_file js_file, "\n#{import_line}\n"
+          say_status :import, "markdowndocs in application.js", :green
         end
       end
 
@@ -76,10 +69,8 @@ module Markdowndocs
           say "    @source \"#{Markdowndocs::Engine.root.join("app", "views")}/**/*.erb\";"
           say ""
         end
-        say "  Stimulus controllers are auto-registered via importmap.", :green
-        say "  If you use a custom Stimulus setup, register these controllers:"
-        say "    - markdowndocs/controllers/docs_mode_controller"
-        say "    - markdowndocs/controllers/docs_search_controller (when search is enabled)"
+        say "  Stimulus controllers are auto-registered via: import \"markdowndocs\"", :green
+        say "  If this was not added automatically, add it to app/javascript/application.js"
         say ""
       end
 

data/lib/markdowndocs/engine.rb

@@ -19,5 +19,14 @@ module Markdowndocs
         app.config.importmap.paths << root.join("config/importmap.rb")
       end
     end
+
+    initializer "markdowndocs.stimulus" do
+      Rails.application.config.after_initialize do
+        if defined?(Importmap)
+          # The pin is already added via importmap.rb
+          # Host app just needs: import "markdowndocs" in their application.js
+        end
+      end
+    end
   end
 end

data/lib/markdowndocs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Markdowndocs
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: markdowndocs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Dave Chmura
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -78,6 +77,7 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
+- app/assets/javascripts/markdowndocs/application.js
 - app/assets/javascripts/markdowndocs/controllers/docs_mode_controller.js
 - app/assets/javascripts/markdowndocs/controllers/docs_search_controller.js
 - app/assets/javascripts/markdowndocs/vendor/minisearch.min.js
@@ -111,7 +111,6 @@ metadata:
   homepage_uri: https://github.com/dschmura/markdowndocs
   source_code_uri: https://github.com/dschmura/markdowndocs
   changelog_uri: https://github.com/dschmura/markdowndocs/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A drop-in markdown documentation site for Rails apps
 test_files: []