rack-bunto 1.0.0

data/test/helper.rb

@@ -0,0 +1,72 @@
+require "minitest/autorun"
+require "stringio"
+require "time"
+require "rack/mock"
+
+require_relative "../lib/rack/bunto"
+
+TEST_DIR = File.expand_path("..", __FILE__)
+
+
+def silence_warnings
+  original_verbose, $VERBOSE = $VERBOSE, nil
+
+  yield
+ensure
+  $VERBOSE = original_verbose
+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 without_processing
+  silence_warnings do
+    Bunto::Site.class_eval do
+      alias :original_process :process
+      def process; end
+    end
+  end
+
+  yield
+ensure
+  silence_warnings do
+    Bunto::Site.class_eval do
+      alias :process :original_process
+      remove_method :original_process
+    end
+  end
+end
+
+def rack_bunto(options = {})
+  bunto = nil
+  silence_output do
+    bunto = Rack::Bunto.new(options)
+  end
+
+  bunto
+end
+
+def rack_bunto_without_build(options = {})
+  bunto = nil
+  without_processing do
+    bunto = rack_bunto(options)
+  end
+
+  bunto
+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/_config.yml

@@ -0,0 +1 @@
+fake_option: "ok"

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

@@ -0,0 +1,3 @@
+---
+---
+Rack-Bunto post

data/test/source/buenos_dias.md

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

data/test/source/css/test.css

@@ -0,0 +1 @@
+

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

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

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

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

data/test/source/index.md

@@ -0,0 +1,3 @@
+---
+---
+Rack-Bunto Test

data/test/source/js/test.js

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+

data/test/source/no-extension

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

data/test/test_build.rb

@@ -0,0 +1,55 @@
+require_relative "helper"
+
+
+describe "when initializing a Rack::Bunto instance" do
+
+  before do
+    @tempdir = File.join(TEST_DIR, "tmp")
+    FileUtils.mkdir_p(@tempdir)  unless File.exist?(@tempdir)
+    Dir.chdir(@tempdir)
+
+    @sourcedir = File.join(TEST_DIR, "source")
+    @destdir   = File.join(@tempdir, "_site")
+    FileUtils.mkdir_p(@sourcedir)  unless File.exist?(@sourcedir)
+    FileUtils.mkdir_p(@destdir)    unless File.exist?(@destdir)
+
+    @page      = File.join(@destdir, "index.html")
+    @fake_page = File.join(@destdir, "fake.html")
+  end
+
+  after do
+    FileUtils.rm_rf(@tempdir)  if File.exist?(@tempdir)
+  end
+
+  describe "when non-empty destination directory exists" do
+
+    before do
+      FileUtils.touch(@fake_page)
+    end
+
+    it "should not build the site by default" do
+      file_wont_exist(@page)
+      rack_bunto(:source      => @sourcedir,
+                  :destination => @destdir)
+      file_wont_exist(@page)
+    end
+
+    it "should build the site when :force_build option is set" do
+      file_wont_exist(@page)
+      rack_bunto(:force_build => true,
+                  :source      => @sourcedir,
+                  :destination => @destdir)
+      file_must_exist(@page)
+    end
+  end
+
+  describe "when empty destination directory exists" do
+
+    it "should build the site" do
+      file_wont_exist(@page)
+      rack_bunto(:source      => @sourcedir,
+                  :destination => @destdir)
+      file_must_exist(@page)
+    end
+  end
+end

data/test/test_configuration.rb

