simple-navigation 3.14.0 → 4.0.0

data/lib/simple_navigation/{core/item_adapter.rb → item_adapter.rb}

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'ostruct'
 
 module SimpleNavigation
   # This class acts as an adapter to items that are not defined using the DSL
@@ -30,7 +31,7 @@ module SimpleNavigation
     attr_reader :item
 
     def initialize(item)
-      @item = item.is_a?(Hash) ? to_object(item) : item
+      @item = item.is_a?(Hash) ? OpenStruct.new(item) : item
     end
 
     # Returns the options for this item. If the wrapped item does not implement
@@ -47,22 +48,7 @@ module SimpleNavigation
 
     # Converts this Item into a SimpleNavigation::Item
     def to_simple_navigation_item(item_container)
-      SimpleNavigation::Item.new(item_container, key, name, url, options, items)
-    end
-
-    protected
-
-    # Converts the specified hash into an object. Each key will be added
-    # as method.
-    def to_object(hash)
-      mod = Module.new do
-        hash.each_pair do |key, value|
-          define_method key do
-            value
-          end
-        end
-      end
-      Object.new.extend(mod)
+      SimpleNavigation::Item.new(item_container, key, name, url, options)
     end
   end
 end

data/lib/simple_navigation/{core/item_container.rb → item_container.rb}

@@ -59,22 +59,18 @@ module SimpleNavigation
     #   set a regexp which is matched againstthe current URI.
     #
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
-    def item(key, name, url_or_options = {}, options_or_nil = {}, &block)
-      options = url_or_options.is_a?(Hash) ? url_or_options : options_or_nil
+    def item(key, name, url = nil, options = {}, &block)
       return unless should_add_item?(options)
-      items << SimpleNavigation::Item.new(self,
-                                          key,
-                                          name,
-                                          url_or_options,
-                                          options_or_nil,
-                                          nil,
-                                          &block)
+      item = Item.new(self, key, name, url, options, &block)
+      add_item item, options
     end
 
     def items=(new_items)
-      @items += new_items.map { |item| ItemAdapter.new(item) }
-                         .keep_if { |item| should_add_item?(item.options) }
-                         .map { |item| item.to_simple_navigation_item(self) }
+      new_items.each do |item|
+        item_adapter = ItemAdapter.new(item)
+        next unless should_add_item?(item_adapter.options)
+        add_item item_adapter.to_simple_navigation_item(self), item_adapter.options
+      end
     end
 
     # Returns the Item with the specified key, nil otherwise.
@@ -148,6 +144,19 @@ module SimpleNavigation
 
     private
 
+    def add_item(item, options)
+      items << item
+      modify_dom_attributes(options)
+    end
+
+    def modify_dom_attributes(options)
+      return unless container_options = options[:container]
+      self.dom_attributes = container_options.fetch(:attributes) { dom_attributes }
+      self.dom_class = container_options.fetch(:class) { dom_class }
+      self.dom_id = container_options.fetch(:id) { dom_id }
+      self.selected_class = container_options.fetch(:selected_class) { selected_class }
+    end
+
     # FIXME: raise an exception if :rederer is a symbol and it is not registred
     #        in SimpleNavigation.registered_renderers
     def renderer_instance(options)
@@ -166,8 +175,8 @@ module SimpleNavigation
     end
 
     def should_add_item?(options)
-      [options.delete(:if)].flatten.compact.all? { |m| evaluate_method(m) } &&
-      [options.delete(:unless)].flatten.compact.none? { |m| evaluate_method(m) }
+      [options[:if]].flatten.compact.all? { |m| evaluate_method(m) } &&
+      [options[:unless]].flatten.compact.none? { |m| evaluate_method(m) }
     end
 
     def evaluate_method(method)

data/lib/simple_navigation/railtie.rb

@@ -0,0 +1,7 @@
+module SimpleNavigation
+  class Railtie < ::Rails::Railtie
+    initializer 'simple_navigation.register' do |app|
+      SimpleNavigation.register
+    end
+  end
+end

