navigatrix 0.0.1

data/spec/renderer_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path("../../lib/navigatrix/renderer", __FILE__)
+
+module Navigatrix
+  describe Renderer do
+    describe "#render" do
+      class StrategyDouble
+        attr_reader :items, :options, :klass
+
+        def initialize(items, options, klass = nil)
+          @items   = items
+          @options = options
+          @klass   = klass
+        end
+
+        def render
+          @rendered = true
+          self
+        end
+
+        def rendered?
+          @rendered
+        end
+
+        def rendered_strategy?(strategy_klass)
+          puts klass
+          puts strategy_klass
+          rendered? and klass == strategy_klass
+        end
+      end
+
+      let(:rendering_context) { double }
+      let(:config)            { double }
+      let(:item_collection)   { double(:items => double) }
+
+      before do
+        wrapped_context = double
+        Rendering::Context.stub(:new).with(rendering_context).and_return(wrapped_context)
+        ItemCollection.stub(:new).with(config, wrapped_context).and_return(item_collection)
+      end
+
+      context "a specified strategy" do
+        subject { render(:strategy => StrategyDouble) }
+
+        it "renders via the strategy" do
+          subject.should be_rendered
+        end
+
+        it "passes the items to be rendered" do
+          subject.items.should == item_collection.items
+        end
+
+        it "passes the rendering options" do
+          subject.options.should == {:render_option  => "an option"}
+        end
+      end
+
+      it "finds strategies by name" do
+        stub_const("Navigatrix::Renderer::REGISTERED_STRATEGIES", {:bootstrap => StrategyDouble})
+        render({:strategy => :bootstrap}).should be_rendered
+      end
+
+      it "defaults to the unordered_list strategy" do
+        stub_const("Navigatrix::Renderer::REGISTERED_STRATEGIES", {:unordered_list => StrategyDouble})
+        render({:strategy => nil}).should be_rendered
+      end
+
+      def render(options)
+        defaults = {
+          :render_context => rendering_context,
+          :render_option  => "an option"
+        }
+
+        Renderer.new(config, defaults.merge(options)).render
+      end
+    end
+  end
+end

data/spec/strategies/bootstrap/navbar_spec.rb

@@ -0,0 +1,44 @@
+require "capybara"
+require File.expand_path("../../../support/list_rendering_strategy", __FILE__)
+require File.expand_path("../../../../lib/navigatrix/rendering/strategies/bootstrap/navbar", __FILE__)
+
+module Navigatrix::Rendering::Strategies
+  module Bootstrap
+    describe Navbar do
+      include ListRenderingStrategy
+
+      it_should_behave_like "a list rendering strategy"
+
+      describe "#render" do
+        it "gives the <ul> a class of 'nav'" do
+          rendered.should have_selector("ul.nav")
+        end
+      end
+
+      describe "a list item" do
+        it "does not have a class of 'dropdown'" do
+          rendered_item["class"].should_not include("dropdown")
+        end
+
+        context "with children" do
+          before do
+            item.stub(:has_children? => true, :children => [])
+          end
+
+          it "gives the item a class of 'dropdown'" do
+            rendered_item["class"].should include("dropdown")
+          end
+
+          it "includes an icon" do
+            rendered_item.should have_selector("i.icon-chevron-down.icon-white")
+          end
+
+          it "allows an icon specification" do
+            rendered_item(:dropdown_icon => "<i class='alt-icon'>ABC</i>".html_safe)
+              .should have_selector("i.alt-icon")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/strategies/bootstrap/tabs_spec.rb

@@ -0,0 +1,19 @@
+require "capybara"
+require File.expand_path("../../../support/list_rendering_strategy", __FILE__)
+require File.expand_path("../../../../lib/navigatrix/rendering/strategies/bootstrap/tabs", __FILE__)
+
+module Navigatrix::Rendering::Strategies
+  module Bootstrap
+    describe Tabs do
+      include ListRenderingStrategy
+
+      it_should_behave_like "a list rendering strategy"
+
+      describe "#render" do
+        it "gives the <ul> a class of 'nav' and 'nav-tabs'" do
+          rendered.should have_selector("ul.nav.nav-tabs")
+        end
+      end
+    end
+  end
+end

data/spec/strategies/list_spec.rb

@@ -0,0 +1,11 @@
+require "capybara"
+require File.expand_path("../../support/list_rendering_strategy", __FILE__)
+require File.expand_path("../../../lib/navigatrix/rendering/strategies/list", __FILE__)
+
+module Navigatrix::Rendering::Strategies
+  describe List do
+    include ListRenderingStrategy
+
+    it_should_behave_like "a list rendering strategy"
+  end
+end

