RubyGems - prezjordan-toto - Versions diffs - 0.4.9 - Mend

prezjordan-toto 0.4.9

Files changed (27) hide show

data/.document +5 -0
data/.gitignore +5 -0
data/LICENSE +20 -0
data/README.md +162 -0
data/Rakefile +35 -0
data/TODO +2 -0
data/VERSION +1 -0
data/lib/ext/ext.rb +52 -0
data/lib/toto.rb +359 -0
data/test/articles/1900-05-17-the-wonderful-wizard-of-oz.txt +5 -0
data/test/articles/2001-01-01-two-thousand-and-one.txt +5 -0
data/test/articles/2009-04-01-tilt-factor.txt +5 -0
data/test/articles/2009-12-04-some-random-article.txt +5 -0
data/test/articles/2009-12-11-the-dichotomy-of-design.txt +5 -0
data/test/autotest.rb +34 -0
data/test/templates/about.rhtml +1 -0
data/test/templates/archives.rhtml +5 -0
data/test/templates/article.rhtml +4 -0
data/test/templates/feed.builder +21 -0
data/test/templates/index.builder +21 -0
data/test/templates/index.rhtml +13 -0
data/test/templates/layout.rhtml +4 -0
data/test/templates/repo.rhtml +1 -0
data/test/test_helper.rb +44 -0
data/test/toto_test.rb +285 -0
data/toto.gemspec +80 -0
metadata +120 -0

data/test/articles/1900-05-17-the-wonderful-wizard-of-oz.txt ADDED Viewed

@@ -0,0 +1,5 @@
+title: The Wonderful Wizard of Oz
+date: 17/05/1900
+_Once upon a time_...

data/test/articles/2001-01-01-two-thousand-and-one.txt ADDED Viewed

@@ -0,0 +1,5 @@
+title: the wizard of oz
+date: 12/10/1932
+Once upon a time...

data/test/articles/2009-04-01-tilt-factor.txt ADDED Viewed

@@ -0,0 +1,5 @@
+title: the wizard of oz
+date: 12/10/1932
+Once upon a time...

data/test/articles/2009-12-04-some-random-article.txt ADDED Viewed

@@ -0,0 +1,5 @@
+title: the wizard of oz
+date: 12/10/1932
+Once upon a time...

data/test/articles/2009-12-11-the-dichotomy-of-design.txt ADDED Viewed

@@ -0,0 +1,5 @@
+title: the wizard of oz
+date: 12/10/1932
+Once upon a time...

data/test/autotest.rb ADDED Viewed

@@ -0,0 +1,34 @@
+#
+# Convenience Methods
+#
+def run(cmd)
+  print "\n\n"
+  puts(cmd)
+  system(cmd)
+  print "\n\n"
+end
+def run_all_tests
+  # see Rakefile for the definition of the test:all task
+  system("rake -s test:all VERBOSE=true")
+end
+#
+# Watchr Rules
+#
+watch('^test/.*?_test\.rb'   ) {|m| run("ruby -rubygems %s"              % m[0]) }
+watch('^lib/(.*)\.rb'        ) {|m| run("ruby -rubygems test/%s_test.rb" % m[1]) }
+watch('^lib/toto/(.*)\.rb'   ) {|m| run("ruby -rubygems test/%s_test.rb" % m[1]) }
+watch('^test/test_helper\.rb') { run_all_tests }
+#
+# Signal Handling
+#
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }

data/test/templates/about.rhtml ADDED Viewed

	@@ -0,0 +1 @@
1	+ <span id="count"><%= @articles.length %></span>

data/test/templates/archives.rhtml ADDED Viewed

@@ -0,0 +1,5 @@
+<h1><%= @path %></h1>
+<% for entry in archives %>
+  <li class="entry"><%= entry.title %></li>
+<% end %>

data/test/templates/article.rhtml ADDED Viewed

@@ -0,0 +1,4 @@
+<h2><%= title %></h2>
+<span><%= date %></h2>
+<p><%= body %></p>

data/test/templates/feed.builder ADDED Viewed

@@ -0,0 +1,21 @@
+xml.instruct!
+xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
+  xml.title @config[:title]
+  xml.id @config[:url]
+  xml.updated articles.first[:date].iso8601 unless articles.empty?
+  xml.author { xml.name @config[:author] }
+  articles.each do |article|
+    xml.entry do
+      xml.title article.title
+      xml.link "rel" => "alternate", "href" => article.url
+      xml.id article.url
+      xml.published article[:date].iso8601
+      xml.updated article[:date].iso8601
+      xml.author { xml.name @config[:author] }
+      xml.summary article.summary, "type" => "html"
+      xml.content article.body, "type" => "html"
+    end
+  end
+end

