rack-jekyll 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff66ebdda97455aea827328639ec115c78ea52ca
-  data.tar.gz: e250fa094a11503db4a51a6e360ee5bfa5022119
+  metadata.gz: 8197071d69920fb886e7a188cb18c1cf7397c2ca
+  data.tar.gz: e7a2ee5f2c1d15b6e4f8a24236d7e5a073399958
 SHA512:
-  metadata.gz: 6872f504907bb61f822d9b37aa2db5272e8b6e4d5969de0728947d800914545689b856dbd5db061f72dc847766998fe164303fef0e08cc77a11055e494830d5d
-  data.tar.gz: 126d49203f5fb68b8d6297ab9c8af1f92c607016e507b17c0b14adfb13e5fe3abcde81c7a2253b06ee8a72a6cd9031b147b491dd1c157365ec2ad32d4ae813ce
+  metadata.gz: 76e0cfca74a9b4a389f615b080f0607ec9cacca41f35911a96c3a8bcd47c2e65cae1c9be86df4b8a8961a9b4fc576a25e914fd13fd33194c661bfeb217332871
+  data.tar.gz: 615e0ff6f289188b6208ecfb351d76d8d8a695ace32d8a52995e2ed28d21d0ffb8053fde69468b52d460474da3efc951ad00a052c67fb54c1454224c37be96e5

data/History.markdown

@@ -0,0 +1,89 @@
+# Rack-Jekyll Release History
+
+## master / 2016-03-09
+
+### Enhancements
+
+  * Drop support of Ruby < 1.9.3
+  * Add release history
+  * Include example/ directory in the gem
+  * Use markdown source files for demo site instead of HTML
+  * Improve demo site pages, CSS, and `_config.yml`
+  * Remove Thorfile
+
+### Bug Fixes
+
+  * Fix wrong HTML tag in default layout of demo site
+
+### Development Fixes
+
+  * Move helper methods into a tested Utils module
+  * Use require_relative
+  * Remove unnecessary require statements
+  * Remove Rack::ShowStatus middleware from demo site
+  * Avoid "unused variable" warning for ruby -w
+
+
+## 0.4.5 / 2015-11-06
+
+### Enhancements
+
+  * Allow serving of files with unknown media type
+  * Support HEAD requests
+
+### Bug Fixes
+
+  * Fix detection of 404s for directories without index.html
+  * Fix detection of 404s with partially matching paths
+  * Fix default media type for unknown extension (`application/octet-stream`)
+
+### Development Fixes
+
+  * Increase test coverage
+  * Major refactorings
+
+
+## 0.4.3, 0.4.4
+
+not to be used, superseded by 0.4.5
+
+
+## 0.4.2 / 2015-10-12
+
+### Enhancements
+
+  * Loosen dependency on Jekyll to also allow Jekyll 2
+  * Add `:config` option for custom configuration file
+  * Add `:force_build` option to always generate site
+  * Wait while regenerating the site before returning a response
+  * Use "listen" gem instead of "directory_watcher"
+  * Clean up and improve demo site: use Markdown, add CSS, ...
+  * Clean up and improve README
+  * Add some RDoc
+
+### Bug Fixes
+
+  * Fix typo in Content-Length header
+  * Fix broken initialization of instance variables
+  * Fix broken configuration loading
+  * Fix updating of @files list
+  * Fix auto-regeneration
+
+### Development Fixes
+
+  * Major refactorings
+  * Start testing the actual code instead of a fake app
+  * Add many test cases and clean up tests
+  * Use "minitest" instead of "test-unit"
+  * Fix Cucumber tests which were always passing
+  * Let the @files list be an array
+  * Fix misplaced instance variable assignment
+  * Fix effectless debugging statement
+  * Add "listen" gem as dependency
+  * Clean up gemspec
+  * Remove some unused legacy code
+
+
+## 0.4.1 / 2013-05-15
+
+See commit log.

data/README.markdown

