menuizer 0.1.9 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGFkZjNiZjMxOGE4NTEzMDZkYjA4ZjNhMmU4MmZkZWJiNDM5Y2QyOA==
+    NDRiOGYzNzI1NjcyZTg1NmE2YjJiZjcwN2MwZWYwOGE5YWI0OWNhZA==
   data.tar.gz: !binary |-
-    NDA4MjA2MTg3MTY2ZDZlZjhkYTlkN2Y5NDFjN2UxNjE0ZWRhM2YxMw==
+    MWRhY2RmODdlZDIwNmYyYzgyYTg2ODE3MTdiZWIyN2RhZTNlNGEyMA==
 SHA512:
   metadata.gz: !binary |-
-    NTU1ZjRkODFhMWMxYTE4ODljZmQ5YTAwZjZmYjA4ZDk3ODAzMTEzZTFlOWRm
-    ZmM2NmY5YTgxMzk1NDllNDZhYjg3MzAzYTQwODc5ZTBjYTVkMThkZGU3NmUz
-    Nzc5NDlkOTMyOGRjMDQ4YTYxMmJmYzE0MjAyNDIzNWMyNTJhMjc=
+    YzIyOGZhNjdiZjI4YWIwZGQ1NzZhNzBmN2YxNDQ4MjFhYWIwNGYyNDJlZjE2
+    ZGU0MGYyYjA4ODY1MDE1MWEzMWM5Zjk1ZjQ5NGMzYmUyOGUzMjMzYTI1YTMx
+    MGE0OTAyZWEwM2I0NGRhZTMyNzg2NmUwYTY5OTc4ZTg3ZDkzMWY=
   data.tar.gz: !binary |-
-    NTU1M2MzNzIxNTNiN2MwOTE4MzZmYjIyYzRmOGE4NWZlMzYwMDhmYTc4OTQ4
-    ZGY1MTE4MjMyYjhjMmE1ZmFjYzg5NDdjM2EzYzRkZmY2OGViMThjZDQ5NzUw
-    M2QwNzE5NDAxN2U4MTRlMzEwMDI5YjFkMzk2NjdmZTYzODc3MDg=
+    OThlNTIyZDQ1YWJiNzFiYzNmMmMzZTZmODQ2MzYxOGVjMzk2MmUyOTEyYmU3
+    NTI2OTA2MWRhYjczMjBjMTIzMjMzYjBkZmM0NzU2ZWQ5ZTU4ZTIwMWIwZmJk
+    NDg1MWM0NmYyYzYyNmQzZjE5OTFkYjgxNjZiNGY3NTY1NDVkYzc=

data/README.md

@@ -25,38 +25,68 @@ Or install it yourself as:
 
 ```ruby
 # config/initializers/menuizer.rb
-Menuizer.configure do |menu|
-  menu.header "MAIN NAVIGATION"
-  menu.item "Dashboard", icon: "fa fa-dashboard" do
-    menu.item "Dashboard v1", icon: "fa fa-circle-o"
-    menu.item "Dashboard v2", icon: "fa fa-circle-o"
-  end
-
-  menu.item Widget, icon: "fa fa-th"
-
-  menu.item "Settings", icon: "fa fa-cog" do
-    menu.item Admin, icon: "fa fa-circle-o"
-    menu.item User, icon: "fa fa-circle-o", notices: [
-      ->{ [:warning, User.unauthorized.count] },
-      ->{ [:danger, User.wait.count] },
-    ]
-
-    menu.item "nested" do
-      menu.item "nested item", path: :path_to_somewhere, icon: "fa fa-circle-o"
+Menuizer.configure do |config|
+  config.file_path = Rails.root.join("config/menuizer.yml")
+end
+```
+
+```yaml
+# config/menuizer.yml
+- header: MAIN NAVIGATION
+- item: Dashboard
+  icon: fa fa-dashboard
+  children: 
+    - item: Dashboard v1
+      icon: fa fa-circle-o
+    - item: Dashboard v2
+      icon: fa fa-circle-o
+
+- item: :Widget
+  icon: fa fa-th
+
+- item: Settings
+  icon: fa fa-cog
+  children:
+    - item: :Admin
+      icon: fa fa-circle-o
+    - item: :User
+      icon: fa fa-circle-o
+      notice:
+        class: :User
+        method: :main_menu_notices
+
+  - item: nested
+    children:
+      - item: nested item
+        path: :path_to_somewhere
+        icon: fa fa-circle-o
+```
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  before_action :set_menuizer
+
+  private
+
+    def set_menuizer
+      @menuizer = Menuizer.menu
+    end
+    helper_method def menuizer
+      @menuizer
     end
-  end
 end
 ```
 
 ```erb
 <%# app/views/admins/index.html.erb %>
-<% @active_menu = Admin # first argument of menu.item %>
-<% content_for :title do %><%= Menuizer.menu.active_item.title %><% end %>
+<% menuizer.activate :Admin # item's value %>
+<% content_for :title do %><%= menuizer.active_item.try(:title) %><% end %>
 
 ...
 
 <ol class="breadcrumb">
