emenu 0.4.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+#
+
+gem "haml", '~> 3.1.1'
+gem "activesupport", '~> 3.0.3'
+gem "actionpack", '~> 3.0.3'
+
+group :development do
+  gem "rspec-rails", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    haml (3.1.2)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rdoc (3.8)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    thor (0.14.6)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.0.3)
+  activesupport (~> 3.0.3)
+  bundler (~> 1.0.0)
+  haml (~> 3.1.1)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec-rails (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kresimir Bojcic
+
+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.rdoc

@@ -0,0 +1,103 @@
+= Enterprise Menu
+
+It extracts logic needed for building effective and maintainable menus for complex enterprise scenarios.
+
+Use it if you:
+* have myriad of options to cover
+* have complex business (il)logic that depends on user role
+
+Live example can be tried at http://emenu.12ip.net/cars. Open it in a new tab or otherwise prepare to click 'Back' quite a few times.
+
+It renders menu based on configuration and persists state with minimal session info and some tiny jQuery posts. Main goal is to hide as much as possible of the HTML/jQuery ugliness from your tender eyes. Evenly important, at least for me, is to make you balls-of-brass-kind-of-guy when customer is asking for yet another exception/addition in menu layout.
+
+  menu.item :transportation do
+    item :cars, cars_path
+    item :trains do
+      item :fast_trains , fast_trains_path
+      item :slow_trains, slow_trains_path
+    end
+    item :planes do
+      item :boeing do
+        item :boeing747 do
+          item :older_ready_to_crash, older_ready_to_crash_path
+          item :brand_new, brand_new_path
+        end
+        item :boeing474, boeing474_path
+      end
+      item :airbus, airbus_path
+    end
+  end
+  #second menu group named Orders
+  menu.item :orders do
+    item :bread, bread_path
+    item :butter, butter_path
+    item :chunky_bacon, chunky_bacon_path
+  end
+end
+
+= Supported
+* Unlimited menu levels 
+* Separate sets of menu for different roles
+* Exclusion of menu items based on authorisation
+
+WARNING: This is release early as it gets so many things are missing. I am planing on releasing often to make this gem worthwhile your time.
+
+= Usage
+Put in your Gemfile:
+
+  gem 'emenu' , :git => 'git@github.com:drKreso/emenu.git'
+
+Then type in your console:
+
+  bundle && rails g emenu:install 
+
+If you are using Haml, put this in layout:
+
+  = stylesheet_link_tag 'reset.css', 'emenu.css'
+  = javascript_include_tag 'jquery-1.4.2.min.js', 'emenu.js'
+  ...
+  #content
+   #left
+     =menu_will_render
+
+Otherwise put this in you layout:
+
+  <%= stylesheet_link_tag 'reset.css', 'emenu.css'%>
+  <%= javascript_include_tag 'jquery-1.4.2.min.js', 'emenu.js' %>
+  ...
+  <div id="content">
+    <div id="left">
+      <%= menu_will_render %>
+    </div>
+  </div>
+
+Add app/navigation to your autoload paths:
+
+  config.autoload_paths += %W(#{config.root}/app/navigation)
+
+<b>Set up menu configuration in app/navigation/navigation.rb and you are ready to go.</b>
+
+== Gotchas
+Theme used is small part of http://themeforest.net/item/smooth-admin/101529. It's just for demonstration and if you plan to use it in your projects you'll have to pay for it. Since you can already steel it from original theme page I don't think I am doing anything wrong including it as a demo. On the other hand the author has not given me permission to do so(yet). All in all it might get a bit uglier if I have to make my own theme...
+
+Be aware that I've monkey patched String class with 'indent' method for my testing purposes. 
+
+== TODO
+* Add quick links support that change according to main menu selection
+* Put authorisation hook that will enable complex authorisation rules for all menu items in one method
+
+== Contributing to emenu
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kresimir Bojcic. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "emenu"
+  gem.homepage = "http://github.com/drKreso/emenu"
+  gem.license = "MIT"
+  gem.summary = %Q{Enterprise class menus}
+  gem.description = %Q{Enterprise class menus with simple ruby based configuration, easy to make, easy to maintain}
+  gem.email = "kresimir.bojcic@gmail.com"
+  gem.authors = ["Kresimir Bojcic"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "emenu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/emenu.gemspec

@@ -0,0 +1,90 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{emenu}
+  s.version = "0.4.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Kresimir Bojcic}]
+  s.date = %q{2011-07-13}
+  s.description = %q{Enterprise class menus with simple ruby based configuration, easy to make, easy to maintain}
+  s.email = %q{kresimir.bojcic@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "emenu.gemspec",
+    "lib/emenu.rb",
+    "lib/emenu/menu.rb",
+    "lib/emenu/menu_config.rb",
+    "lib/emenu/string.rb",
+    "lib/generators/emenu/USAGE",
+    "lib/generators/emenu/install_generator.rb",
+    "lib/generators/emenu/templates/default_menu/navigation.rb",
+    "lib/generators/emenu/templates/images/menu.png",
+    "lib/generators/emenu/templates/images/menu_arrow.png",
+    "lib/generators/emenu/templates/images/menu_border.png",
+    "lib/generators/emenu/templates/images/menu_l.png",
+    "lib/generators/emenu/templates/images/menu_l_selected.png",
+    "lib/generators/emenu/templates/images/menu_minus.png",
+    "lib/generators/emenu/templates/images/menu_plus.png",
+    "lib/generators/emenu/templates/images/menu_r.png",
+    "lib/generators/emenu/templates/images/menu_r_selected.png",
+    "lib/generators/emenu/templates/images/menu_selected.png",
+    "lib/generators/emenu/templates/javascripts/emenu.js",
+    "lib/generators/emenu/templates/javascripts/jquery-1.4.2.min.js",
+    "lib/generators/emenu/templates/stylesheets/emenu.css",
+    "lib/generators/emenu/templates/stylesheets/reset.css",
+    "spec/menu_config_spec.rb",
+    "spec/menu_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/drKreso/emenu}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Enterprise class menus}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<haml>, ["~> 3.1.1"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.0.3"])
+      s.add_development_dependency(%q<rspec-rails>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<haml>, ["~> 3.1.1"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_dependency(%q<actionpack>, ["~> 3.0.3"])
+      s.add_dependency(%q<rspec-rails>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<haml>, ["~> 3.1.1"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+    s.add_dependency(%q<actionpack>, ["~> 3.0.3"])
+    s.add_dependency(%q<rspec-rails>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/emenu.rb

@@ -0,0 +1,38 @@
+require 'action_view'
+
+require 'emenu/string.rb'
+require 'emenu/menu.rb'
+require 'emenu/menu_config.rb'
+
+module Emenu
+  
+
+  def emenu_state
+    session[:menu_state] ||= {}
+    session[:menu_state][params[:id]] = params[:state] unless params[:id].nil?
+    render :json => { :data => :ok } 
+  end
+
+  def emenu 
+    session[:menu_state] ||= {}
+    @menu = menu
+    selected_key = @menu.find_path(request.env['PATH_INFO'])
+    unless selected_key.nil?
+      @menu.selected = selected_key 
+      @menu.find(selected_key).parents.each { |menu| session[:menu_state][menu.title.to_s] = "opened" }
+    end
+    session[:menu_state].each { |key, value| @menu.open(key.to_sym) if value == "opened"} unless session[:menu_state].nil?
+  end
+
+  def self.included(base)
+    base.before_filter :emenu
+    base.send :helper_method, :menu_will_render
+    base.module_eval { include Navigation } unless $install == true
+  end
+
+  def menu_will_render
+    @menu.render
+  end
+
+end
+

data/lib/emenu/menu.rb

@@ -0,0 +1,93 @@
+class Menu
+
+  IDENTATION = 2
+  SPACE = " "
+  DEFAULT_SPACE = SPACE*IDENTATION
+
+  attr_reader :title, :items, :type, :path
+
+  def initialize(title, parent, config, path="#")
+    @title = title
+    @parent = parent
+    @config = config
+    @path = path
+    @items = []
+    @type = @parent.nil? ? :title : :menu 
+  end
+
+  def item(name, path="#",  &block)
+    current = self.add(name,path)
+    current.instance_eval(&block) unless block.nil?
+  end
+
+  def add(item_name, path="#", &block)
+    items << Menu.new(item_name, self, @config, path)
+    @type = :collapsible_menu if @type == :menu # when we add subitems to menu it becomes collapsible menu
+    instance_eval(&block) unless block.nil?
+    MenuConfig.enforce_uniqueness names
+    return items.last
+  end
+
+  def names
+    items.inject([@title.to_s]) { |result, item| result << item.names }
+  end
+
+  def to_haml
+    items.inject(eval "#{type}_haml") { |result, item| result <<  item.to_haml }
+  end
+
+  def title_haml
+    "#{spacing}%h6#h-menu-#{@title}#{opened? ? '{ :class => "selected" }' : ""}\n" <<
+    "#{spacing_subitem}%a{ :href => '##{@title}'}\n" <<
+    "#{spacing_subitem*2}%span #{humanized_title}\n" <<
+    "%ul#menu-#{@title}.#{opened? ? "opened" : "closed"}\n" 
+  end
+
+  def menu_haml
+    "#{spacing}%li#{selected? ? '{ :class => "selected" }' : ""}= link_to '#{humanized_title}', '#{@path}'\n"
+  end
+
+  def collapsible_menu_haml
+    "#{spacing}%li.collapsible\n" <<
+    "#{spacing_subitem}%a{ :href => '#', :class => 'collapsible #{opened? ? "minus" : "plus"}'} #{humanized_title}\n" <<
+    "#{spacing_subitem}%ul##{@title}.#{opened? ? "expanded" : "collapsed"}\n"
+  end
+
+  def humanized_title
+    @title.to_s.humanize
+  end
+
+  def selected?
+    @config.selected == @title
+  end
+
+  def opened?
+    @config.opened? @title
+  end
+
+  def indent
+    result = @parent.nil? ? 0 : @parent.indent + IDENTATION * (@parent.type == :collapsible_menu ? 2 : 1)
+  end
+
+  def spacing
+    SPACE*indent
+  end
+  
+  def spacing_subitem
+    spacing + DEFAULT_SPACE
+  end
+
+  def all_items
+    items.inject([self]) { |result, menu| result << menu.all_items }
+  end
+
+  def parents
+    result = []
+    unless @parent.nil?
+      result << @parent
+      result << @parent.parents unless @parent.parents == []
+    end
+    return result.flatten
+  end
+
+end