data/spec/support/list_rendering_strategy.rb

@@ -0,0 +1,111 @@
+module ListRenderingStrategy
+  def self.included(base)
+    base.let(:item) { build_item }
+  end
+
+  def rendered_item(options = {})
+    rendered(options).find("wrapper > ul > li")
+  end
+
+  def rendered(options = {})
+    Capybara.string("<wrapper>" + described_class.new([item], options).render + "</wrapper>")
+  end
+
+  def build_item(options = {})
+    defaults = {
+      :name            => "Item 1",
+      :render?         => true,
+      :linked?         => false,
+      :active?         => false,
+      :html_attributes => {},
+      :has_children?   => false
+    }
+
+    double(defaults.merge(options))
+  end
+
+  shared_examples_for("a list rendering strategy") do
+    it "wraps the list in a <ul>" do
+      rendered.should have_selector("ul")
+    end
+
+    it "accepts <ul> attributes" do
+      list_attributes = {"id" => "my-list"}
+      rendered(:html_attributes => list_attributes).should have_selector("ul#my-list")
+    end
+
+    context "the item should not be rendered" do
+      it "does not render the item" do
+        item.stub(:render? => false)
+        expect { rendered_item }.to raise_error(Capybara::ElementNotFound)
+      end
+    end
+
+    describe "a list item" do
+      it "returns an <li>" do
+        rendered.find("li").should be_present
+      end
+
+      it "contains the item name" do
+        rendered_item.should have_content("Item 1")
+      end
+
+      it "incorporates HTML attributes" do
+        item.stub(:html_attributes => {:id => "item-1"})
+        rendered.find("li")["id"].should include("item-1")
+      end
+
+      context "the item is linked" do
+        before do
+          item.stub(:linked? => true, :path => "/path")
+        end
+
+        it "contains an <a> and the item name" do
+          rendered_item.find("a").should have_content("Item 1")
+        end
+
+        it "links to the correct path" do
+          rendered_item.find("a")["href"].should == "/path"
+        end
+      end
+
+      context "the item is active" do
+        before do
+          item.stub(:active? => true)
+        end
+
+        it "adds an 'active' class" do
+          rendered_item["class"].should include("active")
+        end
+
+        it "allows the active class to be specified" do
+          rendered_item(:active_class => "alt-active")["class"].should include("alt-active")
+        end
+
+        it "does not overwrite item attributes" do
+          item.stub(:html_attributes => {:class => "preserved-class"})
+          classes = rendered_item["class"].split(" ")
+          classes.should include("active")
+          classes.should include("preserved-class")
+        end
+      end
+
+      context "an item with children" do
+        before do
+          item.stub(
+            :has_children? => true,
+            :children      => [build_item(:name => "Nested Item 1")]
+          )
+        end
+
+        it "creates a nested <ul>" do
+          rendered_item.should have_selector("ul")
+        end
+
+        it "creates list items within the nested list" do
+          rendered_item.find("li").should have_content("Nested Item 1")
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: navigatrix
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Eddy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Navigation Generation
+email:
+- bae@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/navigatrix.rb
+- lib/navigatrix/configuration.rb
+- lib/navigatrix/integration/rails.rb
+- lib/navigatrix/integration/sinatra.rb
+- lib/navigatrix/item.rb
+- lib/navigatrix/item_collection.rb
+- lib/navigatrix/renderer.rb
+- lib/navigatrix/rendering/context.rb
+- lib/navigatrix/rendering/strategies/bootstrap/navbar.rb
+- lib/navigatrix/rendering/strategies/bootstrap/tabs.rb
+- lib/navigatrix/rendering/strategies/list.rb
+- lib/navigatrix/version.rb
+- lib/navigatrix/view_helpers.rb
+- navigatrix.gemspec
+- spec/item_spec.rb
+- spec/renderer_spec.rb
+- spec/strategies/bootstrap/navbar_spec.rb
+- spec/strategies/bootstrap/tabs_spec.rb
+- spec/strategies/list_spec.rb
+- spec/support/list_rendering_strategy.rb
+homepage: https://github.com/foraker/navigatrix
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Navigation generation for Rails and Sinatra
+test_files:
+- spec/item_spec.rb
+- spec/renderer_spec.rb
+- spec/strategies/bootstrap/navbar_spec.rb
+- spec/strategies/bootstrap/tabs_spec.rb
+- spec/strategies/list_spec.rb
+- spec/support/list_rendering_strategy.rb