nyth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 737a2d888ab620a466bfb28d973862252f6cec45eb558f6447ea115279b9c7d4
+  data.tar.gz: e57ad56ea2addba0ac45731733b979b7980635a5e9eb083de8ad5636a693aa00
+SHA512:
+  metadata.gz: ca3ae7088f285599be22d8cf53b81671699cb4036b0998aef5f7baf1efb139fa5337641b67861c0dc03c4655d20823cc35b825897a45654433304b36f4ccc0aa
+  data.tar.gz: 99424811720ed203a16022f752f75b411fdbe6da6851728b5f853a47f94b8940010e2ddad54c7ebe22c10dd779d62200176bdc4e7d660526a1e724374fa6ce41

data/README.md

@@ -0,0 +1,42 @@
+# Nyth 🪺
+
+Pronounced **neeth**, like the Welsh word for nest.
+
+Nyth is a tiny Rack renderer for file-backed ERB pages and partials. No structure, just build it: put files in `app`, put Ruby in `lib`, refresh the page.
+
+## Usage
+
+```ruby
+run Nyth.app(root: __dir__, reload: :changed, reload_check_interval: 5.0)
+```
+
+Requests map directly to files in `app`:
+
+- `/` renders `app/index.erb`.
+- `/about.erb` renders `app/about.erb`.
+- `/assets/style.css` serves `app/assets/style.css`.
+
+ERB files can render partials from `app`:
+
+```erb
+<%= render "_nav.erb" %>
+<%= render "_page_title.erb", heading: "About" %>
+```
+
+Files beginning with `_` are render-only partials and return `404` when requested directly.
+
+Ruby constants under `lib` are loaded with Zeitwerk. By default, `reload: :changed` checks Ruby file mtimes under `lib` at most once every 5 seconds and reloads constants only after a file changes. The nest stays warm without rebuilding it on every request.
+
+Reload modes:
+
+- `:changed` reloads `lib` only when Ruby files change.
+- `:always` reloads `lib` on every request.
+- `false` loads `lib` once at boot.
+
+Set `reload_check_interval:` to control how often `:changed` scans `lib`.
+
+## Tests
+
+```sh
+bundle exec rake
+```

data/lib/nyth/application.rb

@@ -0,0 +1,121 @@
+require "erb"
+require "pathname"
+require "rack/mime"
+require "rack/request"
+require "rack/response"
+require "time"
+
+module Nyth
+  class Application
+    def initialize(root:, app_path: "app")
+      @root = Pathname(root).expand_path
+      @content_root = @root.join(app_path)
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      file = file_for(request.path_info)
+      return not_found unless file&.file?
+      return not_found if partial?(file)
+
+      file.extname == ".erb" ? html(evaluate_template(file)) : static(file, request)
+    rescue Errno::ENOENT
+      not_found
+    end
+
+    private
+
+    attr_reader :content_root
+
+    def file_for(path)
+      resolve_app_path(path == "/" ? "/index.erb" : path)
+    end
+
+    def resolve_app_path(path)
+      relative_path = path.delete_prefix("/")
+      return if relative_path.empty?
+
+      file = content_root.join(relative_path).expand_path
+      file if file.to_s.start_with?(content_root.to_s + File::SEPARATOR)
+    end
+
+    def partial?(file)
+      file.basename.to_s.start_with?("_")
+    end
+
+    def render(path, locals = {})
+      file = resolve_app_path(path)
+      raise Errno::ENOENT, path unless file&.file?
+
+      evaluate_template(file, locals)
+    end
+
+    def evaluate_template(file, locals = {})
+      template = ERB.new(file.read)
+      template.result(template_binding(locals))
+    end
+
+    def template_binding(locals)
+      template_binding = binding
+
+      locals.each do |name, value|
+        template_binding.local_variable_set(name, value)
+      end
+
+      template_binding
+    end
+
+    def html(body)
+      response(body, "text/html; charset=utf-8")
+    end
+
+    def static(file, request)
+      metadata = static_metadata(file)
+      return response("", nil, 304, metadata) if not_modified?(request, metadata)
+
+      response(
+        file.binread,
+        Rack::Mime.mime_type(file.extname, "application/octet-stream"),
+        200,
+        metadata
+      )
+    end
+
+    def not_found
+      response("Not found\n", "text/plain; charset=utf-8", 404)
+    end
+
+    def response(body, content_type, status = 200, headers = {})
+      headers = headers.merge("content-type" => content_type) if content_type
+      Rack::Response.new(body, status, headers).finish
+    end
+
+    def static_metadata(file)
+      stat = file.stat
+      {
+        "cache-control" => "public, max-age=0, must-revalidate",
+        "etag" => %("#{stat.size}-#{stat.mtime.to_i}"),
+        "last-modified" => stat.mtime.httpdate
+      }
+    end
+
+    def not_modified?(request, metadata)
+      return etag_matches?(request, metadata) if request.get_header("HTTP_IF_NONE_MATCH")
+
+      modified_since_matches?(request, metadata)
+    end
+
+    def etag_matches?(request, metadata)
+      request.get_header("HTTP_IF_NONE_MATCH").to_s.split(/\s*,\s*/).include?(metadata["etag"])
+    end
+
+    def modified_since_matches?(request, metadata)
+      header = request.get_header("HTTP_IF_MODIFIED_SINCE")
+      return false unless header
+
+      Time.httpdate(header) >= Time.httpdate(metadata["last-modified"])
+    rescue ArgumentError
+      false
+    end
+  end
+end

