partial_menu 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 497fcb02fc093221933584484fc1bee9994a6117
-  data.tar.gz: 7ac39d10ef5207c92b7bc049619bcee9748abca9
+  metadata.gz: 51707929a107b5a59d3fc4ccce357f1a8833ec79
+  data.tar.gz: cc8327e327f9ab7fcc716003d320dd2f5133408b
 SHA512:
-  metadata.gz: 7462b4e8009ec5acbbc8e94f36ef1d4e6b2bcda277eca8d92fd548e7668086db0c8230a85a7339a8879aaa9d3bfbdad12893513a3f115ca49d750d20d7813e35
-  data.tar.gz: 419e533d62c76d7d4fd87ca9964883fd0c65f91fce0cd6e6eeb8fc87e00bfbfcca1af7d0949ae87ecb4ac3ae4e0119a2b8b571d604de600d065517e8785ee716
+  metadata.gz: e811b68b27e208262c1d56a3928b33cae54492b2fc0d6b66dbb878e8d82e5c075b467141b99cd12375da9dbd3eacbf470af04e5d0c4adc30ccef8f1d20c97824
+  data.tar.gz: 32c9fd3d571ac174e7f63c5e8dd3b1e3824dd0e08fcb97085eaed7c961b7dde4d1dbad6c75a40653d89fbf26cc025a826a16be11c813e200078ad2835f359c7e

data/lib/generators/views/templates/_item.html.erb

@@ -1,12 +1,12 @@
-<li <%= 'class="active"' if current_menu?(item.uri)%>>
-  <% if item.try(:icon).present? %>
-    <i class="fa fa-fw <%= item.icon %>"></i>
-  <% end %>
-  <% if item.uri.present? %>
+<li class="<%= 'active' if is_active_link?(url_for(item.uri), :inclusive) %>">
+  <% if item.try(:icon).present? -%>
+    <i class="<%= item.try(:icontype) || 'fa' %> <%= item.try(:icontype) || 'fa'%>-fw <%= item.icon %>"></i>
+  <% end -%>
+  <% if item.uri.present? -%>
     <%= link_to item.uri do -%>
       <%= item.title %>
     <% end -%>
-  <% else %>
+  <% else -%>
     <%= item.title %>
   <% end -%>
 </li>

data/lib/generators/views/templates/_menu.html.erb

@@ -1,9 +1,11 @@
 <ul>
-  <% menu.items.each do |item| %>
-    <% if item.has_submenu? %>
-      <%= render "#{menu.type}_menu/submenu", menu: item.submenu %>
-    <% else %>
-      <%= render "#{menu.type}_menu/item", item: item %>
-    <% end %>
-  <% end %>
+  <% menu.items.each do |item| -%>
+    <% if item.submenu? -%>
+      <%= render "#{menu.layout}_menu/submenu", menu: item.submenu -%>
+    <% elsif item.separator?%>
+      <%= render "#{menu.layout}_menu/separator", item: item -%>
+    <% else -%>
+      <%= render "#{menu.layout}_menu/item", item: item -%>
+    <% end -%>
+  <% end -%>
 </ul>

data/lib/generators/views/templates/_separator.html.erb

@@ -0,0 +1 @@
+<li><hr/></li>

data/lib/generators/views/templates/_submenu.html.erb

@@ -1,12 +1,20 @@
 <li class="nav-item" title="<%= menu.parent.title %>" data-original-title="<%= menu.parent.title %>">
   <a class="nav-link nav-link-collapse collapsed" data-toggle="collapse"
-    href="#collapse<%= menu.id %>"  data-parent="#<%= menu.type%>">
+    href="#collapse<%= menu.id %>"  data-parent="#<%= menu.layout %>">
     <% if menu.parent.try(:icon).present? %>
-      <i class="fa fa-fw <%= menu.parent.icon %>"></i>
+      <i class="<%= menu.parent.try(:icontype) || 'fa'%> <%= menu.parent.try(:icontype) || 'fa'%>-fw <%= menu.parent.icon %>"></i>
     <% end -%>
     <span class="nav-link-text"><%= menu.parent.title %></span>
   </a>