data/lib/simple_navigation/renderer.rb

@@ -0,0 +1,12 @@
+require 'simple_navigation/helpers'
+require 'simple_navigation/renderer/base'
+
+module SimpleNavigation
+  module Renderer
+    autoload :List, 'simple_navigation/renderer/list'
+    autoload :Links, 'simple_navigation/renderer/links'
+    autoload :Breadcrumbs, 'simple_navigation/renderer/breadcrumbs'
+    autoload :Text, 'simple_navigation/renderer/text'
+    autoload :Json, 'simple_navigation/renderer/json'
+  end
+end

data/lib/simple_navigation/{rendering/renderer → renderer}/base.rb

@@ -95,7 +95,7 @@ module SimpleNavigation
           class: item.selected_class
         }.reject { |_, v| v.nil? }
 
-        link_options = item.html_options[:link]
+        link_options = item.link_html_options
 
         return special_options unless link_options
 

data/lib/simple_navigation/{rendering/renderer → renderer}/json.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module SimpleNavigation
   module Renderer
     # Renders the navigation items as a object tree serialized as a json string,

data/lib/simple_navigation/version.rb

@@ -1,3 +1,3 @@
 module SimpleNavigation
-  VERSION = '3.14.0'
+  VERSION = '4.0.0'
 end

data/simple-navigation.gemspec

@@ -6,7 +6,7 @@ require 'simple_navigation/version'
 Gem::Specification.new do |spec|
   spec.name             = 'simple-navigation'
   spec.version          = SimpleNavigation::VERSION
-  spec.authors          = ['Andi Schacke', 'Mark J. Titorenko']
+  spec.authors          = ['Andi Schacke', 'Mark J. Titorenko', 'Simon Courtois']
   spec.email            = ['andi@codeplant.ch']
   spec.description      = "With the simple-navigation gem installed you can easily " \
                           "create multilevel navigations for your Rails, Sinatra or "\
@@ -29,12 +29,13 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'activesupport', '>= 2.3.2'
 
-  spec.add_development_dependency 'actionpack', '>= 2.3.2'
   spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'guard-rspec', '~> 4.2'
-  spec.add_development_dependency 'json_spec', '~> 1.1'
+  spec.add_development_dependency 'memfs', '~> 0.4.1'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rdoc'
-  spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'tzinfo', '>= 0'
 end

data/spec/fake_app/config/navigation.rb

@@ -0,0 +1,6 @@
+SimpleNavigation::Configuration.run do |navigation|
+  navigation.items do |nav|
+    nav.item :item_1, 'Item 1', '/item_1'
+    nav.item :item_2, 'Item 2', '/item_2'
+  end
+end

data/spec/fake_app/rails_app.rb

@@ -0,0 +1,35 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'action_controller/railtie'
+require 'simple_navigation'
+
+module RailsApp
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+    config.cache_classes = true
+    config.eager_load = false
+    config.root = __dir__
+    config.secret_token = 'x'*100
+    config.session_store :cookie_store, key: '_myapp_session'
+  end
+
+  class TestsController < ActionController::Base
+    def base
+      render inline: <<-END
+        <!DOCTYPE html>
+        <html>
+          <body>
+            <%= render_navigation %>
+          </body>
+        </html>
+      END
+    end
+  end
+end
+
+Rails.backtrace_cleaner.remove_silencers!
+RailsApp::Application.initialize!
+
+RailsApp::Application.routes.draw do
+  get '/base_spec' => 'rails_app/tests#base'
+end

data/spec/initializers/coveralls.rb

@@ -0,0 +1,3 @@
+require 'coveralls'
+
+Coveralls.wear!

data/spec/initializers/have_css_matcher.rb

@@ -1,13 +1,18 @@
 RSpec::Matchers.define :have_css do |expected, times|
   match do |actual|
