alacarte 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in alacarte.gemspec
+gemspec
+
+gem "rails", "~> 3.0.3"

data/README.textile

@@ -0,0 +1,104 @@
+h1. Alacarte
+
+Alacarte allows you to setup menu's and conditions in your Rails app in a router-like DSL way.
+
+You can easily;
+
+* group menu's by name
+* set conditions on menu items as a group
+* set conditions on menu items with @:if@ and @:unless@
+* nest your menu's
+
+h2. Installation
+
+Alacarte is being developed against Rails 3.0.3. No other versions have been tested.
+
+To install, add Alacarte to your @Gemfile@ and run `bundle install`:
+
+<pre>
+gem 'alacarte'
+</pre>
+
+After alacarte is installed, you will need to setup a rails initialiser to define your menu.
+
+h3. Initialiser
+
+Add an initialiser file to your rails application; e.g. @config/initialisers/alacarte.rb@ and add the menus in that file using the draw method.
+
+<pre>
+YourApplication::Application.menus.draw do
+    menu :main do
+        # menu information goes here...
+    end
+end
+</pre>
+
+h2. How it works
+
+h3. Helper environment
+
+Alacarte is linked to your helper environment, therefor you can call any helper method that is available to your rails app within your menu definition file;
+
+* format helpers
+* url_for, generated paths based on your routes file, ...
+* I18n
+* authentication related calls (e.g. current_user for Devise or Authlogic)
+
+h3. options
+
+You can pass in options to any level of your menu, including the top level. Here are some examples of options;
+
+* @type@ specify what type it is, currently @menu@, @link@ and @span@ are supported
+* @name@ allows you to specify the name of the menu item, a @deep_name@ is derived, based on the parents of that item.
+* @path@ allows you to set the path of that link
+* @label@ sets the label of the menu. By default Alacarte tries to translate the @deep_name@ (with an alacarte.menus namespace)
+* @html@ are options passed in as html options to the given element (e.g. class or id attributes)
+* @group@ are options passed in as html options, when the current element apears to be a group of other elements
+* @if@ allows you to pass in a proc to test if the menu item is valid
+* @unless@ allows you to pass in a proc to test if the menu item is valid, but tests for a false
+
+h3. Menu example
+
+<pre>
+YourApplication::Application.menus.draw do
+
+    menu :language do
+        link :nl, root_path(:locale => :nl), :html => { :class => 'nl' }
+        link :fr, root_path(:locale => :fr), :html => { :class => 'fr' }
+    end
+
+    menu :main, :group => { :class => 'main' } do
+       link :home, root_path
+       link :recent, 
+       link :other_site, 'http://someurl.com'
+       # ...
+       
+       link :my_account, account_path(:current), :if => { current_user }
+       
+    end
+    
+end
+</pre>
+
+h3. Render the menu
+
+Render the menu where you like in your view and pass an optional "current element" selector (in this case the current locale);
+
+<pre>
+...
+    <div id="language_selection">
+        <%= navigation_for(:language, I18n.locale) %>
+    </div>
+...
+</pre>
+
+h3. Output example
+
+The output is generated as a ul-li list with anchor elements. If there is an element that can be matched, it will get a class active;
+
+<pre>
+<ul>
+    <li><a href="/" class="nl active">nl</a></li>
+    <li><a href="/" class="nl">fr</a></li>
+</ul>
+</pre>

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/alacarte.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "alacarte/version"
+
+Gem::Specification.new do |s|
+  s.name        = "alacarte"
+  s.version     = Alacarte::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Stijn Mathysen"]
+  s.email       = ["stijn@skylight.be"]
+  s.homepage    = "http://github.com/stijnster/alacarte"
+  s.summary     = %q{Provides a generic menu system for Rails}
+  s.description = %q{This Rails plugin allows you to create a menu system, using a dsl (similar to routes).}
+
+  s.rubyforge_project = "alacarte"
+
+  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/app/helpers/alacarte_helper.rb

