lanyon 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1d734e248758a22e846cf73dc15b13a323548a6
+  data.tar.gz: b7f4ed547b531a6d746f5a0caf31928af6ad968e
+SHA512:
+  metadata.gz: 36f129ec0ff9053464adcfaec6984d10eb04d6d9252538ab4f434ed0fd2de5aeaa3348d68507eb0b906b3664a44d526bd333668ae0a1757f24f526796850106b
+  data.tar.gz: 33a2dc54b3b19c0108773903e18d525808875dcce69f98abf725b5f4fe7bc3cc52f97b0d2d61bffce8c89186495bf24cce627c392a4e6b06c97a626f6b96e960

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marcus Stollsteimer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+Lanyon
+======
+
+Lanyon serves your Jekyll site as a Rack application.
+
+Lanyon is a good friend of [Jekyll][jekyll], the static site generator,
+and transforms your website into a [Rack][rack] application.
+
+## Getting Started
+
+Assuming you already have a Jekyll project that can be built and
+served using the `jekyll` command line tool, then converting it
+to a Rack application is very simple.
+
+ 1. Add a `config.ru` file in your project's root directory,
+    with the following content:
+
+    ``` ruby
+    require "lanyon"
+
+    run Lanyon.application
+    ```
+
+    You can specify additional Rack middleware in this file.
+
+ 2. At the command prompt, build the site and start the web server with
+
+    ``` sh
+    rackup config.ru
+    ```
+
+You can find an example site in the `demo` directory.
+
+Note that Lanyon does not watch for site changes.
+Auto-regeneration similar to Jekyll's `serve` command is
+not supported, and there are no plans to add this feature.
+
+Lanyon applications can be served with WEBrick, Thin, Unicorn and many
+other web servers, and they can be deployed to services like e.g. Heroku.
+
+## Installation
+
+You can install the Lanyon gem from RubyGems.org with
+
+``` sh
+gem install lanyon
+```
+
+## Configuration
+
+### Options
+
+Jekyll configuration options can be specified in a `_config.yml` file
+or as Lanyon initialization options in `config.ru`.
+
+Example:
+
+``` ruby
+run Lanyon.application(:destination => "mysite")
+```
+
+This will set a custom destination path, overriding the default (`_site`)
+and settings from a config file.
+See Jekyll's documentation for more settings.
+
+Additional Lanyon initialization options:
+
+    :config       - use given config file (default: "_config.yml")
+    :skip_build   - whether to skip site generation at startup
+                    (default: false)
+
+Note that on read-only filesystems a site build will fail,
+so you must set `:skip_build => true` in these cases.
+
+### Custum 404 Page
+
+You can provide a custom `404.html` file in your site's root directory.
+This can also be a file generated by Jekyll from e.g. Markdown sources.
+
+## Requirements
+
+- [Ruby][ruby] 2.0.0 or higher
+
+- Gem dependencies (runtime): `jekyll`, `rack`
+
+## Reporting Bugs
+
+Report bugs on the Lanyon home page: <https://github.com/stomar/lanyon/>
+
+## Credits
+
+Lanyon was inspired by [rack-jekyll][rack-jekyll] and written as a replacement.
+
+## License
+
+Copyright &copy; 2015 Marcus Stollsteimer
+
+Lanyon is licensed under the [MIT License][MIT].
+See also the included `LICENSE` file for more information.
+
+
+[ruby]: http://www.ruby-lang.org/
+[jekyll]: http://jekyllrb.com/
+[rack]: http://rack.github.io/
+[rack-jekyll]: https://github.com/adaoraul/rack-jekyll
+[MIT]: http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,37 @@
+require "rake/testtask"
+require "fileutils"
+
+
+def gemspec_file
+  "lanyon.gemspec"
+end
+
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/test_*.rb"
+  t.verbose = true
+  t.warning = true
+end
+
+
+desc "Build gem"
+task :build do
+  sh "gem build #{gemspec_file}"
+end
+
+
+desc "Remove generated files"
+task :clean do
+  FileUtils.rm_rf("demo/_site")
+  FileUtils.rm(Dir.glob("*.gem"))
+end
+
+
+desc "Serve demo site"
+task :demo do
+  port = 4000
+  puts "Starting server: http://localhost:#{port}/"
+  Dir.chdir("demo") { sh "rackup -p #{port} -I ../lib" }
+end

