webby 0.9.0 → 0.9.1

data/spec/webby/resources/layout_spec.rb

@@ -0,0 +1,83 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# -------------------------------------------------------------------------
+describe Webby::Resources::Layout do
+  before :each do
+    layout = Webby::Resources::Layout.
+             new(Webby.datapath %w[layouts tumblog default.txt])
+    Webby::Resources.stub!(:find_layout).and_return(layout)
+
+    @default = File.join %w[layouts tumblog default.txt]
+    @post    = File.join %w[layouts tumblog post.txt]
+    @layout  = Webby::Resources::Layout.new(@default)
+  end
+
+  it 'parses meta-data on initialization' do
+    h = @layout._meta_data
+
+    h.should_not be_empty
+    h.should == {
+      'extension' => 'html',
+      'filter'    => 'erb'
+    }
+  end
+
+  it 'uses the cairn file as the destination' do
+    @layout.destination.should == ::Webby.cairn
+  end
+
+  it 'always returns nil as the url' do
+    @layout.url.should be_nil
+  end
+
+  it 'reads the contents of the file' do
+    layout = Webby::Resources::Layout.new(@post)
+    str = layout._read
+    str.split($/).first.should == '<div class="post">'
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.extension' do
+    it 'uses the extension from the meta-data if present' do
+      @layout.extension.should == 'html'
+    end
+
+    it "returns nil if no extension is found in the meta-data" do
+      @layout._meta_data.delete('extension')
+      @layout.extension.should be_nil
+    end
+
+    it "uses the parent layout's extension if a parent layout is present" do
+      layout = Webby::Resources::Layout.new(@post)
+      layout.extension.should == 'html'
+
+      layout._meta_data.delete('layout')
+      layout.extension.should be_nil
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.dirty?' do
+    it 'overrides the dirty state based on the meta-data value' do
+      @layout['dirty'] = true
+      @layout.dirty?.should == true
+
+      @layout['dirty'] = false
+      @layout.dirty?.should == false
+    end
+
+    it 'returns true if the output file is missing' do
+      @layout.dirty?.should == true
+    end
+
+    it 'returns false if the cairn file is present' do
+      FileUtils.touch Webby.cairn
+      @layout.dirty?.should == false
+    end
+  end
+
+end  # describe Webby::Resources::Layout
+
+# EOF

data/spec/webby/resources/meta_file_spec.rb

