alacarte 0.0.1 → 0.0.2

data/CHANGES

@@ -0,0 +1,11 @@
+= Change Log
+
+== Version 0.0.2
+
+* Removed some Rails specific routines and replaced them with custom routines
+* Adding basic tests and documentation
+
+== Version 0.0.1
+
+Initial version
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Stijn Mathysen
+
+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/lib/alacarte/engine.rb

@@ -1,6 +1,7 @@
 module Alacarte
   class Engine < ::Rails::Engine
     
+    # Adding the Alacarte helper method to the Rails application
     config.to_prepare do
       ApplicationController.helper(AlacarteHelper)
     end

data/lib/alacarte/menu.rb

@@ -1,14 +1,45 @@
 module Alacarte
   
+  # Alacarte::Menu is the base class for defining menu items.
   class Menu
     
     VALID_ELEMENTS = [:link, :span]
+    @@env = nil
     
-    cattr_reader :env
     attr_reader :parent, :type, :name, :deep_name, :path, :as, :label, :options, :items, :block, :html_options, :group_options
     
+    # Tests if an environment was set to the Alacarte::Menu
+    def self.env?
+      !!@@env
+    end
+    
+    # Returns the environment that was set to the Alacarte::Menu
+    def self.env
+      @@env
+    end
+    
+    # Resets the env, used in rspec testing
+    def self.reset_env!
+      @@env = nil
+    end
+    
+    # Creates a menu item. Menu items can relate to a +parent+ menu item and a type should be passed. The type can be used for
+    # rendering (current types are +:menu+, +:link+ and +:span+).
+    #
+    # The first two attributes that can be passed (not required) are the +name+ and +path+ of the menu item. These can also
+    # be set in the options hash. Other settings are derived from +name+, but can also be passed in the options hash.
+    #
+    # The options you can pass are:
+    # * +:name+ sets the name of the menu item
+    # * +:path+ sets the path that the menu item should link to
+    # * +:label+ sets the label that should be displayed as the menu item
+    # * +:as+ defines how the element can be matched with the current element
+    # * +:if+ set a conditions when the menu item should be valid
+    # * +:unless+ set an inverse conditions when the menu item should be valid
+    # * +:html+ pass any html options that you want to be added to the menu item
+    # * +:group+ when the menu item has valid children, the +group+ options are passed as the html options of the grouping element
     def initialize(parent, type, *args, &block)
-      @options = args.extract_options!.dup
+      @options = args.last.is_a?(::Hash) ? args.pop : {}
       @parent = parent
       @type = type
       @name = options[:name] || args[0]
@@ -23,14 +54,12 @@ module Alacarte
       build
     end
     
+    # Tests if a block was passed to the Alacarte::Menu object
     def block?
       !!@block
     end
     
-    def self.env?
-      !!@@env
-    end
-    
+    # Builds the menu, based on the environment that is passed.
     def build(env = nil)
       @@env = env if env
       @items = []
@@ -38,6 +67,7 @@ module Alacarte
       self.instance_eval(&@block) if Menu.env? && self.block?
     end
     
+    # Tests to see if the current menu item is valid in the current setting
     def valid?
       if options[:if] && options[:if].respond_to?(:call)
         return options[:if].call
@@ -49,7 +79,8 @@ module Alacarte
       
       return true
     end
-    
+
+    # Try to send the menu to the passed +env+, then try to create a menu item of the missing method.
     def method_missing(id, *args, &block)
       if Menu.env? && Menu.env.respond_to?(id)
         @@env.send(id, *args, &block)

data/lib/alacarte/menus.rb

@@ -1,10 +1,13 @@
 module Alacarte
   
+  # Alacarte::Menus provides a dsl for building menus.
   class Menus < Hash
+    # Draw the menu
     def draw(&block)
       self.instance_exec(&block)
     end
 
+    # Define a menu in a draw block
     def menu(name, *args, &block)
       self[name] = Menu.new(nil, :menu, name, *args, &block)
     end

data/lib/alacarte/rails.rb

