impression 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8db17f3627f0b8de2ed13a81effd9689f8a292b0861104c276d343bf5ec23e8f
-  data.tar.gz: 79cc272aed0503e1514723815f7019002c780a890995ef7c6f2d4718d9704000
+  metadata.gz: 79fca9e0a9d2a2e782bd3168384e752009776b82d50c285f14f7a2951dae0e5c
+  data.tar.gz: 9d2d433216ca25fcd23b66e7f545520b8433abc076efde2c919d4e0dc8fd980c
 SHA512:
-  metadata.gz: 46112700200e6018c10b9a84b3a90184ce590e0da7369096a787467af4c84aba6578c043c1c9ad520cfa6da83638492def2c53b8cc9d51407d74695e3c12af4f
-  data.tar.gz: 94b1e171d6161bdd452ce27a6ee5effde4c9a1fdb2fd0247b72449fcb7048a8c1800dc616c6e291d56ea639dcec8a4d2d2dad5e9aa6865ccc0cb96cac4525688
+  metadata.gz: 84105ef65c86fefc2babdb7d44e3c89f9b6562d8c1bd4e3bdffa62b279e6e3b236841c5574de57fba4e7fe870f7a183659c636834af93b6d93df3d60f1818fcc
+  data.tar.gz: df125e64c903affa9946704e0c559d45848c89879621d764aa98b66fecaa1fcf27ff899ddb36c11e489f816792345252fe4e08df85c2796773affc88b0f95e9a

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -3,9 +3,9 @@ PATH
   specs:
     impression (0.5)
       modulation (~> 1.1)
-      papercraft (~> 0.14)
+      papercraft (~> 0.15)
       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.3)
+    msgpack (1.4.4)
     multipart-post (2.1.1)
-    papercraft (0.14)
-      escape_utils (= 1.2.1)
-      kramdown (~> 2.3.0)
+    papercraft (0.15)
+      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)
@@ -85,7 +85,7 @@ GEM
     websocket (1.2.9)
 
 PLATFORMS
-  x86_64-linux
+  ruby
 
 DEPENDENCIES
   impression!

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.15'
   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

@@ -29,39 +29,36 @@ module Impression
     def page_list(dir)
       base = File.join(@directory, dir)
       Dir.glob('*.{html,md}', base: base)
-        .map { |fn| page_entry(fn, dir) }
+        .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
+    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
+    INDEX_PAGE_REGEXP = /^(.+)?\/index$/.freeze
 
-    # Returns a page entry for the given file.
+    # Returns the path info for the given file path.
     #
-    # @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)
+    # @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[:markdown_content] = content
+      when '.rb'
+        info[:module] = import(path)
       end
-
-      if (m = fn.match(DATE_REGEXP))
+      if (m = path.match(DATE_REGEXP))
         info[:date] ||= Date.parse(m[1])
       end
-
+  
       info
     end
 
@@ -75,9 +72,9 @@ module Impression
         relative_path = m[1]
       end
       if (m = relative_path.match(INDEX_PAGE_REGEXP))
-        relative_path = m[1]
+        relative_path = m[1] || '/'
       end
-      File.join(absolute_path, relative_path)
+      relative_path == '/' ? absolute_path : File.join(absolute_path, relative_path)
     end
 
     # Renders a file response for the given request and the given path info.
@@ -88,9 +85,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
@@ -99,26 +96,24 @@ 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(request: req, resource: self)
+    def render_papercraft_module(req, path_info)
+      html = H(path_info[:module]).render(request: req, resource: self)
       req.respond(html, 'Content-Type' => Qeweney::MimeTypes[:html])
     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)
-
-      layout = get_layout(attributes[:layout])
+    def render_markdown_file(req, path_info)
+      layout = get_layout(path_info[:layout])
 
-      html = layout.render(request: req, resource: self, **attributes) { emit_markdown markdown }
+      html = layout.render(request: req, resource: self, **path_info) {
+        emit_markdown path_info[:markdown_content]
+      }
       req.respond(html, 'Content-Type' => Qeweney::MimeTypes[:html])
     end
 
@@ -160,14 +155,6 @@ module Impression
       [atts, data]
     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)
-      
-    end
-
     # Returns the supported path extensions used for searching for files based
     # on pretty URLs.
     #

data/lib/impression/version.rb

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

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

@@ -3,4 +3,4 @@ title: NNN
 layout: article
 ---
 
-## BBB
+## CCC

data/test/jamstack/articles/a.md

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

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

@@ -108,7 +108,7 @@ class JamstackTest < MiniTest::Test
         }
         body {
           article {
-            h2 'BBB', id: 'bbb'
+            h2 'ZZZ', id: 'zzz'
           }
         }
       }
@@ -198,7 +198,7 @@ class JamstackTest < MiniTest::Test
         }
         body {
           article {
-            h2 'BBB', id: 'bbb'
+            h2 'ZZZ', id: 'zzz'
           }
         }
       }
@@ -211,32 +211,43 @@ class JamstackTest < MiniTest::Test
 
     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' },
+      { 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', markdown_content: '<h1>Index</h1>' },
     ], 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',
+        markdown_content: "## BBB\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',
+        markdown_content: "## CCC\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'
+        layout: 'article',
+        markdown_content: "## ZZZ\n"
       },
     ], list
   end
@@ -260,4 +271,41 @@ class JamstackTest < MiniTest::Test
     }
     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',
+      markdown_content: '<h1>Index</h1>'
+    },  path_info('/index'))
+
+    assert_equal({
+      kind: :file,
+      path: File.join(JAMSTACK_PATH, 'index.md'),
+      ext: '.md',
+      url:  '/',
+      title: 'Hello',
+      foo: 'BarBar',
+      markdown_content: '<h1>Index</h1>'
+    },  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.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-22 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.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
 - !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