nanoc-toolbox 0.0.7 → 0.1.0

data/spec/helpers/google_analytics_spec.rb

@@ -1,17 +1,37 @@
 require "spec_helper"
-include Nanoc::Toolbox::Helpers::GoogleAnalytics
+
+
+class GoogleAnalyticsDummyClass
+  include Nanoc::Toolbox::Helpers::GoogleAnalytics
+  def initialize
+    @config = { :ga_tracking_code => "UA-0000000-0" } 
+  end
+end
 
 describe Nanoc::Toolbox::Helpers::GoogleAnalytics do
-  subject { Nanoc::Toolbox::Helpers::GoogleAnalytics }
+  subject { GoogleAnalyticsDummyClass.new }
+  
   it { should respond_to(:ga_tracking_snippet) }
+  
   describe ".ga_tracking_snippet" do
+    
     it "returns a string that contains the JS" do
-      ga_tracking_snippet("").should include("<script")
-      ga_tracking_snippet("").should include("var _gaq = _gaq || [];")
+      subject.ga_tracking_snippet().should include("<script")
+      subject.ga_tracking_snippet().should include("var _gaq = _gaq || [];")
     end
-    
+
     it "includes the passed code" do
-      ga_tracking_snippet("qwertzuiop").should include("qwertzuiop")      
+      subject.ga_tracking_snippet("UA-123456-1").should include("UA-123456-1")
+    end
+
+    it "includes the tracking code from the site config" do
+      subject.instance_variable_set(:@config, { :ga_tracking_code => "UA-0000000-0"})
+      subject.ga_tracking_snippet().should include "UA-0000000-0"
+    end
+
+    it "includes the placeholder code when no value is found" do
+      subject.instance_variable_set(:@config, { })
+      subject.ga_tracking_snippet().should include "UA-xxxxxx-x"
     end
   end
-end
+end

data/spec/helpers/gravatar_spec.rb

@@ -1,85 +1,85 @@
 require "spec_helper"
 
 class GravatarDummyClass
+  include Nanoc::Toolbox::Helpers::Gravatar
 end
 
 describe Nanoc::Toolbox::Helpers::Gravatar do
-  before(:each) do
-    @gravatar = GravatarDummyClass.new
-    @gravatar.extend(described_class)
-    
+  subject { GravatarDummyClass.new }
+
+  before(:all) do
     @email = 'anouar@adlani.com'
     @avatar = 'avatar/4d076af1db60b16e1ce080505baf821c'
     @secure_host = {
       true => 'https://secure.gratatar.com/' + @avatar,
       false => 'http://gravatar.com/' + @avatar
     }
-    
   end
 
-  describe "#@gravatar.gravatar_url" do
+  it { should respond_to(:gravatar_url) }
+  it { should respond_to(:gravatar_image) }
+
+
+  describe "#subject.gravatar_url" do
     context "when no parameters passed in the options" do
       it "converts an email address to the a gravatar URL" do
-        @gravatar.gravatar_url(@email).should == @secure_host[false]
+        subject.gravatar_url(@email).should == @secure_host[false]
       end
 
       it "converts an email address to the a secure gravatar URL when requested" do
-        @gravatar.gravatar_url(@email, :secure => true).should == @secure_host[true]
+        subject.gravatar_url(@email, :secure => true).should == @secure_host[true]
       end
       
       it "raise an Argument error when the email is invalid" do
-        lambda{@gravatar.gravatar_url('')}.should raise_error(ArgumentError)
-        lambda{@gravatar.gravatar_url('a@a.c')}.should raise_error(ArgumentError)
-        lambda{@gravatar.gravatar_url('@example.com')}.should raise_error(ArgumentError)
-        lambda{@gravatar.gravatar_url('name@name@example.com')}.should raise_error(ArgumentError)
+        lambda{subject.gravatar_url('')}.should raise_error(ArgumentError)
+        lambda{subject.gravatar_url('a@a.c')}.should raise_error(ArgumentError)
+        lambda{subject.gravatar_url('@example.com')}.should raise_error(ArgumentError)
+        lambda{subject.gravatar_url('name@name@example.com')}.should raise_error(ArgumentError)
       end
       
       it "strips the additionnal spaces before and after the email" do
