menuizer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f46abe20a3b5c13dd4883bbe2e7983c1616dd65
+  data.tar.gz: eb0d8786f57091e8b204d9a9c8ce11ffc6c80a33
+SHA512:
+  metadata.gz: cfa99ec1f9b76b6fa55d8599e0bdb2f8f257ad2778f63a368d6733a3c520cc09b2c8252067690ad0c9faeef8f94047e494a1a1e59ffe95b5a741bc89a9028d88
+  data.tar.gz: ba389b0d967729dc41de32879cb1d6c5ff5470b0f87211dc241f88263ac85f6d21e26ccdf98258d5f23b77a2ae05cddd758069ba7189243496bb4152b2713a09

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/release/

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.13.1
+deploy:
+  api_key:
+    secure: X9io3ltI9EXOql2o8IMlIBshluU4B2vabN3Lnim8r7lTi8av+K9wHnyOi7rOqHrzc3iqoytVoQUML1WwQHhWzXy02sBGS82211zWYtrNOGwNbYC43xg6kM9xpL/hF+Jfiz+dN0j3jhbizAw11dWfNwcEdnInc8XoUggotLMysfWZFb7lFdwP8Py5zI1ikXwJDog8LhENtYckjcAet8EJ2kPkbsgDSMChP4sLn1JUtffXra1yU2Z3lxjYPLIkXELM4k/pCWXSWaqaJOsbJi664/ROQRRlDuhH2yEbooSl2daU0XnHrCzfAzuxp9SFfdKkDX7NlF1CF9OoOjuQBBjv8VBVlTbDqKVg+ewFwx/sp9Ka4cq9sb1QO2P4XRGysy7286GbFZWWP+1L4iWr3E1dFl+7wX3vI2tUOg74VuNAExiKWYZuxSUjKGg7xhpfj3FZnUxHvk9r3V/UcWL9sukxtXKkRnuVAfrfSQiYQamei4rqAixp6QEvAjN1ppAV87fRizoTKakmIBN0cP3M/odfPa61T9EsKkzsXMk7w1VO48C/MsRs2P14vT8XECpcXBJqOFY4THr74eWu3qE6sSZpFxDxdKpogyoG8anNlAM3Dah8mZ+5WUT6F1fRGDzvAmcCbDzeHZepAQv3rmIeOB1PJG2YYoZgcIblEngIra0Yvew=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in menuizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 げっとシステム
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,190 @@
+# Menuizer
+
+[![Build Status](https://travis-ci.org/getto-systems/menuizer.svg?branch=master)](https://travis-ci.org/getto-systems/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 |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_path, icon: "fa fa-circle-o"
+    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 %>
+
+...
+
+<ol class="breadcrumb">
+  <% Menuizer.menu.active_items.each do |item| %>
+    <li><%= link_to item.path || "#" do %><i class="<%= item.icon %>"></i> <%= item.title %><% end %></li>
+  <% end %>
+</ol>
+```
+
+```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| %>
+    <%= render "menu", item: item %>
+  <% end %>
+</ul>
+```
+
+```erb
+<%
+  item # Menuizer.menu.items's item
+%>
+<% case item.type %>
+<% when :header %>
+  <li class="header"><%= item.title %></li>
+<% when :item %>
+  <li class="<% if item.is_active %>active<% end %>">
+  <%= link_to item.path || "#" do %>
+    <i class="<%= item.icon %>"></i> <span><%= item.title %></span>
+    <% if item.notices.present? %>
+      <% item.notices.each do |notice| %>
+        <% type, text = notice.call %>
+        <span class="label label-<%= type %> pull-right"><%= text %></span>
+      <% end %>
+    <% end %>
+  <% end %>
+  </li>
+<% else %>
+  <li class="<% if item.is_active %>active <% end %>treeview">
+    <a href="#">
+      <i class="<%= item.icon %>"></i> <span><%= item.title %></span>
+      <span class="pull-right-container">
+        <i class="fa fa-angle-left pull-right"></i>
+      </span>
+    </a>
+    <ul class="treeview-menu">
+      <% item.children.each do |item| %>
+        <%= render "layouts/manage/menu", item: item %>
+      <% end %>
+    </ul>
+  </li>
+<% end %>
+```
+
+## API
+
+### menu.item
+
+```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] },
+  ],
+)
+```
+
+#### `title` converting
+
+* convert `title.model_name.human` if title respond to `model_name`
+* or, leave `title`
+
+
+#### `path` converting
+
+* convert `:"#{title.model_name.plural}_path"` if title respond to `model_name`
+* or, leave `nil`
+
+## 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 |menu|
+  ...
+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>
+```
+
+```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>
+```
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/getto-systems/menuizer.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "menuizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/menuizer/menu.rb

