RubyGems - webby - Versions diffs - 0.1.0 - Mend

webby 0.1.0

Files changed (45) hide show

data/History.txt +3 -0
data/Manifest.txt +44 -0
data/README.txt +50 -0
data/Rakefile +29 -0
data/bin/webby +14 -0
data/data/Rakefile +6 -0
data/data/content/css/blueprint/License.txt +21 -0
data/data/content/css/blueprint/Readme.txt +93 -0
data/data/content/css/blueprint/lib/buttons.css +112 -0
data/data/content/css/blueprint/lib/compressed.css +127 -0
data/data/content/css/blueprint/lib/grid.css +177 -0
data/data/content/css/blueprint/lib/img/baseline-black.png +0 -0
data/data/content/css/blueprint/lib/img/baseline.png +0 -0
data/data/content/css/blueprint/lib/img/grid.png +0 -0
data/data/content/css/blueprint/lib/img/icons/cross.png +0 -0
data/data/content/css/blueprint/lib/img/icons/textfield_key.png +0 -0
data/data/content/css/blueprint/lib/img/icons/tick.png +0 -0
data/data/content/css/blueprint/lib/reset.css +37 -0
data/data/content/css/blueprint/lib/typography.css +159 -0
data/data/content/css/blueprint/print.css +75 -0
data/data/content/css/blueprint/screen.css +34 -0
data/data/content/css/site.css +0 -0
data/data/content/index.rhtml +18 -0
data/data/layouts/default.rhtml +55 -0
data/data/tasks/create.rake +7 -0
data/data/templates/page.erb +18 -0
data/lib/webby.rb +67 -0
data/lib/webby/auto_builder.rb +75 -0
data/lib/webby/builder.rb +165 -0
data/lib/webby/file.rb +191 -0
data/lib/webby/main.rb +129 -0
data/lib/webby/pages_db.rb +70 -0
data/lib/webby/renderer.rb +94 -0
data/lib/webby/resource.rb +174 -0
data/lib/webby/utils.rb +24 -0
data/lib/webby/webby_task.rb +136 -0
data/spec/spec.opts +1 -0
data/spec/spec_helper.rb +12 -0
data/spec/webby/file_spec.rb +107 -0
data/tasks/doc.rake +60 -0
data/tasks/gem.rake +112 -0
data/tasks/manifest.rake +39 -0
data/tasks/setup.rb +108 -0
data/tasks/spec.rake +37 -0
metadata +128 -0

data/data/content/css/blueprint/screen.css ADDED

@@ -0,0 +1,34 @@
+/* --------------------------------------------------------------
+   Blueprint CSS Framework
+   [bjorkoy.com/blueprint]
+   * Screen & Projection Styles *
+   This is the main CSS-file for the framework.
+   Include this in the <head> of every page. See the
+   Readme file in this directory for further instructions.
+-------------------------------------------------------------- */
+/* Import stylesheets and hide from IE/Mac \*/
+@import "lib/reset.css";
+@import "lib/typography.css";
+@import "lib/grid.css";
+@import "lib/buttons.css";
+/* End import/hide */
+/* Compressed version:
+   [http://teenage.cz/acidofil/tools/cssformat.php]
+   Comment out @import statements above, and add this
+   one when your site has launched (Ca 60% compressed):
+   @import "lib/compressed.css"; */
+/* Uncomment the line below to see the grid and baseline.
+   (Assuming you've wrapped your columns in a container).
+  .container { background: url(lib/img/grid.png); }
+  .container { background: url(lib/img/baseline.png); } */

data/data/content/css/site.css ADDED

File without changes

data/data/content/index.rhtml ADDED

