webby 0.7.3 → 0.7.4

data/History.txt

@@ -1,3 +1,13 @@
+== 0.7.4 / 2008-02-15
+
+* 3 minor enhancements
+  - Added "limit" and "sort_by" options to the pages find method
+  - Removed dependency on RedCloth for outline generation
+  - Added some more options for outline generation, numbering, and
+    table of contents generation
+* 1 bug fix
+  - Fixed incompatibility with the new logging library
+
 == 0.7.3 / 2008-02-05
 
 * 2 bug fixes

data/Manifest.txt

@@ -43,12 +43,12 @@ 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/manual/index.txt
 examples/webby/content/robots.txt
 examples/webby/content/script/jquery.corner.js
 examples/webby/content/script/jquery.js
-examples/webby/content/tips_and_tricks.txt
-examples/webby/content/tutorial.txt
+examples/webby/content/tips_and_tricks/index.txt
+examples/webby/content/tutorial/index.txt
 examples/webby/layouts/default.rhtml
 examples/webby/tasks/create.rake
 examples/webby/tasks/deploy.rake

data/Rakefile

@@ -1,4 +1,4 @@
-# $Id: Rakefile 130 2008-02-04 22:28:22Z tim_pease $
+# $Id: Rakefile 148 2008-02-15 05:26:56Z tim_pease $
 
 load 'tasks/setup.rb'
 
@@ -32,9 +32,8 @@ PROJ.spec_opts << '--color'
 depend_on 'directory_watcher'
 depend_on 'heel'
 depend_on 'hpricot'
-depend_on 'logging', '0.6.1'
+depend_on 'logging', '0.7.0'
 depend_on 'rake'
 depend_on 'rspec'
-depend_on 'RedCloth'
 
 # EOF

data/data/tasks/growl.rake

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

data/examples/webby/Rakefile

@@ -8,6 +8,7 @@ task :deploy => [:build, 'deploy:rsync']
 
 SITE.host = 'tim_pease@rubyforge.org'
 SITE.remote_dir = '/var/www/gforge-projects/webby/'
+SITE.create_mode = 'directory'
 
 task :autobuild => :growl
 

data/examples/webby/content/css/site.css

@@ -84,10 +84,15 @@ p.quiet
     :font-size                 16px
     :list-style-type           none
     li
+      :display                 block
+      :padding-right           5px
+      :background-color =      !box_bg
       a
         :display               block
         :text-decoration       none
+        :margin-right          -5px
         :padding-right         5px
+        :background-color      white
         &:hover
           :background-color = !highlight
 

data/examples/webby/content/index.txt

@@ -3,7 +3,7 @@ title:      Home
 created_at: Tue Aug 21 11:25:06 -0600 2007
 filter:     textile
 --- 
-*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* is a 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.
 

data/examples/webby/content/{manual.txt → manual/index.txt}

@@ -15,37 +15,95 @@ p(title). Table of Contents
 <toc />
 </div>
 
-h2{clear:none}. Getting Started
+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">
+digraph overview {
+  rankdir = LR;
+  edge [fontname="Verdana", fontsize=8];
+  node [fontname="Verdana", fontsize=10];
+
+  layout [label="Layout",color="#BBBBBB",style=filled];
+  p1 [label="Page 1",color=red];
+  h1 [label="HTML 1",color=red];
+  p2 [label="Page 2",color=green];
+  h2 [label="HTML 2",color=green];
+  p3 [label="Page 3",color=blue];
+  h3 [label="HTML 3",color=blue];
+
+  p1 -> layout -> h1 [color=red];
+  p2 -> layout -> h2 [color=green];
+  p3 -> layout -> h3 [color=blue];
+}
+</graphviz>
+
+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.
+
+Webby does not limit the output to HTML. Webby can be used to generate XML files for RSS or Atom news feeds, CSS files for styling web pages, or any other type of text file that you can think of.
 
 h3{clear:none}. Requirements
 
-Webby is an application written using the Ruby programming language. To install and run Webby you will need the following applications on your system:
+Webby is written in the Ruby programming language. To install and run Webby you will need the following applications installed on your system:
 
 * "Ruby":http://ruby-lang.org
 * "RubyGems":http://rubygems.org/read/chapter/3
 
 h3{clear:none}. Installation
 