+  <ul id="#<%= menu.layout %>">
   <% menu.items.each do |item| %>
-    <%= render "#{menu.type}_menu/submenu_item", item: item %>
+    <% if item.submenu? -%>
+      <%= render "#{menu.layout}_menu/submenu", menu: item.submenu -%>
+    <% elsif item.separator?%>
+      <%= render "#{menu.layout}_menu/separator", item: item -%>
+    <% else -%>
+      <%= render "#{menu.layout}_menu/submenu_item", item: item -%>
+    <% end -%>
   <% end %>
-</li>
+  </ul>
+</li>

data/lib/generators/views/templates/_submenu_item.html.erb

@@ -1,12 +1,12 @@
-<li <%= 'class="active"' if current_menu?(item.uri)%>>
-  <% if item.try(:icon).present? %>
+<li class="<%= 'active' if is_active_link?(item.uri, :inclusive) %>">
+  <% if item.try(:icon).present? -%>
     <i class="fa fa-fw <%= item.icon %>"></i>
-  <% end %>
-  <% if item.uri.present? %>
+  <% end -%>
+  <% if item.uri.present? -%>
     <%= link_to item.uri do -%>
       <%= item.title %>
     <% end -%>
-  <% else %>
+  <% else -%>
     <%= item.title %>
   <% end -%>
 </li>

data/lib/generators/yaml/templates/menu.yml

@@ -6,6 +6,7 @@ menu:
     icon: test
   - second_item: separator
   - third_item:
+    icontype: glyph
     menu:
     - first_submenu: link
     - second_submenu:

data/lib/partial_menu/menu.rb

@@ -3,20 +3,30 @@ require 'partial_menu/menu_item'
 module PartialMenu
   # Represents a menu with menu items
   class Menu
-    attr_reader :type
+    attr_reader :layout
     attr_reader :items
     attr_reader :parent
     attr_reader :id
 
-    def initialize(props, type = 'main', parent = nil)
-      raise "Expected a array but got #{props.class}" unless props.is_a? Array
-      raise "Expected a string but got #{type.class}" unless type.is_a? String
-      @type = type
+    # rubocop:disable Metrics/MethodLength
+    def initialize(props, layout = 'main', parent = nil)
+      unless props.is_a? Array
+        raise ::ArgumentError, "Expected an Array, got #{props.class}"
+      end
+      unless layout.is_a? String
+        raise ::ArgumentError, "Expected a String, got #{layout.class}"
+      end
+      unless parent.nil? || (parent.is_a? PartialMenu::MenuItem)
+        raise ::ArgumentError, "Expected MenuItem or nil, got #{parent.class}"
+      end
+      @props = props
+      @layout = layout
       @items = []
       @parent = parent
       set_id
       add_items(props)
     end
+    # rubocop:enable Metrics/MethodLength
 
     private
 
@@ -30,7 +40,7 @@ module PartialMenu
       @id = if @parent.try(:class) == 'PartialMenu::MenuItem'
               @parent.id + '_submenu'
             else
-              @type + '_menu'
+              @layout + '_menu'
             end
     end
   end

data/lib/partial_menu/menu_item.rb

@@ -1,80 +1,144 @@
+require 'active_link_to'
+
 module PartialMenu
   # Represents menu item in a menu
   class MenuItem
+    include ActiveLinkTo
+
     attr_reader :type
     attr_reader :parent
     attr_reader :uri
     attr_reader :title
     attr_reader :submenu
     attr_reader :id
+    attr_reader :options
 
+    ##
+    # Contructor which check parameter types and start setup
+    #
+    # @param [Hash] props The menu list propertiess from the yaml file.
+    # @param [PartialMenu::Menu] parent The parent Menu of the item
+    #
+    # Throws ArgumentError if parameters are not expected type
+    #
     def initialize(props, parent)
-      raise 'Expected a hash as props' unless props.is_a?(Hash)
-      raise 'Expected a PartialMenu::Menu as parent' unless parent.is_a?(
-        PartialMenu::Menu
-      )
+      unless props.is_a? Hash
+        raise ::ArgumentError, "Expected Hash, got #{prop.class}"
+      end
+      unless parent.is_a? PartialMenu::Menu
+        raise ::ArgumentError, "Expected PartialMenu::Menu, got #{parent.class}"
+      end
       @parent = parent
       @props = props
       setup
     end
 
