TwP-webby 0.9.2 → 0.9.3

data/History.txt

@@ -1,3 +1,16 @@
+== 0.9.3 / 2008-10-08
+
+* 4 minor enhancements
+  - Added a "wikiwords" filter to process [[text]] as links to other pages
+    (thanks to Paul)
+  - Added colorization to the output text (facets gem required)
+  - Replaced the Heel webserver with webrick
+  - Special windows version with windows line endings in generated files
+* 2 bug fixes
+  - Fixed a bug on Windows where line endings were messing with meta-data
+  - The paginator was not linking correctly back to the first page from
+    subsequent pages in a list
+
 == 0.9.2 / 2008-09-11
 
 * 1 bug fix

data/Manifest.txt

@@ -64,6 +64,7 @@ examples/webby/content/release-notes/index.txt
 examples/webby/content/release-notes/rel-0-9-0/index.txt
 examples/webby/content/release-notes/rel-0-9-1/index.txt
 examples/webby/content/release-notes/rel-0-9-2/index.txt
+examples/webby/content/release-notes/rel-0-9-3/index.txt
 examples/webby/content/robots.txt
 examples/webby/content/script/jquery.corner.js
 examples/webby/content/script/jquery.js
@@ -103,7 +104,6 @@ examples/website/layouts/default.txt
 examples/website/lib/breadcrumbs.rb
 examples/website/templates/_partial.erb
 examples/website/templates/page.erb
-examples/website/templates/presentation.erb
 lib/webby.rb
 lib/webby/apps.rb
 lib/webby/apps/generator.rb
@@ -125,6 +125,7 @@ lib/webby/filters/sass.rb
 lib/webby/filters/slides.rb
 lib/webby/filters/textile.rb
 lib/webby/filters/tidy.rb
+lib/webby/filters/wiki_words.rb
 lib/webby/helpers.rb
 lib/webby/helpers/capture_helper.rb
 lib/webby/helpers/coderay_helper.rb
@@ -133,6 +134,7 @@ lib/webby/helpers/tag_helper.rb
 lib/webby/helpers/tex_img_helper.rb
 lib/webby/helpers/ultraviolet_helper.rb
 lib/webby/helpers/url_helper.rb
+lib/webby/journal.rb
 lib/webby/link_validator.rb
 lib/webby/renderer.rb
 lib/webby/resources.rb
@@ -145,53 +147,61 @@ lib/webby/resources/resource.rb
 lib/webby/resources/static.rb
 lib/webby/stelan/mktemp.rb
 lib/webby/stelan/paginator.rb
-lib/webby/stelan/spawner.rb
 lib/webby/tasks/build.rake
 lib/webby/tasks/create.rake
 lib/webby/tasks/deploy.rake
 lib/webby/tasks/growl.rake
-lib/webby/tasks/heel.rake
 lib/webby/tasks/validate.rake
 spec/core_ext/hash_spec.rb
 spec/core_ext/string_spec.rb
 spec/core_ext/time_spec.rb
-spec/data/Sitefile
-spec/data/content/_partial.txt
-spec/data/content/css/coderay.css
-spec/data/content/css/site.css
-spec/data/content/css/tumblog.css
-spec/data/content/images/tumblog/permalink.gif
-spec/data/content/images/tumblog/rss.gif
-spec/data/content/index.txt
-spec/data/content/photos.txt
-spec/data/content/tumblog/200806/the-noble-chicken/index.txt
-spec/data/content/tumblog/200807/historical-perspectives-on-the-classic-chicken-joke/index.txt
-spec/data/content/tumblog/200807/mad-city-chickens/index.txt
-spec/data/content/tumblog/200807/the-wisdom-of-the-dutch/index.txt
-spec/data/content/tumblog/200807/up-a-tree/index.txt
-spec/data/content/tumblog/index.txt
-spec/data/content/tumblog/rss.txt
 spec/data/hooligans/bad_meta_data_1.txt
 spec/data/hooligans/bad_meta_data_2.txt
