rack-bunto 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a0a6260a7e80b2dec58dc78f6a1564190c936b4
+  data.tar.gz: 508e696fb10d80687adcabc91992b747dc607003
+SHA512:
+  metadata.gz: d3841eb3fae037ac0eeff9c831ff33db3966c88c6d9078ff5d11df5f834dffc873367f893223b8f25e3d56f40c2e466207b9f70f92b7cff71b94fdff31b68ab3
+  data.tar.gz: 3bc0ed70bb0d426d1ee4842d29f23581a70d5f415eacc0c43ca1a7e9017fd94a264ba70bfa8a1f6a96347029599f970bdda451039bf19b5f63eadc9dcd1220cc

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org/'
+
+group :test do
+  gem "cucumber",    "2.1.0"
+end
+
+gemspec

data/History.markdown

@@ -0,0 +1,5 @@
+# Rack-Bunto Release History
+> See [commit log](https://github.com/bunto/rack-bunto/commits/master) on GitHub!
+
+## 1.0.0 / 2016-03-25
+ * Birthday!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016-present Bryan Goines & Suriyaa Kudo
+ 
+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.markdown

@@ -0,0 +1,93 @@
+# Rack-Bunto
+
+> **Transform your [Bunto](https://bunto.github.io/) app
+into a [Rack](https://github.com/rack/rack) application.**
+
+- You can run it with rackup, [shotgun](https://github.com/rtomayko/shotgun),
+  [unicorn](http://unicorn.bogomips.org/), and more.
+- You can run Rack-Bunto with any modified Bunto.
+- You can deploy Rack-Bunto to Heroku, EC2, Rackspace,
+  dedicated servers, VPS, etc.
+
+
+## How to use it
+
+A `config.ru` file is required in order to run with shotgun and rackup.
+You can even deploy your Bunto app to [Heroku](https://www.heroku.com/)!
+
+Copy this into `config.ru` in your Bunto site's root directory:
+
+``` ruby
+require "rack/bunto"
+
+run Rack::Bunto.new
+```
+
+That's it.
+
+Heroku provides a read-only filesystem, so you need to generate pages
+and git-commit them *before* you deploy your Bunto site to Heroku.
+
+ 1. `cd` to your Bunto directory
+ 2. add a `config.ru` file (see example above)
+ 3. build pages with `bunto build`
+ 4. add `gem "rack-bunto"` to your `Gemfile`
+ 5. `git init && git add .`
+ 6. `git commit -m "Initial commit"`
+ 7. `heroku create`
+ 8. `git push heroku master`
+
+
+## Configuration
+
+Bunto configuration options can be specified in a `_config.yml` file
+or as Rack-Bunto initialization options in `config.ru`.
+
+Example:
+
+``` ruby
+run Rack::Bunto.new(:destination => "mysite")
+```
+
+This will set a custom destination path, overriding the default (`_site`)
+and settings from a config file.
+
+See [Bunto's configuration docs](https://bunto.github.io/docs/configuration/)
+for more settings.
+
+Additional Rack-Bunto initialization options:
+
+    :config        - use given config file (default: "_config.yml")
+    :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)
+
+Note that on read-only filesystems a site build will fail,
+so do not set `:force_build => true` in these cases.
+
+
+## 404 page
+
+In your site's root directory you can provide a custom `404.html` file
+with YAML front matter.
+
+
+## Contributing
+
+Contributions are more than just welcome.
+Fork this repo and create a new branch, then submit a pull request.
+
+
+## Contributors
+
+* adaoraul (Adão Raul)
+* SuriyaaKudoIsc (Suriyaa Kudo)
+* Nerian (Gonzalo Rodríguez-Baltanás Díaz)
+* scottwater (Scott Watermasysk)
+* thedjinn (Emil Loer)
+* bry4n (Bryan Goines)
+* thibaudgg (Thibaud Guillaume-Gentil)
+* bemurphy (Brendon Murphy)
+* imajes (James Cox)
+* mattr- (Matt Rogers)
+* stomar (Marcus Stollsteimer)

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake/testtask'
+
+
+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 rack-bunto.gemspec"
+end
+
+desc "Install gem"
+task :install => :build do
+  sh "gem install rack-bunto-#{Rack::Bunto.version}.gem"
+end
+
+desc "Push gem to rubygems.org"
+task :push do
+  sh "gem push rack-bunto-#{Rack::Bunto.version}.gem"
+end
+
+desc "Clean up gem"
+task :clean do
+  sh "rm *.gem"
+end
+
+desc "Run demo"
+task :demo do
+  puts " ==> Starting demo: http://localhost:3000/"
+  Dir.chdir("example") do
+    sh "rackup -p 3000"
+  end
+end

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-Bunto Demo - {{ page.title }}</title>
+  {% else %}
+  <title>Rack-Bunto 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-Bunto.

data/example/config.ru

@@ -0,0 +1,6 @@
+require_relative "../lib/rack/bunto"
+
+# Middleware
+use Rack::ShowExceptions  # Nice looking errors
+
+run Rack::Bunto.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-Bunto 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/features/requests.feature

@@ -0,0 +1,36 @@
+Feature: Rack-Bunto
+  In order to ensure results are correct
+  As a Bunto
+  I want to become a Rack application
+
+  Scenario: Request 200 page
+    Given I have entered the path /
+    When I request a page
+    Then the http status should be 200
+    Then the content-type should be text/html
+    And the content-length should be 24
+    And the data should show <p>Rack-Bunto Test</p>
+
+  Scenario: Request 304 page
+    Given I have entered the path /
+    When I request a page with a date of Last-Modified
+    Then the http status should be 304
+    And there should be no 'Content-Length' header
+
+  Scenario: Request 404 page
+    Given I have entered the path /show/me/404/
+    When I request a page
+    Then the http status should be 404
+    And the content-type should be text/html
+    And the content-length should be 9
+
+  Scenario: Request static pages
+    Given I have entered the path /css/test.css
+    When I request a page
+    Then the http status should be 200
+    Then the content-type should be text/css
+
+    Given I have entered the path /js/test.js
+    When I request a page
+    Then the http status should be 200
+    Then the content-type should be application/javascript

data/features/step_definitions/rack_bunto_steps.rb

@@ -0,0 +1,58 @@
+Before do
+  @old_pwd = Dir.pwd
+  FileUtils.mkdir_p(TEMP_DIR)  unless File.exist?(TEMP_DIR)
+  Dir.chdir(TEMP_DIR)
+
+  FileUtils.mkdir_p(SOURCE_DIR)  unless File.exist?(SOURCE_DIR)
+  FileUtils.mkdir_p(DEST_DIR)    unless File.exist?(DEST_DIR)
+
+  @bunto = Rack::Bunto.new(:force_build => true,
+                             :source      => SOURCE_DIR,
+                             :destination => DEST_DIR)
+end
+
+After do
+  FileUtils.rm_rf(TEMP_DIR)  if File.exist?(TEMP_DIR)
+  Dir.chdir(@old_pwd)
+end
+
+
+Given /^I have entered the path (.*)$/ do |path|
+  @path = path
+end
+
+
+When /^I request a page$/ do
+  @response = get(@path)
+end
+
+When /^I request a page with a date of Last-Modified$/ do
+  modify_time = get(@path).headers["Last-Modified"]
+  @response = get(@path, {'HTTP_IF_MODIFIED_SINCE' => modify_time})
+end
+
+
+Then /^the http status should be (.*)$/ do |code|
+  assert_equal(code, @response.status.to_s)
+end
+
+Then /^the content\-type should be (.*)$/ do |type|
+  assert_equal(type, @response.headers["Content-Type"])
+end
+
+Then /^the content\-length should be (.*)$/ do |length|
+  assert_equal(length, @response.original_headers["Content-Length"])
+end
+
+Then /^the data should show (.*)$/ do |body|
+  assert_equal(body.chomp, @response.body.chomp)
+end
+
+Then /^there should be no '(.*)' header$/ do |header|
+  refute @response.headers.has_key?(header)
+end
+
+def get(path, headers={})
+  req = Rack::MockRequest.new(@bunto)
+  req.get(path,headers)
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require "minitest"
+require "rack/mock"
+
+require_relative "../../lib/rack/bunto"
+
+TEST_DIR   = File.expand_path("../../../test", __FILE__)
+TEMP_DIR   = File.join(TEST_DIR, "tmp")
+SOURCE_DIR = File.join(TEST_DIR, "source")
+DEST_DIR   = File.join(TEMP_DIR, "_site")

data/lib/rack/bunto/filehandler.rb

@@ -0,0 +1,56 @@
+module Rack
+  class Bunto
+    class FileHandler
+
+      attr_reader :root, :files
+
+      # Initializes a FileHandler for a given root directory
+      # (for testing only: use a given array of filenames, +files+).
+      def initialize(root, files = nil)
+        @root = ::File.expand_path(root)
+        @files = files || get_file_list
+      end
+
+      def empty?
+        @files.empty?
+      end
+
+      def update
+        @files = get_file_list
+      end
+
+      # Returns the full file system path of the file corresponding to
+      # the given URL path, or +nil+ if no corresponding file exists.
+      def get_filename(path)
+        fullpath = ::File.join(@root, path)
+
+        if fullpath.end_with?("/")
+          normalized = fullpath + "index.html"
+        elsif !@files.include?(fullpath)
+          normalized = fullpath + "/index.html"
+        else
+          normalized = fullpath
+        end
+
+        if @files.include?(normalized)
+          filename = normalized
+        else
+          filename = nil
+        end
+
+        filename
+      end
+
+      private
+
+      # Retrieves and returns a list of all files in the root directory
+      # (excluding directory names).
+      def get_file_list
+        files = ::Dir[@root + "/**/*"]
+        files.delete_if {|file| ::FileTest.directory?(file) }
+
+        files
+      end
+    end
+  end
+end

data/lib/rack/bunto/utils.rb

@@ -0,0 +1,21 @@
+module Rack
+  class Bunto
+    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/bunto/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  class Bunto
+    def self.version
+      '1.0.0'
+    end
+  end
+end

data/lib/rack/bunto.rb

@@ -0,0 +1,133 @@
+require "rack"
+require "bunto"
+
+require_relative "bunto/filehandler"
+require_relative "bunto/utils"
+require_relative "bunto/version"
+
+module Rack
+  class Bunto
+
+    attr_reader :config, :destination
+
+    # Initializes a new Rack::Bunto site.
+    #
+    # Options:
+    #
+    # +:config+::      use given config file (default: "_config.yml")
+    #
+    # +: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+)
+    #
+    # Other options are passed on to Bunto::Site.
+    def initialize(options = {})
+      overrides = options.dup
+      @compiling = false
+      @force_build = overrides.fetch(:force_build, false)
+      @auto        = overrides.fetch(:auto, false)
+
+      overrides.delete(:force_build)
+      overrides.delete(:auto)
+      @config = ::Bunto.configuration(overrides)
+
+      @destination = @config["destination"]
+      @source      = @config["source"]
+
+      @files = FileHandler.new(@destination)
+      @site = ::Bunto::Site.new(@config)
+
+      if @files.empty? || @force_build
+        process("Generating site: #{@source} -> #{@destination}")
+      end
+
+      if @auto
+        require 'listen'
+        require 'listen/version'
+        require 'pathname'
+
+        puts "Auto-regeneration enabled: #{@source} -> #{@destination}"
+
+        source_abs = ::File.expand_path(@source)
+        dest_abs   = ::File.expand_path(@destination)
+        relative_path_to_dest = Pathname.new(dest_abs)
+                                .relative_path_from(Pathname.new(source_abs))
+                                .to_path
+        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")
+        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)
+
+      filename = @files.get_filename(request.path_info)
+
+      if filename
+        media_type = Utils.media_type(filename)
+
+        file = Utils.file_info(filename)
+        body = file[:body]
+        time = file[:time]
+        hdrs = { "Last-Modified" => time }
+
+        if time == request.env["HTTP_IF_MODIFIED_SINCE"]
+          response = [304, hdrs, []]
+        else
+          hdrs.update({ "Content-Length" => body.bytesize.to_s,
+                        "Content-Type"   => media_type })
+          response = [200, hdrs, [body]]
+        end
+
+      else
+        body = not_found_message
+        hdrs = { "Content-Length" => body.bytesize.to_s,
+                 "Content-Type"   => "text/html" }
+        response = [404, hdrs, [body]]
+      end
+
+      request.head? ? remove_body(response) : response
+    end
+
+    private
+
+    def process(message = nil)
+      @compiling = true
+      puts message  if message
+      @site.process
+      @files.update
+      @compiling = false
+    end
+
+    def not_found_message
+      custom_404 || default_404
+    end
+
+    def default_404
+      "Not found"
+    end
+
+    def custom_404
+      filename = @files.get_filename("/404.html")
+
+      filename ? Utils.file_info(filename)[:body] : nil
+    end
+
+    def remove_body(response)
+      status, headers, _body = response
+
+      [status, headers, []]
+    end
+  end
+end

data/rack-bunto.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+require_relative "lib/rack/bunto/version"
+
+Gem::Specification.new do |s|
+ s.required_rubygems_version = ">= 1.3.6"
+
+ s.name        = "rack-bunto"
+ s.version     = Rack::Bunto.version
+
+ s.summary     = "Transform your Bunto app into a Rack application."
+ s.description = "Rack-Bunto transforms your Bunto app into a Rack application."
+
+ s.authors  = ["Bryan Goines", "Suriyaa Kudo", "Adão Raul"]
+ s.email    = ["adao.raul@gmail.com", "SuriyaaKudoIsc@users.noreply.github.com"]
+ s.homepage = "https://github.com/bunto/rack-bunto"
+
+ s.files = %w{
+             README.markdown
+             rack-bunto.gemspec
+             Gemfile
+             Rakefile
+             History.markdown
+             LICENSE
+           } +
+           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 = %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 "bunto", ">= 2.0"
+ s.add_dependency "rack", "~> 1.5"
+ s.add_dependency "listen", ">= 1.3"
+
+ s.add_development_dependency "rake"
+ s.add_development_dependency "minitest"
+
+ s.platform = Gem::Platform::RUBY
+ s.rubyforge_project = "rack-bunto"
+end