navigatrix 0.0.1

data/lib/navigatrix/rendering/context.rb

@@ -0,0 +1,26 @@
+module Navigatrix
+  module Rendering
+    class Context < Struct.new(:wrapped)
+      extend Forwardable
+      delegate :request => :wrapped
+
+      def current_path
+        request.env["PATH_INFO"]
+      end
+
+      def controller_name
+        attempt_delegation(:controller_name)
+      end
+
+      def action_name
+        attempt_delegation(:action_name)
+      end
+
+      private
+
+      def attempt_delegation(method)
+        wrapped.send(method) if wrapped.respond_to?(method)
+      end
+    end
+  end
+end

data/lib/navigatrix/rendering/strategies/bootstrap/navbar.rb

@@ -0,0 +1,38 @@
+require "navigatrix/rendering/strategies/list"
+
+module Navigatrix::Rendering::Strategies
+  module Bootstrap
+    class Navbar < List
+
+      private
+
+      def html_attributes
+        super.merge_attribute(:class, "nav")
+      end
+
+      def items
+        super.map { |item| (item.has_children? ? Item : List::Item).new(item, options) }
+      end
+
+      class Item < List::Item
+        private
+
+        def html_attributes
+          super.merge_attribute(:class, "dropdown")
+        end
+
+        def name
+          (super + dropdown_icon).html_safe
+        end
+
+        def nested_list
+          List.new(children, options).render if has_children?
+        end
+
+        def dropdown_icon
+          options[:dropdown_icon] || content_tag(:i, nil, :class => "icon-chevron-down icon-white")
+        end
+      end
+    end
+  end
+end

data/lib/navigatrix/rendering/strategies/bootstrap/tabs.rb

@@ -0,0 +1,12 @@
+module Navigatrix::Rendering::Strategies
+  module Bootstrap
+    class Tabs < List
+
+      private
+
+      def html_attributes
+        super.merge_attribute(:class, "nav nav-tabs")
+      end
+    end
+  end
+end

data/lib/navigatrix/rendering/strategies/list.rb

@@ -0,0 +1,100 @@
+require "action_view"
+
+module Navigatrix::Rendering::Strategies
+  class List < Struct.new(:items, :options)
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
+
+    def render
+      content_tag(:ul, render_items, html_attributes)
+    end
+
+    def render_items
+      items.map(&:render).join.html_safe
+    end
+
+    private
+
+    def items
+      super.map { |item| item_class.new(item, options) }
+    end
+
+    def item_class
+      Item
+    end
+
+    def html_attributes
+      HTMLAttributes.new(options[:html_attributes])
+    end
+
+    class Item < SimpleDelegator
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::UrlHelper
+
+      attr_reader :options
+
+      def initialize(item, options = {})
+        super(item)
+        @options = options
+      end
+
+      def render
+        content_tag(:li, content, html_attributes) if render?
+      end
+
+      private
+
+      def content
+        name_or_link + nested_list.to_s
+      end
+
+      def name_or_link
+        linked? ? link : unlinked_content
+      end
+
+      def nested_list
+        List.new(children, options).render if has_children?
+      end
+
+      def link
+        link_to(name, path)
+      end
+
+      def unlinked_content
+        name
+      end
+
+      def name
+        super.html_safe
+      end
+
+      def html_attributes
+        HTMLAttributes.new(super).merge_attribute(:class, html_class)
+      end
+
+      def html_class
+        active? ? active_class : inactive_class
+      end
+
+      def active_class
+        options[:active_class] || "active"
+      end
+
+      def inactive_class
+        options[:inactive_class]
+      end
+    end
+
+    class HTMLAttributes < HashWithIndifferentAccess
+      def merge_attribute(attribute, value)
+        tap do
+          self[attribute] = attribute_values(attribute).push(value).join(" ")
+        end
+      end
+
+      def attribute_values(attribute)
+        fetch(attribute, "").to_s.split(" ")
+      end
+    end
+  end
+end

data/lib/navigatrix/version.rb

@@ -0,0 +1,3 @@
+module Navigatrix
+  VERSION = "0.0.1"
+end

data/lib/navigatrix/view_helpers.rb

