polygon 0.0.3 → 0.9.1

data/spec/core_ext/test_epath.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+describe Path, "core extensions" do
+
+  def load(file)
+    (fixtures_path / "data" / file).load
+  end
+
+  it 'loads json correctly' do
+    load('data.json').should eq("kind" => "json")
+  end
+
+  it 'loads yaml correctly' do
+    load('data.yaml').should eq("kind" => "yaml")
+    load('data.yml').should eq("kind" => "yml")
+  end
+
+  it 'loads ruby correctly' do
+    load('data.ruby').should eq("kind" => "ruby")
+    load('data.rb').should eq("kind" => "rb")
+  end
+
+  it 'load .md correctly, when no front matter' do
+    load('text.md').should eq("content" => "This is the text")
+  end
+
+  it 'load .md correctly, when empty front matter' do
+    load('empty.md').should eq("content" => "This is the text\n")
+  end
+
+  it 'load .md correctly, when a front matter' do
+    load('data.md').should eq("kind" => "md", "content" => "This is the text")
+  end
+
+end

data/spec/database/test_entries.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+module Polygon
+  describe Database, "entries" do
+
+    let(:database){ Database.new fixtures_path }
+
+    subject{ database.entries }
+
+    it 'is returned by dataset' do
+      subject.should eq(database.dataset(:entries))
+    end
+
+    it 'returns a Alf::Iterator' do
+      subject.should be_a(Alf::Iterator)
+    end
+
+    it 'iterates tuples with entries' do
+      subject.each do |tuple|
+        tuple.should have_key(:entry)
+        tuple[:entry].should be_a(Entry)
+      end
+    end
+
+    it 'iterates tuples with entries of different paths' do
+      paths = subject.map{|t| t[:entry].relative_path.to_s }.uniq
+      paths.size.should eq(subject.to_a.size)
+    end
+
+  end
+end

data/spec/database/test_sitemap.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module Polygon
+  describe Database, "entries" do
+
+    let(:database){ Database.new fixtures_path }
+
+    subject{ database.sitemap }
+
+    it 'is returned by dataset' do
+      subject.should eq(database.dataset(:sitemap))
+    end
+
+    it 'returns a Alf::Iterator' do
+      subject.should be_a(Alf::Iterator)
+    end
+
+    it 'iterates tuples with entries, path and lastmod' do
+      subject.each do |tuple|
+        tuple.should have_key(:entry)
+        tuple[:entry].should be_a(Entry)
+
+        tuple.should have_key(:path)
+        tuple[:path].should be_a(String)
+
+        tuple.should have_key(:lastmod)
+        tuple[:lastmod].should be_a(String)
+      end
+    end
+
+  end
+end

data/spec/entry/test_ancestors_or_self.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'ancestors_or_self' do
+
+    subject{ entry.ancestors_or_self(filter) }
+
+    context 'when a normal entry in root' do
+      let(:filter){ false }
+      let(:entry){ Entry.new(Path.dir, Path.here % Path.dir) }
+      it "should contain all index files" do
+        expected = entry.index_files.map{|index|
+          Entry.new(Path.dir, index)
+        } + [ entry ]
+        subject.should eq(expected)
+      end
+    end
+
+    context 'when filtered' do
+      let(:filter){ true }
+      let(:entry){ Entry.new(Path.dir, Path.here % Path.dir) }
+      it "should contain only existing files" do
+        subject.should eq([ entry ])
+      end
+    end
+
+    context 'when the root and not filtered' do
+      let(:filter){ false }
+      let(:entry){ Entry.new(Path.dir, 'index.yml') }
+      it "should be the singleton" do
+        subject.should eq([entry])
+      end
+    end
+
+    context 'when the root and filtered' do
+      let(:filter){ true }
+      let(:entry){ Entry.new(Path.dir, "index.yml") }
+      it "should be empty" do
+        subject.should eq([])
+      end
+    end
+
+  end
+end

