ceilingfish-toto 0.4.0 → 0.4.2

data/README.md

@@ -6,7 +6,7 @@ the tiniest blogging engine in Oz!
 introduction
 ------------
 
-toto is a git-powered, minimalist blog engine for the hackers of Oz. The engine weights around ~300 sloc at its worse.
+toto is a git-powered, minimalist blog engine for the hackers of Oz. The engine weighs around ~300 sloc at its worse.
 There is no toto client, at least for now; everything goes through git.
 
 blog in 10 seconds
@@ -29,6 +29,18 @@ This makes it an ideal candidate for [heroku](http://heroku.com).
 
 Oh, and everything that can be done with git, _is_.
 
+ceilingfish extensions
+----------------------
+
+The ceilingfish fork of toto attempts to add a set of useful helpers to the core toto engine. Specifically it provides the following functions to all pages:
+
+- an `import` function to allow layouts to be pared down into more manageable chunks
+- an `archives` function to allow access to a historical list of articles
+- a `title` function to return the title of the current page
+- a `root` function to get a link to the base url
+
+Most of these were in there in some form or other, they've just been moved around to ensure they're available for every page.
+
 how it works
 ------------
 
@@ -142,6 +154,9 @@ you could add `set :author, 'John Galt'` inside the `Toto::Server.new` block. He
     set :summary,   :max => 150, :delim => /~\n/              # length of article summary and delimiter 
     set :ext,       'txt'                                     # file extension for articles 
     set :cache,     28800                                     # cache site for 8 hours
+    set :to_html do |path, page, ctx|                         # returns an html, from a path & context
+        ERB.new(File.read("#{path}/#{page}.rhtml")).result(ctx)
+    end
 
 thanks
 ------

data/Rakefile

@@ -10,7 +10,6 @@ begin
     gem.email = "ceilingfish@gmail.com"
     gem.homepage = "http://github.com/ceilingfish/toto"
     gem.authors = ["cloudhead", "ceilingfish"]
-    # gem.files = FileList["{bin,lib}/**/*"]
     gem.add_development_dependency "riot"
     gem.add_dependency "builder"
     gem.add_dependency "rack"

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.2

data/lib/toto.rb

@@ -28,9 +28,9 @@ module Toto
   end
 
   module Template
-    def to_html page, &blk
+    def to_html page, config, &blk
       path = ([:layout, :repo].include?(page) ? Paths[:templates] : Paths[:pages])
-      ERB.new(File.read("#{path}/#{page}.rhtml")).result(binding)
+      config[:to_html].call(path, page, binding)
     end
 
     def markdown text
@@ -71,7 +71,7 @@ module Toto
           filter !~ /^\d{4}/ || a.path =~ /^\/#{filter}/
         end : []
 
-      return Archives.new(entries)
+      return Archives.new(entries, @config)
     end
     
     def title
@@ -80,7 +80,7 @@ module Toto
     
     def articles ext = self[:ext]
       Dir["#{Paths[:articles]}/*.#{ext}"].reverse.map do |article|
-          Article.new File.new(article), @config
+          Article.new article, @config
       end
     end
     
@@ -112,7 +112,7 @@ module Toto
     end
     
     def article route
-      Article.new(File.new("#{Paths[:articles]}/#{route}.#{self[:ext]}"), @config).load
+      Article.new("#{Paths[:articles]}/#{route}.#{self[:ext]}", @config).load
     end
 
     def /
@@ -178,7 +178,7 @@ module Toto
       end
 
       def render page, type
-        type == :html ? to_html(:layout, &Proc.new { to_html page }) : send(:"to_#{type}", :feed)
+        type == :html ? to_html(:layout, @config, &Proc.new { to_html page, @config }) : send(:"to_#{type}", :feed)
       end
 
       def to_xml page
@@ -214,12 +214,17 @@ module Toto
   class Archives < Array
     include Template
 
-    def initialize articles
+    def initialize articles, config
       self.replace articles
+      @config = config
+    end
+
+    def [] a
+      a.is_a?(Range) ? self.class.new(self.slice(a) || [], @config) : super
     end
 
     def to_html
-      super(:archives)
+      super(:archives, @config)
     end
     alias :to_s to_html
     alias :archive archives
@@ -234,9 +239,8 @@ module Toto
     end
 
     def load
-      data = if @obj.is_a? File
-        meta, self[:body] = @obj.read.split(/\n\n/, 2)
-        @obj.close
+      data = if @obj.is_a? String
+        meta, self[:body] = File.read(@obj).split(/\n\n/, 2)
         YAML.load(meta)
       elsif @obj.is_a? Hash
         @obj
@@ -277,10 +281,10 @@ module Toto
     end
 
     def title()   self[:title] || "an article"               end
-    def date()    @config[:date, self[:date]]                end
+    def date()    @config[:date].call(self[:date])           end
     def path()    self[:date].strftime("/%Y/%m/%d/#{slug}/") end
     def author()  self[:author] || @config[:author]          end
-    def to_html() self.load; super(:article)                 end
+    def to_html() self.load; super(:article, @config)        end
 
     alias :to_s to_html
 
@@ -288,35 +292,33 @@ module Toto
 
   class Config < Hash
     Defaults = {
-      :author => ENV['USER'],                             # blog author
-      :title => Dir.pwd.split('/').last,                  # site title
-      :root => "index",                                   # site index
+      :author => ENV['USER'],                               # blog author
+      :title => Dir.pwd.split('/').last,                    # site title
+      :root => "index",                                     # site index
       :url => "http://127.0.0.1",
-      :date => lambda {|now| now.strftime("%d/%m/%Y") },  # date function
-      :markdown => :smart,                                # use markdown
-      :disqus => false,                                   # disqus name
-      :summary => {:max => 150, :delim => /~\n/},         # length of summary and delimiter
-      :ext => 'txt',                                      # extension for articles
-      :cache => 28800,                                    # cache duration (seconds)
-      :github => {:user => "", :repos => [], :ext => 'md'}# Github username and list of repos
+      :date => lambda {|now| now.strftime("%d/%m/%Y") },    # date function
+      :markdown => :smart,                                  # use markdown
+      :disqus => false,                                     # disqus name
+      :summary => {:max => 150, :delim => /~\n/},           # length of summary and delimiter
+      :ext => 'txt',                                        # extension for articles
+      :cache => 28800,                                      # cache duration (seconds)
+      :github => {:user => "", :repos => [], :ext => 'md'}, # Github username and list of repos
+      :to_html => lambda {|path, page, ctx|                 # returns an html, from a path & context
+        ERB.new(File.read("#{path}/#{page}.rhtml")).result(ctx)
+      }
     }
     def initialize obj
       self.update Defaults
       self.update obj
     end
 
-    def set key, val
+    def set key, val = nil, &blk
       if val.is_a? Hash
         self[key].update val
       else
-        self[key] = val
+        self[key] = block_given?? blk : val
       end
     end
-
-    def [] key, *args
-      val = super(key)
-      val.respond_to?(:call) ? val.call(*args) : val
-    end
   end
 
   class Server

data/test/toto_test.rb

@@ -12,36 +12,51 @@ context Toto do
     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
-  # 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 /" 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)
+    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
@@ -180,6 +195,16 @@ context Toto do
     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
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ceilingfish-toto
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
 - cloudhead
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 +00:00
+date: 2010-02-23 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,7 +69,6 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- ceilingfish-toto.gemspec
 - lib/ceilingfish-toto.rb
 - lib/ext/ext.rb
 - lib/toto.rb

data/ceilingfish-toto.gemspec

@@ -1,79 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{ceilingfish-toto}
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["cloudhead", "ceilingfish"]
-  s.date = %q{2010-02-22}
-  s.description = %q{the tiniest blog-engine in Oz.}
-  s.email = %q{ceilingfish@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "ceilingfish-toto.gemspec",
-     "lib/ceilingfish-toto.rb",
-     "lib/ext/ext.rb",
-     "lib/toto.rb",
-     "test/articles/some-random-article.txt",
-     "test/articles/the-dichotomy-of-design.txt",
-     "test/articles/the-wonderful-wizard-of-oz.txt",
-     "test/articles/tilt-factor.txt",
-     "test/articles/two-thousand-and-one.txt",
-     "test/autotest.rb",
-     "test/templates/about.rhtml",
-     "test/templates/archives.rhtml",
-     "test/templates/article.rhtml",
-     "test/templates/feed.builder",
-     "test/templates/index.rhtml",
-     "test/templates/layout.rhtml",
-     "test/templates/repo.rhtml",
-     "test/test_helper.rb",
-     "test/toto_test.rb"
-  ]
-  s.homepage = %q{http://github.com/ceilingfish/toto}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{the tiniest blog-engine in Oz}
-  s.test_files = [
-    "test/autotest.rb",
-     "test/test_helper.rb",
-     "test/toto_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<riot>, [">= 0"])
-      s.add_runtime_dependency(%q<builder>, [">= 0"])
-      s.add_runtime_dependency(%q<rack>, [">= 0"])
-      s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
-    else
-      s.add_dependency(%q<riot>, [">= 0"])
-      s.add_dependency(%q<builder>, [">= 0"])
-      s.add_dependency(%q<rack>, [">= 0"])
-      s.add_dependency(%q<rdiscount>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<riot>, [">= 0"])
-    s.add_dependency(%q<builder>, [">= 0"])
-    s.add_dependency(%q<rack>, [">= 0"])
-    s.add_dependency(%q<rdiscount>, [">= 0"])
-  end
-end
-