simple-navigation 4.1.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 80fdb7f2e02862d983ad05c0fdfc0abba3e702e8
-  data.tar.gz: 8b61d65bd217b32bea405141a7e5f5e212d79159
+SHA256:
+  metadata.gz: 66e6c73b8c96a17a4730125ae741fc1f11f3c9495578cafdb2795223a251614c
+  data.tar.gz: 2b7e406ee541892f12e459eb2218a382f4f3ac26b89f11c382dfa92424146312
 SHA512:
-  metadata.gz: 8171a0a34b62e9ca31f1c1d7fb6ab9ca838be0d566243cd0d11c106797d8279f2e53aeb634eeae79b01e9007da24b47bb706a776580ec010859bc9b74751d0e5
-  data.tar.gz: 9cff271a844731db1151e6031dac06351d8592b3038327e92e0f7b245045f523974c741f9dd33332baeeb492cea9d474fd29f54fe6318517596d02222d5115fc
+  metadata.gz: 252b910e666cd652c25bc42823c3366d4d7f88b541684d6123b4644bcb121657ea22b59415c8333ffa0e69eff6586f2bee75c754426899ab4b8895f9e66a2814
+  data.tar.gz: c4b8fa52310cda2c367e24e88c0366d49d6cbfff41443be5c50092445a80fe14f27f014df47e08e19b4c75cf8d55d55678e606df9a7f2866feb7ea6d1f2e7859

data/.travis.yml

@@ -3,6 +3,12 @@ before_install:
 
 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
@@ -15,4 +21,3 @@ matrix:
     gemfile: gemfiles/rails-4-1-stable.gemfile
   - rvm: 2.3.3
     gemfile: gemfiles/rails-3-2-stable.gemfile
-  

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 4.4.0
+
+* add options rendering to json renderer. Credits to Mikhail Kytyzov.
+
+## 4.3.0
+
+* removed warnings from rspec. Thanks mgrunberg.
+* add compatibility with rails 6.1. Credits to mgrunberg.
+* run specs against 6.1. Credits to mgrunberg.
+
+## 4.2.0
+
+* improvements to generator template. Credits to mgrunberg.
+* be able to run 'rake spec:rails-6-0-stable'. Credits to mgrunberg.
+
 ## 4.1.0
 
 * Delay rails6 initialization using on_load (getting rid of deprecation warnings in rails 6). Credits to Markus Benning.

data/README.md

@@ -60,4 +60,4 @@ In this situation `/Users/username/.rubies/ruby-2.2.3/bin/rake` is the command y
 
 ## License
 
-Copyright (c) 2019 codeplant GmbH, released under the MIT license
+Copyright (c) 2022 codeplant GmbH, released under the MIT license

data/Rakefile

@@ -16,6 +16,8 @@ namespace :spec do
     rails-4-1-stable
     rails-4-2-stable
     rails-5-2-stable
+    rails-6-0-stable
+    rails-6-1-stable
   ]
 
   mappers.each do |gemfile|

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

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

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

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

data/generators/navigation_config/templates/config/navigation.rb

@@ -24,7 +24,7 @@ SimpleNavigation::Configuration.run do |navigation|
   # If you need to add custom html around item names, you can define a proc that
   # will be called with the name you pass in to the navigation.
   # The example below shows how to wrap items spans.
-  #navigation.name_generator = Proc.new {|name, item| "<span>#{name}</span>"}
+  #navigation.name_generator = Proc.new {|name, item| tag.span(name) }
 
   # Specify if the auto highlight feature is turned on (globally, for the whole navigation). Defaults to true
   #navigation.auto_highlight = true
@@ -45,6 +45,7 @@ SimpleNavigation::Configuration.run do |navigation|
     # url - the address that the generated item links to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
     # options - can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
     #           some special options that can be set:
+    #           :html - Specifies html attributes that will be included in the rendered navigation item
     #           :if - Specifies a proc to call to determine if the item should
     #                 be rendered (e.g. <tt>if: -> { current_user.admin? }</tt>). The
     #                 proc should evaluate to a true or false value and is evaluated in the context of the view.
@@ -67,7 +68,7 @@ SimpleNavigation::Configuration.run do |navigation|
     # You can also specify a condition-proc that needs to be fullfilled to display an item.
     # Conditions are part of the options. They are evaluated in the context of the views,
     # thus you can use all the methods and vars you have available in the views.