-  <% Menuizer.menu.active_items.each do |item| %>
+  <% menuizer.active_items.each do |item| %>
     <li><%= link_to item.path || "#" do %><i class="<%= item.icon %>"></i> <%= item.title %><% end %></li>
   <% end %>
 </ol>
@@ -64,21 +94,18 @@ end
 
 ```erb
 <%# app/views/layouts/application.html.erb %>
-<% Menuizer.menu.activate @active_menu %>
-<title><%= yield :title %></title>
-
 ...
-
 <ul class="sidebar-menu">
-  <% Menuizer.menu.items.each do |item| %>
+  <% menuizer.items.each do |item| %>
     <%= render "menu", item: item %>
   <% end %>
 </ul>
+...
 ```
 
 ```erb
 <%
-  item # Menuizer.menu.items's item
+  item # menuizer.items's item
 %>
 <% case item.type %>
 <% when :header %>
@@ -112,32 +139,49 @@ end
 <% end %>
 ```
 
-## API
+## Converters
 
-### menu.item
+```ruby
+# config/initializers/menuizer.rb
+Menuizer.configure do |config|
+  config.converter = {
+    icon: ->(icon,opts){
+      case
+      when icon.blank? || icon.starts_with?("fa") then icon
+      when icon then "fa fa-#{icon}"
+      else
+        "fa fa-circle-o"
+      end
+    },
+  }
+end
+```
 
 ```ruby
-menu.item(
-  title,     # required : convert to item.title
-  path: nil, # optional : convert to item.path
-
-  # other keys pass-through to item.*
-  icon: "fa fa-icon",
-  notices: [
-    ->{ [:info, count] },
-  ],
-)
+menuizer.items.each do |item|
+  item.icon #=> call converter
+end
 ```
 
-#### `title` converting
+icon, opts is yaml's original value  
+opts: all key-value hash
+
 
-* convert `title.model_name.human` if title respond to `model_name`
+### convert `model`
+
+* set `:model` key if title is `Symbol` and respond to `model_name` ( ActiveRecord )
+
+
+### convert `title`
+
+* convert `model.model_name.human` if model respond to `model_name.huuman`
 * or, leave `title`
 
 
-#### `path` converting
+### convert `path`
 
-* convert `:"#{namespace}#{title.model_name.plural}"` if title respond to `model_name`
+* leave `path` if not `nil`
+* convert `:"#{namespace}#{model.model_name.plural}"` if title respond to `model_name.plural`
 * or, leave `nil`
 
 **what namespace is?**
