RubyGems - prauga-flexdoc - Versions diffs - 0.1.0 - Mend

prauga-flexdoc 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +7 -0
data/LICENSE +667 -0
data/README.md +42 -0
data/assets/flexdoc.standalone.css +1 -0
data/assets/flexdoc.standalone.js +52 -0
data/lib/prauga/flexdoc/config.rb +15 -0
data/lib/prauga/flexdoc/host.rb +67 -0
data/lib/prauga/flexdoc/rack_app.rb +16 -0
data/lib/prauga/flexdoc/rails.rb +21 -0
data/lib/prauga/flexdoc/response.rb +20 -0
data/lib/prauga/flexdoc/version.rb +7 -0
data/lib/prauga/flexdoc.rb +8 -0
metadata +130 -0

data/lib/prauga/flexdoc/config.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Prauga
+  module FlexDoc
+    Config = Data.define(:path, :spec_url, :title, :theme, :try_it_enabled) do
+      def initialize(path: "/docs", spec_url: "/openapi.json", title: "API Reference", theme: "system", try_it_enabled: true)
+        normalized = "/#{path.to_s.gsub(%r{\A/+|/+$}, "")}"
+        normalized = "/docs" if normalized == "/"
+        raise ArgumentError, "FlexDoc theme must be system, light, or dark" unless %w[system light dark].include?(theme)
+        super(path: normalized, spec_url:, title:, theme:, try_it_enabled: !!try_it_enabled)
+      end
+    end
+  end
+end

data/lib/prauga/flexdoc/host.rb ADDED Viewed

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+require "cgi"
+require "digest"
+require "json"
+module Prauga
+  module FlexDoc
+    class Host
+      IMMUTABLE_CACHE = "public, max-age=31536000, immutable"
+      attr_reader :config, :fingerprint
+      def initialize(config = Config.new, assets_dir: nil)
+        @config = config
+        root = assets_dir || File.expand_path("../../../assets", __dir__)
+        @javascript = File.binread(File.join(root, "flexdoc.standalone.js"))
+        @css = File.binread(File.join(root, "flexdoc.standalone.css"))
+        @fingerprint = Digest::SHA256.hexdigest(@javascript + "\0" + @css)[0, 16]
+      end
+      def response_for_path(path)
+        return documentation if path == config.path || path == "#{config.path}/"
+        return renderer_javascript if path == "#{config.path}/__flexdoc/renderer.js"
+        return renderer_css if path == "#{config.path}/__flexdoc/renderer.css"
+        Response.new(status: 404, content_type: "text/plain; charset=utf-8", body: "Not Found", cache_control: nil)
+      end
+      def documentation
+        options = {
+          contractVersion: "1",
+          title: config.title,
+          theme: config.theme,
+          tryIt: { enabled: config.try_it_enabled }
+        }
+        title = CGI.escapeHTML(config.title.to_s)
+        path = CGI.escapeHTML(config.path)
+        spec_url = safe_json(config.spec_url)
+        options_json = safe_json(options)
+        body = <<~HTML.delete("\n")
+          <!doctype html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,viewport-fit=cover"><title>#{title}</title><link rel="stylesheet" href="#{path}/__flexdoc/renderer.css?v=#{fingerprint}"></head><body><div id="flexdoc-root"></div><script>window.__FLEXDOC_SPEC_URL__=#{spec_url};window.__FLEXDOC_OPTIONS__=#{options_json};</script><script src="#{path}/__flexdoc/renderer.js?v=#{fingerprint}"></script><script>(async function(){const root=document.getElementById('flexdoc-root');try{const baseUri=new URL(window.__FLEXDOC_SPEC_URL__,window.location.href).toString();const response=await fetch(baseUri);if(!response.ok)throw new Error('Unable to load OpenAPI specification: HTTP '+response.status);const spec=await response.json();const config={spec:spec,options:window.__FLEXDOC_OPTIONS__||{},baseUri:baseUri};if(window.FlexDocStandalone.mountAsync)await window.FlexDocStandalone.mountAsync(root,config);else window.FlexDocStandalone.mount(root,config);}catch(error){root.textContent=error instanceof Error?error.message:String(error);}})();</script></body></html>
+        HTML
+        Response.new(status: 200, content_type: "text/html; charset=utf-8", body:, cache_control: "no-cache")
+      end
+      def renderer_javascript
+        Response.new(status: 200, content_type: "application/javascript; charset=utf-8", body: @javascript, cache_control: IMMUTABLE_CACHE)
+      end
+      def renderer_css
+        Response.new(status: 200, content_type: "text/css; charset=utf-8", body: @css, cache_control: IMMUTABLE_CACHE)
+      end
+      private
+      def safe_json(value)
+        JSON.generate(value)
+          .gsub("<", "\\u003c")
+          .gsub(">", "\\u003e")
+          .gsub("&", "\\u0026")
+          .gsub("\u2028", "\\u2028")
+          .gsub("\u2029", "\\u2029")
+      end
+    end
+  end
+end

