rails_menu 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,120 @@
+# Rails Menu
+
+This small app let you create menu in your app and seamlessly generate views for it later.
+
+## Installation
+
+In Gemfile
+
+``` ruby
+gem 'rails_menu'
+```
+
+And install bundle
+
+``` bash
+bundle install
+```
+
+## Setting up menu
+
+Anywhere in your app add code like that:
+
+``` ruby
+RailsMenu::Set.new('default', [
+  [:home, root_path],
+  [:settings, settings_path]
+])
+```
+
+This will create basic menu that will be accessible later. You can also split this to several independent lines:
+
+``` ruby
+menu = RailsMenu::Set.new
+menu.add(:home, root_path)
+menu.add(:settings, root_path)
+```
+
+and even specify custom options:
+
+``` ruby
+menu = RailsMenu::Set.new
+menu.add(:home, root_path, :label => "Homepage")
+menu.add(:settings, root_path, :label => "My Settings")
+```
+
+## Configuring which menu is currently active
+
+In your controller you can use method "set_meny" to inform RailsMenu that you can set one of menus to default. Menu id is first parameter that was provided on creating menu.
+
+``` ruby
+class Settings < ApplicationController
+  set_menu :settings
+end
+```
+
+You can also add any options that are acceptable by before_filter:
+
+``` ruby
+class Settings < ApplicationController
+  set_menu :settings, :except => :some_action
+end
+```
+
+If you think that it's easier to provide current menu directly in action then you are free to do so:
+
+``` ruby
+class Settings < ApplicationController
+  def index
+    set_menu :settings
+  end
+end
+```
+
+## Displaying menu
+
+In you view you can call helper "menu" to receive table of active menus. Each element will have following elements:
+
+- id - this is id set as first argument on creating menu. Usually needed only internal
+- url - url provided to menu
+- options - hash that was passed as last argument on creation
+- active - true or false depending on current set menu
+
+``` erb
+<p>My menu:</p>
+<ul>
+  <% menu.each do |menu_element| %>
+    <li id="menu-<%= menu_element.id %>" class="<%= menu.active ? 'active' : nil %>">
+      <%= link_to menu_element.options[:label], menu_element.url %>
+    </li>
+  <% end %>
+</ul>
+```
+
+## Creating multiple different menus
+
+Both RailsMenu::Set.new and menu helper can receive menu name as first parameter. At defualt it's set to "default", but if you want to create multiple menus then you should provide different names. Example:
+
+``` ruby
+menu = RailsMenu::Set.new('admin')
+menu.add(:home, root_path, :label => "Homepage")
+menu.add(:users, users_path, :label => "Users")
+```
+
+``` erb
+<% menu('admin').each do |menu_element| %>
+  ...
+<% end %>
+```
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011 Bernard Potocki
+
+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/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the semantic_menu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/rails_menu.rb

@@ -0,0 +1,15 @@
+require 'action_controller'
+require 'action_view'
+
+module RailsMenu
+  ROOT = File.expand_path(File.dirname(__FILE__))
+
+  autoload :Element,          "#{ROOT}/rails_menu/element"
+  autoload :Set,              "#{ROOT}/rails_menu/set"
+
+  autoload :ControllerHelper, "#{ROOT}/rails_menu/controller_helper"
+  autoload :ViewHelper,       "#{ROOT}/rails_menu/view_helper"
+end
+
+ActionController::Base.send(:include, RailsMenu::ControllerHelper)
+ActionView::Base.send(:include, RailsMenu::ViewHelper)

data/lib/rails_menu/controller_helper.rb

@@ -0,0 +1,21 @@
+module RailsMenu
+  module ControllerHelper
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def set_menu(id)
+      @rails_menu_active = id
+    end
+
+    module ClassMethods
+      def set_menu(id, options = {})
+        before_filter(options) do
+          set_menu id
+        end
+      end
+    end
+
+  end
+end

data/lib/rails_menu/element.rb

@@ -0,0 +1,14 @@
+module RailsMenu
+  class Element
+
+    attr_accessor :id, :url, :options, :active
+
+    def initialize(id, url = '', options = {})
+      @id = id.to_s
+      @url = url
+      @options = options
+      @active = false
+    end
+
+  end
+end

data/lib/rails_menu/set.rb

@@ -0,0 +1,35 @@
+module RailsMenu
+  class Set
+
+    class << self
+      def list
+        @list ||= {}
+      end
+
+      def [](list_name)
+        list[list_name]
+      end
+    end
+
+    attr_accessor :name
+
+    def initialize(name = 'default', element_list = [])
+      @name = name
+      @element_list = []
+      element_list.each{ |elem| self.add(*elem) }
+
+      self.class.list[name] = self
+    end
+
+    def add(id, url = '', options = {})
+      element = Element.new(id.to_s, url, options)
+      @element_list << element
+      element
+    end
+
+    def elements
+      @element_list
+    end
+
+  end
+end

data/lib/rails_menu/version.rb

@@ -0,0 +1,3 @@
+module RailsMenu
+  VERSION = "0.1.0"
+end

data/lib/rails_menu/view_helper.rb

@@ -0,0 +1,14 @@
+module RailsMenu
+  module ViewHelper
+
+    def menu(set_name = 'default')
+      set = RailsMenu::Set[set_name]
+      elements = set.nil? ? [] : set.elements
+      elements.each do |elem|
+        elem.active = (@rails_menu_active.to_s == elem.id ? true : false)
+      end
+      elements
+    end
+
+  end
+end