@@ -146,61 +190,37 @@ menu.item(
 
 ## Multiple namespaces
 
-if your rails application has multiple namespaces, and required multiple menues, pass `:namespace` to Menuizer methods.
+If your rails application has multiple namespaces, and required multiple menues, pass `:namespace` to Menuizer methods.
 
 ```ruby
 # config/initializers/menuizer.rb
-Menuizer.configure(:namespace) do |menu|
-  ...
+Menuizer.configure(:namespace) do |config|
+  config.file_path = Rails.root.join("config/menuizer/namespace.yml")
 end
 ```
 
-```erb
-<%# app/views/admins/index.html.erb %>
-<% @active_menu = Admin # first argument of menu.item %>
-<% content_for :title do %><%= Menuizer.menu(:namespace).active_item.title %><% end %>
-
-...
-
-<ol class="breadcrumb">
-  <% Menuizer.menu(:namespace).active_items.each do |item| %>
-    <li><%= link_to item.path || "#" do %><i class="<%= item.icon %>"></i> <%= item.title %><% end %></li>
-  <% end %>
-</ol>
+```yaml
+# config/menuizer/namespace.yml
+- header: NAMESPACE MENU
+- item: :Admin
 ```
 
-```erb
-<%# app/views/layouts/application.html.erb %>
-<% Menuizer.menu(:namespace).activate @active_menu %>
-<title><%= yield :title %></title>
-
-...
-
-<ul class="sidebar-menu">
-  <% Menuizer.menu(:namespace).items.each do |item| %>
-    <%= render "menu", item: item %>
-  <% end %>
-</ul>
-```
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  before_action :set_menuizer
 
-## set converter methods
+  private
 
-```ruby
-# config/initializers/menuizer.rb
-Menuizer.configure(:namespace) do |menu|
-  menu.set_converter :icon do |icon,opts|
-    case
-    when icon.blank? || icon.starts_with?("fa") then icon
-    when icon then "fa fa-#{icon.to_s.gsub("_","-")}"
-    else
-      "fa fa-circle-o"
+    def set_menuizer
+      @menuizer = Menuizer.menu(:namespace)
+    end
+    helper_method def menuizer
+      @menuizer
     end
-  end
 end
 ```
 
-second argument `opts` : original key-value hash
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/menuizer/menu/item.rb

@@ -5,20 +5,18 @@ class Menuizer::Menu::Item < OpenStruct
   end
 
   def title
-    title = @opts[:title]
-    if title.respond_to?(:model_name) && title.model_name.respond_to?(:human)
-      title.model_name.human
+    if model && model.model_name.respond_to?(:human)
+      model.model_name.human
     else
-      title
+      @opts[:title]
     end
   end
   def path
     if path = @opts[:path]
       path
     else
-      title = @opts[:title]
-      if title.respond_to?(:model_name) && title.model_name.respond_to?(:plural)
-        :"#{namespace}#{title.model_name.plural}"
+      if model && model.model_name.respond_to?(:plural)
+        :"#{namespace}#{model.model_name.plural}"
       end
     end
   end

data/lib/menuizer/menu.rb

@@ -2,7 +2,12 @@ class Menuizer::Menu
   def initialize(namespace)
     if namespace
       @namespace = "#{namespace}_"
-      @item_class = self.class.const_set(:"Item_#{namespace}", Class.new(Item))
+      item_class = :"Item_#{namespace}"
+      if self.class.const_defined?(item_class)
+        @item_class = self.class.const_get(item_class)
+      else
+        @item_class = self.class.const_set(item_class, Class.new(Item))
+      end
     else
       @namespace = nil
       @item_class = Item
@@ -41,41 +46,17 @@ class Menuizer::Menu
     end
   end
 
-
-  def header(title)
-    current << @item_class.new(
-      type: :header,
-      namespace: @namespace,
-      title: title,
-    )
-  end
-  def item(title, path: nil, **opts)
-    unless block_given?
-      item = @item_class.new(
-        type: :item,
-        parent: @parent,
-        namespace: @namespace,
-        title: title,
-        path: path,
-        **opts,
-      )
-      map[title] = item
-      current << item
-    else
-      owner = @parent
-      parents = @current
-      item = @parent = @item_class.new(
-        type: :tree,
-        children: [],
-        parent: owner,
-        namespace: @namespace,
-        title: title,
-        **opts,
-      )
-      @current = item.children
-      yield
-      children, @current, @parent = @current, parents, owner
-      current << item
+  def load(data)
+    return unless data.respond_to?(:each)
+    data.each do |item|
+      if item.respond_to?(:map) && item.respond_to?(:delete)
+        item = item.map{|k,v| [k.to_sym,v]}.to_h
+        if title = item.delete(:header)
+          add_header title
+        else
+          add_item item.delete(:item), item
+        end
+      end
     end
   end
 
@@ -85,6 +66,57 @@ class Menuizer::Menu
 
   private
 
+    def add_header(title)
+      current << @item_class.new(
+        type: :header,
+        namespace: @namespace,
+        title: title,
+      )
+    end
+    def add_item(title, opts)
+      model = to_model title
+
+      unless children = opts.delete(:children)
+        item = @item_class.new(
+          type: :item,
+          parent: @parent,
+          namespace: @namespace,
+          title: title,
+          model: model,
+          **opts,
+        )
+        map[title] = item
+        current << item
+      else
+        owner = @parent
+        parents = @current
+        item = @parent = @item_class.new(
+          type: :tree,
+          children: [],
+          parent: owner,
+          namespace: @namespace,
+          title: title,
+          model: model,
+          **opts,
+        )
+        @current = item.children
+        self.load children
+        @current, @parent = parents, owner
+        current << item
+      end
+    end
+    def to_model(title)
+      return unless title.is_a?(Symbol)
+      parent = Object
+      title.to_s.split("::").each do |tip|
+        return unless parent.const_defined?(tip)
+        parent = parent.const_get(tip)
+      end
+      if parent.respond_to?(:model_name)
+        parent
+      end
+    end
+
     def current
       @current ||= items
     end

data/lib/menuizer.rb

@@ -5,16 +5,27 @@ require "menuizer/menu/item"
 module Menuizer
   class << self
     def configure(namespace=nil)
-      yield (map[namespace] = Menu.new(namespace))
+      yield (config[namespace] ||= OpenStruct.new)
     end
     def menu(namespace=nil)
-      map[namespace]
+      Menu.new(namespace).tap{|menu|
+        c = config[namespace]
+        if c.respond_to?(:converter)
+          c.converter.each do |key,block|
+            menu.set_converter key, &block
+          end
+        end
+        if c.respond_to?(:file_path) && path = c.file_path
+          require "yaml"
+          menu.load YAML.load_file(path)
+        end
+      }
     end
 
     private
 
-      def map
-        @map ||= {}
+      def config
+        @config ||= {}
       end
   end
 end

data/version-dump.sh

@@ -10,7 +10,7 @@ fi
 version_file=version.txt
 current_version=$(cat $version_file)
 
-git pull --tags
+git fetch --tags
 current_tag=$(git tag | tail -1)
 
 if [ "v$current_version" != "$current_tag" ]; then

data/version.txt

@@ -1 +1 @@
-0.1.9
+0.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: menuizer
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - shun