syntropy 0.26 → 0.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69fb0521a1229556ec52f7d64d9cb94c00a6e4000d947cd1c78b829923938906
-  data.tar.gz: 50fceb9e5cf0edd0765da05d44950e1d32fd8bd23cbbf5396df0da3cf941b880
+  metadata.gz: 8fd5a77712915e9472ed58a8786dce7369e9d24852533c19ce25d9f4959815bf
+  data.tar.gz: d6420486dc63bb1227b723f14e28e170e6e772f28970a2ce62e2d8283bdcd2b8
 SHA512:
-  metadata.gz: b0547a29500fed8ffa15d3d81be8cce5af9a9c8b128291edf44c1eb16aab36987db2f2f16226095649609d9fb0a2b1cc18235b496d0d217fb2518e1de84dfd4b
-  data.tar.gz: 1b08a07b9220a09b199f4c411af861fe58f674a344643908e7fd691f994cfa1aadaa7782794507800d7a6834be91cc8d117b02a77d597da6bd0411f82dae4e0f
+  metadata.gz: 5041a3820ed58393b643c7ed298fbdfedf255b9116156a1909d39bf0dfbb842004b38a651c85419d28c5dc2cae9b1c0d5fb13a9e24bbb1ec5340508ffbe7591c
+  data.tar.gz: d239554ae9e5b8c1b3159cbc0bb13cc828d2b00a4cf376197aaeb7740c57ae49d6419ccb957893bc6a1026d2db273a77f25a2960e6c21d84dad68528bf2ebf97

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.27.1 2025-10-21
+
+- Fix error instantiation and error testing
+
+# 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
@@ -56,7 +56,7 @@ module Syntropy
   # ValidationError is raised when a validation has failed.
   class ValidationError < Error
     def initialize(msg)
-      super(Qeweney::Status::BAD_REQUEST, msg)
+      super(msg, Qeweney::Status::BAD_REQUEST)
     end
   end
 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

@@ -177,20 +177,36 @@ module Syntropy
     def get_form_data
       body = read
       if !body || body.empty?
-        raise Syntropy::Error.new(Qeweney::Status::BAD_REQUEST, 'Missing form data')
+        raise Syntropy::Error.new('Missing form data', Qeweney::Status::BAD_REQUEST)
       end
 
       Qeweney::Request.parse_form_data(body, headers)
     rescue Qeweney::BadRequestError
-      raise Syntropy::Error.new(Qeweney::Status::BAD_REQUEST, 'Invalid form data')
+      raise Syntropy::Error.new('Invalid form data', Qeweney::Status::BAD_REQUEST)
     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.1'
 end

data/test/app/api+.rb

@@ -10,7 +10,7 @@ class API < Syntropy::JSONAPI
 
   def incr!(req)
     if req.path != '/test/api'
-        raise Syntropy::Error.new(Qeweney::Status::TEAPOT, 'Teapot')
+        raise Syntropy::Error.new('Teapot', Qeweney::Status::TEAPOT)
     end
 
     @count += 1

data/test/test_app.rb

@@ -50,7 +50,7 @@ class AppTest < Minitest::Test
 
     req = make_request(':method' => 'POST', ':path' => '/test')
     assert_equal Status::METHOD_NOT_ALLOWED, req.response_status
-    assert_nil req.response_body
+    assert_equal "Method not allowed", req.response_body
 
     req = make_request(':method' => 'GET', ':path' => '/test/assets/style.css')
     assert_equal '* { color: beige }', req.response_body
@@ -64,7 +64,7 @@ class AppTest < Minitest::Test
 
     req = make_request(':method' => 'POST', ':path' => '/test/api?q=get')
     assert_equal Status::METHOD_NOT_ALLOWED, req.response_status
-    assert_equal({ status: 'Error', message: '' }, req.response_json)
+    assert_equal({ status: 'Error', message: 'Method not allowed' }, req.response_json)
 
     req = make_request(':method' => 'GET', ':path' => '/test/api/foo?q=get')
     assert_equal({ status: 'OK', response: 0 }, req.response_json)
@@ -74,7 +74,7 @@ class AppTest < Minitest::Test
 
     req = make_request(':method' => 'GET', ':path' => '/test/api?q=incr')
     assert_equal Status::METHOD_NOT_ALLOWED, req.response_status
-    assert_equal({ status: 'Error', message: '' }, req.response_json)
+    assert_equal({ status: 'Error', message: 'Method not allowed' }, req.response_json)
 
     req = make_request(':method' => 'POST', ':path' => '/test/api/foo?q=incr')
     assert_equal({ status: 'Error', message: 'Teapot' }, req.response_json)
@@ -97,7 +97,7 @@ class AppTest < Minitest::Test
     assert_equal Status::OK, req.response_status
 
     req = make_request(':method' => 'POST', ':path' => '/test/baz')
-    assert_nil req.response_body
+    assert_equal 'Method not allowed', req.response_body
     assert_equal Status::METHOD_NOT_ALLOWED, req.response_status
 
     req = make_request(':method' => 'GET', ':path' => '/test/about')

data/test/test_errors.rb

@@ -12,7 +12,7 @@ class ErrorsTest < Minitest::Test
     e = Syntropy::Error.new
     assert_equal ISE, Syntropy::Error.http_status(e)
 
-    e = Syntropy::Error.new(Qeweney::Status::UNAUTHORIZED)
+    e = Syntropy::Error.new("", Qeweney::Status::UNAUTHORIZED)
     assert_equal Qeweney::Status::UNAUTHORIZED, Syntropy::Error.http_status(e)
   end
 

metadata

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