data/demo/404.md

@@ -0,0 +1,11 @@
+---
+layout: default
+title:  "404: Not Found"
+permalink: 404.html
+---
+
+# 404: Not Found
+
+The requested page does not exist.
+
+[Go back to home page](/)

data/demo/_config.yml

@@ -0,0 +1,5 @@
+markdown:  kramdown
+permalink: pretty
+
+exclude:
+  - config.ru

data/demo/_layouts/default.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <link rel="stylesheet" type="text/css" href="/css/site.css">
+  {% if page.title != null %}
+  <title>Lanyon Demo - {{ page.title }}</title>
+  {% else %}
+  <title>Lanyon Demo</title>
+  {% endif %}
+</head>
+<body>
+  {{ content }}
+</body>
+</html>

data/demo/_layouts/post.html

@@ -0,0 +1,7 @@
+---
+layout: default
+---
+
+{{ content }}
+
+<p><a href="/">Go back to home page</a></p>

data/demo/_posts/2015-11-05-hello-world.md

@@ -0,0 +1,8 @@
+---
+layout: post
+title:  Hello World!
+---
+
+# Hello World!
+
+A demo blog post for Lanyon.

data/demo/about/index.md

@@ -0,0 +1,10 @@
+---
+layout: default
+title:  About Lanyon
+---
+
+# About Lanyon
+
+Lanyon serves your Jekyll site as a Rack application.
+
+[Go back to home page](/)

data/demo/config.ru

@@ -0,0 +1,6 @@
+require "lanyon"
+
+# Rack middleware
+use Rack::Runtime
+
+run Lanyon.application

data/demo/css/site.css

