webby 0.8.0 → 0.8.1

data/lib/webby/filters/outline.rb

@@ -1,4 +1,4 @@
-# $Id: outline.rb 181 2008-02-29 05:09:49Z tim_pease $
+# $Id: outline.rb 192 2008-03-08 16:27:29Z tim_pease $
 
 require 'hpricot'
 
@@ -27,10 +27,6 @@ module Filters
 class Outline
   include ERB::Util
 
-  # :stopdoc:
-  class Error < StandardError; end
-  # :startdoc:
-
   # call-seq:
   #    Outline.new( html )
   #
@@ -159,7 +155,7 @@ class Outline
     end
 
     if level < @base_level
-      raise Error, "heading tags are not in order, cannot outline"
+      raise ::Webby::Error, "heading tags are not in order, cannot outline"
     end
 
     if level == @cur_level

data/lib/webby/filters/tidy.rb

@@ -1,4 +1,4 @@
-# $Id: tidy.rb 181 2008-02-29 05:09:49Z tim_pease $
+# $Id: tidy.rb 192 2008-03-08 16:27:29Z tim_pease $
 
 require 'fileutils'
 require 'tempfile'
@@ -20,10 +20,6 @@ module Filters
 #
 class Tidy
 
-  # :stopdoc:
-  class Error < StandardError; end
-  # :startdoc:
-
   # call-seq:
   #    Tidy.new( html )
   #

data/lib/webby/helpers/coderay_helper.rb

@@ -1,4 +1,4 @@
-# $Id: coderay_helper.rb 155 2008-02-17 00:48:30Z tim_pease $
+# $Id: coderay_helper.rb 193 2008-03-09 02:32:37Z tim_pease $
 
 if try_require 'coderay'
 require 'enumerator'
@@ -43,16 +43,18 @@ module CodeRayHelper
       return
     end
 
-    lang = opts.getopt(:lang, :ruby).to_sym
+    defaults = ::Webby.site.coderay
+    lang = opts.getopt(:lang, defaults[:lang]).to_sym
 
     cr_opts = {}
     %w(line_numbers       to_sym
        line_number_start  to_i
        bold_every         to_i
        tab_width          to_i).each_slice(2) do |key,convert|
-      val = opts.getopt(key)
+      key = key.to_sym
+      val = opts.getopt(key, defaults[key])
       next if val.nil?
-      cr_opts[key.to_sym] = val.send(convert)
+      cr_opts[key] = val.send(convert)
     end
 
     #cr.swap(CodeRay.scan(text, lang).html(opts).div)

data/lib/webby/helpers/graphviz_helper.rb

@@ -1,4 +1,4 @@
-# $Id: graphviz_helper.rb 181 2008-02-29 05:09:49Z tim_pease $
+# $Id: graphviz_helper.rb 193 2008-03-09 02:32:37Z tim_pease $
 
 require 'fileutils'
 require 'tempfile'
@@ -6,10 +6,6 @@ require 'tempfile'
 module Webby::Helpers
 module GraphvizHelper
 
-  # :stopdoc:
-  class Error < StandardError; end
-  # :startdoc:
-
   # call-seq:
   #    GraphvizHelper.error_check( file )
   #
@@ -20,7 +16,7 @@ module GraphvizHelper
   def self.error_check( file )
     if ::File.size(file.path) != 0
       msg = "\n" << ::File.read(file.path).strip
-      raise Error, msg
+      raise ::Webby::Error, msg
     end
   end
 
@@ -77,21 +73,16 @@ module GraphvizHelper
     pos = buffer.length
     block.call(*args)
 
-    path = opts.getopt(:path)
-    cmd  = opts.getopt(:cmd, 'dot')
-    type = opts.getopt(:type, 'png')
+    defaults = ::Webby.site.graphviz
+    path = opts.getopt(:path, defaults[:path])
+    cmd  = opts.getopt(:cmd, defaults[:cmd])
+    type = opts.getopt(:type, defaults[:type])
     text = buffer[pos..-1].strip
     if text.empty?
       buffer[pos..-1] = ''
       return
     end
 
