simple-navigation 4.4.1 → 4.5.0

data/spec/spec_helper.rb

@@ -1,76 +1,169 @@
-require 'initializers/have_css_matcher'
-require 'initializers/memfs'
-require 'initializers/coveralls'
-require 'initializers/rails'
-require 'initializers/rspec'
+# frozen_string_literal: true
+
+# Load ruby-warning gem
+require 'warning'
+
+Warning[:deprecated]   = true
+Warning[:experimental] = true
+Warning[:performance]  = true if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.3.0')
+
+# Ignore all warnings in Gem dependencies
+Gem.path.each do |path|
+  Warning.ignore(//, path)
+end
+
+# Ignore method redefinitions
+Warning.ignore(/warning: previous definition of/)
+Warning.ignore(/warning: method redefined;/)
+
+# Load simplecov
+require 'simplecov'
+require 'simplecov_json_formatter'
+
+# Start SimpleCov
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new([SimpleCov::Formatter::HTMLFormatter,
+                                                      SimpleCov::Formatter::JSONFormatter])
+  add_filter 'spec/'
+end
+
+# Load test gems
+require 'memfs'
 require 'capybara/rspec'
 
-require 'bundler/setup'
-Bundler.require
+# Define our own spec helper
+module SimpleNavigationTest
+  extend RSpec::Mocks::ExampleMethods
 
-if defined? Rails
-  require 'fake_app/rails_app'
-  require 'rspec/rails'
+  module_function
 
-  Capybara.app = RailsApp::Application
+  def setup_adapter_for(framework, context = double(:context))
+    if framework == :rails
+      # Rails 6.0 and 6.1 provide ActionView::Base.empty method that creates ActionView with an empty LookupContext.
+      # The method is not available on older versions
+      view_context = ActionView::Base.respond_to?(:empty) ? ActionView::Base.empty : ActionView::Base.new
+      allow(context).to receive_messages(view_context: view_context)
+    end
 
-  RSpec.configure do |config|
-    config.before do
-      SimpleNavigation.config_files.clear
-      setup_adapter_for :rails
+    allow(SimpleNavigation).to receive_messages(framework: framework)
+    SimpleNavigation.load_adapter
+    SimpleNavigation.init_adapter_from(context)
+  end
+
+  def select_an_item(item)
+    allow(item).to receive_messages(selected?: true)
+  end
+
+  def setup_container(dom_id, dom_class)
+    container = SimpleNavigation::ItemContainer.new(1)
+    container.dom_id = dom_id
+    container.dom_class = dom_class
+    container
+  end
+
+  def setup_navigation(dom_id, dom_class)
+    setup_adapter_for :rails
+    container = setup_container(dom_id, dom_class)
+    setup_items(container)
+    container
+  end
+
+  # FIXME: adding the :link option for the list renderer messes up the other
+  #        renderers
+  def setup_items(container) # rubocop:disable Metrics/AbcSize
+    container.item :users, 'Users', '/users', html: { id: 'users_id' }, link_html: { id: 'users_link_id' }
+    container.item :invoices, 'Invoices', '/invoices' do |invoices|
+      invoices.item :paid, 'Paid', '/invoices/paid'
+      invoices.item :unpaid, 'Unpaid', '/invoices/unpaid'
+    end
+    container.item :accounts, 'Accounts', '/accounts', html: { style: 'float:right' }
+    container.item :miscellany, 'Miscellany'
+
+    container.items.each do |item|
+      allow(item).to receive_messages(selected?: false, selected_by_condition?: false)
+
+      item.sub_navigation&.items&.each do |sub_item|
+        allow(sub_item).to receive_messages(selected?: false, selected_by_condition?: false)
+      end
     end
   end
 end
 
-def setup_adapter_for(framework, context = double(:context))
-  if framework == :rails
-    # Rails 6.0 and 6.1 provide ActionView::Base.empty method that creates ActionView with an empty LookupContext.
-    # The method is not available on older versions
-    view_context = ActionView::Base.respond_to?(:empty) ? ActionView::Base.empty : ActionView::Base.new
-    allow(context).to receive_messages(view_context: view_context)
+# Configure RSpec
+RSpec.configure do |config|
+  config.include SimpleNavigationTest
+
+  config.color = true
+  config.fail_fast = false
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with(:rspec) do |c|
+    c.syntax = :expect
   end
 
-  allow(SimpleNavigation).to receive_messages(framework: framework)
-  SimpleNavigation.load_adapter
-  SimpleNavigation.init_adapter_from(context)
-end
+  # disable monkey patching
+  # see: https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
 
-def select_an_item(item)
-  allow(item).to receive_messages(selected?: true)
-end
+  config.raise_errors_for_deprecations!
 
-def setup_container(dom_id, dom_class)
-  container = SimpleNavigation::ItemContainer.new(1)
-  container.dom_id = dom_id
-  container.dom_class = dom_class
-  container
+  config.around(memfs: true) do |example|
+    MemFs.activate { example.run }
+  end
 end
 
-def setup_navigation(dom_id, dom_class)
-  setup_adapter_for :rails
-  container = setup_container(dom_id, dom_class)
-  setup_items(container)
-  container
+# Define our own matcher
+RSpec::Matchers.define :have_css do |expected, times|
+  match do |actual|
+    selector = Nokogiri::HTML(actual).css(expected)
+
+    if times
+      expect(selector.size).to eq times
+    else
+      expect(selector.size).to be >= 1
+    end
+  end
+
+  failure_message do |actual|
+    "expected #{actual} to have #{times || 1} elements matching '#{expected}'"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected #{actual} not to have #{times || 1} elements matching '#{expected}'"
+  end
 end
 
-# FIXME: adding the :link option for the list renderer messes up the other
-#        renderers
-def setup_items(container)
-  container.item :users, 'Users', '/users', html: { id: 'users_id' }, link_html: { id: 'users_link_id' }
-  container.item :invoices, 'Invoices', '/invoices' do |invoices|
-    invoices.item :paid, 'Paid', '/invoices/paid'
-    invoices.item :unpaid, 'Unpaid', '/invoices/unpaid'
+RSpec::Matchers.define :have_no_css do |expected|
+  match do |actual|
+    selector = Nokogiri::HTML(actual).css(expected)
+    expect(selector.size).to eq 0
   end
-  container.item :accounts, 'Accounts', '/accounts', html: { style: 'float:right' }
-  container.item :miscellany, 'Miscellany'
 
-  container.items.each do |item|
-    allow(item).to receive_messages(selected?: false, selected_by_condition?: false)
+  failure_message do |actual|
+    "expected #{actual} to have no elements matching '#{expected}'"
+  end
 
-    if item.sub_navigation
-      item.sub_navigation.items.each do |item|
-        allow(item).to receive_messages(selected?: false, selected_by_condition?: false)
-      end
+  failure_message_when_negated do |actual|
+    "expected #{actual} to have elements matching '#{expected}'"
+  end
+end
+
+# Configure RSpec with Rails
+begin
+  require 'rails'
+rescue LoadError # rubocop:disable Lint/SuppressedException
+else
+  require 'fake_app/rails_app'
+  require 'rspec/rails'
+
+  Capybara.app = RailsApp::Application
+
+  RSpec.configure do |config|
+    config.before do
+      SimpleNavigation.config_files.clear
+      SimpleNavigationTest.setup_adapter_for :rails
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-navigation
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Andi Schacke
@@ -17,16 +17,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
-  name: ostruct
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,125 +40,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: memfs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -175,32 +63,38 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
-- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/_guard-core
+- bin/appraisal
+- bin/guard
+- bin/rake
+- bin/rspec
+- bin/rubocop
 - gemfiles/.bundle/config
-- gemfiles/rails-3-2-stable.gemfile
-- gemfiles/rails-4-1-stable.gemfile
-- gemfiles/rails-4-2-stable.gemfile
-- gemfiles/rails-5-2-stable.gemfile
-- gemfiles/rails-6-0-stable.gemfile
-- gemfiles/rails-6-1-stable.gemfile
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - generators/navigation_config/USAGE
 - generators/navigation_config/navigation_config_generator.rb
 - generators/navigation_config/templates/config/navigation.rb
-- init.rb
-- install.rb
 - lib/generators/navigation_config/navigation_config_generator.rb
 - lib/simple-navigation.rb
 - lib/simple_navigation.rb
-- lib/simple_navigation/adapters.rb
 - lib/simple_navigation/adapters/base.rb
 - lib/simple_navigation/adapters/nanoc.rb
 - lib/simple_navigation/adapters/padrino.rb
@@ -215,7 +109,6 @@ files:
 - lib/simple_navigation/item_container.rb
 - lib/simple_navigation/items_provider.rb
 - lib/simple_navigation/railtie.rb
-- lib/simple_navigation/renderer.rb
 - lib/simple_navigation/renderer/base.rb
 - lib/simple_navigation/renderer/breadcrumbs.rb
 - lib/simple_navigation/renderer/json.rb
@@ -226,12 +119,8 @@ files:
 - simple-navigation.gemspec
 - spec/fake_app/config/navigation.rb
 - spec/fake_app/rails_app.rb
-- spec/initializers/coveralls.rb
-- spec/initializers/have_css_matcher.rb
-- spec/initializers/memfs.rb
-- spec/initializers/rails.rb
-- spec/initializers/rspec.rb
 - spec/integration/rendering_navigation_spec.rb
+- spec/simple_navigation/adapters/nanoc_spec.rb
 - spec/simple_navigation/adapters/padrino_spec.rb
 - spec/simple_navigation/adapters/rails_spec.rb
 - spec/simple_navigation/adapters/sinatra_spec.rb
@@ -251,7 +140,6 @@ files:
 - spec/simple_navigation/renderer/text_spec.rb
 - spec/simple_navigation_spec.rb
 - spec/spec_helper.rb
-- uninstall.rb
 homepage: http://github.com/codeplant/simple-navigation
 licenses:
 - MIT
@@ -265,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -276,31 +164,4 @@ rubygems_version: 3.6.7
 specification_version: 4
 summary: simple-navigation is a ruby library for creating navigations (with multiple
   levels) for your Rails, Sinatra or Padrino application.
-test_files:
-- spec/fake_app/config/navigation.rb
-- spec/fake_app/rails_app.rb
-- spec/initializers/coveralls.rb
-- spec/initializers/have_css_matcher.rb
-- spec/initializers/memfs.rb
-- spec/initializers/rails.rb
-- spec/initializers/rspec.rb
-- spec/integration/rendering_navigation_spec.rb
-- spec/simple_navigation/adapters/padrino_spec.rb
-- spec/simple_navigation/adapters/rails_spec.rb
-- spec/simple_navigation/adapters/sinatra_spec.rb
-- spec/simple_navigation/config_file_finder_spec.rb
-- spec/simple_navigation/config_file_spec.rb
-- spec/simple_navigation/configuration_spec.rb
-- spec/simple_navigation/helpers_spec.rb
-- spec/simple_navigation/item_adapter_spec.rb
-- spec/simple_navigation/item_container_spec.rb
-- spec/simple_navigation/item_spec.rb
-- spec/simple_navigation/items_provider_spec.rb
-- spec/simple_navigation/renderer/base_spec.rb
-- spec/simple_navigation/renderer/breadcrumbs_spec.rb
-- spec/simple_navigation/renderer/json_spec.rb
-- spec/simple_navigation/renderer/links_spec.rb
-- spec/simple_navigation/renderer/list_spec.rb
-- spec/simple_navigation/renderer/text_spec.rb
-- spec/simple_navigation_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.travis.yml

@@ -1,23 +0,0 @@
-before_install:
-  - gem install bundler
-
-matrix:
-  include:
-  - rvm: 2.5.8
-    gemfile: gemfiles/rails-6-1-stable.gemfile
-  - rvm: 2.6.7
-    gemfile: gemfiles/rails-6-1-stable.gemfile
-  - rvm: 2.7.3
-    gemfile: gemfiles/rails-6-1-stable.gemfile
-  - rvm: 2.5.3
-    gemfile: gemfiles/rails-6-0-stable.gemfile
-  - rvm: 2.6.0
-    gemfile: gemfiles/rails-6-0-stable.gemfile
-  - rvm: 2.5.1
-    gemfile: gemfiles/rails-5-2-stable.gemfile
-  - rvm: 2.4.5
-    gemfile: gemfiles/rails-4-2-stable.gemfile
-  - rvm: 2.3.3
-    gemfile: gemfiles/rails-4-1-stable.gemfile
-  - rvm: 2.3.3
-    gemfile: gemfiles/rails-3-2-stable.gemfile

data/gemfiles/rails-3-2-stable.gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '< 11.0'
-gem 'railties', '~> 3.2.0'
-gem 'rspec-rails', '~> 3.2.1'
-
-if RUBY_VERSION >= '2.2.0'
-  gem 'test-unit', '~> 3.0'
-end
-
-gemspec path: '../'

data/gemfiles/rails-4-1-stable.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '< 11.0'
-gem 'railties', '~> 4.1.0'
-gem 'rspec-rails', '~> 3.2.1'
-
-gemspec path: '../'

data/gemfiles/rails-4-2-stable.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '< 11.0'
-gem 'railties', '~> 4.2.0'
-gem 'rspec-rails', '~> 3.2.1'
-
-gemspec path: '../'

data/gemfiles/rails-5-2-stable.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '< 11.0'
-gem 'railties', '~> 5.2.0'
-gem 'rspec-rails', '~> 3.8.2'
-
-gemspec path: '../'

data/gemfiles/rails-6-0-stable.gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '< 11.0'
-
-# not yet
-gem 'railties', '~> 6.0.0'
-gem 'rspec-rails', '~> 3.8.2'
-
-gemspec path: '../'

data/gemfiles/rails-6-1-stable.gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake', '< 11.0'
-
-# not yet
-gem 'railties', '~> 6.1.0'
-gem 'rspec-rails', '~> 3.8.2'
-
-gemspec path: '../'

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + '/rails/init'

data/install.rb

@@ -1,5 +0,0 @@
-begin
-  puts IO.read(File.join(File.dirname(__FILE__), 'README'))
-rescue Exception => e
-  puts "The following error ocurred while installing the plugin: #{e.message}"
-end

data/lib/simple_navigation/adapters.rb

@@ -1,10 +0,0 @@
-require 'simple_navigation/adapters/base'
-
-module SimpleNavigation
-  module Adapters
-    autoload :Rails, 'simple_navigation/adapters/rails'
-    autoload :Padrino, 'simple_navigation/adapters/padrino'
-    autoload :Sinatra, 'simple_navigation/adapters/sinatra'
-    autoload :Nanoc, 'simple_navigation/adapters/nanoc'
-  end
-end

data/lib/simple_navigation/renderer.rb

@@ -1,12 +0,0 @@
-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/spec/initializers/coveralls.rb

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

data/spec/initializers/have_css_matcher.rb

@@ -1,19 +0,0 @@
-RSpec::Matchers.define :have_css do |expected, times|
-  match do |actual|
-    selector = Nokogiri::HTML(actual).css(expected)
-
-    if times
-      expect(selector.size).to eq times
-    else
-      expect(selector.size).to be >= 1
-    end
-  end
-
-  failure_message do |actual|
-    "expected #{actual.to_s} to have #{times || 1} elements matching '#{expected}'"
-  end
-
-  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

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

data/spec/initializers/rails.rb

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

data/spec/initializers/rspec.rb

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

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here