webby 0.4.0 → 0.5.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.5.0 / 2007-11-26
+
+* Launching heel now works on Windows boxen
+* Now using "logging" gem to output build status
+* Updated find routine for the pages DB
+* First whack at pagination support
+
 == 0.4.0 / 2007-09-18
 
 * Updated the Blueprint CSS stylesheets to version 0.5

data/Manifest.txt

@@ -23,6 +23,7 @@ data/content/index.txt
 data/layouts/default.rhtml
 data/tasks/create.rake
 data/tasks/deploy.rake
+data/tasks/growl.rake
 data/tasks/heel.rake
 data/tasks/setup.rb
 data/templates/page.erb
@@ -35,6 +36,8 @@ lib/webby/main.rb
 lib/webby/pages_db.rb
 lib/webby/renderer.rb
 lib/webby/resource.rb
+lib/webby/stelan/paginator.rb
+lib/webby/stelan/spawner.rb
 lib/webby/utils.rb
 lib/webby/webby_task.rb
 spec/spec.opts
@@ -59,15 +62,18 @@ 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

@@ -8,7 +8,7 @@ Webby
 
 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 everthing 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 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 +23,7 @@ Install Webby and try it out!
 
 But Wait! There's More!
 
-Webby has a great _autobuild_ feature that continously 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
@@ -46,11 +46,11 @@ Webby is not limited to producing HTML. By no means! Do you ever get tired of re
 
    $ cd my_site
 
-   $ rake create:page new_page.rhtml
-   creating content/new_page.rhtml
+   $ rake create:page new_page.txt
+   creating content/new_page.txt
 
-   $ rake create:page another/new_page.rhtml
-   creating content/another/new_page.rhtml
+   $ rake create:page another/new_page.txt
+   creating content/another/new_page.txt
 
    $ rake autobuild
    heel --root output --daemonize
@@ -62,11 +62,12 @@ Webby is not limited to producing HTML. By no means! Do you ever get tired of re
 
 == REQUIREMENTS:
 
-* rake
-* rspec
 * directory_watcher
-* hpricot
 * heel
+* hpricot
+* logging
+* rake
+* rspec
 
 == LICENSE:
 

data/Rakefile

@@ -18,6 +18,7 @@ PROJ.rdoc_remote_dir = 'rdoc'
 PROJ.version = Webby::VERSION
 
 PROJ.exclude << '^(\.\/|\/)?website/output'
+PROJ.exclude << '^(\.\/|\/)?doc'
 PROJ.rdoc_exclude << '^(\.\/|\/)?data'
 PROJ.rdoc_exclude << '^(\.\/|\/)?website'
 
@@ -26,6 +27,7 @@ PROJ.spec_opts << '--color'
 depend_on 'directory_watcher', '1.0.0'
 depend_on 'heel'
 depend_on 'hpricot'
+depend_on 'logging', '0.5.1'
 depend_on 'rspec'
 
 # EOF

data/bin/webby

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 begin
+  require 'rubygems'
   require 'webby'
 rescue LoadError
   path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))

data/data/content/css/site.css

@@ -0,0 +1,59 @@
+--- 
+extension: css
+filter:    erb
+layout:    nil   # no layout
+
+color:
+  border:      "#ddd"
+  header:      "#111"
+  link:        "#125AA7"
+  link-hover:  "#000"
+  blockquote:  "#666"
+  box-bg:      "#eee"
+  highlight:   "#B2CCFF"
+  quiet:       "#666"
+  alt:         "#666"
+--- 
+
+body {
+  font-family: Verdana, "Bitstream Vera Sans", sans-serif;
+}
+
+/* Headings
+ * --------------------------------------------------------------------- */
+h1,h2,h3,h4,h5,h6 { color: <%= @page.color['header'] %>; }
+
+/* Text Elements
+ * --------------------------------------------------------------------- */
+a                 { color: <%= @page.color['link'] %>; }
+a:hover           { color: <%= @page.color['link-hover'] %>; }
+blockquote        { color: <%= @page.color['blockquote'] %>; }
+
+pre {
+  background: <%= @page.color['box-bg'] %>;
+  border:     1px solid <%= @page.color['border'] %>;
+}
+
+hr {
+  background: <%= @page.color['highlight'] %>;
+  color:      <%= @page.color['highlight'] %>;
+}
+
+/* Tables
+ * --------------------------------------------------------------------- */
+table {
+  border-top:     1px solid <%= @page.color['border'] %>;
+  border-left:    1px solid <%= @page.color['border'] %>;
+}
+th,td {
+  border-bottom:  1px solid <%= @page.color['border'] %>;
+  border-right:   1px solid <%= @page.color['border'] %>;
+}
+
+/* Default Classes
+ * --------------------------------------------------------------------- */
+p.quiet { color: <%= @page.color['quiet'] %>; }
+.alt    { color: <%= @page.color['alt'] %>; }
+
+
+/* EOF */

data/data/layouts/default.rhtml

@@ -7,34 +7,34 @@ filter:    erb
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
 <head>