-        @gravatar.gravatar_url(" \n  #{@email}   \n").should == @secure_host[false]
+        subject.gravatar_url(" \n  #{@email}   \n").should == @secure_host[false]
       end
     end
 
-
     context "when parameters passed in the options" do
-      
       it "removes unknown parameters" do
-        @gravatar.gravatar_url(@email, :blabl => 'jsdfsdfsd').should == @secure_host[false]
+        subject.gravatar_url(@email, :blabl => 'jsdfsdfsd').should == @secure_host[false]
       end
 
       it "removes empty or nil parameters" do
-        @gravatar.gravatar_url(@email, :size => '', :rating => nil).should == @secure_host[false]
+        subject.gravatar_url(@email, :size => '', :rating => nil).should == @secure_host[false]
       end
 
       it "should sort the url parameters" do
-        @gravatar.gravatar_url(@email, :size => 45, :default_icon => 'monsterid', :rating => 'x').should == @secure_host[false] + '?default_icon=monsterid&rating=x&size=45'
+        subject.gravatar_url(@email, :size => 45, :default_icon => 'monsterid', :rating => 'x').should == @secure_host[false] + '?default_icon=monsterid&rating=x&size=45'
       end
 
       it "accepts well formed option and render them" do
-        @gravatar.gravatar_url(@email, :size => 45, :rating => 'x').should == @secure_host[false] + '?rating=x&size=45'
+        subject.gravatar_url(@email, :size => 45, :rating => 'x').should == @secure_host[false] + '?rating=x&size=45'
       end
       
       it "ignores the bad type or the out of rnage parameters" do
-        @gravatar.gravatar_url(@email, :size => '45', :rating => 'xssss').should == @secure_host[false] + '?size=45'
+        subject.gravatar_url(@email, :size => '45', :rating => 'xssss').should == @secure_host[false] + '?size=45'
       end
     end
   end
   
   describe "#gravatar_image" do
-    
     it "converts an email to an html tag" do
-      @gravatar.gravatar_image(@email).should == %[<img src="#{@secure_host[false]}" />]
+      subject.gravatar_image(@email).should == %[<img src="#{@secure_host[false]}" />]
     end
     
     it "converts an email to an html tag with options for the gravatar" do
-      @gravatar.gravatar_image(@email,  :size => 45, :default_icon => 'monsterid', :rating => 'xss').should == %[<img src="#{@secure_host[false]}?default_icon=monsterid&size=45" />]
+      subject.gravatar_image(@email,  :size => 45, :default_icon => 'monsterid', :rating => 'xss').should == %[<img src="#{@secure_host[false]}?default_icon=monsterid&size=45" />]
     end
     
     it "converts an email to an html tag with options for the img tag" do
-      @gravatar.gravatar_image(@email,  :height => 10).should == %[<img height="10" src="#{@secure_host[false]}" />]
+      subject.gravatar_image(@email,  :height => 10).should == %[<img height="10" src="#{@secure_host[false]}" />]
     end
     
     it "converts an email to an html tag with options for the gravatar and for the img" do
-      @gravatar.gravatar_image(@email,  :height => 10, :size => 45, :default_icon => 'monsterid', :rating => 'xss').should == %[<img height="10" src="#{@secure_host[false]}?default_icon=monsterid&size=45" />]
+      subject.gravatar_image(@email,  :height => 10, :size => 45, :default_icon => 'monsterid', :rating => 'xss').should == %[<img height="10" src="#{@secure_host[false]}?default_icon=monsterid&size=45" />]
     end
   end
 end

data/spec/helpers/html_tag_spec.rb

@@ -2,6 +2,9 @@ require "spec_helper"
 include Nanoc::Toolbox::Helpers::HtmlTag
 
 describe Nanoc::Toolbox::Helpers::HtmlTag do
+  it { should respond_to(:tag) }
+  it { should respond_to(:content_tag) }
+
   describe "#tag" do
     it "returns an simple self-closing tag by default" do
       tag("br").should == "<br />"
