giraffesoft-webby 0.9.5

data/spec/webby/resources/db_spec.rb

@@ -0,0 +1,250 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# -------------------------------------------------------------------------
+describe Webby::Resources::DB do
+
+  before :each do
+    layout = Webby::Resources::Layout.
+             new(Webby.datapath %w[site layouts tumblog default.txt])
+    Webby::Resources.stub!(:find_layout).and_return(layout)
+
+    @db = Webby::Resources::DB.new
+    Dir.glob('content/tumblog/**/*').each do |fn|
+      next unless test(?f, fn)
+      @db.add Webby::Resources::Page.new(fn)
+    end
+    @db_hash = @db.instance_variable_get(:@db)
+  end
+
+  it 'stores resources by directory' do
+    @db_hash.keys.sort.should == %w[
+      tumblog
+      tumblog/200806/the-noble-chicken
+      tumblog/200807/historical-perspectives-on-the-classic-chicken-joke
+      tumblog/200807/mad-city-chickens
+      tumblog/200807/the-wisdom-of-the-dutch
+      tumblog/200807/up-a-tree
+    ]
+    @db_hash['tumblog'].length.should == 2
+    @db_hash['tumblog/200807/up-a-tree'].length.should == 1
+    @db_hash['tumblog/200807/up-a-tree'].first.filename.should == 'index'
+  end
+
+  it 'replaces resources when adding' do
+    ary = @db_hash['tumblog/200806/the-noble-chicken']
+    page = ary.first
+
+    @db.add Webby::Resources::Page.
+            new('content/tumblog/200806/the-noble-chicken/index.txt')
+
+    ary.first.should_not equal(page)
+    ary.first.path.should == page.path
+  end
+
+  it 'clears the stored resources' do
+    @db_hash.should_not be_empty
+    @db.clear
+    @db_hash.should be_empty
+  end
+
+  it 'iterates over the resources in order' do
+    ary = []
+    @db.each {|page| ary << page.url}
+    ary.should == %w[
+      /tumblog
+      /tumblog/rss.xml
+      /tumblog/200806/the-noble-chicken
+      /tumblog/200807/historical-perspectives-on-the-classic-chicken-joke
+      /tumblog/200807/mad-city-chickens
+      /tumblog/200807/the-wisdom-of-the-dutch
+      /tumblog/200807/up-a-tree
+    ]
+  end
+
+  it 'returns the parent of a resource' do
+    page = Webby::Resources::Page.new('content/tumblog/index.txt')
+    parent = @db.parent_of(page)
+    (parent == nil).should == true
+
+    page = Webby::Resources::Page.new('content/tumblog/rss.txt')
+    parent = @db.parent_of(page)
+    parent.url.should == '/tumblog'
+
+    page = Webby::Resources::Page.new('content/tumblog/200807/up-a-tree/index.txt')
+    parent = @db.parent_of(page)
+    parent.url.should == '/tumblog'
+  end
+
+  it 'returns the siblings of a resource' do
+    page = Webby::Resources::Page.new('content/tumblog/index.txt')
+    siblings = @db.siblings(page)
+
+    siblings.length.should == 1
+    siblings.first.path.should == 'content/tumblog/rss.txt'
+
+    page = Webby::Resources::Page.new('content/tumblog/200806/the-noble-chicken/index.txt')
+    siblings = @db.siblings(page)
+    siblings.should be_empty
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.children' do
+    it 'returns the children of a resource' do
+      page = Webby::Resources::Page.new('content/tumblog/index.txt')
+      children = @db.children(page)
+
+      children.length.should == 5
+      children.map {|page| page.url}.sort.should == %w[
+        /tumblog/200806/the-noble-chicken
+        /tumblog/200807/historical-perspectives-on-the-classic-chicken-joke
+        /tumblog/200807/mad-city-chickens
+        /tumblog/200807/the-wisdom-of-the-dutch
+        /tumblog/200807/up-a-tree
+      ]
+    end
+
+    it 'returns them in the specified sort order' do
+      page = Webby::Resources::Page.new('content/tumblog/index.txt')
+      children = @db.children(page, :sort_by => :url)
+
+      children.length.should == 5
+      children.map {|page| page.url}.should == %w[
+        /tumblog/200806/the-noble-chicken
+        /tumblog/200807/historical-perspectives-on-the-classic-chicken-joke
+        /tumblog/200807/mad-city-chickens
+        /tumblog/200807/the-wisdom-of-the-dutch
+        /tumblog/200807/up-a-tree
+      ]
+    end
+
+    it 'returns them in the reversed sort order' do
+      page = Webby::Resources::Page.new('content/tumblog/index.txt')
+      children = @db.children(page, :sort_by => :url, :reverse => true)
+
+      children.length.should == 5
+      children.map {|page| page.url}.should == %w[
+        /tumblog/200806/the-noble-chicken
+        /tumblog/200807/historical-perspectives-on-the-classic-chicken-joke
+        /tumblog/200807/mad-city-chickens
+        /tumblog/200807/the-wisdom-of-the-dutch
+        /tumblog/200807/up-a-tree
+      ].reverse
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.find' do
+    it 'returns the first page if no options are given' do
+      page = @db.each {|p| break p}
+      @db.find.path.should == page.path
+    end
+
+    it 'returns all pages' do
+      ary = []
+      @db.each {|p| ary << p.path}
+
+      pages = @db.find(:all)
+      pages.map! {|p| p.path}
+      pages.should == ary
+
+      pages = @db.find(:limit => :all)
+      pages.map! {|p| p.path}
+      pages.should == ary
+
+      pages = @db.find('all')
+      pages.map! {|p| p.path}
+      pages.should == ary
+    end
+
+    it 'returns a limited number of pages' do
+      ary = []
+      @db.each {|p| ary << p.path}
+      ary = ary.slice(0,3)
+
+      pages = @db.find(3)
+      pages.map! {|p| p.path}
+      pages.should == ary
+
+      pages = @db.find(:limit => 3)
+      pages.map! {|p| p.path}
+      pages.should == ary
+    end
+
+    it 'can sorty by a given meta-data field' do
+      pages = @db.find(:all, :sort_by => 'title')
+      pages.map! {|p| p.title}
+      pages.should == [
+        'A Mother Clucker',
+        'A Mother Clucker',
+        'Historical Perspectives on the Classic Chicken Joke',
+        'Mad City Chickens',
+        'The Noble Chicken',
+        'The Wisdom of the Dutch',
+        'Up a Tree'
+      ]
+
+      pages = @db.find(:all, :sort_by => 'tumblog_type')
+      pages.map! {|p| p.tumblog_type}
+      pages.should == %w[conversation link photo quote regular]
+    end
+
+    it 'can reverse the sort order' do
+      pages = @db.find(:all, :sort_by => 'tumblog_type', :reverse => true)
+      pages.map! {|p| p.tumblog_type}
+      pages.should == %w[conversation link photo quote regular].reverse
+
+      pages = @db.find(3, :sort_by => 'tumblog_type', :reverse => true)
+      pages.map! {|p| p.tumblog_type}
+      pages.should == %w[regular quote photo]
+    end
+
+    it 'can search is a specific directory' do
+      pages = @db.find('all', :in_directory => 'tumblog')
+      pages.map! {|p| p.path}
+      pages.should == %w[
+        content/tumblog/index.txt
+        content/tumblog/rss.txt
+      ]
+    end
+
+    it 'can recurse into directories' do
+      pages = @db.find('all', :in_directory => 'tumblog/200807', :recursive => true)
+      pages.map! {|p| p.title}
+      pages.should == [
+        'The Wisdom of the Dutch',
+        'Mad City Chickens',
+        'Historical Perspectives on the Classic Chicken Joke',
+        'Up a Tree'
+      ]
+    end
+
+    it 'can combine all these options' do
+      pages = @db.find(:limit => 2,
+                       :in_directory => 'tumblog/200807', :recursive => true,
+                       :sort_by => 'title', :reverse => true,
+                       :author => 'Tim Pease')
+      pages.map! {|p| p.title}
+      pages.should == [
+        'Up a Tree',
+        'Mad City Chickens'
+      ]
+    end
+
+    it 'can find pages using a user supplied search block' do
+      pages = @db.find(:all, :sort_by => 'title') do |page|
+        %w[quote conversation photo].include? page.tumblog_type
+      end
+      pages.map! {|p| p.title}
+      pages.should == [
+        'Historical Perspectives on the Classic Chicken Joke',
+        'The Wisdom of the Dutch',
+        'Up a Tree'
+      ]
+    end
+  end
+
+end  # describe Webby::Resources::DB
+
+# EOF

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[site 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,171 @@
+
+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[site 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[site 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[site content photos.txt]
+    File.open(fn, 'r') do |fd|
+      mf = Webby::Resources::MetaFile.new(fd)
+      mf.meta_count.should == 3
+    end
+  end
+
+  it 'determines the end of the final meta-data block' do
+    fn = Webby.datapath %w[site content index.txt]
+    File.open(fn, 'r') do |fd|
+      mf = Webby::Resources::MetaFile.new(fd)
+      mf.meta_end.should == 7
+    end
+
+    fn = Webby.datapath %w[site content photos.txt]
+    File.open(fn, 'r') do |fd|
+      mf = Webby::Resources::MetaFile.new(fd)
+      mf.meta_end.should == 18
+    end
+  end
+
+  # -----------------------------------------------------------------------
+  describe '.each' do
+    it 'yields each meta-data block' do
+      fn = Webby.datapath %w[site 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[site 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[site 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[site 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[site 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[site 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[site 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[site 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[site 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[site 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