Menuizer

build menu items for admin page ( like AdminLTE )

Installation

Add this line to your application’s Gemfile:

ruby gem 'menuizer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install menuizer

Usage

ruby # config/initializers/menuizer.rb 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
  @menuizer.data[:request] = request
end
helper_method def menuizer
  @menuizer
end end ```

```erb <%# app/views/admins/index.html.erb %> <% menuizer.activate :Admin # item’s value %> <% content_for :title do %><%= menuizer.active_item.try(:title) %><% end %>

…

<% menuizer.active_items.each do |item| %>
1. <%= link_to item.path || "#" do %> <%= item.title %><% end %>
<% end %>

```

```erb <%# app/views/layouts/application.html.erb %> …

<% menuizer.items.each do |item| %> <%= render "menu", item: item %> <% end %>

… ```

```erb <% item # menuizer.items’s item %> <% case item.type %> <% when :header %>

<%= item.title %>

<% when :item %>

<%= link_to item.path || "#" do %> <%= item.title %> <% if item.notices.present? %> <% item.notices.each do |notice| %> <% type, text = notice.call %> <%= text %> <% end %> <% end %> <% end %>

<% else %>

<%= item.title %>

<% item.children.each do |item| %> <%= render "layouts/manage/menu", item: item %> <% end %>

<% end %> ```

get item

ruby menuizer.item(:Widget) #=> menu item

Generators

Generate menu items by ruby code:

ruby # config/initializers/menuizer.rb Menuizer.configure do |config| ... config.generator = { generate_items: ->(menu){ [ {item: "generate item1"}, {item: "generate item2"}, ] }, } end

yaml # config/menuizer.yml - header: MAIN NAVIGATION - items: :generate_items # => # - item: generate item1 # - item: generate item2

Converters

Convert menu item’s property:

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 menuizer.items.each do |item| item.icon #=> "fa fa-circle-o" <= converter[:icon].call(icon,opts) end

icon, opts is yaml’s original value
opts: all key-value hash

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

convert path

• leave path if not nil
• convert :"#{namespace}#{model.model_name.plural}" if title respond to model_name.plural
• or, leave nil

what is namespace?

↓↓↓

Multiple namespaces

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 |config| config.file_path = Rails.root.join("config/menuizer/namespace.yml") end

yaml # config/menuizer/namespace.yml - header: NAMESPACE MENU - item: :Admin

```ruby # app/controllers/application_controller.rb class ApplicationController < ActionController::Base before_action :set_menuizer

private

def set_menuizer
  @menuizer = Menuizer.menu(:namespace)
end
helper_method def menuizer
  @menuizer
end end ```

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/getto-systems/menuizer.