-Webby is an application written using the Ruby programming language. You will need to install a Ruby interpreter on your computer. Download and installation instructions can be found on the "Ruby":http://ruby-lang.org website. For the Windows platform, the one-click installer is recommended. Webby is not compatible with the Ruby 1.9.0 release; please use the Ruby 1.8.6 release.
-
-You will also need to install RubyGems. If you used the Windows one-click installer, RubyGems is already present on your system. For everyone else you can find installation instructions on the "RubyGems":http://rubygems.org/read/chapter/3 website.
-
-To install Webby and its dependent gems type the following command. Omit the @sudo@ portion for the Windows platform; you will need to specify the *mswin32* versions of the _mongrel_ and _hpricot_ dependent gems when prompted.
+Webby is easily installed as a Ruby gem. From a command prompt, type in the following:
 
 <pre>
 sudo gem install -y webby
 </pre>
 
+This will install Webby and all its required dependencies.
+
+bq. For those users installing Webby on the Windows platform, please omit the @sudo@ portion of the above command. You will also need to specify the *mswin32* versions of the _mongrel_ and _hpricot_ gems when prompted.
+
 To make use of all the features Webby has to offer, the following gems should also be installed. These gems provide different ways to transform text into HTML or CSS.
 
 <pre>
-sudo gem install -y RedcCoth
 sudo gem install -y BlueCloth
 sudo gem install -y haml
 sudo gem install -y coderay
 </pre>
 
-h3. New Website
+Webby can also use a few other programs to clean up generated HTML and to created pretty graphs. You can read more about these programs and how they are used in the Filters section of this manual  --  specifically, the sections on the "Tidy":#tidy filter and the "Graphviz":#graphviz filter.
+
+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. 
+
+<pre>
+$ webby --help
+
+Usage: webby [options] site
+
+    -u, --update                     update the rake tasks for the site
+
+common options:
+    -h, --help                       show this message
+        --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@.
+
+<pre>
+$ rake -T
+
+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: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)
+rake heel:stop     # stop the heel server
+rake rebuild       # rebuild the website
+</pre>
 
 h2. Working With Resources
 
@@ -300,7 +358,7 @@ p(column span-2). *Require*:
 
 p(column span-13). The @coderay@ gem must be installed on your system in order to use the coderay filter. Be sure to include the coderay stylesheet in your layout.
 
