webby 0.6.0 → 0.7.0

data/History.txt

@@ -1,4 +1,16 @@
-== 0.6.0 / 
+== 0.7.0 / 2008-01-01
+
+* 1 major enhancement
+  - Refactored how the filters are handled (thanks Bruce Williams)
+* 2 minor enhancements
+  - Added helper methods for URL and tag generation
+  - Added rake task to delete the generated website
+* 2 bug fixes
+  - Fixed a bug arising from the order of the logger creation
+  - Removed the file extension form the page defaults
+    (should be set in the layout or the page itself)
+
+== 0.6.0 / 2007-12-04
 
 * Added support for embedded graphviz images and image maps
 * Tidy can be used as a filter to format HTML and check for errors

data/Manifest.txt

@@ -27,13 +27,48 @@ data/tasks/growl.rake
 data/tasks/heel.rake
 data/tasks/setup.rb
 data/templates/page.erb
+examples/webby/Rakefile
+examples/webby/content/css/blueprint/lib/buttons.css
+examples/webby/content/css/blueprint/lib/compressed.css
+examples/webby/content/css/blueprint/lib/grid.css
+examples/webby/content/css/blueprint/lib/img/grid.png
+examples/webby/content/css/blueprint/lib/img/icons/cross.png
+examples/webby/content/css/blueprint/lib/img/icons/textfield_key.png
+examples/webby/content/css/blueprint/lib/img/icons/tick.png
+examples/webby/content/css/blueprint/lib/reset.css
+examples/webby/content/css/blueprint/lib/typography.css
+examples/webby/content/css/blueprint/print.css
+examples/webby/content/css/blueprint/screen.css
+examples/webby/content/css/coderay.css
+examples/webby/content/css/site.css
+examples/webby/content/download.txt
+examples/webby/content/index.txt
+examples/webby/content/manual.txt
+examples/webby/content/robots.txt
+examples/webby/content/tips_and_tricks.txt
+examples/webby/content/tutorial.txt
+examples/webby/layouts/default.rhtml
+examples/webby/tasks/create.rake
+examples/webby/tasks/deploy.rake
+examples/webby/tasks/growl.rake
+examples/webby/tasks/heel.rake
+examples/webby/tasks/setup.rb
+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/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/sass.rb
+lib/webby/filters/textile.rb
 lib/webby/filters/tidy.rb
+lib/webby/helpers/tag_helper.rb
+lib/webby/helpers/url_helper.rb
 lib/webby/main.rb
 lib/webby/pages_db.rb
 lib/webby/renderer.rb
@@ -45,6 +80,7 @@ lib/webby/webby_task.rb
 spec/spec.opts
 spec/spec_helper.rb
 spec/webby/file_spec.rb
+tasks/annotations.rake
 tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
@@ -52,30 +88,3 @@ tasks/rubyforge.rake
 tasks/setup.rb
 tasks/spec.rake
 tasks/website.rake
-website/Rakefile
-website/content/css/blueprint/lib/buttons.css
-website/content/css/blueprint/lib/compressed.css
-website/content/css/blueprint/lib/grid.css
-website/content/css/blueprint/lib/img/grid.png
-website/content/css/blueprint/lib/img/icons/cross.png
-website/content/css/blueprint/lib/img/icons/textfield_key.png
-website/content/css/blueprint/lib/img/icons/tick.png
-website/content/css/blueprint/lib/reset.css
-website/content/css/blueprint/lib/typography.css
-website/content/css/blueprint/print.css
-website/content/css/blueprint/screen.css
-website/content/css/coderay.css
-website/content/css/site.css
-website/content/download.txt
-website/content/index.txt
-website/content/manual.txt
-website/content/robots.txt
-website/content/tips_and_tricks.txt
-website/content/tutorial.txt
-website/layouts/default.rhtml
-website/tasks/create.rake
-website/tasks/deploy.rake
-website/tasks/growl.rake
-website/tasks/heel.rake
-website/tasks/setup.rb
-website/templates/page.erb

data/README.txt

@@ -71,4 +71,24 @@ Webby is not limited to producing HTML. By no means! Do you ever get tired of re
 
 == LICENSE:
 
-MIT
+MIT License
+Copyright (c) 2007 - 2008
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sub-license, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,6 +1,7 @@
-# $Id$
+# $Id: Rakefile 89 2008-01-02 04:42:38Z tim_pease $
 
-load './tasks/setup.rb'
+load 'tasks/setup.rb'
+ensure_in_path 'lib'
 require 'webby'
 
 task :default => 'spec:run'
@@ -17,17 +18,20 @@ PROJ.rdoc_dir = 'doc/rdoc'
 PROJ.rdoc_remote_dir = 'rdoc'
 PROJ.version = Webby::VERSION
 
