navigatrix 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 28321e32d4430f1d16823c1a3d23121d25a1d2a3
-  data.tar.gz: 8c466c5479a7330322bb2989a49d11621e13f81a
-SHA512:
-  metadata.gz: d7c652b8c6d1e5ddbda0e997b1829307828d2951ae775a680c3407d1c2ff040e2fa444375a0e2facfddfa43d83a6092aa5d993b77a01af0007f758559accbebf
-  data.tar.gz: 0eeb7a60fc49e5f7ce8a2e8c683bda0d10716694cb09f65a10d0dcf006310fd9f9245cddd599c87ecc9577fb994489f2c38dccb72ce705501ba979dd13c20568
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTU0ZDk1YzY1NjgxODkwODM0YmE1NjcyYmRmMWQwNWRjYmYwNTUxZQ==
+  data.tar.gz: !binary |-
+    NWRlOTg0NDVmYWZkNTg1MGEwYmRhMTU2Y2EwNGM4Yjc2MjFkMjk3MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTI3M2I0MTIyYTE0ZjI0N2U4ZDA1NjhlNTJjMWU4MjBjYzg4YjU5NGU4NGM4
+    NWVmZmViNDY4NjgyMzRjZTk3NmU2NTAzZjk4MjkwZTE0N2FlMjU1YmI2ZDEw
+    NTQzMDU4YjQyZTJiMzM2YzNmMmIxYTVlMWE5ZThmZTM3ODM0ZWQ=
+  data.tar.gz: !binary |-
+    NWU0YzVjMGY3OTYxYWJkNTEyZTQ0ZDBiMWVkMzI1NmU2NmZiNWI1NmU2YWNl
+    MjdmMDVhMDhkNWE1NzNmOTk3ZjBhNGFhODVjZmNjOTk5MmZiMTcwNzdiOGZh
+    MmM2NDhmNTk4ZmEzNmM3NzhkZGRkNjYzOGMwYTc4ZThjMTg2ZmY=

data/README.md

@@ -46,9 +46,13 @@ Assuming we're on the "/about-us" path, the resulting HTML will look like this:
     :render? => user_signed_in?
   }
 }, {
-  :active_class    => "active-nav-item",
-  :html_attributes => {
-    :class => "nav"
+  :item => {
+    :active_class => "active-nav-item"
+  },
+  :list => {
+    :html_attributes => {
+      :class => "nav"
+    }
   }
 }) %>
 ```
@@ -57,14 +61,45 @@ Assuming we're on the "/users/1" path, and a User is signed in, the resulting HT
 ```HTML
 <ul class="nav">
   <li><a href="/">Home</a></li>