@@ -10,6 +13,10 @@ describe Nanoc::Toolbox::Helpers::HtmlTag do
     it "returns an simple self-closing tag with option" do
       tag("hr", :class => "thin").should == %[<hr class="thin" />]
     end
+
+    it "returns an orphean tag when open is set to true" do
+      tag("hr", {:class => "thin"}, true).should == %[<hr class="thin">]
+    end
   end
   
   describe "#content_tag" do
@@ -21,4 +28,4 @@ describe Nanoc::Toolbox::Helpers::HtmlTag do
       content_tag("b", "Hello", :class => "highlight").should == %[<b class="highlight">Hello</b>]
     end
   end
-end
+end

data/spec/helpers/navigation_spec.rb

@@ -1,81 +1,142 @@
 require "spec_helper"
 
-
 class NavigationDummyClass
+  include Nanoc::Toolbox::Helpers::Navigation
 end
 
 describe Nanoc::Toolbox::Helpers::Navigation do
-  before(:each) do
-    @navigation = NavigationDummyClass.new
-    @navigation.extend(described_class)
-  end
+  subject { NavigationDummyClass.new }
+
+  it { should respond_to(:render_menu) }
+  it { should respond_to(:navigation_for) }
+  it { should respond_to(:toc_for) }
+  it { should respond_to(:breadcrumb_for) }
 
   describe ".render_menu" do
+    before do
+      @sections     = [
+        {:title => "Title", :link => "http://example.com", :subsections => [
+          {:title => "Title", :link => "http://example.com", :subsections => [
+            {:title => "Title", :link => "http://example.com", :subsections => [
+              {:title => "Title", :link => "http://example.com"}
+            ]}
+          ]}
+        ]}]
+    end
+
     context "when no options specified" do
+
       it "returns nil when the menu is empty" do
-        @navigation.render_menu([]).should be_nil
+        subject.render_menu([]).should be_nil
       end
 
       it "returns a simple ordered list when given a 1 level menu" do
         sections = [{:title => "Title", :link => "http://example.com" }]
-        html_menu = %[<ol><li><a href="http://example.com">Title</a></li></ol>]
-
-        @navigation.render_menu(sections).should == html_menu
+        html_menu = %[<ol class="menu"><li><a href="http://example.com">Title</a></li></ol>]
+        subject.render_menu(sections).should == html_menu
       end
 
       it "returns a nested ordered list when given a multi level menu" do
-        sections     = [{:title => "Title", :link => "http://example.com", :subsections => [{:title => "Title", :link => "http://example.com" },{:title => "Title", :link => "http://example.com" }] }]
-        html_menu = %[<ol><li><a href="http://example.com">Title</a><ol><li><a href="http://example.com">Title</a></li><li><a href="http://example.com">Title</a></li></ol></li></ol>]
-
-        @navigation.render_menu(sections).should == html_menu
+        html_menu = %[<ol class="menu"><li><a href="http://example.com">Title</a><ol class="menu"><li><a href="http://example.com">Title</a><ol class="menu"><li><a href="http://example.com">Title</a></li></ol></li></ol></li></ol>]
+        subject.render_menu(@sections).should == html_menu
       end
 
-      it "returns only 3 levels when nothing is specified in the options" do
-        sections     = [
-          {:title => "Title", :link => "http://example.com", :subsections => [
-            {:title => "Title", :link => "http://example.com", :subsections => [
-              {:title => "Title", :link => "http://example.com", :subsections => [
-                {:title => "Title", :link => "http://example.com"}
-              ]}
-            ]}
-          ]}]
-        html_menu = %[<ol><li><a href="http://example.com">Title</a><ol><li><a href="http://example.com">Title</a><ol><li><a href="http://example.com">Title</a></li></ol></li></ol></li></ol>]
-        @navigation.render_menu(sections).should == html_menu
+      it "returns only 3 levels deep" do
+          html_menu = %[<ol class="menu"><li><a href="http://example.com">Title</a><ol class="menu"><li><a href="http://example.com">Title</a><ol class="menu"><li><a href="http://example.com">Title</a></li></ol></li></ol></li></ol>]
+          subject.render_menu(@sections).should == html_menu
       end
 
