syntropy 0.25 → 0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e03dfbaf126674e740e0ef3819967a181499962a2940dbcbb075c005d91f87
-  data.tar.gz: aa26e63ce7f99be78e8a70b879a27ac039674947b833122533afb23a34bbdda2
+  metadata.gz: b84251781cfce3688f58c6f25a754b0699d97fe4a7c51f390b63635b45007960
+  data.tar.gz: 69e85137dcee6b399d3198303f9de4227b5276521a6c964eca5ac4954a9fb10f
 SHA512:
-  metadata.gz: d2eac9d510c3d449fc507a7bcd457ac448d857121915b030730714a6fcaeadecc36f52c4b5b77becc1bbe6760d71ab59bb8d10e3ff0edcece136f55e4fe503f8
-  data.tar.gz: a05435e23baa3b6d0ba34c7bc24ae0fc6652931e53313c63652ad84be955b1b15467e3d0abb0b4ce4eb152a72b5f20b2664392a7b4ea8bd4c61478f48d7e6903
+  metadata.gz: dd871276c35cd2a9c216f37ec1361794e34f489af71580a1da5cebef244830daf0e2bc4e418abe28623607e8da5693ead8074dd1f397ba9ea61afb0e4bcf7d96
+  data.tar.gz: 2b3ae1c3c4691d247357a8ec3d9f7e3da778c0fcdd7a94de84b2d83c94ffe75c7beb7ec7883976c2ca09b5c45225391b9322e28a32be9cc3a55acfc6d8c5ac9e

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 0.27 2025-10-21
+
+- Use accept header (instead of user-agent) for rendering error page
+- Add `Request#accept?` method
+- Fix import path normalization, module method visibility
+- Fix instantiation of Syntropy::Error
+- Improve default error handler response
+- Fix and enhance `Request#html_response`, `Request#json_response` methods
+
+# 0.26 2025-10-21
+
+- Add /.syntropy/req route for testing request headers
+- Add default builtin error page / response
+- Add `Request#browser?` method for detecting browser
+- Change behaviour of import to support relative paths
+- Update Papercraft
+
 # 0.25 2025-10-19
 
 - Upgrade Papercraft to version 3.0

data/examples/index.md

@@ -5,4 +5,4 @@ title: Syntropy Examples
 # Syntropy Examples
 
 - [Template composition](/templates)
-- [JSON API](/counter)
+- [JSON API](/counter)

data/lib/syntropy/app.rb

@@ -168,7 +168,7 @@ module Syntropy
     end
 
     # Serves a static file from the given target hash with cache validation.
-    # 
+    #
     # @param req [Qeweney::Request] request
     # @param target [Hash] route target hash
     # @return [void]
@@ -190,7 +190,7 @@ module Syntropy
 
     # Validates and conditionally updates the file information for the given
     # target.
-    # 
+    #
     # @param target [Hash] route target hash
     # @return [void]
     def validate_static_file_info(target)
@@ -203,7 +203,7 @@ module Syntropy
     STATX_MASK = UM::STATX_MTIME | UM::STATX_SIZE
 
     # Updates the static file information for the given target
-    # 
+    #
     # @param target [Hash] route target hash
     # @param now [Time] current time
     # @return [void]
@@ -373,12 +373,6 @@ module Syntropy
       @module_loader.load(ref)
     end
 
-    DEFAULT_ERROR_HANDLER = ->(req, err) {
-      msg = err.message
-      msg = nil if msg.empty? || (req.method == 'head')
-      req.respond(msg, ':status' => Syntropy::Error.http_status(err)) rescue nil
-    }
-
     # Returns an error handler for the given route. If route is nil, looks up
     # the error handler for the routing tree root. If no handler is found,
     # returns the default error handler.
@@ -386,7 +380,7 @@ module Syntropy
     # @param route [Hash] route entry
     # @return [Proc] error handler proc
     def get_error_handler(route)
