zenweb 2.18.1 → 3.0.0.b1

data/lib/zenweb/tasks.rake

@@ -0,0 +1,165 @@
+require 'zenweb'
+
+task :default => :generate
+
+def website
+  $website = Zenweb::Site.new
+  $website.scan
+  $website.wire
+  $website
+rescue RuntimeError => e
+  p e
+  puts e.backtrace.join "\n"
+  raise e
+end
+
+desc "Generate the website."
+task :generate do
+  site = website
+
+  site.generate
+
+  found = Dir[".site/**/*"].select { |f| File.file? f }.sort
+  known = site.pages.values.map { |p| p.url_path }.sort
+  rm found - known
+end
+
+desc "Print out possible orphans (html pages w/o parent pages)"
+task :orphans do
+  site = website
+  puts "Possible Orphans (HTML pages w/o parents):"
+  puts
+  site.pages.values.reject(&:parent).sort_by(&:clean_url).each do |page|
+    next unless page.url =~ /html$/
+    puts page
+  end
+end
+
+desc "Push changes to the site. (you need to define this)"
+task :push
+
+desc "Publish your website: clean, generate, push."
+task :publish => [:clean, :generate, :push]
+
+desc "Remove junk files."
+task :clean do
+  rm_rf Dir["**/*~"]
+end
+
+desc "Remove generated .site directory."
+task :realclean => :clean do
+  rm_rf ".site"
+end
+
+def new_file title, dated = false
+  path = "#{title.strip.downcase.gsub(/\W+/, '-')}.html.md"
+
+  if dated then
+    today = Time.now.strftime '%Y-%m-%d'
+    path = "#{today}-#{path}"
+  end
+
+  open path, 'w' do |post|
+    post.puts "---"
+    post.puts "title: \"#{title}\""
+    post.puts "date: #{Time.now.iso8601}"
+    post.puts "..."
+    post.puts
+  end
+
+  path
+end
+
+desc "Begin a new dated post: rake new_post['title']"
+task :new_post, :title do |t, args|
+  title = args[:title] || "new-post"
+
+  path = new_file title, true
+
+  warn "Created new post: #{path}"
+end
+
+desc "Begin a new dated post: rake new_page['title']"
+task :new_page, :title do |t, args|
+  title = args[:title] || "new-post"
+
+  path = new_file title
+
+  warn "Created new file: #{path}"
+end
+
+desc "Run a webserver and build on the fly."
+task :run do
+  require 'zenweb/extensions'
+  require 'webrick'
+  require 'thread'
+
+  module Rake
+    class FileTask
+      def clear_timestamp
+        @timestamp = nil
+        prerequisite_tasks.each(&:clear_timestamp)
+      end
+    end
+  end
+
+  # TODO: implement a watcher or something... this is annoying
+  class ZenwebBuilder < WEBrick::HTTPServlet::FileHandler
+    @@semaphore = Mutex.new
+
+    def service req, res
+      @@site ||= @@semaphore.synchronize { website }
+
+      url = req.path
+      target_path = File.join(".site", url)
+
+      target_path = File.join target_path, "index.html" if
+        File.directory? target_path
+
+      task = Rake.application[target_path] rescue nil
+
+      warn "NOTE: No file found for #{url}" unless task
+
+      newer = task && task.needed?
+
+      if newer then
+        system "rake clean generate"
+      end
+
+      if task && newer then
+        @@site = nil
+        Rake.application = Rake::Application.new # reset
+      end
+
+      task.clear_timestamp if task && target_path =~ /(html|css|js)$/
+
+      super
+    end
+  end
+
+  server = WEBrick::HTTPServer.new :Port => 8000
+  server.mount '/', ZenwebBuilder, ".site"
+
+  trap 'INT' do
+    server.shutdown
+  end
+
+  server.start
+end
+
+website if ENV['DEBUG']
+
+desc "Debug the generation of a file. Takes a PATH arg."
+task :debug => ".site" do
+  site = website
+
+  path = ENV['PAGE'] || ENV['F'] || ENV['FILE'] || "index.html.erb"
+
+  if path then
+    page = site.pages[path]
+    page.generate
+
+    puts
+    puts File.read page.url_path
+  end
+end