-PROJ.exclude << '^(\.\/|\/)?website/output'
-PROJ.exclude << '^(\.\/|\/)?doc'
-PROJ.rdoc_exclude << '^(\.\/|\/)?data'
-PROJ.rdoc_exclude << '^(\.\/|\/)?website'
+
+PROJ.exclude << '^examples/[^/]+/output'
+PROJ.exclude << '^tasks/archive'
+PROJ.exclude << '^tags$'
+
+PROJ.rdoc_exclude << '^data'
+PROJ.rdoc_exclude << '^examples'
 
 PROJ.spec_opts << '--color'
 
-depend_on 'directory_watcher', '1.1.0'
+depend_on 'directory_watcher'
 depend_on 'heel'
 depend_on 'hpricot'
-depend_on 'logging', '0.5.2'
+depend_on 'logging', '0.6.1'
 depend_on 'rspec'
 
 # EOF

data/bin/webby

@@ -1,15 +1,7 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'rubygems'
-  require 'webby'
-rescue LoadError
-  path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-  raise if $:.include? path
-  $: << path
-  retry
-end
-
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'webby'))
 ::Webby::Main.run ARGV
 
 # EOF

data/data/Rakefile

@@ -1,3 +1,4 @@
+# $Id$
 
 load 'tasks/setup.rb'
 

data/data/tasks/create.rake

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

data/data/tasks/deploy.rake

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

data/data/tasks/growl.rake

@@ -1,12 +1,13 @@
-
-desc 'send log events to Growl (Mac OS X only)'
-task :growl do
-  Logging::Logger['Webby'].add(Logging::Appenders::Growl.new(
-    "Webby",
-    :layout => Logging::Layouts::Pattern.new(:pattern => "%5l - Webby\000%m"),
-    :coalesce => true,
-    :separator => "\000"
-  ))
-end
-
-# EOF
+# $Id$
+
+desc 'send log events to Growl (Mac OS X only)'
+task :growl do
+  Logging::Logger['Webby'].add(Logging::Appenders::Growl.new(
+    "Webby",
+    :layout => Logging::Layouts::Pattern.new(:pattern => "%5l - Webby\000%m"),
+    :coalesce => true,
+    :separator => "\000"
+  ))
+end
+
+# EOF

data/data/tasks/heel.rake

@@ -1,32 +1,29 @@
-
-if HAVE_HEEL
-
-namespace :heel do
-
-  desc 'start the heel server to view website (not for Windows)'
-  task :start do
-    sh "heel --root #{SITE.output_dir} --daemonize"
-  end
-  
-  desc 'stop the heel server'
-  task :stop do
-    sh "heel --kill"
-  end
-
-  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.start
-  end
-
-  task :autobuild => :autorun do
-    at_exit {@heel_spawner.stop if defined? @heel_spawner and not @heel_spawner.nil?}
-  end
-
-end
-
-task :autobuild => 'heel:autobuild'
-
-end  # HAVE_HEEL
-
-# EOF
+# $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"
+  end
+  
+  desc 'stop the heel server'
+  task :stop do
+    sh "heel --kill"
+  end
+
+  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.start
+  end
+
+  task :autobuild => :autorun do
+    at_exit {@heel_spawner.stop if defined? @heel_spawner and not @heel_spawner.nil?}
+  end
+
+end
+
+task :autobuild => 'heel:autobuild'
+
+# EOF

data/data/tasks/setup.rb

@@ -1,3 +1,4 @@
+# $Id$
 
 require 'webby'
 
@@ -11,8 +12,7 @@ SITE.template_dir  = 'templates'
 SITE.exclude       = %w[tmp$ bak$ ~$ CVS \.svn]
   
 SITE.page_defaults = {
-  'extension' => 'html',
-  'layout'    => 'default'
+  'layout' => 'default'
 }
 
 # Items used to deploy the webiste
@@ -23,12 +23,7 @@ SITE.rsync_args = %w(-av --delete)
 # Options passed to the 'tidy' program when the tidy filter is used
 SITE.tidy_options = '-indent -wrap 80'
 
-# Load up the other rake tasks
-FileList['tasks/*.rake'].each {|task| import task}
-
-# Conditional dependencies
-%w(heel).each do |lib|
-  Object.instance_eval {const_set "HAVE_#{lib.upcase}", try_require(lib)}
-end
+# Load the other rake files in the tasks folder
+Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
 
 # EOF

data/examples/webby/content/manual.txt

@@ -0,0 +1,24 @@
+--- 
+title:      Manual
+created_at: Wed Aug 29 08:57:00 -0600 2007
+filter:
+  - coderay
+  - textile
+--- 
+h2. Installation
+
+directory structure
+
+* content
+* output
+* layouts
+* templates
+* lib
+* tasks
+
+resources
+
+renderer
+
+pages database
+