@@ -0,0 +1,110 @@
+require_relative "helper"
+
+
+describe "when configuring site" do
+
+  before do
+    @tempdir = File.join(TEST_DIR, "tmp")
+    FileUtils.mkdir_p(@tempdir)  unless File.exist?(@tempdir)
+    Dir.chdir(@tempdir)
+  end
+
+  after do
+    FileUtils.rmdir(@tempdir)  if File.exist?(@tempdir)
+  end
+
+  describe "when no options are given and no config file exists" do
+
+    it "loads the correct default destination" do
+      bunto = rack_bunto_without_build
+      bunto.destination.must_equal File.join(Dir.pwd, "_site")
+    end
+  end
+
+  describe "when using default config file" do
+
+    it "loads the configuration from file" do
+      begin
+        File.open("_config.yml", "w") do |f|
+          f.puts "config_file_opt: ok"
+        end
+
+        bunto = rack_bunto_without_build
+        bunto.config.must_include "config_file_opt"
+        bunto.config["config_file_opt"].must_equal "ok"
+      ensure
+        FileUtils.rm("_config.yml")
+      end
+    end
+  end
+
+  describe "when using custom config file" do
+
+    it "loads the configuration from file" do
+      begin
+        File.open("_my_config.yml", "w") do |f|
+          f.puts "config_file_opt: ok"
+        end
+
+        bunto = rack_bunto_without_build(:config => "_my_config.yml")
+        bunto.config.must_include "config_file_opt"
+        bunto.config["config_file_opt"].must_equal "ok"
+      ensure
+        FileUtils.rm("_my_config.yml")
+      end
+    end
+  end
+
+  describe "when initialization options are given" do
+
+    it "has the initialization options" do
+      bunto = rack_bunto_without_build(:init_opt => "ok")
+      bunto.config.must_include "init_opt"
+      bunto.config["init_opt"].must_equal "ok"
+    end
+
+    it "has the correct destination" do
+      bunto = rack_bunto_without_build(:destination => "/project/_site")
+      bunto.destination.must_equal "/project/_site"
+    end
+
+    it ":auto is not passed on to Bunto" do
+      bunto = rack_bunto_without_build(:auto => "ok")
+      bunto.config.wont_include "auto"
+    end
+
+    it ":force_build is not passed on to Bunto" do
+      bunto = rack_bunto_without_build(:force_build => "ok")
+      bunto.config.wont_include "force_build"
+    end
+  end
+
+  describe "when initialization options are given and a config file exists" do
+
+    before do
+      File.open("_config.yml", "w") do |f|
+        f.puts "config_file_opt: ok"
+        f.puts "common_opt:      from config"
+        f.puts "destination:     /project/_site_from_config"
+      end
+    end
+
+    after do
+      FileUtils.rm("_config.yml")
+    end
+
+    it "has all options and initialization options override file options" do
+      bunto = rack_bunto_without_build(:init_opt   => "ok",
+                                         :common_opt => "from init")
+      bunto.config.must_include "init_opt"
+      bunto.config.must_include "config_file_opt"
+      bunto.config.must_include "common_opt"
+      bunto.config["common_opt"].must_equal "from init"
+    end
+
+    it "has the correct destination" do
+      bunto = rack_bunto_without_build(:destination => "/project/_site_from_init")
+      bunto.destination.must_equal "/project/_site_from_init"
+    end
+  end
+end

data/test/test_filehandler.rb