@@ -0,0 +1,18 @@
+---
+title:  Home Page
+filter:
+  - erb
+  - textile
+---
+h2. <%= @page.title %>
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc congue ipsum vestibulum libero. Aenean vitae justo. Nam eget tellus. Etiam convallis, est eu lobortis mattis, lectus tellus tempus felis, a ultricies erat ipsum at metus.
+h3. Litora Sociis
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Morbi et risus. Aliquam nisl. Nulla facilisi. Cras accumsan vestibulum ante. Vestibulum sed tortor. Praesent tempus fringilla elit. Ut elit diam, sagittis in, nonummy in, gravida non, nunc. Ut orci. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Nam egestas, orci eu imperdiet malesuada, nisl purus fringilla odio, quis commodo est orci vitae justo. Aliquam placerat odio tincidunt nulla. Cras in libero. Aenean rutrum, magna non tristique posuere, erat odio eleifend nisl, non convallis est tortor blandit ligula. Nulla id augue.
+bq. Nullam mattis, odio ut tempus facilisis, metus nisl facilisis metus, auctor consectetuer felis ligula nec mauris. Vestibulum odio erat, fermentum at, commodo vitae, ultrices et, urna. Mauris vulputate, mi pulvinar sagittis condimentum, sem nulla aliquam velit, sed imperdiet mi purus eu magna. Nulla varius metus ut eros. Aenean aliquet magna eget orci. Class aptent taciti sociosqu ad litora.
+Vivamus euismod. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Suspendisse vel nibh ut turpis dictum sagittis. Aliquam vel velit a elit auctor sollicitudin. Nam vel dui vel neque lacinia pretium. Quisque nunc erat, venenatis id, volutpat ut, scelerisque sed, diam. Mauris ante. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec mattis. Morbi dignissim sollicitudin libero. Nulla lorem.

data/data/layouts/default.rhtml ADDED

@@ -0,0 +1,55 @@
+---
+extension: html
+filter:    erb
+---
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "DTD/xhtml1-strict.dtd">
+<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" />
+   <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" />
+   <!-- Homepage CSS -->
+   <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">
+     <h2>A New Website</h2>
+     <hr>
+   </div>
+   <div class="column span-8 prepend-1 first">
+      <%= @content %>
+   </div>
+   <div class="column span-3 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>
+      <div class="box">
+         <p class="last">Mauris a lectus. Aliquam erat volutpat. Phasellus ultrices mi a sapien. Nunc rutrum egestas lorem. Duis ac sem sagittis elit tincidunt gravida.</p>
+      </div>
+      <p class="quiet">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>
+      <h5>Incremental leading</h5>
+      <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">
+     <hr />
+     <p>This website was created with <a href="http://webby.rubyforge.org">Webby</a></p>
+   </div>
+</div>
+</body>
+</html>

data/data/tasks/create.rake ADDED

@@ -0,0 +1,7 @@
+require 'webby'
+Rake::WebbyTask.new do |webby|
+  webby.output_dir = 'output'
+end

data/data/templates/page.erb ADDED

@@ -0,0 +1,18 @@
+---
+title:      New Page
+created_at: <%= Time.now %>
+filter:
+  - erb
+  - textile
+---
+h2. <%%= @page.title %>
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc congue ipsum vestibulum libero. Aenean vitae justo. Nam eget tellus. Etiam convallis, est eu lobortis mattis, lectus tellus tempus felis, a ultricies erat ipsum at metus.
+h3. Litora Sociis
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Morbi et risus. Aliquam nisl. Nulla facilisi. Cras accumsan vestibulum ante. Vestibulum sed tortor. Praesent tempus fringilla elit. Ut elit diam, sagittis in, nonummy in, gravida non, nunc. Ut orci. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Nam egestas, orci eu imperdiet malesuada, nisl purus fringilla odio, quis commodo est orci vitae justo. Aliquam placerat odio tincidunt nulla. Cras in libero. Aenean rutrum, magna non tristique posuere, erat odio eleifend nisl, non convallis est tortor blandit ligula. Nulla id augue.
+bq. Nullam mattis, odio ut tempus facilisis, metus nisl facilisis metus, auctor consectetuer felis ligula nec mauris. Vestibulum odio erat, fermentum at, commodo vitae, ultrices et, urna. Mauris vulputate, mi pulvinar sagittis condimentum, sem nulla aliquam velit, sed imperdiet mi purus eu magna. Nulla varius metus ut eros. Aenean aliquet magna eget orci. Class aptent taciti sociosqu ad litora.
+Vivamus euismod. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Suspendisse vel nibh ut turpis dictum sagittis. Aliquam vel velit a elit auctor sollicitudin. Nam vel dui vel neque lacinia pretium. Quisque nunc erat, venenatis id, volutpat ut, scelerisque sed, diam. Mauris ante. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec mattis. Morbi dignissim sollicitudin libero. Nulla lorem.