data/{website → examples/webby}/content/tutorial.txt

@@ -25,7 +25,7 @@ content/
 layouts/
 lib/
 output/
-tasks/
+rakelib/
 templates/
 </pre> 
 
@@ -69,7 +69,7 @@ This is not the entire contents of the file, just to enough to get a feel for ho
 
 The content of this page is not HTML, but it ends up that way. How? Webby uses _filters_ on the page to transform the text into HTML. The *filter* item in the meta-data tells Webby which filters to apply to the page. Two filters will be applied, "erb" and "textile" - in that order. Each filter operates on the page text (everything after the meta-data).
 
-The erb filter (erb stands for "embedded Ruby") allows Webby to process Ruby statements found in the page text and to substitue the output of those Ruby statements back into the page text. The Ruby statements appear between @<%= ruby_code %>@ delimiters. The meta-data found at the top of the page is made available through the @@page@ object. You can see from the index.rhtml file that the page title, "Home Page", will be substituted on the first line.
+The erb filter (erb stands for "embedded Ruby") allows Webby to process Ruby statements found in the page text and to substitute the output of those Ruby statements back into the page text. The Ruby statements appear between @<%= ruby_code %>@ delimiters. The meta-data found at the top of the page is made available through the @@page@ object. You can see from the index.rhtml file that the page title, "Home Page", will be substituted on the first line.
 
 The textile filter operates on all page text. It is a human readable markup that gets converted into HTML. For example, the line @h3. Litora Sociis@ will be converted into @<h3>Litora Sociis</h3>@ by the textile filter. It is a powerful markup language that simplifies web publishing. 
 
@@ -117,14 +117,14 @@ filter:    erb
 
 Ahhh, I love the smell of HTML in the morning!
 
-You'll notice that the layout file has meta-data just like the content files we've been editing. The *extension* defines the filename extentions that will be appened to every file generated by this layout. Just like the content files, layouts are filtered to produce valid HTML. The current page being rendered is available in the layout using the @@page@ variable.
+You'll notice that the layout file has meta-data just like the content files we've been editing. The *extension* defines the filename extension that will be appended to every file generated by this layout. Just like the content files, layouts are filtered to produce valid HTML. The current page being rendered is available in the layout using the @@page@ variable. We can see in the HTML header data that the page title will be set to the value of the @@page.title@.
 
-We can see in the HTML header data that the page title will be set to the value of the @@page.title@ from the meta-datalayouts are filtered to produce valid HTML. The current page being rendered is available in the layout using the @@page@ variable. The meta-data of the layout is not made available in the layout itself - just the meta-data of the content file being rendered.
+The meta-data of the layout is not made available in the layout itself - just the meta-data of the content file being rendered.
 
-Let's change the layout by removing the sidebar from every page. Find the sidebar div @<div class="column span-3 last">@. Delete that div, run rake to build the webiste again, and take a look at the site in your browser. You'll notice that both pages have been updated since both depend upon the default layout.
+Let's change the layout by removing the sidebar from every page. Find the sidebar div @<div class="column span-3 last">@. Delete that div, run rake to build the website again, and take a look at the site in your browser. You'll notice that both pages have been updated since both depend upon the default layout.
 
 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 &amp; tricks":tips_and_tricks.html for more ideas on simplying your web development work cycle.
+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 &amp; tricks":tips_and_tricks.html for more ideas on simplifying your web development work cycle.

data/{website → examples/webby}/tasks/growl.rake

@@ -1,12 +1,12 @@
-
-desc 'send log events to Growl (Mac OS X only)'
-task :growl do
-  Logging::Logger['Webby'].add(Logging::Appenders::Growl.new(
-    "Webby",
-    :layout => Logging::Layouts::Pattern.new(:pattern => "%5l - Webby\000%m"),
-    :coalesce => true,
-    :separator => "\000"
-  ))
-end
-
-# EOF
+
+desc 'send log events to Growl (Mac OS X only)'
+task :growl do
+  Logging::Logger['Webby'].add(Logging::Appenders::Growl.new(
+    "Webby",
+    :layout => Logging::Layouts::Pattern.new(:pattern => "%5l - Webby\000%m"),
+    :coalesce => true,
+    :separator => "\000"
+  ))
+end
+
+# EOF

data/{website → examples/webby}/tasks/heel.rake