data/spec/entry/test_divide.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'divide' do
+
+    let(:entry){ Entry.new(Path.dir, Path.dir) }
+
+    subject{ entry / path }
+
+    context "when it stays inside the root" do
+      let(:path){ "somewhere/somefile.yml" }
+      it 'should return an Entry instance' do
+        subject.should be_a(Entry)
+      end
+      it 'should return the correct instance' do
+        subject.path.should eq(Path.dir / "somewhere/somefile.yml")
+      end
+    end
+
+    context "when it exits the root" do
+      let(:path){ "../somefile.yml" }
+      it 'should return nil' do
+        subject.should be_nil
+      end
+    end
+
+  end
+end

data/spec/entry/test_equality.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, '==' do
+
+    subject{ left == right }
+
+    context 'when the same entries' do
+      let(:left) { Entry.new(Path.dir, Path.here % Path.dir) }
+      let(:right){ Entry.new(Path.dir, Path.here % Path.dir) }
+      it{ should be_true }
+    end
+
+    context 'when not the same entries' do
+      let(:left) { Entry.new(Path.dir, Path.here % Path.dir) }
+      let(:right){ Entry.new(Path.dir, "another one") }
+      it{ should be_false }
+    end
+
+    context 'when bad comparison' do
+      let(:left) { Entry.new(Path.dir, Path.here % Path.dir) }
+      let(:right){ 12 }
+      it{ should be_false }
+    end
+
+  end
+end

data/spec/entry/test_exist.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'exist?' do
+
+    subject{ entry.exist? }
+
+    context 'when it exists' do
+      let(:entry){ Entry.new(Path.dir, Path.here % Path.dir) }
+      it{ should be_true }
+    end
+
+    context 'when it does not exists' do
+      let(:entry){ Entry.new(Path.dir, "nosuchone.md") }
+      it{ should be_false }
+    end
+
+  end
+end

data/spec/entry/test_extensions.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'extensions' do
+
+    let(:entry){ Entry.new(Path.dir, Path.here % Path.dir, options) }
+
+    subject{ entry.extensions }
+
+    before do
+      subject.should be_a(Array)
+      subject.all?{|e| e.should be_a(String) }
+    end
+
+    context 'with default options' do
+      let(:options){ {} }
+      it 'should contain expected extensions' do
+        subject.should eq(['yml', 'md'])
+      end
+    end
+
+    context 'with explicit options' do
+      let(:options){ {:extensions => ["yml", "rb"]} }
+      it 'should contain expected extensions' do
+        subject.should eq(['yml', 'rb'])
+      end
+    end
+
+  end
+end

data/spec/entry/test_hash.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'hash' do
+
+    it 'should be consistent with ==' do
+      e = Entry.new(Path.dir, Path.here % Path.dir)
+      f = Entry.new(Path.dir, Path.here % Path.dir)
+      g = Entry.new(Path.dir, 'another one')
+      e.hash.should eq(f.hash)
+      e.hash.should_not eq(g.hash)
+    end
+
+  end
+end

data/spec/entry/test_index.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'index?' do
+
+    subject{ entry.index? }
+
+    context 'when an index file' do
+      let(:entry){ Entry.new(Path.dir, "index.yml") }
+      it{ should be_true }
+    end
+
+    context 'when not an index file' do
+      let(:entry){ Entry.new(Path.dir, "nosuchone.md") }
+      it{ should be_false }
+    end
+
+  end
+end

data/spec/entry/test_index_files.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'index_files' do
+
+    let(:entry){ Entry.new(Path.dir, Path.here % Path.dir, options) }
+
+    subject{ entry.index_files }
+
+    before do
+      subject.should be_a(Array)
+      subject.all?{|e| e.should be_a(String) }
+    end
+
+    context 'with default options' do
+      let(:options){ {} }
+      it 'should contain expected index files' do
+        subject.should eq(['index.yml', 'index.md'])
+      end
+    end
+
+    context 'with explicit options' do
+      let(:options){ {:extensions => ["yml", "rb"]} }
+      it 'should contain expected index files' do
+        subject.should eq(['index.yml', 'index.rb'])
+      end
+    end
+
+  end
+end