-      route_error_handler(route || @routing_tree.root) || DEFAULT_ERROR_HANDLER
+      route_error_handler(route || @routing_tree.root) || default_error_handler
     end
 
     # Returns the given route's error handler, caching the result.
@@ -420,6 +414,23 @@ module Syntropy
       route[:parent] && find_error_handler(route[:parent])
     end
 
+    RAW_DEFAULT_ERROR_HANDLER = ->(req, err) {
+      msg = err.message
+      msg = nil if msg.empty? || (req.method == 'head')
+      req.respond(msg, ':status' => Syntropy::Error.http_status(err)) rescue nil
+    }
+
+    def default_error_handler
+
+      @default_error_handler ||= begin
+        if @builtin_applet
+          @builtin_applet.module_loader.load('/default_error_handler')
+        else
+          RAW_DEFAULT_ERROR_HANDLER
+        end
+      end
+    end
+
     # Performs app start up, creating a log message and starting the file
     # watcher according to app options.
     #

data/lib/syntropy/applets/builtin/default_error_handler/style.css

@@ -0,0 +1,18 @@
+body {
+  max-width: 800px;
+  margin: 4em auto;
+  
+  font-family: Seravek, 'Gill Sans Nova', Ubuntu, Calibri, 'DejaVu Sans', source-sans-pro, sans-serif;
+
+  big {
+    display: block;
+    font-weight: bold;
+    font-size: 10em;
+  }
+}
+
+@media (max-width: 768px) {
+  body {
+    margin-inline: 1em;
+  }
+}

data/lib/syntropy/applets/builtin/default_error_handler.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+ErrorPage = ->(error:, status:, backtrace:) {
+  html {
+    head {
+      title "Syntropy error: #{error.message}"
+      meta charset: 'utf-8'
+      meta name: 'viewport', content: 'width=device-width, initial-scale=1.0'
+      link rel: 'stylesheet', type: 'text/css', href: '/.syntropy/default_error_handler/style.css'
+    }
+    body {
+      div {
+        big status
+        h2 error.message
+        if backtrace
+          p "Backtrace:"
+          ul {
+            backtrace.each {
+              li {
+                a(it[:entry], href: it[:url])
+              }
+            }
+          }
+        end
+      }
+      auto_refresh_watch!
+    }
+  }
+}
+
+def transform_backtrace(backtrace)
+  backtrace.map do
+    location = it.match(/^(.+:\d+):/)[1]
+    { entry: it, url: "vscode://file/#{location}" }
+  end
+end
+
+def error_response_html(req, error)
+  status = Syntropy::Error.http_status(error)
+  backtrace = transform_backtrace(error.backtrace)
+  html = Papercraft.html(ErrorPage, error:, status:, backtrace:)
+  req.html_response(html, ':status' => status)
+end
+
+def error_response_raw(req, error)
+  status = Syntropy::Error.http_status(error)
+  response = {
+    class: error.class.to_s,
+    message: error.message,
+    backtrace: error.backtrace
+  }
+  req.json_pretty_response(response, ':status' => status)
+end
+
+export ->(req, error) {
+  req.accept?('text/html') ?
+    error_response_html(req, error) : error_response_raw(req, error)
+}

data/lib/syntropy/applets/builtin/json_api.js

@@ -25,4 +25,4 @@ class JSONAPI {
   }
 }
 
-export default JSONAPI;
+export default JSONAPI;

data/lib/syntropy/applets/builtin/req.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+export ->(req) {
+  req.json_response({
+    headers: req.headers
+  })
+}

data/lib/syntropy/errors.rb

@@ -21,17 +21,17 @@ module Syntropy
     # Creates an error with status 404 Not Found
     #
     # @return [Syntropy::Error]
-    def self.not_found(msg = '') = new(Status::NOT_FOUND, msg)
+    def self.not_found(msg = 'Not found') = new(msg, Status::NOT_FOUND)
 
     # Creates an error with status 405 Method Not Allowed
     #
     # @return [Syntropy::Error]