data/lib/nyth/reloader.rb

@@ -0,0 +1,101 @@
+require "zeitwerk"
+
+module Nyth
+  class Reloader
+    RELOAD_MODES = [true, false, :always, :changed].freeze
+
+    def initialize(root:, lib_path: "lib", app_path: "app", reload: :changed, reload_check_interval: 5.0)
+      validate_reload!(reload)
+      validate_reload_check_interval!(reload_check_interval)
+
+      @root = Pathname(root).expand_path
+      @lib_root = @root.join(lib_path)
+      @app_path = app_path
+      @reload = reload
+      @reload_check_interval = reload_check_interval.to_f
+      @next_reload_check_at = monotonic_now
+      @mutex = Mutex.new
+      @loader = Zeitwerk::Loader.new
+      @loader.push_dir(@lib_root)
+      @loader.enable_reloading
+      @loader.setup
+      @loader.eager_load
+      @lib_snapshot = lib_snapshot
+    end
+
+    def call(env)
+      reload_if_needed
+
+      Application.new(root: @root, app_path: @app_path).call(env)
+    end
+
+    private
+
+    def validate_reload!(reload)
+      return if RELOAD_MODES.include?(reload)
+
+      raise ArgumentError, "reload must be one of: #{RELOAD_MODES.map(&:inspect).join(", ")}"
+    end
+
+    def validate_reload_check_interval!(reload_check_interval)
+      return unless reload_check_interval.negative?
+
+      raise ArgumentError, "reload_check_interval must be greater than or equal to 0"
+    end
+
+    def reload_if_needed
+      return unless reload_check_due?
+
+      @mutex.synchronize do
+        return unless reload_check_due?
+
+        next_snapshot = reload_snapshot
+        schedule_next_reload_check
+        return unless next_snapshot
+
+        @loader.reload
+        @loader.eager_load
+        @lib_snapshot = next_snapshot
+      end
+    end
+
+    def reload_check_due?
+      return true if @reload == true || @reload == :always
+      return false if @reload == false
+
+      monotonic_now >= @next_reload_check_at
+    end
+
+    def schedule_next_reload_check
+      @next_reload_check_at = monotonic_now + @reload_check_interval
+    end
+
+    def reload_snapshot
+      if @reload == true || @reload == :always
+        lib_snapshot
+      elsif @reload == :changed
+        changed_snapshot
+      end
+    end
+
+    def changed_snapshot
+      current_snapshot = lib_snapshot
+      return if current_snapshot == @lib_snapshot
+
+      current_snapshot
+    end
+
+    def lib_snapshot
+      Dir.glob(@lib_root.join("**/*.rb")).sort.to_h do |path|
+        stat = File.stat(path)
+        [path, [stat.mtime.to_f, stat.size]]
+      rescue Errno::ENOENT
+        [path, nil]
+      end
+    end
+
+    def monotonic_now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/nyth.rb

@@ -0,0 +1,14 @@
+require_relative "nyth/application"
+require_relative "nyth/reloader"
+
+module Nyth
+  def self.app(root:, lib_path: "lib", app_path: "app", reload: :changed, reload_check_interval: 5.0)
+    Reloader.new(
+      root: root,
+      lib_path: lib_path,
+      app_path: app_path,
+      reload: reload,
+      reload_check_interval: reload_check_interval
+    )
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: nyth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phillip Ridlen
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: :runtime
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '15'
+description: Nyth maps Rack requests to files under an app directory and renders ERB
+  with simple partial support.
+email:
+- phil@ptx.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/nyth.rb
+- lib/nyth/application.rb
+- lib/nyth/reloader.rb
+homepage: https://github.com/philtr/nyth
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/philtr/nyth/issues
+  homepage_uri: https://github.com/philtr/nyth
+  source_code_uri: https://github.com/philtr/nyth
+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: 4.0.6
+specification_version: 4
+summary: A tiny Rack renderer for file-backed ERB pages and partials.
+test_files: []