data/spec/entry/test_parent.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'parent' do
+
+    subject{ entry.parent }
+
+    before do
+      subject.should be_a(Entry) unless subject.nil?
+    end
+
+    context 'when a normal entry' do
+      let(:entry){ Entry.new(Path.dir, Path.here % Path.dir) }
+      it "should be the last index file" do
+        subject.path.should eq(Path.dir / entry.index_file(-1))
+      end
+    end
+
+    context 'when the second index file' do
+      let(:entry){ Entry.new(Path.dir, "index.md") }
+      it "should be the first index file" do
+        subject.path.should eq(Path.dir / entry.index_file(0))
+      end
+    end
+
+    context 'when the first index file and not in root' do
+      let(:entry){ Entry.new(Path.dir, Path("subfolder") / "index.yml") }
+      it "should be the last index of the parent" do
+        subject.path.should eq(Path.dir / entry.index_file(-1))
+      end
+    end
+
+    context 'when the first index file and not in' do
+      let(:entry){ Entry.new(Path.dir, "index.yml") }
+      it "should be nil" do
+        subject.should be_nil
+      end
+    end
+
+  end
+end

data/spec/entry/test_path.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'path' do
+
+    let(:entry){ Entry.new(Path.dir, Path.here % Path.dir) }
+
+    subject{ entry.path }
+
+    it 'is a path instance' do
+      subject.should be_a(Path)
+    end
+
+    it "is the concatenation of root and relative_path" do
+      subject.should eq(entry.root / entry.relative_path)
+      subject.should eq(Path.here)
+    end
+
+  end
+end

data/spec/entry/test_to_hash.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+module Polygon
+  describe Entry, 'to_hash' do
+
+    let(:fixtures){ Entry.new(fixtures_path, "") }
+
+    subject{ entry.to_hash }
+
+    context 'on with_index_yml/say-hello.md' do
+      let(:entry){ fixtures / "with_index_yml/say-hello.md" }
+      it 'should take all data along ancestors' do
+        expected = {
+          "title"    => "Say Hello",
+          "content"  => "# How to Say Hello to World?\n\nThis way!\n",
+          "keywords" => ["say-hello", "with_index_yml/index.yml", "root"]
+        }
+        subject.should eq(expected)
+      end
+    end
+
+  end
+end

data/spec/fixtures/data/empty.md

@@ -0,0 +1,3 @@
+---
+---
+This is the text

data/spec/spec_helper.rb

@@ -1,2 +1,18 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'polygon'
+
+class Polygon::Entry
+  public :extensions, :index_files, :index_file
+end
+
+module Helpers
+
+  def fixtures_path
+    Path.dir / "fixtures"
+  end
+
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

data/spec/test_polygon.rb

@@ -5,4 +5,14 @@ describe Polygon do
     Polygon.const_defined?(:VERSION).should be_true
   end
 
+  def markdown(x)
+    x.upcase
+  end
+
+  it 'installs a friendly html dialect' do
+    tpl = Tilt['wlang'].new{ "~{content}" }
+    got = tpl.render(self, :content => "hello world!")
+    got.should eq("HELLO WORLD!")
+  end
+
 end

data/tasks/yard.rake

@@ -0,0 +1,51 @@
+# Installs a rake task to generate API documentation using yard.
+#
+# This file installs the 'rake yard' task. It is automatically generated by Noe from
+# your .noespec file, and should therefore be configured there, under the
+# variables/rake_tasks/yard entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     yard:
+#       files: lib/**/*.rb
+#       options: []
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/yard.rake:
+#       safe-override: false
+#
+# This file has been written to conform to yard v0.6.4. More information about
+# yard and the rake task installed below can be found on http://yardoc.org/
+#
+begin
+  require "yard"
+  desc "Generate yard documentation"
+  YARD::Rake::YardocTask.new(:yard) do |t|
+    # Array of options passed to yardoc commandline. See 'yardoc --help' about this
+    t.options = ["--output-dir", "doc/api", "-", "README.md", "CHANGELOG.md", "LICENCE.md"]
+
+    # Array of ruby source files (and any extra documentation files
+    # separated by '-')
+    t.files = ["lib/**/*.rb"]
+
+    # A proc to call before running the task
+    # t.before = proc{ }
+
+    # A proc to call after running the task
+    # r.after = proc{ }
+
+    # An optional lambda to run against all objects being generated.
+    # Any object that the lambda returns false for will be excluded
+    # from documentation.
+    # t.verifier = lambda{|obj| true}
+  end
+rescue LoadError
+  task :yard do
+    abort 'yard is not available. In order to run yard, you must: gem install yard'
+  end
+end