@@ -0,0 +1,7 @@
+module Navigatrix
+  module ViewHelpers
+    def render_navigation(configuration, options = {})
+      Navigatrix::Renderer.new(configuration, options.merge({:render_context => self})).render
+    end
+  end
+end

data/navigatrix.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'navigatrix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "navigatrix"
+  spec.version       = Navigatrix::VERSION
+  spec.authors       = ["Ben Eddy"]
+  spec.email         = ["bae@foraker.com"]
+  spec.description   = %q{Navigation Generation}
+  spec.summary       = %q{Navigation generation for Rails and Sinatra}
+  spec.homepage      = "https://github.com/foraker/navigatrix"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "actionpack"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "capybara"
+end

data/spec/item_spec.rb

@@ -0,0 +1,247 @@
+require File.expand_path("../../lib/navigatrix/item", __FILE__)
+require File.expand_path("../../lib/navigatrix/item_collection", __FILE__)
+require File.expand_path("../../lib/navigatrix/configuration", __FILE__)
+
+module Navigatrix
+  describe Item do
+    let(:context) { double({:current_path => "/"}) }
+
+    it "knows its name" do
+      Item.new("Item 1", {}, context).name.should == "Item 1"
+    end
+
+    describe "#path" do
+      it "returns a file paths" do
+        Item.new("Item 1", {"path" => "/a/standard/path"}).path.should == "/a/standard/path"
+      end
+
+      it "evaluates a Proc" do
+        context.stub(:path_method => "/a/path/method")
+        path_proc = Proc.new { |context| context.path_method }
+        item      = Item.new("Item 1", {"path" => path_proc}, context)
+        item.path.should == "/a/path/method"
+      end
+    end
+
+    describe "#active?" do
+      it "is true when the navigation is unlinked" do
+        item = new_item({})
+        item.stub(:unlinked? => true)
+        item.should be_active
+      end
+
+      it "is false when the navigation is linked" do
+        item = new_item({})
+        item.stub(:unlinked? => false)
+        item.should_not be_active
+      end
+
+      context "a controller name is specified in the config" do
+        let(:config) { {"active_states" => {"controller" => "controller_1"}} }
+
+        it "is true if the specified controller is the current controller" do
+          context.stub(:controller_name => "controller_1", :action_name => "index")
+          new_item(config).should be_active
+        end
+
+        it "is true regardless of action name" do
+          context.stub(:controller_name => "controller_1", :action_name => "edit")
+          new_item(config).should be_active
+        end
+      end
+
+      context "a controller pattern is specified in the config" do
+        let(:config) { {"active_states" => {"controller" => /^users/}} }
+
+        it "is true if the specified controller is the current controller" do
+          context.stub(:controller_name => "users", :action_name => "index")
+          new_item(config).should be_active
+        end
+
+        it "is true if the specified controller matches the current controller" do
+          context.stub(:controller_name => "users/comments", :action_name => "index")
+          new_item(config).should be_active
+        end
+
+        it "is true regardless of action name" do
+          context.stub(:controller_name => "users", :action_name => "edit")
+          new_item(config).should be_active
+        end
+
+        it "is false if the name does not match" do
+          context.stub(:controller_name => "comments/users", :action_name => "edit")
+          new_item(config).should_not be_active
+        end
+      end
+
+      context "a controller and action are specified in the config" do
+        let(:config) do
+          {"active_states" => {"controller" => "controller_2", "actions" => "index"}}
+        end
+
+        it "is true if the specified controller/action combination is the current controller/action combination" do
+          context.stub(:controller_name => "controller_2", :action_name => "index")
+          new_item(config).should be_active
+        end
+
+        it "is false when the action name mismatches" do
+          context.stub(:controller_name => "controller_2", :action_name => "edit")
+          new_item(config).should_not be_active
+        end
+
+        it "is false when the controller name mismatches" do
+          context.stub(:controller_name => "controller_1", :action_name => "index")
+          new_item(config).should_not be_active
+        end
+      end
+
+      context "multiple active states are specified" do
+        let(:config) do
+          {"active_states" => [
+            {"controller" => "controller_3"},
+            {"controller" => "controller_4", "actions" => "show"},
+          ]}
+        end
+
+        it "is true if the first state is applicable" do
+          context.stub(:controller_name => "controller_3", :action_name => "index")
+          new_item(config).should be_active
+        end
+
+        it "is indifferent to action name in the first case" do
+          context.stub(:controller_name => "controller_3", :action_name => "show")
+          new_item(config).should be_active
+        end
+
+        it "is true if the second state is applicable" do
+          context.stub(:controller_name => "controller_4", :action_name => "show")
+          new_item(config).should be_active
+        end
+
+        it "is honors action name specifications" do
+          context.stub(:controller_name => "controller_4", :action_name => "edit")
+          new_item(config).should_not be_active
+        end
+
+        it "is false when neither apply" do
+          context.stub(:controller_name => "controller_5", :action_name => "edit")
+          new_item(config).should_not be_active
+        end
+      end
+    end
+
+    describe "#unlinked?" do
+      context "no unlinked states are configured" do
+        before { context.stub(:current_path => "/path_1") }
+
+        it "is true when the current_path is the same as the item path" do
+          item = new_item({})
+          item.stub(:path => "/path_1")
+          item.should be_unlinked
+        end
+
+        it "is false when the current_path is not the same the item path" do
+          item = new_item({})
+          item.stub(:path => "/path_2")
+          item.should_not be_unlinked
+        end
+      end
+
+      context "unlink states are configured" do
+        context "a controller is specified" do
+          let(:config) { {"unlinked_states" => {"controller" => "controller_1"}} }
+
+          it "is true if the specified controller is the current controller" do
+            context.stub(:controller_name => "controller_1", :action_name => "index")
+            new_item(config).should be_unlinked
+          end
+
+          it "is true regardless of action name" do
+            context.stub(:controller_name => "controller_1", :action_name => "edit")
+            new_item(config).should be_unlinked
+          end
+        end
+
+        context "a controller and action are specified config" do
+          let(:config) do
+            {"unlinked_states" => {"controller" => "controller_2", "actions" => "index"}}
+          end
+
+          it "is true if the specified controller/action combination is the current controller/action combination" do
+            context.stub(:controller_name => "controller_2", :action_name => "index")
+            new_item(config).should be_unlinked
+          end
+
+          it "is false when the action name mismatches" do
+            context.stub(:controller_name => "controller_2", :action_name => "edit")
+            new_item(config).should_not be_unlinked
+          end
+
+          it "is false when the controller name mismatches" do
+            context.stub(:controller_name => "controller_1", :action_name => "index")
+            new_item(config).should_not be_active
+          end
+        end
+
+        context "multiple active states are specified" do
+          let(:config) do
+            {"unlinked_states" => [
+              {"controller" => "controller_3"},
+              {"controller" => "controller_4", "actions" => "show"},
+            ]}
+          end
+
+          it "is true if the first state is applicable" do
+            context.stub(:controller_name => "controller_3", :action_name => "index")
+            new_item(config).should be_unlinked
+          end
+
+          it "is indifferent to action name in the first case" do
+            context.stub(:controller_name => "controller_3", :action_name => "show")
+            new_item(config).should be_unlinked
+          end
+
+          it "is true if the second state is applicable" do
+            context.stub(:controller_name => "controller_4", :action_name => "show")
+            new_item(config).should be_unlinked
+          end
+
+          it "is honors action name specifications" do
+            context.stub(:controller_name => "controller_4", :action_name => "edit")
+            new_item(config).should_not be_unlinked
+          end
+
+          it "is false when neither apply" do
+            context.stub(:controller_name => "controller_5", :action_name => "edit")
+            new_item(config).should_not be_unlinked
+          end
+        end
+      end
+    end
+
+    describe "#children" do
+      let(:item)  { new_item({"children" => {"Child 1" => {}}}) }
+      let(:child) { item.children.first }
+
+      it "creates the correct number of children" do
+        item.children.count.should == 1
+      end
+
+      it "returns an array of items" do
+        child.should be_instance_of(Item)
+      end
+
+      it "maps its children to items" do
+        child.name.should == "Child 1"
+      end
+
+      it "can handle childless configurations" do
+        expect { new_item({}) }.to_not raise_error
+      end
+    end
+  end
+end
+
+def new_item(config)
+  Navigatrix::Item.new("", config, context)
+end