-    primary.item :key_3, 'Admin', url, class: 'special', if: -> { current_user.admin? }
+    primary.item :key_3, 'Admin', url, html: { class: 'special' }, if: -> { current_user.admin? }
     primary.item :key_4, 'Account', url, unless: -> { logged_in? }
 
     # you can also specify html attributes to attach to this particular level

data/lib/simple_navigation/item.rb

@@ -5,7 +5,8 @@ module SimpleNavigation
     attr_reader :key,
                 :name,
                 :sub_navigation,
-                :url
+                :url,
+                :options
 
     # see ItemContainer#item
     #
@@ -121,13 +122,13 @@ module SimpleNavigation
 
     private
 
-    attr_accessor :container,
-                  :options
+    attr_accessor :container
 
     attr_writer :key,
                 :name,
                 :sub_navigation,
-                :url
+                :url,
+                :options
 
     def config
       SimpleNavigation.config

data/lib/simple_navigation/renderer/json.rb

@@ -20,7 +20,8 @@ module SimpleNavigation
             items: hash_render(item.sub_navigation),
             name: item.name,
             selected: item.selected?,
-            url: item.url
+            url: item.url,
+            options: item.options
           }
         end
       end

data/lib/simple_navigation/version.rb

@@ -1,3 +1,3 @@
 module SimpleNavigation
-  VERSION = '4.1.0'
+  VERSION = '4.4.0'
 end

data/spec/simple_navigation/adapters/rails_spec.rb

@@ -186,7 +186,7 @@ module SimpleNavigation
             before { adapter.instance_variable_set(:@template, nil) }
 
             it 'raises an exception' do
-              expect{ adapter.context_for_eval }.to raise_error
+              expect{ adapter.context_for_eval }.to raise_error(RuntimeError, 'no context set for evaluation the config file')
             end
           end
         end

data/spec/simple_navigation/adapters/sinatra_spec.rb

@@ -9,7 +9,7 @@ describe SimpleNavigation::Adapters::Sinatra do
     context "when adapter's context is not set" do
       it 'raises an exception' do
         allow(adapter).to receive_messages(context: nil)
-        expect{ adapter.context_for_eval }.to raise_error
+        expect{ adapter.context_for_eval }.to raise_error(RuntimeError, 'no context set for evaluation the config file')
       end
     end
 

data/spec/simple_navigation/config_file_finder_spec.rb

@@ -23,7 +23,7 @@ module SimpleNavigation
 
         context 'and no navigation.rb file is found in the paths' do
           it 'raises an exception' do
-            expect{ finder.find(context) }.to raise_error
+            expect { finder.find(context) }.to raise_error(RuntimeError, /Config file 'navigation.rb' not found in path\(s\)/)
           end
         end
       end
@@ -41,7 +41,7 @@ module SimpleNavigation
 
         context 'and no other_navigation.rb file is found in the paths' do
           it 'raise an exception' do
-            expect{ finder.find(context) }.to raise_error
+            expect{ finder.find(context) }.to raise_error(RuntimeError, /Config file 'other_navigation.rb' not found in path\(s\)/)
           end
         end
       end

data/spec/simple_navigation/configuration_spec.rb

@@ -89,7 +89,7 @@ module SimpleNavigation
           let(:provider) { double(:provider) }
 
           it 'raises an exception' do
-            expect{ config.items(provider) {} }.to raise_error
+            expect{ config.items(provider) {} }.to raise_error(RuntimeError, 'please specify either items_provider or block, but not both')
           end
         end
 
@@ -139,7 +139,7 @@ module SimpleNavigation
 
         context 'when items_provider is not specified' do
           it "raises an exception" do
-            expect{ config.items }.to raise_error
+            expect{ config.items }.to raise_error(RuntimeError, 'please specify either items_provider or block, but not both')
           end
         end
       end

data/spec/simple_navigation/helpers_spec.rb

@@ -382,7 +382,7 @@ module SimpleNavigation
           it 'raises an exception' do
             expect{
               controller.render_navigation(level: :invalid)
-            }.to raise_error
+            }.to raise_error(ArgumentError, 'Invalid navigation level: invalid')
           end
         end
       end
@@ -408,7 +408,7 @@ module SimpleNavigation
         before { allow(SimpleNavigation).to receive_messages(primary_navigation: nil) }
 
         it 'raises an exception' do
