webby 0.9.3 → 0.9.4

data/lib/webby/builder.rb

@@ -74,10 +74,8 @@ class Builder
     def new_page_info
       args = Webby.site.args
 
-      if args.raw.empty?
-        task_name = Rake.application.top_level_tasks.first
-        raise "Usage:  webby #{task_name} path"
-      end
+      # TODO: maybe even get rid of this method altogether
+      raise "Usage:  webby #{args.rake.first} 'path'" if args.raw.empty?
 
       [args.page, args.title, args.dir]
     end
@@ -131,7 +129,7 @@ class Builder
       FileUtils.mkdir output_dir
     end
 
-    load_files if opts[:load_files]
+    ::Webby.load_files if opts[:load_files]
 
     Resources.pages.each do |page|
       unless page.dirty? or opts[:rebuild]
@@ -157,15 +155,9 @@ class Builder
     nil
   end
 
-  # Scan the <code>layouts/</code> folder and the <code>content/</code>
-  # folder and create a new Resource object for each file found there.
-  #
   def load_files
-    ::Find.find(layout_dir, content_dir) do |path|
-      next unless test ?f, path
-      next if path =~ ::Webby.exclude
-      Resources.new path
-    end
+    ::Webby.deprecated "load_files", "it is being replaced by the Webby#load() method"
+    ::Webby.load_files
   end
 
   %w(output_dir layout_dir content_dir).each do |key|

data/lib/webby/config.rb

@@ -0,0 +1,172 @@
+# These are the main configuration options for Webby. Options for specific
+# filters and helpers are defined in those files. Even a few of the rake
+# tasks in the "examples" folder have their own configuration options
+# defined.
+#
+# The nice thing about Loquacious configurations is that all these options
+# can be defined where they are used, but the descriptions can be viewed by
+# the user in one handy page.
+
+Loquacious.configuration_for(:webby) {
+
+  desc 'The generated website will be output to this directory.'
+  output_dir 'output'
+
+  desc <<-__
+    The directory containg the main site content - pages, partials, css
+    stylesheets, etc.
+  __
+  content_dir 'content'
+
+  desc 'The directory containing the layout files.'
+  layout_dir 'layouts'
+
+  desc <<-__
+    The directory where page templtes can be found. These templates are used
+    by the 'webby create' command to define the boiler-plate for new pages
+    (things like the meta-data or standard text).
+  __
+  template_dir 'templates'
+
+  desc <<-__
+    This is an array of regular expression patterns that will exclude files
+    from webby processing. The patterns will be joined using the regular
+    expression OR operator '|'.
+  __
+  exclude %w{tmp$ bak$ ~$ CVS \.svn}
+
+  desc <<-__
+    A set of default meta-data values that are added to every page rendered
+    by webby. Specific values in the page override the default values
+    defined here. For example, you could define a default set of filters
+    |
+    |   SITE.page_defaults = {
+    |     'layout' => 'default',
+    |     'filter' => ['erb', 'textile']
+    |   }
+    |
+    Now, every page will be run through the ERB filter and then the
+    Textile filter. Specific pages can override the set of filters or omit
+    them altogether as needed.
+  __
+  page_defaults({
+    'layout' => 'default'
+  })
+
+  desc <<-__
+    Defines the default page attribute that will be used by the
+    'link_to_page' method to find other pages in the site. If this value
+    is set to :title, then the title found in the page meta-data is
+    searched for a match. If this value is set to :filename, then the
+    filenames of pages are search for a match.
+
+    This value can be overridden on a case by case basis when the
+    'link_to_page' method is called.
+  __
+  find_by :title
+
+  desc <<-__
+    Using the 'webby create' task, new pages can either be created as a
+    normal page or as an index page in it's own directory. The latter
+    option allows your pages to have "nice" URLs:
+    |
+    |   foo/bar/my-new-post.html    <-- 'page'
+    |   foo/bar/my-new-post/        <-- 'directory'
+    |
+    The two options supported by the 'create_mode' are either 'page'
+    or 'directory'.
+  __
+  create_mode 'page'
+
+  desc <<-__
+    When the 'webby create' task is used to create a new page in your site,
+    webby will automatically open your favorite editor. Use this option to
+    define which editor webby will start. Set this option to nil if you do
+    not want webby to launch an editor when you create new pages.
+
+    The default is taken from the environment as either 'WEBBY_EDITOR' or
+    'EDITOR', whichever is defined.
+  __
+  editor ENV['WEBBY_EDITOR'] || ENV['EDITOR']
+
+  desc <<-__
+    This flag determines whether or not the internal web server is launched
+    when the autobuild loop is running. The default is to launch the web
+    server. Set to false to disable.
+  __
+  use_web_server true
+
+  desc <<-__
+    Defines the port number the internal web server will use when the
+    autobuild loop is running.
+  __
+  web_port 4331
+
+  desc <<-__
+    The username that will be used when publishing a site to the remote host.
+    Login to the remote host will take the form 'user@host' where both 'user'
+    and 'host' are configuration options.
+
+    The default is taken from the environment as either 'USER' or
+    'USERNAME', whichever is defined.
+  __
+  user ENV['USER'] || ENV['USERNAME']
+
+  desc <<-__
+    The hostname that will be used when publishing a site to the remote host.
+    Login to the remote host will take the form 'user@host' where both 'user'
+    and 'host' are configuration options.
+  __
+  host 'example.com'
+
+  desc <<-__
+    The destination directory on the remote host where the site will
+    be published.
+  __
+  remote_dir '/dev/null'
+
+  desc <<-__
+    Arguments that will be passed to the rysnc command when deploying the
+    site to the remote host. This array of arguments will be joined together
+    by spaces.
+  __
+  rsync_args %w(-av)
+
+  desc <<-__
+    The list of URIs that will automatically pass validation when the webby
+    validate task is run.
+  __
+  valid_uris []
+
+  desc <<-__
+    The base URL of the site. This value is used by the 'basepath' filter to
+    replace leading slashes in URIs with this base value. The URIs to replace
+    are identified by the 'xpaths' option.
+  __
+  base nil
+
+  desc <<-__
+    The basepath filter is used to replace leading slashes in URIs with the
+    text from the 'base' option. Only those URIs identified by the XPaths
+    defined here will be altered. You can add to or remove XPaths from this
+    list depending on your needs.
+  __
+  xpaths %w{
+      /html/head//base[@href]
+      /html/head//link[@href]
+      //script[@src]
+      /html/body[@background]
+      /html/body//a[@href]
+      /html/body//object[@data]
+      /html/body//img[@src]
+      /html/body//area[@href]
+      /html/body//form[@action]
+      /html/body//input[@src]
+  }
+  # other possible XPaths to include for base path substitution
+  #   /html/body//object[@usemap]
+  #   /html/body//img[@usemap]
+  #   /html/body//input[@usemap]
+}
+
+# EOF

