impression 0.1 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a7e55ef9ff6c795a485a4b1e50456949932d923425ad447ada836ef2e69b0c
-  data.tar.gz: 669f0781d30986542fb09aad0af058107a658281136ace716edfdefc18fefabb
+  metadata.gz: 8db17f3627f0b8de2ed13a81effd9689f8a292b0861104c276d343bf5ec23e8f
+  data.tar.gz: 79cc272aed0503e1514723815f7019002c780a890995ef7c6f2d4718d9704000
 SHA512:
-  metadata.gz: 1cdbfd6167b1e1717e5a3fda6089c84bb0ed7c6d810b1dac9376a1cd81a38a473c097ba6dd6ecbd07c61145b86b5e10f13c8be02ac69c14c556ba6991f87e4f4
-  data.tar.gz: cf2e071b60b5ed0aa0ab826d2721c55d15cabb7fa0f63e84d068f76eef9a39db68159d6a651ddf5371976c4703a72a910883e50becdd64ff365d4b955cb93192
+  metadata.gz: 46112700200e6018c10b9a84b3a90184ce590e0da7369096a787467af4c84aba6578c043c1c9ad520cfa6da83638492def2c53b8cc9d51407d74695e3c12af4f
+  data.tar.gz: 94b1e171d6161bdd452ce27a6ee5effde4c9a1fdb2fd0247b72449fcb7048a8c1800dc616c6e291d56ea639dcec8a4d2d2dad5e9aa6865ccc0cb96cac4525688

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ciconia

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['2.7', '3.0', '3.1', 'head']
+
+    name: >-
+      ${{matrix.os}}, ${{matrix.ruby}}
+
+    runs-on: ${{matrix.os}}
+
+    env:
+      POLYPHONY_USE_LIBEV: "1"
+
+    steps:
+    - name: Setup machine
+      uses: actions/checkout@v1
+    - name: Setup Ruby and install deps
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true # 'bundle install' and cache
+        cache-version: 1
+        
+    - name: Run tests
+      run:  bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# 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)
+
+# 0.3 2022-01-19
+
+- Implement basic Jamstack resource (#5)
+- Add support for stock callable responses (#4)
+- Make resource callable, rename `#respond` to `#callable` (#3)
+
+## 0.2 2022-01-13
+
+- Implement `FileTree` (#2)
+- Rename `Resource#render` to `Resource#respond`
+- Rewrite resource routing (#1)
+- Implement `Resource`
+
+## 0.1 2021-02-24

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# %w{polyphony tipi qeweney papercraft}.each do |dep|
+#   dir = "../#{dep}"
+#   gem(dep, path: dir) if File.directory?(dir)
+# end

data/Gemfile.lock

@@ -1,66 +1,97 @@
 PATH
   remote: .
   specs:
-    impression (0.1)
-      kramdown (~> 2.3.0)
-      kramdown-parser-gfm (~> 1.1.0)
-      polyphony (~> 0.51.0)
-      rouge (~> 3.26.0)
-      tipi (~> 0.37)
+    impression (0.5)
+      modulation (~> 1.1)
+      papercraft (~> 0.14)
+      polyphony (~> 0.73.1)
+      qeweney (~> 0.15)
+      tipi (~> 0.45)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ansi (1.5.0)
-    builder (3.2.4)
-    docile (1.3.5)
+    acme-client (2.0.9)
+      faraday (>= 0.17, < 2.0.0)
+    docile (1.4.0)
     escape_utils (1.2.1)
-    http-2 (0.10.2)
-    http_parser.rb (0.6.0)
-    json (2.5.1)
-    kramdown (2.3.0)
+    ever (0.1)
+    extralite (1.11)
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    h1p (0.2)
+    http-2 (0.11.0)
+    json (2.6.1)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    localhost (1.1.9)
     minitest (5.11.3)
-    minitest-reporters (1.4.3)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    msgpack (1.4.2)
-    polyphony (0.51.0)
-    qeweney (0.5)
+    modulation (1.1)
+    msgpack (1.4.3)
+    multipart-post (2.1.1)
+    papercraft (0.14)
+      escape_utils (= 1.2.1)
+      kramdown (~> 2.3.0)
+      kramdown-parser-gfm (~> 1.1.0)
+      rouge (~> 3.26.0)
+    polyphony (0.73.1)
+    qeweney (0.15)
       escape_utils (~> 1.2.1)
     rack (2.2.3)
     rake (12.3.3)
-    rexml (3.2.4)
-    rouge (3.26.0)
-    ruby-progressbar (1.11.0)
+    rexml (3.2.5)
+    rouge (3.26.1)
+    ruby2_keywords (0.0.5)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    tipi (0.37)
-      http-2 (~> 0.10.0)
-      http_parser.rb (~> 0.6.0)
+    tipi (0.45)
+      acme-client (~> 2.0.8)
+      ever (~> 0.1)
+      extralite (~> 1.2)
+      h1p (~> 0.2)
+      http-2 (~> 0.11)
+      localhost (~> 1.1.4)
       msgpack (~> 1.4.2)
-      polyphony (~> 0.51.0)
-      qeweney (~> 0.5)
+      polyphony (~> 0.71)
+      qeweney (~> 0.14)
       rack (>= 2.0.8, < 2.3.0)
       websocket (~> 1.2.8)
     websocket (1.2.9)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   impression!
   minitest (~> 5.11.3)
-  minitest-reporters (~> 1.4.2)
   rake (~> 12.3.3)
   simplecov (~> 0.17.1)
 
 BUNDLED WITH
-   2.1.4
+   2.3.3

data/README.md

@@ -1,2 +1,44 @@
-# impression
-A modern web framework for Ruby
+<h1 align="center">
+  Impression
+</h1>
+
+<h4 align="center">A modern web framework for Ruby</h4>
+
+<p align="center">
+  <a href="http://rubygems.org/gems/impression">
+    <img src="https://badge.fury.io/rb/impression.svg" alt="Ruby gem">
+  </a>
+  <a href="https://github.com/digital-fabric/impression/actions?query=workflow%3ATests">
+    <img src="https://github.com/digital-fabric/impression/workflows/Tests/badge.svg" alt="Tests">
+  </a>
+  <a href="https://github.com/digital-fabric/impression/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
+  </a>
+</p>
+
+## What is Impression
+
+> Impression is still in a very early stage of development. Things might not
+> correctly, or not at all.
+
+Impression is a modern web framework for Ruby. Unlike other web framework,
+Impression does not impose any rigid structure or paradigm, but instead provides
+a set of tools letting you build any kind of web app, by freely mixing different
+kinds of web resources, be they static files, structured templates, Jamstack
+sites, or dynamic APIs.
+
+In Impression, resources can be composed into a hierarchical tree, allowing
+combining of multiple web apps, or web subsystems, into a single URL hierarchy.
+
+Impression is made for running on top of
+[Tipi](https://github.com/digital-fabric/tipi), a new all-in-one web server for
+Ruby.
+
+## I want to know more
+
+Further documentation is coming real soon (TM)...
+
+## Contributing
+
+Contributions in the form of issues, PRs or comments will be greatly
+appreciated!

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/clean"
+
+task :default => [:test]
+
+task :test do
+  exec 'ruby test/run.rb'
+end

data/examples/markdown/_assets/style.css

@@ -0,0 +1,98 @@
+* {
+  border: 0;
+  font: inherit;
+  font-size: 100%;
+  vertical-align: baseline;
+  margin: 0;
+  padding: 0;
+  color: black;
+}
+
+body {
+  font: normal 14px monospace;
+}
+
+h1, h2 {
+  font-weight: bold;
+}
+
+header {
+  margin-bottom: 20px;
+}
+
+a {
+  color: -webkit-link;
+}
+
+li {
+  margin-left: 40px;
+}
+
+em {
+  font-style: italic;
+}
+
+strong {
+  font-weight: bold;
+}
+
+p, ul, ol {
+  margin: 20px;
+}
+
+pre {
+  margin-bottom: 20px;
+  padding: 20px 5px;
+  overflow-x: visible;
+}
+
+pre code {
+  word-wrap: no;
+}
+
+hr {
+  display: block;
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+  margin-left: auto;
+  margin-right: auto;
+  border-style: inset;
+  border-width: 1px;
+}
+
+#nav {
+  padding: 20px 5px;
+}
+
+#nav, #content, footer {
+  margin: 0 20px;
+  max-width: 580px;
+}
+
+#nav h1 {
+  margin-bottom: 20px;
+}
+
+iframe {
+  margin: 20px;
+  max-width: 530px;
+}
+
+#content img {
+  max-width: 100%;
+}
+
+#title {
+  margin-top: 40px;
+  font-weight: bold;
+  text-align: center;
+}
+
+#date {
+  display: block;
+  text-align: right;
+}
+
+#webring {
+  padding-bottom: 10px;
+}