-    def self.method_not_allowed(msg = '') = new(Status::METHOD_NOT_ALLOWED, msg)
+    def self.method_not_allowed(msg = 'Method not allowed') = new(msg, Status::METHOD_NOT_ALLOWED)
 
     # Creates an error with status 418 I'm a teapot
     #
     # @return [Syntropy::Error]
-    def self.teapot(msg = '') = new(Status::TEAPOT, msg)
+    def self.teapot(msg = 'I\'m a teapot') = new(msg, Status::TEAPOT)
 
     attr_reader :http_status
 
@@ -40,7 +40,7 @@ module Syntropy
     # @param http_status [Integer, String] HTTP status
     # @param msg [String] error message
     # @return [void]
-    def initialize(http_status = DEFAULT_STATUS, msg = '')
+    def initialize(msg = 'Internal server error', http_status = DEFAULT_STATUS)
       super(msg)
       @http_status = http_status
     end

data/lib/syntropy/module.rb

@@ -38,6 +38,8 @@ module Syntropy
     # @param ref [String] module reference
     # @return [any] export value
     def load(ref)
+      ref = "/#{ref}" if ref !~ /^\//
+
       entry = (@modules[ref] ||= load_module(ref))
       entry[:export_value]
     end
@@ -93,6 +95,7 @@ module Syntropy
     # @param ref [String] module reference
     # @return [Hash] module entry
     def load_module(ref)
+      ref = "/#{ref}" if ref !~ /^\//
       fn = File.expand_path(File.join(@root_dir, "#{ref}.rb"))
       raise Syntropy::Error, "File not found #{fn}" if !File.file?(fn)
 
@@ -112,8 +115,9 @@ module Syntropy
 
     def clean_ref(ref)
       return '/' if ref =~ /^index(\+)?$/
-      
-      ref.gsub(/\/index(?:\+)?$/, '')
+
+      clean = ref.gsub(/\/index(?:\+)?$/, '')
+      clean == '' ? '/' : clean
     end
 
     # Transforms the given export value. If the value is nil, an exception is
@@ -177,10 +181,21 @@ module Syntropy
       @app = env[:app]
       @ref = env[:ref]
       @logger = env[:logger]
+      @__dependencies__ = []
       singleton_class.const_set(:MODULE, self)
     end
 
-    attr_reader :__export_value__
+    attr_reader :__export_value__, :__dependencies__
+
+    # Returns a list of pages found at the given ref.
+    #
+    # @param ref [String] directory reference
+    # @return [Array] array of pages found in directory
+    def page_list(ref)
+      Syntropy.page_list(@env, ref)
+    end
+
+    private
 
     # Exports the given value. This value will be used as the module's
     # entrypoint. It can be any Ruby value, but for a route module would
@@ -192,22 +207,23 @@ module Syntropy
       @__export_value__ = v
     end
 
-    # Returns the list of module references imported by the module.
-    #
-    # @return [Array] array of module references
-    def __dependencies__
-      @__dependencies__ ||= []
-    end
-
     # Imports the module corresponding to the given reference. The return value
     # is the module's export value.
     #
     # @param ref [String] module reference
     # @return [any] loaded dependency's export value
     def import(ref)
-      @module_loader.load(ref).tap {
-        __dependencies__ << ref
-      }
+      ref = normalize_import_ref(ref)
+      @module_loader.load(ref).tap { __dependencies__ << ref }
+    end
+
+    def normalize_import_ref(ref)
+      base = @ref == '' ? '/' : @ref
+      if ref =~ /^\//
+        ref
+      else
+        File.expand_path(File.join(File.dirname(base), ref))
+      end
     end
 
     # Creates and returns a Papercraft template created with the given block.
@@ -238,19 +254,13 @@ module Syntropy
       raise
     end
 