-    HTML::Selector.new(expected).select(actual).should have_at_least(times || 1).entry
+    selector = HTML::Selector.new(expected).select(actual)
+    if times
+      expect(selector.size).to eq times
+    else
+      expect(selector.size).to be >= 1
+    end
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "expected #{actual.to_s} to have #{times || 1} elements matching '#{expected}'"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "expected #{actual.to_s} not to have #{times || 1} elements matching '#{expected}'"
   end
 end

data/spec/initializers/memfs.rb

@@ -0,0 +1,7 @@
+require 'memfs'
+
+RSpec.configure do |config|
+  config.around(memfs: true) do |example|
+    MemFs.activate { example.run }
+  end
+end

data/spec/initializers/rails.rb

@@ -0,0 +1,4 @@
+begin
+  require 'rails'
+rescue LoadError
+end

data/spec/initializers/rspec.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.expect_with(:rspec) do |c|
+    c.syntax = :expect
+  end
+
+  config.order = :random
+end

data/spec/integration/rendering_navigation_spec.rb

@@ -0,0 +1,12 @@
+RSpec.feature 'Rendering navigation' do
+  background do
+    SimpleNavigation.set_env(RailsApp::Application.root, 'test')
+  end
+
+  scenario 'Rendering basic navigation', type: :feature do
+    visit '/base_spec'
+
+    expect(page).to have_content('Item 1')
+    expect(page).to have_content('Item 2')
+  end
+end

data/spec/{lib/simple_navigation → simple_navigation}/adapters/padrino_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Adapters
     describe Padrino do

data/spec/{lib/simple_navigation → simple_navigation}/adapters/rails_spec.rb

@@ -1,10 +1,8 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Adapters
     describe Rails do
       let(:action_controller) { ActionController::Base }
-      let(:adapter) { SimpleNavigation::Adapters::Rails.new(context) }
+      let(:adapter) { Rails.new(context) }
       let(:context) { double(:context, controller: controller) }
       let(:controller) { double(:controller) }
       let(:request) { double(:request) }
@@ -12,10 +10,11 @@ module SimpleNavigation
       let(:template) { double(:template, request: request) }
 
       describe '.register' do
-        before { action_controller.stub(:include) }
+        before { allow(action_controller).to receive(:include) }
 
         it 'calls set_env' do
-          expect(simple_navigation).to receive(:set_env).with('./', 'test')
+          app_path = RailsApp::Application.root
+          expect(simple_navigation).to receive(:set_env).with(app_path, 'test')
           simple_navigation.register
         end
 
@@ -25,19 +24,25 @@ module SimpleNavigation
           simple_navigation.register
         end
 
-        it 'installs the helper methods in the controller' do
-          expect(action_controller).to receive(:helper_method).with(:render_navigation)
-          expect(action_controller).to receive(:helper_method).with(:active_navigation_item_name)
-          expect(action_controller).to receive(:helper_method).with(:active_navigation_item_key)
-          expect(action_controller).to receive(:helper_method).with(:active_navigation_item)
-          expect(action_controller).to receive(:helper_method).with(:active_navigation_item_container)
-          simple_navigation.register
+        shared_examples 'installing helper method' do |method|
+          it "installs the #{method} method as helper method" do
+            simple_navigation.register
+
+            helper_methods = action_controller.send(:_helper_methods)
+            expect(helper_methods).to include(method)
+          end
         end
+
+        it_behaves_like 'installing helper method', :render_navigation
+        it_behaves_like 'installing helper method', :active_navigation_item_name
+        it_behaves_like 'installing helper method', :active_navigation_item_key
+        it_behaves_like 'installing helper method', :active_navigation_item
+        it_behaves_like 'installing helper method', :active_navigation_item_container
       end
 
       describe '#initialize' do
         context "when the controller's template is set" do
