smart_navigation 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 322510ff431e621ac05e9a7114fc15ad656bd6be
-  data.tar.gz: 4257511a0085900ef8be0f89bb0a7bb105da50b3
+  metadata.gz: 032655f9ab35419c26f5b36b2ebb58bc044cee25
+  data.tar.gz: 54e5513ff6c6954ce05e6e25bdd205279b421a40
 SHA512:
-  metadata.gz: 6fa49d788f5b38b65c19688393888c3b19a991e6eec39048d2bfda5d0382e3c25407cde74aad5b2ba0f7ee5c0d07df37e7de801e17da59711ecbce5f9933e199
-  data.tar.gz: 68a2d5cdf34287d02cbd335c832d42a5fd05ab09a7d18f5be4386b80f79c518ba0347fba8f80588f4910f4f9e3015280563f3c4245d34a2a136d6bacdd861467
+  metadata.gz: 2413436e93175f1ca0eb2771740962d755a5f50d6775db282176b01fa6eced57d5a1aa8e6eee7504ba9b562f0847e852c0cc2b964d13463b9610e627b5c920b9
+  data.tar.gz: b23f3b1a58cd012667d80f1835fba875fd06f6e4bc43680c0a2c532989d1b3fd7cfdf2cd003fc91856481fec869698a6c10e53532748f981df84989c0d73c5bd

data/README.md

@@ -1,6 +1,6 @@
 # SmartNavigation
 
