syntropy 0.26 → 0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69fb0521a1229556ec52f7d64d9cb94c00a6e4000d947cd1c78b829923938906
-  data.tar.gz: 50fceb9e5cf0edd0765da05d44950e1d32fd8bd23cbbf5396df0da3cf941b880
+  metadata.gz: b84251781cfce3688f58c6f25a754b0699d97fe4a7c51f390b63635b45007960
+  data.tar.gz: 69e85137dcee6b399d3198303f9de4227b5276521a6c964eca5ac4954a9fb10f
 SHA512:
-  metadata.gz: b0547a29500fed8ffa15d3d81be8cce5af9a9c8b128291edf44c1eb16aab36987db2f2f16226095649609d9fb0a2b1cc18235b496d0d217fb2518e1de84dfd4b
-  data.tar.gz: 1b08a07b9220a09b199f4c411af861fe58f674a344643908e7fd691f994cfa1aadaa7782794507800d7a6834be91cc8d117b02a77d597da6bd0411f82dae4e0f
+  metadata.gz: dd871276c35cd2a9c216f37ec1361794e34f489af71580a1da5cebef244830daf0e2bc4e418abe28623607e8da5693ead8074dd1f397ba9ea61afb0e4bcf7d96
+  data.tar.gz: 2b3ae1c3c4691d247357a8ec3d9f7e3da778c0fcdd7a94de84b2d83c94ffe75c7beb7ec7883976c2ca09b5c45225391b9322e28a32be9cc3a55acfc6d8c5ac9e

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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

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

@@ -35,21 +35,24 @@ def transform_backtrace(backtrace)
   end
 end
 
-def error_response_browser(req, error)
+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.respond(html, ':status' => status, 'Content-Type' => 'text/html')
+  req.html_response(html, ':status' => status)
 end
 
 def error_response_raw(req, error)
-  status = error_status_code(error)
-  msg = err.message
-  msg = nil if msg.empty? || (req.method == 'head')
-  req.respond(msg, ':status' => status)
+  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.browser? ?
-    error_response_browser(req, error) : error_response_raw(req, error)
+  req.accept?('text/html') ?
+    error_response_html(req, error) : error_response_raw(req, error)
 }

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

@@ -116,7 +116,8 @@ 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
@@ -180,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
@@ -195,23 +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)
-      path = ref =~ /^\// ? ref : File.expand_path(File.join(File.dirname(@ref), ref))
-      @module_loader.load(path).tap {
-        __dependencies__ << path
-      }
+      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.
@@ -242,14 +254,6 @@ 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. The app's
     # environment is based on the module's env merged with the given parameters.
     #

data/lib/syntropy/request_extensions.rb

@@ -185,12 +185,28 @@ module Syntropy
       raise Syntropy::Error.new(Qeweney::Status::BAD_REQUEST, 'Invalid form data')
     end
 
-    def html_repsonse(html)
-      respond(html, 'Content-Type' => 'text/html; charset=utf-8')
+    def html_response(html, **headers)
+      respond(
+        html,
+        'Content-Type' => 'text/html; charset=utf-8',
+        **headers
+      )
     end
 
-    def json_response(obj)
-      respond(JSON.dump(obj), 'Content-Type' => 'application/json; charset=utf-8')
+    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?
@@ -198,8 +214,24 @@ module Syntropy
       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.26'
+  VERSION = '0.27'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syntropy
 version: !ruby/object:Gem::Version
-  version: '0.26'
+  version: '0.27'
 platform: ruby
 authors:
 - Sharon Rosner