data/lib/webby.rb ADDED

@@ -0,0 +1,67 @@
+# $Id: webby.rb 8 2007-08-22 22:32:09Z tim_pease $
+module Webby
+  VERSION = '0.1.0'   # :nodoc:
+  # Path to the Webby package
+  PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..'))
+  class Error < StandardError; end  # :nodoc:
+  # call-seq:
+  #    Webby.require_all_libs_relative_to( filename, directory = nil )
+  #
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= File.basename(fname, '.*')
+    search_me = File.expand_path(
+        File.join(File.dirname(fname), dir, '**', '*.rb'))
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+  # call-seq:
+  #    Webby.config    => hash
+  #
+  # Returns the configuration hash for the Webby application.
+  #--
+  # The defaults are defined in the lib/webby/webby_task.rb file
+  #++
+  def self.config
+    @config ||= {}
+  end
+  # call-seq:
+  #    Webby.page_defaults    => hash
+  #
+  # Returns the page defaults hash used for page resource objects.
+  #--
+  # The defaults are defined in the lib/webby/webby_task.rb file
+  #++
+  def self.page_defaults
+    @page_defaults ||= {}
+  end
+end  # module Webby
+# call-seq:
+#    try_require( library )
+#
+# Try to laod the given _library_ using the built-in require, but do not
+# raise a LoadError if unsuccessful.
+#
+def try_require( lib )
+  require lib
+rescue LoadError
+end
+Webby.require_all_libs_relative_to __FILE__
+# EOF

data/lib/webby/auto_builder.rb ADDED

@@ -0,0 +1,75 @@
+# $Id: auto_builder.rb 5 2007-08-22 04:25:49Z tim_pease $
+require 'directory_watcher'
+module Webby
+# The AutoBuilder class is used to monitor the content and layouts folders
+# and to compile the resource files only when they are modified. If a
+# layout is modified, then all resources that depend upon the layout are
+# compiled.
+#
+class AutoBuilder
+  # call-seq:
+  #    AutoBuilder.run
+  #
+  # Creates a new AutoBuilder and sets it running. This method will only
+  # return when the user presses Ctrl-C.
+  #
+  def self.run
+    self.new.run
+  end
+  # call-seq:
+  #    AutoBuilder.new
+  #
+  # Create a new AutoBuilder class.
+  #
+  def initialize
+    @watcher = DirectoryWatcher.new '.', :interval => 2
+    @watcher.add_observer self
+    glob = []
+    glob << File.join(::Webby.config['layout_dir'], '**', '*')
+    glob << File.join(::Webby.config['content_dir'], '**', '*')
+    @watcher.glob = glob
+  end
+  # call-seq:
+  #    update( *events )
+  #
+  # The update method is called by the DirectoryWatcher when files have been
+  # modified, added, or deleted. An array of events is passed to his method,
+  # and each event contains the event type and the path to the file.
+  #
+  def update( *events )
+    ary = events.find_all {|evt| evt.type != :removed}
+    return if ary.empty?
+    print '- started at '
+    puts Time.now.strftime('%H:%M:%S')
+    Builder.run
+  rescue => err
+    puts err.message
+  end
+  # call-seq:
+  #    run
+  #
+  # Starts the DirectoryWatcher running and waits till the user presses
+  # Ctrl-C to stop the watcher thread.
+  #
+  def run
+    puts '-- starting autobuild (Ctrl-C to stop)'
+    Signal.trap('INT') {@watcher.stop}
+    @watcher.start
+    @watcher.join
+  end
+end  # class AutoBuilder
+end  # module Webby
+# EOF

data/lib/webby/builder.rb ADDED