@@ -0,0 +1,157 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# -------------------------------------------------------------------------
+describe Webby::Resources::MetaFile do
+
+  it 'raises an error when created without an IO object' do
+    lambda {Webby::Resources::MetaFile.new('string')}.should raise_error(
+      ArgumentError, 'expecting an IO stream')
+  end
+
+  it 'returns the number of meta-data blocks at the top of a file' do
+    fn = Webby.datapath %w[content css coderay.css]
+    File.open(fn, 'r') do |fd|
+      mf = Webby::Resources::MetaFile.new(fd)
+      mf.meta_count.should == 0
+    end
+
+    fn = Webby.datapath %w[content index.txt]
+    File.open(fn, 'r') do |fd|
+      mf = Webby::Resources::MetaFile.new(fd)
+      mf.meta_count.should == 1
+    end
+
+    fn = Webby.datapath %w[content photos.txt]
+    File.open(fn, 'r') do |fd|
+      mf = Webby::Resources::MetaFile.new(fd)
+      mf.meta_count.should == 3
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.each' do
+    it 'yields each meta-data block' do
+      fn = Webby.datapath %w[content photos.txt]
+      output = []
+      File.open(fn, 'r') do |fd|
+        mf = Webby::Resources::MetaFile.new(fd)
+        mf.each {|h| output << h}
+      end
+      output.length.should == 3
+      output.map {|h| h['title']}.should == [
+        'First Photo',
+        'Second Photo',
+        'Third Photo'
+      ]
+      output.map {|h| h['directory']}.should == ['photos']*3
+      output.map {|h| h['filename']}.should == %w[image1 image2 image3]
+
+    end
+
+    it 'yields a single meta-data block' do
+      fn = Webby.datapath %w[content index.txt]
+      output = []
+      File.open(fn, 'r') do |fd|
+        mf = Webby::Resources::MetaFile.new(fd)
+        mf.each {|h| output << h}
+      end
+      output.length.should == 1
+      h = output.first
+      h['title'].should == 'Home Page'
+      h['filter'].should == %w[erb textile]
+    end
+
+    it 'raises an error if the meta-data is not a hash' do
+      fn = Webby.datapath %w[hooligans bad_meta_data_1.txt]
+      output = []
+      File.open(fn, 'r') do |fd|
+        mf = Webby::Resources::MetaFile.new(fd)
+        lambda {
+          mf.each {|h| output << h}
+        }.should raise_error(Webby::Resources::MetaFile::Error)
+      end
+      output.length.should == 1
+    end
+
+    it "really doesn't like YAML syntax errors" do
+      fn = Webby.datapath %w[hooligans bad_meta_data_2.txt]
+      output = []
+      File.open(fn, 'r') do |fd|
+        mf = Webby::Resources::MetaFile.new(fd)
+        lambda {
+          mf.each {|h| output << h}
+        }.should raise_error(Webby::Resources::MetaFile::Error)
+      end
+      output.length.should == 1
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '#meta_data' do
+    it 'returns nil for regular files' do
+      fn = Webby.datapath %w[content css coderay.css]
+      Webby::Resources::MetaFile.meta_data(fn).should be_nil
+    end
+
+    it 'returns a hash for pages' do
+      fn = Webby.datapath %w[content index.txt]
+      h = Webby::Resources::MetaFile.meta_data(fn)
+
+      h.should be_instance_of(Hash)
+      h['created_at'].should be_instance_of(Time)
+    end
+
+    it 'returns a hash for layouts' do
+      fn = Webby.datapath %w[layouts default.txt]
+      h = Webby::Resources::MetaFile.meta_data(fn)
+
+      h.should be_instance_of(Hash)
+      h.should == {
+        'extension' => 'html',
+        'filter'    => 'erb'
+      }
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe "#meta_data?" do
+    it 'returns true for files with meta-data' do
+      fn = Webby.datapath %w[content index.txt]
+      Webby::Resources::MetaFile.meta_data?(fn).should == true
+    end
+
+    it 'returns false for files without meta-data' do
+      fn = Webby.datapath %w[content css coderay.css]
+      Webby::Resources::MetaFile.meta_data?(fn).should == false
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe "#read" do
+    it 'behaves the same as File#read for regular files' do
+      fn = Webby.datapath %w[content css coderay.css]
+      Webby::Resources::MetaFile.read(fn).should == ::File.read(fn)
+    end
+
+    it 'returns only the content for pages' do
+      fn = Webby.datapath %w[content index.txt]
+      lines = File.readlines(fn)
+      lines = lines[7..-1].join
+
+      Webby::Resources::MetaFile.read(fn).should == lines
+    end
+
+    it 'returns only the content for layouts' do
+      fn = Webby.datapath %w[layouts default.txt]
+      lines = File.readlines(fn)
+      lines = lines[4..-1].join
+
+      Webby::Resources::MetaFile.read(fn).should == lines
+    end
+  end
+
+end  # describe Webby::Resources::MetaFile
+
+# EOF

data/spec/webby/resources/page_spec.rb

@@ -0,0 +1,111 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# -------------------------------------------------------------------------
+describe Webby::Resources::Page do
+  before :each do
+    layout = Webby::Resources::Layout.
+             new(Webby.datapath %w[layouts default.txt])
+    Webby::Resources.stub!(:find_layout).and_return(layout)
+
+    @filename = File.join %w[content index.txt]
+    @page = Webby::Resources::Page.new(@filename)
+  end
+
+  it 'parses meta-data on initialization' do
+    h = @page._meta_data
+
+    h.should_not be_empty
+    h['title'].should == 'Home Page'
+    h['filter'].should == ['erb', 'textile']
+    h['layout'].should == 'default'
+  end
+
+  it 'can be given a hash of meta-data on initialization' do
+    page = Webby::Resources::Page.new(
+      @filename,
+      'title' => 'Not Your Average Title'
+    )
+
+    h = page._meta_data
+    h.should_not be_empty
+    h['title'].should == 'Not Your Average Title'
+    h['layout'].should == 'default'
+    h['created_at'].should be_nil
+    h['filter'].should be_nil
+  end
+
+  it 'reads the contents of the file' do
+    str = @page._read
+    str.split($/).first.should == "p(title). <%= @page.title %>"
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.url' do
+    before :each do
+      @filename = File.join %w[content tumblog rss.txt]
+      @page = Webby::Resources::Page.new(@filename)
+    end
+
+    it 'computes the url from the destination' do
+      @page.url.should == '/tumblog/rss.xml'
+    end
+
+    it "uses only the directory name for 'index' files" do
+      filename = File.join %w[content tumblog index.txt]
+      resource = Webby::Resources::Page.new(filename)
+      resource.url.should == '/tumblog'
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.extension' do
+    it 'uses the extension from the meta-data if present' do
+      @page['extension'] = 'foo'
+      @page.extension.should == 'foo'
+    end
+
+    it "uses the layout's extension if a layout is present" do
+      @page.extension.should == 'html'
+    end
+
+    it "uses the file's extension as a last ditch effort" do
+      @page._meta_data.delete('layout')
+      @page.extension.should == 'txt'
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.dirty?' do
+    it 'overrides the dirty state based on the meta-data value' do
+      @page['dirty'] = true
+      @page.dirty?.should == true
+
+      @page['dirty'] = false
+      @page.dirty?.should == false
+    end
+
+    it 'returns true if the output file is missing' do
+      @page.dirty?.should == true
+    end
+
+    it 'returns true if the layout is dirty' do
+      dest = @page.destination
+      FileUtils.touch dest
+
+      @page.dirty?.should == true
+    end
+
+    it 'returns false if everything is up to date' do
+      dest = @page.destination
+      FileUtils.touch dest
+      FileUtils.touch ::Webby.cairn
+
+      @page.dirty?.should == false
+    end
+  end
+
+end  # describe Webby::Resources::Page
+
+# EOF