-View helpers for navigation menus. Build navigation menus from hash configs.
+View helpers for navigation menus. Build navigation menus from hash objects.
 
 [![Gem Version](https://badge.fury.io/rb/smart_navigation.svg)](https://badge.fury.io/rb/smart_navigation)
 [![Build Status](https://travis-ci.org/hardpixel/smart-navigation.svg?branch=master)](https://travis-ci.org/hardpixel/smart-navigation)
@@ -24,7 +24,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Define the menu items in a hash:
+
+```ruby
+@items = {
+  dashboard: {
+    label: 'Dashboard',
+    url:   :root_path,
+    icon:  'dashboard'
+  },
+  pages: {
+    label: 'Pages',
+    url:   :admin_pages_path,
+    icon:  'pages',
+    children: {
+      index: {
+        label: 'All Pages',
+        url:   :pages_path
+      },
+      new: {
+        label: 'New Page',
+        url:   :new_page_path
+      }
+    }
+  },
+  system: {
+    label:     'System',
+    separator: true
+  },
+  profile: {
+    label: 'Profile',
+    url:   -> { edit_user_path(current_user) },
+    icon:  'user',
+    if:    :user_signed_in?
+  }
+}
+```
+
+The `url` key can be a String, a Symbol or a Proc. Keys `if` and `unless` can be a Symbol or a Proc. Symbols and Procs are executed in the view context.
+
+To render a menu you can use the `navigation_for` or `smart_navigation_for` helper in your views:
+
+```erb
+<%= smart_navigation_for(@items) %>
+```
+
+There are a number of options you can use to customize the navigation. The default options are:
+
+```ruby
+options = {
+  menu_class:           'menu',
+  menu_html:            {},
+  separator_class:      'separator',
+  submenu_parent_class: 'has-submenu',
+  submenu_class:        'submenu',
+  active_class:         'active',
+  active_submenu_class: 'open',
+  submenu_icons:        false,
+  submenu_toggle:       nil,
+  icon_prefix:          'icon icon-',
+  icon_position:        'left'
+}
+
+smart_navigation_for(@items, options)
+```
 
 ## Development
 

data/lib/smart_navigation/renderer.rb

@@ -2,107 +2,159 @@ module SmartNavigation
   class Renderer
     # Initialize builder
     def initialize(view_context, items, options={})
-      @context              = view_context
-      @items                = sort_items items
-      @menu_class           = options.fetch :menu_class,           'menu'
-      @sep_class            = options.fetch :separator_class,      'separator'
-      @group_class          = options.fetch :group_class,          'menu-group'
-      @submenu_class        = options.fetch :submenu_class,        'submenu'
-      @active_class         = options.fetch :active_class,         'active'
-      @active_submenu_class = options.fetch :active_submenu_class, 'open'
-      @submenu_icons        = options.fetch :submenu_icons,        false
+      @context = view_context
+      @items   = sort_items items
+      @options = default_options.merge(options)
     end
 
-    # Sort items by order
-    def sort_items(items)
-      items.sort_by { |_k, v| v[:order] }.to_h
+    # Render menu
+    def render
+      menu_tag @items.map { |k, v| item_tag(v, true) }.join
     end
 
-    # Get menu item url
-    def item_url(item)
-      params = { controller: item[:controller], action: item[:action] }
-      params[:action] ? url_for(params) : "##{item[:id]}"
-    end
+    private
+
+      # Default options
+      def default_options
+        {
+          menu_class:           'menu',
+          menu_html:            {},
+          separator_class:      'separator',
+          submenu_parent_class: 'has-submenu',
+          submenu_class:        'submenu',
+          active_class:         'active',
+          active_submenu_class: 'open',
+          submenu_icons:        false,
+          submenu_toggle:       nil,
+          icon_prefix:          'icon icon-',
+          icon_position:        'left'
+        }
+      end
 
-    # Check if current page
-    def current_page?(item)
-      url = item_url(item)
-      @context.current_page?(url)
-    end
+      # Sort items by order
+      def sort_items(items)
+        items.sort_by { |_k, v| v[:order] }.to_h
+      end
 
-    # Check if current group
-    def current_group?(item)
-      current = item[:children].any? { |_k, v| current_page?(v) }
-      current = item[:children].any? { |_k, v| current_group?(v) } if current.blank?
-      current
-    end
+      # Get menu item url
+      def item_url(item)
+        item[:url].present? ? mixed_value(item[:url]) : "##{item[:id]}"
+      end
 
-    # Create menu separator
-    def separator_tag(item)
-      content_tag :li, item[:label], class: @sep_class
-    end
+      # Check if should render item
+      def render_item?(item)
+        if item[:if]
+          mixed_value(item[:if]).present?
+        elsif item[:unless]
+          mixed_value(item[:unless]).blank?
+        else
+          true
+        end
+      end
 
-    # Create item link
-    def item_link_tag(item, icons=false)
-      arrow = content_tag :span, icon('angle-left pull-right'), class: 'pull-right-container'
-      label = content_tag :span, item[:label]
-      label = icon("#{item[:icon]}") + label if icons.present?
-      label = label + arrow if item[:children].present?
+      # Check if current page
+      def current_page?(item)
+        url = item_url(item)
+        @context.current_page?(url)
+      end
 
-      link_to label.html_safe, item_url(item)
-    end
+      # Check if current group
+      def current_group?(item)
+        current = true if current_page?(item)
+        current = Hash(item[:children]).any? { |_k, v| current_page?(v) } if current.blank?
+        current = Hash(item[:children]).any? { |_k, v| current_group?(v) } if current.blank?
+        current
+      end
+
+      # Create html tag
+      def tag(*args, &block)
+        @context.content_tag(*args, &block)
+      end
 
-    # Create submenu item
-    def submenu_item_tag(item, active=false)
-      items  = sort_items item[:children]
-      items  = items.map { |_k, v| item_tag(v, @submenu_icons) }.join
-      active = @active_submenu_class if active.present?
+      # Create menu icon
+      def icon_tag(name, label=nil)
+        icon = tag :i, nil, class: "#{@options[:icon_prefix]}#{name}"
 
-      content_tag(:ul, items.html_safe, class: "#{active} #{@submenu_class}")
-    end
+        if @options[:icon_position] == 'left'
+          "#{icon}#{label}".html_safe
+        else
+          "#{label}#{icon}".html_safe
+        end
+      end
 
-    # Create group menu item
-    def group_item_tag(item, icons=false)
-      active  = @active_class if current_group?(item)
-      link    = item_link_tag item, icons
-      submenu = submenu_item_tag item, active
-      content = link + submenu
+      # Create submenu toggle tag
+      def toggle_tag
+        "#{@options[:submenu_toggle]}".html_safe
+      end
 
-      content_tag :li, content.html_safe, class: "#{active} #{@group_class}"
-    end
+      # Create menu separator
+      def separator_tag(item)
+        tag :li, item[:label], class: @options[:separator_class]
+      end
 
-    # Create single menu item
-    def single_item_tag(item, icons=false)
-      active = @active_class if current_page?(item)
-      link   = item_link_tag(item, icons)
+      # Create item link
+      def item_link_tag(item, icons=false)
+        label = tag :span, item[:label]
+        label = icon_tag("#{item[:icon]}", label) if icons.present?
+        label = label + toggle_tag if item[:children].present?
 
-      content_tag :li, link.html_safe, class: "#{active}"
-    end
+        @context.link_to label.html_safe, item_url(item)
+      end
 
-    # Create menu list item
-    def item_tag(item, icons=false)
-      if item[:separator].present?
-        separator_tag(item)
-      elsif item[:children].present?
-        group_item_tag(item, icons)
-      else
-        single_item_tag(item, icons)
+      # Create submenu item
+      def submenu_item_tag(item, active=false)
+        items  = sort_items item[:children]
+        items  = items.map { |_k, v| item_tag(v, @options[:submenu_icons]) }.join
+        active = @options[:active_submenu_class] if active.present?
+
+        tag(:ul, items.html_safe, class: "#{active} #{@options[:submenu_class]}".strip)
       end
-    end
 
-    # Create menu list
-    def menu_tag(items)
-      content_tag :ul, items.html_safe, class: @menu_class
-    end
+      # Create group menu item
+      def group_item_tag(item, icons=false)
+        active  = @options[:active_class] if current_group?(item)
+        link    = item_link_tag item, icons
+        submenu = submenu_item_tag item, active
+        content = link + submenu
 
-    # Render menu
-    def render
-      menu_tag @items.map { |k, v| item_tag(v, true) }.join
-    end
+        tag :li, content.html_safe, class: "#{active} #{@options[:submenu_parent_class]}".strip
+      end
 
-    # Get app helpers if method is missing
-    def method_missing(method, *args, &block)
-      @context.respond_to?(method) ? @context.send(method, *args, &block) : super
-    end
+      # Create single menu item
+      def single_item_tag(item, icons=false)
+        active = @options[:active_class] if current_page?(item)
+        link   = item_link_tag(item, icons)
+
+        tag :li, link.html_safe, class: "#{active}"
+      end
+
+      # Create menu list item
+      def item_tag(item, icons=false)
+        if render_item?(item)
+          if item[:separator].present?
+            separator_tag(item)
+          elsif item[:children].present?
+            group_item_tag(item, icons)
+          else
+            single_item_tag(item, icons)
+          end
+        end
+      end
+
+      # Create menu list
+      def menu_tag(items)
+        tag :ul, items.html_safe, Hash(@options[:menu_html]).merge(class: @options[:menu_class])
+      end
+
+      # Parse mixed value
+      def mixed_value(value)
+        if value.is_a?(Proc)
+          @context.instance_exec(&value)
+        elsif value.is_a?(Symbol)
+          @context.send(value)
+        else
+          value
+        end
+      end
   end
 end

data/lib/smart_navigation/version.rb

@@ -1,3 +1,3 @@
 module SmartNavigation
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_navigation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonian Guveli
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: View helpers for navigation menus. Build navigation menus from hash configs.
+description: View helpers for navigation menus. Build navigation menus from hash objects.
 email:
 - jonian@hardpixel.eu
 executables: []