sdoc_live 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c58eaf82f18b4feb7c431156e8ba8be018e22eb57b8b62d69e0e0c503e2085c
-  data.tar.gz: 372965feda50bdc4bc08b196d3acbbc43af6fe2b7fb4461b622bbb4f80c0befa
+  metadata.gz: 01316e7563fe0c297ff8ee3304b86fcab074251063ab2c503369a8288362210c
+  data.tar.gz: d4d839d93250944f290f0157282213c8888daf1c4bfbb2872c17b0ff1034b0b7
 SHA512:
-  metadata.gz: 224cc2e187603628bb1e76664ef87ff8f6c33640d34512d38e7f262b1e96490a3e05dc07ed2cc08f78e372adf8a016bae6c55199f2a9de3c57ebbcc1ea2e5bfb
-  data.tar.gz: dc1222d122c5992e1e9505e752305a28b164b0d55dff3bbdc3f3b19aae4d630c76d6940be15fd45201426e1c548172bea7722b61cf6f3f95eb4ffec2ef02c2f2
+  metadata.gz: 0fed3626046989a0448f0368d0d3d65d3889e82ec71cb43775969e832824f156dc773f25b2c9a0e7c92c284f6d76227045fc46e8bbd4e6052f397f99c1cbbf15
+  data.tar.gz: 7b73e3fe0c6aecc0414120f1af80e4e92ecde9ddc314939ce3165ace61398c31d5a2f85238aec220395b2bd57ed78c4f3e949862eb0d5b85841fd163ead4af75

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

@@ -6,47 +6,55 @@ 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
+    initializer "sdoc_live.static" do
+      config = SdocLive.configuration
+      doc_root = (config.output_dir || Rails.root.join("tmp", "doc")).to_s
+      mount_path = config.mount_path
+
+      app.middleware.use(SdocLive::StaticFiles, doc_root, mount_path)
+    end
+
+  end
+
+  class StaticFiles
+
+    def initialize(app, doc_root, mount_path)
+      @app = app
+      @doc_root = doc_root
+      @mount_path = mount_path.chomp("/")
     end
 
-    initializer "sdoc_live.trailing_slash", after: :add_routing_paths do |app|
-      mount_path = nil
+    def call(env)
+      path_info = env["PATH_INFO"]
 
-      app.routes.routes.each do |route|
-        if route.app.respond_to?(:app) && route.app.app == SdocLive::Engine
-          mount_path = route.path.spec.to_s.gsub("(.:format)", "").chomp("/")
-          break
-        end
+      if path_info == @mount_path
+        query = env["QUERY_STRING"].to_s.empty? ? "" : "?#{ env['QUERY_STRING'] }"
+        return [301, { "location" => "#{ @mount_path }/#{ query }" }, []]
       end
 
-      if mount_path && !mount_path.empty?
-        app.middleware.use(Class.new do
-          define_method(:initialize) { |a| @app = a }
-
-          define_method(:call) do |env|
-            if env["PATH_INFO"] == mount_path && !env["PATH_INFO"].end_with?("/")
-              query = env["QUERY_STRING"].to_s.empty? ? "" : "?#{ env['QUERY_STRING'] }"
-              [301, { "location" => "#{ mount_path }/#{ query }", "content-type" => "text/html" }, ["Redirecting..."]]
-            else
-              @app.call(env)
-            end
-          end
-        end)
+      return @app.call(env) unless path_info.start_with?("#{ @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)
+      file_path = File.join(file_path, "index.html") if File.directory?(file_path)
+
+      if File.file?(file_path)
+        serve_file(file_path)
+      else
+        @app.call(env)
       end
     end
 
+    private
+
+    def serve_file(path)
+      content_type = Rack::Mime.mime_type(File.extname(path), "application/octet-stream")
+      body = File.read(path, mode: "rb")
+      [200, { "content-type" => content_type, "content-length" => body.bytesize.to_s }, [body]]
+    end
+
   end
 
 end

data/lib/sdoc_live/version.rb

@@ -1,5 +1,5 @@
 module SdocLive
 
-  VERSION = "0.1.8"
+  VERSION = "0.1.10"
 
 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.8
+  version: 0.1.10
 platform: ruby
 authors:
 - 16554289+optimuspwnius@users.noreply.github.com