-      it "returns menu within an html ordered list (<ol> <li>) when nothing is specified in the options" do
-        sections = [{:title => "Title", :link => "http://example.com" }]
-          @navigation.render_menu(sections).should =~ /^<ol><li>/
+      it "returns menu within an html ordered list with menu class(<ol> <li>)" do
+        subject.render_menu(@sections).should =~ /^<ol class="menu"><li>/
       end
     end
-    
-    context "when no options specified" do
-      it "returns menu within a html unordered list (<ul> <li>) when it is specified in the options" do
-        sections = [{:title => "Title", :link => "http://example.com" }]
-          @navigation.render_menu(sections, :collection_tag => 'ul').should =~ /^<ul><li>/
+
+    context "when options specified" do
+      it "renders a title" do
+        subject.render_menu(@sections, :title => 'title').should =~ /^<h2>title<\/h2>/
+        subject.render_menu(@sections, :title => 'title', :title_tag => 'h1').should =~ /^<h1>title<\/h1>/
       end
-      
-      it "returns menu within a div/span when it is specified in the options" do
-        sections = [{:title => "Title", :link => "http://example.com" }]
-          @navigation.render_menu(sections, :collection_tag => 'div', :item_tag => 'span').should =~ /^<div><span>/
+      it "returns menu within a html unordered list (<ul> <li>) " do
+        subject.render_menu(@sections, :collection_tag => 'ul').should =~ /^<ul class="menu"><li>/
       end
-      
-      it "returns only 2 levels when it's specified in the options" do
-        sections     = [
-          {:title => "Title", :link => "http://example.com", :subsections => [
-            {:title => "Title", :link => "http://example.com", :subsections => [
-              {:title => "Title", :link => "http://example.com", :subsections => [
-                {:title => "Title", :link => "http://example.com"}
-              ]}
-            ]}
-          ]}]
-        html_menu = %[<ol><li><a href="http://example.com">Title</a><ol><li><a href="http://example.com">Title</a></li></ol></li></ol>]
-        @navigation.render_menu(sections, :depth => 2).should == html_menu
+
+      it "returns menu within a div/span " do
+        subject.render_menu(@sections, :collection_tag => 'div', :item_tag => 'span').should =~ /^<div class="menu"><span>/
+      end
+
+      it "returns only 2 levels deep" do
+        html_menu = %[<ol class="menu"><li><a href="http://example.com">Title</a><ol class="menu"><li><a href="http://example.com">Title</a></li></ol></li></ol>]
+        subject.render_menu(@sections, :depth => 2).should == html_menu
+      end
+
+      it "set a specific class name" do
+        subject.render_menu(@sections, :collection_tag => 'ul').should =~ /^<ul class="menu"><li>/
       end
     end
   end
 
   describe ".toc_for" do
-    it "should return a toc for a page"
+    before :all do
+      @content = <<-EOS
+        <html>
+          <body>
+            <div id="title1" class="section">
+              <h1>Title 1</h1>
+              <div  id="title21" class="section">
+                <h2>Title 2<h2>
+              </div>
+              <div id="title22" class="section">
+                <h2>Title 2<h2>
+              </div>
+              <div  id="title23" class="section">
+                <h2>Title 2<h2>
+              </div>
+            </div>
+          </body>
+        </html>
+      EOS
+    end
+
+    it "should return a toc for a page" do
+      item_rep = Nanoc::ItemRep.new(Nanoc::Item.new("", {:title => ""},  "/yetAnotherItem/"), "")
+      item_rep.instance_variable_set :@content, {:pre => @content}
+
+      subject.toc_for(item_rep).should include "#title1"
+      subject.toc_for(item_rep).should include "#title21"
+      subject.toc_for(item_rep).should include "#title22"
+      subject.toc_for(item_rep).should include "#title23"
+
+      subject.toc_for(item_rep).should include "Title 1"
+      subject.toc_for(item_rep).should include "Title 2"
+    end
+
+    it "calls find_to_sections and render_menu for the formating" do
+      item_rep = Nanoc::ItemRep.new(Nanoc::Item.new("", {:title => ""},  "/yetAnotherItem/"), "")
+      item_rep.instance_variable_set :@content, {:pre => @content}
+
+      subject.should_receive(:find_toc_sections).once
+      subject.should_receive(:render_menu).once
+      subject.toc_for(item_rep)
+    end
+
+    it "returns an empty string when the main content is empty" do
+      item_rep = Nanoc::ItemRep.new(Nanoc::Item.new("", {:title => ""},  "/yetAnotherItem/"), "")
+      item_rep.instance_variable_set :@content, {:pre => ""}
+      subject.toc_for(item_rep).should eq ""
+    end
+
+    it "returns an empty string when the provided css path returns nothing" do
+      item_rep = Nanoc::ItemRep.new(Nanoc::Item.new("", {:title => ""},  "/yetAnotherItem/"), "")
+      item_rep.instance_variable_set :@content, {:pre => @content}
+      subject.toc_for(item_rep, {:path => "section"}).should eq ""
+    end
+  end
+
+  describe ".navigation_for" do
+    it "should return a navigation menu for a item" 
+  end
+
+  describe ".breadcrumb_for" do
+    it "should return a breadcrumb for an item"
   end
 end

data/spec/helpers/tagging_extra_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+class DummyTaggingExtra
+  include Nanoc::Toolbox::Helpers::TaggingExtra
+end
+
+describe Nanoc::Toolbox::Helpers::TaggingExtra do
+  subject { DummyTaggingExtra.new }
+
+  it { should respond_to :tag_set }
+  it { should respond_to :has_tag? }
+  it { should respond_to :items_with_tag }
+  it { should respond_to :count_tags }
+  it { should respond_to :rank_tags }
+  it { should respond_to :create_tag_pages }
+  it { should respond_to :tag_links_for }
+
+  describe ".tag_set" do
+    it "returns all the tags present in a collection of item" do
+      items = [ {:tags => ['a', 'b', 'c', 'd']}, {:tags => ['e', 'f']} ]
+      subject.tag_set(items).should eq %w{a b c d e f}
+    end
+
+    it "returns distinct tags in a collection of items" do
+      items = [ {:tags => ['a', 'b', 'c', 'd']}, {:tags => ['a', 'd', 'c', 'e', 'f']}]
+      subject.tag_set(items).should eq %w{a b c d e f}
+    end
+
+    it "returns tags without nil value when an item has no tag" do
+      items = [ {:tags => ['a', 'b', 'c', 'd']}, {:tags => ['a', 'd', 'c', 'e', 'f']}, {}]
+      subject.tag_set(items).should eq %w{a b c d e f}
+    end
+  end
+
+  describe ".has_tag?" do
+    it "returns true when the item contains the desired tag" do
+      item = { :tags => ['a', 'b', 'c'] }
+      subject.has_tag?(item, 'a').should be_true
+    end
+    it "returns false when the item contains the desired tag" do
+      item = { :tags => ['a', 'b', 'c'] }
+      subject.has_tag?(item, 'd').should be_false
+    end
+    it "returns fals when the item do not have tag" do
+      item = { }
+      subject.has_tag?(item, 'd').should be_false
+    end
+  end
+
+  describe ".items_with_tag" do
+    it "returns only the item whith the specified tag" do
+      item_a = {:tags => ['a', 'b', 'c', 'd']}
+      item_b = {:tags => ['a', 'd', 'c', 'e', 'f']}
+      items = [ item_a, item_b, {}]
+      subject.items_with_tag('f', items).should eq [item_b]
+    end
+
+    it "returns only all the item whith the specified tag" do
+      item_a = {:tags => ['a', 'b', 'c', 'd']}
+      item_b = {:tags => ['a', 'd', 'c', 'e', 'f']}
+      items = [ item_a, item_b, {}]
+      subject.items_with_tag('a', items).should eq [item_a, item_b]
+    end
+
+    it "returns an empty array when no item has been found" do
+      item_a = {:tags => ['a', 'b', 'c', 'd']}
+      item_b = {:tags => ['a', 'd', 'c', 'e', 'f']}
+      items = [ item_a, item_b, {}]
+      subject.items_with_tag('g', items).should eq []
+    end
+  end
+
+  describe ".count_tag" do
+    it "return the occurences of all the tags in a collection of item" do
+      items = [ {:tags => ['a', 'b', 'c', 'd']}, {:tags => ['a', 'd', 'c', 'e' ]}]
+      subject.count_tags(items).should eq({'a' => 2, 'b' => 1, 'c' => 2, 'd' => 2, 'e' => 1 })
+    end
+    it "return the occurences of all the tags without the empty item" do
+      items = [ {:tags => ['a', 'b', 'c', 'd']}, {:tags => ['a', 'd', 'c', 'e' ]}, {}]
+      subject.count_tags(items).should eq({'a' => 2, 'b' => 1, 'c' => 2, 'd' => 2, 'e' => 1 })
+    end
+  end
+
+  describe ".rank_tags" do
+     it "Sort the tags of an item collection in N classes of rank" do
+       items = [ {:tags => ['a', 'b']}, {:tags => ['b', 'c']} ]
+       subject.rank_tags(2, items)['a'].should eq 1
+       subject.rank_tags(2, items)['b'].should eq 0
+       subject.rank_tags(2, items)['c'].should eq 1
+     end
+
+     it "Raises exception when the number of argument is invalid" do
+       items = [ {:tags => ['a', 'b']}, {:tags => ['b', 'c']} ]
+       lambda { subject.rank_tags(-1, items) }.should raise_error ArgumentError
+       lambda { subject.rank_tags(0, items) }.should raise_error ArgumentError
+       lambda { subject.rank_tags(1, items) }.should raise_error ArgumentError
+     end
+  end
+
+  describe ".create_tag_pages" do
+     it "Creates in-memory tag pages" do
+       subject.instance_variable_set(:@items, [ {:tags => ['a', 'b']}, {:tags => ['b', 'c']} ])
+
+       expect {
+         subject.create_tag_pages
+       }.to change { subject.instance_variable_get(:@items).size }.by(3)
+
+       subject.instance_variable_get(:@items).last(3).each do |tag_item|
+         tag_item.should be_a Nanoc::Item
+         tag_item.identifier.should =~ /^\/tags\//
+       end
+     end
+  end
+
+  describe ".tag_links_for" do
+    it "generates the tags lings corresponding to the parameter" do
+      tags = %W[a b c d e f]
+      item = { :tags => tags }
+      subject.tag_links_for(item).size.should == tags.size
+      tags.each do |t|
+        subject.tag_links_for(item).should include("<a href=\"/tags/#{t}.html\">#{t}</a>")
+      end
+    end
+
+    it "generates the same number of links than tags" do
+      tags = %W[a b c d e f]
+      subject.tag_links_for({ :tags => tags }).size.should == 6
+    end
+
+    it "excludes the tags passed as second parameter" do
+      omited = %W[ d e ]
+      item = { :tags => %W[a b c d e f] }
+
+      generated_links = subject.tag_links_for(item, omited)
+      generated_links.size.should == (item[:tags].size - omited.size)
+
+      omited.each do |t|
+        generated_links.should_not include("<a href=\"/tags/#{t}.html\">#{t}</a>")
+      end
+    end
+
+    it "handle the tag format in the URL and title passed in param" do
+      tags = %W[a b c d e f]
+      item = { :tags => tags }
+      omited = []
+      options = { :title => "all articles tagged with %%TAGNAME%%", :tag_pattern => "%%TAGNAME%%", :url_format => "/tags/tag_%%TAGNAME%%.html"}
+
+      generated_links = subject.tag_links_for(item, omited, options)
+      tags.each do |t|
+        generated_links.should include("<a href=\"/tags/tag_#{t}.html\">all articles tagged with #{t}</a>")
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+
 require "rspec/core"
 require 'rspec/mocks'
 require "nanoc/toolbox"
+require "nanoc3"
 
 unless defined?(SPEC_ROOT)
   SPEC_ROOT = File.expand_path("../", __FILE__)
@@ -8,4 +12,4 @@ end
 
 RSpec.configure do |config|
   config.mock_with :rspec
-end
+end