data/rails_menu.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_menu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_menu"
+  s.version     = RailsMenu::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernard Potocki"]
+  s.email       = ["bernard.potocki@imanel.org"]
+  s.homepage    = ""
+  s.summary     = %q{Simple menu generator for Ruby on Rails}
+  s.description = %q{Simple menu generator for Ruby on Rails}
+
+  s.add_dependency 'actionpack'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/controller_helper_test.rb

@@ -0,0 +1,48 @@
+require './test/test_helper'
+
+class ActiveSupport::TestCase
+  setup do
+    @routes = RailsMenu::Routes
+  end
+end
+
+class BooksController < ApplicationController
+  set_menu :books
+  def index; end
+end
+
+class SettingsController < ApplicationController
+  set_menu :settings, :only => :index
+
+  def index; end
+
+  def other; end
+
+  def notifications
+    set_menu :notification
+  end
+end
+
+class BooksControllerTest < ActionController::TestCase
+  test "assign global" do
+    get :index
+    assert_equal(:books, assigns(:rails_menu_active))
+  end
+end
+
+class SettingsControllerTest < ActionController::TestCase
+  test "assign specific action" do
+    get :index
+    assert_equal(:settings, assigns(:rails_menu_active))
+  end
+
+  test "ignore specific action" do
+    get :other
+    assert_equal(nil, assigns(:rails_menu_active))
+  end
+
+  test "override specific action" do
+    get :notifications
+    assert_equal(:notification, assigns(:rails_menu_active))
+  end
+end

data/test/element_test.rb

@@ -0,0 +1,13 @@
+require './test/test_helper'
+
+class ElementTest < Test::Unit::TestCase
+
+  def test_initialization
+    elem = RailsMenu::Element.new('my_id', 'my_url', :my => 'hash')
+    assert_equal 'my_id', elem.id
+    assert_equal 'my_url', elem.url
+    assert_equal({:my => 'hash'}, elem.options)
+    assert_equal false, elem.active
+  end
+
+end

data/test/set_test.rb

@@ -0,0 +1,39 @@
+require './test/test_helper'
+
+class SetTest < Test::Unit::TestCase
+
+  def teardown
+    RailsMenu::Set.list.keys.each { |key| RailsMenu::Set.list.delete(key) }
+  end
+
+  def test_empty_list
+    assert_equal RailsMenu::Set.list, {}
+  end
+
+  def test_adding_default
+    set = RailsMenu::Set.new
+    assert_equal RailsMenu::Set, set.class
+    assert_equal 'default', set.name
+    assert_equal [], set.elements
+    assert_equal set, RailsMenu::Set['default']
+  end
+
+  def test_adding_custom
+    set = RailsMenu::Set.new('my_name', [
+      ['first', '/first'],
+      ['second', '/second']
+    ])
+    assert_equal RailsMenu::Set, set.class
+    assert_equal 'my_name', set.name
+    assert_not_equal [], set.elements
+    assert_equal set, RailsMenu::Set['my_name']
+  end
+
+  def test_adding_element
+    set = RailsMenu::Set.new('default')
+    assert_equal [], set.elements
+    element = set.add('my', 'url')
+    assert_equal [element], set.elements
+  end
+
+end

data/test/support/controllers.rb

@@ -0,0 +1,6 @@
+class ApplicationController < ActionController::Base
+  protected
+  def default_render
+    render :text => action_name
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'rails_menu'
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each { |f| require f }
+
+RailsMenu::Routes = ActionDispatch::Routing::RouteSet.new
+RailsMenu::Routes.draw do
+  match ':controller(/:action(/:id(.:format)))'
+end
+
+class ApplicationController < ActionController::Base; end
+ActionController::Base.send :include, RailsMenu::Routes.url_helpers

data/test/view_helper_test.rb

@@ -0,0 +1,38 @@
+require "./test/test_helper"
+
+class ViewHelperTest < ActionView::TestCase
+  tests RailsMenu::ViewHelper
+
+  attr_accessor :controller, :request
+
+  def setup
+    @menu = RailsMenu::Set.new
+  end
+
+  def teardown
+    RailsMenu::Set.list.keys.each { |key| RailsMenu::Set.list.delete(key) }
+  end
+
+  test "default menu is empty" do
+    assert_equal [], menu("default")
+  end
+
+  test "unknown menu is empty" do
+    assert_equal [], menu("unknown")
+  end
+
+  test "access elements in menu" do
+    element = @menu.add("my", "url", :my => "options")
+    assert_equal [element], menu("default")
+  end
+
+  test "current element should be active" do
+    @rails_menu_active = "second"
+    first = @menu.add("first")
+    second = @menu.add("second")
+    assert_equal [first, second], menu("default")
+    assert_equal false, first.active
+    assert_equal true, second.active
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: rails_menu
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bernard Potocki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Simple menu generator for Ruby on Rails
+email: 
+- bernard.potocki@imanel.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rails_menu.rb
+- lib/rails_menu/controller_helper.rb
+- lib/rails_menu/element.rb
+- lib/rails_menu/set.rb
+- lib/rails_menu/version.rb
+- lib/rails_menu/view_helper.rb
+- rails_menu.gemspec
+- test/controller_helper_test.rb
+- test/element_test.rb
+- test/set_test.rb
+- test/support/controllers.rb
+- test/test_helper.rb
+- test/view_helper_test.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Simple menu generator for Ruby on Rails
+test_files: 
+- test/controller_helper_test.rb
+- test/element_test.rb
+- test/set_test.rb
+- test/support/controllers.rb
+- test/test_helper.rb
+- test/view_helper_test.rb