data/examples/markdown/app.rb

@@ -11,13 +11,19 @@ opts = {
 }
 
 puts "pid: #{Process.pid}"
-puts 'Listening on port 4411...'
 
-Tipi.serve('0.0.0.0', 4411, opts) do |req|
-  app.call(req)
+Tipi.full_service do |req|
+  req.route do
+    if req.host != 'noteflakes.com'
+      req.respond(nil, ':status' => Qeweney::Status::SERVICE_UNAVAILABLE)
+      stop_routing
+    end
+    req.on('assets') { req.serve_file(req.route_relative_path, base_path: File.join(__dir__, '_assets')) }
+    req.default { app.call(req) }
+  end
 rescue Exception => e
-  p e
-  puts e.backtrace.join("\n")
+  p [req.path, e]
+  # puts e.backtrace.join("\n")
   status = e.respond_to?(:http_status) ? e.http_status : 500
   req.respond(e.inspect, ':status' => status)
 end

data/examples/markdown/docs/tutorial.md

@@ -0,0 +1,15 @@
+# This is a tutorial
+
+## I'm an h2
+
+```ruby
+"here's some code"
+
+class A
+  def b
+    [:c, 42, /foo/]
+  end
+end
+
+p A.new.b
+```

data/impression.gemspec

@@ -10,7 +10,10 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split
   s.homepage    = 'http://github.com/digital-fabric/impression'
   s.metadata    = {
-    "source_code_uri" => "https://github.com/digital-fabric/impression"
+    "source_code_uri" => "https://github.com/digital-fabric/impression",
+    "documentation_uri" => "https://www.rubydoc.info/gems/impression",
+    "homepage_uri" => "https://github.com/digital-fabric/impression",
+    "changelog_uri" => "https://github.com/digital-fabric/impression/blob/master/CHANGELOG.md"
   }
   s.rdoc_options = ["--title", "impression", "--main", "README.md"]
   s.extra_rdoc_files = ["README.md"]
