guard-jekyll-plus 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -42,3 +42,9 @@ New config options
 ### 1.3.0
 
 - Changed guard name to jekyll-plus to help Guard properly init the Guardfile.
+
+### 1.4.0
+
+- Now allowing Rack server as an alternative to Jekyll's WEBrick server.
+- Ships with an internal config for Rack, but users can override it in the guard config options.
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    guard-jekyll-plus (1.2.3)
+    guard-jekyll-plus (1.3.0)
       guard (>= 1.1.0)
       jekyll (>= 1.0.0)
 
@@ -12,7 +12,7 @@ GEM
       fast-stemmer (>= 1.0.0)
     coderay (1.0.9)
     colorator (0.1)
-    commander (4.1.3)
+    commander (4.1.4)
       highline (~> 1.6.11)
     directory_watcher (1.4.1)
     fast-stemmer (1.0.2)
@@ -25,19 +25,19 @@ GEM
       pry (>= 0.9.10)
       thor (>= 0.14.6)
     highline (1.6.19)
-    jekyll (1.1.0)
+    jekyll (1.1.2)
       classifier (~> 1.3)
       colorator (~> 0.1)
       commander (~> 4.1.3)
       directory_watcher (~> 1.4.1)
       kramdown (~> 1.0.2)
-      liquid (~> 2.3)
+      liquid (~> 2.5.1)
       maruku (~> 0.5)
       pygments.rb (~> 0.5.0)
       redcarpet (~> 2.2.2)
       safe_yaml (~> 0.7.0)
     kramdown (1.0.2)
-    liquid (2.5.0)
+    liquid (2.5.1)
     listen (1.2.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)

data/README.md

@@ -75,15 +75,34 @@ This guard has two configurations.
 |:--------------|:-------------------------------------------------|:-----------------------------------------------------------------------------------|
 | `extensions`  | Array of file extensions to trigger Jekyll build | ['md', 'mkd', 'mkdn', 'markdown', 'textile', 'html', 'haml', 'slim', 'xml', 'yml'] |
 | `config`      | Array of configuration files                     | ['_config.yml']                                                                    |
-| `serve`       | Use Jekyll's build in WEBrick server             | false                                                                              |
+| `serve`       | Serve your site with Jekyll or a Rack server     | false                                                                              |
 | `drafts`      | Build your site with draft posts                 | false                                                                              |
 | `future`      | Build your site with future dated posts          | false                                                                              |
 | `config_hash` | Use a config hash instead of an array of files   | nil                                                                                |
 | `silent`      | Slience all output other than exception message  | false                                                                              |
 | `msg_prefix`  | Output messages are prefixed with with this      | 'Jekyll'                                                                           |
+| `rack_config` | Optional configuration for using the rack server | nil                                                                                |
 
 **Note:** customizations to the `extensions` configuration are additive.
 