data/spec/webby/resources/partial_spec.rb

@@ -0,0 +1,58 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# -------------------------------------------------------------------------
+describe Webby::Resources::Partial do
+  before :each do
+    @filename = File.join %w[content _partial.txt]
+    @partial  = Webby::Resources::Partial.new(@filename)
+  end
+
+  it 'parses meta-data on initialization' do
+    h = @partial._meta_data
+
+    h.should_not be_empty
+    h.should == {'filter' => 'erb'}
+  end
+
+  it 'uses the cairn file as the destination' do
+    @partial.destination.should == ::Webby.cairn
+  end
+
+  it 'always returns nil as the url' do
+    @partial.url.should be_nil
+  end
+
+  it 'reads the contents of the file' do
+    str = @partial._read
+    str.split($/).first.should == 'A partial has access to the page from which it was called. The title below will be the title of the page in which this partial is rendered.'
+  end
+
+  it 'uses the files extension as the extension' do
+    @partial.extension.should equal(@partial.ext)
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.dirty?' do
+    it 'overrides the dirty state based on the meta-data value' do
+      @partial['dirty'] = true
+      @partial.dirty?.should == true
+
+      @partial['dirty'] = false
+      @partial.dirty?.should == false
+    end
+
+    it 'returns true if the cairn file is missing' do
+      @partial.dirty?.should == true
+    end
+
+    it 'returns false if the cairn file is present' do
+      FileUtils.touch Webby.cairn
+      @partial.dirty?.should == false
+    end
+  end
+
+end  # describe Webby::Resources::Partial
+
+# EOF

data/spec/webby/resources/resource_spec.rb