data/lib/webby/filters.rb

@@ -70,6 +70,8 @@ module Filters
         result = handler.call(*args)
         @processed += 1
         result
+      rescue StandardError => err
+        raise ::Webby::Error, "#{filter} filter error: #{err.message.inspect}"
       end
       
     end  # class Cursor

data/lib/webby/filters/haml.rb

@@ -2,8 +2,21 @@
 # Render text via the Haml library
 if try_require('haml', 'haml')
 
+  Loquacious.configuration_for(:webby) {
+    desc <<-__
+      A hash of options that will be passed to the Haml::Engine when procesing
+      content through the 'haml' filter. See the Haml rdoc documentation for
+      the list of available options.
+
+      Note: webby will set the :filename to the current page being rendered.
+    __
+    haml_options Hash.new
+  }
+
   Webby::Filters.register :haml do |input, cursor|
     opts = ::Webby.site.haml_options.merge(cursor.page.haml_options || {})
+    opts = opts.symbolize_keys
+    opts.merge!(:filename => cursor.page.destination)
     b = cursor.renderer.get_binding
     Haml::Engine.new(input, opts).to_html(b)
   end

data/lib/webby/filters/maruku.rb

@@ -0,0 +1,16 @@
+
+# Render text via markdown using the Maruku library.
+if try_require('maruku', 'maruku')
+
+  Webby::Filters.register :maruku do |input|
+    Maruku.new(input).to_html
+  end
+
+# Otherwise raise an error if the user tries to use maruku
+else
+  Webby::Filters.register :maruku do |input|
+    raise Webby::Error, "'maruku' must be installed to use the maruku filter"
+  end
+end
+
+# EOF

data/lib/webby/filters/outline.rb

@@ -175,7 +175,7 @@ class Outline
 
     lbl = label
     if numbering?