@@ -0,0 +1,37 @@
+module AlacarteHelper
+  
+  def navigation_for(menu, current_element = nil)
+    current_element = controller_name if current_element.blank?
+    
+    if current_menu = Alacarte.menus[menu]
+      current_menu.build(self)
+      
+      return elements_for(current_menu, current_element.to_sym)
+    end
+  end
+  
+  def elements_for(menu, current_element)
+    result = ''
+    
+    menu.items.each do |item|
+      if item.valid?
+        _html_options = item.html_options || {}
+        _html_options[:class] = _html_options[:class].to_s.insert(0, 'active ').strip if (current_element == item.as)
+      
+        _item = case item.type
+          when :link: link_to(item.label.html_safe, item.path, _html_options)
+          else content_tag(item.type, item.label, _html_options)
+        end
+        
+        if item.items.size > 0
+          _item << elements_for(item, current_element)
+        end
+      
+        result << content_tag(:li, _item)
+      end
+    end
+    
+    result.blank? ? '' : content_tag(:ul, result.html_safe, menu.group_options)
+  end
+
+end

data/lib/alacarte.rb

@@ -0,0 +1,9 @@
+require 'alacarte/engine'
+require 'alacarte/rails'
+require 'alacarte/menus'
+require 'alacarte/menu'
+
+module Alacarte
+  mattr_reader :menus
+  @@menus = Alacarte::Menus.new
+end

data/lib/alacarte/engine.rb

@@ -0,0 +1,9 @@
+module Alacarte
+  class Engine < ::Rails::Engine
+    
+    config.to_prepare do
+      ApplicationController.helper(AlacarteHelper)
+    end
+
+  end
+end

data/lib/alacarte/menu.rb

@@ -0,0 +1,64 @@
+module Alacarte
+  
+  class Menu
+    
+    VALID_ELEMENTS = [:link, :span]
+    
+    cattr_reader :env
+    attr_reader :parent, :type, :name, :deep_name, :path, :as, :label, :options, :items, :block, :html_options, :group_options
+    
+    def initialize(parent, type, *args, &block)
+      @options = args.extract_options!.dup
+      @parent = parent
+      @type = type
+      @name = options[:name] || args[0]
+      @path = options[:path] || args[1]
+      @deep_name = @parent ? "#{@parent.deep_name}.#{@name.to_s}" : @name.to_s
+      @label = options[:label] || I18n.t("alacarte.menus.#{@deep_name}", :default => @deep_name.to_s)
+      @as = options[:as] || @name
+      @block = block if block_given?
+      @html_options = options[:html]
+      @group_options = options[:group]
+
+      build
+    end
+    
+    def block?
+      !!@block
+    end
+    
+    def self.env?
+      !!@@env
+    end
+    
+    def build(env = nil)
+      @@env = env if env
+      @items = []
+
+      self.instance_eval(&@block) if Menu.env? && self.block?
+    end
+    
+    def valid?
+      if options[:if] && options[:if].respond_to?(:call)
+        return options[:if].call
+      end
+
+      if options[:unless] && options[:unless].respond_to?(:call)
+        return !options[:unless].call
+      end
+      
+      return true
+    end
+    
+    def method_missing(id, *args, &block)
+      if Menu.env? && Menu.env.respond_to?(id)
+        @@env.send(id, *args, &block)
+      elsif VALID_ELEMENTS.member?(id)
+        @items << Menu.new(self, id, *args, &block)
+      else
+        super
+      end
+    end
+  end
+  
+end

data/lib/alacarte/menus.rb

@@ -0,0 +1,14 @@
+module Alacarte
+  
+  class Menus < Hash
+    def draw(&block)
+      self.instance_exec(&block)
+    end
+
+    def menu(name, *args, &block)
+      self[name] = Menu.new(nil, :menu, name, *args, &block)
+    end
+
+  end
+  
+end

data/lib/alacarte/rails.rb

@@ -0,0 +1,9 @@
+module Rails
+  class Application
+    
+    def menus
+      Alacarte.menus
+    end
+    
+  end
+end

data/lib/alacarte/version.rb

@@ -0,0 +1,3 @@
+module Alacarte
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: alacarte
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stijn Mathysen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-17 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: This Rails plugin allows you to create a menu system, using a dsl (similar to routes).
+email: 
+- stijn@skylight.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.textile
+- Rakefile
+- alacarte.gemspec
+- app/helpers/alacarte_helper.rb
+- lib/alacarte.rb
+- lib/alacarte/engine.rb
+- lib/alacarte/menu.rb
+- lib/alacarte/menus.rb
+- lib/alacarte/rails.rb
+- lib/alacarte/version.rb
+has_rdoc: true
+homepage: http://github.com/stijnster/alacarte
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: alacarte
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides a generic menu system for Rails
+test_files: []
+