@@ -0,0 +1,91 @@
+require_relative "helper"
+
+
+describe Rack::Bunto::FileHandler do
+
+  describe "when asked for filenames with #get_filename" do
+
+    before do
+      files = [
+        "/site/index.html",
+        "/site/page.html",
+        "/site/README",
+        "/site/dir-with-index/index.html",
+        "/site/dir-without-index/page.html",
+        "/site/dir1/dir2/dir3/index.html"
+      ]
+      @filehandler = Rack::Bunto::FileHandler.new("/site", files)
+    end
+
+    it "should return path for '/'" do
+      @filehandler.get_filename("/").must_equal "/site/index.html"
+    end
+
+    it "should return existing path" do
+      @filehandler.get_filename("/page.html").must_equal "/site/page.html"
+    end
+
+    it "should return nil for non-existent path" do
+      @filehandler.get_filename("/not-a-page.html").must_be_nil
+    end
+
+    it "should return existing path for resource without extension" do
+      @filehandler.get_filename("/README").must_equal "/site/README"
+    end
+
+    it "should return nil for partially matching paths" do
+      @filehandler.get_filename("/dir1/dir2/").must_be_nil
+      @filehandler.get_filename("/dir2/dir3").must_be_nil
+      @filehandler.get_filename("ir1/di").must_be_nil
+    end
+
+    it "should return path for directory/ with index" do
+      @filehandler.get_filename("/dir-with-index/").must_equal "/site/dir-with-index/index.html"
+    end
+
+    it "should return path for directory with index" do
+      @filehandler.get_filename("/dir-with-index").must_equal "/site/dir-with-index/index.html"
+    end
+
+    it "should return nil for directory/ without index" do
+      @filehandler.get_filename("/dir-without-index/").must_be_nil
+    end
+
+    it "should return nil for directory without index" do
+      @filehandler.get_filename("/dir-without-index").must_be_nil
+    end
+  end
+
+
+  describe "when retrieving the file list from root directory" do
+
+    before do
+      sourcedir = File.join(TEST_DIR, "source")
+      @filehandler = Rack::Bunto::FileHandler.new(sourcedir)
+      @existing_file = File.join(sourcedir, "index.md")
+      @existing_dir  = File.join(sourcedir, "css")
+    end
+
+    it "should include regular files" do
+      @filehandler.files.must_include @existing_file
+    end
+
+    it "should not include directories" do
+      @filehandler.files.wont_include @existing_dir
+    end
+  end
+
+
+  describe "when initialized" do
+
+    it "should strip trailing slash from root" do
+      filehandler = Rack::Bunto::FileHandler.new("/site/", [])
+      filehandler.root.must_equal "/site"
+    end
+
+    it "should not append a trailing slash to root" do
+      filehandler = Rack::Bunto::FileHandler.new("/site", [])
+      filehandler.root.must_equal "/site"
+    end
+  end
+end

data/test/test_requests.rb