-    def setup
-      set_type
-      set_title
-      set_id
-      set_uri
-      set_submenu
-      set_other_attr
-    end
-
+    ##
+    # True if menu item has submenu
+    #
+    # @return [boolean]
+    #
     def submenu?
       @submenu != nil
     end
 
+    ##
+    # True if menu item is a separator
+    #
+    # @ return [boolean]
+    #
     def separator?
       @type == :separator
     end
 
-    def active?
-      false
-    end
-
     private
 
+    ##
+    # Manage parsing order of yaml properties
+    #
+    def setup
+      set_first_entry
+      set_type
+      set_id
+      set_title
+      set_uri
+      set_submenu
+      set_other_attr
+    end
+
+    ##
+    # Check if there is a +:menu+ property for the menu item and intantiate a
+    # new <tt>PartialMenu::Menu</tt> to parse it's content.
+    #
     def set_submenu
       @submenu = nil
-      return if @props.key?(:menu)
+      return unless @props.key?(:menu)
       @submenu = PartialMenu::Menu.new(
         @props[:menu],
-        @parent.type,
+        @parent.layout,
         self
       )
     end
 
+    ##
+    # Sets type property
+    # * +:separator+ - if menu item is has +separator+ entry only
+    # * +:link+ - any other occasion
+    #
     def set_type
-      @_first_entry = @props.shift
       @type = :item
       @type = @_first_entry[1].to_sym if @_first_entry[1] == 'separator'
     end
 
+    ##
+    # Gets and first entry in the yaml file for this particular menu item as it
+    # could hold esential information about the entry
+    #
+    def set_first_entry
+      @_first_entry = @props.shift
+    end
+
+    ##
+    # Set the title of the menu item based ont the +title+ property from the
+    # yaml file or if that not exists, use the yaml entry's name titlelized. If
+    # menu item is a separator, :title will be an empty string.
+    #
     def set_title
       @title = ''
-      return unless @type != :separator
+      return if @type == :separator
       @title = @props[:title] if @props.key?(:title)
-      @title = @_first_entry[0].to_s.titleize
+      @title = @id.titleize if @title.blank?
     end
 
+    ##
+    # Sets the menu item id to the entry's name in the yaml
+    #
     def set_id
       @id = @_first_entry[0].to_s
     end
 
+    ##
+    # Set the URL of the menu item if it is not a separator.
+    #
     def set_uri
       @uri = nil
       @uri = @props[:uri] if @type != :separator
     end
 
+    ##
+    # Parse additional attributes from yaml
+    #
+    # If a menu entry defines any addtional attributes above the list below,
+    # it will be parsed to an instance variable of the MenuItem.
+    #
+    # Built-in properties:
+    # * +:id+
+    # * +:uri+
+    # * +:title+
+    # * +:menu+
+    #
     def set_other_attr
-      @props.except(@id, :uri, :title, :menu).each do |name, value|
+      @props.except(:id, :uri, :title, :menu).each do |name, value|
         instance_variable_set('@' + name.to_s, value)
         define_singleton_method(name) { instance_variable_get("@#{name}") }
       end

data/lib/partial_menu/railtie.rb

@@ -4,8 +4,8 @@ module PartialMenu
   # Binding to Rails
   class Railtie < ::Rails::Railtie
     initializer 'partial_menu.view_helpers' do
-      ActiveSupport.on_load(:action_view) do
-        PartialMenu::ViewHelpers
+      ActiveSupport.on_load :action_view do
+        include PartialMenu::ViewHelpers
       end
     end
 

data/lib/partial_menu/version.rb

@@ -1,3 +1,3 @@
 module PartialMenu
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/partial_menu/view_helpers.rb

@@ -6,51 +6,70 @@ module PartialMenu
   # This module serves for availability in ActionView templates. It also adds a
   # new view helper: +partial_menu+.
   #
