simple-navigation 4.4.1 → 4.5.0

data/lib/simple_navigation/renderer/base.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+# frozen_string_literal: true
 
 module SimpleNavigation
   module Renderer
@@ -13,7 +13,7 @@ module SimpleNavigation
 
       def_delegators :adapter, :link_to, :content_tag
 
-      def initialize(options) #:nodoc:
+      def initialize(options) # :nodoc:
         @options = options
         @adapter = SimpleNavigation.adapter
       end
@@ -44,7 +44,7 @@ module SimpleNavigation
       # include_sub_navigation? to determine whether an item's sub_navigation
       # should be rendered or not.
       def render(item_container)
-        fail NotImplementedError, 'subclass responsibility'
+        raise NotImplementedError, 'subclass responsibility'
       end
 
       protected
@@ -89,11 +89,11 @@ module SimpleNavigation
       end
 
       # Extracts the options relevant for the generated link
-      def link_options_for(item)
+      def link_options_for(item) # rubocop:disable Metrics/MethodLength
         special_options = {
           method: item.method,
           class: item.selected_class
-        }.reject { |_, v| v.nil? }
+        }.compact
 
         link_options = item.link_html_options
 

data/lib/simple_navigation/renderer/breadcrumbs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Renderer
     # Renders an ItemContainer as a <div> element and its containing items as
@@ -25,11 +27,10 @@ module SimpleNavigation
       def a_tags(item_container)
         item_container.items.each_with_object([]) do |item, list|
           next unless item.selected?
+
           list << tag_for(item)
 
-          if include_sub_navigation?(item)
-            list.concat a_tags(item.sub_navigation)
-          end
+          list.concat a_tags(item.sub_navigation) if include_sub_navigation?(item)
         end
       end
 

data/lib/simple_navigation/renderer/json.rb

@@ -1,4 +1,4 @@
-require 'json'
+# frozen_string_literal: true
 
 module SimpleNavigation
   module Renderer

data/lib/simple_navigation/renderer/links.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Renderer
     # Renders an ItemContainer as a <div> element and its containing items as

data/lib/simple_navigation/renderer/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Renderer
     # Renders an ItemContainer as a <ul> element and its containing items as
@@ -28,14 +30,12 @@ module SimpleNavigation
       private
 
       def list_content(item_container)
-        item_container.items.map { |item|
+        item_container.items.map do |item|
           li_options = item.html_options.except(:link)
           li_content = tag_for(item)
-          if include_sub_navigation?(item)
-            li_content << render_sub_navigation_for(item)
-          end
+          li_content << render_sub_navigation_for(item) if include_sub_navigation?(item)
           content_tag(:li, li_content, li_options)
-        }.join
+        end.join
       end
     end
   end

data/lib/simple_navigation/renderer/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Renderer
     # Renders the 'chain' of selected navigation items as simple text items,
@@ -13,7 +15,7 @@ module SimpleNavigation
       def list(item_container)
         item_container.items.keep_if(&:selected?).map do |item|
           [item.name(apply_generator: false)] +
-          (include_sub_navigation?(item) ? list(item.sub_navigation) : [])
+            (include_sub_navigation?(item) ? list(item.sub_navigation) : [])
         end
       end
     end

data/lib/simple_navigation/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
-  VERSION = '4.4.1'
+  VERSION = '4.5.0'
 end

data/lib/simple_navigation.rb

@@ -1,24 +1,30 @@
-# cherry picking active_support stuff
+# frozen_string_literal: true
+
+# require ruby dependencies
+require 'cgi/escape'
+require 'forwardable'
+require 'json'
+require 'singleton'
+
+# require external dependencies
 require 'active_support/core_ext/array'
 require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
 require 'active_support/core_ext/module/attribute_accessors'
+require 'zeitwerk'
 
-require 'simple_navigation/version'
-require 'simple_navigation/configuration'
-require 'simple_navigation/item_adapter'
-require 'simple_navigation/item'
-require 'simple_navigation/item_container'
-require 'simple_navigation/items_provider'
-require 'simple_navigation/renderer'
-require 'simple_navigation/adapters'
-require 'simple_navigation/config_file_finder'
-require 'simple_navigation/railtie' if defined?(::Rails::Railtie)
-
-require 'forwardable'
+# load zeitwerk
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore("#{__dir__}/generators")
+  loader.ignore("#{__dir__}/simple-navigation.rb")
+  loader.setup
+end
 
 # A plugin for generating a simple navigation. See README for resources on
 # usage instructions.
 module SimpleNavigation