@@ -0,0 +1,214 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# -------------------------------------------------------------------------
+describe Webby::Resources::Resource do
+
+  before :each do
+    layout = Webby::Resources::Layout.
+             new(Webby.datapath %w[layouts default.txt])
+    Webby::Resources.stub!(:find_layout).and_return(layout)
+
+    @filename = File.join %w[content index.txt]
+    @resource = Webby::Resources::Resource.new(@filename)
+  end
+
+  it 'does not parse meta-data by default' do
+    @resource._meta_data.should be_empty
+  end
+
+  it 'provides the path to the file' do
+    @resource.path.should == @filename
+  end
+
+  it 'returns the bare filename' do
+    @resource.name.should == 'index'
+
+    resource = Webby::Resources::Resource.
+                   new(File.join(%w[content tumblog rss.txt]))
+    resource.name.should == 'rss'
+  end
+
+  it 'returns the path-based extension' do
+    @resource.ext.should == 'txt'
+  end
+
+  it 'computes the directory of the file with the content folder removed' do
+    @resource.dir.should == ''
+
+    resource = Webby::Resources::Resource.
+                   new(File.join(%w[content tumblog index.txt]))
+    resource.dir.should == 'tumblog'
+  end
+
+  it 'returns the modification time of the file' do
+    @resource.mtime.should be_instance_of(Time)
+  end
+
+  it 'determines equality from the full path' do
+    a = Webby::Resources::Resource.new(File.join(%w[content tumblog index.txt]))
+    b = Webby::Resources::Resource.new(File.join(%w[content tumblog rss.txt]))
+    c = Webby::Resources::Resource.new(File.join(%w[content tumblog index.txt]))
+
+    (a == b).should == false
+    (a == c).should == true
+    (b == c).should == false
+    (a == nil).should == false
+    (a == a.path).should == false
+  end
+
+  it 'compares two resources by path' do
+    a = Webby::Resources::Resource.new(File.join(%w[content tumblog index.txt]))
+    b = Webby::Resources::Resource.new(File.join(%w[content tumblog rss.txt]))
+    c = Webby::Resources::Resource.new(File.join(%w[content tumblog index.txt]))
+
+    (a <=> b).should == -1
+    (b <=> a).should ==  1
+    (a <=> c).should ==  0
+    (a <=> a).should ==  0
+    (a <=> nil).should be_nil
+    (a <=> a.path).should be_nil
+  end
+
+  it 'can alter meta-data' do
+    @resource['title'].should be_nil
+    @resource[:title] = 'Home Page'
+
+    @resource['title'].should == 'Home Page'
+    @resource[:title].should == 'Home Page'
+    @resource[:title].should equal(@resource['title'])
+  end
+
+  it 'overrides the dirty state based on the meta-data value' do
+    @resource['dirty'] = true
+    @resource.dirty?.should == true
+
+    @resource['dirty'] = false
+    @resource.dirty?.should == false
+  end
+
+  it 'reads the contents of the file' do
+    str = @resource._read
+    str.split($/).first.should == "p(title). <%= @page.title %>"
+  end
+
+  it 'repleces the meta-data hash when reset' do
+    @resource._meta_data.should be_empty
+    oid = @resource._meta_data.object_id
+
+    @resource._reset('foo' => 'bar')
+    @resource._meta_data.should_not be_empty
+    @resource._meta_data.object_id.should == oid
+    @resource._meta_data['foo'].should == 'bar'
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.filename' do
+    it 'uses the filename from the meta-data if present' do
+      @resource['filename'] = 'bozo'
+      @resource.filename.should == 'bozo'
+    end
+
+    it "uses the file's filename as a last ditch effort" do
+      @resource.filename.should == 'index'
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.extension' do
+    it 'uses the extension from the meta-data if present' do
+      @resource['extension'] = 'foo'
+      @resource.extension.should == 'foo'
+    end
+
+    it "uses the file's extension as a last ditch effort" do
+      @resource.extension.should == 'txt'
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.directory' do
+    it 'uses the directory from the meta-data if present' do
+      @resource['directory'] = 'foo'
+      @resource.directory.should == 'foo'
+    end
+
+    it "uses the file's directory as a last ditch effort" do
+      @resource.directory.should == ''
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.url' do
+    it 'computes the url from the filename and directory' do
+      @resource.url.should == '/index.txt'
+    end
+
+    it 'caches the url' do
+      @resource.url.should == '/index.txt'
+
+      @resource['directory'] = 'foo/bar/baz'
+      @resource.url.should == '/index.txt'
+    end
+
+    it 'clears the cached url on reset' do
+      @resource.url.should == '/index.txt'
+
+      @resource['directory'] = 'foo/bar/baz'
+      @resource.url.should == '/index.txt'
+
+      @resource._reset
+      @resource.url.should == '/foo/bar/baz/index.txt'
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.destination' do
+    it 'computes the destination from the filename and directory' do
+      @resource.destination.should == 'output/index.txt'
+    end
+
+    it 'caches the destination' do
+      @resource.destination.should == 'output/index.txt'
+
+      @resource['directory'] = 'foo/bar/baz'
+      @resource.destination.should == 'output/index.txt'
+    end
+
+    it 'clears the cached destination on reset' do
+      @resource.destination.should == 'output/index.txt'
+
+      @resource['directory'] = 'foo/bar/baz'
+      @resource.destination.should == 'output/index.txt'
+
+      @resource._reset
+      @resource.destination.should == 'output/foo/bar/baz/index.txt'
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.dirty?' do
+    it 'overrides the dirty state based on the meta-data value' do
+      @resource['dirty'] = true
+      @resource.dirty?.should == true
+
+      @resource['dirty'] = false
+      @resource.dirty?.should == false
+    end
+
+    it 'returns true if the output file is missing' do
+      @resource.dirty?.should == true
+    end
+
+    it 'returns false if everything is up to date' do
+      dest = @resource.destination
+      FileUtils.touch dest
+
+      @resource.dirty?.should == false
+    end
+  end
+
+end  # describe Webby::Resources::Resource
+
+# EOF