@@ -19,15 +22,16 @@ Gem::Specification.new do |s|
 
   # s.executables   = ['impression']
 
-  s.add_runtime_dependency      'polyphony',            '~>0.51.0'
-  s.add_runtime_dependency      'tipi',                 '~>0.37'
-  s.add_runtime_dependency      'kramdown',             '~>2.3.0'
-  s.add_runtime_dependency      'rouge',                '~>3.26.0'
-  s.add_runtime_dependency      'kramdown-parser-gfm',  '~>1.1.0'
+  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      'rb-inotify',           '~>0.10.1'
+  s.add_runtime_dependency      'papercraft',            '~>0.14'
+  s.add_runtime_dependency      'modulation',           '~>1.1'
 
   
   s.add_development_dependency  'rake',                 '~>12.3.3'
   s.add_development_dependency  'minitest',             '~>5.11.3'
-  s.add_development_dependency  'minitest-reporters',   '~>1.4.2'
   s.add_development_dependency  'simplecov',            '~>0.17.1'
 end

data/lib/impression/app.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Impression
+  class App < Resource
+    def initialize(path: '/', **opts)
+      super(path: path, **opts)
+    end
+  end
+end

data/lib/impression/file_tree.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative './resource'
+
+module Impression
+
+  # `FileTree` implements a resource that maps to a static file hierarchy.
+  class FileTree < Resource
+
+    # Initializes a `FileTree` resource.
+    #
+    # @param directory [String] static directory path
+    # @return [void]
+    def initialize(directory:, **props)
+      super(**props)
+      @directory = directory
+      @path_info_cache = {}
+    end
+
+    # Responds to a request.
+    #
+    # @param req [Qeweney::Request] request
+    # @return [void]
+    def call(req)
+      path_info = get_path_info(req.resource_relative_path)
+      render_from_path_info(req, path_info)
+    end
+
+    private
+
+    # Renders a response from the given response kind and path.
+    #
+    # @param req [Qeweney::Request] request
+    # @param kind [Symbol] path kind (`:not_found` or `:file`)
+    # @param path [String, nil] file path
+    def render_from_path_info(req, path_info)
+      case path_info[:kind]
+      when :not_found
+        req.respond(nil, ':status' => Qeweney::Status::NOT_FOUND)
+      when :file
+        render_file(req, path_info)
+      else
+        raise "Invalid path info kind #{kind.inspect}"
+      end
+    end
+
+    private
+
+    # Renders a file response for the given request and the given path info.
+    #
+    # @param req [Qeweney::Request] request
+    # @param path_info [Hash] path info
+    # @return [void]
+    def render_file(req, path_info)
+      req.serve_file(path_info[:path])
+    end
+
+    # Returns the path info for the given relative path.
+    #
+    # @param path [String] relative path
+    # @return [Hash] path info
+    def get_path_info(path)
+      @path_info_cache[path] ||= calculate_path_info(path)
+    end
+
+    # Calculates the path info for the given relative path.
+    #
+    # @param path [String] relative path
+    # @param add_ext [bool] whether to add .html extension if not found
+    # @return [Hash] path info
+    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 }
+    end
+
+    # Returns the path info for the given path. If the path refers to a file,
+    # returns a hash containing the file information. If the path refers to a
+    # directory, performs a search for an index file using #directory_path_info.
+    # Otherwise, returns nil.
+    #
+    # @param path [String] path
+    # @return [Hash, nil] path info
+    def path_info(path)
+      stat = File.stat(path) rescue nil
+      if !stat
+        nil
+      elsif stat.directory?
+        return directory_path_info(path)
+      else
+        return { kind: :file, path: path, ext: File.extname(path) }
+      end
+    end
+
+    # Calculates the path info for a directory. If an index file exists, its
+    # path info is returned, otherwise, returns nil.
+    #
+    # @param path [String] directory path
+    # @return [Hash, nil] path info
+    def directory_path_info(path)
+      search_path_info_with_extension(File.join(path, 'index'))
+    end
+
+    # Returns the supported path extensions for paths without extension.
+    #
+    # @return [Array] supported extensions
+    def supported_path_extensions
+      [:html]
+    end
+
+    # Searches for files with extensions for the given path.
+    #
+    # @param path [String] path
+    # @return [Hash, nil] path info
+    def search_path_info_with_extension(path)
+      supported_path_extensions.each do |ext|
+        info = path_info("#{path}.#{ext}")
+        return info if info
+      end
+      nil
+    end
+  end
+end

data/lib/impression/file_watcher.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'rb-inotify'
+
+module Impression
+  class FileWatcher
+    def initialize(spec)
+      @notifier = INotify::Notifier.new
+      @buffer = []
+      setup(spec)
+    end
+
+    def setup(spec)
+      if File.file?(spec)
+        setup_single_file(spec)
+      elsif File.directory?(spec)
+        setup_directory(spec)
+      else
+        dir = File.dir_name(spec)
+        filename = File.basename(spec)
+        if dir =~ /\/\*\*$/
+          dir = File.dir_name(dir)
+          filename = "**/#{filename}"
+        end
+        setup_directory(dir, filename)
+      end
+    end
+
+    def setup_directory(dir)
+      @notifier.watch(dir, :moved_to, :create, :move, :attrib, :modify, :delete) do |event|
+        kind = event.flags.first
+
+        @buffer << [kind, event.absolute_name]
+      end
+    end
+
+    def each(&block)
+      @receiver = Fiber.current
+      io = @notifier.to_io
+      loop do
+        io.wait_readable
+        @notifier.process
+        next if @buffer.empty?
+
+        @buffer.each(&block)
+        @buffer.clear
+      end
+    end
+  end
+end