-      elem.children.first.before {tag!(:span, lbl, :class => 'heading-num')}
+      elem.children.first.before %Q{<span class="heading-num">#{lbl}</span>}
     end
     elem['id'] = "h#{lbl.tr('.','_')}" if elem['id'].nil?
 

data/lib/webby/filters/sass.rb

@@ -2,8 +2,22 @@
 # Render text via the Sass library (part of Haml)
 if try_require('sass', 'haml')
 
+  Loquacious.configuration_for(:webby) {
+    desc <<-__
+      A hash of options that will be passed to the Sass::Engine when procesing
+      content through the 'sass' filter. See the Sass rdoc documentation for
+      the list of available options (par of the haml gem).
+
+      Note: webby will set the :filename to the current page being rendered.
+    __
+    sass_options Hash.new
+  }
+
   Webby::Filters.register :sass do |input, cursor|
     opts = ::Webby.site.sass_options.merge(cursor.page.sass_options || {})
+    opts = opts.symbolize_keys
+    opts.merge!(:filename => cursor.page.destination)
+    opts[:style] = opts[:style].to_sym if opts.include? :style
     Sass::Engine.new(input, opts).render
   end
 

data/lib/webby/filters/slides.rb

@@ -35,9 +35,9 @@ class Slides
   def filter
     result = []
 
-    @str.split(%r/\<h1\>/i).each do |slide|
+    @str.split(%r/\<h1/i).each do |slide|
       next if slide.strip.empty?
-      result << START_SLIDE << '<h1>' << slide << END_SLIDE
+      result << START_SLIDE << '<h1' << slide << END_SLIDE
     end
 
     result.join

data/lib/webby/filters/tidy.rb

@@ -1,6 +1,11 @@
 require 'fileutils'
 require 'tempfile'
 
+Loquacious.configuration_for(:webby) {
+  desc "Options passed to the 'tidy' program when the tidy filter is used"
+  tidy_options '-indent -wrap 80'
+}
+
 module Webby
 module Filters
 

data/lib/webby/helpers/coderay_helper.rb

@@ -1,6 +1,30 @@
 if try_require 'coderay'
 require 'enumerator'
 
+Loquacious.configuration_for(:webby) {
+  desc <<-__
+    Options for CodeRay syntax highlighting. See the CodeRay home page
+    (http://coderay.rubychan.de/) for more information about the available
+    options.
+  __
+  coderay {
+    desc 'The language being highlighted (given as a symbol).'
+    lang :ruby
+
+    desc 'Include line numbers in :table, :inline, :list or nil (no line numbers).'
+    line_numbers nil
+
+    desc 'Where to start line number counting.'
+    line_number_start 1
+
+    desc 'Make every N-th number appear bold.'
+    bold_every 10
+
+    desc 'Tabs will be converted into this number of space characters.'
+    tab_width 8
+  }
+}
+
 module Webby::Helpers
 module CodeRayHelper
 
@@ -35,7 +59,7 @@ module CodeRayHelper
     return if text.empty?
 
     defaults = ::Webby.site.coderay
-    lang = opts.getopt(:lang, defaults[:lang]).to_sym
+    lang = opts.getopt(:lang, defaults.lang).to_sym
 
     cr_opts = {}
     %w(line_numbers       to_sym
@@ -49,9 +73,9 @@ module CodeRayHelper
     end
 
     #cr.swap(CodeRay.scan(text, lang).html(opts).div)
-    out = '<div class="CodeRay"><pre>'
+    out = %Q{<div class="CodeRay">\n<pre>}
     out << ::CodeRay.scan(text, lang).html(cr_opts)
-    out << '</pre></div>'
+    out << %Q{</pre>\n</div>}
 
     # put some guards around the output (specifically for textile)
     out = _guard(out)

data/lib/webby/helpers/graphviz_helper.rb

@@ -1,6 +1,23 @@
 require 'fileutils'
 require 'tempfile'
 
+Loquacious.configuration_for(:webby) {
+  desc 'Options for graphviz processing.'
+  graphviz {
+    desc 'The path in the output folder where images are stored.'
+    path nil
+
+    desc <<-__
+      The graphviz command used to render the images.
+      (dot, neato, twopi, circo, fdp)
+    __
+    cmd 'dot'
+
+    desc 'The type of output image to generate (png, jpg, gif).'
+    type 'png'
+  }
+}
+
 module Webby::Helpers
 module GraphvizHelper
 
@@ -71,9 +88,9 @@ module GraphvizHelper
     err.close
 
     defaults = ::Webby.site.graphviz
-    path = opts.getopt(:path, defaults[:path])
-    cmd  = opts.getopt(:cmd, defaults[:cmd])
-    type = opts.getopt(:type, defaults[:type])
+    path = opts.getopt(:path, defaults.path)
+    cmd  = opts.getopt(:cmd, defaults.cmd)
+    type = opts.getopt(:type, defaults.type)
 
     # 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,6 +1,26 @@
 require Webby.libpath(*%w[webby stelan mktemp])
 require 'fileutils'
 
+Loquacious.configuration_for(:webby) {
+  desc "Options for processing TeX math formula into images."
+  tex2img {
+    desc 'Where generated images will be stored.'
+    path nil
+
+    desc 'The type of image to generate (png, jpeg, gif).'
+    type 'png'
+
+    desc 'The background color of the image (color name, TeX color spec, or #aabbcc)'
+    bg 'white'
+
+    desc 'The foreground color of the image (color name, TeX color spec, or #aabbcc)'
+    fg 'black'
+
+    desc 'The desired resolution in dpi (HxV)'
+    resolution '150x150'
+  }
+}
+
 module Webby::Helpers
 module TexImgHelper
 
@@ -45,11 +65,11 @@ module TexImgHelper
     return if text.empty?
 
     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])
+    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 color escaping
     fg = fg =~ %r/^[a-zA-Z]+$/ ? fg : "\"#{fg}\""