-spec/data/layouts/default.txt
-spec/data/layouts/tumblog/default.txt
-spec/data/layouts/tumblog/post.txt
-spec/data/lib/breadcrumbs.rb
-spec/data/lib/tumblog_helper.rb
-spec/data/tasks/tumblog.rake
-spec/data/templates/_partial.erb
-spec/data/templates/atom_feed.erb
-spec/data/templates/page.erb
-spec/data/templates/presentation.erb
-spec/data/templates/tumblog/conversation.erb
-spec/data/templates/tumblog/link.erb
-spec/data/templates/tumblog/photo.erb
-spec/data/templates/tumblog/post.erb
-spec/data/templates/tumblog/quote.erb
+spec/data/outline/basic.out
+spec/data/outline/basic.txt
+spec/data/outline/no_clobber.out
+spec/data/outline/numbering.out
+spec/data/outline/numbering_only.out
+spec/data/outline/toc_range_1.out
+spec/data/outline/toc_range_2.out
+spec/data/outline/toc_style.out
+spec/data/site/Sitefile
+spec/data/site/content/_partial.txt
+spec/data/site/content/css/coderay.css
+spec/data/site/content/css/site.css
+spec/data/site/content/css/tumblog.css
+spec/data/site/content/images/tumblog/permalink.gif
+spec/data/site/content/images/tumblog/rss.gif
+spec/data/site/content/index.txt
+spec/data/site/content/photos.txt
+spec/data/site/content/tumblog/200806/the-noble-chicken/index.txt
+spec/data/site/content/tumblog/200807/historical-perspectives-on-the-classic-chicken-joke/index.txt
+spec/data/site/content/tumblog/200807/mad-city-chickens/index.txt
+spec/data/site/content/tumblog/200807/the-wisdom-of-the-dutch/index.txt
+spec/data/site/content/tumblog/200807/up-a-tree/index.txt
+spec/data/site/content/tumblog/index.txt
+spec/data/site/content/tumblog/rss.txt
+spec/data/site/layouts/default.txt
+spec/data/site/layouts/tumblog/default.txt
+spec/data/site/layouts/tumblog/post.txt
+spec/data/site/lib/breadcrumbs.rb
+spec/data/site/lib/tumblog_helper.rb
+spec/data/site/tasks/tumblog.rake
+spec/data/site/templates/_partial.erb
+spec/data/site/templates/atom_feed.erb
+spec/data/site/templates/page.erb
+spec/data/site/templates/presentation.erb
+spec/data/site/templates/tumblog/conversation.erb
+spec/data/site/templates/tumblog/link.erb
+spec/data/site/templates/tumblog/photo.erb
+spec/data/site/templates/tumblog/post.erb
+spec/data/site/templates/tumblog/quote.erb
 spec/spec.opts
 spec/spec_helper.rb
 spec/webby/apps/generator_spec.rb
 spec/webby/apps/main_spec.rb
+spec/webby/filters/basepath_spec.rb
+spec/webby/filters/outline_spec.rb
 spec/webby/filters/textile_spec.rb
 spec/webby/helpers/capture_helper_spec.rb
 spec/webby/renderer_spec.rb

data/Rakefile

@@ -14,7 +14,7 @@ PROJ.url = 'http://webby.rubyforge.org/'
 PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
 PROJ.rubyforge.name = 'webby'
 PROJ.version = Webby::VERSION
-PROJ.release_name = 'Gallus Gallus Toothicus ++'
+PROJ.release_name = 'Bill Gates Alien Love Child'
 
 PROJ.ruby_opts = %w[-W0]
 PROJ.exclude << %w(^examples/[^/]+/output ^tasks/archive ^tags$ ^webby.gemspec$)
@@ -40,8 +40,8 @@ TwP
 ANN
 
 depend_on 'directory_watcher'
-depend_on 'heel'
 depend_on 'hpricot', '= 0.6.0'
+depend_on 'launchy'
 depend_on 'logging'
 depend_on 'rake'
 depend_on 'rspec'

data/bin/webby

@@ -1,5 +1,38 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+require 'logging'
+
+::Logging.configure {
+  logger('Webby') {
+    level      :info
+    appenders  'stdout'
+  }
+
+  logger('Webby::Journal') {
+    level      :info
+    additive   false
+    appenders  'journal'
+  }
+
+  appender('stdout') {
+    type   'Stdout'
+    layout {
+      type          'Pattern'
+      pattern       "[%d] %5l: %m\n"
+      date_pattern  "%H:%M:%S"
+    }
+  }
+
+  appender('journal') {
+    type  'Stdout'
+    layout {
+      type     'Pattern'
+      pattern  "%m\n"
+    }
+  }
+}
+
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib webby]))
 

data/bin/webby-gen

@@ -1,5 +1,38 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+require 'logging'
+
+::Logging.configure {
+  logger('Webby') {
+    level      :info
+    appenders  'stdout'
+  }
+
+  logger('Webby::Journal') {
+    level      :info
+    additive   false
+    appenders  'journal'
+  }
+
+  appender('stdout') {
+    type   'Stdout'
+    layout {
+      type          'Pattern'
+      pattern       "[%d] %5l: %m\n"
+      date_pattern  "%H:%M:%S"
+    }
+  }
+
+  appender('journal') {
+    type  'Stdout'
+    layout {
+      type     'Pattern'
+      pattern  "%m\n"
+    }
+  }
+}
+
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib webby]))
 

