navigatrix 0.0.1 → 0.1.0

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

@@ -0,0 +1,16 @@
+require "action_view"
+
+module Navigatrix
+  module Rendering
+    module Strategies
+      module ContentHelpers
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::UrlHelper
+
+        def capture
+          yield
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require "active_support/core_ext"
+
+module Navigatrix
+  module Rendering
+    module Strategies
+      class HTMLAttributes < HashWithIndifferentAccess
+        def merge(other)
+          other.inject(self) do |this, (attribute, value)|
+            this.merge_attribute(attribute, value)
+          end
+        end
+
+        def merge_attribute(attribute, value)
+          return self unless value.present?
+
+          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
+end

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

@@ -0,0 +1,102 @@
+require "delegate"
+
+require "navigatrix/rendering/strategy_factory"
+require "navigatrix/rendering/strategies/html_attributes"
+require "navigatrix/rendering/strategies/content_helpers"
+
+module Navigatrix
+  module Rendering
+    module Strategies
+      class Item < SimpleDelegator
+        include ContentHelpers
+
+        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 + render_children
+        end
+
+        def name_or_link
+          linked? ? linked_content : unlinked_content
+        end
+
+        def linked_content
+          link_to(name, path)
+        end
+
+        def unlinked_content
+          name
+        end
+
+        def name
+          super.html_safe
+        end
+
+        def html_attributes
+          universal_attributes
+            .merge(super)
+            .merge_attribute(:class, html_class)
+        end
+
+        def universal_attributes
+          HTMLAttributes.new(options[:html_attributes])
+        end
+
+        def render_children
+          if has_children?
+            children_renderer.new(
+              children,
+              children_list_options,
+              children_item_options
+            ).render
+          else
+            ""
+          end
+        end
+
+        def children_options
+          options
+        end
+
+        def html_class
+          active? ? active_class : inactive_class
+        end
+
+        def active_class
+          super.presence || options[:active_class] || "active"
+        end
+
+        def inactive_class
+          super.presence || options[:inactive_class]
+        end
+
+        def children_renderer
+          StrategyFactory.find_list_strategy(strategy_name)
+        end
+
+        def strategy_name
+          children_list_options[:renderer]
+        end
+
+        def children_list_options
+          children_options.fetch(:list, {})
+        end
+
+        def children_item_options
+          children_options.fetch(:item, {})
+        end
+      end
+    end
+  end
+end

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

@@ -1,99 +1,43 @@
-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
+require "navigatrix/rendering/strategy_factory"
+require "navigatrix/rendering/strategies/content_helpers"
+require "navigatrix/rendering/strategies/html_attributes"
+require "navigatrix/rendering/strategies/item"
+
+module Navigatrix
+  module Rendering
+    module Strategies
+      class List
+        include ContentHelpers
+
+        attr_reader :options, :item_options
+
+        def initialize(items, list_options = {}, item_options = {})
+          @items        = items || []
+          @options      = list_options
+          @item_options = item_options
+        end
 
-      def html_attributes
-        HTMLAttributes.new(super).merge_attribute(:class, html_class)
-      end
+        def render
+          content_tag(:ul, render_items, html_attributes)
+        end
 
-      def html_class
-        active? ? active_class : inactive_class
-      end
+        private
 
-      def active_class
-        options[:active_class] || "active"
-      end
+        def render_items
+          items.map(&:render).join.html_safe
+        end
 
-      def inactive_class
-        options[:inactive_class]
-      end
-    end
+        def items
+          @items.map { |item| item_class.new(item, item_options) }
+        end
 
-    class HTMLAttributes < HashWithIndifferentAccess
-      def merge_attribute(attribute, value)
-        tap do
-          self[attribute] = attribute_values(attribute).push(value).join(" ")
+        def item_class
+          StrategyFactory.find_item_strategy(item_options[:renderer])
         end
-      end
 
-      def attribute_values(attribute)
-        fetch(attribute, "").to_s.split(" ")
+        def html_attributes
+          HTMLAttributes.new(options[:html_attributes])
+        end
       end
     end
   end

data/lib/navigatrix/rendering/strategy_factory.rb

