simple_navigation_bootstrap 1.0.0

data/lib/simple_navigation_bootstrap/version.rb

@@ -0,0 +1,15 @@
+module SimpleNavigationBootstrap
+  # Returns the version of the currently loaded Rails as a <tt>Gem::Version</tt>
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/simple_navigation_bootstrap.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'simple_navigation_bootstrap/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'simple_navigation_bootstrap'
+  s.version     = SimpleNavigationBootstrap::VERSION::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Pavel Shpak', 'Nicolas Rodriguez']
+  s.email       = ['shpakvel@gmail.com', 'nrodriguez@jbox-web.com']
+  s.homepage    = 'https://github.com/jbox-web/simple_navigation_bootstrap'
+  s.summary     = %q{A Ruby gem that adds Bootstrap renderers for SimpleNavigation}
+  s.description = %q{This gem adds Bootstrap2 and Bootstrap3 renderers for SimpleNavigation}
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency 'simple-navigation', '~> 4.0'
+
+  s.add_development_dependency 'actionpack'
+  s.add_development_dependency 'actionview'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/spec/lib/simple_navigation_bootstrap/bootstrap2_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe SimpleNavigationBootstrap::Bootstrap2 do
+
+  describe '#render' do
+
+    it "wraps main menu in ul-tag with 'nav' class" do
+      check_selector build_menu(version: 2), 'ul.nav.navbar-nav', 0
+      check_selector build_menu(version: 2), 'ul.nav'
+    end
+
+
+    context "when ':header' option provided" do
+      context "for the first level item" do
+        it "does not set up 'dropdown-header' or 'nav-header' class on li-tag" do
+          check_selector build_menu(version: 2), 'ul.nav > li.to_check_header.nav-header', 0
+        end
+
+        it "creates link-tag for the item (standard item)" do
+          check_selector build_menu(version: 2), 'ul.nav > li.to_check_header > a'
+        end
+      end
+
+      context "for the second level item and deeper" do
+        it "sets up 'nav-header' class on li-tag" do
+          check_selector build_menu(version: 2), 'ul.dropdown-menu > li.to_check_header2.nav-header'
+        end
+
+        it "does not create link-tag for the item (standard item), but puts only item 'name'" do
+          check_selector build_menu(version: 2), 'ul.dropdown-menu > li.to_check_header2.nav-header > a', 0
+          check_title build_menu(version: 2), 'ul.dropdown-menu > li.to_check_header2.nav-header', 'Misc. Pages'
+        end
+      end
+    end
+
+
+    context "when ':navbar_text' option provided" do
+      it "creates p-tag with class 'navbar-text' and item 'name' as a content instead of link-tag for the item (standard item)" do
+        check_selector build_menu(version: 2), 'ul > li.to_check_navbar_text > a', 0
+        check_title build_menu(version: 2), 'ul > li.to_check_navbar_text > p.navbar-text', 'Signed in as Pavel Shpak'
+      end
+    end
+
+
+    context "when container is empty" do
+      it 'return empty list' do
+        check_selector build_menu(version: 2, menu_name: :empty_menu, menu_opts: { skip_if_empty: true }), 'ul > li', 0
+      end
+    end
+
+  end
+
+end

data/spec/lib/simple_navigation_bootstrap/bootstrap3_spec.rb