@@ -0,0 +1,94 @@
+class Menuizer::Menu
+  def initialize(namespace)
+    @namespace = namespace ? "#{namespace}_" : nil
+  end
+
+  def activate(key)
+    active_items.each do |item|
+      item.is_active = false
+    end
+
+    @active_item = item = map[key]
+    while item
+      item.is_active = true
+      item = item.parent
+    end
+  end
+  def active_item
+    @active_item
+  end
+  def active_items
+    result = []
+    item = @active_item
+    while item
+      result << item
+      item = item.parent
+    end
+    result
+  end
+
+
+  def header(title)
+    current << OpenStruct.new(
+      type: :header,
+      title: title,
+    )
+  end
+  def item(title, path: nil, **opts)
+    unless block_given?
+      item = OpenStruct.new(
+        type: :item,
+        title: to_title(title),
+        path: to_path(path: path, title: title),
+        parent: @parent,
+        **opts,
+      )
+      map[title] = item
+      current << item
+    else
+      owner = @parent
+      parents = @current
+      item = @parent = OpenStruct.new(
+        type: :tree,
+        title: to_title(title),
+        children: [],
+        parent: owner,
+        **opts,
+      )
+      @current = item.children
+      yield
+      children, @current, @parent = @current, parents, owner
+      current << item
+    end
+  end
+
+  def items
+    @items ||= []
+  end
+
+  private
+
+    def current
+      @current ||= items
+    end
+    def map
+      @map ||= {}
+    end
+
+    def to_title(title)
+      if title.respond_to?(:model_name)
+        title.model_name.human
+      else
+        title
+      end
+    end
+    def to_path(path:, title:)
+      if path
+        path
+      else
+        if title.respond_to?(:model_name)
+          :"#{@namespace}#{title.model_name.plural}_path"
+        end
+      end
+    end
+end

data/lib/menuizer/version.rb

@@ -0,0 +1,3 @@
+module Menuizer
+  VERSION = "0.1.1"
+end

data/lib/menuizer.rb

@@ -0,0 +1,19 @@
+require "menuizer/version"
+require "menuizer/menu"
+
+module Menuizer
+  class << self
+    def configure(namespace=nil)
+      yield (map[namespace] = Menu.new(namespace))
+    end
+    def menu(namespace=nil)
+      map[namespace]
+    end
+
+    private
+
+      def map
+        @map ||= {}
+      end
+  end
+end

data/menuizer.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'menuizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "menuizer"
+  spec.version       = Menuizer::VERSION
+  spec.authors       = ["shun"]
+  spec.email         = ["shun@getto.systems"]
+
+  spec.summary       = %q{build menu items for admin page}
+  spec.description   = %q{build menu items for admin page ( like AdminLTE )}
+  spec.homepage      = "https://github.com/getto-systems/menuizer"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "travis"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: menuizer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- shun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  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'
+description: build menu items for admin page ( like AdminLTE )
+email:
+- shun@getto.systems
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/menuizer.rb
+- lib/menuizer/menu.rb
+- lib/menuizer/version.rb
+- menuizer.gemspec
+homepage: https://github.com/getto-systems/menuizer
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: build menu items for admin page
+test_files: []