@@ -0,0 +1,28 @@
+module Navigatrix
+  module Rendering
+    class StrategyFactory
+      DEFAULT_LIST_STRATEGY = :unordered_list
+      DEFAULT_ITEM_STRATEGY = :item
+
+      class MissingStrategy < NameError ; end
+
+      def self.find_list_strategy(strategy_or_name, strategies = Navigatrix.list_renderers)
+        find_strategy(strategy_or_name, strategies, DEFAULT_LIST_STRATEGY)
+      end
+
+      def self.find_item_strategy(strategy_or_name, strategies = Navigatrix.item_renderers)
+        find_strategy(strategy_or_name, strategies, DEFAULT_ITEM_STRATEGY)
+      end
+
+      def self.find_strategy(strategy_or_name, strategies, default)
+        return strategy_or_name if strategy_or_name.is_a?(Class)
+
+        strategy_or_name ||= default
+
+        strategies.fetch(strategy_or_name) do
+          raise(MissingStrategy, "can't find strategy #{strategy_or_name}")
+        end
+      end
+    end
+  end
+end

data/lib/navigatrix/version.rb

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

data/spec/integration/documentation_spec.rb

@@ -0,0 +1,154 @@
+require "spec_helper"
+
+describe "documentation" do
+  let(:request) do
+    double({
+      env: {}
+    })
+  end
+
+  let(:render_context) do
+    double({
+      request: request
+    })
+  end
+
+  def render_navigation(configuration, options = {})
+    Navigatrix::Renderer.new(configuration, options.merge(render_context: render_context)).render
+  end
+
+  it "renders a basic navigation" do
+    request.stub(env: {
+      "PATH_INFO" => "/about-us"
+    })
+    rendered = render_navigation({
+      "Home"     => "/",
+      "About Us" => "/about-us",
+      "Blog"     => "/blog",
+      "Contact"  => "/contact"
+    })
+
+    desired = <<-HTML
+      <ul>
+        <li><a href="/">Home</a></li>
+        <li class="active">About Us</li>
+        <li><a href="/blog">Blog</a></li>
+        <li><a href="/contact">Contact</a></li>
+      </ul>
+    HTML
+
+    rendered.should match_html(desired)
+  end
+
+  it "renders a more sophisticated nav" do
+    render_context.stub(controller_name: "users")
+    request.stub(env: {
+      "PATH_INFO" => "/users/1"
+    })
+
+    rendered = render_navigation({
+      "Home" => "/",
+      "Users" => {
+        :path   => "/users",
+        :active_states => [
+          {:path => "/my_account"},
+          {:path  => /\/users\/\d*/},
+        ]
+      },
+      "Sign In" => {
+        :path   => "/sign_in",
+        :render? => false
+      },
+      "Sign Out" => {
+        :path   => "/sign_out",
+        :render? => true
+      }
+    }, {
+      :item => {
+        :active_class => "active-nav-item"
+      },
+      :list => {
+        :html_attributes => {
+          :class => "nav"
+        }
+      }
+    })
+
+    desired = <<-HTML
+      <ul class="nav">
+        <li><a href="/">Home</a></li>
+        <li class="active-nav-item"><a href="/users">Users</a></li>
+        <li><a href="/sign_out">Sign Out</a></li>
+      </ul>
+    HTML
+
+    rendered.should match_html(desired)
+  end
+
+  it "accepts item options" do
+    render_context.stub(controller_name: "users")
+    request.stub(env: {
+      "PATH_INFO" => "/users"
+    })
+
+    rendered = render_navigation({
+      "Users"   => "/users",
+      "Clients" => "/clients"
+    }, {
+      item: {
+        :active_class   => "custom-active",
+        :inactive_class => "custom-inactive",
+        :html_attributes => {
+          "class"     => "nav-item",
+          "data-item" => "nav"
+        }
+      }
+    })
+
+    rendered.should match_html <<-HTML
+      <ul>
+        <li class="nav-item custom-active" data-item="nav">Users</li>
+        <li class="nav-item custom-inactive" data-item="nav"><a href="/clients">Clients</a></li>
+      </ul>
+    HTML
+  end
+
+  it "accepts item options on each item" do
+    render_context.stub(controller_name: "users")
+    request.stub(env: {
+      "PATH_INFO" => "/users"
+    })
+
+    rendered = render_navigation({
+      "Users" => {
+        :path   => "/users",
+        :active_class => "custom-active"
+      },
+      "Clients" => {
+        :path   => "/clients",
+        :inactive_class => "custom-inactive"
+      }
+    })
+
+    rendered.should match_html <<-HTML
+      <ul>
+        <li class="custom-active">Users</li>
+        <li class="custom-inactive"><a href="/clients">Clients</a></li>
+      </ul>
+    HTML
+  end
+end
+
+RSpec::Matchers.define :match_html do |expected|
+  match do |actual|
+    clean(expected) == clean(actual)
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{clean(actual)} to equal #{clean(expected)}"
+  end
+
+  def clean(text)
+    text.strip.gsub("\n", "").gsub(/(?<=\>)\s+?(?=\<)/, "")
+  end
+end