+### Using Jekyll Server
+
+To use Jekyll's built-in server, simply set `:server => true` in your rack options
+
+```ruby
+guard "jekyll-plus", :server => true do
+  watch /.*/
+  ignore /^_site/
+end
+```
+
+### Using Rack Server
+
+Simply add `gem 'rack'` to your Gemfile and Jekyll Plus will use Rack instead with a [config file](lib/rack/config.ru) which redirects `404s` and auto-appends `index.html` to directory urls.
+If you want to use [Thin](https://github.com/macournoyer/thin/), add `gem 'thin'` instead.
+
+If you wish to use your own rack server configuration, simply drop a `config.ru` file into your site root, or use the option `:rack_config => 'path/to/config.ru'` to tell Jeklly Plus where to look for your rack config file.
+
 ### Configuring Jekyll watched file extensions
 
 Here's how you would add `txt` to the list of file extensions which triggers a Jekyll build.

data/lib/guard/jekyll-plus/version.rb

@@ -1,5 +1,5 @@
 module Guard
   class JekyllPlusVersion
-    VERSION = "1.3.0"
+    VERSION = "1.4.0"
   end
 end

data/lib/guard/jekyll-plus.rb

@@ -4,6 +4,12 @@ require 'guard'
 require 'guard/guard'
 
 require 'jekyll'
+#begin require 'thin' rescue false end
+begin
+  require 'rack'
+  USE_RACK = true
+rescue LoadError
+end
 
 module Guard
   class Jekyllplus < Guard
@@ -14,14 +20,15 @@ module Guard
       default_extensions = ['md','mkd','mkdn','markdown','textile','html','haml','slim','xml','yml']
 
       @options = {
-        :extensions => [], 
-        :config => ['_config.yml'],
-        :serve => false,
-        :drafts => false,
-        :future => false,
-        :config_hash => nil,
-        :silent => false,
-        :msg_prefix => 'Jekyll'
+        :extensions     => [], 
+        :config         => ['_config.yml'],
+        :serve          => false,
+        :rack_config    => nil,
+        :drafts         => false,
+        :future         => false,
+        :config_hash    => nil,
+        :silent         => false,
+        :msg_prefix     => 'Jekyll'
       }.merge(options)
 
       # The config_hash option should be a hash ready to be consumed by Jekyll's Site class.
@@ -51,6 +58,8 @@ module Guard
       # Create a Jekyll site
       #
       @site = ::Jekyll::Site.new @config
+      @rack = ::Rack::Server.new(rack_config) if USE_RACK
+      puts @rack
 
     end
 
@@ -199,13 +208,20 @@ module Guard
       if options[:config_hash]
         config = options[:config_hash]
       elsif options[:config]
-        config_files = options[:config]
-        config_files = [config_files] unless config_files.is_a? Array
-        config = { "config" => config_files}
+        options[:config] = [options[:config]] unless options[:config].is_a? Array
+        config = options
       end
       ::Jekyll.configuration(config)
     end
 
+    def rack_config
+      default_config = File.expand_path("../rack/config.ru", File.dirname(__FILE__))
+      local_config = File.exist? 'config.ru' ? 'config.ru' : nil
+      config = (@config['rack_config'] || local_config || default_config)
+      puts config
+      { :config => config, :Port => @config['port'], :Host => @config['host'] }
+    end
+
     def local_path(path)
       Dir.chdir('.')
       current = Dir.pwd
@@ -231,7 +247,11 @@ module Guard
     end
 
     def server(config)
-      proc{ Process.fork { ::Jekyll::Commands::Serve.process(config) } }
+      if @rack
+        proc{ Process.fork { @rack.start } }
+      else
+        proc{ Process.fork { ::Jekyll::Commands::Serve.process(config) } }
+      end
     end
 
     def kill
@@ -244,6 +264,7 @@ module Guard
     end
 
     def stop_server
+      #@rack.stop if @rack
       if alive?
         instance_eval do
           kill.call(@pid)

data/lib/rack/config.ru

@@ -0,0 +1,37 @@
+module Rack
+
+  class TryStatic
+
+    def initialize(app, options)
+      @app = app
+      @try = ['', *options.delete(:try)]
+      @static = ::Rack::Static.new(lambda { [404, {}, []] }, options)
+    end
+
+    def call(env)
+      orig_path = env['PATH_INFO']
+      found = nil
+      @try.each do |path|
+        resp = @static.call(env.merge!({'PATH_INFO' => orig_path + path}))
+        break if 404 != resp[0] && found = resp
+      end
+      found or @app.call(env.merge!('PATH_INFO' => orig_path))
+    end
+
+  end
+
+end
+
+def start_rack(root, not_found)
+  use Rack::TryStatic, :root => root, :urls => %w[/], :try => ['.html', 'index.html', '/index.html']
+
+  # Run your own Rack app here or use this one to serve 404 messages:
+  run lambda{ |env|
+    not_found_page = File.exist?(not_found) ? [File.read(not_found)] : ['404 - page not found']
+    [ 404, { 'Content-Type'  => 'text/html' }, not_found_page ]
+  }
+end
+
+root = ENV['RACK_ROOT'] || '_site'
+
+start_rack  root, "#{root}/404.html"

data/test/404.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+      <meta charset="utf-8">
+      <title>404</title>
+  </head>
+  <body>
+    <h1>404</h1>
+  </body>
+</html>
+
+

data/test/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'guard-jekyll-plus', :path => "../"
+gem 'rack'

data/test/Gemfile.lock

@@ -54,6 +54,7 @@ GEM
     pygments.rb (0.5.2)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
+    rack (1.5.2)
     rb-fsevent (0.9.3)
     rb-inotify (0.9.0)
       ffi (>= 0.5.0)
@@ -71,3 +72,4 @@ PLATFORMS
 
 DEPENDENCIES
   guard-jekyll-plus!
+  rack

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-jekyll-plus
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -61,7 +61,9 @@ files:
 - lib/guard/jekyll-plus.rb
 - lib/guard/jekyll-plus/templates/Guardfile
 - lib/guard/jekyll-plus/version.rb
+- lib/rack/config.ru
 - test/.gitignore
+- test/404.html
 - test/Gemfile
 - test/Gemfile.lock
 - test/Guardfile