impression 0.1 → 0.2

data/lib/impression/pages.rb

@@ -4,6 +4,8 @@ require 'kramdown'
 require 'rouge'
 require 'kramdown-parser-gfm'
 require 'yaml'
+require 'rb-inotify'
+require 'papercraft'
 
 require_relative './errors'
 
@@ -18,8 +20,53 @@ module Impression
     def initialize(base_path, opts = {})
       @base_path = base_path
       @opts = opts
+      @opts[:pages] = self
 
       load
+
+      if opts[:auto_reload]
+        start_automatic_reloader
+      end
+    end
+
+    def start_automatic_reloader
+      notifier = INotify::Notifier.new
+      watched = {}
+      @map.each_value do |entry|
+        path = entry[:full_path]
+        next if watched[path]
+
+        notifier.watch(path, :modify, :delete_self) { |e| handle_changed_file(path) }
+        watched[path] = true
+      end
+      notifier.watch(@base_path, :moved_to, :create) do |event|
+        path = event.absolute_name
+        if File.file?(path)
+          notifier.watch(path, :modify, :delete_self) { |e| handle_changed_file(path) }
+        end
+        handle_changed_file(path)
+      end
+      @reloader = spin do
+        notify_io = notifier.to_io
+        loop do
+          notify_io.wait_readable
+          notifier.process
+        end
+      end
+    end
+
+    def handle_changed_file(full_path)
+      p handle_changed_file: full_path
+      if !File.file?(full_path)
+        @map.reject! { |k, v| v[:full_path] == full_path }
+        return
+      end
+
+      path = File.basename(full_path)
+      page = Page.new(path, full_path, @opts)
+      permalink = page.permalink
+      @map[permalink] = { page: page, full_path: full_path }
+      @map['/'] = @map[permalink] if permalink == '/index'
     end
 
     def load
@@ -31,87 +78,159 @@ module Impression
         next unless File.file?(full_path)
 
         page = Page.new(path, full_path, @opts)
-        @map[page.relative_permalink] = page
+        @map[page.permalink] = { page: page, full_path: full_path }
       end
       @map['/'] = @map['/index']
     end
     alias_method :reload, :load
 
+    def prev_page(page)
+      keys = @map.keys
+      case idx = keys.index(page.permalink)
+      when 0, nil
+        nil
+      else
+        @map[keys[idx - 1]][:page]
+      end
+    end
+
+    def next_page(page)
+      keys = @map.keys
+      case idx = keys.index(page.permalink)
+      when keys.size - 1, nil
+        nil
+      else
+        @map[keys[idx + 1]][:page]
+      end
+    end
+
     def load_file(path)
       content = IO.read(path)
     end
 
     def serve(req)
-      page = @map[req.routing_path]
-      raise NotFoundError unless page
+      entry = @map[req.route_relative_path]
+      raise NotFoundError unless entry
 
-      # return req.respond('Hello world')
+      body = render_page(entry[:page])
+      req.respond(body, 'Content-Type' => 'text/html')
+    rescue NotFoundError => e
+      req.respond('Not found.', ':status' => e.http_status)
+    end
+    alias_method :call, :serve
 
-      
-      req.respond(page.to_html, 'Content-Type' => 'text/html')
+    def render_page(page)
+      layout_proc(page.layout).().render(pages: self, page: page)
     end
 
-    class Page
-      def initialize(path, full_path, opts = {})
-        @path = path
-        @full_path = full_path
-        @opts = opts
-        read_page
-      end
-    
-      PAGE_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
-    
-      def read_page
-        data = IO.read(@full_path) || ''
-        if data =~ PAGE_REGEXP
-          front_matter = Regexp.last_match(1)
-          @attributes = YAML.load(front_matter)
-          @content = Regexp.last_match.post_match
-        else
-          @attributes = {}
-          @content = data
-        end
-      end
+    def layout_proc(layout)
+      full_path = File.expand_path("../_layouts/#{layout}.rb", @base_path)
+      instance_eval("->(&block) do; #{IO.read(full_path)}; end", full_path)
+    end
 
-      def relative_permalink
-        @relative_permalink = @attributes[:permalink] || path_without_extension
+    def select(selector)
+      @map.inject([]) do |array, (permalink, entry)|
+        array << entry[:page] if permalink =~ selector
+        array
       end
+    end
+  end
 
-      def path_without_extension
-        "/#{File.basename(@path, File.extname(@path))}"
-      end
-    
-      def title
-        @attributes['title'] || title_from_content
-      end
-    
-      TITLE_REGEXP = /^#\s+([^\n]+)/.freeze
-    
-      def title_from_content
-        (@content =~ TITLE_REGEXP) && Regexp.last_match(1)
-      end
-    
-      def status
-        @attributes['status'] || Qeweney::Status::OK
-      end
-    
-      def to_html
-        @html ||= render_html
-      end
+  class Page
+    attr_reader :attributes
+
+    def initialize(path, full_path, opts = {})
+      @path = path
+      @full_path = full_path
+      @opts = opts
+      @kind = detect_page_kind(full_path)
+      read_page
+    end
 