data/test/templates/index.builder ADDED Viewed

@@ -0,0 +1,21 @@
+xml.instruct!
+xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
+  xml.title @config[:title]
+  xml.id @config[:url]
+  xml.updated articles.first[:date].iso8601 unless articles.empty?
+  xml.author { xml.name @config[:author] }
+  articles.each do |article|
+    xml.entry do
+      xml.title article.title
+      xml.link "rel" => "alternate", "href" => article.url
+      xml.id article.url
+      xml.published article[:date].iso8601
+      xml.updated article[:date].iso8601
+      xml.author { xml.name @config[:author] }
+      xml.summary article.summary, "type" => "html"
+      xml.content article.body, "type" => "html"
+    end
+  end
+end

data/test/templates/index.rhtml ADDED Viewed

@@ -0,0 +1,13 @@
+<ul id="articles">
+  <% for article in articles[0...3] %>
+    <li><%= article %></li>
+  <% end %>
+</ul>
+<div id="archives">
+  <%= archives[3...5] %>
+</div>
+<!-- testing env variable passing -->
+<p>env passed: <%= env != nil %><br/></p>
+<!-- testing get/post parameter passing -->
+<p>request method type: <%= env['REQUEST_METHOD'] %><br/></p>
+<p>request name value pair: <%= env['QUERY_STRING'] %><br/></p>

data/test/templates/layout.rhtml ADDED Viewed

@@ -0,0 +1,4 @@
+<html>
+  <%= yield %>
+</html>

data/test/templates/repo.rhtml ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= readme %>

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'hpricot'
+require 'riot'
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'toto'
+module Toto
+  class IncludesHTMLMacro < Riot::AssertionMacro
+    register :includes_html
+    def evaluate(actual, expected)
+      doc = Hpricot.parse(actual)
+      expected = expected.to_a.flatten
+      if (doc/expected.first).empty?
+        fail("expected #{actual} to contain a <#{expected.first}>")
+      elsif !(doc/expected.first).inner_html.match(expected.last)
+        fail("expected <#{expected.first}> to contain #{expected.last}")
+      else
+        pass
+      end
+    end
+  end
+  class IncludesElementsMacro < Riot::AssertionMacro
+    register :includes_elements
+    def evaluate(actual, selector, count)
+      doc = Hpricot.parse(actual)
+      (doc/selector).size == count ? pass : fail("expected #{actual} to contain #{count} #{selector}(s)")
+    end
+  end
+  class WithinMacro < Riot::AssertionMacro
+    register :within
+    def evaluate(actual, expected)
+      expected.include?(actual) ? pass : fail("expected #{actual} to be within #{expected}")
+    end
+  end
+end

data/test/toto_test.rb ADDED Viewed