-          expect{controller.render_navigation}.to raise_error
+          expect{controller.render_navigation}.to raise_error(RuntimeError, 'no primary navigation defined, either use a navigation config file or pass items directly to render_navigation')
         end
       end
 

data/spec/simple_navigation/item_container_spec.rb

@@ -435,7 +435,7 @@ module SimpleNavigation
             it 'raises an error' do
               expect{
                 item_container.item('key', 'name', 'url', { if: 'text' })
-              }.to raise_error
+              }.to raise_error(ArgumentError, ':if or :unless must be procs or lambdas')
             end
           end
         end

data/spec/simple_navigation/item_spec.rb

@@ -346,7 +346,7 @@ module SimpleNavigation
           let(:options) {{ highlights_on: :hello }}
 
           it 'raises an exception' do
-            expect{ item.selected? }.to raise_error
+            expect{ item.selected? }.to raise_error(ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath')
           end
         end
       end

data/spec/simple_navigation/items_provider_spec.rb

@@ -36,7 +36,7 @@ module SimpleNavigation
         let(:provider) { double(:provider) }
 
         it 'raises an exception' do
-          expect{ items_provider.items }.to raise_error
+          expect{ items_provider.items }.to raise_error(RuntimeError, /items_provider either must be a symbol .*, an object .* or an enumerable/)
         end
       end
     end

data/spec/simple_navigation/renderer/base_spec.rb

@@ -32,7 +32,7 @@ module SimpleNavigation
 
       describe '#render' do
         it "raise an exception to indicate it's a subclass responsibility" do
-          expect{ base.render(:container) }.to raise_error
+          expect{ base.render(:container) }.to raise_error(NotImplementedError, 'subclass responsibility')
         end
       end
 

data/spec/simple_navigation/renderer/json_spec.rb

@@ -20,12 +20,15 @@ module SimpleNavigation
           end
         end
 
-        # FIXME: not sure if :as_hash returning an array makes sense...
         context 'when the :as_hash option is true' do
           let(:options) {{ level: :all, as_hash: true }}
 
-          it 'returns a hash' do
+          it 'returns every item as a hash' do
             expect(output).to be_an Array
+
+            output.each do |item|
+              expect(item).to be_an Hash
+            end
           end
 
           it 'renders the selected page' do
@@ -34,6 +37,14 @@ module SimpleNavigation
           end
         end
 
+        context 'with options' do
+          it 'should render options for each item' do
+            parsed_output.each do |item|
+              expect(item).to have_key('options')
+            end
+          end
+        end
+
         context 'when a sub navigation item is selected' do
           let(:invoices_item) do
             parsed_output.find { |item| item['name'] == 'Invoices' }

data/spec/simple_navigation_spec.rb

@@ -104,7 +104,7 @@ describe SimpleNavigation do
 
     context "when the config file for the context doesn't exists" do
       it 'raises an exception' do
-        expect{ subject.load_config }.to raise_error
+        expect{ subject.load_config }.to raise_error(RuntimeError, /Config file 'navigation.rb' not found in path\(s\)/)
       end
     end
   end
@@ -152,7 +152,7 @@ describe SimpleNavigation do
       it 'raises an exception' do
         expect{
           subject.active_item_container_for('something else')
-        }.to raise_error
+        }.to raise_error(ArgumentError, 'Invalid navigation level: something else')
       end
     end
   end

data/spec/spec_helper.rb

@@ -24,7 +24,10 @@ end
 
 def setup_adapter_for(framework, context = double(:context))
   if framework == :rails
-    allow(context).to receive_messages(view_context: ActionView::Base.new)
+    # 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
 
   allow(SimpleNavigation).to receive_messages(framework: framework)

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: simple-navigation
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Andi Schacke
 - Mark J. Titorenko
 - Simon Courtois
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-17 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -177,6 +177,7 @@ files:
 - gemfiles/rails-4-2-stable.gemfile
 - gemfiles/rails-5-2-stable.gemfile
 - gemfiles/rails-6-0-stable.gemfile
+- gemfiles/rails-6-1-stable.gemfile
 - generators/navigation_config/USAGE
 - generators/navigation_config/navigation_config_generator.rb
 - generators/navigation_config/templates/config/navigation.rb
@@ -241,7 +242,7 @@ homepage: http://github.com/codeplant/simple-navigation
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--inline-source"
 - "--charset=UTF-8"
@@ -258,9 +259,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: simple-navigation is a ruby library for creating navigations (with multiple
   levels) for your Rails, Sinatra or Padrino application.