+  require_relative 'simple_navigation/railtie' if defined?(Rails::Railtie)
+
   mattr_accessor :adapter,
                  :adapter_class,
                  :config_files,
@@ -38,21 +44,21 @@ module SimpleNavigation
   # Maps renderer keys to classes. The keys serve as shortcut in the
   # render_navigation calls (renderer: :list)
   self.registered_renderers = {
-    list:        SimpleNavigation::Renderer::List,
-    links:       SimpleNavigation::Renderer::Links,
+    list: SimpleNavigation::Renderer::List,
+    links: SimpleNavigation::Renderer::Links,
     breadcrumbs: SimpleNavigation::Renderer::Breadcrumbs,
-    text:        SimpleNavigation::Renderer::Text,
-    json:        SimpleNavigation::Renderer::Json
+    text: SimpleNavigation::Renderer::Text,
+    json: SimpleNavigation::Renderer::Json
   }
 
   class << self
     extend Forwardable
 
     def_delegators :adapter, :context_for_eval,
-                             :current_page?,
-                             :request,
-                             :request_path,
-                             :request_uri
+                   :current_page?,
+                   :request,
+                   :request_path,
+                   :request_uri
 
     def_delegators :adapter_class, :register
 
@@ -67,11 +73,13 @@ module SimpleNavigation
     # Returns the current framework in which the plugin is running.
     def framework
       return :rails if defined?(Rails)
+      # :nocov:
       return :padrino if defined?(Padrino)
       return :sinatra if defined?(Sinatra)
       return :nanoc if defined?(Nanoc3)
-      fail 'simple_navigation currently only works for Rails, Sinatra and ' \
-           'Padrino apps'
+
+      raise 'simple_navigation currently only works for Rails, Sinatra and Padrino apps'
+      # :nocov:
     end
 
     # Loads the adapter for the current framework
@@ -138,7 +146,7 @@ module SimpleNavigation
       when Integer then primary_navigation.active_item_container_for(level)
       when Range then primary_navigation.active_item_container_for(level.min)
       else
-        fail ArgumentError, "Invalid navigation level: #{level}"
+        raise ArgumentError, "Invalid navigation level: #{level}"
       end
     end
 

data/simple-navigation.gemspec

@@ -1,42 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'simple_navigation/version'
+# frozen_string_literal: true
+
+require_relative 'lib/simple_navigation/version'
 
 Gem::Specification.new do |spec|
   spec.name             = 'simple-navigation'
   spec.version          = SimpleNavigation::VERSION
   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 "\
-                          "Padrino applications. The navigation is defined in a "    \
-                          "single configuration file. It supports automatic as well "\
-                          "as explicit highlighting of the currently active "        \
-                          "navigation through regular expressions."
-  spec.summary          = "simple-navigation is a ruby library for creating navigations "\
-                          "(with multiple levels) for your Rails, Sinatra or "  \
-                          "Padrino application."
+  spec.description      = 'With the simple-navigation gem installed you can easily ' \
+                          'create multilevel navigations for your Rails, Sinatra or ' \
+                          'Padrino applications. The navigation is defined in a ' \
+                          'single configuration file. It supports automatic as well ' \
+                          'as explicit highlighting of the currently active ' \
+                          'navigation through regular expressions.'
+  spec.summary          = 'simple-navigation is a ruby library for creating navigations ' \
+                          '(with multiple levels) for your Rails, Sinatra or ' \
+                          'Padrino application.'
   spec.homepage         = 'http://github.com/codeplant/simple-navigation'
   spec.license          = 'MIT'
 
   spec.files            = `git ls-files -z`.split("\x0")
-  spec.executables      = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths    = ['lib']
 
   spec.rdoc_options     = ['--inline-source', '--charset=UTF-8']
 
-  spec.add_runtime_dependency 'activesupport', '>= 2.3.2'
-  spec.add_runtime_dependency 'ostruct'
+  spec.required_ruby_version = '>= 3.0.0'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'capybara'
-  spec.add_development_dependency 'coveralls', '~> 0.7'
-  spec.add_development_dependency 'guard-rspec', '~> 4.2'
-  spec.add_development_dependency 'memfs', '~> 0.4.1'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rdoc'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'tzinfo', '>= 0'
+  spec.add_dependency 'activesupport', '>= 6.1.0'
+  spec.add_dependency 'json'
+  spec.add_dependency 'zeitwerk'
 end