@@ -62,6 +62,7 @@ Additional Rack-Jekyll initialization options:
     :force_build   - whether to always generate the site at startup, even
                      when the destination path is not empty (default: false)
     :auto          - whether to watch for changes and rebuild (default: false)
+    :wait_page     - a page to display while pages are rendering
 
 Note that on read-only filesystems a site build will fail,
 so do not set `:force_build => true` in these cases.
@@ -73,6 +74,22 @@ In your site's root directory you can provide a custom `404.html` file
 with YAML front matter.
 
 
+## Wait page
+
+You can create a custom HTML page to display while Jekyll is rendering the
+site.  Set the `:wait_page` initialization option to point to a file relative
+to the root of your Jekyll project.
+
+*Example:*
+
+    run Rack::Jekyll.new(:wait_page => "hold_on.html")
+
+Note that this page should be self-contained (no links to external CSS
+or JS).  It is also not a bad idea to add a `<meta http-equiv="refresh"
+content="60"/>` to the `head` section so that the page will periodically
+refresh itself and display the site once Jekyll has finished rendering.
+
+
 ## Contributing
 
 Contributions are more than just welcome.

data/Rakefile

@@ -1,9 +1,5 @@
-require 'rubygems'
-require 'rubygems/specification'
-require 'rubygems/package_task'
 require 'rake/testtask'
-#require 'extensions/all'
-require_relative 'lib/rack/jekyll'
+
 
 task :default => :test
 

data/example/404.md

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

data/example/_config.yml

@@ -0,0 +1,5 @@
+permalink: /:year/:month/:day/:title/
+markdown: kramdown
+
+exclude:
+  - config.ru

data/example/_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>Rack-Jekyll Demo - {{ page.title }}</title>
+  {% else %}
+  <title>Rack-Jekyll Demo</title>
+  {% endif %}
+</head>
+<body>
+  {{ content }}
+</body>
+</html>

data/example/_layouts/post.html

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

data/example/_posts/2009-12-21-hello-world.md

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

data/example/config.ru

@@ -0,0 +1,6 @@
+require_relative "../lib/rack/jekyll"
+
+# Middleware
+use Rack::ShowExceptions  # Nice looking errors
+
+run Rack::Jekyll.new

data/example/css/site.css

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

data/example/index.md

@@ -0,0 +1,16 @@
+---
+layout: default
+---
+
+# Rack-Jekyll Demo
+
+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/lib/rack/jekyll.rb

@@ -1,16 +1,15 @@
 require "rack"
 require "jekyll"
-require "rack/request"
-require "rack/response"
-require File.join(File.dirname(__FILE__), 'jekyll', 'filehandler')
-require File.join(File.dirname(__FILE__), 'jekyll', 'helpers')
-require File.join(File.dirname(__FILE__), 'jekyll', 'version')
-require File.join(File.dirname(__FILE__), 'jekyll', 'ext')
+require "thread"
+
+require_relative "jekyll/filehandler"
+require_relative "jekyll/utils"
+require_relative "jekyll/version"
 
 module Rack
   class Jekyll
 
-    attr_reader :config, :destination
+    attr_reader :config, :destination, :wait_page
 
     # Initializes a new Rack::Jekyll site.
     #
@@ -23,15 +22,19 @@ module Rack
     #
     # +:auto+::        whether to watch for changes and rebuild (default: +false+)
     #
+    # +:wait_page+::   a page to display while pages are rendering (default: "templates/wait.html")
+    #
     # Other options are passed on to Jekyll::Site.
     def initialize(options = {})
       overrides = options.dup
-      @compiling = false
       @force_build = overrides.fetch(:force_build, false)
       @auto        = overrides.fetch(:auto, false)
+      @wait_page   = read_wait_page(overrides)
+      @compile_queue = Queue.new
 
       overrides.delete(:force_build)
       overrides.delete(:auto)
+      overrides.delete(:wait_page)
       @config = ::Jekyll.configuration(overrides)
 
       @destination = @config["destination"]