-      def kramdown_options
-        {
-          entity_output: :numeric,
-          syntax_highlighter: :rouge,
-          input: 'GFM'
-        }
+    EXTNAME_REGEXP = /^\.(.+)$/.freeze
+
+    def detect_page_kind(path)
+      File.extname(path).match(EXTNAME_REGEXP)[1].to_sym
+    end
+  
+    PAGE_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m.freeze
+  
+    def read_page
+      data = IO.read(@full_path) || ''
+      if data =~ PAGE_REGEXP
+        front_matter = Regexp.last_match(1)
+        @content_start_line = front_matter.lines.size + 2
+        @attributes = YAML.load(front_matter)
+        @content = Regexp.last_match.post_match
+      else
+        @attributes = {}
+        @content_start_line = 1
+        @content = data
       end
+    end
+
+    def permalink
+      @permalink = @attributes[:permalink] || path_without_extension
+    end
+
+    def path_without_extension
+      "/#{@path.delete_suffix(File.extname(@path))}"
+    end
+  
+    def title
+      @attributes['title'] || title_from_content
+    end
+
+    def prev_page
+      @opts[:pages].prev_page(self)
+    end
+
+    def next_page
+      @opts[:pages].next_page(self)
+    end
+  
+    TITLE_REGEXP = /^#\s+([^\n]+)/.freeze
+  
+    def title_from_content
+      (@content =~ TITLE_REGEXP) && Regexp.last_match(1)
+    end
+  
+    def status
+      @attributes['status'] || Qeweney::Status::OK
+    end
 
-      def render_html
-        inner = Kramdown::Document.new(@content, **kramdown_options).to_html
-        "<!doctype html><html><body>#{inner}</body></html>"
+    def layout
+      layout = @attributes['layout'] || 'default'
+    end
+  
+    def render
+      case @kind
+      when :md
+        render_markdown
+      when :rb
+        render_papercraft
+      else
+        raise "Invalid page kind #{kind.inspect}"
       end
     end
+
+    def render_markdown
+      Kramdown::Document.new(@content, **kramdown_options).to_html
+    end
+
+    def kramdown_options
+      {
+        entity_output: :numeric,
+        syntax_highlighter: :rouge,
+        input: 'GFM',
+        hard_wrap: false
+      }
+    end
+
+    def render_papercraft
+      proc = instance_eval("->(&block) do; #{@content}; end", @full_path, @content_start_line)
+      proc.().render(page: self, pages: @opts[:pages])
+    end
   end
 end
 

data/lib/impression/request_extensions.rb

@@ -2,8 +2,12 @@
 
 require 'qeweney'
 
-require_relative './pages'
+# require_relative './pages'
+require_relative './request_routing'
 
+# Extensions to `Qeweney::Request`
 class Qeweney::Request
-  include Impression::Pages::RequestMethods
+  
+  # include Impression::Pages::RequestMethods
+  include Impression::RequestRouting
 end

data/lib/impression/request_routing.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Impression
+  
+  # Request routing extensions for `Qeweney::Request`
+  module RequestRouting
+
+    # Matches a route regexp against the relative request path. The relative
+    # request path is a separate string (stored in `@resource_relative_path`)
+    # that is updated as routes are matched against it. The `route_regexp`
+    # should be either `nil` for root routes (`/`) or a Regexp of the form
+    # `/^#{route}(\/.*)?$/`. See also `Resource#initialize`.
+    #
+    # @param route_regexp [Regexp, nil] Route regexp to match against
+    # @return [String, nil] The remainder of the path (relative to the route)
+    def match_resource_path?(route_regexp)
+      @resource_relative_path ||= path.dup
+
+      return @resource_relative_path unless route_regexp
+
+      # Simplified logic: no match returns nil, otherwise we set the relative path for 
+      @resource_relative_path = match_resource_relative_path(
+        @resource_relative_path, route_regexp
+      )
+    end
+
+    # Returns the relative_path for the latest matched resource
+    #
+    # @return [String]
+    def resource_relative_path
+      @resource_relative_path ||= path.dup
+    end
+
+    private
+
+    # Matches the given path against the given route regexp. If the path matches
+    # the regexp, the relative path for the given route is returned. Otherwise,
+    # this method returns `nil`.
+    #
+    # @param path [String] path to match
+    # @param route_regexp [Regexp] route regexp to match against
+    # @return [String, nil] the relative path for the given route, or nil if no match.
+    def match_resource_relative_path(path, route_regexp)
+      match = path.match(route_regexp)
+      match && (match[1] || '/')
+    end
+  end
+end