data/spec/fake_app/config/navigation.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 SimpleNavigation::Configuration.run do |navigation|
   navigation.items do |nav|
-    nav.item :item_1, 'Item 1', '/item_1', html: {class: 'item_1'}, link_html: {id: 'link_1'}
-    nav.item :item_2, 'Item 2', '/item_2', html: {class: 'item_2'}, link_html: {id: 'link_2'}
+    nav.item :item1, 'Item 1', '/item_1', html: { class: 'item_1' }, link_html: { id: 'link_1' }
+    nav.item :item2, 'Item 2', '/item_2', html: { class: 'item_2' }, link_html: { id: 'link_2' }
   end
 end

data/spec/fake_app/rails_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'action_controller/railtie'
@@ -9,20 +11,20 @@ module RailsApp
     config.cache_classes = true
     config.eager_load = false
     config.root = __dir__
-    config.secret_token = 'x'*100
+    config.secret_token = 'x' * 100
     config.session_store :cookie_store, key: '_myapp_session'
   end
 
   class TestsController < ActionController::Base
     def base
-      render inline: <<-END
+      render inline: <<-HTML
         <!DOCTYPE html>
         <html>
           <body>
             <%= render_navigation %>
           </body>
         </html>
-      END
+      HTML
     end
   end
 end

data/spec/integration/rendering_navigation_spec.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 RSpec.feature 'Rendering navigation' do
   background do
     SimpleNavigation.set_env(RailsApp::Application.root, 'test')
   end
 
-  scenario 'Rendering basic navigation', type: :feature do
+  scenario 'Rendering basic navigation', type: :feature do # rubocop:disable RSpec/MultipleExpectations
     visit '/base_spec'
 
-    expect(page).to have_content('Item 1')
-    expect(page).to have_content('Item 2')
-    expect(page).to have_selector('li.item_1 a#link_1')
-    expect(page).to have_selector('li.item_2 a#link_2')
+    expect(page).to have_text('Item 1')
+    expect(page).to have_text('Item 2')
+    expect(page).to have_css('li.item_1 a#link_1')
+    expect(page).to have_css('li.item_2 a#link_2')
   end
 end

data/spec/simple_navigation/adapters/nanoc_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# NOTE: This adapter is deprecated. It supports Nanoc3 (circa 2011-2012) which is obsolete.
+# These tests are maintained for backward compatibility only.
+RSpec.describe SimpleNavigation::Adapters::Nanoc do
+  let(:adapter) { described_class.new(context) }
+  let(:context) { double(:context, item: item) }
+  let(:item) { double(:item, path: '/test/path/') }
+
+  describe '.register' do
+    let(:nanoc_context) { double(:nanoc_context) }
+
+    before do
+      stub_const('Nanoc3::Context', nanoc_context)
+      allow(SimpleNavigation).to receive(:set_env)
+      allow(nanoc_context).to receive(:include)
+    end
+
+    it 'calls SimpleNavigation.set_env with root and development environment' do
+      expect(SimpleNavigation).to receive(:set_env).with('/root/path', 'development')
+      described_class.register('/root/path')
+    end
+
+    it 'includes SimpleNavigation::Helpers in Nanoc3::Context' do
+      expect(nanoc_context).to receive(:include).with(SimpleNavigation::Helpers)
+      described_class.register('/root/path')
+    end
+  end
+
+  describe '#initialize' do
+    it 'sets the context' do
+      expect(adapter.instance_variable_get(:@context)).to eq context
+    end
+  end
+
+  describe '#context_for_eval' do
+    it 'returns the context' do
+      expect(adapter.context_for_eval).to eq context
+    end
+  end
+
+  describe '#current_page?' do
+    context 'when the path matches the url (after chomping the trailing slash)' do
+      it 'returns true' do
+        expect(adapter.current_page?('/test/path')).to be true
+      end
+    end
+
+    context 'when the path does not match the url' do
+      it 'returns false' do
+        expect(adapter.current_page?('/other/path')).to be false
+      end
+    end
+
+    context 'when path is nil' do
+      let(:item) { double(:item, path: nil) }
+
+      it 'returns nil' do
+        expect(adapter.current_page?('/test/path')).to be_nil
+      end
+    end
+  end
+
+  describe '#link_to' do
+    it 'returns a link with the correct attributes' do
+      link = adapter.link_to('Test Link', '/url', class: 'nav-link', id: 'link1')
+      expect(link).to eq "<a href='/url' class='nav-link' id='link1'>Test Link</a>"
+    end
+
+    it 'handles options without values' do
+      link = adapter.link_to('Test', '/url', {})
+      expect(link).to eq "<a href='/url' >Test</a>"
+    end
+
+    it 'filters out nil values' do
+      link = adapter.link_to('Test', '/url', class: 'nav', id: nil)
+      expect(link).to eq "<a href='/url' class='nav'>Test</a>"
+    end
+  end
+
+  describe '#content_tag' do
+    it 'returns a tag with the correct type, content and attributes' do
+      tag = adapter.content_tag(:div, 'Content', class: 'container', id: 'main')
+      expect(tag).to eq "<div class='container' id='main'>Content</div>"
+    end
+
+    it 'handles tags without attributes' do
+      tag = adapter.content_tag(:span, 'Text', {})
+      expect(tag).to eq '<span >Text</span>'
+    end
+
+    it 'filters out nil values from attributes' do
+      tag = adapter.content_tag(:p, 'Paragraph', class: 'text', id: nil)
+      expect(tag).to eq "<p class='text'>Paragraph</p>"
+    end
+  end
+end