@@ -0,0 +1,179 @@
+# encoding: UTF-8
+
+require_relative "helper"
+
+
+describe "when handling requests" do
+
+  before do
+    @tempdir = File.join(TEST_DIR, "tmp")
+    FileUtils.mkdir_p(@tempdir)  unless File.exist?(@tempdir)
+    Dir.chdir(@tempdir)
+
+    @sourcedir = File.join(TEST_DIR, "source")
+    @destdir   = File.join(@tempdir, "_site")
+    FileUtils.mkdir_p(@sourcedir)  unless File.exist?(@sourcedir)
+    FileUtils.mkdir_p(@destdir)    unless File.exist?(@destdir)
+
+    @bunto = rack_bunto(:force_build => true,
+                          :source      => @sourcedir,
+                          :destination => @destdir)
+    @request = Rack::MockRequest.new(@bunto)
+  end
+
+  after do
+    FileUtils.rm_rf(@tempdir)  if File.exist?(@tempdir)
+  end
+
+  it "can be created" do
+    @bunto.wont_be_nil
+    @request.wont_be_nil
+  end
+
+  it "should return status 200 for existing path" do
+    @request.get("/").status.must_equal 200
+    @request.get("/2015/10/05/hello-world.html").status.must_equal 200
+  end
+
+  it "should return status 404 for nonexistent path" do
+    @request.get("/show/me/404").status.must_equal 404
+  end
+
+  it "should return status 404 for partially matching path 1" do
+    @request.get("/2015/10/05/hello").status.must_equal 404
+  end
+
+  it "should return status 404 for partially matching path 2" do
+    @request.get("/10/05/hello-world.html").status.must_equal 404
+  end
+
+  it "should return correct status code for If-Modified-Since" do
+    modify_time = @request.get("/").headers["Last-Modified"]
+    earlier_time = (Time.parse(modify_time) - 3600).httpdate
+
+    @request.get("/", {"HTTP_IF_MODIFIED_SINCE" => modify_time}).status.must_equal 304
+    @request.get("/", {"HTTP_IF_MODIFIED_SINCE" => earlier_time}).status.must_equal 200
+  end
+
+  it "should return correct status code for If-Modified-Since with 404s" do
+    modify_time = @request.get("/").headers["Last-Modified"]
+    earlier_time = (Time.parse(modify_time) - 3600).httpdate
+
+    @request.get("/show/me/404", {"HTTP_IF_MODIFIED_SINCE" => earlier_time}).status.must_equal 404
+  end
+
+  it "should return correct Content-Type header" do
+    @request.get("/").headers["Content-Type"].must_equal "text/html"
+    @request.get("/css/test.css").headers["Content-Type"].must_equal "text/css"
+    @request.get("/js/test.js").headers["Content-Type"].must_equal "application/javascript"
+    @request.get("/js/test.min.js").headers["Content-Type"].must_equal "application/javascript"
+    @request.get("/show/me/404").headers["Content-Type"].must_equal "text/html"
+  end
+
+  it "should return correct Content-Length header for '/'" do
+    @request.get("/").original_headers["Content-Length"].to_i.must_equal 24
+  end
+
+  it "should return correct Content-Length header for If-Modified-Since" do
+    modify_time = @request.get("/").headers["Last-Modified"]
+    @request.get("/", {"HTTP_IF_MODIFIED_SINCE" => modify_time}).original_headers["Content-Length"].must_be_nil
+  end
+
+  it "should return correct body for '/'" do
+    @request.get("/").body.must_equal "<p>Rack-Bunto Test</p>\n"
+  end
+
+
+  describe "when a directory is requested" do
+
+    it "should redirect with status 301 to 'directory/' for 'directory' with index.html" do
+      skip
+      @request.get("/dir-with-index").status.must_equal 301
+      @request.get("/dir-with-index").headers["Location"].must_equal "/dir-with-index/"
+    end
+
+    it "should return status 200 for 'directory/' with index.html" do
+      @request.get("/dir-with-index/").status.must_equal 200
+    end
+
+    it "should return status 404 for 'directory' without index.html" do
+      @request.get("/dir-without-index").status.must_equal 404
+    end
+
+    it "should return status 404 for 'directory/' without index.html" do
+      @request.get("/dir-without-index/").status.must_equal 404
+    end
+  end
+
+
+  describe "when a resource of unknown mime type is requested" do
+
+    it "should return status 200" do
+      @request.get("/no-extension").status.must_equal 200
+    end
+
+    it "should return Content-Type 'application/octet-stream'" do
+      @request.get("/no-extension").headers["Content-Type"].must_equal "application/octet-stream"
+    end
+  end
+
+
+  describe "when page contains multibyte characters" do
+
+    before do
+      @response = @request.get("/buenos_dias.html")
+    end
+
+    it "should return correct body" do
+      @response.body.must_equal "<p>¡Buenos días!</p>\n"
+    end
+
+    it "should return the bytesize as Content-Length header" do
+      @response.original_headers["Content-Length"].to_i.must_equal 23
+    end
+  end
+
+
+  describe "when returning 404s" do
+
+    it "should return correct body for default 404" do
+      @request.get("/show/me/404").body.must_equal "Not found"
+    end
+
+    it "should return correct Content-Length header for default 404" do
+      @request.get("/show/me/404").original_headers["Content-Length"].to_i.must_equal 9
+    end
+
+    it "should return correct body for custom 404" do
+      begin
+        filename = File.join(@sourcedir, "404.html")
+        File.open(filename, "w") {|f| f.puts "Custom 404" }
+
+        bunto = rack_bunto(:force_build => true,
+                             :source      => @sourcedir,
+                             :destination => @destdir)
+        request = Rack::MockRequest.new(bunto)
+
+        request.get("/show/me/404").body.must_match %r{Custom 404}
+      ensure
+        FileUtils.rm(filename)
+      end
+    end
+  end
+
+
+  describe "when handling HEAD requests" do
+
+    it "should return status 200 for '/'" do
+      @request.head("/").status.must_equal 200
+    end
+
+    it "should return correct Content-Length header for '/'" do
+      @request.head("/").original_headers["Content-Length"].to_i.must_equal 24
+    end
+
+    it "should not return a body" do
+      @request.head("/").body.must_equal ""
+    end
+  end
+end

data/test/test_utils.rb

@@ -0,0 +1,54 @@
+require_relative "helper"
+
+
+describe Rack::Bunto::Utils do
+
+  before do
+    @utils = Rack::Bunto::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