impression 0.9 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 565e43b51b9cd953d870b6bddf4542eae8c88a2467c79dc251a8c1e350cb13b8
-  data.tar.gz: ad661f50dfa8c35c96a83d5d3ad4d3f6d3ef97dc8d23a8aabde737ac925cf720
+  metadata.gz: 718a8a8eba181a00e5519e970d34bfc2e666ea15bacf0e72bffba450f3c9788d
+  data.tar.gz: fd665341a6fdcf66af4c564a269022f5fce014243a8736cf228188f9b3ca3e1f
 SHA512:
-  metadata.gz: f522619bb82ae14ad5856b8b6374b4ac30493dabc7550956b666adf46f64f1dc6db3d650583a07d98f21243550ef4e5908400191351dad2decde4d05240ff03c
-  data.tar.gz: 4397c5a63f0578c5be1ca0b1b8187f0de3890c5c41caf00adb7ec89b799c0576d917a704869d42b92681396a544882f87780d784d5861fb96abc691019954e4a
+  metadata.gz: 32ce3395a8f74e463b935e48711ae2b3fccd756b1bd3ec11912539ed2d969e0691dc044933548c5321a89749ad4faf3ddfc546958a83716d339b6fbeea0739b8
+  data.tar.gz: c33b519b8fd5a2a5da76e0d1a4a78854a0178dee62d90b143bf7cd8358150e69127af9d42832cb6158b41835cf6fa08cb6fc3efc09d0caa437e03b1e43722cde

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.10 2022-02-10
+
+- Add support for resource modules in Jamstack (#13)
+- Add convenience methods for creating resources (#12)
+- Accept block for setting default request handler in Resource.new (#11)
+
 ## 0.9 2022-02-05
 
 - Update Papercraft

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    impression (0.9)
+    impression (0.10)
       modulation (~> 1.1)
       papercraft (~> 0.19)
-      polyphony (~> 0.74)
-      qeweney (~> 0.16)
-      tipi (~> 0.47)
+      polyphony (~> 0.77)
+      qeweney (~> 0.17)
+      tipi (~> 0.49)
 
 GEM
   remote: https://rubygems.org/
@@ -57,8 +57,8 @@ GEM
       kramdown (~> 2.3.1)
       kramdown-parser-gfm (~> 1.1.0)
       rouge (~> 3.27.0)
-    polyphony (0.75)
-    qeweney (0.16)
+    polyphony (0.77)
+    qeweney (0.17)
       escape_utils (~> 1.2.1)
     rack (2.2.3)
     rake (12.3.3)
@@ -70,16 +70,16 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    tipi (0.47)
-      acme-client (~> 2.0.8)
+    tipi (0.49)
+      acme-client (~> 2.0.9)
       ever (~> 0.1)
       extralite (~> 1.2)
       h1p (~> 0.3)
       http-2 (~> 0.11)
       localhost (~> 1.1.4)
       msgpack (~> 1.4.2)
-      polyphony (~> 0.71)
-      qeweney (~> 0.14)
+      polyphony (~> 0.77)
+      qeweney (~> 0.16)
       rack (>= 2.0.8, < 2.3.0)
       websocket (~> 1.2.8)
     websocket (1.2.9)

data/impression.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.6'
 
-  s.add_runtime_dependency      'polyphony',            '~>0.74'
-  s.add_runtime_dependency      'tipi',                 '~>0.47'
-  s.add_runtime_dependency      'qeweney',              '~>0.16'
+  s.add_runtime_dependency      'polyphony',            '~>0.77'
+  s.add_runtime_dependency      'tipi',                 '~>0.49'
+  s.add_runtime_dependency      'qeweney',              '~>0.17'
   
   s.add_runtime_dependency      'papercraft',           '~>0.19'
   s.add_runtime_dependency      'modulation',           '~>1.1'

data/lib/impression/file_tree.rb

@@ -8,6 +8,8 @@ module Impression
   # `FileTree` implements a resource that maps to a static file hierarchy.
   class FileTree < Resource
 
+    attr_reader :directory
+
     # Initializes a `FileTree` resource.
     #
     # @param directory [String] static directory path
@@ -27,11 +29,11 @@ module Impression
       render_from_path_info(req, path_info)
     end
 
-    # Renders a response from the given response kind and path.
+    # Renders a response from the given path info.
     #
     # @param req [Qeweney::Request] request
-    # @param kind [Symbol] path kind (`:not_found` or `:file`)
-    # @param path [String, nil] file path
+    # @param path_info [Hash] path info
+    # @return [void]
     def render_from_path_info(req, path_info)
       case path_info[:kind]
       when :not_found
@@ -39,7 +41,7 @@ module Impression
       when :file
         render_file(req, path_info)
       else
-        raise "Invalid path info kind #{kind.inspect}"
+        raise "Invalid path info kind #{path_info[:kind].inspect}"
       end
     end
 
@@ -73,7 +75,11 @@ module Impression
     def calculate_path_info(path)
       full_path = File.join(@directory, path)
 
-      path_info(full_path) || search_path_info_with_extension(full_path) || { kind: :not_found }
+      (
+        path_info(full_path) ||
+        search_path_info_with_extension(full_path) ||
+        { kind: :not_found }
+      )
     end
 
     # Returns the path info for the given path. If the path refers to a file,

data/lib/impression/jamstack.rb

@@ -57,8 +57,10 @@ module Impression
         atts, content = parse_markdown_file(path)
         info = info.merge(atts)
         info[:html_content] = Papercraft.markdown(content)
+        info[:kind] = :markdown
       when '.rb'
         info[:module] = import(path)
+        info[:kind] = :module
       end
       if (m = path.match(DATE_REGEXP))
         info[:date] ||= Date.parse(m[1])
@@ -82,29 +84,132 @@ module Impression
       relative_path == '/' ? absolute_path : File.join(absolute_path, relative_path)
     end
 
-    # Renders a file response for the given request and the given path info.
-    #
+    # Renders a response according to the given path info.
+    # 
     # @param req [Qeweney::Request] request
     # @param path_info [Hash] path info
     # @return [void]
-    def render_file(req, path_info)
-      case path_info[:ext]
-      when '.rb'
-        render_papercraft_module(req, path_info)
-      when '.md'
+    def render_from_path_info(req, path_info)
+      case (kind = path_info[:kind])
+      when :not_found
+        mod_path_info = up_tree_resource_module_path_info(req, path_info)
+        if mod_path_info
+          render_module(req, mod_path_info)
+        else
+          req.respond(nil, ':status' => Qeweney::Status::NOT_FOUND)
+        end
+      when :module
+        render_module(req, path_info)
+      when :markdown
         render_markdown_file(req, path_info)
+      when :file
+        render_file(req, path_info)
       else
-        req.serve_file(path_info[:path])
+        raise "Invalid path info kind #{kind.inspect}"
       end
     end
 
-    # Renders a Papercraft module. The module is loaded using Modulation.
+    # Returns the path info for an up-tree resource module, or false if not
+    # found. the :up_tree_resource_module_path_info KV can be either:
+    # - nil (default): up tree module search has not been performed.
+    # - false: no up tree module was found.
+    # - module path info: up tree module info (subsequent requests will be
+    #   directly routed to the module).
     #
-    # @param req [Qeweney::Request] reqest
+    # @param req [Qeweney::Request] request
+    # @param path_info [Hash] path info
+    # @return [Hash, false] up-tree resource module path info
+    def up_tree_resource_module_path_info(req, path_info)
+      if path_info[:up_tree_resource_module_path_info].nil?
+        if (mod_path_info = find_up_tree_resource_module(req, path_info))
+          path_info[:up_tree_resource_module_path_info] = mod_path_info
+          return mod_path_info;
+        else
+          path_info[:up_tree_resource_module_path_info] = false
+          return false
+        end
+      end
+      path_info[:up_tree_resource_module_path_info]
+    end
+
+    # Performs a recursive search for an up-tree resource module from the given
+    # path info. If a resource module is found up the tree, its path_info is
+    # returned, otherwise returns nil.
+    # 
+    # @param req [Qeweney::Request] request
+    # @param path_info [Hash] path info
+    # @return [Hash, nil] up-tree resource module path info
+    def find_up_tree_resource_module(req, path_info)
+      relative_path = req.resource_relative_path
+
+      while relative_path != path
+        up_tree_path = File.expand_path('..', relative_path)
+        up_tree_path_info = get_path_info(up_tree_path)
+
+        case up_tree_path_info[:kind]
+        when :not_found
+          relative_path = up_tree_path
+          next
+        when :module
+          return up_tree_path_info
+        else
+          return nil
+        end
+      end
+      nil
+    end
+
+    # Renders a file response for the given request and the given path info,
+    # according to the file type.
+    #
+    # @param req [Qeweney::Request] request
+    # @param path_info [Hash] path info
+    # @return [void]
+    # def render_file(req, path_info)
+    #   case path_info[:kind]
+    #   else
+    #     req.serve_file(path_info[:path])
+    #   end
+    # end
+
+    # Renders a module. If the module is a Resource, it is mounted, and then the
+    # request is rerouted from the new resource and rendered. If the module is a
+    # Proc or a Papercraft::Template, it is rendered as such. Otherwise, an
+    # error is raised.
+    #
+    # @param req [Qeweney::Request] request
+    # @param path_info [Hash] path info
+    # @return [void]
+    def render_module(req, path_info)
+      # p render_module: path_info
+      case (mod = path_info[:module])
+      when Module
+        resource = mod.resource
+        resource.remount(self, path_info[:url])
+        # p path_info_url: path_info[:url], relative_path: req.resource_relative_path
+        relative_url = path_info[:url].gsub(/^#{path}/, '')
+        # p relative_url: relative_url
+        req.recalc_resource_relative_path(relative_url)
+        # p resource_relative_path: req.resource_relative_path
+        resource.route(req).call(req)
+      when Impression::Resource
+        mod.remount(self, path_info[:url])
+        req.recalc_resource_relative_path(path_info[:url])
+        mod.route(req).call(req)
+      when Proc, Papercraft::Template
+        render_papercraft_module(req, mod)
+      else
+        raise "Unsupported module type #{mod.class}"
+      end
+    end
+
+    # Renders a Papercraft module.
+    #
+    # @param mod [Module] Papercraft module
     # @param path_info [Hash] path info
     # @return [void]
-    def render_papercraft_module(req, path_info)
-      template = Papercraft.html(path_info[:module])
+    def render_papercraft_module(req, mod)
+      template = Papercraft.html(mod)
       body = template.render(request: req, resource: self)
       req.respond(body, 'Content-Type' => template.mime_type)
     end

data/lib/impression/request_extensions/routing.rb

@@ -31,7 +31,17 @@ module Impression
       #
       # @return [String]
       def resource_relative_path
-        @resource_relative_path ||= path.dup
+        @resource_relative_path ||= path
+      end
+
+      # Recalculates the relative_path from the given base path
+      #
+      # @param base_path [String] base path
+      # @return [String] new relative path
+      def recalc_resource_relative_path(base_path)
+        @resource_relative_path = @resource_relative_path.gsub(
+          /^#{base_path}/, ''
+        )
       end
 
       private

data/lib/impression/resource.rb

@@ -26,18 +26,35 @@ module Impression
     # A hash mapping relative paths to child resources
     attr_reader :children
 
-    # Initalizes a new resource instance.
+    # Initalizes a new resource instance. If a block is given, it is used as the
+    # request handler instead of the default one, which returns `404 NOT FOUND`.
     #
     # @param parent [Impression::Resource, nil] the parent resource (or nil)
     # @param path [String] the resource's relative path
+    # @param &block [Proc] default request handler
     # @return [void]
-    def initialize(parent: nil, path:)
+    def initialize(parent: nil, path:, &block)
       @parent = parent
       @path = normalize_route_path(path)
       @route_regexp = @path == '/' ? nil : /^#{@path}(\/.*)?$/.freeze
       @children = {}
 
       @parent&.add_child(self)
+
+      if block
+        singleton_class.define_method(:call, &block)
+      end
+    end
+
+    # Remounts the resource on a different parent and path.
+    #
+    # @param parent [Resource, nil] new parent
+    # @param path [String] new path relative to new parent
+    # @return [void]
+    def remount(parent, path)
+      @parent&.remove_child(self)
+      @parent = parent
+      @path = normalize_route_path(path)
     end
 
     # Returns the resource's absolute path, according to its location in the
@@ -67,6 +84,15 @@ module Impression
       self
     end
 
+    # Removes a child reference from the children map.
+    #
+    # @param child [Impression::Resource] child resource
+    # @return [Impression::Resource] self
+    def remove_child(child)
+      @children.delete(child.path)
+      self
+    end
+
     # Responds to the given request by rendering a 404 Not found response.
     #
     # @param req [Qeweney::Request] request

data/lib/impression/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Impression
-  VERSION = '0.9'
+  VERSION = '0.10'
 end

data/lib/impression.rb

@@ -9,3 +9,34 @@ require_relative './impression/resource'
 require_relative './impression/file_tree'
 require_relative './impression/jamstack'
 require_relative './impression/app'
+
+# The Impression module contains convenience methods for creating resources.
+module Impression
+
+  # Creates a new `Impression::Resource` instance with the given parameters and
+  # block.
+  #
+  # @param path [String] resource path (defaults to `"/"`)
+  # @param **props [Hash] other resource properties
+  # @param &block [Proc] optional block for overriding default request handler
+  # @return [Impression::Resource] new resource
+  def self.resource(path: '/', **props, &block)
+    Resource.new(path: path, **props, &block)
+  end
+
+  # Creates a new `Impression::FileTree` instance with the given parameters.
+  #
+  # @param **props [Hash] properties
+  # @return [Impression::FileTree] new resource
+  def self.file_tree(path: '/', **props)
+    FileTree.new(path: path, **props)
+  end
+
+  # Creates a new `Impression::Jamstack` instance with the given parameters.
+  #
+  # @param **props [Hash] properties
+  # @return [Impression::Jamstack] new resource
+  def self.jamstack(path: '/', **props)
+    Jamstack.new(path: path, **props)
+  end
+end

data/test/helper.rb

@@ -41,6 +41,10 @@ module Minitest::Assertions
   end
 
   def assert_response exp_body, exp_content_type, req
+    status = req.response_status
+    msg = message(msg) { "Expected HTTP status 200 OK, but instead got #{status}" }
+    assert_equal 200, status, msg
+
     actual = req.response_body
     assert_equal exp_body.gsub("\n", ''), actual&.gsub("\n", '')
 

data/test/jamstack/resources/greeter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+export :resource
+
+def resource
+  Impression.resource { |req|
+    req.respond("Hello, #{req.query[:name]}!", 'Content-Type' => 'text/plain')
+  }
+end

data/test/jamstack/resources/recurse.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+export :resource
+
+def resource
+  Impression.jamstack(
+    directory: File.expand_path('..', __dir__)
+  )
+end

data/test/test_impression.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class ImpressionModuleTest < MiniTest::Test
+  def test_resource_method
+    r1 = Impression.resource do |req|
+      req.respond('foobar', ':status' => Qeweney::Status::TEAPOT)
+    end
+
+    req = mock_req(':method' => 'GET', ':path' => '/')
+    r1.route_and_call(req)
+    assert_equal 'foobar', req.response_body
+    assert_equal Qeweney::Status::TEAPOT, req.response_status
+  end
+
+  def test_file_tree_method
+    r1 = Impression.file_tree(path: '/foo', directory: '/bar')
+
+    assert_kind_of Impression::FileTree, r1
+    assert_equal '/foo', r1.path
+    assert_equal '/bar', r1.directory
+  end
+
+  def test_jamstack_method
+    r1 = Impression.jamstack(path: '/foo', directory: '/bar')
+
+    assert_kind_of Impression::Jamstack, r1
+    assert_equal '/foo', r1.path
+    assert_equal '/bar', r1.directory
+  end
+end

data/test/test_jamstack.rb

@@ -212,7 +212,7 @@ class JamstackTest < MiniTest::Test
     list = @jamstack.page_list('/')
     assert_equal [
       { kind: :file, path: File.join(JAMSTACK_PATH, 'bar.html'), ext: '.html', url: '/app/bar' },
-      { kind: :file, path: File.join(JAMSTACK_PATH, 'index.md'), ext: '.md', url: '/app', 
+      { kind: :markdown, path: File.join(JAMSTACK_PATH, 'index.md'), ext: '.md', url: '/app', 
         title: 'Hello', foo: 'BarBar', html_content: "<h1>Index</h1>\n" },
     ], list
 
@@ -221,7 +221,7 @@ class JamstackTest < MiniTest::Test
 
     assert_equal [
       {
-        kind: :file,
+        kind: :markdown,
         path: File.join(JAMSTACK_PATH, 'articles/2008-06-14-manu.md'),
         url: '/app/articles/2008-06-14-manu',
         ext: '.md',
@@ -236,7 +236,7 @@ class JamstackTest < MiniTest::Test
         date: Date.new(2008, 06, 14)
       },
       {
-        kind: :file,
+        kind: :markdown,
         path: File.join(JAMSTACK_PATH, 'articles/2009-06-12-noatche.md'),
         url: '/app/articles/2009-06-12-noatche',
         ext: '.md',
@@ -246,7 +246,7 @@ class JamstackTest < MiniTest::Test
         date: Date.new(2009, 06, 12)
       },
       { 
-        kind: :file,
+        kind: :markdown,
         path: File.join(JAMSTACK_PATH, 'articles/a.md'),
         url: '/app/articles/a',
         ext: '.md',
@@ -283,7 +283,7 @@ class JamstackTest < MiniTest::Test
 
   def test_path_info
     assert_equal({
-      kind: :file,
+      kind: :markdown,
       path: File.join(JAMSTACK_PATH, 'index.md'),
       ext: '.md',
       url:  '/',
@@ -293,7 +293,7 @@ class JamstackTest < MiniTest::Test
     },  path_info('/index'))
 
     assert_equal({
-      kind: :file,
+      kind: :markdown,
       path: File.join(JAMSTACK_PATH, 'index.md'),
       ext: '.md',
       url:  '/',
@@ -313,4 +313,38 @@ class JamstackTest < MiniTest::Test
       kind: :not_found,
     },  path_info('/js/b.js'))
   end
+
+  def test_resource_loading
+    req = mock_req(':method' => 'GET', ':path' => '/resources/greeter?name=world')
+    route = @jamstack.route(req)
+    assert_equal @jamstack, route
+
+    req = mock_req(':method' => 'GET', ':path' => '/resources/greeter?name=world')
+    @jamstack.route_and_call(req)
+    assert_response 'Hello, world!', :text, req
+
+    req = mock_req(':method' => 'GET', ':path' => '/resources/recurse/resources/greeter?name=foo')
+    @jamstack.route_and_call(req)
+    assert_response 'Hello, foo!', :text, req
+  end
+
+  def test_recursive_resource_loading_on_non_root_jamstack
+    jamstack = Impression::Jamstack.new(path: '/foo/bar', directory: JAMSTACK_PATH)
+
+    req = mock_req(':method' => 'GET', ':path' => '/foo/bar/resources/greeter?name=world')
+    route = jamstack.route(req)
+    assert_equal jamstack, route
+
+    req = mock_req(':method' => 'GET', ':path' => '/foo/bar/resources/greeter?name=world')
+    jamstack.route_and_call(req)
+    assert_response 'Hello, world!', :text, req
+
+    req = mock_req(':method' => 'GET', ':path' => '/foo/bar/resources/recurse/resources/greeter?name=foo')
+    jamstack.route_and_call(req)
+    assert_response 'Hello, foo!', :text, req
+
+    # req = mock_req(':method' => 'GET', ':path' => '/foo/bar/resources/recurse/bar')
+    # @jamstack.route_and_call(req)
+    # assert_response static('bar.html'), :html, req
+  end
 end

data/test/test_resource.rb

@@ -198,4 +198,15 @@ class ResourceTest < MiniTest::Test
     assert_equal '{"baz":123}', req.response_body
     assert_equal 'application/json', req.response_content_type
   end
+
+  def test_resource_with_block
+    r1 = Impression::Resource.new(path: '/') do |req|
+      req.respond('foobar', ':status' => Qeweney::Status::TEAPOT)
+    end
+
+    req = mock_req(':method' => 'GET', ':path' => '/')
+    r1.route_and_call(req)
+    assert_equal 'foobar', req.response_body
+    assert_equal Qeweney::Status::TEAPOT, req.response_status
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: impression
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polyphony
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.77'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.77'
 - !ruby/object:Gem::Dependency
   name: tipi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.49'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: qeweney
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: papercraft
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +168,8 @@ files:
 - test/jamstack/foo.rb
 - test/jamstack/foobar.rb
 - test/jamstack/index.md
+- test/jamstack/resources/greeter.rb
+- test/jamstack/resources/recurse.rb
 - test/run.rb
 - test/static/bar/index.html
 - test/static/foo.html
@@ -176,6 +178,7 @@ files:
 - test/test_app.rb
 - test/test_file_tree.rb
 - test/test_file_watcher.rb
+- test/test_impression.rb
 - test/test_jamstack.rb
 - test/test_resource.rb
 homepage: http://github.com/digital-fabric/impression