navtastic 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1310ede0cecc3da85ea235b10c6bd7b6413d823
-  data.tar.gz: 7507adc0d81b1e381463fabc7f0a912b24e8b586
+  metadata.gz: 0e38b165248d09e76592965914d31a637907efd3
+  data.tar.gz: c96c4568a2a0880b2b17cb0599a8bceaa9fa13d5
 SHA512:
-  metadata.gz: fab8bbf0725908f60ecdd76c50709ea4cff88ccbf43ba30f4cd1d6085b03b4e3baeae5bd18ebec37ba19f8dec5e77a5e4a77c78395ec0a44621c0c049ce1749b
-  data.tar.gz: d315fb9dc68df9e0d827b231421684d9b211611b249a69163fa65b95055c797062286a6935144af2246c33e011ff1d9aef3d75e67c6961c48063c312149eb297
+  metadata.gz: bad84049a62139b26dd37950e9cc4120056a52c52fc959068eca024fa7655e07f12c516d204e82bb685843604b2c927be13ffa6b53e95df0a7dd0cc23bee78f7
+  data.tar.gz: 7733f9d31ec353558f23b6e9db2a24995e86cb5f3529df0bf155b9009537f04c2dce431fd7eaefa9f4c741922a2e5efd7051501722cbb4f70aa9555b748fb8ed

data/.rubocop.yml

@@ -8,6 +8,7 @@ AllCops:
     - 'spec/demo/**/*'
     - 'spec/support/**/*'
     - 'vendor/**/*'
+    - '*.gemspec'
   TargetRubyVersion: 2.4
 
 Metrics/AbcSize:
@@ -26,6 +27,6 @@ Style/FrozenStringLiteralComment:
 Style/StringLiterals:
   Enabled: false
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
   

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased]
 
+## [0.2.0] - 2018-03-06
+
+### Added
+
+- Hot reload option of renderer class
+- Support for Rails (configuration and view helpers)
+
 ## [0.1.0] - 2017-09-05
 
 ### Added
@@ -21,4 +28,5 @@
 - Runtime parameters
 
 [Unreleased]: https://github.com/aramvisser/navtastic/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.1.0
+[0.1.0]: https://github.com/aramvisser/navtastic/compare/v0.0.1...v0.1.0
+[0.2.0]: https://github.com/aramvisser/navtastic/compare/v0.1.0...v0.2.0

data/README.md

@@ -80,6 +80,12 @@ Using the default renderer, assuming that the current url starts with `/posts`,
 </ul>
 ```
 
+### Rails
+
+When using rails, a `render_menu` helper is added that automatically sets the current_url.
+
+Also, put defined menus in `app/menus` to take advantage of hot reload.
+
 ## Documentation
 
 ### Submenus
@@ -172,6 +178,9 @@ Navtastic.configure do |config|
 
   # Options that are passed to the renderer
   config.renderer_options = {}
+
+  # Reload the renderer class every time menu is rendered (helpful during development)
+  config.reload_renderer = false
 end
 ```
 

data/lib/navtastic.rb

@@ -59,13 +59,13 @@ module Navtastic
     raise KeyError, "menu not defined: #{name.inspect}" if block.nil?
 
     # Merge renderer options globally with those passed at runtime
-    renderer_options = configuration.renderer_options
+    renderer_options = configuration.renderer_options.dup
     renderer_options.merge!(params.delete(:renderer) || {})
 
     menu = Menu.new
     block.call(menu, params)
     menu.current_url = current_url
-    Navtastic.configuration.renderer.render(menu, renderer_options)
+    Navtastic.configuration.current_renderer.render(menu, renderer_options)
   end
 
   # A list of all defined menus
@@ -75,3 +75,5 @@ module Navtastic
     @menu_store.keys
   end
 end
+
+require 'navtastic/railtie.rb' if defined?(Rails)

data/lib/navtastic/configuration.rb

@@ -22,9 +22,20 @@ module Navtastic # :nodoc:
     # @return [Hash]
     attr_accessor :renderer_options
 
+    # Should the renderer class be reloaded everytime the menu is rendered?
+    #
+    # This is helpful during development, to avoid restarting the server after
+    # every change, but should be disabled during production.
+    #
+    # Defaults to `false`
+    #
+    # @return bool
+    attr_accessor :reload_renderer
+
     def initialize
       @renderer = Navtastic::Renderer::Simple
       @renderer_options = {}
+      @reload_renderer = false
       @base_url = nil
     end
 
@@ -45,6 +56,20 @@ module Navtastic # :nodoc:
       end
     end
 
+    # @return [Navtastic::Renderer] renderer to use
+    #
+    # Will hot reload the renderer class if needed
+    def current_renderer
+      klass = renderer
+
+      if reload_renderer
+        klass = klass.to_s unless klass.is_a?(String)
+        Object.const_get(klass)
+      else
+        klass
+      end
+    end
+
     private
 
     # Built in renderers

data/lib/navtastic/railtie.rb

@@ -0,0 +1,20 @@
+module Navtastic
+  # Helper methods for ActionView
+  module ViewHelpers
+    def render_menu(menu, options = {})
+      Navtastic.render menu, request.fullpath, options
+    end
+  end
+
+  # Setup hot reload and add helper to ApplicationHelper
+  class Railtie < ::Rails::Railtie
+    initializer "navtastic_railtie.initialize_configuration" do |app|
+      Navtastic.configuration.reload_renderer = !app.config.eager_load
+      ActiveSupport.on_load(:action_view) { include Navtastic::ViewHelpers }
+    end
+
+    config.to_prepare do
+      Dir["app/menus/*.rb"].each { |file| load file }
+    end
+  end
+end

data/lib/navtastic/version.rb

@@ -1,3 +1,3 @@
 module Navtastic
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/navtastic_spec.rb

@@ -85,5 +85,15 @@ RSpec.describe Navtastic do
         expect(render.options[:foo]).to eq :foo
       end
     end
+
+    context "when render gets called twice in a row" do
+      before do
+        described_class.render(menu_name, '/', renderer: { foo: :bar })
+      end
+
+      it "won't use the renderer params from the first call" do
+        expect(render.options[:foo]).to be_nil
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: navtastic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aram Visser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arbre
@@ -117,6 +117,7 @@ files:
 - lib/navtastic/configuration.rb
 - lib/navtastic/item.rb
 - lib/navtastic/menu.rb
+- lib/navtastic/railtie.rb
 - lib/navtastic/renderer.rb
 - lib/navtastic/renderer/bootstrap4.rb
 - lib/navtastic/renderer/bulma.rb