-    # Returns a list of pages found at the given ref.
-    #
-    # @param ref [String] directory reference
-    # @return [Array] array of pages found in directory
-    def page_list(ref)
-      Syntropy.page_list(@env, ref)
-    end
-
-    # Creates and returns a Syntropy app for the given environment.
+    # Creates and returns a Syntropy app for the given environment. The app's
+    # environment is based on the module's env merged with the given parameters.
     #
     # @param env [Hash] environment
     def app(**env)
-      Syntropy::App.new(**(@env.merge(env)))
+      env = @env.merge(env)
+      Syntropy::App.new(**env)
     end
   end
 end

data/lib/syntropy/request_extensions.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'qeweney'
+require 'json'
 
 module Syntropy
   # Extensions for the Qeweney::Request class
@@ -144,7 +145,7 @@ module Syntropy
     # matches the given etag or last_modified values, responds with a 304 Not
     # Modified status. Otherwise, yields to the given block for a normal
     # response, and sets cache control headers according to the given arguments.
-    # 
+    #
     # @param cache_control [String] value for Cache-Control header
     # @param etag [String, nil] Etag header value
     # @param last_modified [String, nil] Last-Modified header value
@@ -184,8 +185,53 @@ module Syntropy
       raise Syntropy::Error.new(Qeweney::Status::BAD_REQUEST, 'Invalid form data')
     end
 
+    def html_response(html, **headers)
+      respond(
+        html,
+        'Content-Type' => 'text/html; charset=utf-8',
+        **headers
+      )
+    end
+
+    def json_response(obj, **headers)
+      respond(
+        JSON.dump(obj),
+        'Content-Type' => 'application/json; charset=utf-8',
+        **headers
+      )
+    end
+
+    def json_pretty_response(obj, **headers)
+      respond(
+        JSON.pretty_generate(obj),
+        'Content-Type' => 'application/json; charset=utf-8',
+        **headers
+      )
+    end
+
+    def browser?
+      user_agent = headers['user-agent']
+      user_agent && user_agent =~ /^Mozilla\//
+    end
+
+    # Returns true if the accept header includes the given MIME type
+    #
+    # @param mime_type [String] MIME type
+    # @return [bool]
+    def accept?(mime_type)
+      accept = headers['accept']  
+      return nil if !accept
+
+      @accept_parts ||= parse_accept_parts(accept)
+      @accept_parts.include?(mime_type)
+    end
+
     private
 
+    def parse_accept_parts(accept)
+      accept.split(',').map { it.match(/^\s*([^\s;]+)/)[1] }
+    end
+
     BOOL_REGEXP = /^(t|f|true|false|on|off|1|0|yes|no)$/
     BOOL_TRUE_REGEXP = /^(t|true|on|1|yes)$/
     INTEGER_REGEXP = /^[+-]?[0-9]+$/

data/lib/syntropy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Syntropy
-  VERSION = '0.25'
+  VERSION = '0.27'
 end

data/syntropy.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'extralite',     '2.13'
   s.add_dependency 'json',          '2.13.2'
-  s.add_dependency 'papercraft',    '3.0'
+  s.add_dependency 'papercraft',    '3.0.1'
   s.add_dependency 'qeweney',       '0.24'
   s.add_dependency 'tp2',           '0.19'
   s.add_dependency 'uringmachine',  '0.18'

data/test/app/_lib/callable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Klass = import '_lib/klass'
+Klass = import './klass'
 
 def call(x)
   Klass.foo.to_s * x

data/test/app/_lib/dep.rb

@@ -1,4 +1,4 @@
-Foo = import '_lib/self'
+Foo = import '/_lib/self'
 
 def bar
   Foo.foo

data/test/app/_lib/missing-export.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Klass = import '_lib/klass'
+Klass = import '/_lib/klass'
 
 def call
   Klass.foo

data/test/app/mod/path/a.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+export :foo

data/test/app/mod/path/b.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+a1 = import './a'
+a2 = import 'a'
+foo = import '../foo/index'
+callable = import '/_lib/callable'
+
+export(a1:, a2:, foo:, callable:)

data/test/test_module.rb