@@ -59,27 +62,29 @@ module Rack
         ignore_pattern = %r{#{Regexp.escape(relative_path_to_dest)}}
 
         listener = Listen.to(@source, :ignore => ignore_pattern) do |modified, added, removed|
-          t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
-          n = modified.length + added.length + removed.length
-          process("[#{t}] Regenerating: #{n} file(s) changed")
+          unless compiling?
+            t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+            n = modified.length + added.length + removed.length
+            process("[#{t}] Regenerating: #{n} file(s) changed")
+          end
         end
         listener.start  unless Listen::VERSION =~ /\A[0-1]\./
       end
     end
 
     def call(env)
-      while @compiling
-        sleep 0.1
-      end
-
       request = Rack::Request.new(env)
 
+      while compiling?
+        return serve_wait_page(request)
+      end
+
       filename = @files.get_filename(request.path_info)
 
       if filename
-        mime = mime(filename)
+        media_type = Utils.media_type(filename)
 
-        file  = file_info(filename)
+        file = Utils.file_info(filename)
         body = file[:body]
         time = file[:time]
         hdrs = { "Last-Modified" => time }
@@ -88,7 +93,7 @@ module Rack
           response = [304, hdrs, []]
         else
           hdrs.update({ "Content-Length" => body.bytesize.to_s,
-                        "Content-Type"   => mime })
+                        "Content-Type"   => media_type })
           response = [200, hdrs, [body]]
         end
 
@@ -102,14 +107,21 @@ module Rack
       request.head? ? remove_body(response) : response
     end
 
+    def compiling?
+      !@compile_queue.empty?
+    end
+
     private
 
     def process(message = nil)
-      @compiling = true
-      puts message  if message
-      @site.process
-      @files.update
-      @compiling = false
+      puts message if message
+      @compile_queue << '.'
+
+      Thread.new do
+        @site.process
+        @files.update
+        @compile_queue.clear
+      end
     end
 
     def not_found_message
@@ -123,7 +135,27 @@ module Rack
     def custom_404
       filename = @files.get_filename("/404.html")
 
-      filename ? file_info(filename)[:body] : nil
+      filename ? Utils.file_info(filename)[:body] : nil
+    end
+
+    def read_wait_page(options)
+      path = ::File.expand_path("templates/wait.html", ::File.dirname(__FILE__))
+      if options.key?(:wait_page)
+        if ::File.exist?(options[:wait_page])
+          path = options[:wait_page]
+        else
+          puts "Could not read #{options[:wait_page]}.  Using default."
+        end
+      end
+      ::File.open(path, 'r').read
+    end
+
+    def serve_wait_page(req)
+      headers ||= {}
+      headers['Content-Length'] = @wait_page.bytesize.to_s
+      headers['Content-Type'] = 'text/html'
+      headers['Connection'] = 'keep-alive'
+      [200, headers, [@wait_page]]
     end
 
     def remove_body(response)

data/lib/rack/jekyll/utils.rb

@@ -0,0 +1,21 @@
+module Rack
+  class Jekyll
+    module Utils
+
+      def self.media_type(filename)
+        extension = ::File.extname(filename)
+
+        Rack::Mime.mime_type(extension)
+      end
+
+      def self.file_info(path)
+        info = {
+          :body => ::File.read(path),
+          :time => ::File.mtime(path).httpdate
+        }
+
+        info
+      end
+    end
+  end
+end

data/lib/rack/jekyll/version.rb

@@ -1,7 +1,7 @@
 module Rack
   class Jekyll
     def self.version
-      '0.4.5'
+      '0.5.0'
     end
   end
 end

data/lib/rack/templates/wait.html

