sdoc_live 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c308a3b0c63dae1cd0325824aecadac55373be489c0371d7a00710129527533e
-  data.tar.gz: c69d278e885d057d746c433431333a10bd34e9595e9b881a99c8ebe38569914f
+  metadata.gz: 2632d4b9ea967fd91af45d93010c1f507813c88ed9665a1592ff9667fd65d300
+  data.tar.gz: 5160265deb94355bf35d442f192cc2917f4900e887e69911039755af4135508a
 SHA512:
-  metadata.gz: f82f91308407a7a993f5fd58bfaf26490e02ad7ee91edfa7d5065faea40411638c461011820efa61f1939bf671915f2de5297bf5fdad9868a0e7fa45ad56b0e9
-  data.tar.gz: 0c0930e0ab7c5196057648904952eadbd8674abd79a2972081b0d0ed698128e01b70c0a4a6ecb4b4490a2061bbdd3d059fe7a458c9c3d49af3cc5e08a5047f82
+  metadata.gz: ab62868d6ea0993036eb970cee004df241813b6b7183784893a329774238496045e9f5af87fe747015bb302d733e0c6b638a105c8d0e32562934037a914f4a95
+  data.tar.gz: 3c864f88b8eebe761424c695ee85ba0bad5659e51ee3e5bc38d5fdbaa16a929f085cb2c5a7df572d161ba64ce71a635d1a186c732ddfc045183b369c5604fc83

data/README.md

@@ -26,15 +26,7 @@ Then run `bundle install`.
 
 ## Usage
 
-### 1. Mount the Engine
-
-Add to your `config/routes.rb`:
-
-```ruby
-mount SdocLive::Engine, at: "/doc"
-```
-
-### 2. Puma Plugin (Development Watch Mode)
+### 1. Puma Plugin (Development Watch Mode)
 
 Add to your `config/puma.rb`:
 
@@ -46,7 +38,7 @@ end
 
 This watches `app/` and `lib/` for `.rb` file changes and automatically regenerates SDoc documentation.
 
-### 3. Rake Task (Manual / Deploy)
+### 2. Rake Task (Manual / Deploy)
 
 ```bash
 rake sdoc:build
@@ -77,6 +69,9 @@ SdocLive.configure do |config|
 
   # Additional RDoc options passed to the SDoc generator
   # config.rdoc_options = ["--all", "--hyperlink-all"]
+
+  # URL path where documentation is served (default: "/doc")
+  # config.mount_path = "/doc"
 end if defined?(SdocLive)
 ```
 
@@ -85,7 +80,7 @@ end if defined?(SdocLive)
 1. **Development**: Puma boots → forks a child process that runs `SdocLive::Generator#build_watch`
 2. The `listen` gem monitors `app/` and `lib/` for `.rb` file changes
 3. On change, SDoc regenerates documentation into `tmp/doc/`
-4. Docs are served by the mounted engine (e.g. at `/doc`)
+4. Docs are served via middleware at the configured `mount_path` (default: `/doc`)
 5. Clean subprocess management with bidirectional lifecycle monitoring (Puma ↔ SDoc)
 
 ## License

data/lib/sdoc_live/engine.rb

@@ -7,34 +7,34 @@ module SdocLive
     end
 
     initializer "sdoc_live.static" do
-      doc_root = (SdocLive.configuration.output_dir || Rails.root.join("tmp", "doc")).to_s
+      config = SdocLive.configuration
+      doc_root = (config.output_dir || Rails.root.join("tmp", "doc")).to_s
+      mount_path = config.mount_path
 
-      config.middleware.use(SdocLive::StaticFiles, doc_root)
+      Rails.application.middleware.insert_before(Rails::Rack::Logger, SdocLive::StaticFiles, doc_root, mount_path)
     end
 
   end
 
   class StaticFiles
 
-    def initialize(app, doc_root)
+    def initialize(app, doc_root, mount_path)
       @app = app
       @doc_root = doc_root
+      @mount_path = mount_path.chomp("/")
     end
 
     def call(env)
-      mount_path = find_mount_path(env)
-      return @app.call(env) unless mount_path
-
       path_info = env["PATH_INFO"]
 
-      if path_info == mount_path
+      if path_info == @mount_path
         query = env["QUERY_STRING"].to_s.empty? ? "" : "?#{ env['QUERY_STRING'] }"
-        return [301, { "location" => "#{ mount_path }/#{ query }" }, []]
+        return [301, { "location" => "#{ @mount_path }/#{ query }" }, []]
       end
 
-      return @app.call(env) unless path_info.start_with?("#{ mount_path }/")
+      return @app.call(env) unless path_info.start_with?("#{ @mount_path }/")
 
-      relative_path = path_info.delete_prefix(mount_path)
+      relative_path = path_info.delete_prefix(@mount_path)
       relative_path = "/index.html" if relative_path == "/"
 
       file_path = File.join(@doc_root, relative_path)
@@ -49,14 +49,6 @@ module SdocLive
 
     private
 
-    def find_mount_path(env)
-      @mount_path ||= begin
-        routes = Rails.application.routes.routes
-        route = routes.detect { |r| r.app.respond_to?(:app) && r.app.app == SdocLive::Engine }
-        route&.path&.spec&.to_s&.gsub("(.:format)", "")&.chomp("/")
-      end
-    end
-
     def serve_file(path)
       content_type = Rack::Mime.mime_type(File.extname(path), "application/octet-stream")
       body = File.read(path, mode: "rb")

data/lib/sdoc_live/version.rb

@@ -1,5 +1,5 @@
 module SdocLive
 
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 
 end

data/lib/sdoc_live.rb

@@ -19,13 +19,14 @@ module SdocLive
   class Configuration
 
     attr_accessor :output_dir, :title, :main_file, :source_dirs, :watch_dirs,
-                  :watch_file_type_regex, :rdoc_options
+                  :watch_file_type_regex, :rdoc_options, :mount_path
 
     def initialize
       @source_dirs = ["app", "lib"]
       @watch_file_type_regex = /\.rb$/
       @title = "Documentation"
       @main_file = "README.md"
+      @mount_path = "/doc"
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdoc_live
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - 16554289+optimuspwnius@users.noreply.github.com