simple_navigation_bootstrap 1.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.3.1
+  - 2.2.5

data/AUTHORS

@@ -0,0 +1,2 @@
+Nicolas Rodriguez <nrodriguez@jbox-web.com>
+Pavel Shpak <shpakvel@gmail.com>

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_navigation_bootstrap.gemspec
+gemspec
+
+# Get master branch of simple-navigation to fix 'undefined class ::Rails::Railtie' error
+# See: https://github.com/codeplant/simple-navigation/commit/fb2c41511ade34e1ed6857a89ab2c7f1eead3ecb
+gem 'simple-navigation', git: 'https://github.com/codeplant/simple-navigation.git'
+
+# README edition
+gem 'gh-preview'
+
+# CodeClimate Test Coverage
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+## SimpleNavigation Bootstrap
+
+[![GitHub license](https://img.shields.io/github/license/jbox-web/simple_navigation_bootstrap.svg)](https://github.com/jbox-web/simple_navigation_bootstrap/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/jbox-web/simple_navigation_bootstrap.svg)](https://github.com/jbox-web/simple_navigation_bootstrap/releases/latest)
+[![Build Status](https://travis-ci.org/jbox-web/simple_navigation_bootstrap.svg?branch=master)](https://travis-ci.org/jbox-web/simple_navigation_bootstrap)
+[![Code Climate](https://codeclimate.com/github/jbox-web/simple_navigation_bootstrap/badges/gpa.svg)](https://codeclimate.com/github/jbox-web/simple_navigation_bootstrap)
+[![Test Coverage](https://codeclimate.com/github/jbox-web/simple_navigation_bootstrap/badges/coverage.svg)](https://codeclimate.com/github/jbox-web/simple_navigation_bootstrap/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/jbox-web/simple_navigation_bootstrap.svg)](https://gemnasium.com/github.com/jbox-web/simple_navigation_bootstrap)
+
+This gem adds Bootstrap renderers for Simple Navigation. For now, it is include renderers for:
+
+* [Bootstrap 2 navigation](http://getbootstrap.com/2.3.2/components.html#navbar)
+* [Bootstrap 3 navigation](http://getbootstrap.com/components/#navbar)
+
+With these renderers you will be able create **any Bootstrap navigation elements**, such as: **submenu**, **navbar-text**, **divider**, **header**.
+As well as add **icons** to menu elements, such as: Glyphicons, Font Awesome icons, even custom icons. Also you have **split** option for main menu containing submenu.
+
+*This gem is fork of [ShPakvel/simple\_navigation\_renderers](https://github.com/ShPakvel/simple_navigation_renderers).*
+*After a year of waiting for [PR merge](https://github.com/ShPakvel/simple_navigation_renderers/pull/14) without any news from the author, I decided to fork it.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_navigation_bootstrap'
+```
+
+and then execute:
+
+```console
+$ bundle install
+```
+
+Or install it yourself as:
+
+```console
+$ gem install simple_navigation_bootstrap
+```
+
+## Usage
+
+### Simply set up renderer and you are done!!
+
+There are two ways to say that you want to use any of renderers.
+
+1. You can specify it in you view as a parameter to `render_navigation`:
+
+    ```erb
+    ...
+      <%= render_navigation(expand_all: true, renderer: :bootstrap2) %>
+      # Or
+      <%= render_navigation(expand_all: true, renderer: :bootstrap3) %>
+    ...
+    ```
+
+2. Or you can set it in the very navigation configuration file (e.g. `config/navigation.rb`):
+
+    ```ruby
+    SimpleNavigation::Configuration.run do |navigation|
+      navigation.renderer = SimpleNavigationBootstrap::Bootstrap2
+      # or
+      navigation.renderer = SimpleNavigationBootstrap::Bootstrap3
+      # navigation itself goes here...
+    end
+    ```
+
+## Explicit example of using all features
+
+I think you already using `simple-navigation` gem and know how to define navigation items.
+If not, you can always look at the [configuration instructions](https://github.com/andi/simple-navigation/wiki/Configuration) on the Simple Navigation wiki or read comments and examples in the generated by default `config/navigation.rb` file.
+
+In addition to standard options you can use ones specific for Bootstrap renderers.
+Lets look at the example:
+
+```ruby
+SimpleNavigation::Configuration.run do |navigation|
+  navigation.renderer = SimpleNavigationRenderers::Bootstrap3
+
+  navigation.items do |primary|
+    primary.item :news, { icon: 'fa fa-fw fa-bullhorn', text: 'News' }, news_index_path
+    primary.item :concerts, 'Concerts', concerts_path
+    primary.item :video, 'Video', videos_path
+    primary.item :divider_before_info, '#', divider: true
+    primary.item :info, { icon: 'fa fa-fw fa-book', title: 'Info' }, info_index_path, split: true do |info_nav|
+      info_nav.item :main_info_page, 'Main info page', info_path(:main_info_page)
+      info_nav.item :about_info_page, 'About', info_path(:about_info_page)
+      info_nav.item :misc_info_pages, 'Misc.' do |misc_page|
+        misc_page.item :header_misc_pages, 'Misc. Pages', header: true
+        Info.all.each do |info_page|
+          misc_page.item :"#{info_page.permalink}", info_page.title, info_path(info_page)
+        end
+      end
+      info_nav.item :divider_before_contact_info_page, '#', divider: true
+      info_nav.item :contact_info_page, 'Contact', info_path(:contact_info_page)
+    end
+    primary.item :signed_in, 'Signed in as Pavel Shpak', navbar_text: true
+  end
+end
+```
+
+## Features
+
+Specific options used in the example:
+
+    Option     | Description
+---------------|--------------
+`:split`       | Use it to split first level item link with caret. If you add `split: true` option to item, then caret itself will toggle first level submenu and link will have standard behaviour, instead of toggle submenu. You can use `:split` only with first level items, for the rest it will not do anything.
+`:navbar_text` | Use it as `navbar_text: true` to add Bootstrap `navbar-text`.
+`:divider`     | Use it to add Bootstrap menu divider. if you add `divider: true` option to first level item, then it will create li-tag with `divider-vertical` Bootstrap 2 class. (You can add `divider-vertical` class to Bootstrap 3 - see below). For the second level item and deeper it will create `li` tag with class `divider` (which exists in both, Bootstrap 2 and 3).
+`:header`      | Use it as `header: true` to add Bootstrap menu header. You can use `:header` only with submenus, for the first level items it will not do anything.
+`:name hash`   | Use it in place of `:name` if you want. Hash can have three keys: `:text`, `:icon` and `:title`, which is only recognized. You can use it together or separatly, but at least one of `:text` and `:icon` parameters should be provided.
+
+Example for `:name hash`:
+
+* `{ text: 'News', icon: 'fa fa-fw fa-bullhorn' }` will create Font Awesome icon and add text after it (name of the item)
+* `{ icon: 'glyphicon glyphicon-book', title: 'Info' }` will create Bootstrap icon with title without any text after it
+
+## Notes
+
+1. Bootstrap 3 has only one level submenu. If you want to use nested submenus as in example above, import `bootstrap2_dropdown_submenu.css.scss` file into your Sass file (e.g. `application.css.scss`) as following:
+
+    ```scss
+    @import "bootstrap2_dropdown_submenu";
+    ```
+
+2. Bootstrap 3 has not `divider-vertical` class. If you want to use it as in example above, import `bootstrap2_navbar_divider_vertical.css.scss` file:
+
+    ```scss
+    @import "bootstrap2_navbar_divider_vertical";
+    ```
+
+3. You may also want to include following file which changes some first level submenu style:
+
+    ```scss
+    @import "simple_navigation_bootstrap_overrides";
+    ```
+
+4. or you can add them all together:
+
+    ```scss
+    @import "simple_navigation_bootstrap";
+    ```
+
+## Test
+
+Just run following commands:
+
+```console
+$ bundle install
+$ rake
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Contributors
+
+A big thank to [them](https://github.com/jbox-web/simple_navigation_bootstrap/blob/master/AUTHORS) for their contribution!

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/simple_navigation_bootstrap.rb

@@ -0,0 +1,14 @@
+require 'forwardable'
+require 'simple-navigation'
+require 'simple_navigation_bootstrap/errors'
+require 'simple_navigation_bootstrap/rendered_item'
+require 'simple_navigation_bootstrap/bootstrap_base'
+require 'simple_navigation_bootstrap/bootstrap2'
+require 'simple_navigation_bootstrap/bootstrap3'
+require 'simple_navigation_bootstrap/engine' if defined? Rails::Engine
+
+module SimpleNavigationBootstrap
+end
+
+SimpleNavigation.register_renderer(bootstrap2: SimpleNavigationBootstrap::Bootstrap2)
+SimpleNavigation.register_renderer(bootstrap3: SimpleNavigationBootstrap::Bootstrap3)

data/lib/simple_navigation_bootstrap/bootstrap2.rb

@@ -0,0 +1,20 @@
+module SimpleNavigationBootstrap
+  class Bootstrap2 < SimpleNavigation::Renderer::Base
+
+    include BootstrapBase
+
+
+    private
+
+
+      def bootstrap_version
+        2
+      end
+
+
+      def navigation_class
+        nil
+      end
+
+  end
+end

data/lib/simple_navigation_bootstrap/bootstrap3.rb

@@ -0,0 +1,20 @@
+module SimpleNavigationBootstrap
+  class Bootstrap3 < SimpleNavigation::Renderer::Base
+
+    include BootstrapBase
+
+
+    private
+
+
+      def bootstrap_version
+        3
+      end
+
+
+      def navigation_class
+        'navbar-nav'
+      end
+
+  end
+end

data/lib/simple_navigation_bootstrap/bootstrap_base.rb

@@ -0,0 +1,81 @@
+module SimpleNavigationBootstrap
+  module BootstrapBase
+
+    def render(item_container)
+      if skip_if_empty? && item_container.empty?
+        ''
+      else
+        # Generate list of items
+        list_content = with_bootstrap_configs do
+          item_container.items.inject([]) do |list, item|
+            list << render_item(self, item, item_container.level, bootstrap_version)
+          end.join
+        end
+
+        # Set CSS class for container :
+        #   class = 'nav' if level == 1
+        #   class = 'dropdown-menu' if level > 1
+        item_container.dom_class = [item_container.dom_class, container_class(item_container.level)].flatten.compact.join(' ')
+
+        # Generate the final list
+        content_tag(:ul, list_content, id: item_container.dom_id, class: item_container.dom_class)
+      end
+    end
+
+
+    private
+
+
+      def render_item(*args)
+        SimpleNavigationBootstrap::RenderedItem.new(*args).to_s
+      end
+
+
+      def container_class(level)
+        remove_navigation_class = options.delete(:remove_navigation_class){ false }
+        if level == 1
+          remove_navigation_class ? '' : ['nav', navigation_class].compact
+        else
+          'dropdown-menu'
+        end
+      end
+
+
+      def with_bootstrap_configs
+        # Get current config
+        sn_config = SimpleNavigation.config
+
+        # Save current config
+        config_selected_class    = sn_config.selected_class
+        config_name_generator    = sn_config.name_generator
+        sn_config.selected_class = 'active'
+
+        # name_generator should be proc (not lambda or method) to be compatible with earlier versions of simple-navigation
+        sn_config.name_generator = proc do |name, item|
+          config_name_generator.call(prepare_name(name), item)
+        end
+
+        # Generate menu
+        result = yield
+
+        # Restore config
+        sn_config.name_generator = config_name_generator
+        sn_config.selected_class = config_selected_class
+
+        result
+      end
+
+
+      def prepare_name(name)
+        return name unless name.is_a?(Hash)
+
+        if name[:icon]
+          icon_options = { class: name[:icon], title: name[:title] }.reject { |_, v| v.nil? }
+          content_tag(:span, '', icon_options) + ' ' + (name[:text] || '')
+        else
+          name[:text] || (raise SimpleNavigationBootstrap::InvalidHash)
+        end
+      end
+
+  end
+end

data/lib/simple_navigation_bootstrap/engine.rb

@@ -0,0 +1,4 @@
+module SimpleNavigationBootstrap
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/simple_navigation_bootstrap/errors.rb

@@ -0,0 +1,8 @@
+module SimpleNavigationBootstrap
+  # Exception raised when you set Hash without both 'text' and 'icon' parameters as Item 'name' parameter
+  class InvalidHash < StandardError
+    def initialize(msg = "Hash does not contain any of parameters: 'text', 'icon'")
+      super
+    end
+  end
+end

data/lib/simple_navigation_bootstrap/rendered_item.rb

@@ -0,0 +1,125 @@
+module SimpleNavigationBootstrap
+  class RenderedItem
+    extend Forwardable
+
+    attr_reader :renderer
+    def_delegators :renderer, :link_to, :content_tag, :include_sub_navigation?, :render_sub_navigation_for
+
+    def initialize(renderer, item, level, bootstrap_version)
+      @renderer = renderer
+      @item     = item
+      @level    = level
+      @bootstrap_version = bootstrap_version
+
+      @options      = item.html_options
+      @navbar_text  = options.delete(:navbar_text)
+      @divider      = options.delete(:divider) { false }
+      @header       = options.delete(:header) { false }
+      @split        = options.delete(:split) { false }
+      @skip_caret   = options.delete(:skip_caret) { false }
+      @link_options = @item.link_html_options || {}
+    end
+
+
+    def to_s
+      if navbar_text
+        li_text
+      elsif divider
+        li_divider
+      elsif header && (level != 1)
+        li_header
+      else
+        li_link
+      end
+    end
+
+
+    private
+
+
+      attr_reader :item, :level, :bootstrap_version, :options, :navbar_text, :divider, :header, :split, :skip_caret, :link_options
+
+      def li_text
+        content_tag(:li, content_tag(:p, item.name, class: 'navbar-text'), options)
+      end
+
+
+      def li_divider
+        css_class = level == 1 ? 'divider-vertical' : 'divider'
+        options[:class] = [options[:class], css_class].flatten.compact.join(' ')
+        content_tag(:li, '', options)
+      end
+
+
+      def li_header
+        css_class = bootstrap_version == 3 ? 'dropdown-header' : 'nav-header'
+        options[:class] = [options[:class], css_class].flatten.compact.join(' ')
+        content_tag(:li, item.name, options)
+      end
+
+
+      def li_link
+        if include_sub_navigation?(item)
+          if level == 1
+            if split
+              splitted_simple_part + splitted_dropdown_part
+            else
+              content = [item.name]
+              content << caret unless skip_caret
+              content = content.join(' ').html_safe
+              dropdown_part(content)
+            end
+          else
+            content_tag(:li, dropdown_submenu_link, options)
+          end
+        else
+          content_tag(:li, simple_link, options)
+        end
+      end
+
+
+      def splitted_simple_part
+        main_li_options = options.dup
+        main_li_options[:class] = [main_li_options[:class], 'dropdown-split-left'].flatten.compact.join(' ')
+        content_tag(:li, simple_link, main_li_options)
+      end
+
+
+      def splitted_dropdown_part
+        item.sub_navigation.dom_class = [item.sub_navigation.dom_class, 'pull-right'].flatten.compact.join(' ')
+        link_options = {}
+        options[:id] = nil
+        options[:class] = [options[:class], 'dropdown-split-right'].flatten.compact.join(' ')
+        dropdown_part(caret)
+      end
+
+
+      def dropdown_part(name)
+        options[:class] = [options[:class], 'dropdown'].flatten.compact.join(' ')
+        link_options[:class] = [link_options[:class], 'dropdown-toggle'].flatten.compact.join(' ')
+        link_options[:"data-toggle"] = 'dropdown'
+        link_options[:"data-target"] = '#'
+
+        content = link_to(name, '#', link_options) + render_sub_navigation_for(item)
+        content_tag(:li, content, options)
+      end
+
+
+      def caret
+        content_tag(:b, '', class: 'caret')
+      end
+
+
+      def dropdown_submenu_link
+        options[:class] = [options[:class], 'dropdown-submenu'].flatten.compact.join(' ')
+        simple_link + render_sub_navigation_for(item)
+      end
+
+
+      def simple_link
+        link_options[:method] ||= item.method
+        link_to(item.name, (item.url || '#'), link_options)
+      end
+
+  end
+end