-          before { controller.stub(instance_variable_get: template) }
+          before { allow(controller).to receive_messages(instance_variable_get: template) }
 
           it "sets the adapter's request accordingly" do
             expect(adapter.request).to be request
@@ -45,7 +50,7 @@ module SimpleNavigation
         end
 
         context "when the controller's template is not set" do
-          before { controller.stub(instance_variable_get: nil) }
+          before { allow(controller).to receive_messages(instance_variable_get: nil) }
 
           it "sets the adapter's request to nil" do
             expect(adapter.request).to be_nil
@@ -58,7 +63,7 @@ module SimpleNavigation
 
         context "when the controller's template is stored as instance var (Rails2)" do
           context "when the controller's template is set" do
-            before { controller.stub(instance_variable_get: template) }
+            before { allow(controller).to receive_messages(instance_variable_get: template) }
 
             it "sets the adapter's template accordingly" do
               expect(adapter.template).to be template
@@ -66,7 +71,7 @@ module SimpleNavigation
           end
 
           context "when the controller's template is not set" do
-            before { controller.stub(instance_variable_get: nil) }
+            before { allow(controller).to receive_messages(instance_variable_get: nil) }
 
             it "set the adapter's template to nil" do
               expect(adapter.template).to be_nil
@@ -76,7 +81,7 @@ module SimpleNavigation
 
         context "when the controller's template is stored as view_context (Rails3)" do
           context 'and the template is set' do
-            before { controller.stub(view_context: template) }
+            before { allow(controller).to receive_messages(view_context: template) }
 
             it "sets the adapter's template accordingly" do
               expect(adapter.template).to be template
@@ -84,7 +89,7 @@ module SimpleNavigation
           end
 
           context 'and the template is not set' do
-            before { controller.stub(view_context: nil) }
+            before { allow(controller).to receive_messages(view_context: nil) }
 
             it "sets the adapter's template to nil" do
               expect(adapter.template).to be_nil
@@ -92,10 +97,10 @@ module SimpleNavigation
           end
         end
       end
-  
+
       describe '#request_uri' do
         context "when the adapter's request is set" do
-          before { adapter.stub(request: request) }
+          before { allow(adapter).to receive_messages(request: request) }
 
           context 'and request.fullpath is defined' do
             let(:request) { double(:request, fullpath: '/fullpath') }
@@ -108,7 +113,7 @@ module SimpleNavigation
           context 'and request.fullpath is not defined' do
             let(:request) { double(:request, request_uri: '/request_uri') }
 
-            before { adapter.stub(request: request) }
+            before { allow(adapter).to receive_messages(request: request) }
 
             it "sets the adapter's request_uri to the request.request_uri" do
               expect(adapter.request_uri).to eq '/request_uri'
@@ -117,19 +122,19 @@ module SimpleNavigation
         end
 
         context "when the adapter's request is not set" do
-          before { adapter.stub(request: nil) }
+          before { allow(adapter).to receive_messages(request: nil) }
 
           it "sets the adapter's request_uri to an empty string" do
             expect(adapter.request_uri).to eq ''
           end
         end
       end
-  
+
       describe '#request_path' do
         context "when the adapter's request is set" do
           let(:request) { double(:request, path: '/request_path') }
 
-          before { adapter.stub(request: request) }
+          before { allow(adapter).to receive_messages(request: request) }
 
           it "sets the adapter's request_path to the request.path" do
             expect(adapter.request_path).to eq '/request_path'
@@ -137,7 +142,7 @@ module SimpleNavigation
         end
 
         context "when the adapter's request is not set" do
-          before { adapter.stub(request: nil) }
+          before { allow(adapter).to receive_messages(request: nil) }
 
           it "sets the adapter's request_path to an empty string" do
             expect(adapter.request_path).to eq ''
@@ -189,7 +194,7 @@ module SimpleNavigation
 
       describe '#current_page?' do
         context "when the adapter's template is set" do