@@ -1,6 +1,7 @@
 module Rails
   class Application
     
+    # Provides an entry point for the Rails application to the Alacarte +menus+ attribute.
     def menus
       Alacarte.menus
     end

data/lib/alacarte/version.rb

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

data/lib/alacarte.rb

@@ -1,9 +1,13 @@
-require 'alacarte/engine'
-require 'alacarte/rails'
+require 'alacarte/engine' if defined?(Rails)
+require 'alacarte/rails' if defined?(Rails)
 require 'alacarte/menus'
 require 'alacarte/menu'
 
 module Alacarte
-  mattr_reader :menus
   @@menus = Alacarte::Menus.new
+
+  # menus provides an access point to the Alacarte module +menus+ attribute.
+  def self.menus
+    @@menus
+  end
 end

data/spec/alacarte/menu_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Alacarte::Menu do
+  
+  context "when creating a menu" do
+    
+    it "should be possible to create an item with its minimal settings" do
+      @menu = Alacarte::Menu.new(nil, :menu)
+      
+      @menu.name.should be_nil
+      @menu.path.should be_nil
+    end
+
+    it "should be possible to pass in a name" do
+      @menu = Alacarte::Menu.new(nil, :menu, 'name')
+      @menu.name.should eql 'name'
+      @menu.label.should eql 'name'
+      @menu.deep_name.should eql 'name'
+      @menu.as.should eql 'name'
+
+      @menu = Alacarte::Menu.new(nil, :menu, :name => 'other name')
+      @menu.name.should eql 'other name'
+      @menu.label.should eql 'other name'
+      @menu.deep_name.should eql 'other name'
+      @menu.as.should eql 'other name'
+    end
+    
+    it "should be possible to pass in a path" do      
+      @menu = Alacarte::Menu.new(nil, :link, 'login', '/accounts/login')
+      @menu.path.should eql '/accounts/login'
+      
+      @menu = Alacarte::Menu.new(nil, :link, 'logout', :path => '/accounts/logout')
+      @menu.path.should eql '/accounts/logout'
+    end
+    
+    it "should be possible to specify a label" do
+      @menu = Alacarte::Menu.new(nil, :span, :label => 'spacer')
+      @menu.label.should eql 'spacer'
+            
+      @menu = Alacarte::Menu.new(nil, :link, 'login', :label => 'Log in here!')
+      @menu.name.should eql 'login'
+      @menu.label.should eql 'Log in here!'
+    end
+    
+    it "should be possible to specify an 'as'" do
+      @menu = Alacarte::Menu.new(nil, :span, :as => 'spacestation')
+      @menu.as.should eql 'spacestation'
+            
+      @menu = Alacarte::Menu.new(nil, :link, 'login', :as => 'login_button')
+      @menu.name.should eql 'login'
+      @menu.as.should eql 'login_button'
+    end
+    
+  end
+    
+  it "should set the env property when the menu is built" do
+    @menu = Alacarte::Menu.new(nil, :menu, :as => 'account')
+    Alacarte::Menu.env?.should be_false
+    Alacarte::Menu.env.should be_nil
+    
+    @menu.build
+    Alacarte::Menu.env?.should be_false
+    Alacarte::Menu.env.should be_nil
+
+    @object = Object.new
+    @menu.build(@object)
+    Alacarte::Menu.env?.should be_true
+    Alacarte::Menu.env.should eql @object    
+  end
+  
+  it "should be possible to reset the env property" do
+    Alacarte::Menu.env?.should be_false
+    Alacarte::Menu.env.should be_nil
+
+    @menu = Alacarte::Menu.new(nil, :menu, :as => 'account')
+    @object = Object.new
+    @menu.build(@object)
+    Alacarte::Menu.env?.should be_true
+    Alacarte::Menu.env.should eql @object
+    
+    Alacarte::Menu.reset_env!
+    Alacarte::Menu.env?.should be_false
+    Alacarte::Menu.env.should be_nil
+  end
+  
+  it "should be able to test if a block was set on the menu" do
+    @menu = Alacarte::Menu.new(nil, :menu, :as => 'account') do
+      link :login, '/login'
+      link :logout, '/logout'
+    end
+    @menu.block?.should be_true
+    
+    @menu = Alacarte::Menu.new(nil, :menu, :as => 'account')
+    @menu.block?.should be_false
+  end
+  
+  it "should return the correct valid state for if statements" do
+    @menu = Alacarte::Menu.new(nil, :menu, :if => lambda{ 4 == 3 })
+    @menu.valid?.should be_false
+
+    @menu = Alacarte::Menu.new(nil, :menu, :if => lambda{ 4 == 4 })
+    @menu.valid?.should be_true
+  end
+  
+  it "should return the correct valid state for unless statements" do
+    @menu = Alacarte::Menu.new(nil, :menu, :unless => lambda{ 4 == 3 })
+    @menu.valid?.should be_true
+
+    @menu = Alacarte::Menu.new(nil, :menu, :unless => lambda{ 4 == 4 })
+    @menu.valid?.should be_false
+  end    
+    
+end