data/test/helper.rb

@@ -0,0 +1,53 @@
+class MiniTest::Unit::TestCase
+  def self.ChdirTest path
+    Module.new do
+      define_method :setup do
+        super()
+        @old_dir = Dir.pwd
+        Dir.chdir path
+      end
+
+      define_method :teardown do
+        super()
+        Dir.chdir @old_dir
+      end
+    end
+  end
+
+  def assert_task name, deps = nil, type = Rake::FileTask
+    @tasks << name
+    assert_operator Rake::Task, :task_defined?, name
+
+    task = Rake.application[name]
+    assert_kind_of type, task
+    assert_equal deps, task.prerequisites.sort, name if deps
+  end
+
+  def assert_tasks
+    @tasks = []
+    yield
+    assert_empty Rake.application.tasks.map(&:name) - @tasks
+  end
+
+  def build_fake_site(*paths)
+    paths.flatten.compact.each do |path|
+      page = Zenweb::Page.new(site, path)
+      page.content = "Content for #{path}"
+      page.config = Zenweb::Config.new site, path
+      page.config.h = {
+        "title" => "Title for #{path}"
+      }
+      site.pages[path] = page
+    end
+
+    site.fix_subpages
+  end
+end
+
+class Zenweb::Page
+  attr_writer :content, :config
+end
+
+class Zenweb::Config
+  attr_writer :h
+end

data/test/test_zenweb_config.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby -w
+
+require "rubygems"
+
+gem "rake"
+require "rake"
+require "minitest/autorun"
+
+require "zenweb/site"
+require "test/helper"
+
+class TestZenwebConfig < MiniTest::Unit::TestCase
+  include ChdirTest("example-site")
+
+  attr_accessor :site, :config
+
+  def setup
+    super
+
+    self.site = Zenweb::Site.new
+    page = Zenweb::Page.new site, "blog/2012-01-02-page1.html.md"
+    self.config = page.config
+  end
+
+  def test_h
+    exp = {"title"=>"Example Page 1"}
+    assert_equal exp, config.h
+  end
+
+  def test_index
+    assert_equal "Example Page 1", config["title"]
+  end
+
+  def test_inspect
+    exp = ['Config["blog/2012-01-02-page1.html.md"',
+           'Config["blog/_config.yml"',
+           'Config["_config.yml"',
+           'Config::Null]]]'
+          ].join ", "
+    assert_equal exp, config.inspect
+  end
+
+  def test_inspect_trace
+    exp = ['Config["blog/2012-01-02-page1.html.md"',
+           'Config["blog/_config.yml"',
+           'Config["_config.yml"',
+           'Config::Null',
+           '"exclude" => ["Rakefile", "tmp"]',
+           '"google_ua" => "UA-1234567-8"',
+           '"header" => "Example Website"]',
+           '"layout" => "post"]',
+           '"title" => "Example Page 1"]'].join ", "
+
+    assert_nil Rake.application.options.trace
+    Rake.application.options.trace = true
+    assert_equal exp, config.inspect
+  ensure
+    Rake.application.options.trace = nil
+  end
+
+  def test_parent
+    assert_equal site.configs["blog/_config.yml"], config.parent
+  end
+
+  def test_path
+    assert_equal "blog/2012-01-02-page1.html.md", config.path
+  end
+
+  def test_site
+    assert_equal site, config.site
+  end
+
+  def test_to_s
+    assert_equal "Config[\"blog/2012-01-02-page1.html.md\"]", config.to_s
+  end
+
+  def test_wire
+    Rake.application = Rake::Application.new
+    site.scan
+    self.config = site.pages["blog/2012-01-02-page1.html.md"].config
+
+    config.wire
+
+    assert_tasks do
+      assert_task "_config.yml"
+      assert_task "blog/_config.yml", %w[_config.yml]
+      assert_task config.path, %w[blog/_config.yml]
+    end
+  end
+end