-          before { adapter.stub(template: template) }
+          before { allow(adapter).to receive_messages(template: template) }
 
           it 'delegates the call to the template' do
             expect(template).to receive(:current_page?).with(:page)
@@ -198,7 +203,7 @@ module SimpleNavigation
         end
 
         context "when the adapter's template is not set" do
-          before { adapter.stub(template: nil) }
+          before { allow(adapter).to receive_messages(template: nil) }
 
           it 'returns false' do
             expect(adapter).not_to be_current_page(:page)
@@ -210,7 +215,7 @@ module SimpleNavigation
         let(:options) { double(:options) }
 
         context "when the adapter's template is set" do
-          before { adapter.stub(template: template, html_safe: 'safe_text') }
+          before { allow(adapter).to receive_messages(template: template, html_safe: 'safe_text') }
 
           context 'with considering item names as safe' do
             before { SimpleNavigation.config.consider_item_names_as_safe = true }
@@ -232,11 +237,10 @@ module SimpleNavigation
             end
           end
 
-
         end
 
         context "when the adapter's template is not set" do
-          before { adapter.stub(template: nil) }
+          before { allow(adapter).to receive_messages(template: nil) }
 
           it 'returns nil' do
             expect(adapter.link_to('text', 'url', options)).to be_nil
@@ -248,7 +252,7 @@ module SimpleNavigation
         let(:options) { double(:options) }
 
         context "when the adapter's template is set" do
-          before { adapter.stub(template: template, html_safe: 'safe_text') }
+          before { allow(adapter).to receive_messages(template: template, html_safe: 'safe_text') }
 
           it 'delegates the call to the template (with html_safe text)' do
             expect(template).to receive(:content_tag)
@@ -258,7 +262,7 @@ module SimpleNavigation
         end
 
         context "when the adapter's template is not set" do
-          before { adapter.stub(template: nil) }
+          before { allow(adapter).to receive_messages(template: nil) }
 
           it 'returns nil' do
             expect(adapter.content_tag(:div, 'text', options)).to be_nil
@@ -266,67 +270,6 @@ module SimpleNavigation
         end
       end
 
-      describe '#extract_controller_from' do
-        context 'when context responds to controller' do
-          it 'returns the controller' do
-            expect(adapter.send(:extract_controller_from, context)).to be controller
-          end
-        end
-
-        context 'when context does not respond to controller' do
-          let(:context) { double(:context) }
-
-          it 'returns the context' do
-            expect(adapter.send(:extract_controller_from, context)).to be context
-          end
-        end
-      end
-  
-      describe '#html_safe' do
-        let(:input) { double(:input) }
-
-        context 'when input responds to html_safe' do
-          let(:safe) { double(:safe) }
-
-          before { input.stub(html_safe: safe) }
-
-          it 'returns the html safe version of the input' do
-            expect(adapter.send(:html_safe, input)).to be safe
-          end
-        end
-
-        context 'when input does not respond to html_safe' do
-          it 'returns the input' do
-            expect(adapter.send(:html_safe, input)).to be input
-          end
-        end
-      end
-
-      describe '#link_title' do
-        let(:name) { double(:name, html_safe: safe) }
-        let(:safe) { double(:safe) }
-
-        context 'when config option consider_item_names_as_safe is true' do
-          before { SimpleNavigation.config.consider_item_names_as_safe = true }
-          after { SimpleNavigation.config.consider_item_names_as_safe = false }
-          
-          it 'uses the html_safe version of the name' do
-            expect(adapter.send(:link_title, name)).to be safe
-          end
-        end
-
-        # TODO: Does it make sense ?
-        context 'when config option consider_item_names_as_safe is false (default)' do
-          before do
-            SimpleNavigation.config.consider_item_names_as_safe = false
-            adapter.stub(template: template)
-          end
-
-          it 'uses the item name' do
-            expect(adapter.send(:link_title, name)).to be name
-          end
-        end
-      end
     end
   end
 end