@@ -0,0 +1,48 @@
+<!DOCTYPE HTML>
+<html lang="en-US">
+<head>
+  <meta charset="UTF-8"/>
+  <meta http-equiv="refresh" content="60"/>
+  <title>Jekyll is working</title>
+  <style type="text/css">
+    html {
+      position: relative;
+      min-height: 100%;
+    }
+
+    body {
+      font-family: "Liberation Sans", Tahoma, Geneva, "Helvetica Neue", Helvetica, Arial, sans-serif;
+      background-color: #555;
+      background-image: linear-gradient(to bottom, #555 0%, #333 100%);
+      background-repeat: repeat-x;
+    }
+
+    div#message {
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      transform: translate(-50%, -50%);
+
+      background-color: #c00;
+      background-image: linear-gradient(to bottom, #a70000 0%, #7d0000 100%);
+      background-repeat: repeat-x;
+
+      border-color: #730000;
+      border-radius: 5px;
+
+      color: #fff;
+      padding: 15px;
+    }
+
+    div#message h1 {
+      margin-top: 5px;
+      margin-bottom: 5px;
+    }
+  </style>
+</head>
+<body>
+  <div id="message">
+    <h1>Jekyll is currently rendering the site.</h1>
+    <h1>Please try again shortly.</h1>
+  </div>
+</body>

data/rack-jekyll.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-require File.join(File.dirname(__FILE__), "lib", "rack", "jekyll", "version")
+require_relative "lib/rack/jekyll/version"
 
 Gem::Specification.new do |s|
  s.required_rubygems_version = ">= 1.3.6"
@@ -20,15 +20,19 @@ Gem::Specification.new do |s|
              rack-jekyll.gemspec
              Gemfile
              Rakefile
+             History.markdown
              LICENSE
            } +
-           Dir.glob("lib/**/*")
+           Dir.glob("lib/**/*") +
+           Dir.glob("example/**/*").reject {|f| f =~ %r(\Aexample/_site/) }
  s.test_files = Dir.glob("{test,features}/**/*")
  s.require_paths = ["lib"]
 
- s.extra_rdoc_files = ["README.markdown"]
+ s.extra_rdoc_files = %w[README.markdown History.markdown LICENSE]
  s.rdoc_options = ['--charset=UTF-8', '--main=README.markdown']
 
+ s.required_ruby_version = '>= 1.9.3'
+
  s.add_dependency "jekyll", ">= 1.3"
  s.add_dependency "rack", "~> 1.5"
  s.add_dependency "listen", ">= 1.3"

data/test/helper.rb

@@ -47,6 +47,9 @@ def rack_jekyll(options = {})
   jekyll = nil
   silence_output do
     jekyll = Rack::Jekyll.new(options)
+    while jekyll.compiling?
+      sleep 0.4
+    end
   end
 
   jekyll

data/test/test_configuration.rb

@@ -77,6 +77,16 @@ describe "when configuring site" do
       jekyll = rack_jekyll_without_build(:force_build => "ok")
       jekyll.config.wont_include "force_build"
     end
+
+    it ":wait_page is not passed on to Jekyll" do
+      jekyll = rack_jekyll_without_build(:wait_page => "foobar")
+      jekyll.config.wont_include "wait_page"
+    end
+
+    it ":wait_page uses default" do
+      jekyll = rack_jekyll_without_build(:wait_page => "/does/not/exist")
+      jekyll.wait_page.must_match %r{Please try again shortly}
+    end
   end
 
   describe "when initialization options are given and a config file exists" do

data/test/test_requests.rb

@@ -84,6 +84,34 @@ describe "when handling requests" do
   end
 
 
+  describe "when the site is compiling" do
+
+    it "should serve a wait page" do
+      begin
+        filename = File.join(@sourcedir, "custom_wait.html")
+        File.open(filename, "w") {|f| f.puts "Custom Wait" }
+
+        jekyll = nil
+        silence_output do
+          # This is a little brittle as the site renders in a separate thread
+          # Theoretically, if the site rendered fast enough, the request
+          # would end up getting actual content instead of the wait page
+          # and this test would fail.
+          jekyll = Rack::Jekyll.new(:force_build => true,
+                                    :source      => @sourcedir,
+                                    :destination => @destdir,
+                                    :wait_page   => filename)
+        end
+        request = Rack::MockRequest.new(jekyll)
+
+        request.get("/index.html").body.must_match %r{Custom Wait}
+      ensure
+        FileUtils.rm(filename)
+      end
+    end
+  end
+
+
   describe "when a directory is requested" do
 
     it "should redirect with status 301 to 'directory/' for 'directory' with index.html" do