@@ -0,0 +1,209 @@
+require 'spec_helper'
+
+describe SimpleNavigationBootstrap::Bootstrap3 do
+
+  describe '#render' do
+
+    it "wraps main menu in ul-tag with 'nav navbar-nav' classes" do
+      check_selector build_menu(version: 3), 'ul.nav.navbar-nav'
+    end
+
+
+    it "sets up 'active' class on selected items (on li-tags)" do
+      check_selector build_menu(version: 3), 'ul.nav.navbar-nav > li.active > a[href="news_index_path"]'
+    end
+
+
+    it "wraps submenu in ul-tag 'dropdown-menu' class" do
+      check_selector build_menu(version: 3), 'ul > li > ul.dropdown-menu > li > ul.dropdown-menu'
+    end
+
+
+    context "for the first level submenu (the second level menu)" do
+      it "sets up 'dropdown' class on li-tag which contains that submenu" do
+        check_selector build_menu(version: 3), 'ul > li.dropdown'
+      end
+
+      it "sets up 'dropdown-toggle' class on link-tag which is used for toggle that submenu" do
+        check_selector build_menu(version: 3), 'ul > li.dropdown > a.dropdown-toggle'
+      end
+
+      it "sets up 'data-toggle' attribute to 'dropdown' on link-tag which is used for toggle that submenu" do
+        check_selector build_menu(version: 3), 'ul > li.dropdown > a[data-toggle=dropdown]'
+      end
+
+      it "sets up 'data-target' attribute to '#' on link-tag which is used for toggle that submenu" do
+        check_selector build_menu(version: 3), 'ul > li.dropdown > a[data-target="#"]'
+      end
+
+      it "sets up 'href' attribute to '#' on link-tag which is used for toggle that submenu" do
+        check_selector build_menu(version: 3), 'ul > li.dropdown > a[href="#"]'
+      end
+
+      it "puts b-tag with 'caret' class in li-tag which contains that submenu" do
+        check_selector build_menu(version: 3), 'ul > li.dropdown > a[href="#"] > b.caret'
+      end
+    end
+
+
+    context "for nested submenu (the third level menu and deeper)" do
+      it "sets up 'dropdown-submenu' class on li-tag which contains that submenu" do
+        check_selector build_menu(version: 3), 'ul > li > ul.dropdown-menu > li.dropdown-submenu'
+      end
+    end
+
+
+    context "when ':split' option provided" do
+      context "for the first level item which contains submenu" do
+        it "splits item on two li-tags (left and right) and right li-tag will contain the first level submenu (second level menu)" do
+          check_selector build_menu(version: 3), 'ul > li.dropdown-split-left + li.dropdown.dropdown-split-right > ul.dropdown-menu'
+        end
+
+        it "sets up 'pull-right' class on ul-tag which is the submenu" do
+          check_selector build_menu(version: 3), 'ul > li > ul.dropdown-menu.pull-right'
+        end
+      end
+
+      context "for the second level item and deeper which contains submenu" do
+        it "does not splits item on two li-tags" do
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li.dropdown-split-left + li.dropdown.dropdown-split-right > ul.dropdown-menu', 0
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li.dropdown-submenu > ul.dropdown-menu'
+        end
+
+        it "does not sets up 'pull-right' class on ul-tag which is the submenu" do
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li > ul.dropdown-menu.pull-right', 0
+        end
+      end
+
+      context "for item which does not contain submenu" do
+        it "does not splits item on two li-tags" do
+          check_selector build_menu(version: 3), 'ul > li.to_check_split.dropdown-split-left + li.dropdown.dropdown-split-right', 0
+          check_selector build_menu(version: 3), 'ul > li.to_check_split'
+        end
+      end
+    end
+
+
+    context "when ':split' option is not provided" do
+      context "for the first level item which contains submenu" do
+        it "does not splits item on two li-tags (left and right) and right li-tag will contain the first level submenu (second level menu)" do
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul > li.dropdown-split-left + li.dropdown.dropdown-split-right > ul.dropdown-menu', 0
+        end
+
+        it "does not sets up 'pull-right' class on ul-tag which is the submenu" do
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul > li > ul.dropdown-menu.pull-right', 0
+        end
+      end
+
+      context "for the second level item and deeper which contains submenu" do
+        it "does not splits item on two li-tags" do
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul.dropdown-menu > li.dropdown-split-left + li.dropdown.dropdown-split-right > ul.dropdown-menu', 0
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul.dropdown-menu > li.dropdown-submenu > ul.dropdown-menu'
+        end
+
+        it "does not sets up 'pull-right' class on ul-tag which is the submenu" do
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul.dropdown-menu > li > ul.dropdown-menu.pull-right', 0
+        end
+      end
+
+      context "for item which does not contain submenu" do
+        it "does not splits item on two li-tags" do
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul > li.to_check_split.dropdown-split-left + li.dropdown.dropdown-split-right', 0
+          check_selector build_menu(version: 3, menu_name: :unsplited_menu), 'ul > li.to_check_split'
+        end
+      end
+    end
+
+
+    context "when ':navbar_text' option provided" do
+      it "creates p-tag with class 'navbar-text' and item 'name' as a content instead of link-tag for the item (standard item)" do
+        check_selector build_menu(version: 3), 'ul > li.to_check_navbar_text > a', 0
+        check_title build_menu(version: 3), 'ul > li.to_check_navbar_text > p.navbar-text', 'Signed in as Pavel Shpak'
+      end
+    end
+
+
+    context "when ':divider' option provided" do
+      it "does not create link-tag for the item (standard item)" do
+        check_selector build_menu(version: 3), 'ul > li.divider-vertical + li > a[href="divider_before_info_index_path"]', 0
+        check_selector build_menu(version: 3), 'ul.dropdown-menu > li.divider + li > a[href="divider_before_misc_info_pages"]', 0
+        check_selector build_menu(version: 3), 'ul.dropdown-menu > li.divider + li > a[href="divider_before_contact_info_page"]', 0
+      end
+
+      context "for the first level item" do
+        it "adds li-tag with class 'divider-vertical'" do
+          check_selector build_menu(version: 3), 'ul > li.divider-vertical + li > a[href="info_index_path"]'
+        end
+      end
+
+      context "for the second level item and deeper" do
+        it "adds li-tag with class 'divider'" do
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li.divider + li > a[href="misc_info_pages"]'
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li.divider + li > a[href="contact_info_page"]'
+        end
+      end
+    end
+
+
+    context "when ':header' option provided" do
+      context "for the first level item" do
+        it "does not set up 'dropdown-header' or 'nav-header' class on li-tag" do
+          check_selector build_menu(version: 3), 'ul.nav.navbar-nav > li.to_check_header.dropdown-header', 0
+        end
+
+        it "creates link-tag for the item (standard item)" do
+          check_selector build_menu(version: 3), 'ul.nav.navbar-nav > li.to_check_header > a'
+        end
+      end
+
+      context "for the second level item and deeper" do
+        it "sets up 'dropdown-header' class on li-tag" do
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li.to_check_header2.dropdown-header'
+        end
+
+        it "does not create link-tag for the item (standard item), but puts only item 'name'" do
+          check_selector build_menu(version: 3), 'ul.dropdown-menu > li.to_check_header2.dropdown-header > a', 0
+          check_title build_menu(version: 3), 'ul.dropdown-menu > li.to_check_header2.dropdown-header', 'Misc. Pages'
+        end
+      end
+    end
+
+
+    context "when 'hash' provided in place of 'name'" do
+      context "with ':icon' parameter" do
+        it "adds span-tag with classes from the parameter" do
+          check_selector build_menu(version: 3), 'ul > li > a > span.fa.fa-fw.fa-bullhorn'
+        end
+      end
+
+      context "with ':title' parameter" do
+        it "sets up 'title' attribute on icon's span-tag to the parameter value" do
+          check_selector build_menu(version: 3), 'ul > li > a > span.fa.fa-fw.fa-book[title="Info"]'
+        end
+      end
+
+      context "with ':text' parameter" do
+        it "uses the parameter value as 'name' of the item" do
+          expect(build_menu(version: 3).css('ul > li > a > span.fa.fa-fw.fa-bullhorn')[0].parent.children[1].to_s).to eq ' News'
+        end
+      end
+
+      context "without ':text' and ':icon' parameters" do
+        it "raises 'InvalidHash' error" do
+          expect {
+            build_menu(version: 3, stub_name: true)
+          }.to raise_error(SimpleNavigationBootstrap::InvalidHash)
+        end
+      end
+    end
+
+
+    context "when container is empty" do
+      it 'return empty list' do
+        check_selector build_menu(version: 3, menu_name: :empty_menu, menu_opts: { skip_if_empty: true }), 'ul > li', 0
+      end
+    end
+
+  end
+
+end

