webby 0.7.4 → 0.8.0

data/History.txt

@@ -1,3 +1,22 @@
+== 0.8.0 / 2008-02-28
+
+* 3 major enhancements
+  - Added support for partials
+  - Refactored the coderay and graphviz filters into helper methods
+    accessible from ERB
+  - Added support for embedding LaTeX mathematical equations
+* 3 minor enhancements
+  - Added a template file for creating Atom feeds
+  - The SITE configuration is available in pages and layouts as
+    the @config variable
+  - Can specify the port the Heel webserver starts on using the
+    SITE.heel_port option in the Rakefile
+* 2 bug fixes
+  - When creating pages in directory mode the full page path was
+    not being created
+  - Read only files were being created in the output folder
+    preventing them from being overwritten if changed
+
 == 0.7.4 / 2008-02-15
 
 * 3 minor enhancements

data/Manifest.txt

@@ -30,11 +30,14 @@ data/content/css/coderay.css
 data/content/css/site.css
 data/content/index.txt
 data/layouts/default.rhtml
+data/lib/breadcrumbs.rb
 data/tasks/create.rake
 data/tasks/deploy.rake
 data/tasks/growl.rake
 data/tasks/heel.rake
 data/tasks/setup.rb
+data/templates/_partial.erb
+data/templates/atom_feed.erb
 data/templates/page.erb
 examples/webby/Rakefile
 examples/webby/content/css/blueprint/print.css
@@ -59,32 +62,42 @@ examples/webby/templates/page.erb
 lib/webby.rb
 lib/webby/auto_builder.rb
 lib/webby/builder.rb
-lib/webby/file.rb
 lib/webby/filters.rb
 lib/webby/filters/basepath.rb
-lib/webby/filters/coderay.rb
 lib/webby/filters/erb.rb
-lib/webby/filters/graphviz.rb
 lib/webby/filters/haml.rb
 lib/webby/filters/markdown.rb
 lib/webby/filters/outline.rb
 lib/webby/filters/sass.rb
 lib/webby/filters/textile.rb
 lib/webby/filters/tidy.rb
+lib/webby/helpers.rb
+lib/webby/helpers/coderay_helper.rb
+lib/webby/helpers/graphviz_helper.rb
 lib/webby/helpers/tag_helper.rb
+lib/webby/helpers/tex_img_helper.rb
 lib/webby/helpers/url_helper.rb
 lib/webby/main.rb
-lib/webby/pages_db.rb
 lib/webby/renderer.rb
-lib/webby/resource.rb
+lib/webby/resources.rb
+lib/webby/resources/db.rb
+lib/webby/resources/file.rb
+lib/webby/resources/layout.rb
+lib/webby/resources/page.rb
+lib/webby/resources/partial.rb
+lib/webby/resources/resource.rb
+lib/webby/resources/static.rb
+lib/webby/stelan/mktemp.rb
 lib/webby/stelan/paginator.rb
 lib/webby/stelan/spawner.rb
 lib/webby/utils.rb
 lib/webby/webby_task.rb
 spec/spec.opts
 spec/spec_helper.rb
-spec/webby/file_spec.rb
+spec/webby/resources/file_spec.rb
+tasks/ann.rake
 tasks/annotations.rake
+tasks/bones.rake
 tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake

data/README.txt

@@ -6,9 +6,17 @@ Webby
 
 == DESCRIPTION:
 
-Webby is a super fantastic little website management system. It would be called a _content management system_ if it were a bigger kid. But, it's just a runt with a special knack for transforming text. And that's really all it does - manages the legwork of turning text into something else, an *ASCII Alchemist* if you will.
-
-Webby works by combining the contents of a *page* with a *layout* to produce HTML. The layout contains everything common to all the pages - HTML headers, navigation menu, footer, etc. - and the page contains just the information for that page. You can use your favorite markup language to write your pages; Webby supports quite a few.
+Webby is a super fantastic little website management system. It would be
+called a _content management system_ if it were a bigger kid. But, it's
+just a runt with a special knack for transforming text. And that's really
+all it does - manages the legwork of turning text into something else, an
+*ASCII Alchemist* if you will.
+
+Webby works by combining the contents of a *page* with a *layout* to
+produce HTML. The layout contains everything common to all the pages -
+HTML headers, navigation menu, footer, etc. - and the page contains just
+the information for that page. You can use your favorite markup language
+to write your pages; Webby supports quite a few.
 
 Install Webby and try it out!
 