-    # ensure the requested graphviz command actually exists
-    %x[#{cmd} -V 2>&1]
-    unless 0 == $?.exitstatus
-      raise NameError, "'#{cmd}' not found on the path"
-    end
-
     # pull the name of the graph|digraph out of the DOT script
     name = text.match(%r/\A\s*(?:strict\s+)?(?:di)?graph\s+([A-Za-z_][A-Za-z0-9_]*)\s+\{/o)[1]
 

data/lib/webby/helpers/tex_img_helper.rb

@@ -1,16 +1,11 @@
-# $Id: tex_img_helper.rb 181 2008-02-29 05:09:49Z tim_pease $
+# $Id: tex_img_helper.rb 193 2008-03-09 02:32:37Z tim_pease $
 
 require Webby.libpath(*%w[webby stelan mktemp])
 require 'fileutils'
-require 'tempfile'
 
 module Webby::Helpers
 module TexImgHelper
 
-  # :stopdoc:
-  class Error < StandardError; end
-  # :startdoc:
-
   # The +tex2img+ method converts a a section of mathematical TeX script
   # into an image and embeds the resulting image into the page. The TeX
   # engine must be installed on your system along with the ImageMagick
@@ -36,8 +31,6 @@ module TexImgHelper
   #                    TeX color spec, or #aabbcc) [default is black]
   #    :resolution   : the desired resolution in dpi (HxV)
   #                    [default is 150x150]
-  #    :antialias    : if false, disables anti-aliasing in the resulting image
-  #                    [default is true]
   #
   #    the following options are passed as-is to the generated <img /> tag
   #    :style    : CSS styles to apply to the <img />
@@ -60,21 +53,16 @@ module TexImgHelper
       return
     end
 
-    # create a temporary file for holding any error messages
-    # from the graphviz program
-    err = Tempfile.new('graphviz_err')
-    err.close
-
-    path  = opts.getopt(:path)
-    type  = opts.getopt(:type, 'png')
-    bg    = opts.getopt(:bg, 'white')
-    fg    = opts.getopt(:fg, 'black')
-    res   = opts.getopt(:resolution, '150x150')
-    aa    = opts.getopt(:antialias, true)
+    defaults = ::Webby.site.tex2img
+    path = opts.getopt(:path, defaults[:path])
+    type = opts.getopt(:type, defaults[:type])
+    bg   = opts.getopt(:bg, defaults[:bg])
+    fg   = opts.getopt(:fg, defaults[:fg])
+    res  = opts.getopt(:resolution, defaults[:resolution])
 
-    # fix the color escaping
-    fg = TexImgHelper.tex_color(fg)
-    bg = TexImgHelper.tex_color(bg)
+    # fix color escaping
+    fg = fg =~ %r/^[a-zA-Z]+$/ ? fg : "\"#{fg}\""
+    bg = bg =~ %r/^[a-zA-Z]+$/ ? bg : "\"#{bg}\""
 
     # generate the image filename based on the path, graph name, and type
     # of image to generate
@@ -88,15 +76,21 @@ module TexImgHelper
     FileUtils.mkpath(::File.join(out_dir, path)) unless path.nil?
 
     tex = <<-TEX
-      \\documentclass[12pt]{article}
-      \\usepackage[usenames,dvipsnames]{color}
-      \\usepackage[dvips]{graphicx}
+      \\nonstopmode
+      \\documentclass{article}
+      \\usepackage[T1]{fontenc}
+      \\usepackage{amsmath,amsfonts,amssymb,wasysym,latexsym,marvosym,txfonts}
+      \\usepackage[pdftex]{color}
       \\pagestyle{empty}
-      \\pagecolor#{bg}
       \\begin{document}
-      {\\color#{fg}
+      \\fontsize{12}{24}
+      \\selectfont
+      \\color{white}
+      \\pagecolor{black}
+      \\[
       #{text}
-      }\\end{document}
+      \\]
+      \\end{document}
     TEX
     tex.gsub!(%r/\n\s+/, "\n").strip!
 
@@ -109,9 +103,14 @@ module TexImgHelper
       File.open('out.tex', 'w') {|fd| fd.puts tex}
       dev_null = test(?e, "/dev/null") ? "/dev/null" : "NUL:"
 
-      %x[latex -interaction=batchmode out.tex &> #{dev_null}]
-      %x[dvips -o out.eps -E out.dvi &> #{dev_null}]
-      %x[convert +adjoin #{aa ? '-antialias' : '+antialias'} -density #{res} out.eps #{out_file} &> #{dev_null}]
+      %x[pdflatex -interaction=batchmode out.tex &> #{dev_null}]
+
+      convert =  "\\( -density #{res} out.pdf -trim +repage \\) "
+      convert << "\\( +clone -fuzz 100% -fill #{fg} -opaque black \\) "
+      convert << "+swap -compose copy-opacity -composite "
+      convert << "\\( +clone -fuzz 100% -fill #{bg} -opaque white +matte \\) "
+      convert << "+swap -compose over -composite #{out_file}"
+      %x[convert #{convert} &> #{dev_null}]
     ensure
       Dir.chdir(pwd)
       FileUtils.rm_rf(tmpdir) if test(?e, tmpdir)
@@ -133,42 +132,10 @@ module TexImgHelper
 
     buffer[pos..-1] = out
     return
-  ensure
-  end
-
-  # call-seq:
-  #    TexImgHelper.tex_color( string )    => string
-  #
-  # Taken the given color _string_ and convert it to a TeX color spec. The
-  # input string can be either a RGB Hex value, a TeX color spec, or a color
-  # name.
-  #
-  #    tex_color( '#666666' )         #=> [rgb]{0.4,0.4,0.4}
-  #    tex_color( 'Tan' )             #=> {Tan}
-  #    tex_color( '[rgb]{1,0,0}' )    #=> [rgb]{1,0,0}
-  #
-  # This is an example of an invalid Hex RGB color -- they must contain six
-  # hexidecimal characters to be valid.
-  #
-  #    tex_color( '#333' )            #=> {#333}
-  #
-  def self.tex_color( color )
-    case color
-    when %r/^#([A-Fa-f0-9]{6})/o
-      hex = $1
-      rgb = []
-      hex.scan(%r/../) {|n| rgb << Float(n.to_i(16))/255.0}
-      "[rgb]{#{rgb.join(',')}}"
-    when %r/^[\{\[]/o
-      "{#{color}}"
-    else
-      color
-    end
   end
-
 end  # module TexImgHelper
 
-%x[latex --version 2>&1]
+%x[pdflatex --version 2>&1]
 if 0 == $?.exitstatus
   %x[convert --version 2>&1]
   if 0 == $?.exitstatus

data/lib/webby/helpers/ultraviolet_helper.rb

@@ -0,0 +1,74 @@
+# $Id: ultraviolet_helper.rb 190 2008-03-05 05:35:00Z tim_pease $
+
+# This code was provided by Guillaume Carbonneau -- http://radr.ca/
+# Many thanks for his support of Webby!
+
+if try_require 'uv'
+
+module Webby::Helpers
+module UltraVioletHelper
+
+  # The +uv+ method applies syntax highlighting to source code embedded
+  # in a webpage. The UltraViolet highlighting engine is used for the HTML
+  # markup of the source code. The page sections to be highlighted are given
+  # as blocks of text to the +uv+ method.
+  #
+  # Options can be passed to the UltraViolet engine via attributes in the
+  # +uv+ method.
+  #
+  #    <% uv( :lang => "ruby", :line_numbers => true ) do -%>
+  #    # Initializer for the class.
+  #    def initialize( string )
+  #      @str = stirng
+  #    end
+  #    <% end -%>
+  #    
+  # The supported UltraViolet options are the following:
+  #
+  #    :lang               : the language to highlight (ruby, c, html, ...)
+  #                          [defaults to 'ruby']
+  #    :line_numbers       : true or false [defaults to false]
+  #    :theme              : see list of available themes in ultraviolet
+  #                          [defaults to 'mac_classic']
+  #
+  # The defaults can be overridden for an entire site by changing the SITE.uv
+  # options hash in the Rakefile.
+  #
+  def uv( *args, &block )
+    opts = args.last.instance_of?(Hash) ? args.pop : {}
+
+    buffer = eval('_erbout', block.binding)
+    pos = buffer.length
+    block.call(*args)
+
+    text = buffer[pos..-1].strip
+    if text.empty?
+      buffer[pos..-1] = ''
+      return
+    end
+    
+    defaults = ::Webby.site.uv
+    lang = opts.getopt(:lang, defaults[:lang])
+    line_numbers = opts.getopt(:line_numbers, defaults[:line_numbers])
+    theme = opts.getopt(:theme, defaults[:theme])
+    
+    out = '<div class="UltraViolet">'
+    out << Uv.parse(text, "xhtml", lang, line_numbers, theme)
+    out << '</div>'
+
+    if @_cursor.remaining_filters.include? 'textile'
+      out.insert 0, "<notextile>\n"
+      out << "\n</notextile>"
+    end
+
+    buffer[pos..-1] = out
+    return
+  end
+end  # module UltraVioletHelper
+
+register(UltraVioletHelper)
+
+end  # module Webby::Helpers
+end  # try_require
+
+# EOF

data/lib/webby/helpers/url_helper.rb

@@ -1,4 +1,4 @@
-# $Id: url_helper.rb 175 2008-02-28 15:49:11Z tim_pease $
+# $Id: url_helper.rb 192 2008-03-08 16:27:29Z tim_pease $
 
 module Webby::Helpers
 
@@ -92,12 +92,14 @@ module UrlHelper
   #
   def link_to( name, *args )
     opts = Hash === args.last ? args.pop : {}
-    url = args.first
+    obj = args.first
     attrs = opts.delete(:attrs)
 
-    url = case url
+    url = case obj
       when String, Webby::Resources::Resource
-        self.url_for(url, opts)
+        self.url_for(obj, opts)
+      when ::Webby::Paginator::Page
+        self.url_for(obj.url, opts)
       when :back
         'javascript:history.back()'
       else
@@ -213,7 +215,8 @@ module UrlHelper
     if Webby::Resources::Resource === name
       p, name = name, nil
     elsif opts.empty? && name
-      p = @pages.find(Webby.site.find_by.to_sym => name)
+      opts[Webby.site.find_by.to_sym] = name
+      p = @pages.find(opts)
     else
       p = @pages.find(opts)
     end

data/lib/webby/link_validator.rb

@@ -0,0 +1,154 @@
+# $Id: link_validator.rb 189 2008-03-02 22:22:24Z tim_pease $
+
+require 'hpricot'
+require 'open-uri'
+
+module Webby
+
+# The Webby LinkValidator class is used to validate the hyperlinks of all
+# the HTML files in the output directory. By default, only links to other
+# pages in the output directory are checked. However, setting the
+# :external flag to +true+ will cause hyperlinks to external web sites to
+# be validated as well.
+#
+class LinkValidator
+
+  # A lazy man's method that will instantiate a new link validator and run
+  # the validations.
+  #
+  def self.validate( opts = {} )
+    new(opts).validate
+  end
+
+  attr_accessor :validate_externals
+
+  # call-seq:
+  #    LinkValidator.new( opts = {} )
+  #
+  # Creates a new LinkValidator object. The only supported option is the
+  # :external flag. When set to +true+, the link validator will also check
+  # out links to external websites. This is done by opening a connection to
+  # the remote site and pulling down the page specified in the hyperlink.
+  # Use with caution.
+  #
+  def initialize( opts = {} )
+    @log = Logging::Logger[self]
+
+    glob = ::File.join(::Webby.site.output_dir, '**', '*.html')
+    @files = Dir.glob(glob).sort
+    @attr_rgxp = %r/\[@(\w+)\]$/o
+
+    @validate_externals = opts.getopt(:external, false)
+    @valid_uris = ::Webby.site.valid_uris.flatten
+    @invalid_uris = []
+  end
+
+  # Iterate over all the HTML files in the output directory and validate the
+  # hyperlinks.
+  #
+  def validate
+    @files.each {|fn| check_file fn}
+  end
+
+  # Check the given file (identified by its filename {fn for short here}) by
+  # iterating through all the configured xpaths and validating that those
+  # hyperlinks ae valid.
+  #
+  def check_file( fn )
+    @log.info "validating #{fn}"
+
+    dir = ::File.dirname(fn)
+    @doc = Hpricot(::File.read(fn))
+
+    ::Webby.site.xpaths.each do |xpath|
+      @attr_name = nil
+
+      @doc.search(xpath).each do |element|
+        @attr_name ||= @attr_rgxp.match(xpath)[1]
+        uri = URI.parse(element.get_attribute(@attr_name))
+        validate_uri(uri, dir)
+      end
+    end
+    @doc = @attr_name = nil
+  end
+
+  # Validate the the page the _uri_ refers to actually exists. The directory
+  # of the current page being processed is needed in order to resolve
+  # relative paths. 
+  #
+  # If the _uri_ is a relative path, then the output directory is searched
+  # for the appropriate page. If the _uri_ is an absolute path, then the
+  # remote server is contacted and the page requested from the server. This
+  # will only take place if the LinkValidator was created with the :external
+  # flag set to true.
+  #
+  def validate_uri( uri, dir )
+    # for relative URIs, we can see if the file exists in the output folder
+    if uri.relative?
+      return validate_anchor(uri, @doc) if uri.path.empty?
+
+      path = if uri.path =~ %r/^\//
+          ::File.join(::Webby.site.output_dir, uri.path)
+        else
+          ::File.join(dir, uri.path)
+        end
+      path = ::File.join(path, 'index.html') if ::File.extname(path).empty?
+
+      uri_str = path.dup
+      (uri_str << '#' << uri.fragment) if uri.fragment
+      return if @valid_uris.include? uri_str
+
+      if test ?f, path
+        valid = if uri.fragment
+            validate_anchor(uri, Hpricot(::File.read(path)))
+          else true end
+        @valid_uris << uri_str if valid
+      else
+        @log.error "invalid URI '#{uri.to_s}'"
+      end
+
+    # if the URI responds to the open mehod, then try to access the URI
+    elsif uri.respond_to? :open
+      return unless @validate_externals
+      return if @valid_uris.include? uri.to_s
+
+      if @invalid_uris.include? uri.to_s
+        @log.error "could not open URI '#{uri.to_s}'"
+        return
+      end
+
+      begin
+        uri.open {|_| nil}
+        @valid_uris << uri.to_s
+      rescue Exception
+        @log.error "could not open URI '#{uri.to_s}'"
+        @invalid_uris << uri.to_s
+      end 
+
+    # otherwise, post a warning that the URI could not be validated
+    else
+      return if @valid_uris.include? uri.to_s
+      @log.warn "could not validate URI '#{uri.to_s}'"
+    end
+  end
+
+  # Validate that the anchor fragment of the URI exists in the given
+  # document. The document is an Hpricot document object.
+  #
+  # Returns +true+ if the anchor exists in the document and +false+ if it
+  # does not.
+  #
+  def validate_anchor( uri, doc )
+    return false if uri.fragment.nil?
+
+    anchor = '#' + uri.fragment
+    if doc.at(anchor).nil?
+      @log.error "invalid URI '#{uri.to_s}'"
+      false
+    else true end
+  end
+
+end  # class LinkValidator
+end  # module Webby
+
+# EOF

data/lib/webby/renderer.rb

@@ -1,4 +1,4 @@
-# $Id: renderer.rb 173 2008-02-27 02:58:43Z tim_pease $
+# $Id: renderer.rb 192 2008-03-08 16:27:29Z tim_pease $
 
 # Equivalent to a header guard in C/C++
 # Used to prevent the spec helper from being loaded more than once
@@ -24,7 +24,6 @@ class Renderer
   include ERB::Util
 
   # :stopdoc:
-  class Error < StandardError; end
   @@stack = []
   # :startdoc:
 
@@ -40,7 +39,7 @@ class Renderer
 
     loop {
       ::File.open(page.destination, 'w') do |fd|
-        fd.write renderer.layout_page
+        fd.write(renderer.__send__(:_layout_page))
       end
       break unless renderer.__send__(:_next_page)
     }
@@ -68,40 +67,6 @@ class Renderer
     @log = Logging::Logger[self]
   end
 
-  # call-seq:
-  #    layout_page    => string
-  #
-  # Apply the desired filters to the page and then render the filtered page
-  # into the desired layout. The filters to apply to the page are determined
-  # from the page's meta-data. The layout to use is also determined from the
-  # page's meta-data.
-  #
-  def layout_page
-    layouts = Resources.layouts
-    obj = @page
-    str = @page.render(self)
-
-    @@stack << @page.path
-    loop do
-      lyt = layouts.find :filename => obj.layout
-      break if lyt.nil?
-
-      @content, str = str, ::Webby::Resources::File.read(lyt.path)
-      str = _track_rendering(lyt.path) {
-        Filters.process(self, lyt, str)
-      }
-      @content, obj = nil, lyt
-    end
-
-    @@stack.pop if @page.path == @@stack.last
-    raise Error, "rendering stack corrupted" unless @@stack.empty?
-
-    str
-  rescue => err
-    @log.error "while rendering page '#{@page.path}'"
-    @log.error err
-  end
-
   # call-seq:
   #    render_page    => string
   #
@@ -136,11 +101,11 @@ class Renderer
         p = Resources.partials.find(
             :filename => fn, :in_directory => @page.dir ) rescue nil
         p ||= Resources.partials.find(:filename => fn)
-        raise Error, "could not find partial '#{part}'" if p.nil?
+        raise ::Webby::Error, "could not find partial '#{part}'" if p.nil?
         p
       when ::Webby::Resources::Partial
         part
-      else raise Error, "expecting a partial or a partial name" end
+      else raise ::Webby::Error, "expecting a partial or a partial name" end
 
     _track_rendering(part.path) {
       Filters.process(self, part, ::Webby::Resources::File.read(part.path))
@@ -181,6 +146,52 @@ class Renderer
 
   private
 
+  # call-seq:
+  #    _layout_page    => string
+  #
+  # Apply the desired filters to the page and then render the filtered page
+  # into the desired layout. The filters to apply to the page are determined
+  # from the page's meta-data. The layout to use is also determined from the
+  # page's meta-data.
+  #
+  def _layout_page
+    @content = @page.render(self)
+
+    _track_rendering(@page.path) {
+      _render_layout_for(@page)
+    }
+    raise ::Webby::Error, "rendering stack corrupted" unless @@stack.empty?
+
+    @content
+  rescue ::Webby::Error => err
+    @log.error "while rendering page '#{@page.path}'"
+    @log.error err.message
+  rescue => err
+    @log.error "while rendering page '#{@page.path}'"
+    @log.fatal err
+    exit 1
+  ensure
+    @content = nil
+    @@stack.clear
+  end
+
+  # call-seq:
+  #    _render_layout_for( resource )
+  #
+  # Render the layout for the given resource. If the resource does not have
+  # a layout, then this method returns immediately.
+  #
+  def _render_layout_for( res )
+    lyt = Resources.layouts.find :filename => res.layout
+    return if lyt.nil?
+
+    _track_rendering(lyt.path) {
+      @content = Filters.process(
+          self, lyt, ::Webby::Resources::File.read(lyt.path))
+      _render_layout_for(lyt)
+    }
+  end
+
   # call-seq:
   #    _next_page    => true or false
   #
@@ -222,7 +233,7 @@ class Renderer
       msg = "rendering loop detected for '#{path}'\n"
       msg << "    current rendering stack\n\t"
       msg << @@stack.join("\n\t")
-      raise Error, msg
+      raise ::Webby::Error, msg
     end
 
     yield

data/lib/webby/resources/page.rb

@@ -1,4 +1,4 @@
-# $Id: page.rb 167 2008-02-24 00:59:54Z tim_pease $
+# $Id: page.rb 191 2008-03-05 19:07:50Z tim_pease $
 
 require Webby.libpath(*%w[webby resources resource])
 
@@ -53,7 +53,7 @@ class Page < Resource
   #
   def number=( num )
     @number = num
-    @dest = nil
+    @url = @dest = nil
   end
 
   # call-seq: