noumenon 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.1.3
+
+## New Features
+
+* Add the nav_menu template tag for generating menus from the content repository.
+* Make RSpec output color when running Rake
+* Tidied up the Cucumber features
+
+## Bug Fixes
+
 # 0.1.2
 
 ## New Features

data/Rakefile

@@ -5,7 +5,9 @@ require 'yard/rake/yardoc_task'
 
 task :default => [ :spec, :cucumber ]
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--color)
+end
 
 Cucumber::Rake::Task.new do |t|
   t.cucumber_opts = %w(--format progress)

data/features/step_definitions/navigation_steps.rb

@@ -0,0 +1,26 @@
+def check_for_items(menu_items)
+  menu_items.hashes.each do |item|
+    page.should have_css "li a[href='#{item["Link Target"]}']", :text => item["Label"]
+  end
+end
+
+Then /^a menu with the following items should be visible:$/ do |menu_items|
+  page.should have_css "nav ul"
+  within "nav ul" do
+    check_for_items(menu_items)
+  end
+end
+
+Then /^the "([^"]*)" menu item should have these children:$/ do |label, items|
+  within("nav ul li", :text => label) do
+    check_for_items(items)
+  end
+end
+
+Then /^these menu items should not be visible:$/ do |items|
+  within "nav ul" do
+    items.hashes.each do |item|
+      page.should have_no_css "li a[href='#{item["Link Target"]}']", :text => item["Label"]
+    end
+  end
+end

data/features/template_tags/assign_to.feature

@@ -0,0 +1,15 @@
+Feature: The assign_to tag
+  As a designer
+  I want to assign a variable in my template
+  So that I can use it multiple times later
+
+  Scenario: Assigning the variable
+    Given this template exists at "assign.nou.html"
+      """
+      {{ "Hello" | assign_to: "hello" }}
+      <h1>{{ hello }}</h1>
+      """
+    And this content item exists at "/assign"
+      | template | assign |
+    When I view "/assign"
+    Then the headline should be "Hello"

data/features/template_tags/content_from.feature

@@ -0,0 +1,33 @@
+Feature: Including content in a template
+  As a designer
+  I use content from elsewhere in the repository
+  So that it can be changed by the end user
+
+  Scenario: The content item exists
+    Given this template exists at "inclusion.nou.html"
+      """
+      {{ "/includes/header" | item_at_path | assign_to: "header" }}
+      <h1>{{ header.title }}</h1>
+      """
+    And this content item exists at "/inclusion"
+      | template | inclusion |
+    And this content item exists at "/includes/header"
+      | title | The site title |
+    When I view "/inclusion"
+    Then the headline should be "The site title"
+
+  Scenario: The content item does not exist
+    Given this template exists at "missing_content.nou.html"
+      """
+      {{ "/includes/header" | item_at_path | assign_to: "header" }}
+      {% if header %}
+        <h1>Header Found</h1>
+      {% else %}
+        <h1>No Header</h1>
+      {% endif %}
+      """
+    And this content item exists at "/missing_content"
+      | template | missing_content |
+    And no content item exists at "/includes/header"
+    When I view "/missing_content"
+    Then the headline should be "No Header"

data/features/template_tags/nav_menu.feature

@@ -0,0 +1,77 @@
+Feature: Navigation menus
+  As a designer
+  I want to build a navigation menu from the content repository
+  So that my users can add new pages
+
+  Scenario: Basic menu
+    Given this template exists at "basic_menu.nou.html"
+      """
+      <nav>
+        {% nav_menu %}
+      </nav>
+      """
+    And this content item exists at "/about"
+      | title    | About      |
+      | template | basic_menu |
+    And this content item exists at "/contact"
+      | title | Contact |
+    And this content item exists at "/team"
+      | title | Team |
+    When I view "/about"
+    Then a menu with the following items should be visible:
+      | Label   | Link Target |
+      | About   | /about      |
+      | Contact | /contact    |
+      | Team    | /team       |
+
+  Scenario: Multi-level menu
+    Given this template exists at "deep_menu.nou.html"
+      """
+      <nav>
+        {% nav_menu depth=2 %}
+      </nav>
+      """
+    And this content item exists at "/about"
+      | title    | About     |
+      | template | deep_menu |
+    And this content item exists at "/about/team"
+      | title    | Team |
+    And this content item exists at "/contact"
+      | title | Contact |
+    And this content item exists at "/team"
+      | title | Team |
+    When I view "/about"
+    Then a menu with the following items should be visible:
+      | Label   | Link Target |
+      | About   | /about      |
+      | Contact | /contact    |
+      | Team    | /team       |
+    And the "About" menu item should have these children:
+      | Label | Link Target |
+      | Team  | /about/team |
+
+  Scenario: Non-root menus
+    Given this template exists at "deep_menu.nou.html"
+      """
+      <nav>
+        {% nav_menu root=/about %}
+      </nav>
+      """
+    And this content item exists at "/about"
+      | title    | About     |
+      | template | deep_menu |
+    And this content item exists at "/about/team"
+      | title    | Team |
+    And this content item exists at "/contact"
+      | title | Contact |
+    And this content item exists at "/team"
+      | title | Team |
+    When I view "/about"
+    Then a menu with the following items should be visible:
+      | Label | Link Target |
+      | Team  | /about/team |
+    And these menu items should not be visible:
+      | Label   | Link Target |
+      | About   | /about      |
+      | Contact | /contact    |
+      | Team    | /team       |

data/lib/noumenon/repository/file_system.rb

@@ -56,6 +56,29 @@ class Noumenon::Repository::FileSystem < Noumenon::Repository
     path = File.join(path, "index") if File.exist?(repository_path(path))
     File.open(repository_path("#{path}.yml"), "w") { |f| f.print content.symbolize_keys.to_yaml }
   end
+  
+  def children(root = "/", depth = 1)
+    root.gsub! /\/$/, ''
+    
+    pattern = File.join(repository_path(root), "*")
+    items = Dir.glob(pattern).collect do |i|
+      i.gsub(repository_path("/"), "/").
+        gsub(".yml", "")
+    end
+    
+    # We're not interested in indexes, since they're not children.
+    items.delete(File.join(root, "index"))
+     
+    items.reject { |i| i.gsub(root, "").split("/").size > depth + 1 }.collect do |item|
+      path = item == "" ? "/" : item
+      
+      # Loading everyitem probably isn't scalable, but it'll do for now. We can add caching
+      # at a later date if needed.
+      page = get(path).merge({ path: path })
+      page[:children] = children(page[:path], depth - 1) if depth - 1 > 0
+      page
+    end
+  end
 
   private
   # Return the on-disk path to a repository item.

data/lib/noumenon/repository.rb

@@ -36,4 +36,8 @@ class Noumenon::Repository
   def get(path)
     raise NotImplementedError.new("This repository type does not support reading it's contents.")
   end
+
+  def children(root = "/")
+    raise NotImplementedError.new("This repository type does not support listing children from a path.")
+  end
 end

data/lib/noumenon/template/core_tags.rb

@@ -2,7 +2,7 @@ require 'noumenon/template'
 
 # Liquid extensions provided by Noumenon.
 #
-# @see [ Noumenon::Template::CoreTags::Filters ]
+# @see http://github.com/Noumenon/noumenon/wiki/Template%20Tags
 module Noumenon::Template::CoreTags
   # The core set of filters provided by Noumenon for use in templates.
   #
@@ -39,4 +39,54 @@ module Noumenon::Template::CoreTags
     end
   end
   Liquid::Template.register_filter(Filters)
+  
+  # Renders a navigation menu.
+  #
+  # @api public
+  # @example
+  #   <header>
+  #     {{ nav_menu }}
+  #   </header>
+  #
+  #   <div id="sidebar">
+  #     <h1>About Our Stuff</h1>
+  #     <nav>
+  #       {{ nav_menu root=/about depth=1 }}
+  #     </nav>
+  #   </div>
+  class NavigationTag < Liquid::Tag
+    def initialize(tag_name, syntax, tokens)
+      super
+      
+      @options = { depth: 1, root: "/" }
+     
+      syntax.split(" ").each do |option|
+        key, value = option.split("=")
+        case key
+        when "depth"
+          @options[:depth] = value.to_i
+        when "root"
+          @options[:root] = value
+        end
+      end
+    end
+    
+    def render_list(items)
+      list = items.collect do |item|
+        str  = "<li>"
+        str << %Q{<a href="#{item[:path]}">#{item[:title]}</a>}
+        str << render_list(item[:children]) if item[:children]
+        str << "</li>"
+        
+        str
+      end
+      
+      "<ul>#{list.join("\n")}</ul>"
+    end
+    
+    def render(context)
+      render_list Noumenon.content_repository.children(@options[:root], @options[:depth])
+    end
+  end
+  Liquid::Template.register_tag('nav_menu', NavigationTag)
 end

data/lib/noumenon/version.rb

@@ -1,5 +1,5 @@
 module Noumenon
   # The current version of Noumenon.
   # @api public
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/noumenon/repository/file_system_spec.rb

@@ -112,4 +112,62 @@ describe Noumenon::Repository::FileSystem do
       end
     end
   end
+
+  describe "listing child items" do
+    before do
+      subject.put("/", title: "Home")
+      subject.put("/about", title: "About")
+      subject.put("/about/team", title: "Team")
+      subject.put("/about/location", title: "Location")
+      subject.put("/contact", title: "Contact")
+    end
+
+    context "a single level from the root" do
+      it "returns an array" do
+        subject.children.should be_instance_of Array
+      end
+      
+      it "does not list items below the top level" do
+        subject.children("/").should have(2).items
+      end
+      
+      describe "each item" do
+        let(:items) { subject.children("/") }
+
+        it "is a hash" do
+          items[0].should be_instance_of Hash
+        end
+
+        it "has a path" do
+          items[0][:path].should == "/about"
+          items[1][:path].should == "/contact"
+        end
+
+        it "has a title" do
+          items[0][:title].should == "About"
+          items[1][:title].should == "Contact"
+        end
+      end
+    end
+
+    context "multiple levels from the root" do
+      let(:items) { subject.children("/", 2) }
+      
+      describe "an item with children" do
+        it "has an array of children" do
+          items[0][:children].should have(2).items
+        end
+      end
+    end
+
+    context "from a point below the root" do
+      let(:items) { subject.children("/about") }
+
+      it "lists only items below that point" do
+        items.should have(2).items
+        items[0][:title].should == "Location"
+        items[1][:title].should == "Team"
+      end
+    end
+  end
 end

data/spec/noumenon/repository_spec.rb

@@ -37,4 +37,19 @@ describe Noumenon::Repository do
       end
     end
   end
+
+  it { should respond_to(:children) }
+  describe "calling #children" do
+    it "raises a NotImplementedError" do
+      lambda { subject.children("/") }.should raise_error NotImplementedError
+    end
+
+    it "provides some details in the error message" do
+      begin
+        subject.children("/")
+      rescue NotImplementedError => e
+        e.to_s.should == "This repository type does not support listing children from a path."
+      end
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: noumenon
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jon Wood
@@ -165,20 +165,23 @@ files:
 - README.md
 - Rakefile
 - bin/noumenon
-- features/dynamic_template_rendering.feature
 - features/generator/site_generator.feature
-- features/including_content_from_a_template.feature
 - features/mounted_applications.feature
-- features/static_template_rendering.feature
 - features/step_definitions/asset_steps.rb
 - features/step_definitions/content_steps.rb
 - features/step_definitions/generator_steps.rb
 - features/step_definitions/liquid_steps.rb
+- features/step_definitions/navigation_steps.rb
 - features/step_definitions/request_steps.rb
 - features/step_definitions/theme_steps.rb
 - features/support/env.rb
 - features/support/theme/theme.yml
 - features/template_extensions.feature
+- features/template_rendering/dynamic.feature
+- features/template_rendering/static.feature
+- features/template_tags/assign_to.feature
+- features/template_tags/content_from.feature
+- features/template_tags/nav_menu.feature
 - features/theme_assets.feature
 - generators/repository/index.yml
 - generators/site/Gemfile
@@ -241,20 +244,23 @@ signing_key:
 specification_version: 3
 summary: A flexible content management system.
 test_files: 
-- features/dynamic_template_rendering.feature
 - features/generator/site_generator.feature
-- features/including_content_from_a_template.feature
 - features/mounted_applications.feature
-- features/static_template_rendering.feature
 - features/step_definitions/asset_steps.rb
 - features/step_definitions/content_steps.rb
 - features/step_definitions/generator_steps.rb
 - features/step_definitions/liquid_steps.rb
+- features/step_definitions/navigation_steps.rb
 - features/step_definitions/request_steps.rb
 - features/step_definitions/theme_steps.rb
 - features/support/env.rb
 - features/support/theme/theme.yml
 - features/template_extensions.feature
+- features/template_rendering/dynamic.feature
+- features/template_rendering/static.feature
+- features/template_tags/assign_to.feature
+- features/template_tags/content_from.feature
+- features/template_tags/nav_menu.feature
 - features/theme_assets.feature
 - spec/noumenon/repository/file_system_spec.rb
 - spec/noumenon/repository_spec.rb

data/features/including_content_from_a_template.feature

@@ -1,17 +0,0 @@
-Feature: Including content in a template
-  As a designer
-  I want to include a piece of content within a page
-  So that it can be changed by the end user
-
-  Scenario: The content item exists
-    Given this template exists at "inclusion.nou.html"
-      """
-      {{ "/includes/header" | item_at_path | assign_to: "header" }}
-      <h1>{{ header.title }}</h1>
-      """
-    And this content item exists at "/inclusion"
-      | template | inclusion |
-    And this content item exists at "/includes/header"
-      | title | The site title |
-    When I view "/inclusion"
-    Then the headline should be "The site title"