data/test/test_zenweb_extensions.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+
+require "rubygems"
+require "minitest/autorun"
+require "zenweb/extensions"
+
+class TestFile < MiniTest::Unit::TestCase
+  def test_class_each_parent
+    a = []
+
+    Dir.chdir "example-site" do
+      File.each_parent "blog/index.html.erb", "_config.yml" do |f|
+        a << f
+      end
+    end
+
+    assert_equal %w[blog/_config.yml _config.yml], a
+  end
+end
+
+class TestTime < MiniTest::Unit::TestCase
+  def test_date
+    assert_equal "1969-12-31",         Time.at(0).date
+  end
+
+  def test_datetime
+    assert_equal "1969-12-31 @ 16:00", Time.at(0).datetime
+  end
+
+  def test_time
+    assert_equal "16:00",              Time.at(0).time
+  end
+end

data/test/test_zenweb_page.rb

@@ -0,0 +1,381 @@
+#!/usr/bin/ruby -w
+
+require "rubygems"
+require "minitest/autorun"
+
+require "zenweb/site"
+require "test/helper"
+
+class TestZenwebPage < MiniTest::Unit::TestCase
+  include ChdirTest("example-site")
+
+  attr_accessor :site, :page
+
+  def setup
+    super
+
+    self.site = Zenweb::Site.new
+    self.page = Zenweb::Page.new site, "blog/2012-01-02-page1.html.md"
+  end
+
+  def setup_deps
+    Rake.application = Rake::Application.new
+    site.scan
+
+    assert_empty Rake.application.tasks
+
+    p1 = site.pages["blog/2012-01-02-page1.html.md"]
+    p2 = site.pages["blog/2012-01-03-page2.html.md"]
+
+    return p1, p2
+  end
+
+  def test_body
+    assert_equal "Not really much here to see.", page.body
+  end
+
+  def test_breadcrumbs
+    site.scan
+    self.page = site.pages[page.path]
+
+    exp = %w[/index.html /blog/index.html]
+
+    assert_equal exp, page.breadcrumbs.map(&:url)
+  end
+
+  def test_clean_url
+    act = page.clean_url
+    exp = "/blog/2012/01/02/page1.html"
+
+    assert_equal exp, act
+
+    page = Zenweb::Page.new site, "a/b/index.html"
+    act = page.clean_url
+    exp = "/a/b/"
+
+    assert_equal exp, act
+  end
+
+  def test_config
+    exp = {"title" => "Example Page 1"}
+
+    assert_kind_of Zenweb::Config, page.config
+    assert_equal exp, page.config.h
+  end
+
+  def test_content
+    assert_equal File.read(page.path), page.content
+  end
+
+  def test_date
+    assert_equal Time.local(2012, 1, 2), page.date
+  end
+
+  def test_date_from_path
+    assert_equal Time.local(2012, 1, 2), page.date_from_path
+  end
+
+  def test_depends_on
+    p1, p2 = setup_deps
+
+    p1.depends_on p2
+
+    assert_tasks do
+      assert_task p1.url_path, [p2.url_path]
+    end
+  end
+
+  def test_depends_on_string
+    p1, _ = setup_deps
+
+    p1.depends_on "somethingelse"
+
+    # TODO: double check that this should be p1.path and not p1.url_path
+    assert_tasks do
+      assert_task p1.path, ["somethingelse"]
+    end
+  end
+
+  def test_filetype
+    assert_equal "md", page.filetype
+  end
+
+  def test_filetypes
+    assert_equal %w[md], page.filetypes
+  end
+
+  def test_filetypes_odd
+    page = Zenweb::Page.new site, "blah.wtf"
+    assert_equal %w[], page.filetypes
+  end
+
+  def test_generate
+    page = Zenweb::Page.new site, "blah"
+
+    def page.render
+      "woot"
+    end
+
+    def page.open path, mode
+      yield $stdout
+    end
+
+    out = "woot\n"
+    err = "Rendering .site/blah\n"
+
+    assert_output out, err do
+      page.generate
+    end
+  end
+
+  def test_generate_via_invoke
+    Rake.application = Rake::Application.new
+    site.scan
+    site.wire
+    self.page = site.pages["blog/2012-01-02-page1.html.md"]
+    Rake.application[page.url_path].clear_prerequisites # no mkdir, thanks
+
+    def page.generate
+      raise "no generate"
+    end
+
+    e = assert_raises RuntimeError do
+      Rake.application[page.url_path].invoke
+    end
+
+    assert_equal "no generate", e.message
+  ensure
+    FileUtils.rm_rf ".site"
+  end
+
+  def test_html_eh
+    assert page.html?
+
+    site.scan
+    refute site.pages["js/site.js"].html?
+  end
+
+  def test_include
+    # test via a layout page so we can test indirect access of page vars
+    layout = Zenweb::Page.new(site, "_layouts/site.erb")
+    fragment = layout.include("analytics.html.erb", page)
+    assert_match(/UA-\d+/, site.config["google_ua"])
+    assert_match site.config["google_ua"], fragment
+  end
+
+  def test_include_page_var
+    # test via a layout page so we can test indirect access of page vars
+    layout = Zenweb::Page.new(site, "_layouts/site.erb")
+    fragment = layout.include("header.html.erb", page)
+    assert_match "Example Page 1 ~ Example Website", fragment
+  end
+
+  def test_index
+    assert_equal page.config["title"], page["title"]
+  end
+
+  def test_inspect
+    assert_equal 'Page["blog/2012-01-02-page1.html.md"]', page.inspect
+  end
+
+  def test_layout
+    assert_equal site.layout("post"), page.layout
+  end
+
+  def test_link_html
+    exp = "<a href=\"/blog/2012/01/02/page1.html\">Example Page 1</a>"
+    assert_equal exp, page.link_html
+
+    exp = "<a href=\"/blog/2012/01/02/page1.html\">blah</a>"
+    assert_equal exp, page.link_html("blah")
+  end
+
+  def test_method_missing
+    assert_equal page["title"], page.method_missing("title")
+  end
+
+  def test_meta
+    exp = '<meta name="title" content="Example Page 1">'
+    assert_equal exp, page.meta("title")
+  end
+
+  def test_method_missing_odd
+    err = "Page[\"blog/2012-01-02-page1.html.md\"] does not define \"wtf\"\n"
+    assert_output "", err do
+      assert_nil page.method_missing("wtf")
+    end
+  end
+
+  def test_method_missing_render
+    e = assert_raises NoMethodError do
+      assert_nil page.render_wtf
+    end
+    err = "undefined method `render_wtf' for Page"
+    assert_includes e.message, err
+  end
+
+  def test_parent
+    site.scan
+    self.page = site.pages[page.path]
+
+    assert_equal site.pages["blog/index.html.erb"], page.parent
+  end
+
+  def test_parent_top
+    build_fake_site %w[index.html]
+
+    page = site.pages["index.html"]
+
+    assert_nil page.parent
+  end
+
+  def test_parent_url
+    assert_equal "/blog/2012/01/02/page1.html", page.url
+    assert_equal "/blog/2012/01/02/index.html", page.parent_url
+
+    page = Zenweb::Page.new(site, "a/b/c.html")
+    assert_equal "/a/b/index.html", page.parent_url
+
+    page = Zenweb::Page.new(site, "a/b/index.html")
+    assert_equal "/a/index.html", page.parent_url
+  end
+
+  def test_path
+    assert_equal "blog/2012-01-02-page1.html.md", page.path
+  end
+
+  def test_render
+    assert_equal "<p>Not really much here to see.</p>\n", page.render
+  end
+
+  def test_render_image
+    self.page = Zenweb::Page.new site, "img/bg.png"
+    assert_equal File.binread("img/bg.png"), page.render
+  end
+
+  def test_run_js_script
+    exp = <<-EOM.gsub(/^ {6}/, '')
+      <script type=\"text/javascript\">
+        (function() {
+          var s   = document.createElement('script');
+          s.type  = 'text/javascript';
+          s.async = true;
+          s.src   = 'my_url';
+          (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);
+        })();
+      </script>
+    EOM
+
+    assert_equal exp, page.run_js_script("my_url")
+  end
+
+  def test_site
+    assert_equal site, page.site
+  end
+
+  def test_subpages
+    site.scan
+
+    page = site.pages["blog/index.html.erb"]
+    act = page.subpages
+    exp = [site.pages["blog/2012-01-04-page3.html.md"],
+           site.pages["blog/2012-01-03-page2.html.md"],
+           site.pages["blog/2012-01-02-page1.html.md"]]
+
+    assert_equal exp, act
+  end
+
+  def test_subpages_subdirs
+    build_fake_site %w[index.html
+                       a/index.html
+                       a/a.html
+                       a/b.html
+                       a/c.html
+                       b/index.html
+                       b/2012-01-02-p1.html
+                       b/2012-01-03-p2.html
+                       b/2012-01-04-p3.html
+                       c/index.html
+                       c/a.html
+                       c/b.html
+                       c/c.html
+                       c/d/e.html
+                       c/d/f.html
+                       c/d/g.html
+                       d/index.html
+                       d/2012-01-02-p1.html
+                       d/2012-01-03-p2.html
+                       d/2012-01-04-p3.html
+                       some_random_page.html
+                      ]
+
+    urls = %w[a/index.html
+              b/index.html
+              c/index.html
+              d/index.html
+              some_random_page.html]
+
+    exp = urls.map { |url| site.pages[url] }
+
+    page = site.pages["index.html"]
+    assert_equal exp, page.subpages
+  end
+
+  def test_subrender
+    assert_equal "<p>Not really much here to see.</p>\n", page.subrender
+  end
+
+  def test_to_s
+    assert_equal 'Page["blog/2012-01-02-page1.html.md"]', page.to_s
+  end
+
+  def test_url
+    assert_equal "/blog/2012/01/02/page1.html", page.url
+  end
+
+  def test_url_date_fmt
+    page.config.h["date_fmt"] = "%Y/%m"
+    assert_equal "/blog/2012/01/page1.html", page.url
+  end
+
+  def test_url_regular_page
+    page = Zenweb::Page.new site, "pages/blah.html"
+    assert_equal "/pages/blah.html", page.url
+  end
+
+  def test_url_dir
+    assert_equal ".site/blog/2012/01/02", page.url_dir
+  end
+
+  def test_url_path
+    assert_equal ".site/blog/2012/01/02/page1.html", page.url_path
+  end
+
+  def test_wire
+    Rake.application = Rake::Application.new
+    site.scan
+    self.page = site.pages["blog/2012-01-02-page1.html.md"]
+
+    page.wire
+
+    assert_tasks do
+      # dirs
+      assert_task ".site"
+      assert_task ".site/blog"
+      assert_task ".site/blog/2012"
+      assert_task ".site/blog/2012/01"
+      assert_task ".site/blog/2012/01/02"
+
+      # aux
+      assert_task "_layouts/post.erb", %w[_config.yml _layouts/site.erb]
+      assert_task "_layouts/site.erb", %w[_config.yml]
+      assert_task "blog/_config.yml", %w[_config.yml]
+      assert_task "_config.yml"
+
+      # page down to site
+      assert_task page.path, %w[_layouts/post.erb blog/_config.yml]
+      assert_task page.url_path, [page.url_dir, page.path]
+      assert_task "site", [page.url_path], Rake::Task
+    end
+  end
+end