@@ -0,0 +1,6 @@
+body {
+  background-color: #f0f0f0;
+  font-family: sans-serif;
+}
+
+.date { color: #808080; }

data/demo/index.md

@@ -0,0 +1,18 @@
+---
+layout: default
+---
+
+# Lanyon Demo
+
+Demo page for the Lanyon gem. [Read more...](about/)
+
+Blog posts:
+
+<ul>
+  {% for post in site.posts %}
+  <li>
+    <span class="date">{{ post.date | date_to_string }}:</span>
+    <a href="{{ post.url }}">{{ post.title }}</a>
+  </li>
+  {% endfor %}
+</ul>

data/lanyon.gemspec

@@ -0,0 +1,46 @@
+require_relative "lib/lanyon/version"
+
+version  = Lanyon::VERSION
+date     = Lanyon::DATE
+
+Gem::Specification.new do |s|
+  s.name              = "lanyon"
+  s.version           = version
+  s.date              = date
+
+  s.summary = "Lanyon serves your Jekyll site as a Rack application."
+  s.description =
+    "Lanyon is a good friend of Jekyll, the static site generator, " +
+    "and transforms your website into a Rack application."
+
+  s.authors = ["Marcus Stollsteimer"]
+  s.email = "sto.mar@web.de"
+  s.homepage = "https://github.com/stomar/lanyon/"
+
+  s.license = "MIT"
+
+  s.required_ruby_version = ">= 2.0.0"
+
+  s.add_dependency "jekyll", "~> 2.0"
+  s.add_dependency "rack", "~> 1.6"
+
+  s.add_development_dependency "rake", "~> 10.4"
+  s.add_development_dependency "minitest", "~> 5.8"
+
+  s.require_paths = ["lib"]
+
+  s.files = %w[
+      README.md
+      LICENSE
+      lanyon.gemspec
+      Gemfile
+      Rakefile
+      .yardopts
+    ] +
+    Dir.glob("lib/**/*") +
+    Dir.glob("test/**/*") +
+    Dir.glob("demo/**/*").reject {|f| f =~ %r(\Ademo/_site/) }
+
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.rdoc_options = ["--charset=UTF-8", "--main=README.md"]
+end

data/lib/lanyon/application.rb

@@ -0,0 +1,124 @@
+require "rack/mime"
+require "rack/request"
+require "rack/response"
+require "time"
+
+
+module Lanyon
+
+  # Rack application that serves the Jekyll site.
+  #
+  # Not to be instantiated directly, use Lanyon.application instead.
+  class Application
+
+    attr_reader :router
+
+    def initialize(router)
+      @router = router
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      endpoint = router.endpoint(request.path_info)
+
+      case endpoint
+      when :not_found
+        not_found_response
+      when :must_redirect
+        redirect_to_dir_response(request.path_info)
+      else
+        case request.request_method
+        when "HEAD", "GET"
+          response(endpoint)
+        when "OPTIONS"
+          [200, { "Allow" => "GET,HEAD,OPTIONS", "Content-Length" => "0" }, []]
+        else
+          not_allowed_response
+        end
+      end
+    end
+
+    private
+
+    def response(filename)  # :nodoc:
+      response = Rack::Response.new(File.read(filename))
+      response["Content-Type"]  = media_type(filename)
+      response["Last-Modified"] = modification_time(filename)
+
+      response.finish
+    end
+
+    def html_response(body, status, headers = {})  # :nodoc:
+      response = Rack::Response.new(body, status, headers)
+      response["Content-Type"] = "text/html"
+
+      response.finish
+    end
+
+    def media_type(filename)  # :nodoc:
+      extension = ::File.extname(filename)
+
+      Rack::Mime.mime_type(extension)
+    end
+
+    def modification_time(filename)  # :nodoc:
+      File.mtime(filename).httpdate
+    end
+
+    def html_wrap(title, content)  # :nodoc:
+      <<-document.gsub(/^ {6}/, "")
+      <!DOCTYPE html>
+      <html lang="en">
+      <head>
+        <meta charset="utf-8">
+        <title>#{title}</title></head>
+      <body>
+        #{content}
+      </body>
+      </html>
+      document
+    end
+
+    def default_404_body  # :nodoc:
+      html_wrap("Error", "<p>404: Not Found</p>")
+    end
+
+    def custom_404_body  # :nodoc:
+      router.custom_404_body
+    end
+
+    def not_found_response  # :nodoc:
+      body = custom_404_body || default_404_body
+
+      html_response(body, 404)
+    end
+
+    def not_allowed_response  # :nodoc:
+      body = html_wrap("Error", "<p>405: Method Not Allowed</p>")
+
+      html_response(body, 405)
+    end
+
+    def redirect_body(to_path)  # :nodoc:
+      message = %Q{<p>Redirecting to <a href="#{to_path}">#{to_path}</a>.</p>}
+
+      html_wrap("Redirection", message)
+    end
+
+    def redirect_to_dir_response(from_path)  # :nodoc:
+      location = from_path.dup
+      location << "/"  unless location.end_with?("/")
+
+      cache_time = 3600
+
+      body = redirect_body(location)
+      headers = {
+        "Location"      => location,
+        "Cache-Control" => "max-age=#{cache_time}, must-revalidate",
+        "Expires"       => (Time.now + cache_time).httpdate
+      }
+
+      html_response(body, 301, headers)
+    end
+  end
+end

data/lib/lanyon/router.rb

@@ -0,0 +1,52 @@
+module Lanyon
+
+  # Router class for Lanyon applications.
+  class Router
+
+    attr_reader :root
+
+    # Creates a Router for the given root directory.
+    def initialize(root)
+      @root = File.expand_path(root)
+    end
+
+    # Returns the full file system path of the file corresponding to
+    # the given URL +path+, or
+    #
+    # - +:not_found+ if no corresponding file exists,
+    # - +:must_redirect+ if the request must be redirected to <tt>path/</tt>.
+    #
+    def endpoint(path)
+      fullpath = File.join(@root, path)
+
+      if fullpath.end_with?("/")
+        normalized = fullpath + "index.html"
+      else
+        normalized = fullpath
+      end
+
+      endpoint = if FileTest.file?(normalized)
+                   normalized
+                 elsif needs_redirect_to_dir?(normalized)
+                   :must_redirect
+                 else
+                   :not_found
+                 end
+
+      endpoint
+    end
+
+    # Returns the body of the custom 404 page or +nil+ if none exists.
+    def custom_404_body
+      filename = File.join(root, "404.html")
+
+      File.exist?(filename) ? File.read(filename) : nil
+    end
+
+    private
+
+    def needs_redirect_to_dir?(fullpath)  # :nodoc:
+      !fullpath.end_with?("/") && FileTest.file?(fullpath + "/index.html")
+    end
+  end
+end

data/lib/lanyon/version.rb

@@ -0,0 +1,4 @@
+module Lanyon
+  VERSION  = '0.2.0'
+  DATE     = '2015-11-11'
+end

data/lib/lanyon.rb

@@ -0,0 +1,79 @@
+# = lanyon.rb
+#
+# See Lanyon module for documentation.
+
+require "jekyll"
+
+require "lanyon/application"
+require "lanyon/router"
+require "lanyon/version"
+
+
+# Lanyon serves your Jekyll site as a Rack application.
+#
+# See Lanyon.application for available initialization options.
+#
+# Further information on the Lanyon library is available in the README file
+# or on the project home page: <https://github.com/stomar/lanyon/>.
+#
+module Lanyon
+
+  # Builds the Jekyll site and returns a Rack application.
+  #
+  # Options:
+  #
+  # +:config+::      use given config file (default: "_config.yml")
+  #
+  # +:skip_build+::  whether to skip site generation at startup
+  #                  (default: +false+)
+  #
+  # Other options are passed on to Jekyll::Site.
+  #
+  # Returns a Rack application.
+  def self.application(options = {})
+    skip_build = options.fetch(:skip_build, default_options[:skip_build])
+
+    config = jekyll_config(options)
+
+    if skip_build
+      puts skip_build_warning
+    else
+      build(config)
+    end
+
+    destination = config["destination"]
+    router = Router.new(destination)
+
+    Rack::Builder.new do
+      use Rack::Head
+      use Rack::ConditionalGet
+
+      run Application.new(router)
+    end
+  end
+
+  # @private
+  def self.default_options  # :nodoc:
+    { :skip_build => false }
+  end
+
+  # @private
+  def self.jekyll_config(overrides = {})  # :nodoc:
+    overrides = overrides.dup
+    default_options.each_key {|key| overrides.delete(key) }
+
+    ::Jekyll.configuration(overrides)
+  end
+
+  # @private
+  def self.skip_build_warning  # :nodoc:
+    "Build warning: Skipping the initial build."
+  end
+
+  # @private
+  def self.build(config)  # :nodoc:
+    site = ::Jekyll::Site.new(config)
+    puts "Generating site: #{site.source} -> #{site.dest}"
+    site.process
+  end
+end

data/test/helper.rb

@@ -0,0 +1,51 @@
+require "minitest/autorun"
+require "fileutils"
+require "stringio"
+require "rack/mock"
+require "time"
+
+require "lanyon"
+
+
+TEST_DIR = File.expand_path("..", __FILE__)
+TEMP_DIR = File.join(TEST_DIR, "tmp")
+
+
+def setup_tempdir
+  FileUtils.mkdir_p(TEMP_DIR)
+
+  File.exist?(TEMP_DIR) ? TEMP_DIR : nil
+end
+
+def teardown_tempdir
+  FileUtils.rm_rf(TEMP_DIR)  if File.exist?(TEMP_DIR)
+end
+
+def chdir_tempdir
+  Dir.chdir(TEMP_DIR)
+end
+
+def sourcedir
+  File.join(TEST_DIR, "source")
+end
+
+
+def silence_output
+  original_stderr, original_stdout = $stderr, $stdout
+  $stderr, $stdout = StringIO.new, StringIO.new
+
+  yield
+ensure
+  $stderr, $stdout = original_stderr, original_stdout
+end
+
+
+def file_must_exist(filename)
+  assert File.exist?(filename),
+         "Expected file `#{filename}' to exist."
+end
+
+def file_wont_exist(filename)
+  assert !File.exist?(filename),
+         "Expected file `#{filename}' to not exist."
+end

data/test/source/_posts/2015-11-05-hello-world.md

@@ -0,0 +1,4 @@
+---
+---
+
+A Blog Post

data/test/source/buenos_dias.md

@@ -0,0 +1,4 @@
+---
+---
+
+¡Buenos días!

data/test/source/css/test.css

@@ -0,0 +1 @@
+/* CSS */

data/test/source/dir-with-index/index.md

@@ -0,0 +1,4 @@
+---
+---
+
+Index of dir-with-index/

data/test/source/dir-without-index/page.md

@@ -0,0 +1,4 @@
+---
+---
+
+Test

data/test/source/index.md

@@ -0,0 +1,4 @@
+---
+---
+
+Home Page

data/test/source/js/test.min.js

@@ -0,0 +1 @@
+// JavaScript

data/test/source/no-extension

@@ -0,0 +1 @@
+Test