-h3. Graphviz
+h3(#graphviz). Graphviz
 
 "Graphviz":http://www.graphviz.org/ is open source graph visualization software. Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. The Graphviz layout programs take descriptions of graphs in a simple text language, and make diagrams in several useful formats. The graphviz filter allows you to embed Graphviz scripts into a page and generate an image in the page.
 
@@ -363,7 +421,7 @@ p(column span-2). *Require*:
 
 p(column span-13). none
 
-h3. Tidy
+h3(#tidy). Tidy
 
 "Tidy":http://www.w3.org/People/Raggett/tidy/ is a useful application for cleaning up and detecting errors in XHTML text. The tidy filter will run your XHTML code through the tidy program and report any errors in the build log. From the HTML Tidy website:
 

data/examples/webby/layouts/default.rhtml

@@ -37,11 +37,11 @@ filter:
 
    <div class="column span-4 prepend-1 first" id="navigation">
       <ul
-        ><li><a href="/index.html">Home</a></li
-        ><li><a href="/download.html">Download</a></li
-        ><li><a href="/tutorial.html">Tutorial</a></li
-        ><li><a href="/manual.html">Manual</a></li
-        ><li><a href="/tips_and_tricks.html">Tips &amp; Tricks</a></li
+        ><li><%= link_to_page_unless_current 'Home' %></li
+        ><li><%= link_to_page_unless_current 'Download' %></li
+        ><li><%= link_to_page_unless_current 'Tutorial' %></li
+        ><li><%= link_to_page_unless_current 'Manual' %></li
+        ><li><%= link_to_page_unless_current 'Tips & Tricks' %></li
         ></ul>
    </div>
 

data/examples/webby/tasks/growl.rake

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

data/lib/webby.rb

@@ -1,11 +1,12 @@
-# $Id: webby.rb 130 2008-02-04 22:28:22Z tim_pease $
+# $Id: webby.rb 145 2008-02-13 00:39:03Z tim_pease $
 
 require 'logging'
 require 'ostruct'
+require 'date'
 
 # Configure Webby to log to STDOUT at the 'info' level
 Logging::Logger['Webby'].level = :info
-Logging::Logger['Webby'].add(Logging::Appender.stdout)
+Logging::Logger['Webby'].add_appenders(Logging::Appender.stdout)
 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
@@ -14,7 +15,7 @@ Logging::Appender.stdout.layout = Logging::Layouts::Pattern.new(
 
 module Webby
 
-  VERSION = '0.7.3'   # :nodoc:
+  VERSION = '0.7.4'   # :nodoc:
 
   # Path to the Webby package
   PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..'))

data/lib/webby/filters/outline.rb

@@ -1,4 +1,4 @@
-# $Id: outline.rb 124 2008-02-03 00:24:10Z tim_pease $
+# $Id: outline.rb 151 2008-02-15 21:09:47Z tim_pease $
 
 require 'hpricot'
 
@@ -15,7 +15,7 @@ module Filters
 # into the heading tags, this can be specified in the attibutes of the
 # <toc /> tag itself.
 #
-#    <toc outline_numbering="off" />
+#    <toc numbering="off" />
 #
 # This will generate a table of contents, but not insert outline numbering
 # into the heading tags.
@@ -25,6 +25,7 @@ module Filters
 # etc.).
 #
 class Outline
+  include ERB::Util
 
   class Error < StandardError; end    # :nodoc:
 
@@ -40,8 +41,14 @@ class Outline
     @cur_level, @base_level, @cur_depth = nil
     @level = [0] * 6
     @h_rgxp = %r/^h(\d)$/o
+
+    @numbering = true
+    @numbering_start = 1
+
     @toc = []
-    @outline_numbering = true
+    @toc_style = 'ol'
+    @toc_range = 'h1-h6'
+    @list_opening = nil
   end
 
   # call-seq:
@@ -59,7 +66,7 @@ class Outline
   #
   # somewhere in a page about comic strips, the tag might be altered as such
   #
-  #    <h3 id="h2_2_1"><span class="heading-num>2.2.1</span>Get Fuzzy</h3>
+  #    <h3 id="h2_2_1"><span class="heading-num">2.2.1</span>Get Fuzzy</h3>
   # 
   # The id attribute is used to generate a linke from the table of contents
   # to this particular heading tag. The original text of the tag is used in
@@ -72,26 +79,46 @@ class Outline
     toc_elem = doc.search('toc').first
 
     unless toc_elem.nil?
-      @outline_numbering = toc_elem['outline_numbering'] !~ %r/off/i
+      @numbering = toc_elem['numbering'] !~ %r/off/i
+      @numbering_start = Integer(toc_elem['numbering_start']) if toc_elem.has_attribute? 'numbering_start'
+      @toc_style = toc_elem['toc_style'] if toc_elem.has_attribute? 'toc_style'
+      @toc_range = toc_elem['toc_range'] if toc_elem.has_attribute? 'toc_range'
+    end
+
+    unless %w[ul ol].include? @toc_style
+      raise ArgumentError, "unknown ToC list type '#{@toc_style}'"
     end
 
+    m = %r/h(\d)\s*-\s*h(\d)/i.match @toc_range
+    @toc_range = Integer(m[1])..Integer(m[2])
+    @list_opening = build_list_opening(toc_elem)
+
     doc.traverse_element(*%w[h1 h2 h3 h4 h5 h6]) do |elem|
       text, id = heading_info(elem)
-      add_to_toc(text, id)
+      add_to_toc(text, id) if @toc_range.include? current_level
     end
 
-    # create the TOC ordered list
-
     toc_elem.swap(toc) unless toc_elem.nil?
-    
-    # replace the "toc" tag with the ordered list
-
     doc.to_html
   end
 
 
   private
 
+  def build_list_opening( elem )
+    lo = "<#{@toc_style}"
+    unless elem.nil?
+      %w[class style id].each do |atr|
+        next unless elem.has_attribute? atr
+        lo << " %s=\"%s\"" % [atr, elem[atr]]
+      end
+    end
+    if @toc_style == 'ol' and @numbering_start != 1
+      lo << " start=\"#{@numbering_start}\""
+    end
+    lo << ">"
+  end
+
   # Returns information for the given heading element. The information is
   # returned as a two element array: [text, id].
   #
@@ -107,7 +134,7 @@ class Outline
     text = elem.inner_text
 
     lbl = label
-    if outline_numbering?
+    if numbering?
       elem.children.first.before {tag!(:span, lbl, :class => 'heading-num')}
     end
     elem['id'] = "h#{lbl.tr('.','_')}" if elem['id'].nil?
@@ -124,8 +151,10 @@ class Outline
   # heading level.
   #
   def current_level=( level )
-    @base_level ||= level
-    @cur_level ||= level
+    if @base_level.nil?
+      @base_level = @cur_level = level
+      @level[@base_level-1] = @numbering_start-1
+    end
 
     if level < @base_level
       raise Error, "heading tags are not in order, cannot outline"
@@ -143,6 +172,12 @@ class Outline
     @cur_level = level
   end
 
+  # Returns the current heading level number.
+  #
+  def current_level
+    @cur_level
+  end
+
   # Return the label string for the current heading level.
   #
   def label
@@ -161,23 +196,63 @@ class Outline
   # Add the given text and id reference to the table of contents.
   #
   def add_to_toc( text, id )
-    str = '#' * depth
-    str << ' ' << "\"#{text}\":##{id}"
-    @toc << str
+    a = "<a href=\"##{id}\">#{h(text)}</a>"
+    @toc << [depth, a]
   end
 
   # Returns the table of contents as a collection of nested ordered lists.
   # This is fully formatted HTML.
   #
   def toc
-    RedCloth.new(@toc.join("\n"), %w(no_span_caps)).to_html
+    ary = []
+
+    lopen = "<#@toc_style>"
+    lclose = "</#@toc_style>"
+    prev_depth = open = 0
+
+    @toc.each do |a|
+      cur = a.first
+
+      # close out the previous list item if we're at the same level
+      if cur == prev_depth
+        ary << "</li>"
+
+      # if we are increasing the level, then start a new list
+      elsif cur > prev_depth
+        ary << if ary.empty? then @list_opening else lopen end
+        open += 1
+
+      # we are decreasing the level; close out tags but ensure we don't
+      # close out all the tags (leave one open)
+      else
+        (prev_depth - cur).times {
+          ary << "</li>" << lclose
+          open -= 1
+          break if open <= 0
+        }
+        if open > 0
+          ary << "</li>"
+        else
+          ary << lopen
+          open += 1
+        end
+      end
+
+      # add the current element
+      ary << "<li>" << a.last
+      prev_depth = cur
+    end
+
+    # close out the remaingling tags
+    ary << "</li>" << lclose
+    ary.join("\n")
   end
 
   # Returns +true+ if outline numbering should be inserted into the heading
   # tags. Returns +false+ otherwise.
   #
-  def outline_numbering?
-    @outline_numbering
+  def numbering?
+    @numbering
   end
 end  # class Outline
 

data/lib/webby/helpers/url_helper.rb

@@ -1,4 +1,4 @@
-# $Id: url_helper.rb 103 2008-01-20 23:58:14Z tim_pease $
+# $Id: url_helper.rb 147 2008-02-14 20:14:04Z tim_pease $
 
 module Webby
 module Helpers #:nodoc:
@@ -115,7 +115,7 @@ module UrlHelper
     end
 
     href_attr = href ? nil : %Q(href="#{url}")
-    "<a #{href_attr}#{attrs}>#{name || url}</a>"
+    "<a #{href_attr}#{attrs}>#{name || h(url)}</a>"
   end
 
   # call-seq:
@@ -222,8 +222,8 @@ module UrlHelper
     raise Webby::Renderer::Error,
           "could not find requested page: #{opts.inspect}" if p.nil?
 
-    name = h(p.title || p.filename) if name.nil?
-    return [name, p, link_opts]
+    name = p.title || p.filename if name.nil?
+    return [h(name), p, link_opts]
   end
 
 end  # module UrlHelper

data/lib/webby/pages_db.rb

@@ -1,4 +1,4 @@
-# $Id: pages_db.rb 119 2008-01-29 04:26:27Z wbruce $
+# $Id: pages_db.rb 137 2008-02-08 05:05:55Z tim_pease $
 
 module Webby
 
@@ -78,14 +78,20 @@ class PagesDB
   #
   # Options include:
   #
-  #    :all
   #    :in_directory => 'directory'
+  #    :recursive    => true or false
+  #
+  #    :limit        => :all or integer
+  #    :sorty_by     => 'attribute'
   #
   # Examples:
   #
   #    # find the "index" resource in the "foo/bar" directory
   #    pages_db.find( :filename => 'index', :in_directory => 'foo/bar' )
   #
+  #    # find any "index" resource under the "foo/bar" directory
+  #    pages_db.find( :filename => 'index', :in_directory => 'foo/bar', :recursive => true )
+  #
   #    # find all resources named "widgets" whose color is "blue"
   #    pages_db.find( :all, :name => 'widgets', :color => 'blue' )
   #
@@ -96,8 +102,12 @@ class PagesDB
   #
   def find( *args, &block )
     opts = Hash === args.last ? args.pop : {}
-    find_all = args.include? :all
 
+    limit = opts.delete(:limit)
+    sort_by = opts.delete(:sort_by)
+
+    # figure out which directories to search through and whether to recurse
+    # into directories or not
     search = if (dir = opts.delete(:in_directory))
       strategy = if opts.delete(:recursive)
         lambda { |key| key =~ /^#{Regexp.escape(dir)}(?:\/|$)/ }
@@ -111,6 +121,7 @@ class PagesDB
       self
     end
 
+    # construct a search block if one was not supplied by the user
     block ||= lambda do |page|
       found = true
       opts.each do |key, value|
@@ -120,16 +131,28 @@ class PagesDB
       found
     end
     
+    # search through the directories for the desired pages
     ary = []
     search.each do |page|
-      if block.call(page)
-        ary << page
-        break unless find_all
-      end
+      ary << page if block.call(page)
+    end
+
+    # sort the search results if the user gave an attribute to sort by
+    if sort_by
+      m = sort_by.to_sym
+      ary.delete_if {|p| p.__send__(m).nil?}
+      ary.sort! {|a,b| a.__send__(m) <=> b.__send__(m)}
+    end
+
+    # limit the search results
+    case limit
+    when :all, 'all'
+      ary
+    when Integer
+      ary.slice(0,limit)
+    else
+      ary.first
     end
-    
-    return ary if find_all
-    return ary.first
   end
 
   # call-seq:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webby
 version: !ruby/object:Gem::Version 
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-05 00:00:00 -07:00
+date: 2008-02-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,7 +46,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.6.1
+        version: 0.7.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -66,15 +66,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.3
     version: 
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 3.0.4
-    version: 
 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.
 email: tim.pease@gmail.com
 executables: 
@@ -131,12 +122,12 @@ files:
 - examples/webby/content/css/site.css
 - examples/webby/content/download.txt
 - examples/webby/content/index.txt
-- examples/webby/content/manual.txt
+- examples/webby/content/manual/index.txt
 - examples/webby/content/robots.txt
 - examples/webby/content/script/jquery.corner.js
 - examples/webby/content/script/jquery.js
-- examples/webby/content/tips_and_tricks.txt
-- examples/webby/content/tutorial.txt
+- examples/webby/content/tips_and_tricks/index.txt
+- examples/webby/content/tutorial/index.txt
 - examples/webby/layouts/default.rhtml
 - examples/webby/tasks/create.rake
 - examples/webby/tasks/deploy.rake