@@ -23,7 +31,11 @@ Install Webby and try it out!
 
 But Wait! There's More!
 
-Webby has a great _autobuild_ feature that continuously generates HTML whenever the *pages* or *layouts* change. The HTML is served up via {heel}[http://copiousfreetime.rubyforge.org/heel/], a static file webserver based on mongrel. Whenever you change a page, you can immediately see those changes without having to run any commands.
+Webby has a great _autobuild_ feature that continuously generates HTML whenever
+the *pages* or *layouts* change. The HTML is served up via
+{heel}[http://copiousfreetime.rubyforge.org/heel/], a static file webserver
+based on mongrel. Whenever you change a page, you can immediately see those
+changes without having to run any commands.
 
    $ rake autobuild
    heel --root output --daemonize
@@ -33,7 +45,11 @@ Webby has a great _autobuild_ feature that continuously generates HTML whenever
    - started at 10:22:57
    creating output/index.html
 
-Webby is not limited to producing HTML. By no means! Do you ever get tired of repeating the same color code <b>#D3C4A2</b> in your CSS files? Webby can help. Need some customized JavaScript for your website. Webby can help. Anytime you find yourself repeating the same bit of text over and over, then you should be using Webby.
+Webby is not limited to producing HTML. By no means! Do you ever get tired of
+repeating the same color code <b>#D3C4A2</b> in your CSS files? Webby can help.
+Need some customized JavaScript for your website. Webby can help. Anytime you
+find yourself repeating the same bit of text over and over, then you should be
+using Webby.
 
 == INSTALL:
 

data/Rakefile

@@ -1,4 +1,4 @@
-# $Id: Rakefile 148 2008-02-15 05:26:56Z tim_pease $
+# $Id: Rakefile 155 2008-02-17 00:48:30Z tim_pease $
 
 load 'tasks/setup.rb'
 
@@ -18,7 +18,6 @@ PROJ.rdoc_dir = 'doc/rdoc'
 PROJ.rdoc_remote_dir = 'rdoc'
 PROJ.version = Webby::VERSION
 
-
 PROJ.exclude << '^examples/[^/]+/output'
 PROJ.exclude << '^tasks/archive'
 PROJ.exclude << '^tags$'
@@ -32,7 +31,7 @@ PROJ.spec_opts << '--color'
 depend_on 'directory_watcher'
 depend_on 'heel'
 depend_on 'hpricot'
-depend_on 'logging', '0.7.0'
+depend_on 'logging'
 depend_on 'rake'
 depend_on 'rspec'
 

data/data/Rakefile

@@ -4,7 +4,7 @@ load 'tasks/setup.rb'
 
 task :default => :build
 
-desc 'depoloy the site to the webserver'
+desc 'deploy the site to the webserver'
 task :deploy => [:build, 'deploy:rsync']
 
 # EOF

data/data/lib/breadcrumbs.rb

@@ -0,0 +1,28 @@
+# breadcrumbs.rb
+
+module BreadcrumbsHelper
+  # call-seq:
+  #    breadcrumbs( page )    => html
+  #
+  # Create breadcrumb links for the current page. This will return an HTML
+  # <ul></ul> object.
+  #
+  def breadcrumbs( page )
+    list = ["<li>#{h(page.title)}</li>"]
+    loop do
+      page = @pages.parent_of(page)
+      break if page.nil?
+      list << "<li>#{link_to_page(page)}</li>"
+    end
+    list.reverse!
+
+    html = "<ul class=\"breadcrumbs\">\n"
+    html << list.join("\n")
+    html << "\n</ul>\n"
+    html
+  end
+end  # module Breadcrumbs
+
+Webby::Helpers.register(BreadcrumbsHelper)
+
+# EOF

data/data/tasks/create.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 Rake::WebbyTask.new
 

data/data/tasks/deploy.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'rake/contrib/sshpublisher'
 

data/data/tasks/growl.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 desc 'send log events to Growl (Mac OS X only)'
 task :growl do

data/data/tasks/heel.rake

@@ -1,10 +1,9 @@
-# $Id$
 
 namespace :heel do
 
   desc 'start the heel server to view website (not for Windows)'
   task :start do
-    sh "heel --root #{SITE.output_dir} --daemonize"
+    sh "heel --root #{SITE.output_dir} --port #{SITE.heel_port} --daemonize"
   end
   
   desc 'stop the heel server'
@@ -14,7 +13,7 @@ namespace :heel do
 
   task :autorun do
     heel_exe = File.join(Gem.bindir, 'heel')
-    @heel_spawner = Spawner.new(Spawner.ruby, heel_exe, '--root', SITE.output_dir, :pause => 86_400)
+    @heel_spawner = Spawner.new(Spawner.ruby, heel_exe, '--root', SITE.output_dir, '--port', SITE.heel_port.to_s, :pause => 86_400)
     @heel_spawner.start
   end
 

data/data/tasks/setup.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 begin
   require 'webby'

data/data/templates/_partial.erb

@@ -0,0 +1,10 @@
+---
+filter: erb
+---
+A partial has access to the page from which it was called. The title below will be the title of the page in which this partial is rendered.
+
+<%%= h(@page.title) %>
+
+A partial does not have access to it's own meta-data. The partial meta-data is used primarily for finding partials or for use in other pages. The filter(s) specified in the meta-data will be applied to the partial text when it is rendered.
+
+A partial does not require meta-data at all. They can contain just text.

data/data/templates/atom_feed.erb

@@ -0,0 +1,34 @@
+---
+extension: xml
+layout: false
+dirty: true
+filter:
+- erb
+---
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+ 
+  <title>A New Atom Feed</title>
+  <subtitle>a really swell blog</subtitle>
+  <link href="http://fakesite.nil/feed/" rel="self"/>
+  <link href="http://fakesite.nil/"/>
+  <updated><%%= Time.now.xmlschema %></updated>
+  <author>
+    <name>Author's Name</name>
+    <email>author@fakesite.nil</email>
+  </author>
+  <id>http://fakesite.nil/</id>
+  <%% @pages.find(:limit => 10,
+                 :in_directory => 'articles',
+                 :recursive => true,
+                 :sort_by => 'created_at',
+                 :reverse => true).each do |article| %>
+  <entry>
+    <title><%%= h(article.title) %></title>
+    <link href="<%%= article.url %>"/>
+    <id>tag:fakesite.nil,<%%= article.created_at.strftime('%Y-%m-%d') %>:<%%= article.created_at.to_i %></id>
+    <updated><%%= article.created_at.xmlschema %></updated>
+    <content type="html"><%%= h(article.render) %></content>
+  </entry>
+  <%% end %>
+</feed>

data/examples/webby/content/manual/index.txt

@@ -3,8 +3,6 @@ title:      Manual
 created_at: Wed Aug 29 08:57:00 -0600 2007
 filter:
   - erb
-  - graphviz
-  - coderay
   - textile
   - outline
 --- 
@@ -19,7 +17,7 @@ h2{clear:none}. Introduction
 
 Webby was created out of the need for a simple way to build and manage small websites. The desire was for a system that could take files written in plain text, combine them with a layout file and produce web pages. In this system, a single page can be written quickly without the need for HTML markup; the look and feel of the entire site can be changed by modifying the site layout file.
 
-<graphviz path="images" alt="Webby Overview">
+<% graphviz :path => "images", :alt => "Webby Overview" do %>
 digraph overview {
   rankdir = LR;
   edge [fontname="Verdana", fontsize=8];
@@ -37,7 +35,7 @@ digraph overview {
   p2 -> layout -> h2 [color=green];
   p3 -> layout -> h3 [color=blue];
 }
-</graphviz>
+<% end %>
 
 The diagram above shows the basic concept of how Webby works. Changing the layout file will result in changes to every generated HTML file. Changes to a single page will result in changes only to the HTML file corresponding to that particular page.
 
@@ -74,7 +72,7 @@ Webby can also use a few other programs to clean up generated HTML and to create
 
 h3. Running Webby
 
-When the Webby gem is installed it also installs a @webby@ executable program. This program is used to create a new website and to udpate the associated rake tasks when a new version of Webby is released. Typing in @webby --help@ will show you the options this program supports. After you create a webiste, though, the webby command will not be needed. 
+When the Webby gem is installed it also installs a @webby@ executable program. This program is used to create a new website and to update the associated rake tasks when a new version of Webby is released. Typing in @webby --help@ will show you the options this program supports. After you create a webiste, though, the webby command will not be needed. 
 
 <pre>
 $ webby --help
@@ -88,7 +86,7 @@ common options:
         --version                    show version
 </pre>
 
-The tasks of building the webiste and deploying it to the destnation server are handled by "Rake":http://docs.rubyrake.org/, a Ruby version of the more famous *make* program. Several rake tasks are provided by default. You are free to create others to make developing and deploying your webiste easier. To see the current list of rake tasks type in @rake -T@.
+The tasks of building the webiste and deploying it to the destination server are handled by "Rake":http://docs.rubyrake.org/, a Ruby version of the more famous *make* program. Several rake tasks are provided by default. You are free to create others to make developing and deploying your webiste easier. To see the current list of rake tasks type in @rake -T@.
 
 <pre>
 $ rake -T
@@ -97,7 +95,7 @@ rake autobuild     # continuously build the website
 rake build         # build the website
 rake clobber       # delete the website
 rake create:page   # create a new page
-rake deploy        # depoloy the site to the webserver
+rake deploy        # deploy the site to the webserver
 rake deploy:rsync  # deploy to the server using rsync
 rake deploy:ssh    # deploy to the server using ssh
 rake heel:start    # start the heel server to view website (not for Windows)
@@ -188,7 +186,7 @@ h3. Layouts
 
 Layouts provide the basic framework for a page  --  the header, the footer, the navigation. They provide a consistent look and feel across all pages in the website. Individual pages contain just the content for that particular page.
 
-<graphviz path="images" class="push-0" alt="layout diagram">
+<% graphviz :path => "images", :class => "push-0", :alt => "layout diagram" do %>
 digraph layout_graph {
   rankdir = LR;
   edge [fontname="Verdana", fontsize=8];
@@ -197,7 +195,7 @@ digraph layout_graph {
   page -> layout [label="rendered\ninto"];
   layout -> HTML [label="results\nin"];
 }
-</graphviz>
+<% end %>
 
 The diagram to the right shows a typical page rendering process. The content of a page is rendered by the Webby filter engine. The rendered content is inserted into the layout specified by the page; the content insertion occurs as the layout is being rendered. The result is the HTML that is stored in the _output_ folder.
 
@@ -337,14 +335,14 @@ end
 &lt;/coderay&gt;</notextile>
 </pre>
 
-<coderay lang="ruby" line_numbers="inline">
+<% coderay :lang => "ruby", :line_numbers => "inline" do %>
 class Object
   def returning( r )
     yield r if block_given?
     r
   end
 end
-</coderay>
+<% end %>
 
 p(column span-2). *Usage*:
 
@@ -375,12 +373,12 @@ digraph hello_world {
 &lt;/graphviz&gt;</notextile>
 </pre>
 
-<graphviz path="images" alt="hello world graph">
+<% graphviz :path => "images", :alt => "hello world graph" do %>
 digraph hello_world {
   rankdir = LR;
   Hello -> World;
 }
-</graphviz>
+<% end %>
 
 p(column span-2). *Usage*:
 

data/examples/webby/content/tutorial/index.txt

@@ -127,4 +127,4 @@ h2. What Now?
 
 Let your creativity run wild!
 
-You can read more about the features of Webby in the "manual":manual.html. There you'll discover how to reference layouts other than the default, how to create page templates for simplifying blog posts. Take a look at the "tips & tricks":tips_and_tricks.html for more ideas on simplifying your web development work cycle.
+You can read more about the features of Webby in the "manual":manual/index.html. There you'll discover how to reference layouts other than the default, how to create page templates for simplifying blog posts. Take a look at the "tips & tricks":tips_and_tricks.html for more ideas on simplifying your web development work cycle.

data/examples/webby/tasks/heel.rake

@@ -3,7 +3,7 @@ namespace :heel do
 
   desc 'start the heel server to view website (not for Windows)'
   task :start do
-    sh "heel --root #{SITE.output_dir} --daemonize"
+    sh "heel --root #{SITE.output_dir} --port #{SITE.heel_port} --daemonize"
   end
   
   desc 'stop the heel server'
@@ -13,7 +13,7 @@ namespace :heel do
 
   task :autorun do
     heel_exe = File.join(Gem.bindir, 'heel')
-    @heel_spawner = Spawner.new(Spawner.ruby, heel_exe, '--root', SITE.output_dir, :pause => 86_400)
+    @heel_spawner = Spawner.new(Spawner.ruby, heel_exe, '--root', SITE.output_dir, '--port', SITE.heel_port.to_s, :pause => 86_400)
     @heel_spawner.start
   end
 

data/examples/webby/tasks/setup.rb

@@ -1,5 +1,10 @@
 
-require 'webby'
+begin
+  require 'webby'
+rescue LoadError
+  require 'rubygems'
+  require 'webby'
+end
 
 SITE = Webby.site
 

data/lib/webby.rb

@@ -1,5 +1,12 @@
-# $Id: webby.rb 145 2008-02-13 00:39:03Z tim_pease $
+# $Id: webby.rb 180 2008-02-29 05:03:21Z tim_pease $
 
+# TODO: add support for inlining background gradients (in the CSS)
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the spec helper from being loaded more than once
+unless defined? ::Webby
+
+require 'rubygems'
 require 'logging'
 require 'ostruct'
 require 'date'
@@ -15,29 +22,14 @@ Logging::Appender.stdout.layout = Logging::Layouts::Pattern.new(
 
 module Webby
 
-  VERSION = '0.7.4'   # :nodoc:
-
-  # Path to the Webby package
-  PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..'))
+  # :stopdoc:
+  VERSION = '0.8.0'   # :nodoc:
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
 
   class Error < StandardError; end  # :nodoc:
 
-  # call-seq:
-  #    Webby.require_all_libs_relative_to( filename, directory = nil )
-  #
-  # Utility method used to rquire all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= File.basename(fname, '.*')
-    search_me = File.expand_path(
-        File.join(File.dirname(fname), dir, '**', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
-  end
-
   # call-seq:
   #    Webby.site    => struct
   #
@@ -60,6 +52,9 @@ module Webby
       :base          => nil,
       :create_mode   => 'page',
 
+      # Items for running the heel webserver
+      :heel_port => 4331,
+
       # Items used to deploy the webiste
       :host       => 'user@hostname.tld',
       :remote_dir => '/not/a/valid/dir',
@@ -107,9 +102,40 @@ module Webby
   # modification time of the file is important.
   #
   def self.cairn
-    @cairn ||= File.join(site.output_dir, '.cairn')
+    @cairn ||= ::File.join(site.output_dir, '.cairn')
   end
 
+  # Returns the library path for Webby. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+  end
+
+  # Returns the path for Webby. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, *args)
+  end
+
+  # call-seq:
+  #    Webby.require_all_libs_relative_to( filename, directory = nil )
+  #
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
 end  # module Webby
 
 
@@ -127,7 +153,8 @@ rescue LoadError
   false
 end
 
+Webby.require_all_libs_relative_to(__FILE__)
 
-Webby.require_all_libs_relative_to __FILE__
+end  # unless defined?
 
 # EOF