data/lib/impression/resource.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'qeweney'
+
+module Impression
+
+  # The `Resource` class represents an abstract web resource. Resources are
+  # organized in tree like structure, with the structure normally corresponding
+  # to the URL path hierarchy. Other ways of organising resources, according to
+  # other taxonomies, can be implemented as long as the resources implement the
+  # same interface as the `Resource` class, which includes the following
+  # methods:
+  #
+  # - `Resource#route` - returns the resource which should respond to the
+  #   request.
+  # - `Resource#respond` - responds to the request.
+  #
+  class Resource
+    # Reference to the parent resource
+    attr_reader :parent
+
+    # The resource's path relative to its parent
+    attr_reader :path
+
+    # A hash mapping relative paths to child resources
+    attr_reader :children
+
+    # Initalizes a new resource instance.
+    #
+    # @param parent [Impression::Resource, nil] the parent resource (or nil)
+    # @param path [String] the resource's relative path
+    # @return [void]
+    def initialize(parent: nil, path:)
+      @parent = parent
+      @path = normalize_route_path(path)
+      @route_regexp = @path == '/' ? nil : /^#{@path}(\/.*)?$/.freeze
+      @children = {}
+
+      @parent&.add_child(self)
+    end
+
+    # Returns the resource's absolute path, according to its location in the
+    # resource hierarchy.
+    #
+    # @return [String] absolute path
+    def absolute_path
+      @absoulte_path ||= File.join(@parent ? @parent.absolute_path : '/', @path)
+    end
+
+    # Iterates over the resource and any of its sub-resources, passing each to
+    # the given block.
+    # 
+    # @return [Impression::Resource] self
+    def each(&block)
+      block.(self)
+      @children.values.each { |c| c.each(&block) }
+      self
+    end
+
+    # Adds a child reference to the children map.
+    #
+    # @param child [Impression::Resource] child resource
+    # @return [Impression::Resource] self
+    def add_child(child)
+      @children[child.path] = child
+      self
+    end
+
+    # Responds to the given request by rendering a 404 Not found response.
+    #
+    # @param req [Qeweney::Request] request
+    # @return [void]
+    def respond(req)
+      req.respond(nil, ':status' => Qeweney::Status::NOT_FOUND)
+    end
+
+    FIRST_PATH_SEGMENT_REGEXP = /^(\/[^\/]+)\//.freeze
+
+    # Routes the request by matching self and any children against the request
+    # path, returning the target resource, or nil if there's no match.
+    #
+    # @param req [Qeweney::Request] request
+    # @return [Impression::Resource, nil] target resource
+    def route(req)
+      case (relative_path = req.match_resource_path?(@route_regexp))
+      when nil
+        return nil
+      when '/'
+        return self
+      else
+        # naive case
+        child = @children[relative_path]
+        return child.route(req) if child
+
+        if (m = relative_path.match(FIRST_PATH_SEGMENT_REGEXP))
+          child = @children[m[1]]
+          return child.route(req) if child
+        end
+
+        return self
+      end
+    end
+
+    # Renders the resource and all of its sub-resources to static files.
+    #
+    # @param base_path [String] base path of target directory
+    # @return [Impression::Resource] self
+    def render_tree_to_static_files(base_path)
+      each do |r|
+        path = File.join(base_path, r.relative_static_file_path)
+        dir = File.dirname(path)
+        FileUtils.mkdir_p(dir) if !File.directory?(dir)
+        File.open(path, 'w') { |f| r.render_to_file(f) }
+      end
+      self
+    end
+
+    # Converts the resource to a Proc, for use as a Qeweney app.
+    #
+    # @return [Proc] web app proc
+    def to_proc
+      ->(req) do
+        resource = route(req) || self
+        resource.respond(req)
+      end
+    end
+
+    private
+
+    SLASH_PREFIXED_PATH_REGEXP = /^\//.freeze
+
+    # Normalizes the given path by ensuring it starts with a slash.
+    #
+    # @param path [String] path to normalize
+    # @return [String] normalized path
+    def normalize_route_path(path)
+      path =~ SLASH_PREFIXED_PATH_REGEXP ? path : "/#{path}"
+    end
+  end
+end

data/lib/impression/version.rb

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

data/lib/impression.rb

@@ -1,3 +1,10 @@
 # frozen_string_literal: true
 
+require 'polyphony'
+
 require_relative './impression/request_extensions'
+# require_relative './impression/file_watcher'
+
+require_relative './impression/resource'
+require_relative './impression/file_tree'
+require_relative './impression/app'

