webby 0.1.0

data/lib/webby/resource.rb

@@ -0,0 +1,174 @@
+# $Id: resource.rb 5 2007-08-22 04:25:49Z tim_pease $
+
+module Webby
+
+#
+#
+class Resource
+
+  class << self
+    def pages
+      @pages ||= PagesDB.new
+    end
+
+    def layouts
+      @layouts ||= PagesDB.new
+    end
+
+    def clear
+      self.pages.clear
+      self.layouts.clear
+    end
+  end  # class << self
+
+  # call-seq:
+  #    Resource.new( filename, defaults = {} )    => page
+  #
+  def initialize( fn, defaults = {} )
+    @path     = fn.sub(%r/\A(?:\.\/|\/)/o, '').freeze
+    @dir      = ::File.dirname(@path).sub(%r/\A[^\/]+\/?/o, '')
+    @filename = ::File.basename(@path).sub(%r/\.\w+\z/o, '')
+    @ext      = ::File.extname(@path).sub(%r/\A\.?/o, '')
+    @mtime    = ::File.mtime @path
+
+    @rendering = false
+
+    # deal with the meta-data
+    @mdata = ::Webby::File.meta_data(@path)
+    @have_mdata = !@mdata.nil?
+    @mdata = @have_mdata ? defaults.merge(@mdata) : {}
+    @mdata.sanitize!
+
+    self.class.pages << self if is_page? or is_static?
+    self.class.layouts << self if is_layout?
+  end
+
+  # call-seq:
+  #    equal?( other )    => true or false
+  #
+  def equal?( other )
+    return false unless self.class == other.class
+    @path == other.path
+  end
+  alias :== :equal?
+  alias :eql? :equal?
+
+  # call-seq:
+  #    resource <=> other    => -1, 0, +1, or nil
+  #
+  def <=>( other )
+    return unless self.class == other.class
+    @path <=> other.path
+  end
+
+
+  attr_reader :path, :dir, :filename, :mtime, :ext
+
+  # call-seq:
+  #    extension    => string
+  #
+  def extension
+    return @mdata['extension'] if @mdata.has_key? 'extension'
+
+    if @mdata.has_key? 'layout'
+      lyt = self.class.layouts.find_by_name @mdata['layout']
+      break if lyt.nil?
+      return lyt.extension
+    end
+
+    @ext
+  end
+
+  def destination
+    return @destination if defined? @destination
+    return @destination = ::Webby.config['output_dir'] if is_layout?
+
+    @destination = File.join(::Webby.config['output_dir'], dir, filename)
+    @destination << '.'
+    @destination << extension
+    @destination
+  end
+
+  # call-seq:
+  #    render   => string
+  #
+  def render
+    raise Error, "page '#@path' is in a rendering loop" if @rendering
+
+    @rendering = true
+    content = Renderer.new(self).render_page
+    @rendering = false
+
+    return content
+
+  rescue
+    @rendering = false
+    raise
+  end
+
+  # call-seq:
+  #    is_layout?    => true or false
+  #
+  # Returns +true+ if this resource is a layout.
+  #
+  def is_layout?
+    @is_layout ||=
+        !(%r/\A(?:\.\/|\/)?#{::Webby.config['layout_dir']}\//o =~ @path).nil?
+  end
+
+  # call-seq:
+  #    is_static?    => true or false
+  #
+  # Returns +true+ if this resource is a static file.
+  #
+  def is_static?
+    !@have_mdata
+  end
+
+  # call-seq:
+  #    is_page?    => true or false
+  #
+  # Returns +true+ if this resource is a page suitable for rendering.
+  #
+  def is_page?
+    @have_mdata and !is_layout?
+  end
+
+  # call-seq:
+  #    dirty?    => true or false
+  #
+  # Returns +true+ if this resource is newer than its corresponding output
+  # product. The resource needs to be rendered (if a page or layout) or
+  # copied (if a static file) to the output directory.
+  #
+  def dirty?
+    return @mdata['dirty'] if @mdata.has_key? 'dirty'
+
+    # if the destination file does not exist, then we are dirty
+    return @mdata['dirty'] = true unless test ?e, destination
+
+    # if this file's mtime is larger than the destination file's
+    # mtime, then we are dirty
+    @mdata['dirty'] = @mtime > File.mtime(destination)
+    return @mdata['dirty'] if is_static? or @mdata['dirty']
+
+    # check to see if the layout is dirty, and it it is then we
+    # are dirty, too
+    if @mdata.has_key? 'layout'
+      lyt = self.class.layouts.find_by_name @mdata['layout']
+      break if lyt.nil?
+      return @mdata['dirty'] = true if lyt.dirty?
+    end
+
+    # if we got here, then we are not dirty
+    @mdata['dirty'] = false
+  end
+
+  def method_missing( name, *a, &b )
+    @mdata[name.to_s]
+  end
+
+end  # class Resource
+end  # module Webby
+
+# EOF

data/lib/webby/utils.rb

@@ -0,0 +1,24 @@
+# $Id: utils.rb 1 2007-08-18 21:39:50Z tim_pease $
+
+module Enumerable
+  def injecting( initial )
+    inject(initial) do |memo, obj|
+      yield(memo, obj); memo
+    end
+  end
+end
+
+class Hash
+  def sanitize!
+    h = self.injecting({}) do |h, (k, v)|
+          h[k] = case v
+                 when 'none', 'nil': nil
+                 when 'true', 'yes': true
+                 when 'false', 'no': false
+                 else v end
+        end
+    self.replace h
+  end
+end
+
+# EOF

data/lib/webby/webby_task.rb

@@ -0,0 +1,136 @@
+# $Id: webby_task.rb 7 2007-08-22 22:31:08Z tim_pease $
+
+begin
+  require 'rake'
+  require 'rake/tasklib'
+rescue LoadError
+  require 'rubygems'
+  raise unless gem 'rake'
+  retry
+end
+
+module Rake
+
+# The WebbyTask defines several rake tasks for working with Webby based
+# websites:
+#
+# [:build]  Build the site by compiling only those resources in the content
+#           folder that have been modifed recently. If the a content file
+#           has a modification time more recent then its corresponding
+#           output file, then it will be built by this task.
+#
+# [:rebuild]  Rebuild the entire site from the content folder and store the
+#             results in the output folder.
+#
+# [:autobuild]  Monitors the content and layout directories for modified
+#               resources and compiles those files as needed. This task
+#               returns only when the user hits Ctrl-C.
+#
+# [:create:page]  Create a new page in the content folder based on the
+#                 template 'page' found in the templates folder. One task
+#                 will be created for each file found in the templates
+#                 folder.
+#
+class WebbyTask < TaskLib
+
+  # Location of the generated website
+  attr_accessor :output_dir
+
+  # Location of the webiste source material
+  attr_accessor :content_dir
+
+  # Location of the layout files for generated pages
+  attr_accessor :layout_dir
+
+  # Location of the page templates
+  attr_accessor :template_dir
+
+  # Array of patterns used to exclude files
+  attr_accessor :exclude
+
+  # Global page attributes (default is {})
+  attr_reader :page_defaults
+
+  # Merge the given _hash_ with the page defaults hash
+  def page_defaults=( hash )
+    @page_defaults.merge! hash
+  end
+
+  # call-seq:
+  #    WebbyTask.new {|self| block}
+  #
+  # Create the tasks used by Webby to build a website and to create new
+  # pages in the website.
+  #
+  def initialize
+    @output_dir = 'output'
+    @content_dir = 'content'
+    @layout_dir = 'layouts'
+    @template_dir = 'templates'
+    @exclude = %w(tmp$ bak$ ~$ CVS \.svn)
+    @page_defaults = {
+      'extension' => 'html',
+      'layout'    => 'default'
+    }
+
+    yield self if block_given?
+
+    ::Webby.config.merge!({
+      'output_dir' => @output_dir,
+      'content_dir' => @content_dir,
+      'layout_dir' => @layout_dir,
+      'template_dir' => @template_dir,
+      'exclude' => @exclude
+    })
+    ::Webby.page_defaults.merge! @page_defaults
+
+    define_build_tasks
+    namespace(:create) {define_create_tasks}
+  end
+
+
+  private
+
+  # Defines the :build and :rebuild tasks
+  #
+  def define_build_tasks
+    desc "build the website"
+    task :build do |t|
+      ::Webby::Builder.run
+    end
+
+    desc "rebuild the website"
+    task :rebuild do |t|
+      ::Webby::Builder.run :rebuild => true
+    end
+
+    desc "continuously build the website"
+    task :autobuild do |t|
+      ::Webby::AutoBuilder.run
+    end
+  end
+
+  # Scans the templates directory for any files, and creats a corresponding
+  # task for creating a new page based on that template.
+  #
+  def define_create_tasks
+    FileList["#{@template_dir}/*"].each do |template|
+      name = template.pathmap '%n'
+
+      desc "create a new #{name} page"
+      task name do |t|
+        raise "Usage:  rake #{t.name} path" unless ARGV.length == 2
+
+        page = t.application.top_level_tasks.pop
+        page = File.join(@content_dir, page)
+        page << '.txt' if File.extname(page).empty?
+
+        ::Webby::Builder.create page, :from => template
+      end  # task
+    end  # each
+  end
+
+end  # class WebbyTask
+end  # module Rake
+
+# EOF

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# $Id: spec_helper.rb 1 2007-08-18 21:39:50Z tim_pease $
+
+begin
+  require 'webby'
+rescue LoadError
+  path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+  raise if $:.include? path
+  $: << path
+  retry
+end
+
+# EOF

data/spec/webby/file_spec.rb

@@ -0,0 +1,107 @@
+# $Id: file_spec.rb 1 2007-08-18 21:39:50Z tim_pease $
+
+require 'spec/spec_helper.rb'
+require 'fileutils'
+
+describe Webby::File do
+
+  FN = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lorem_ipsum.txt'))
+  FN_YAML = FN.gsub %r/\.txt\z/, '_yaml.txt'
+  LINES = [
+    "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla orci\n",
+    "ante, aliquet ac, vulputate ut, suscipit et, sapien. Integer elementum\n",
+    "nisi quis magna tincidunt mattis. Aliquam semper. Pellentesque pretium.\n",
+    "Ut a ligula sit amet pede malesuada laoreet. Ut et purus. Morbi turpis\n",
+    "justo, pharetra vitae, consequat a, sodales vitae, tortor. Donec non\n",
+    "massa. Maecenas adipiscing venenatis nisi. Proin vulputate lorem posuere\n",
+    "mi. Cras sagittis. Pellentesque tortor mauris, accumsan vitae, ultrices\n",
+    "vel, tristique ultricies, eros. Donec fringilla hendrerit mauris. Nam in\n",
+    "orci. Curabitur congue consectetuer leo. Donec ut pede. Proin et lorem.\n",
+    "Aliquam eget lacus. In nibh.\n"
+  ]
+
+  before do
+    File.open(FN,'w') {|fd| fd.write LINES}
+    File.open(FN_YAML,'w') do |fd|
+      fd.write "--- \n- one\n- two\n- three\n--- \n"
+      fd.write LINES
+    end
+  end
+
+  after do 
+    File.delete FN if File.exists?(FN)
+    File.delete FN_YAML if File.exists?(FN_YAML)
+  end
+
+  it 'should return nil for meta-data on regular files' do
+    begin
+      fd = Webby::File.new FN, 'r'
+      fd.meta_data.should == nil
+
+      fd.readlines.should == LINES
+    ensure
+      fd.close
+    end
+  end
+
+  it 'should add meta-data to the top of a file' do
+    Webby::File.open(FN,'a+') do |fd|
+      fd.meta_data.should == nil
+      fd.meta_data = %w(one two three)
+    end
+
+    Webby::File.open(FN,'r') do |fd|
+      fd.meta_data.should == %w(one two three)
+    end
+
+    File.open(FN_YAML, 'r') do |fd|
+      ary = LINES.dup
+      ary.insert 0, [
+        "--- \n",
+        "- one\n",
+        "- two\n",
+        "- three\n",
+        "--- \n"
+      ]
+      fd.readlines.should == ary.flatten
+    end
+  end
+
+  it 'should remove the meta-data when set to nil' do
+    Webby::File.open(FN_YAML,'a+') do |fd|
+      fd.meta_data.should == %w(one two three)
+      fd.meta_data = nil
+    end
+
+    Webby::File.open(FN_YAML,'r') do |fd|
+      fd.meta_data.should == nil
+    end
+
+    File.open(FN_YAML, 'r') do |fd|
+      fd.readlines.should == LINES
+    end
+  end
+
+  it 'should skip the meta-data when reading from the file' do
+    begin
+      fd = Webby::File.new FN_YAML, 'r'
+      fd.meta_data.should == %w(one two three)
+
+      fd.getc.should == ?L;                        fd.seek 0
+      fd.gets.should == LINES.first;               fd.seek 0
+      fd.read(5).should == 'Lorem';                fd.seek 0
+      fd.read_nonblock(11) == 'Lorem ipsum';       fd.seek 0
+      fd.readchar.should == ?L;                    fd.seek 0
+      fd.readline.should == LINES.first;           fd.seek 0
+      fd.readlines.should == LINES;                fd.seek 0
+      fd.readpartial(11).should == 'Lorem ipsum';  fd.seek 0
+      fd.sysread(11).should == 'Lorem ipsum';      fd.seek 0
+
+    ensure
+      fd.close
+    end
+  end
+
+end  # describe Webby::File
+
+# EOF