@@ -29,6 +29,17 @@ class ModuleTest < Minitest::Test
     assert_equal 43, mod.bar
   end
 
+  def test_import_paths
+    mod = @loader.load('/mod/path/b')
+    assert_kind_of Hash, mod
+    assert_equal [:a1, :a2, :foo, :callable], mod.keys
+
+    assert_equal :foo, mod[:a1]
+    assert_equal :foo, mod[:a2]
+    assert_kind_of Syntropy::Module, mod[:foo]
+    assert_equal 'barbarbar', mod[:callable].(3)
+  end
+
   def test_export_self
     mod = @loader.load('_lib/self')
     assert_kind_of Syntropy::Module, mod
@@ -39,23 +50,23 @@ class ModuleTest < Minitest::Test
     mod = @loader.load('_lib/env')
 
     assert_equal mod, mod.module_const
-    assert_equal @env.merge(module_loader: @loader, ref: '_lib/env'), mod.env
+    assert_equal @env.merge(module_loader: @loader, ref: '/_lib/env'), mod.env
     assert_equal @machine, mod.machine
     assert_equal @loader, mod.module_loader
     assert_equal 42, mod.app
 
     assert_equal mod, mod.module_const
-    assert_equal @env.merge(module_loader: @loader, ref: '_lib/env'), mod.env
+    assert_equal @env.merge(module_loader: @loader, ref: '/_lib/env'), mod.env
     assert_equal @machine, mod.machine
     assert_equal @loader, mod.module_loader
     assert_equal 42, mod.app
   end
 
   def test_dependency_invalidation
-    mod = @loader.load('_lib/dep')
-    assert_equal ['_lib/self', '_lib/dep'], @loader.modules.keys
+    _mod = @loader.load('_lib/dep')
+    assert_equal ['/_lib/self', '/_lib/dep'], @loader.modules.keys
 
-    self_fn = @loader.modules['_lib/self'][:fn]
+    self_fn = @loader.modules['/_lib/self'][:fn]
     @loader.invalidate_fn(self_fn)
 
     assert_equal [], @loader.modules.keys
@@ -63,9 +74,9 @@ class ModuleTest < Minitest::Test
 
   def test_index_module_env
     mod = @loader.load('mod/bar/index+')
-    assert_equal 'mod/bar', mod.env[:ref]
+    assert_equal '/mod/bar', mod.env[:ref]
 
     mod = @loader.load('mod/foo/index')
-    assert_equal 'mod/foo', mod.env[:ref]
+    assert_equal '/mod/foo', mod.env[:ref]
   end
 end

data/test/test_routing_tree.rb

@@ -570,5 +570,5 @@ class RoutingTreeWildcardIndexTest < Minitest::Test
     assert_nil route
   end
 
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syntropy
 version: !ruby/object:Gem::Version
-  version: '0.25'
+  version: '0.27'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: qeweney
   requirement: !ruby/object:Gem::Requirement
@@ -203,8 +203,11 @@ files:
 - lib/syntropy/applets/builtin/auto_refresh/watch.sse.rb
 - lib/syntropy/applets/builtin/debug/debug.css
 - lib/syntropy/applets/builtin/debug/debug.js
+- lib/syntropy/applets/builtin/default_error_handler.rb
+- lib/syntropy/applets/builtin/default_error_handler/style.css
 - lib/syntropy/applets/builtin/json_api.js
 - lib/syntropy/applets/builtin/ping.rb
+- lib/syntropy/applets/builtin/req.rb
 - lib/syntropy/connection_pool.rb
 - lib/syntropy/dev_mode.rb
 - lib/syntropy/errors.rb
@@ -238,6 +241,8 @@ files:
 - test/app/index.html
 - test/app/mod/bar/index+.rb
 - test/app/mod/foo/index.rb
+- test/app/mod/path/a.rb
+- test/app/mod/path/b.rb
 - test/app/params/[foo].rb
 - test/app/rss.rb
 - test/app/tmp.rb