-   <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+   <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <title><%= @page.title %></title>
    <meta name="author" content="<%= @page.author %>" />
 
    <!--- Blueprint CSS Framework -->
-   <link rel="stylesheet" href="css/blueprint/screen.css" type="text/css" media="screen, projection" />
-   <link rel="stylesheet" href="css/blueprint/print.css" type="text/css" media="print" />
+   <link rel="stylesheet" href="/css/blueprint/screen.css" type="text/css" media="screen, projection" />
+   <link rel="stylesheet" href="/css/blueprint/print.css" type="text/css" media="print" />
 
    <!-- CodeRay syntax highlighting CSS -->
-   <link rel="stylesheet" href="css/coderay.css" type="text/css" />
+   <link rel="stylesheet" href="/css/coderay.css" type="text/css" />
 
    <!-- Homepage CSS -->
-   <link rel="stylesheet" href="css/site.css" type="text/css" media="screen, projection" />
+   <link rel="stylesheet" href="/css/site.css" type="text/css" media="screen, projection" />
 </head>
 <body>
 
 <div class="container">
 	
-   <div class="column span-11 prepend-1 first last">
+   <div class="column span-18 prepend-2 append-4 first last" id="header">
      <h2>A New Website</h2>
      <hr>
    </div>
 	
-   <div class="column span-8 prepend-1 first">
+   <div class="column span-15 prepend-2 first">
       <%= @content %>
    </div>
 
-   <div class="column span-3 last">
+   <div class="column span-3 append-4 last">
       <h4>Sidebar</h4>
       <p>Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Cras ornare mattis nunc. Mauris venenatis, pede sed aliquet vehicula, lectus tellus pulvinar neque, non cursus sem nisi vel augue. </p>
 		
@@ -48,7 +48,7 @@ filter:    erb
       <p class="incr">Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Cras ornare mattis nunc. Mauris venenatis, pede sed aliquet vehicula, lectus tellus pulvinar neque, non cursus sem nisi vel augue. sed aliquet vehicula, lectus tellus.</p>
    </div>
 
-   <div class="column span-11 prepend-1 first last">
+   <div class="column span-18 prepend-2 append-4 first last" id="footer">
      <hr />
      <p>This website was created with <a href="http://webby.rubyforge.org">Webby</a></p>
    </div>

data/data/tasks/create.rake

@@ -10,3 +10,4 @@ Rake::WebbyTask.new do |webby|
   webby.page_defaults = SITE.page_defaults
 end
 
+# EOF

data/data/tasks/growl.rake

@@ -0,0 +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

data/data/tasks/heel.rake

@@ -3,18 +3,24 @@ if HAVE_HEEL
 
 namespace :heel do
 
-  desc 'start the heel server to view website'
-  task :run 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 :kill do
+  task :stop do
     sh "heel --kill"
   end
 
-  task :autobuild => :run do
-    at_exit {sh "heel --kill"}
+  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

data/lib/webby.rb

@@ -1,8 +1,19 @@
-# $Id: webby.rb 29 2007-09-18 18:14:50Z tim_pease $
+# $Id: webby.rb 41 2007-10-15 20:44:21Z tim_pease $
+
+require 'logging'
+
+# Configure Webby to log to STDOUT at the 'info' level
+Logging::Appender.stdout.layout = Logging::Layouts::Pattern.new(
+    :pattern      => "[%d] %5l: %m\n",    # [date] LEVEL: message
+    :date_pattern => "%H:%M:%S"           # date == HH:MM:SS
+)
+Logging::Logger['Webby'].add(Logging::Appender.stdout)
+Logging::Logger['Webby'].level = :info
+
 
 module Webby
 
-  VERSION = '0.4.0'   # :nodoc:
+  VERSION = '0.5.0'   # :nodoc:
 
   # Path to the Webby package
   PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..'))
@@ -52,6 +63,28 @@ module Webby
     }
   end
 
+  # call-seq
+  #    Webby.exclude    => regexp
+  #
+  # Returns a regular expression used to exclude resources from the content
+  # directory from being processed by Webby. This same regular expression is
+  # also used to exclude layouts.
+  #
+  def self.exclude
+    @exclude ||= Regexp.new(config['exclude'].join('|'))
+  end
+
+  # call-seq:
+  #    cairn    => filename
+  #
+  # The Webby _cairn_ file is used to mark the last time the content was
+  # built into the output directory. It is an empty file; only the
+  # modification time of the file is important.
+  #
+  def self.cairn
+    @cairn ||= File.join(config['output_dir'], '.cairn')
+  end
+
 end  # module Webby
 
 

data/lib/webby/auto_builder.rb

@@ -1,4 +1,4 @@
-# $Id: auto_builder.rb 5 2007-08-22 04:25:49Z tim_pease $
+# $Id: auto_builder.rb 40 2007-10-14 03:54:36Z tim_pease $
 
 require 'directory_watcher'
 
@@ -27,6 +27,9 @@ class AutoBuilder
   # Create a new AutoBuilder class.
   #
   def initialize