data/examples/presentation/content/presentation/s5/print.css

@@ -1 +1,25 @@
-/* The following rule is necessary to have all slides appear in print! DO NOT REMOVE IT! */
+/* The following rule is necessary to have all slides appear in print! DO NOT REMOVE IT! */
+.slide, ul {page-break-inside: avoid; visibility: visible !important;}
+h1 {page-break-after: avoid;}
+
+body {font-size: 12pt; background: white;}
+* {color: black;}
+
+#slide0 h1 {font-size: 200%; border: none; margin: 0.5em 0 0.25em;}
+#slide0 h3 {margin: 0; padding: 0;}
+#slide0 h4 {margin: 0 0 0.5em; padding: 0;}
+#slide0 {margin-bottom: 3em;}
+
+h1 {border-top: 2pt solid gray; border-bottom: 1px dotted silver;}
+.extra {background: transparent !important;}
+div.extra, pre.extra, .example {font-size: 10pt; color: #333;}
+ul.extra a {font-weight: bold;}
+p.example {display: none;}
+
+#header {display: none;}
+#footer h1 {margin: 0; border-bottom: 1px solid; color: gray; font-style: italic;}
+#footer h2, #controls {display: none;}
+
+/* The following rule keeps the layout stuff out of print.  Remove at your own risk! */
+.layout, .layout * {display: none !important;}
+

data/examples/webby/content/release-notes/rel-0-9-3/index.txt

@@ -0,0 +1,47 @@
+---
+title:      Release 0.9.3
+created_at: 2008-10-08 21:22:41.217238 -06:00
+filter:
+  - erb
+  - textile
+release_name: Bill Gates Alien Love Child
+---
+h2. <%= h(@page.title) %>
+
+Release 0.9.3 adds several new features and fixes a few bugs. The two most significant features are a "wikiwords" filter and a special webby gem for the windows platform. See below for more information.
+
+* 4 minor enhancements
+** Added a "wikiwords" filter to process [[text]] as links to other pages (thanks to Paul)
+** Added colorization to the output text (facets gem required)
+** Replaced the Heel webserver with webrick
+** Special windows version with windows line endings in generated files
+* 2 bug fixes
+** Fixed a bug on Windows where line endings were messing with meta-data
+** The paginator was not linking correctly back to the first page from subsequent pages in a list
+
+h3. Wiki Words
+
+Wiki Words provide a convenient way to link to other pages in a site based on the page titles. Page titles surrounded by double brackets will be converted into a link to that particular page.
+
+<pre>
+<%= Webby::YAML_SEP %> 
+title:      Special Report
+created_at: 2008-10-08 21:22:41.217238 -06:00
+filter:
+  - wikiwords
+  - textile
+<%= Webby::YAML_SEP %> 
+h1. Special Report
+
+This page is a special report that links to some [[Other Page]] in the site and
+offers a little more information. You can find out more in the [[Reference]]
+page, too.
+</pre>
+
+So, in the example above two links will be generated. One will link to the "Other Page" and the second will link to the "Reference" page.
+
+h3. Windows Support
+
+This release also fixes a few issues with webby on the windows platform. Both issues concern windows line endings versus UNIX line endings in files. The code that parses meta-data has been updated to be line ending agnostic -- so no need to use UNIX line endings in the windows world.
+
+The second issue is a windows specific version of the webby gem. This gem has the template site files converted to the windows line ending style. So when a site is created using the webby-gen command, the resulting files should be in the native windows format.

data/lib/webby/apps/generator.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'optparse'
+require 'forwardable'
 
 module Webby::Apps
 
@@ -9,6 +10,7 @@ module Webby::Apps
 #
 
 class Generator
+  extend Forwardable
 
   # Create a new Generator instance and run the +webby+ application given the
   # command line _args_.
@@ -22,10 +24,34 @@ class Generator
 
   # Initialize a new generator object.
   #
-  def initialize
+  def initialize( output = $stdout, input = $stdin )
     @options = {}
     @site = @template = nil
-    @stdout, @stdin = $stdout, $stdin
+    @output, @input = output, input
+    @journal = journal
+  end
+
+  def_delegators :@journal,
+                 :exists, :create, :force, :skip, :identical
+
+  # Writes the given objects to the output destination. Each object is
+  # followed by a newline unless the object is a string with a newline
+  # already at the end.
+  #
+  def puts( *args )
+    @output.puts(*args)
+  end
+
+  # Writes the given objects to the output destination.
+  #
+  def print( *args )
+    @output.print(*args)
+  end
+
+  # Reads a line text frim the input source.
+  #
+  def gets
+    @input.gets
   end
 
   # Run the generator executing the commands specified by the user on the
@@ -60,18 +86,18 @@ class Generator
     opts.on('-t', '--templates', 'list available templates') {
       ary = templates.map {|t| ::File.basename(t)}
       ary.delete 'webby'
-      @stdout.puts "\nAvailable Templates"
-      @stdout.puts "    #{ary.join(', ')}"
-      @stdout.puts
+      puts "\nAvailable Templates"
+      puts "    #{ary.join(', ')}"
+      puts
       exit
     }
 
     opts.separator ''
     opts.separator 'common options:'
 
-    opts.on( '-h', '--help', 'show this message' ) {@stdout.puts opts; exit}
+    opts.on( '-h', '--help', 'show this message' ) {puts opts; exit}
     opts.on( '--version', 'show version' ) do
-      @stdout.puts "Webby #{::Webby::VERSION}"
+      puts "Webby #{::Webby::VERSION}"
       exit
     end
 
@@ -87,13 +113,13 @@ class Generator
 
     # exit if comand line args are missing
     if site.nil? or tmpl.nil?
-      @stdout.puts opts
+      puts opts
       exit 1
     end
 
     templates.each {|t| self.template = t if t =~ %r/\/#{tmpl}$/}
     if template.nil?
-      @stdout.puts opts
+      puts opts
       abort "Could not find template '#{tmpl}'"
     end
 
@@ -184,46 +210,16 @@ class Generator
     end
     return if pretend?
 
-    if WINDOWS then win_line_endings(src, dst)
-    else FileUtils.cp(src, dst) end
-  end
-
-  # Copy the file from the _src_ location to the _dst_ location and
-  # transform the line endings to the windows "\r\n" format.
-  #
-  def win_line_endings( src, dst )
-    case ::File.extname(src)
-    when *%w[.png .gif .jpg .jpeg]
-      FileUtils.cp src, dst
-    else
-      ::File.open(dst,'w') do |fd|
-        ::File.foreach(src, "\n") do |line|
-          line.tr!("\r\n",'')
-          fd.puts line
-        end
-      end
-    end
-  end
-
-  %w[exists create force skip identical].each do |m|
-    class_eval "def #{m}( msg ) message('#{m}', msg); end"
-  end
-
-  # Print the given message and message type to stdout.
-  #
-  def message( type, msg )
-    msg = msg.sub(%r/#{site}\/?/, '')
-    return if msg.empty?
-    @stdout.puts "%13s  %s" % [type, msg]
+    FileUtils.cp(src, dst)
   end
 
   # Prints an abort message to the screen and then exits the Ruby
   # interpreter. A non-zero return code is used to indicate an error.
   #
   def abort( msg )
-    @stdout.puts "\nAborting!"
-    @stdout.puts "    #{msg}"
-    @stdout.puts
+    puts "\nAborting!"
+    puts "    #{msg}"
+    puts
     exit 1
   end
 
@@ -254,8 +250,6 @@ class Generator
   # Returns +false+ if this is not the case.
   #
   def identical?( src, dst )
-    # FIXME: this most likely won't work on windows machines
-    #        because the line endings are modified when the site is gnerated
     source      = IO.read(src)
     destination = IO.read(dst)
     source == destination
@@ -265,9 +259,8 @@ class Generator
   #
   def force_file_collision?( dst )
     dst = dst.sub(%r/#{site}\/?/, '')
-    @stdout.print "overwrite #{dst}? [(Y)es (n)o (q)uit] "
-    @stdout.flush
-    case @stdin.gets
+    print "overwrite #{dst}? [(Y)es (n)o (q)uit] "
+    case gets
       when %r/q/i  then abort 'user asked to quit'
       when %r/n/i  then :skip
       when %r/y/i  then :force

data/lib/webby/apps/main.rb

@@ -12,10 +12,13 @@ class Main
     self.new.run args
   end
 
+  attr_reader :cmd_line_options
+
   # Create a new Main webby object for building websites.
   #
   def initialize
     @stdout = $stdout
+    @cmd_line_options = {}
   end
 
   # Runs the main webby application. The command line arguments are passed
@@ -44,6 +47,16 @@ class Main
       opts.on(*options)
     end
 
+    opts.separator ''
+    opts.separator 'autobuild options:'
+
+    opts.on('--web-server', 'Start a local web server') {
+      cmd_line_options[:use_web_server] = true
+    }
+    opts.on('--no-web-server', 'Do not start a local web server') {
+      cmd_line_options[:use_web_server] = false
+    }
+
     opts.separator ''
     opts.separator 'common options:'
 
@@ -98,6 +111,7 @@ class Main
   def rake
     app.init 'webby'
     app.load_rakefile
+    load_command_line_options
     app.top_level
   end
 
@@ -167,6 +181,14 @@ class Main
     args
   end
 
+  # Load options from the command line into the ::Webby.site struct
+  #
+  def load_command_line_options
+    cmd_line_options.each do |key, value|
+      ::Webby.site.__send__("#{key}=", value)
+    end
+  end
+
 end  # class Main
 end  # module Webby::Apps
 

data/lib/webby/auto_builder.rb

@@ -1,4 +1,6 @@
 require 'directory_watcher'
+require 'launchy'
+require 'webrick'
 
 module Webby
 
@@ -21,13 +23,15 @@ class AutoBuilder
     self.new.run
   end
 
+  attr_reader :logger
+
   # call-seq:
   #    AutoBuilder.new
   #
   # Create a new AutoBuilder class.
   #
   def initialize
-    @log = Logging::Logger[self]
+    @logger = Logging::Logger[self]
 
     @builder = Builder.new
     @builder.load_files
@@ -39,6 +43,8 @@ class AutoBuilder
     glob << File.join(::Webby.site.layout_dir, '**', '*')
     glob << File.join(::Webby.site.content_dir, '**', '*')
     @watcher.glob = glob
+
+    @web_server = ::Webby.site.use_web_server ? WebServer.new : nil
   end
 
   # call-seq:
@@ -53,15 +59,16 @@ class AutoBuilder
     return if ary.empty?
 
     ary.each do |evt|
-      @log.debug "changed #{evt.path}"
+      logger.debug "changed #{evt.path}"
       next unless test ?f, evt.path
       next if evt.path =~ ::Webby.exclude
       Resources.new evt.path
     end
 
-    @builder.run :load_files => false
+    logger.info 'running the build'
+    @builder.run :load_files => false, :verbose => false
   rescue => err
-    @log.error err
+    logger.error err
   end
 
   # call-seq:
@@ -71,14 +78,79 @@ class AutoBuilder
   # Ctrl-C to stop the watcher thread.
   #
   def run
-    @log.info 'starting autobuild (Ctrl-C to stop)'
+    logger.info 'starting autobuild (Ctrl-C to stop)'
 
-    Signal.trap('INT') {@watcher.stop}
+    Signal.trap('INT') {
+      @watcher.stop
+      @web_server.stop if @web_server
+    }
 
     @watcher.start
+    if @web_server
+      @web_server.start
+      sleep 0.25
+      Launchy.open("http://localhost:#{::Webby.site.heel_port}")
+    end
+
     @watcher.join
+    @web_server.join if @web_server
   end
 
+  # Wrapper class around the webrick web server.
+  #
+  class WebServer
+
+    # Create a new webrick server configured to serve pages from the output
+    # directory. Output will be directed to /dev/null.
+    #
+    def initialize
+      logger = WEBrick::Log.new(Kernel::DEV_NULL, WEBrick::Log::DEBUG)
+      access_log = [[ logger, WEBrick::AccessLog::COMBINED_LOG_FORMAT ]]
+
+      @thread = nil
+      @running = false
+      @server = WEBrick::HTTPServer.new(
+        :BindAddress   => 'localhost',
+        :Port          => ::Webby.site.heel_port,
+        :DocumentRoot  => ::Webby.site.output_dir,
+        :FancyIndexing => true,
+        :Logger        => logger,
+        :AccessLog     => access_log
+      )
+    end
+
+    # Returns +true+ if the server is running.
+    #
+    def running?
+      @running
+    end
+
+    # Start the webrick server running in a separate thread (so we don't
+    # block forever).
+    #
+    def start
+      return if running?
+      @running = true
+      @thread = Thread.new {@server.start}
+    end
+
+    # Stop the webrick server.
+    #
+    def stop
+      return if not running?
+      @running = false
+      @server.shutdown
+    end
+
+    # Join on the webserver thread.
+    #
+    def join
+      return if not running?
+      @thread.join
+    end
+
+  end  # class WebServer
+
 end  # class AutoBuilder
 end  # module Webby