-  <li class="active-nav-item">Users</li>
+  <li class="active-nav-item"><a href="/users">Users</a></li>
   <li><a href="/sign_out">Sign Out</a></li>
 </ul>
 ```
 The "Users" item is active and not linked because the path "/users/1" matches the pattern `/\/users\/\d*/`.  The "Home" item is linked because we are not on the path "/".
 
+## List Configuration Options
+List configuration options are supplied via the `:list` option when rendering a navigation.  For example,
+
+```Ruby
+render_navigation(config, {
+  list: {
+    html_attributes: {
+      class: "nav"
+    }
+  }
+})
+```
+
+A list accepts the following configuration options:
+
+##### `:html_attributes`
+HTML attributes added to an the list.
 
 ## List Item Configuration Options
+
+List item configuration options can be supplied to all list items or a single list item.  Supply options to a single list item via the navigation configuration.
+
+```Ruby
+render_navigation({
+  "Home" => {
+    path: "/",
+    active_class: "home-active"
+  }
+})
+```
+
+The following options are supported.
+
 ##### `:path`
 Specifies where the navigation item should link to.
 
@@ -133,12 +168,78 @@ Results in the following HTML.
 ##### `:render?`
 Determines if the navigation item is rendered.
 
-## List Configuration Options
-##### `:html_attributes`
-HTML attributes added to an the list.
+### Supplying options to all list items
+List configuration options are supplied via the `:item` option when rendering a navigation.  For example,
+```Ruby
+render_navigation(config, {
+  item: {
+    active_class: "active-item"
+  }
+})
+```
+
+Supported options are:
 
 ##### `:active_class`
 Determines which HTML class is applied to list items when the item is active.
 
 ##### `:inactive_class`
 Determines which HTML class is applied to list items when the item is *not* active.
+
+`active_class`, `inactive_class`, `html_attributes`.
+
+## Building Custom List Renderers
+
+To change the default list rendering from \<ul> tags to \<section> tags with an id of "nav", create a custom list renderer:
+
+```Ruby
+Navigatrix.register_list_renderer(:my_custom_list) do |renderer|
+  renderer.wrapper do |items, html_attributes|
+    content_tag(:section, items, html_attributes.merge_attribute(:id, "nav"))
+  end
+end
+```
+
+```ERB
+<%= render_navigation({
+  "Home"     => "/",
+  "About Us" => "/about-us",
+}, {
+  list: {renderer: :my_custom_list}
+}) %>
+```
+
+## Building Custom Item Renderers
+
+If the basic list and and item configuration, custom renders can be registered.
+
+For example, to add change the default item rendering from \<li> tags to \<p> tags, create a custom item renderer:
+
+```Ruby
+Navigatrix.register_item_renderer(:my_custom_item) do |renderer|
+  renderer.wrapper do |content, children, html_attributes|
+    content(:p, content + children, html_attributes)
+  end
+end
+```
+
+```ERB
+<%= render_navigation({
+  "Home"     => "/",
+  "About Us" => "/about-us",
+}, {
+  item: {renderer: :my_custom_item}
+}) %>
+```
+
+#### All item rendering options
+
+`wrapper` - wraps item content - accepts `content, children, html_attributes`
+
+`linked` - content when the item is linked - accepts `name, path`
+
+`unlinked` - content when the item is not linked - accepts `name, path`
+
+`html_attributes` - HTML attributes for the item
+
+`children_options` - attributes passed to the child list

data/lib/navigatrix.rb

@@ -2,8 +2,31 @@ require "navigatrix/version"
 require "navigatrix/item"
 require "navigatrix/item_collection"
 require "navigatrix/renderer"
+require "navigatrix/builder"
 require 'navigatrix/integration/rails' if defined?(Rails)
 require 'navigatrix/integration/sinatra' if defined?(Sinatra)
 
 module Navigatrix
+  extend self
+
+  mattr_accessor :list_renderers
+
+  self.list_renderers = {
+    :unordered_list   => Rendering::Strategies::List,
+    :bootstrap_navbar => Rendering::Strategies::Bootstrap::Navbar,
+    :bootstrap_tabs   => Rendering::Strategies::Bootstrap::Tabs
+  }
+
+  mattr_accessor :item_renderers
+  self.item_renderers = {
+    :item => Rendering::Strategies::Item
+  }
+
+  def register_list_renderer(name, &block)
+    list_renderers[name] = ListBuilder.build(&block)
+  end
+
+  def register_item_renderer(name, &block)
+    item_renderers[name] = ItemBuilder.build(&block)
+  end
 end

data/lib/navigatrix/builder.rb

@@ -0,0 +1,69 @@
+module Navigatrix
+  class Builder
+    attr_reader :klass
+
+    def self.build(&block)
+      instance = new(klass)
+      block.call(instance)
+      instance.klass
+    end
+
+    def initialize(klass)
+      @klass = Class.new(klass)
+    end
+
+    def define_method(method_name, &block)
+      @klass.send(:define_method, method_name, &block)
+    end
+  end
+
+  class ListBuilder < Builder
+    def self.klass
+      Navigatrix::Rendering::Strategies::List
+    end
+
+    def wrapper(&block)
+      define_method(:render) do
+        instance_exec(render_items, html_attributes, &block)
+      end
+    end
+  end
+
+  class ItemBuilder < Builder
+    def self.klass
+      Navigatrix::Rendering::Strategies::Item
+    end
+
+    def wrapper(&block)
+      define_method(:render) do
+        instance_exec(name_or_link, render_children, html_attributes, &block) if render?
+      end
+    end
+
+    def linked(&block)
+      define_method(:linked_content) do
+        instance_exec(name, path, &block)
+      end
+    end
+
+    def unlinked(&block)
+      define_method(:unlinked_content) do
+        instance_exec(name, path, &block)
+      end
+    end
+
+    def children_options(&block)
+      define_method(:children_options) do
+        instance_exec(super(), &block)
+      end
+    end
+
+    def html_attributes(&block)
+      define_method(:html_attributes) do
+        instance_exec(&block).inject(super()) do |acc, (key, val)|
+          acc.merge_attribute(key, val)
+        end
+      end
+    end
+  end
+end

data/lib/navigatrix/configuration.rb

@@ -23,6 +23,14 @@ module Navigatrix
         {}
       end
 
+      def active_class
+        nil
+      end
+
+      def inactive_class
+        nil
+      end
+
       def render?
         true
       end
@@ -30,6 +38,8 @@ module Navigatrix
 
     class AdvancedConfig < OpenStruct
       DEFAULTS = {
+        :active_class    => nil,
+        :inactive_class  => nil,
         :html_attributes => {},
         :render?         => true,
         :children        => {}

data/lib/navigatrix/item.rb

@@ -6,7 +6,7 @@ module Navigatrix
   class Item < Struct.new(:name, :config, :context)
     extend Forwardable
     delegate :current_path => :context
-    delegate [:render?, :html_attributes] => :config
+    delegate [:render?, :html_attributes, :active_class, :inactive_class] => :config
 
     def active?
       applicable_active_state? ||

data/lib/navigatrix/renderer.rb

@@ -1,4 +1,5 @@
 require "navigatrix/rendering/context"
+require "navigatrix/rendering/strategy_factory"
 require "navigatrix/rendering/strategies/list"
 require "navigatrix/rendering/strategies/bootstrap/navbar"
 require "navigatrix/rendering/strategies/bootstrap/tabs"
@@ -7,23 +8,14 @@ module Navigatrix
   class Renderer
     attr_reader :configuration, :strategy, :render_context, :render_options
 
-    REGISTERED_STRATEGIES = {
-      :unordered_list   => Rendering::Strategies::List,
-      :bootstrap_navbar => Rendering::Strategies::Bootstrap::Navbar,
-      :bootstrap_tabs   => Rendering::Strategies::Bootstrap::Tabs
-    }
-
-    class MissingStrategy < NameError ; end
-
     def initialize(configuration, options)
       @configuration  = configuration
-      @strategy       = find_strategy(options.delete(:strategy))
       @render_context = Rendering::Context.new(options.delete(:render_context))
       @render_options = options
     end
 
     def render
-      strategy.new(item_collection.items, render_options).render
+      strategy.new(item_collection.items, list_options, item_options).render
     end
 
     private
@@ -32,10 +24,24 @@ module Navigatrix
       ItemCollection.new(configuration, render_context)
     end
 
-    def find_strategy(strategy_or_name)
-      return strategy_or_name if strategy_or_name.is_a?(Class)
-      strategy_or_name ||= :unordered_list
-      REGISTERED_STRATEGIES[strategy_or_name] || raise(MissingStrategy, "can't find strategy #{strategy_name}")
+    def strategy
+      Rendering::StrategyFactory.find_list_strategy(strategy_name)
+    end
+
+    def strategy_name
+      render_options.fetch(:list, {})[:renderer]
+    end
+
+    def list_options
+      base = render_options[:html_attributes]
+      (base ? {html_attributes: base} : {})
+        .merge(render_options.fetch(:list, {}))
+    end
+
+    def item_options
+      render_options
+        .slice(:active_class, :inactive_class)
+        .merge(render_options.fetch(:item, {}))
     end
   end
 end

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

@@ -1,36 +1,40 @@
 require "navigatrix/rendering/strategies/list"
 
-module Navigatrix::Rendering::Strategies
-  module Bootstrap
-    class Navbar < List
+module Navigatrix
+  module Rendering
+    module Strategies
+      module Bootstrap
+        class Navbar < List
 
-      private
+          private
 
-      def html_attributes
-        super.merge_attribute(:class, "nav")
-      end
+          def html_attributes
+            super.merge_attribute(:class, "nav")
+          end
 
-      def items
-        super.map { |item| (item.has_children? ? Item : List::Item).new(item, options) }
-      end
+          def items
+            super.map { |item| (item.has_children? ? Item : Strategies::Item).new(item, options) }
+          end
 
-      class Item < List::Item
-        private
+          class Item < Strategies::Item
+            private
 
-        def html_attributes
-          super.merge_attribute(:class, "dropdown")
-        end
+            def html_attributes
+              super.merge_attribute(:class, "dropdown")
+            end
 
-        def name
-          (super + dropdown_icon).html_safe
-        end
+            def name
+              (super + dropdown_icon).html_safe
+            end
 
-        def nested_list
-          List.new(children, options).render if has_children?
-        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")
+            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

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