@@ -0,0 +1,165 @@
+# $Id: builder.rb 5 2007-08-22 04:25:49Z tim_pease $
+require 'find'
+require 'fileutils'
+require 'erb'
+module Webby
+# The Builder class performs the work of scanning the content folder,
+# creating Resource objects, and converting / copying the contents to the
+# output folder as needed.
+#
+class Builder
+  class << self
+    # call-seq:
+    #    Builder.run( :rebuild => false )
+    #
+    # Create a new instance of the Builder class and invoke the run method.
+    # If the <code>:rebuild</code> option is given as +true+, then all pages
+    # will be recreated / copied.
+    #
+    def run( opts = {} )
+      self.new.run opts
+    end
+    # call-seq:
+    #    Builder.create( page, :from => template )
+    #
+    # This mehod is used to create a new _page_ in the content folder based
+    # on the specified template. _page_ is the relative path to the new page
+    # from the <code>content/</code> folder. The _template_ is the name of
+    # the template to use from the <code>templates/</code> folder.
+    #
+    def create( page, opts = {} )
+      tmpl = opts[:from]
+      raise Error, "template not given" unless tmpl
+      raise Error, "#{page} already exists" if test ?e, page
+      puts "creating #{page}"
+      FileUtils.mkdir_p File.dirname(page)
+      str = ERB.new(::File.read(tmpl), nil, '-').result
+      ::File.open(page, 'w') {|fd| fd.write str}
+      return nil
+    end
+  end  # class << self
+  # call-seq:
+  #    run( :rebuild => false )
+  #
+  # Runs the Webby builder by loading in the layout files from the
+  # <code>layouts/</code> folder and the content from the
+  # <code>contents/</code> folder. Content is analyzed, and those that need
+  # to be copied or compiled (filtered using ERB, Texttile, Markdown, etc.)
+  # are handled. The results are placed in the <code>output/</code> folder.
+  #
+  # If the <code>:rebuild</code> flag is set to +true+, then all content is
+  # copied and/or compiled to the output folder.
+  #
+  # A content file can mark itself as dirty by setting the +dirty+ flag to
+  # +true+ in the meta-data of the file. This will cause the contenet to
+  # always be compiled when the builder is run. Conversely, setting the
+  # dirty flag to +false+ will cause the content to never be compiled or
+  # copied to the output folder.
+  #
+  # A content file needs to be built if the age of the file is less then the
+  # age of the output product -- i.e. the content file has been modified
+  # more recently than the output file.
+  #
+  def run( opts = {} )
+    Resource.clear
+    unless test(?d, output_dir)
+      puts "creating #{output_dir}"
+      FileUtils.mkdir output_dir
+    end
+    load_layouts
+    load_content
+    Resource.pages.each do |page|
+      next unless page.dirty? or opts[:rebuild]
+      puts "creating #{page.destination}"
+      # make sure the directory exists
+      FileUtils.mkdir_p ::File.dirname(page.destination)
+      # copy the resource to the output directory if it is static
+      if page.is_static?
+        FileUtils.cp page.path, page.destination
+      # 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
+    end
+    # touch the output directory so we know when the
+    # website was last generated
+    FileUtils.touch output_dir
+    return nil
+  end
+  private
+  # Scan the <code>layouts/</code> folder and create a new Resource object
+  # for each file found there.
+  #
+  def load_layouts
+    excl = Regexp.new exclude.join('|')
+    ::Find.find(layout_dir) do |path|
+      next unless test ?f, path
+      next if path =~ excl
+      Resource.new path
+    end
+    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
+        if stack.include? lyt.filename
+          stack << lyt.filename
+          raise Error,
+                "loop detected in layout references: #{stack.join(' > ')}"
+        end
+        stack << lyt.filename
+        lyt = layouts.find_by_name lyt.layout
+      end  # while
+    end  # each
+  end
+  # Scan the <code>content/</code> folder and create a new Resource object
+  # for each file found there.
+  #
+  def load_content
+    excl = Regexp.new exclude.join('|')
+    Find.find(content_dir) do |path|
+      next unless test ?f, path
+      next if path =~ excl
+      Resource.new path, ::Webby.page_defaults
+    end
+  end
+  %w(output_dir layout_dir content_dir exclude).each do |key|
+    self.class_eval <<-CODE
+      def #{key}( ) ::Webby.config['#{key}'] end
+    CODE
+  end
+end  # class Builder
+end  # module Webby
+# EOF