@@ -0,0 +1,285 @@
+require 'test/test_helper'
+require 'date'
+URL = "http://toto.oz"
+AUTHOR = "toto"
+context Toto do
+  setup do
+    @config = Toto::Config.new(:markdown => true, :author => AUTHOR, :url => URL)
+    @toto = Rack::MockRequest.new(Toto::Server.new(@config))
+    Toto::Paths[:articles] = "test/articles"
+    Toto::Paths[:pages] = "test/templates"
+    Toto::Paths[:templates] = "test/templates"
+  end
+  context "GET /" do
+    setup { @toto.get('/') }
+    asserts("returns a 200")                { topic.status }.equals 200
+    asserts("body is not empty")            { not topic.body.empty? }
+    asserts("content type is set properly") { topic.content_type }.equals "text/html"
+    should("include a couple of article")   { topic.body }.includes_elements("#articles li", 3)
+    should("include an archive")            { topic.body }.includes_elements("#archives li", 2)
+    context "with no articles" do
+      setup { Rack::MockRequest.new(Toto::Server.new(@config.merge(:ext => 'oxo'))).get('/') }
+      asserts("body is not empty")          { not topic.body.empty? }
+      asserts("returns a 200")              { topic.status }.equals 200
+    end
+    context "with a user-defined to_html" do
+      setup do
+        @config[:to_html] = lambda do |path, page, binding|
+          ERB.new(File.read("#{path}/#{page}.rhtml")).result(binding)
+        end
+        @toto.get('/')
+      end
+      asserts("returns a 200")                { topic.status }.equals 200
+      asserts("body is not empty")            { not topic.body.empty? }
+      asserts("content type is set properly") { topic.content_type }.equals "text/html"
+      should("include a couple of article")   { topic.body }.includes_elements("#articles li", 3)
+      should("include an archive")            { topic.body }.includes_elements("#archives li", 2)
+      asserts("Etag header present")          { topic.headers.include? "ETag" }
+      asserts("Etag header has a value")      { not topic.headers["ETag"].empty? }
+    end
+  end
+  context "GET /about" do
+    setup { @toto.get('/about') }
+    asserts("returns a 200")                { topic.status }.equals 200
+    asserts("body is not empty")            { not topic.body.empty? }
+    should("have access to @articles")      { topic.body }.includes_html("#count" => /5/)
+  end
+  context "GET a single article" do
+    setup { @toto.get("/1900/05/17/the-wonderful-wizard-of-oz") }
+    asserts("returns a 200")                { topic.status }.equals 200
+    asserts("content type is set properly") { topic.content_type }.equals "text/html"
+    should("contain the article")           { topic.body }.includes_html("p" => /<em>Once upon a time<\/em>/)
+  end
+  context "GET to the archive" do
+    context "through a year" do
+      setup { @toto.get('/2009') }
+      asserts("returns a 200")                     { topic.status }.equals 200
+      should("includes the entries for that year") { topic.body }.includes_elements("li.entry", 3)
+    end
+    context "through a year & month" do
+      setup { @toto.get('/2009/12') }
+      asserts("returns a 200")                      { topic.status }.equals 200
+      should("includes the entries for that month") { topic.body }.includes_elements("li.entry", 2)
+      should("includes the year & month")           { topic.body }.includes_html("h1" => /2009\/12/)
+    end
+    context "through /archive" do
+      setup { @toto.get('/archive') }
+    end
+  end
+  context "GET to an unknown route with a custom error" do
+    setup do
+      @config[:error] = lambda {|code| "error: #{code}" }
+      @toto.get('/unknown')
+    end
+    should("returns a 404") { topic.status }.equals 404
+    should("return the custom error") { topic.body }.equals "error: 404"
+  end
+  context "Request is invalid" do
+    setup { @toto.delete('/invalid') }
+    should("returns a 400") { topic.status }.equals 400
+  end
+  context "GET /index.xml (atom feed)" do
+    setup { @toto.get('/index.xml') }
+    asserts("content type is set properly") { topic.content_type }.equals "application/xml"
+    asserts("body should be valid xml")     { topic.body }.includes_html("feed > entry" => /.+/)
+    asserts("summary shouldn't be empty")   { topic.body }.includes_html("summary" => /.{10,}/)
+  end
+  context "GET /index?param=testparam (get parameter)" do
+    setup { @toto.get('/index?param=testparam')   }
+    asserts("returns a 200")                { topic.status }.equals 200
+    asserts("content type is set properly") { topic.content_type }.equals "text/html"
+    asserts("contain the env variable")           { topic.body }.includes_html("p" => /env passed: true/)
+    asserts("access the http get parameter")           { topic.body }.includes_html("p" => /request method type: GET/)
+    asserts("access the http parameter name value pair")           { topic.body }.includes_html("p" => /request name value pair: param=testparam/)
+  end
+  context "GET to a repo name" do
+    setup do
+      class Toto::Repo
+        def readme() "#{self[:name]}'s README" end
+      end
+    end
+    context "when the repo is in the :repos array" do
+      setup do
+        @config[:github] = {:user => "cloudhead", :repos => ['the-repo']}
+        @toto.get('/the-repo')
+      end
+      should("return the-repo's README") { topic.body }.includes("the-repo's README")
+    end
+    context "when the repo is not in the :repos array" do
+      setup do
+        @config[:github] = {:user => "cloudhead", :repos => []}
+        @toto.get('/the-repo')
+      end
+      should("return a 404") { topic.status }.equals 404
+    end
+  end
+  context "creating an article" do
+    setup do
+      @config[:markdown] = true
+      @config[:date] = lambda {|t| "the time is #{t.strftime("%Y/%m/%d %H:%M")}" }
+      @config[:summary] = {:length => 50}
+    end
+    context "with the bare essentials" do
+      setup do
+        Toto::Article.new({
+          :title => "Toto & The Wizard of Oz.",
+          :body => "#Chapter I\nhello, *stranger*."
+        }, @config)
+      end
+      should("have a title")               { topic.title }.equals "Toto & The Wizard of Oz."
+      should("parse the body as markdown") { topic.body }.equals "<h1>Chapter I</h1>\n\n<p>hello, <em>stranger</em>.</p>\n"
+      should("create an appropriate slug") { topic.slug }.equals "toto-and-the-wizard-of-oz"
+      should("set the date")               { topic.date }.equals "the time is #{Date.today.strftime("%Y/%m/%d %H:%M")}"
+      should("create a summary")           { topic.summary == topic.body }
+      should("have an author")             { topic.author }.equals AUTHOR
+      should("have a path")                { topic.path }.equals Date.today.strftime("/%Y/%m/%d/toto-and-the-wizard-of-oz/")
+      should("have a url")                 { topic.url }.equals Date.today.strftime("#{URL}/%Y/%m/%d/toto-and-the-wizard-of-oz/")
+    end
+    context "with a user-defined summary" do
+      setup do
+        Toto::Article.new({
+          :title => "Toto & The Wizard of Oz.",
+          :body => "Well,\nhello ~\n, *stranger*."
+        }, @config.merge(:markdown => false, :summary => {:max => 150, :delim => /~\n/}))
+      end
+      should("split the article at the delimiter") { topic.summary }.equals "Well,\nhello"
+      should("not have the delimiter in the body") { topic.body !~ /~/ }
+    end
+    context "with everything specified" do
+      setup do
+        Toto::Article.new({
+          :title  => "The Wizard of Oz",
+          :body   => ("a little bit of text." * 5) + "\n" + "filler" * 10,
+          :date   => "19/10/1976",
+          :slug   => "wizard-of-oz",
+          :author => "toetoe"
+        }, @config)
+      end
+      should("parse the date") { [topic[:date].month, topic[:date].year] }.equals [10, 1976]
+      should("use the slug")   { topic.slug }.equals "wizard-of-oz"
+      should("use the author") { topic.author }.equals "toetoe"
+      context "and long first paragraph" do
+        should("create a valid summary") { topic.summary }.equals "<p>" + ("a little bit of text." * 5).chop + "&hellip;</p>\n"
+      end
+      context "and a short first paragraph" do
+        setup do
+          @config[:markdown] = false
+          Toto::Article.new({:body => "there ain't such thing as a free lunch\n" * 10}, @config)
+        end
+        should("create a valid summary") { topic.summary.size }.within 75..80
+      end
+    end
+    context "in a subdirectory" do
+      context "with implicit leading forward slash" do
+        setup do
+          conf = Toto::Config.new({})
+          conf.set(:prefix, "blog")
+          Toto::Article.new({
+            :title => "Toto & The Wizard of Oz.",
+            :body => "#Chapter I\nhello, *stranger*."
+          }, conf)
+        end
+        should("be in the directory") { topic.path }.equals Date.today.strftime("/blog/%Y/%m/%d/toto-and-the-wizard-of-oz/")
+      end
+      context "with explicit leading forward slash" do
+        setup do
+          conf = Toto::Config.new({})
+          conf.set(:prefix, "/blog")
+          Toto::Article.new({
+            :title => "Toto & The Wizard of Oz.",
+            :body => "#Chapter I\nhello, *stranger*."
+          }, conf)
+        end
+        should("be in the directory") { topic.path }.equals Date.today.strftime("/blog/%Y/%m/%d/toto-and-the-wizard-of-oz/")
+      end
+      context "with explicit trailing forward slash" do
+        setup do
+          conf = Toto::Config.new({})
+          conf.set(:prefix, "blog/")
+          Toto::Article.new({
+            :title => "Toto & The Wizard of Oz.",
+            :body => "#Chapter I\nhello, *stranger*."
+          }, conf)
+        end
+        should("be in the directory") { topic.path }.equals Date.today.strftime("/blog/%Y/%m/%d/toto-and-the-wizard-of-oz/")
+      end
+    end
+  end
+  context "using Config#set with a hash" do
+    setup do
+      conf = Toto::Config.new({})
+      conf.set(:summary, {:delim => /%/})
+      conf
+    end
+    should("set summary[:delim] to /%/") { topic[:summary][:delim].source }.equals "%"
+    should("leave the :max intact") { topic[:summary][:max] }.equals 150
+  end
+  context "using Config#set with a block" do
+    setup do
+      conf = Toto::Config.new({})
+      conf.set(:to_html) {|path, p, _| path + p }
+      conf
+    end
+    should("set the value to a proc") { topic[:to_html] }.respond_to :call
+  end
+  context "testing individual configuration parameters" do
+    context "generate error pages" do
+      setup do
+        conf = Toto::Config.new({})
+        conf.set(:error) {|code| "error code #{code}" }
+        conf
+      end
+      should("create an error page") { topic[:error].call(400) }.equals "error code 400"
+    end
+  end
+  context "extensions to the core Ruby library" do
+    should("respond to iso8601") { Date.today }.respond_to?(:iso8601)
+  end
+end