sdoc_live 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7490903924197e3ee4eff1894ade54c6c7c21537816a4b634302900736dfe6c8
-  data.tar.gz: 46e30d39c620d14dbc2a420654d026e7fa0a290ede2eb36e2540c33ac8117178
+  metadata.gz: 1653429aed4ce0456d7df0c26da4d8ccdde41967cfd91ab2824c24c5da7dc975
+  data.tar.gz: a22e7b188e50c419cf7160dbc2c2b32160320ca46015306cf19e08efde37dc11
 SHA512:
-  metadata.gz: 00ccad038240b21408c3adf4360db50e8edcb90554573f5305837cb139c621d272c842622b925c03f689eaabaff30b661548c67cddece8cc9c2609dd96bbe7e0
-  data.tar.gz: bc2eccd08b28280f4ee6ff178b5f9dde689c64cddab2df9a4954702f3dbebf5e3e8f35044b7960f1f958919207f10ab9c683081fab8edfab714b51ad94627176
+  metadata.gz: 4c592cd42c497602bbb49b90e9f1603c407139e8c00e0f093f26bfc412a5c160b1de729ce70c4db14a5efbe89967e51eceda9bca695273f7e252c83e6dfd639a
+  data.tar.gz: 87c2c8adc1768ed43cba4aad88b425a16279920893ab5e326c63555e5653c1bce416980d868eb1e17d52162277ce80bc009466df465e38743ba266f8c081df79

data/README.md

@@ -1,6 +1,6 @@
 # SDoc Live
 
-Live SDoc generation for Rails — watches your source files and auto-regenerates API documentation on changes. Serves docs from `public/doc/` so they're available at `/doc/index.html` in development.
+Live SDoc generation for Rails — watches your source files and auto-regenerates API documentation on changes. Serves docs via a mountable engine at a path you choose (e.g. `/doc`).
 
 ## Requirements
 
@@ -26,7 +26,15 @@ Then run `bundle install`.
 
 ## Usage
 
-### 1. Puma Plugin (Development Watch Mode)
+### 1. Mount the Engine
+
+Add to your `config/routes.rb`:
+
+```ruby
+mount SdocLive::Engine, at: "/doc"
+```
+
+### 2. Puma Plugin (Development Watch Mode)
 
 Add to your `config/puma.rb`:
 
@@ -38,9 +46,7 @@ end
 
 This watches `app/` and `lib/` for `.rb` file changes and automatically regenerates SDoc documentation.
 
-Docs are served at `/doc/index.html` via Rails' `public/` directory.
-
-### 2. Rake Task (Manual / Deploy)
+### 3. Rake Task (Manual / Deploy)
 
 ```bash
 rake sdoc:build
@@ -66,8 +72,8 @@ SdocLive.configure do |config|
   # Regex for file types that trigger regeneration (default: /\.rb$/)
   # config.watch_file_type_regex = /\.(rb|md)$/
 
-  # Override the output directory (default: Rails.root.join("public", "doc"))
-  # config.output_dir = Rails.root.join("public", "doc")
+  # Override the output directory (default: Rails.root.join("tmp", "doc"))
+  # config.output_dir = Rails.root.join("tmp", "doc")
 
   # Additional RDoc options passed to the SDoc generator
   # config.rdoc_options = ["--all", "--hyperlink-all"]
@@ -78,8 +84,8 @@ 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 `public/doc/`
-4. Docs are immediately available at `/doc/index.html`
+3. On change, SDoc regenerates documentation into `tmp/doc/`
+4. Docs are served by the mounted engine (e.g. at `/doc`)
 5. Clean subprocess management with bidirectional lifecycle monitoring (Puma ↔ SDoc)
 
 ## License

data/lib/sdoc_live/engine.rb

@@ -6,6 +6,37 @@ module SdocLive
       load File.expand_path("../tasks/sdoc_live.rake", __dir__)
     end
 
+    initializer "sdoc_live.static" do |app|
+      doc_root = (SdocLive.configuration.output_dir || app.root.join("tmp", "doc")).to_s
+
+      SdocLive::Engine.routes.draw do
+        doc_app = ::Rack::Static.new(
+          ->(_) { [404, { "content-type" => "text/plain" }, ["Not Found"]] },
+          urls: ["/"],
+          root: doc_root,
+          index: "index.html"
+        )
+
+        mount doc_app, at: "/"
+      end
+    end
+
+    initializer "sdoc_live.trailing_slash" do
+      SdocLive::Engine.middleware.use(Class.new do
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          if env["PATH_INFO"] == ""
+            [301, { "location" => "#{ env['SCRIPT_NAME'] }/", "content-type" => "text/html" }, ["Redirecting..."]]
+          else
+            @app.call(env)
+          end
+        end
+      end)
+    end
+
   end
 
 end

data/lib/sdoc_live/generator.rb

@@ -10,7 +10,7 @@ module SdocLive
 
       config = SdocLive.configuration
 
-      @output_dir = config.output_dir || @root.join("public", "doc")
+      @output_dir = config.output_dir || @root.join("tmp", "doc")
       @title      = config.title
       @main_file  = config.main_file
 

data/lib/sdoc_live/version.rb

@@ -1,5 +1,5 @@
 module SdocLive
 
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 
 end

metadata

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