data/spec/alacarte/menus_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Alacarte::Menus do
+  
+  before do
+    @menus = Alacarte::Menus.new
+  end
+  
+  it "should be possible to draw menus using a block" do
+    @menus.size.should eql 0
+    
+    @menus.draw do
+      menu :one
+      menu :two
+    end
+    
+    @menus.size.should eql 2
+    @menus.keys.should include(:one)
+    @menus.keys.should include(:two)
+
+    @menus.values.each do |menu|
+      menu.should be_instance_of Alacarte::Menu
+    end
+  end
+  
+  it "should be possible to create a menu directly" do
+    @menus.size.should eql 0
+    @menus.menu :three
+    @menus.size.should eql 1
+    @menus.keys.first.should eql :three
+  end
+  
+  it "should construct menu items when the build command is issued" do
+    Alacarte::Menu.env?.should be_false
+    @menus.size.should eql 0
+    @menus.draw do
+      menu :account do
+        link :account, '/account' do
+          link :avatar, '/account/avatar'
+          link :edit, '/account/edit'
+        end
+        link :login, '/login'
+        link :logout, '/logout'
+      end
+    end
+    
+    @menus.size.should eql 1
+    @menus[:account].items.size.should eql 0
+    
+    @menus[:account].build(Object.new)
+    @menus[:account].items.size.should eql 3
+    @menus[:account].items.first.items.size.should eql 2
+  end
+  
+end

data/spec/alacarte_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Alacarte do
+  
+  before :all do
+  end
+  
+  it "should be possible to access the menus in the Alacarte namespace" do
+    Alacarte.menus.should be_instance_of Alacarte::Menus
+    Alacarte.menus.size.should eql 0
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'I18n'
+require File.dirname(__FILE__) + '/../lib/alacarte.rb'
+
+# Add I18n load_path
+# I18n.load_path = (I18n.load_path << Dir[File.join(File.dirname(__FILE__), 'locales', '*.yml')]).uniq
+
+RSpec.configure do |c|
+  
+  c.before :each do
+    Alacarte::Menu.reset_env!
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: alacarte
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Stijn Mathysen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 +01:00
+date: 2010-12-20 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,9 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGES
 - Gemfile
+- LICENSE
 - README.textile
 - Rakefile
 - alacarte.gemspec
@@ -41,6 +43,10 @@ files:
 - lib/alacarte/menus.rb
 - lib/alacarte/rails.rb
 - lib/alacarte/version.rb
+- spec/alacarte/menu_spec.rb
+- spec/alacarte/menus_spec.rb
+- spec/alacarte_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/stijnster/alacarte
 licenses: []
@@ -75,5 +81,8 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Provides a generic menu system for Rails
-test_files: []
-
+test_files: 
+- spec/alacarte/menu_spec.rb
+- spec/alacarte/menus_spec.rb
+- spec/alacarte_spec.rb
+- spec/spec_helper.rb