data/test/test_utils.rb

@@ -0,0 +1,54 @@
+require_relative "helper"
+
+
+describe Rack::Jekyll::Utils do
+
+  before do
+    @utils = Rack::Jekyll::Utils
+  end
+
+
+  describe "when asked for #media_type" do
+
+    it "returns correct type for HTML" do
+      @utils.media_type("index.html").must_equal "text/html"
+    end
+
+    it "returns correct type for HTML with full path" do
+      @utils.media_type("/path/index.html").must_equal "text/html"
+    end
+
+    it "returns correct type for CSS" do
+      @utils.media_type("/path/style.css").must_equal "text/css"
+    end
+
+    it "returns correct type for *.min.js" do
+      @utils.media_type("script.min.js").must_equal "application/javascript"
+    end
+
+    it "returns correct default type for files without extension" do
+      @utils.media_type("README").must_equal "application/octet-stream"
+    end
+
+    it "ignores lower/upper case in file extensions" do
+      @utils.media_type("image.JpG").must_equal "image/jpeg"
+    end
+  end
+
+
+  describe "when asked for #file_info" do
+
+    before do
+      @filename = __FILE__
+      @info = @utils.file_info(@filename)
+    end
+
+    it "has the file content" do
+      @info[:body].must_equal ::File.read(@filename)
+    end
+
+    it "has the modification time in httpdate format" do
+      @info[:time].must_equal ::File.mtime(@filename).httpdate
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Bryan Goines
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -87,19 +87,30 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.markdown
+- History.markdown
+- LICENSE
 files:
 - Gemfile
+- History.markdown
 - LICENSE
 - README.markdown
 - Rakefile
+- example/404.md
+- example/_config.yml
+- example/_layouts/default.html
+- example/_layouts/post.html
+- example/_posts/2009-12-21-hello-world.md
+- example/config.ru
+- example/css/site.css
+- example/index.md
 - features/requests.feature
 - features/step_definitions/rack_jekyll_steps.rb
 - features/support/env.rb
 - lib/rack/jekyll.rb
-- lib/rack/jekyll/ext.rb
 - lib/rack/jekyll/filehandler.rb
-- lib/rack/jekyll/helpers.rb
+- lib/rack/jekyll/utils.rb
 - lib/rack/jekyll/version.rb
+- lib/rack/templates/wait.html
 - rack-jekyll.gemspec
 - test/helper.rb
 - test/source/_config.yml
@@ -116,6 +127,7 @@ files:
 - test/test_configuration.rb
 - test/test_filehandler.rb
 - test/test_requests.rb
+- test/test_utils.rb
 homepage: https://github.com/adaoraul/rack-jekyll
 licenses: []
 metadata: {}
@@ -129,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -137,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: rack-jekyll
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Transform your Jekyll app into a Rack application.
@@ -157,6 +169,7 @@ test_files:
 - test/test_configuration.rb
 - test/test_filehandler.rb
 - test/test_requests.rb
+- test/test_utils.rb
 - features/requests.feature
 - features/step_definitions/rack_jekyll_steps.rb
 - features/support/env.rb

data/lib/rack/jekyll/ext.rb

@@ -1,7 +0,0 @@
-class String
-  if RUBY_VERSION < "1.9"
-    def bytesize
-      size
-    end
-  end
-end

data/lib/rack/jekyll/helpers.rb

@@ -1,16 +0,0 @@
-module Rack
-  class Jekyll
-    def mime(filename)
-      ext = ::File.extname(filename)
-
-      Rack::Mime.mime_type(ext)
-    end
-
-    def file_info(path)
-      expand_path = ::File.expand_path(path)
-      ::File.open(expand_path, 'r') do |f|
-        {:body => f.read, :time => f.mtime.httpdate, :expand_path => expand_path}
-      end
-    end
-  end
-end