@@ -1,32 +1,28 @@
-
-if HAVE_HEEL
-
-namespace :heel do
-
-  desc 'start the heel server to view website (not for Windows)'
-  task :start do
-    sh "heel --root #{SITE.output_dir} --daemonize"
-  end
-  
-  desc 'stop the heel server'
-  task :stop do
-    sh "heel --kill"
-  end
-
-  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.start
-  end
-
-  task :autobuild => :autorun do
-    at_exit {@heel_spawner.stop if defined? @heel_spawner and not @heel_spawner.nil?}
-  end
-
-end
-
-task :autobuild => 'heel:autobuild'
-
-end  # HAVE_HEEL
-
-# EOF
+
+namespace :heel do
+
+  desc 'start the heel server to view website (not for Windows)'
+  task :start do
+    sh "heel --root #{SITE.output_dir} --daemonize"
+  end
+  
+  desc 'stop the heel server'
+  task :stop do
+    sh "heel --kill"
+  end
+
+  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.start
+  end
+
+  task :autobuild => :autorun do
+    at_exit {@heel_spawner.stop if defined? @heel_spawner and not @heel_spawner.nil?}
+  end
+
+end
+
+task :autobuild => 'heel:autobuild'
+
+# EOF

data/{website → examples/webby}/tasks/setup.rb

@@ -11,8 +11,7 @@ SITE.template_dir  = 'templates'
 SITE.exclude       = %w[tmp$ bak$ ~$ CVS \.svn]
   
 SITE.page_defaults = {
-  'extension' => 'html',
-  'layout'    => 'default'
+  'layout' => 'default'
 }
 
 # Items used to deploy the webiste
@@ -23,12 +22,7 @@ SITE.rsync_args = %w(-av --delete)
 # Options passed to the 'tidy' program when the tidy filter is used
 SITE.tidy_options = '-indent -wrap 80'
 
-# Load up the other rake tasks
-FileList['tasks/*.rake'].each {|task| import task}
-
-# Conditional dependencies
-%w(heel).each do |lib|
-  Object.instance_eval {const_set "HAVE_#{lib.upcase}", try_require(lib)}
-end
+# Load the other rake files in the tasks folder
+Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
 
 # EOF

data/lib/webby/file.rb

@@ -1,4 +1,4 @@
-# $Id: file.rb 46 2007-11-27 03:31:29Z tim_pease $
+# $Id: file.rb 71 2007-12-13 05:45:53Z tim_pease $
 
 require 'yaml'
 
@@ -69,6 +69,38 @@ class File < ::File
     ensure
       fd.close unless fd.nil?
     end
+
+    # call-seq:
+    #    Webby::File.dirname( filename )    => dir_name
+    #
+    # Returns all components of the _filename_ except the last one. The
+    # filename must be formed using forward slashes ("/") regardless of the
+    # separator used on the local file system.
+    #
+    def dirname( fn )
+      ::File.dirname(fn).sub(%r/\A[^\/]+\/?/o, '')
+    end
+
+    # call-seq:
+    #    Webby::File.basename( filename )    => base_name
+    #
+    # Returns the last component of the _filename_, which must be formed
+    # using forward slashes ("/"regardless of the separator used on the
+    # local file system. The suffix is removed from the filename.
+    #
+    def basename( fn )
+      ::File.basename(fn, '.*')
+    end
+
+    # call-seq:
+    #    Webby::File.extname( filename )    => ext_name
+    #
+    # Returns the extension (the portion of file name in path after the
+    # period). This method excludes the period from the extension name.
+    #
+    def extname( fn )
+      ::File.extname(fn).tr('.', '')
+    end
   end
 
   # call-seq:

data/lib/webby/filters/coderay.rb

@@ -1,11 +1,11 @@
-# $Id: coderay.rb 58 2007-12-02 23:59:27Z tim_pease $
+# $Id: coderay.rb 68 2007-12-09 07:45:37Z tim_pease $
 
 require 'enumerator'
 require 'hpricot'
 try_require 'coderay'
 
 module Webby
-module Filters  
+module Filters
 
 # The CodeRay applies syntax highlighting to source code embedded in a
 # webpage. The CodeRay highlighting engine is used for the HTML markup of
@@ -86,6 +86,12 @@ class CodeRay
   end
 
 end  # class CodeRay
+
+# Render text via the CodeRay syntax highlighter library.
+register :coderay do |input, cursor|
+  Filters::CodeRay.new(input, cursor.remaining_filters).to_html
+end
+
 end  # module Filters
 end  # module Webby
 

data/lib/webby/filters/erb.rb

@@ -0,0 +1,11 @@
+# $Id: erb.rb 68 2007-12-09 07:45:37Z tim_pease $
+
+require 'erb'
+
+# Render text via ERB using the built in ERB library.
+Webby::Filters.register :erb do |input, cursor|
+  b = cursor.renderer.get_binding
+  ERB.new(input, nil, '-').result(b)
+end
+
+# EOF