+    @log = Logging::Logger[self]
+
+    @builder = Builder.new
     @watcher = DirectoryWatcher.new '.', :interval => 2
     @watcher.add_observer self
 
@@ -47,11 +50,16 @@ class AutoBuilder
     ary = events.find_all {|evt| evt.type != :removed}
     return if ary.empty?
 
-    print '- started at '
-    puts Time.now.strftime('%H:%M:%S')
-    Builder.run
+    ary.each do |evt|
+      @log.debug "changed #{evt.path}"
+      next unless test ?f, evt.path
+      next if evt.path =~ ::Webby.exclude
+      Resource.new evt.path
+    end
+
+    @builder.run :load_files => false
   rescue => err
-    puts err.message
+    @log.error err
   end
 
   # call-seq:
@@ -61,7 +69,7 @@ class AutoBuilder
   # Ctrl-C to stop the watcher thread.
   #
   def run
-    puts '-- starting autobuild (Ctrl-C to stop)'
+    @log.info 'starting autobuild (Ctrl-C to stop)'
 
     Signal.trap('INT') {@watcher.stop}
 

data/lib/webby/builder.rb

@@ -1,4 +1,4 @@
-# $Id: builder.rb 16 2007-08-25 19:55:00Z tim_pease $
+# $Id: builder.rb 46 2007-11-27 03:31:29Z tim_pease $
 
 require 'find'
 require 'fileutils'
@@ -38,7 +38,7 @@ class Builder
       raise Error, "template not given" unless tmpl
       raise Error, "#{page} already exists" if test ?e, page
 
-      puts "creating #{page}"
+      Logging::Logger[self].info "creating #{page}"
       FileUtils.mkdir_p File.dirname(page)
       str = ERB.new(::File.read(tmpl), nil, '-').result
       ::File.open(page, 'w') {|fd| fd.write str}
@@ -48,7 +48,17 @@ class Builder
   end  # class << self
 
   # call-seq:
-  #    run( :rebuild => false )
+  #    Builder.new
+  #
+  # Creates a new Builder object for creating pages from the content and
+  # layout directories.
+  #
+  def initialize
+    @log = Logging::Logger[self]
+  end
+
+  # call-seq:
+  #    run( :rebuild => false, :load_files => true )
   #
   # Runs the Webby builder by loading in the layout files from the
   # <code>layouts/</code> folder and the content from the
@@ -70,19 +80,20 @@ class Builder
   # more recently than the output file.
   #
   def run( opts = {} )
-    Resource.clear
+    opts[:load_files] = true unless opts.has_key?(:load_files)
 
     unless test(?d, output_dir)
-      puts "creating #{output_dir}"
+      @log.info "creating #{output_dir}"
       FileUtils.mkdir output_dir
     end
 
-    load_files
+    load_files if opts[:load_files]
+    loop_check
 
     Resource.pages.each do |page|
       next unless page.dirty? or opts[:rebuild]
 
-      puts "creating #{page.destination}"
+      @log.info "creating #{page.destination}"
 
       # make sure the directory exists
       FileUtils.mkdir_p ::File.dirname(page.destination)
@@ -93,18 +104,13 @@ class Builder
 
       # otherwise, layout the resource and write the results to
       # the output directory
-      else
-        ::File.open(page.destination, 'w') do |fd|
-          fd.write Renderer.new(page).layout_page
-        end
-      end
+      else Renderer.write(page) end
     end
 
-    # touch the output directory so we know when the
-    # website was last generated
-    FileUtils.touch output_dir
+    # touch the cairn so we know when the website was last generated
+    FileUtils.touch ::Webby.cairn
 
-    return nil
+    nil
   end
 
 
@@ -114,18 +120,20 @@ class Builder
   # folder and create a new Resource object for each file found there.
   #
   def load_files
-    excl = Regexp.new exclude.join('|')
-
     ::Find.find(layout_dir, content_dir) do |path|
       next unless test ?f, path
-      next if path =~ excl
+      next if path =~ ::Webby.exclude
       Resource.new path
     end
+  end
 
+  # Loop over all the layout resources looking for circular reference -- a
+  # layout that eventually refers back to itself. These are bad. Raise an
+  # error if one is detected.
+  #
+  def loop_check
     layouts = Resource.layouts
 
-    # look for loops in the layout references -- i.e. a layout
-    # eventually refers back to itself
     layouts.each do |lyt|
       stack = []
       while lyt
@@ -135,12 +143,12 @@ class Builder
                 "loop detected in layout references: #{stack.join(' > ')}"
         end
         stack << lyt.filename
-        lyt = layouts.find_by_name lyt.layout
+        lyt = layouts.find :filename => lyt.layout
       end  # while
     end  # each
   end
 
-  %w(output_dir layout_dir content_dir exclude).each do |key|
+  %w(output_dir layout_dir content_dir).each do |key|
     self.class_eval <<-CODE
       def #{key}( ) ::Webby.config['#{key}'] end
     CODE