data/spec/simple_navigation/adapters/padrino_spec.rb

@@ -1,27 +1,46 @@
-module SimpleNavigation
-  module Adapters
-    describe Padrino do
-      let(:adapter) { SimpleNavigation::Adapters::Padrino.new(context) }
-      let(:content) { double(:content) }
-      let(:context) { double(:context, request: request) }
-      let(:request) { double(:request) }
+# frozen_string_literal: true
 
-      describe '#link_to' do
-        it 'delegates to context' do
-          expect(context).to receive(:link_to)
-                             .with('name', 'url', :my_option => true)
-          adapter.link_to('name', 'url', :my_option => true)
-        end
-      end
+RSpec.describe SimpleNavigation::Adapters::Padrino do
+  let(:adapter) { described_class.new(context) }
+  let(:content) { double(:content) }
+  let(:context) { double(:context, request: request) }
+  let(:request) { double(:request) }
 
-      describe '#content_tag' do
-        it 'delegates to context' do
-          expect(content).to receive(:html_safe).and_return('content')
-          expect(context).to receive(:content_tag)
-                             .with('type', 'content', my_option: true)
-          adapter.content_tag('type', content, my_option: true)
-        end
-      end
+  describe '.register' do
+    let(:padrino_module) { Module.new }
+    let(:padrino_application) { Module.new }
+
+    before do
+      stub_const('Padrino', padrino_module)
+      stub_const('Padrino::Application', padrino_application)
+      allow(padrino_module).to receive_messages(root: '/padrino/root', env: 'production')
+      allow(SimpleNavigation).to receive(:set_env)
+      allow(padrino_application).to receive(:send)
+    end
+
+    it 'calls SimpleNavigation.set_env with Padrino root and env' do
+      expect(SimpleNavigation).to receive(:set_env).with('/padrino/root', 'production')
+      described_class.register(nil)
+    end
+
+    it 'includes SimpleNavigation::Helpers in Padrino::Application' do
+      expect(padrino_application).to receive(:send).with(:helpers, SimpleNavigation::Helpers)
+      described_class.register(nil)
+    end
+  end
+
+  describe '#link_to' do
+    it 'delegates to context' do
+      expect(context).to receive(:link_to).with('name', 'url', { my_option: true })
+      adapter.link_to('name', 'url', my_option: true)
+    end
+  end
+
+  describe '#content_tag' do
+    it 'delegates to context' do # rubocop:disable RSpec/MultipleExpectations
+      expect(content).to receive(:html_safe).and_return('content') # rubocop:disable RSpec/StubbedMock
+      expect(context).to receive(:content_tag).with('type', 'content', { my_option: true })
+      adapter.content_tag('type', content, my_option: true)
     end
   end
 end