klenod-rack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 913a1d05a13144d907d9dd2cb02efd0ecbcbae1d075a69e4e225a06e3d78558f
+  data.tar.gz: 3576d918c391b71ea94dac9a8f0375c4511a89e8c2d58ac07b5bcfe395c5a1d8
+SHA512:
+  metadata.gz: 4110c103c9322b684205a6a3b87f6b55a63b5ad812e83f4097ecfacb8a8fe46d7037cbdc86ed2e0e0a0008c96754ea144b6a11789de5a98b16a1703808aa6bc3
+  data.tar.gz: 5785c87a96bd297e5d7fc28400a33b6408b2e056b2787a9223642863f4f971d5501b9807ec0248f3bb239590d9fe04e43ce02bdb78e8564bb9387fdc2a70bf81

data/README.md

@@ -0,0 +1,18 @@
+# klenod-rack
+
+`klenod-rack` provides Rack-compatible serving helpers for
+[Klenod](https://github.com/aalin/klenod) runtime assets.
+
+It is intentionally small and framework-agnostic. `Klenod::Rack::AssetApp`:
+
+- serves content-hashed assets from a build context or loaded runtime bundle
+- serves precompressed Brotli assets when available
+- can delegate non-asset requests to another Rack application
+
+Use this gem when exposing Klenod assets from a Rack-compatible server:
+
+```ruby
+require "klenod/rack"
+
+assets = Klenod::Rack::AssetApp.new(bundle, assets_dir: "public")
+```

data/lib/klenod/rack/asset_app.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "http/accept"
+
+module Klenod
+  module Rack
+    Response = Data.define(:status, :headers, :body) do
+      def rack_response
+        [status, headers, [body]]
+      end
+
+      def protocol_response
+        require "protocol/http/response"
+
+        Protocol::HTTP::Response[status, headers, [body]]
+      end
+    end
+
+    class AssetApp
+      CACHE_CONTROL = "public, max-age=31536000, immutable"
+
+      def initialize(source, app: nil, assets_dir: nil, path_prefix: "/assets/")
+        @source = source
+        @app = app
+        @assets_dir = assets_dir
+        @path_prefix = path_prefix
+      end
+
+      attr_reader :source, :app, :assets_dir, :path_prefix
+
+      def call(env)
+        response = response_for(env.fetch("PATH_INFO", ""), env)
+        return response.rack_response if response
+        return app.call(env) if app
+
+        not_found.rack_response
+      end
+
+      def response_for(path, env = {})
+        return nil unless asset_path?(path)
+
+        asset = source.asset(path)
+        brotli_available = brotli_asset_available?(asset)
+        compressed = brotli_available && accepts_brotli?(env.fetch("HTTP_ACCEPT_ENCODING", ""))
+        body = compressed ? brotli_asset_bytes(asset) : asset_bytes(asset)
+        headers = {
+          "content-type" => asset.content_type,
+          "content-length" => body.bytesize.to_s,
+          "cache-control" => CACHE_CONTROL
+        }
+        link = preload_link_header(asset)
+        headers["link"] = link if link
+        headers["vary"] = "Accept-Encoding" if brotli_available
+        if compressed
+          headers["content-encoding"] = "br"
+        end
+
+        Response.new(
+          200,
+          headers,
+          body
+        )
+      rescue KeyError, Errno::ENOENT
+        not_found
+      end
+
+      private
+
+      def asset_path?(path)
+        path.start_with?(path_prefix)
+      end
+
+      def asset_bytes(asset)
+        if source.respond_to?(:asset_bytes)
+          source.asset_bytes(asset.output_path, assets_dir: assets_dir)
+        else
+          File.binread(asset_disk_path(asset.output_path))
+        end
+      end
+
+      def brotli_asset_available?(asset)
+        return false unless assets_dir
+
+        File.file?(brotli_asset_disk_path(asset.output_path))
+      end
+
+      def accepts_brotli?(header)
+        return false if header.to_s.strip.empty?
+
+        HTTP::Accept::Encodings.parse(header.to_s).any? do |encoding|
+          %w[br *].include?(encoding.encoding) && encoding.quality_factor.positive?
+        end
+      rescue HTTP::Accept::ParseError
+        false
+      end
+
+      def preload_link_header(asset)
+        links =
+          Array(asset.metadata[:preload_assets]).map do |preload|
+            path = preload.fetch(:path)
+            as = preload.fetch(:as)
+            %(<#{path}>; rel=preload; as=#{as})
+          end
+
+        links.empty? ? nil : links.join(", ")
+      end
+
+      def brotli_asset_bytes(asset)
+        File.binread(brotli_asset_disk_path(asset.output_path))
+      end
+
+      def brotli_asset_disk_path(output_path)
+        "#{asset_disk_path(output_path)}.br"
+      end
+
+      def asset_disk_path(output_path)
+        raise ArgumentError, "assets_dir is required to serve runtime bundle assets" unless assets_dir
+
+        File.join(assets_dir, output_path.delete_prefix("/"))
+      end
+
+      def not_found
+        Response.new(
+          404,
+          {
+            "content-type" => "text/plain",
+            "content-length" => "16"
+          },
+          "Asset not found\n"
+        )
+      end
+    end
+  end
+end

data/lib/klenod/rack/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Klenod
+  module Rack
+    VERSION = "0.0.1"
+  end
+end

data/lib/klenod/rack.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "rack/version"
+require_relative "rack/asset_app"

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: klenod-rack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrés Alin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: klenod-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: http-accept
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Klenod Rack serves content-hashed runtime bundle assets from Rack-compatible
+  applications.
+email:
+- andreas.alin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/klenod/rack.rb
+- lib/klenod/rack/asset_app.rb
+- lib/klenod/rack/version.rb
+homepage: https://github.com/aalin/klenod
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aalin/klenod
+  source_code_uri: https://github.com/aalin/klenod/tree/main/gems/klenod-rack
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Rack asset serving helpers for Klenod.
+test_files: []