-  # == Using the helper without arguments
-  # If the helper is called without passing in the type, it will
-  # render the default menu using the default view partials.
-  #
-  # Example:
-  #
-  #   <%= partial_menu %>
-  #
-  # ... will result in <tt>menu.yaml</tt> getting displayed using partials
-  # from +app/views/partial_menu+:
-  #
-  #  <ul>
-  #    <li><a href="/">First item</a></li>
-  #    ...
-  #  </ul>
-  #
-  # Any options defined in the call will be send to +render+ as local variables
-  #
-  # Example:
-  #
-  #   <%= partial_menu 'menu', {menu_id:'sidemenu'} %>
-  #
-  # You can leave out menu type parameter:
-  #
-  # Example:
-  #
-  #   <%= partial_menu {menu_id:'sidemenu'} %>
-  #
   module ViewHelpers
-    def partial_menu(type = 'main', options = {}) #:nodoc:
+    # rubocop:disable Metrics/MethodLength
+    #  == Using the helper
+    # If the helper is called without passing in the type, it will
+    # render the default menu using the default view partials.
+    #
+    # Example:
+    #
+    #   <%= partial_menu %>
+    #
+    # ... will result in <tt>menu.yaml</tt> getting displayed using partials
+    # from +app/views/partial_menu+:
+    #
+    #  <ul>
+    #    <li><a href="/">First item</a></li>
+    #    ...
+    #  </ul>
+    #
+    # Any options defined in the call will be send to +render+ as
+    # local variables
+    #
+    # Example:
+    #
+    #   <%= partial_menu 'menu', {menu_id:'sidemenu'} %>
+    #
+    # You can leave out menu type parameter:
+    #
+    # Example:
+    #
+    #   <%= partial_menu {menu_id:'sidemenu'} %>
+    #
+    def partial_menu(type = 'main', options = {})
+      unless (type.is_a? String) || (type.is_a? Hash)
+        raise ::ArgumentError, "Expected a String or Hash, got #{type.class}"
+      end
+      unless options.is_a? Hash
+        raise ::ArgumentError, "Expected a Hash, got #{options.class}"
+      end
       if type.is_a? Hash
         options = type
         type = 'main'
       end
-      options[:menu] = PartialMenu::Menu.new(load_menu_from_yaml(type))
-      options.symbolize_keys!
+      options[:menu] = PartialMenu::Menu.new(load_menu_from_yaml(type), type)
+      options.deep_symbolize_keys!
       render partial: "#{type}_menu/menu", locals: options
     end
-
-    def current_menu?(path)
-      request.path == URI(path).path unless path.blank?
-    end
+    # rubocop:enable Metrics/MethodLength
 
     private
 
+    ##
+    # Load yaml file from config
+    #
+    # The +type+ parameter is used to create te actual file name. It is
+    # expected to:
+    # * be in the Rails apps config/ folder
+    # * have a name like +type>_menu.yml+
+    #
+    # All keys are symbolized after loading hte file.
+    #
+    # @param [String] type The menu type, which identifies the file too
+    #
+    # @return [Hash] The parsed YAML as hash of objects
+    #
     def load_menu_from_yaml(type)
       Psych.load_file(
         Rails.root.join("config/#{type}_menu.yml")

data/lib/partial_menu.rb

@@ -1,9 +1,6 @@
+require 'partial_menu/version'
+
 # PartailMenu implementation class
 module PartialMenu
-end
-
-if defined?(Rails::Railtie)
-  require 'partial_menu/railtie'
-elsif defined?(Rails::Initializer)
-  raise 'partial_menu is not compatible with Rails 2.3 or older'
+  require 'partial_menu/railtie' if defined?(Rails)
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: partial_menu
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Nagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_link_to
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +152,7 @@ files:
 - lib/generators/views/USAGE
 - lib/generators/views/templates/_item.html.erb
 - lib/generators/views/templates/_menu.html.erb
+- lib/generators/views/templates/_separator.html.erb
 - lib/generators/views/templates/_submenu.html.erb
 - lib/generators/views/templates/_submenu_item.html.erb
 - lib/generators/views/views_generator.rb