data/lib/prauga/flexdoc/rack_app.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Prauga
+  module FlexDoc
+    class RackApp
+      def initialize(host = Host.new)
+        @host = host
+      end
+      def call(env)
+        path = "#{env.fetch("SCRIPT_NAME", "")}#{env.fetch("PATH_INFO", "")}"
+        @host.response_for_path(path).rack
+      end
+    end
+  end
+end

data/lib/prauga/flexdoc/rails.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Prauga
+  module FlexDoc
+    module Rails
+      module_function
+      def mount(mapper, host: Host.new, at: nil, as: :flexdoc)
+        mount_path = at || host.config.path
+        normalized_mount_path = Config.new(path: mount_path).path
+        if normalized_mount_path != host.config.path
+          raise ArgumentError,
+                "Rails mount path #{normalized_mount_path.inspect} must match FlexDoc host path #{host.config.path.inspect}"
+        end
+        mapper.mount RackApp.new(host), at: normalized_mount_path, as: as
+        host
+      end
+    end
+  end
+end

data/lib/prauga/flexdoc/response.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Prauga
+  module FlexDoc
+    Response = Data.define(:status, :content_type, :body, :cache_control) do
+      def headers
+        result = {
+          "content-type" => content_type,
+          "content-length" => body.bytesize.to_s
+        }
+        result["cache-control"] = cache_control if cache_control
+        result
+      end
+      def rack
+        [status, headers, [body]]
+      end
+    end
+  end
+end

data/lib/prauga/flexdoc/version.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Prauga
+  module FlexDoc
+    VERSION = "0.1.0"
+  end
+end

data/lib/prauga/flexdoc.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require_relative "flexdoc/version"
+require_relative "flexdoc/config"
+require_relative "flexdoc/response"
+require_relative "flexdoc/host"
+require_relative "flexdoc/rack_app"
+require_relative "flexdoc/rails"

metadata ADDED Viewed

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: prauga-flexdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Prauga
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+description: Framework-neutral Ruby host for the canonical FlexDoc OpenAPI renderer
+  with thin Rack and Rails integrations.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- assets/flexdoc.standalone.css
+- assets/flexdoc.standalone.js
+- lib/prauga/flexdoc.rb
+- lib/prauga/flexdoc/config.rb
+- lib/prauga/flexdoc/host.rb
+- lib/prauga/flexdoc/rack_app.rb
+- lib/prauga/flexdoc/rails.rb
+- lib/prauga/flexdoc/response.rb
+- lib/prauga/flexdoc/version.rb
+homepage: https://github.com/prauga/flexdoc
+licenses:
+- AGPL-3.0-or-later
+metadata:
+  source_code_uri: https://github.com/prauga/flexdoc
+  bug_tracker_uri: https://github.com/prauga/flexdoc/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Self-hosted FlexDoc integration for Rack and Rails
+test_files: []