data/test/helper.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require_relative './coverage' if ENV['COVERAGE']
+require 'minitest/autorun'
+require 'impression'
+require 'qeweney/test_adapter'
+
+module Kernel
+  def mock_req(**args)
+    Qeweney::TestAdapter.mock(**args)
+  end
+
+  def capture_exception
+    yield
+  rescue Exception => e
+    e
+  end
+
+  def trace(*args)
+    STDOUT.orig_write(format_trace(args))
+  end
+
+  def format_trace(args)
+    if args.first.is_a?(String)
+      if args.size > 1
+        format("%s: %p\n", args.shift, args)
+      else
+        format("%s\n", args.first)
+      end
+    else
+      format("%p\n", args.size == 1 ? args.first : args)
+    end
+  end
+end
+
+module Minitest::Assertions
+  def assert_in_range exp_range, act
+    msg = message(msg) { "Expected #{mu_pp(act)} to be in range #{mu_pp(exp_range)}" }
+    assert exp_range.include?(act), msg
+  end
+
+  def assert_response exp_body, exp_content_type, req
+    msg = message(msg) { "Expected response body #{mu_pp(act)} to equal #{mu_pp(exp_body)}" }
+    assert_equal exp_body, req.response_body, msg
+
+    return unless exp_content_type
+
+    if Symbol === exp_content_type
+      exp_content_type = Qeweney::MimeTypes[exp_content_type]
+    end
+    msg = message(msg) { "Expected response content type #{mu_pp(act)} to equal #{mu_pp(exp_body)}" }
+    assert_equal exp_content_type, req.response_content_type, msg
+  end
+end
+
+class Impression::Resource
+  def route_and_respond(req)
+    route(req).respond(req)
+  end
+end
+
+class PathRenderingResource < Impression::Resource
+  def respond(req)
+    req.respond(absolute_path)
+  end
+end
+
+class CompletePathInfoRenderingResource < Impression::Resource
+  def respond(req)
+    req.respond("#{absolute_path} #{req.resource_relative_path}")
+  end
+end
+
+# Extensions to be used in conjunction with `Qeweney::TestAdapter`
+class Qeweney::Request
+  def response_headers
+    adapter.headers
+  end
+
+  def response_body
+    adapter.body
+  end
+
+  def response_status
+    adapter.status
+  end
+
+  def response_content_type
+    response_headers['Content-Type']
+  end
+end
+
+puts "Polyphony backend: #{Thread.current.backend.kind}"

data/test/run.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir.glob("#{__dir__}/test_*.rb").each do |path|
+  require(path)
+end

data/test/static/bar/index.html

@@ -0,0 +1 @@
+<h1>BarIndex</h1>

data/test/static/foo.html

@@ -0,0 +1 @@
+<h1>Foo</h1>

data/test/static/index.html

@@ -0,0 +1 @@
+<h1>Index</h1>

data/test/static/js/a.js

@@ -0,0 +1 @@
+console.log(42);

data/test/test_app.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class AppTest < MiniTest::Test
+  def test_empty_app
+    app = Impression::App.new(path: '/')
+    req = mock_req(':method' => 'GET', ':path' => '/')
+
+    app.respond(req)
+    assert_equal Qeweney::Status::NOT_FOUND, req.adapter.status
+  end
+
+  def test_app_each
+    app = Impression::App.new(path: '/')
+    
+    buffer = []
+    app.each { |r| buffer << r }
+    assert_equal [app], buffer
+
+    foo = PathRenderingResource.new(parent: app, path: 'foo')
+    bar = PathRenderingResource.new(parent: app, path: 'bar')
+    
+    buffer = []
+    app.each { |r| buffer << r }
+    assert_equal [app, foo, bar], buffer
+  end
+
+  def test_app_to_proc
+    app = Impression::App.new(path: '/')
+    app_proc = app.to_proc
+
+    foo = PathRenderingResource.new(parent: app, path: 'foo')
+    bar = PathRenderingResource.new(parent: app, path: 'bar')
+
+    # req = mock_req(':method' => 'GET', ':path' => '/')
+    # app_proc.(req)
+    # assert_equal Qeweney::Status::NOT_FOUND, req.adapter.status
+
+    req = mock_req(':method' => 'GET', ':path' => '/foo')
+    app_proc.(req)
+    assert_equal '/foo', req.adapter.body
+
+    req = mock_req(':method' => 'GET', ':path' => '/bar')
+    app_proc.(req)
+    assert_equal '/bar', req.adapter.body
+
+    req = mock_req(':method' => 'GET', ':path' => '/baz')
+    app_proc.(req)
+    assert_equal Qeweney::Status::NOT_FOUND, req.adapter.status
+  end
+end