data/spec/lib/simple_navigation_bootstrap/exceptions_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SimpleNavigationBootstrap::InvalidHash do
+  it 'has specific default message' do
+    expect(subject.message).to eq "Hash does not contain any of parameters: 'text', 'icon'"
+  end
+end

data/spec/lib/simple_navigation_renderers_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SimpleNavigationBootstrap do
+  it 'registers Bootstrap2 renderer' do
+    expect(SimpleNavigation.registered_renderers[:bootstrap2]).to eq SimpleNavigationBootstrap::Bootstrap2
+  end
+
+  it 'registers Bootstrap3 renderer' do
+    expect(SimpleNavigation.registered_renderers[:bootstrap3]).to eq SimpleNavigationBootstrap::Bootstrap3
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+
+# Configure SimpleCov
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  CodeClimate::TestReporter::Formatter
+])
+
+SimpleCov.start
+
+# SimpleNavigation currently only works for Rails, Sinatra and Padrino apps
+# This is a workaround to be able to test the lib
+## START ##
+ENV['RAILS_ENV'] = 'test'
+
+require 'action_controller'
+require 'action_view'
+
+module Rails
+  module VERSION
+    MAJOR = 2
+  end
+end unless defined? Rails
+
+RAILS_ROOT = './' unless defined?(RAILS_ROOT)
+RAILS_ENV = 'test' unless defined?(RAILS_ENV)
+## END ##
+
+current_dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories.
+Dir[File.join(current_dir, 'spec/support/**/*.rb')].each { |f| require f }
+
+# Configure RSpec
+RSpec.configure do |config|
+  # Include standard helpers
+  config.include TestHelper
+end
+
+# Require the lib to test
+require 'simple_navigation_bootstrap'

data/spec/support/test_helper.rb

@@ -0,0 +1,139 @@
+module TestHelper
+
+  def build_menu(version:, menu_name: :splited_menu, stub_name: false, menu_opts: {})
+    case version
+    when 2
+      render_result(SimpleNavigationBootstrap::Bootstrap2, menu_name, stub_name, menu_opts)
+    when 3
+      render_result(SimpleNavigationBootstrap::Bootstrap3, menu_name, stub_name, menu_opts)
+    else
+    end
+  end
+
+
+  def check_selector(nav_menu, selector, nb_entries = 1)
+    expect(nav_menu.css(selector).size).to eq nb_entries
+  end
+
+
+  def check_title(menu, selector, title)
+    expect(menu.css(selector)[0].children[0].to_s).to eq title
+  end
+
+
+  private
+
+
+    # 'stub_name' neads to check raising error when invalid 'Item name hash' provided
+    #
+    def render_result(renderer, menu_name, stub_name, opts = {})
+      menu_opts = opts.merge(expand_all: true)
+      prepare_navigation_instance(renderer)
+      main_menu = build_main_menu(menu_name, stub_name).render(menu_opts)
+      html_document(main_menu)
+    end
+
+
+    def prepare_navigation_instance(renderer)
+      SimpleNavigation::Configuration.instance.renderer = renderer
+      allow(SimpleNavigation).to receive_messages(adapter: simple_navigation_adapter)
+      allow_any_instance_of(SimpleNavigation::Item).to receive_messages(selected?: false, selected_by_condition?: false)
+    end
+
+
+    def simple_navigation_adapter
+      SimpleNavigation::Adapters::Rails.new(
+        double(:context, view_context: ActionView::Base.new)
+      )
+    end
+
+
+    def build_main_menu(menu_name, stub_name)
+      # Create a new container
+      main_menu = SimpleNavigation::ItemContainer.new(1)
+      # Fill it with menu
+      send(menu_name, main_menu)
+      # Mark one entry as selected
+      selected = main_menu.items.find { |item| item.key == :news }
+      allow(selected).to receive_messages(selected?: true, selected_by_condition?: true)
+      # Stub if needed
+      main_menu.items[0].instance_variable_set(:@name, {}) if stub_name
+      # Return menu
+      main_menu
+    end
+
+
+    def html_document(html)
+      Loofah.fragment(html)
+    end
+
+
+    ### TESTED NAVIGATION CONTENT ###
+
+
+    def splited_menu(primary)
+      primary.item :news, { icon: 'fa fa-fw fa-bullhorn', text: 'News' }, 'news_index_path'
+      primary.item :concerts, 'Concerts', 'concerts_path', html: { class: 'to_check_header', header: true }
+      primary.item :video, 'Video', 'videos_path', html: { class: 'to_check_split', split: true }
+      primary.item :divider_before_info_index_path, '', '#', html: { divider: true }
+      primary.item :info, { icon: 'fa fa-fw fa-book', title: 'Info' }, 'info_index_path', html: { split: true } do |info_nav|
+        info_nav.item :main_info_page, 'Main info page', 'main_info_page'
+        info_nav.item :about_info_page, 'About', 'about_info_page'
+        info_nav.item :divider_before_misc_info_pages, '', '#', html: { divider: true }
+        info_nav.item :misc_info_pages, 'Misc.', 'misc_info_pages', html: { split: true } do |misc_nav|
+          misc_nav.item :header_misc_pages, 'Misc. Pages', '#', html: { class: 'to_check_header2', header: true }
+          misc_nav.item :page1, 'Page1', 'page1'
+          misc_nav.item :page2, 'Page2', 'page2'
+        end
+        info_nav.item :divider_before_contact_info_page, '', '#', html: { divider: true }
+        info_nav.item :contact_info_page, 'Contact', 'contact_info_page'
+      end
+      primary.item :signed_in, 'Signed in as Pavel Shpak', '#', html: { class: 'to_check_navbar_text', navbar_text: true }
+    end
+
+
+    def unsplited_menu(primary)
+      primary.item :news, { icon: 'fa fa-fw fa-bullhorn', text: 'News' }, 'news_index_path'
+      primary.item :concerts, 'Concerts', 'concerts_path', html: { class: 'to_check_header', header: true }
+      primary.item :video, 'Video', 'videos_path', html: { class: 'to_check_split', split: true }
+      primary.item :divider_before_info_index_path, '', '#', html: { divider: true }
+      primary.item :info, { icon: 'fa fa-fw fa-book', title: 'Info' }, 'info_index_path', html: { split: false } do |info_nav|
+        info_nav.item :main_info_page, 'Main info page', 'main_info_page'
+        info_nav.item :about_info_page, 'About', 'about_info_page'
+        info_nav.item :divider_before_misc_info_pages, '', '#', html: { divider: true }
+        info_nav.item :misc_info_pages, 'Misc.', 'misc_info_pages', html: { split: true } do |misc_nav|
+          misc_nav.item :header_misc_pages, 'Misc. Pages', '#', html: { class: 'to_check_header2', header: true }
+          misc_nav.item :page1, 'Page1', 'page1'
+          misc_nav.item :page2, 'Page2', 'page2'
+        end
+        info_nav.item :divider_before_contact_info_page, '', '#', html: { divider: true }
+        info_nav.item :contact_info_page, 'Contact', 'contact_info_page'
+      end
+      primary.item :signed_in, 'Signed in as Pavel Shpak', '#', html: { class: 'to_check_navbar_text', navbar_text: true }
+    end
+
+
+    def demo_menu(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, '', '#', html: { divider: true }
+      primary.item :info, { icon: 'fa fa-fw fa-book', title: 'Info' }, '/info_index_path', html: { split: true } do |info_nav|
+        info_nav.item :main_info_page, 'Main info page', '/main_info_page'
+        info_nav.item :about_info_page, 'About', '/about_info_page'
+        info_nav.item :misc_info_pages, 'Misc.', '#' do |misc_nav|
+          misc_nav.item :header_misc_pages, 'Misc. Pages', '#', html: { header: true }
+          misc_nav.item :page1, 'Page1', '/page1'
+          misc_nav.item :page2, 'Page2', '/page2'
+        end
+        info_nav.item :divider_before_contact_info_page, '', '#', html: { divider: true }
+        info_nav.item :contact_info_page, 'Contact', '/contact_info_page'
+      end
+      primary.item :signed_in, 'Signed in as Pavel Shpak', '#', html: { navbar_text: true }
+    end
+
+
+    def empty_menu(primary)
+    end
+
+end