impression 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f310190c6415f14cdc24e4ab871dee51122a148292b778d6fc4679dafa03b10c
-  data.tar.gz: 302dd60dea184497508d7200354bf230835e0e84768ef6f5e5f5ee1e8ee27416
+  metadata.gz: 8db17f3627f0b8de2ed13a81effd9689f8a292b0861104c276d343bf5ec23e8f
+  data.tar.gz: 79cc272aed0503e1514723815f7019002c780a890995ef7c6f2d4718d9704000
 SHA512:
-  metadata.gz: dc1469936dd52810143d48ce608335a96b2fcfac8187d481c6df031bc4b3bc9d22ef41a3532660fb0826973dd356ef7ba7f181fdd1ac8ea8be31bc080b99013c
-  data.tar.gz: 89294842887b2da78309bb2c5cb3472123f363a315e2b22d9dcac67753e6008926374222895a40f373738c6dbdb964752873d459fac942cd99a68eafb4e1fd11
+  metadata.gz: 46112700200e6018c10b9a84b3a90184ce590e0da7369096a787467af4c84aba6578c043c1c9ad520cfa6da83638492def2c53b8cc9d51407d74695e3c12af4f
+  data.tar.gz: 94b1e171d6161bdd452ce27a6ee5effde4c9a1fdb2fd0247b72449fcb7048a8c1800dc616c6e291d56ea639dcec8a4d2d2dad5e9aa6865ccc0cb96cac4525688

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    impression (0.4)
+    impression (0.5)
       modulation (~> 1.1)
       papercraft (~> 0.14)
       polyphony (~> 0.73.1)
@@ -50,7 +50,7 @@ GEM
     localhost (1.1.9)
     minitest (5.11.3)
     modulation (1.1)
-    msgpack (1.4.2)
+    msgpack (1.4.3)
     multipart-post (2.1.1)
     papercraft (0.14)
       escape_utils (= 1.2.1)
@@ -85,7 +85,7 @@ GEM
     websocket (1.2.9)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   impression!

data/lib/impression/jamstack.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'yaml'
+require 'date'
 require 'modulation'
 require 'papercraft'
 
@@ -17,8 +18,68 @@ 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| page_entry(fn, dir) }
+        .sort_by { |i| i[:path] }
+    end
+
     private
 
+    DATE_REGEXP = /^(\d{4}\-\d{2}\-\d{2})/.freeze
+    MARKDOWN_PAGE_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
+
+    # Returns a page entry for the given file.
+    #
+    # @param fn [String] file name
+    # @param dir [String] relative directory
+    # @return [Hash] page entry
+    def page_entry(fn, dir)
+      relative_path = File.join(dir, fn)
+      absolute_path = File.join(@directory, relative_path)
+      info = {
+        path: absolute_path,
+        url: pretty_url(relative_path)
+      }
+      if fn =~ MD_EXT_REGEXP
+        atts, _ = parse_markdown_file(absolute_path)
+        info.merge!(atts)
+      end
+
+      if (m = fn.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
+      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
@@ -43,7 +104,7 @@ module Impression
     def render_papercraft_module(req, path)
       mod = import path
 
-      html = H(mod).render
+      html = H(mod).render(request: req, resource: self)
       req.respond(html, 'Content-Type' => Qeweney::MimeTypes[:html])
     end
 
@@ -57,7 +118,7 @@ module Impression
 
       layout = get_layout(attributes[:layout])
 
-      html = layout.render(**attributes) { emit_markdown markdown }
+      html = layout.render(request: req, resource: self, **attributes) { emit_markdown markdown }
       req.respond(html, 'Content-Type' => Qeweney::MimeTypes[:html])
     end
 
@@ -73,8 +134,6 @@ module Impression
       
       import path
     end
-
-    MARKDOWN_PAGE_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
   
     # Parses the markdown file at the given path.
     #
@@ -82,13 +141,23 @@ module Impression
     # @return [Array] an tuple containing properties<Hash>, contents<String>
     def parse_markdown_file(path)
       data = IO.read(path) || ''
+      atts = {}
+
+      # Parse date from file name
+      if (m = path.match(DATE_REGEXP))
+        atts[:date] ||= Date.parse(m[1])
+      end
+
       if (m = data.match(MARKDOWN_PAGE_REGEXP))
         front_matter = m[1]
-
-        [symbolize_keys(YAML.load(front_matter)), m.post_match]
-      else
-        [{}, data]
+        data = m.post_match
+        
+        YAML.load(front_matter).each_with_object(atts) do |(k, v), h|
+          h[k.to_sym] = v
+        end
       end
+        
+      [atts, data]
     end
 
     # Converts a hash with string keys to one with symbol keys.
@@ -96,7 +165,7 @@ module Impression
     # @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 }
+      
     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.5'
 end

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

@@ -0,0 +1,6 @@
+---
+title: MMM
+layout: article
+---
+
+## BBB

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

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

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/test_jamstack.rb

@@ -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')
@@ -205,4 +205,59 @@ class JamstackTest < MiniTest::Test
     }
     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 [
+      { path: File.join(JAMSTACK_PATH, 'bar.html'), url: '/app/bar' },
+      { path: File.join(JAMSTACK_PATH, 'index.md'), title: 'Hello', url: '/app/index' },
+    ], list
+
+
+    list = @jamstack.page_list('/articles')
+    assert_equal [
+      {
+        path: File.join(JAMSTACK_PATH, 'articles/2008-06-14-manu.md'),
+        url: '/app/articles/2008-06-14-manu',
+        title: 'MMM',
+        layout: 'article',
+        date: Date.new(2008, 06, 14)
+      },
+      {
+        path: File.join(JAMSTACK_PATH, 'articles/2009-06-12-noatche.md'),
+        url: '/app/articles/2009-06-12-noatche',
+        title: 'NNN',
+        layout: 'article',
+        date: Date.new(2009, 06, 12)
+      },
+      { 
+        path: File.join(JAMSTACK_PATH, 'articles/a.md'),
+        url: '/app/articles/a',
+        title: 'AAA',
+        layout: 'article'
+      },
+    ], list
+  end
+
+  def test_template_resource_and_request
+    req = mock_req(':method' => 'GET', ':path' => '/foobar?q=42')
+    @jamstack.route_and_call(req)
+  
+    foo = H {
+      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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: impression
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polyphony
@@ -158,11 +158,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