impression 0.4 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f310190c6415f14cdc24e4ab871dee51122a148292b778d6fc4679dafa03b10c
-  data.tar.gz: 302dd60dea184497508d7200354bf230835e0e84768ef6f5e5f5ee1e8ee27416
+  metadata.gz: 27ba311a12a9ce237fd7eaef9102d859bd419471815b58ddea49f5d2879965f7
+  data.tar.gz: 4bf89153122f79e8c11ebf9f66f6ebc2d1c33858d0393fcfa3ff1698f9feab8f
 SHA512:
-  metadata.gz: dc1469936dd52810143d48ce608335a96b2fcfac8187d481c6df031bc4b3bc9d22ef41a3532660fb0826973dd356ef7ba7f181fdd1ac8ea8be31bc080b99013c
-  data.tar.gz: 89294842887b2da78309bb2c5cb3472123f363a315e2b22d9dcac67753e6008926374222895a40f373738c6dbdb964752873d459fac942cd99a68eafb4e1fd11
+  metadata.gz: d49af3a42dd499957344bc1b53275841909b793f3ae0e181fbd4a4ebf46f7ea279ae1ac666ff9692bf57579378fd1441acdb9fff100ed41822d5aef128b7ad93
+  data.tar.gz: 0a316777f8a8020da38136f587aed8d29fdae45b2216a85a0a1ece6452ab4439f70ffc198878028d8e50449b1a17bef0b1e5b59e1a6925fe35116ac142a6a6b7

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.7.1 2022-01-24
+
+- Improve YAML front matter loading
+
+# 0.7 2022-01-23
+
+- Update Papercraft, Refactor Jamstack resource
+
+# 0.6 2022-01-22
+
+- Unify page_list entries and page_info cache entries (#10)
+- Refactor FileTree#path_info to return more information
+
+# 0.5 2022-01-20
+
+- Pass resource and request to rendered templates (#8)
+- Implement Jamstack#page_list method (#7)
+
 # 0.4 2022-01-19
 
 - Remove deprecated Pages code (#6)

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    impression (0.4)
+    impression (0.7.1)
       modulation (~> 1.1)
-      papercraft (~> 0.14)
+      papercraft (~> 0.17)
       polyphony (~> 0.73.1)
-      qeweney (~> 0.15)
+      qeweney (~> 0.16)
       tipi (~> 0.45)
 
 GEM
@@ -50,20 +50,20 @@ GEM
     localhost (1.1.9)
     minitest (5.11.3)
     modulation (1.1)
-    msgpack (1.4.2)
+    msgpack (1.4.4)
     multipart-post (2.1.1)
-    papercraft (0.14)
-      escape_utils (= 1.2.1)
-      kramdown (~> 2.3.0)
+    papercraft (0.17)
+      escape_utils (~> 1.2.1)
+      kramdown (~> 2.3.1)
       kramdown-parser-gfm (~> 1.1.0)
-      rouge (~> 3.26.0)
+      rouge (~> 3.27.0)
     polyphony (0.73.1)
-    qeweney (0.15)
+    qeweney (0.16)
       escape_utils (~> 1.2.1)
     rack (2.2.3)
     rake (12.3.3)
     rexml (3.2.5)
-    rouge (3.26.1)
+    rouge (3.27.0)
     ruby2_keywords (0.0.5)
     simplecov (0.17.1)
       docile (~> 1.1)

data/examples/hello.rb

@@ -0,0 +1,13 @@
+require 'impression'
+
+app = Impression.app do
+  mount '/' => text_response('Hello, world!')
+end
+
+# class App < Impression::Resource
+#   def route(req)
+#     @response ||= text_response('Hello, world!')
+#   end
+# end
+
+# run { |req| req.respond_text('Hello, world!') }

data/impression.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency      'polyphony',            '~>0.73.1'
   s.add_runtime_dependency      'tipi',                 '~>0.45'
-  s.add_runtime_dependency      'qeweney',              '~>0.15'
+  s.add_runtime_dependency      'qeweney',              '~>0.16'
   
   # s.add_runtime_dependency      'rb-inotify',           '~>0.10.1'
-  s.add_runtime_dependency      'papercraft',            '~>0.14'
+  s.add_runtime_dependency      'papercraft',            '~>0.17'
   s.add_runtime_dependency      'modulation',           '~>1.1'
 
   

data/lib/impression/file_tree.rb

@@ -27,8 +27,6 @@ module Impression
       render_from_path_info(req, path_info)
     end
 
-    private
-
     # Renders a response from the given response kind and path.
     #
     # @param req [Qeweney::Request] request
@@ -47,6 +45,9 @@ module Impression
 
     private
 
+    PAGE_EXT_REGEXP = /^(.+)\.html$/.freeze
+    INDEX_PAGE_REGEXP = /^(.+)?\/index$/.freeze
+
     # Renders a file response for the given request and the given path info.
     #
     # @param req [Qeweney::Request] request
@@ -89,8 +90,37 @@ module Impression
       elsif stat.directory?
         return directory_path_info(path)
       else
-        return { kind: :file, path: path, ext: File.extname(path) }
+        file_info(path)
+      end
+    end
+
+    # Returns the path info for the given file path.
+    #
+    # @param path [String] file path
+    # @return [Hash] path info
+    def file_info(path)
+      relative_path = path.gsub(/^#{@directory}/, '')
+      {
+        kind: :file,
+        path: path,
+        ext: File.extname(path),
+        url: pretty_url(relative_path)
+      }
+    end
+
+    # Returns the pretty URL for the given relative path. For pages, the
+    # extension is removed. For index pages, the index suffix is removed.
+    #
+    # @param relative_path [String] relative path
+    # @return [String] pretty URL
+    def pretty_url(relative_path)
+      if (m = relative_path.match(PAGE_EXT_REGEXP))
+        relative_path = m[1]
+      end
+      if (m = relative_path.match(INDEX_PAGE_REGEXP))
+        relative_path = m[1] || '/'
       end
+      relative_path == '/' ? absolute_path : File.join(absolute_path, relative_path)
     end
 
     # Calculates the path info for a directory. If an index file exists, its

data/lib/impression/jamstack.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'date'
 require 'yaml'
 require 'modulation'
 require 'papercraft'
@@ -17,8 +18,70 @@ module Impression
       @layouts = {}
     end
 
+    # Returns a list of pages found in the given directory (relative to the base
+    # directory). Each entry containins the absolute file path, the pretty URL,
+    # the possible date parsed from the file name, and any other front matter
+    # attributes (for .md files). This method will detect only pages with the
+    # extensions .html, .md, .rb. The returned entries are sorted by file path.
+    #
+    # @param dir [String] relative directory
+    # @return [Array<Hash>] array of page entries
+    def page_list(dir)
+      base = File.join(@directory, dir)
+      Dir.glob('*.{html,md}', base: base)
+        .map { |fn| get_path_info(File.join(dir, fn)) }# page_entry(fn, dir) }
+        .sort_by { |i| i[:path] }
+    end
+
     private
 
+    DATE_REGEXP = /(\d{4}\-\d{2}\-\d{2})/.freeze
+    FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
+    MD_EXT_REGEXP = /\.md$/.freeze
+    PAGE_EXT_REGEXP = /^(.+)\.(md|html|rb)$/.freeze
+    INDEX_PAGE_REGEXP = /^(.+)?\/index$/.freeze
+
+    YAML_OPTS = {
+      permitted_classes: [Date],
+      symbolize_names: true
+    }.freeze
+
+    # Returns the path info for the given file path.
+    #
+    # @param path [String] file path
+    # @return [Hash] path info
+    def file_info(path)
+      info = super
+      case info[:ext]
+      when '.md'
+        atts, content = parse_markdown_file(path)
+        info = info.merge(atts)
+        info[:html_content] = Papercraft.markdown(content)
+      when '.rb'
+        info[:module] = import(path)
+      end
+      if (m = path.match(DATE_REGEXP))
+        info[:date] ||= Date.parse(m[1])
+      end
+  
+      info
+    end
+
+    # Returns the pretty URL for the given relative path. For pages, the
+    # extension is removed. For index pages, the index suffix is removed.
+    #
+    # @param relative_path [String] relative path
+    # @return [String] pretty URL
+    def pretty_url(relative_path)
+      if (m = relative_path.match(PAGE_EXT_REGEXP))
+        relative_path = m[1]
+      end
+      if (m = relative_path.match(INDEX_PAGE_REGEXP))
+        relative_path = m[1] || '/'
+      end
+      relative_path == '/' ? absolute_path : File.join(absolute_path, relative_path)
+    end
+
     # Renders a file response for the given request and the given path info.
     #
     # @param req [Qeweney::Request] request
@@ -27,9 +90,9 @@ module Impression
     def render_file(req, path_info)
       case path_info[:ext]
       when '.rb'
-        render_papercraft_module(req, path_info[:path])
+        render_papercraft_module(req, path_info)
       when '.md'
-        render_markdown_file(req, path_info[:path])
+        render_markdown_file(req, path_info)
       else
         req.serve_file(path_info[:path])
       end
@@ -38,26 +101,25 @@ module Impression
     # Renders a Papercraft module. The module is loaded using Modulation.
     #
     # @param req [Qeweney::Request] reqest
-    # @param path [String] file path
+    # @param path_info [Hash] path info
     # @return [void]
-    def render_papercraft_module(req, path)
-      mod = import path
-
-      html = H(mod).render
-      req.respond(html, 'Content-Type' => Qeweney::MimeTypes[:html])
+    def render_papercraft_module(req, path_info)
+      template = Papercraft.html(path_info[:module])
+      body = template.render(request: req, resource: self)
+      req.respond(body, 'Content-Type' => template.mime_type)
     end
 
     # Renders a markdown file using a layout.
     #
     # @param req [Qeweney::Request] reqest
-    # @param path [String] file path
+    # @param path_info [Hash] path info
     # @return [void]
-    def render_markdown_file(req, path)
-      attributes, markdown = parse_markdown_file(path)
+    def render_markdown_file(req, path_info)
+      layout = get_layout(path_info[:layout])
 
-      layout = get_layout(attributes[:layout])
-
-      html = layout.render(**attributes) { emit_markdown markdown }
+      html = layout.render(request: req, resource: self, **path_info) {
+        emit path_info[:html_content]
+      }
       req.respond(html, 'Content-Type' => Qeweney::MimeTypes[:html])
     end
 
@@ -73,30 +135,29 @@ module Impression
       
       import path
     end
-
-    MARKDOWN_PAGE_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
   
     # Parses the markdown file at the given path.
     #
     # @param path [String] file path
     # @return [Array] an tuple containing properties<Hash>, contents<String>
     def parse_markdown_file(path)
-      data = IO.read(path) || ''
-      if (m = data.match(MARKDOWN_PAGE_REGEXP))
-        front_matter = m[1]
+      content = IO.read(path) || ''
+      atts = {}
 
-        [symbolize_keys(YAML.load(front_matter)), m.post_match]
-      else
-        [{}, data]
+      # Parse date from file name
+      if (m = path.match(DATE_REGEXP))
+        atts[:date] ||= Date.parse(m[1])
       end
-    end
 
-    # Converts a hash with string keys to one with symbol keys.
-    #
-    # @param hash [Hash] input hash
-    # @return [Hash] output hash
-    def symbolize_keys(hash)
-      hash.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      if (m = content.match(FRONT_MATTER_REGEXP))
+        front_matter = m[1]
+        content = m.post_match
+        
+        yaml = YAML.safe_load(front_matter, **YAML_OPTS)
+        atts = atts.merge(yaml)
+      end
+        
+      [atts, content]
     end
 
     # Returns the supported path extensions used for searching for files based

data/lib/impression/version.rb

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

data/test/jamstack/_layouts/default.rb

@@ -1,6 +1,6 @@
 require 'papercraft'
 
-export_default H { |**props|
+export_default Papercraft.html { |**props|
   html5 {
     head {
       title props[:title]

data/test/jamstack/articles/2008-06-14-manu.md

@@ -0,0 +1,9 @@
+---
+title: MMM
+layout: article
+foo:
+  bar:
+    baz: 42
+---
+
+## BBB

data/test/jamstack/articles/2009-06-12-noatche.md

@@ -0,0 +1,6 @@
+---
+title: NNN
+layout: article
+---
+
+## CCC

data/test/jamstack/articles/a.md

@@ -3,4 +3,4 @@ title: AAA
 layout: article
 ---
 
-## BBB
+## ZZZ

data/test/jamstack/foobar.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+layout = import('./_layouts/default')
+
+export_default layout.apply(title: 'Foobar') { |resource:, request:, **props|
+  h1 request.query[:q]
+  resource.page_list('/articles').each do |i|
+    a i[:title], href: i[:url]
+  end
+}

data/test/jamstack/index.md

@@ -1,4 +1,5 @@
 ---
 title: Hello
+foo: BarBar
 ---
 <h1>Index</h1>

data/test/test_file_tree.rb

@@ -113,4 +113,42 @@ class FileTreeTest < MiniTest::Test
     @file_tree.route_and_call(req)
     assert_response static('bar/index.html'), :html, req
   end
+
+  def path_info(path)
+    @file_tree.send(:get_path_info, path)
+  end
+
+  def test_path_info
+    assert_equal({
+      kind: :file,
+      path: File.join(__dir__, 'static/index.html'),
+      ext: '.html',
+      url:  '/'
+    },  path_info('/index.html'))
+
+    assert_equal({
+      kind: :file,
+      path: File.join(__dir__, 'static/index.html'),
+      ext: '.html',
+      url:  '/'
+    },  path_info('/index'))
+
+    assert_equal({
+      kind: :file,
+      path: File.join(__dir__, 'static/index.html'),
+      ext: '.html',
+      url:  '/'
+    },  path_info('/'))
+
+    assert_equal({
+      kind: :file,
+      path: File.join(__dir__, 'static/js/a.js'),
+      ext: '.js',
+      url:  '/js/a.js'
+    },  path_info('/js/a.js'))
+
+    assert_equal({
+      kind: :not_found,
+    },  path_info('/js/b.js'))
+  end
 end

data/test/test_jamstack.rb

@@ -48,7 +48,7 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/foo')
     @jamstack.route_and_call(req)
 
-    foo = H {
+    foo = Papercraft.html {
       html5 {
         head {
           title 'Foo title'
@@ -63,7 +63,7 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/index')
     @jamstack.route_and_call(req)
 
-    index = H {
+    index = Papercraft.html {
       html5 {
         head {
           title 'Hello'
@@ -86,7 +86,7 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/baz')
     @jamstack.route_and_call(req)
 
-    baz_index = H {
+    baz_index = Papercraft.html {
       html5 {
         head {
           title 'BarBar'
@@ -101,14 +101,14 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/articles/a')
     @jamstack.route_and_call(req)
 
-    a = H {
+    a = Papercraft.html {
       html5 {
         head {
           title 'AAA'
         }
         body {
           article {
-            h2 'BBB', id: 'bbb'
+            h2 'ZZZ', id: 'zzz'
           }
         }
       }
@@ -116,7 +116,7 @@ class JamstackTest < MiniTest::Test
     assert_response a.render, :html, req
   end
 
-  def test_non_root_file_tree_response
+  def test_non_root_jamstack_response
     @jamstack = Impression::Jamstack.new(path: '/app', directory: JAMSTACK_PATH)
 
     req = mock_req(':method' => 'GET', ':path' => '/app/roo')
@@ -138,7 +138,7 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/app/foo')
     @jamstack.route_and_call(req)
 
-    foo = H {
+    foo = Papercraft.html {
       html5 {
         head {
           title 'Foo title'
@@ -153,7 +153,7 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/app/index')
     @jamstack.route_and_call(req)
 
-    index = H {
+    index = Papercraft.html {
       html5 {
         head {
           title 'Hello'
@@ -176,7 +176,7 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/app/baz')
     @jamstack.route_and_call(req)
 
-    baz_index = H {
+    baz_index = Papercraft.html {
       html5 {
         head {
           title 'BarBar'
@@ -191,18 +191,126 @@ class JamstackTest < MiniTest::Test
     req = mock_req(':method' => 'GET', ':path' => '/app/articles/a')
     @jamstack.route_and_call(req)
 
-    a = H {
+    a = Papercraft.html {
       html5 {
         head {
           title 'AAA'
         }
         body {
           article {
-            h2 'BBB', id: 'bbb'
+            h2 'ZZZ', id: 'zzz'
           }
         }
       }
     }
     assert_response a.render, :html, req
   end
+
+  def test_page_list
+    @jamstack = Impression::Jamstack.new(path: '/app', directory: JAMSTACK_PATH)
+
+    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', 
+        title: 'Hello', foo: 'BarBar', html_content: "<h1>Index</h1>\n" },
+    ], list
+
+
+    list = @jamstack.page_list('/articles')
+
+    assert_equal [
+      {
+        kind: :file,
+        path: File.join(JAMSTACK_PATH, 'articles/2008-06-14-manu.md'),
+        url: '/app/articles/2008-06-14-manu',
+        ext: '.md',
+        title: 'MMM',
+        layout: 'article',
+        foo: {
+          bar: {
+            baz: 42
+          }
+        },
+        html_content: "<h2 id=\"bbb\">BBB</h2>\n",
+        date: Date.new(2008, 06, 14)
+      },
+      {
+        kind: :file,
+        path: File.join(JAMSTACK_PATH, 'articles/2009-06-12-noatche.md'),
+        url: '/app/articles/2009-06-12-noatche',
+        ext: '.md',
+        title: 'NNN',
+        layout: 'article',
+        html_content: "<h2 id=\"ccc\">CCC</h2>\n",
+        date: Date.new(2009, 06, 12)
+      },
+      { 
+        kind: :file,
+        path: File.join(JAMSTACK_PATH, 'articles/a.md'),
+        url: '/app/articles/a',
+        ext: '.md',
+        title: 'AAA',
+        layout: 'article',
+        html_content: "<h2 id=\"zzz\">ZZZ</h2>\n",
+      },
+    ], list
+  end
+
+  def test_template_resource_and_request
+    req = mock_req(':method' => 'GET', ':path' => '/foobar?q=42')
+    @jamstack.route_and_call(req)
+  
+    foo = Papercraft.html {
+      html5 {
+        head {
+          title 'Foobar'
+        }
+        body {
+          h1 '42'
+          a 'MMM', href: '/articles/2008-06-14-manu'
+          a 'NNN', href: '/articles/2009-06-12-noatche'
+          a 'AAA', href: '/articles/a'
+        }
+      }
+    }
+    assert_response foo.render, :html, req
+  end
+
+  def path_info(path)
+    @jamstack.send(:get_path_info, path)
+  end
+
+  def test_path_info
+    assert_equal({
+      kind: :file,
+      path: File.join(JAMSTACK_PATH, 'index.md'),
+      ext: '.md',
+      url:  '/',
+      title: 'Hello',
+      foo: 'BarBar',
+      html_content: "<h1>Index</h1>\n"
+    },  path_info('/index'))
+
+    assert_equal({
+      kind: :file,
+      path: File.join(JAMSTACK_PATH, 'index.md'),
+      ext: '.md',
+      url:  '/',
+      title: 'Hello',
+      foo: 'BarBar',
+      html_content: "<h1>Index</h1>\n"
+    },  path_info('/'))
+
+    assert_equal({
+      kind: :file,
+      path: File.join(JAMSTACK_PATH, 'assets/js/a.js'),
+      ext: '.js',
+      url:  '/assets/js/a.js'
+    },  path_info('/assets/js/a.js'))
+
+    assert_equal({
+      kind: :not_found,
+    },  path_info('/js/b.js'))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: impression
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.7.1
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polyphony
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: papercraft
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: modulation
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +139,7 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- examples/hello.rb
 - examples/markdown/_assets/style.css
 - examples/markdown/app.rb
 - examples/markdown/docs/index.md
@@ -158,11 +159,14 @@ files:
 - test/helper.rb
 - test/jamstack/_layouts/article.rb
 - test/jamstack/_layouts/default.rb
+- test/jamstack/articles/2008-06-14-manu.md
+- test/jamstack/articles/2009-06-12-noatche.md
 - test/jamstack/articles/a.md
 - test/jamstack/assets/js/a.js
 - test/jamstack/bar.html
 - test/jamstack/baz/index.md
 - test/jamstack/foo.rb
+- test/jamstack/foobar.rb
 - test/jamstack/index.md
 - test/run.rb
 - test/static/bar/index.html