merb-menus 0.0.7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 YOUR NAME
+
+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

@@ -0,0 +1,4 @@
+menu_generator
+==============
+
+A plugin for the Merb framework that provides ...

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+require File.dirname(__FILE__) + '/lib/merb-menus/version'
+
+GEM_NAME = "merb-menus"
+GEM_VERSION = Merb::Menus::VERSION
+AUTHOR = "jonah honeyman"
+EMAIL = "jonah@honeyman.org"
+HOMEPAGE = "http://github.com/jonuts/merb-menus"
+SUMMARY = "Merb plugin that provides dot dot dot uh menus" 
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  #s.add_dependency('merb', '>= 1.0.11')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/menu_generator.rb
+Add your Merb rake tasks to lib/menu_generator/merbtasks.rb

data/lib/merb-menus/item.rb

@@ -0,0 +1,32 @@
+module Merb::Menus
+  class Item
+    def initialize(opts)
+      @submenu = opts[:submenu]
+      @name = opts[:name]
+      @anchor = opts[:anchor] || build_anchor
+      @href = opts[:href] || build_url
+    end
+
+    attr_reader :name, :anchor, :href, :submenu
+
+    def inspect
+      "<Merb::Menus::Item> - name~>#{name}"
+    end
+
+    def to_s
+      anchor.to_s
+    end
+
+    private
+
+    def build_url
+      submenu.url_generator.rule.call(@submenu.name,@name)
+    end
+
+    def build_anchor
+      submenu.display_style.rule.call(@name)
+    end
+
+  end
+end
+

data/lib/merb-menus/menu.rb

@@ -0,0 +1,118 @@
+module Merb::Menus
+
+  # This is the top level menu
+  #
+  # ==== Usage
+  # Generate a menu in a controller:
+  #
+  #     create_menu :main_menu do
+  #       # add some display styles
+  #       display_style(:splitncap) {|thing| thing.to_s.split("_").map{|e| e.capitalize}.join(" ")}
+  #       display_style(:dollarify) {|thing| "$#{thing.to_s.gsub(/_/,',')}"}
+  #       default_display_style :splitncap
+  #
+  #       # define all of the submenus with their individual items
+  #       submenu :videos do
+  #         item :home, :url => '/videos'
+  #         
+  #         #this item will be generated with href '/videos/humor' and text 'Humor'
+  #         item :humor
+  #       end
+  #
+  #       submenu :audio do
+  #         display_style :dollarify
+  #         
+  #         item :home, :href => '/audio'
+  #         item :humor, :anchor => "LOL!!!"
+  #       end
+  #     end
+  #         
+  #
+  class Menu
+    extend Enumerable
+
+    class << self
+      attr_reader :collection
+
+      def each
+        @collection.each{|i| yield i}
+      end
+
+      def [](name)
+        find{|e| e.name == name}
+      end
+
+      def first
+        @collection.first
+      end
+
+      def reset
+        each{ |e| e.submenus.each{ |menu| menu.current_item = nil} ; e.current_submenu = nil}
+      end
+    end
+
+    @collection ||= []
+
+    def initialize(name, is_default=false)
+      @name       = name
+      @is_default = is_default
+      @submenus   = []
+      create_default_rules
+      use_display_style :default
+      use_url_generator :default
+      add_self_to_collection
+    end
+
+    attr_accessor :current_submenu, :default_display_style, :default_url_generator
+    attr_reader :name, :submenus
+
+    def submenu(name, opts={}, &blk)
+      submenu = Submenu.new(name, self, opts)
+      submenu.instance_eval(&blk) if block_given?
+      @submenus << submenu
+      self
+    end
+
+    def display_style(key, &rule)
+      DisplayStyle.add_rule(key, self, &rule)
+    end
+
+    def url_generator(key, &rule)
+      UrlGenerator.add_rule(key, self, &rule)
+    end
+
+    def use_display_style(rule)
+      self.default_display_style = DisplayStyle[rule]
+    end
+
+    def use_url_generator(rule)
+      self.default_url_generator = UrlGenerator[rule]
+    end
+   
+    def default?
+      @is_default
+    end
+
+    def inspect
+      "Merb::Menus::Menu - name~>#{self.name} - submenus~>[#{submenus.map{|e| e.name}.join(", ")}]"
+    end
+
+    def to_s
+      name.to_s
+    end
+
+    private
+
+    def add_self_to_collection
+      Menu.collection << self unless Menu[name]
+      self
+    end
+
+    def create_default_rules
+      display_style(:default){|thing| thing.to_s}
+      url_generator(:default){|menu, item| "/#{menu}/#{item}"}
+    end
+
+  end
+end
+

data/lib/merb-menus/merb_controller.rb

@@ -0,0 +1,100 @@
+class Merb::Controller
+  before do
+    Merb::Menus.reset
+
+    controller = params['controller']
+    action = params['action']
+
+    if top = Merb::Menus.current_menu = Merb::Menus.default
+      if menu = top.current_submenu = get_submenu(top,controller)
+        menu.current_item = get_item(menu,action)
+      end
+    end
+
+    callback = self.class.instance_variable_get(:@callback)
+    callback.call if callback
+  end
+
+  def self.create_menu(name, &blk)
+    Merb::Menus::Menu.new(name).instance_eval(&blk)
+  end
+
+  def self.set_current
+  end
+
+  # FIXME: if only one arg is given, we probably want to set submenu only? maybe? grr
+  def self.use_menu(*args)
+    @callback = lambda{
+      menu, submenu = *args
+      top = Merb::Menus[menu]
+      Merb::Menus.current_menu = top
+      raise Merb::Menus::NoMenuError.new("Menu '#{menu}' does not exist") unless top
+
+      if submenu
+        top.current_submenu = get_submenu(top, submenu)
+        raise Merb::Menus::NoMenuError.new("Menu '#{submenu}' does not exist") unless top.current_submenu
+      end
+    }
+    @callback.call
+  end
+
+  # ==== Parameters
+  # top<Merb::Menus::Menu>::
+  # sub<Symbol>:: name of desired submenu
+  def self.get_submenu(top, sub)
+    top.submenus.find {|m| m.name.to_s == sub.to_s}
+  end
+
+  # ==== Parameters
+  # menu<Merb::Menus::Submenu>::
+  # item<Symbol>:: name of desired item
+  def self.get_item(menu, item)
+    menu.items.find{|e| e.name.to_s == item.to_s}
+  end
+
+  def get_submenu(top, sub)
+    self.class.get_submenu(top, sub)
+  end
+
+  def get_item(menu, item)
+    self.class.get_item(menu, item)
+  end
+
+  def menu_item(*args)
+    case args.size
+    when 3
+      menu, submenu, item = *args
+      self.class.use_menu(menu, submenu)
+      top = Merb::Menus[menu]
+      menu = get_submenu(top,submenu)
+      menu.current_item = get_item(menu,item)
+    when 2
+      submenu, item = *args
+      top = Merb::Menus.default
+      self.class.use_menu(top.name,submenu)
+      menu = get_submenu(top,submenu)
+      menu.current_item = get_item(menu,item)
+    when 1
+      item = *args
+      top = Merb::Menus.default
+      menu = top.current_submenu
+      menu.current_item = get_item(menu,item)
+    else
+      raise ArgumentError.new("Wrong number of arguments given (#{args.size} for 1)")
+    end
+  end
+
+  def current_menu
+    Merb::Menus.current_menu
+  end
+
+  def current_submenu
+    Merb::Menus.current_submenu
+  end
+
+  def current_item
+    Merb::Menus.current_item
+  end
+
+end
+

data/lib/merb-menus/merbtasks.rb

@@ -0,0 +1,6 @@
+namespace :menu_generator do
+  desc "Do something for menu_generator"
+  task :default do
+    puts "menu_generator doesn't do anything"
+  end
+end

data/lib/merb-menus/rule.rb

@@ -0,0 +1,39 @@
+module Merb::Menus
+  class Rule
+    extend Enumerable
+
+    class << self
+      attr_reader :collection
+
+      def add_rule(key, owner, &rule)
+        return nil unless block_given? and unique?(key, owner)
+        @collection << new(key, &rule)
+      end
+
+      def each
+        @collection.each{|i| yield i}
+      end
+
+      def [](key)
+        find{|rule| rule.key == key}
+      end
+
+      private
+
+      def unique?(key, owner)
+        !find{|rule| rule.key == key && rule.owner == owner}
+      end
+    end
+
+    def initialize(key, &rule)
+      @key = key
+      @rule = rule
+    end
+
+    attr_reader :key, :rule, :owner
+  end
+
+  class UrlGenerator < Rule; @collection ||= []; end
+  class DisplayStyle  < Rule; @collection ||= []; end
+end
+

data/lib/merb-menus/submenu.rb

@@ -0,0 +1,45 @@
+module Merb::Menus
+  class Submenu
+    def initialize(name, menu, opts={})
+      @name          = name
+      @menu          = menu
+      @display_style = @menu.default_display_style
+      @url_generator = @menu.default_url_generator
+      @details       = Item.new(opts.merge({:name => name, :submenu => self}))
+      @items         = []
+    end
+
+    attr_accessor :current_item
+    attr_reader :name, :items, :menu, :display_style, :url_generator
+
+    def anchor
+      @details.anchor
+    end
+
+    def href
+      @details.href
+    end
+
+    def item(name, opts={})
+      @items << Item.new(opts.merge({:name => name, :submenu => self}))
+      self
+    end
+
+    def use_display_style(name)
+      @display_style = DisplayStyle[name]
+    end
+
+    def use_url_generator(name)
+      @url_generator = UrlGenerator[name]
+    end
+
+    def inspect
+      "Merb::Menus::Submenu - name~>#{name} - items~>[#{items.map{|e| e.name}.join(", ")}]"
+    end
+
+    def to_s
+      anchor
+    end
+  end
+end
+

data/lib/merb-menus/version.rb

@@ -0,0 +1,10 @@
+module Merb
+  module Menus
+    BIG = "0"
+    SMALL = "0"
+    TINY = "7"
+
+    VERSION = [BIG, SMALL, TINY].join(".")
+  end
+end
+

data/lib/merb-menus.rb

@@ -0,0 +1,51 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_menus] = {
+    :chickens => false
+  }
+
+  Merb::BootLoader.before_app_loads do
+    $:.push File.dirname(__FILE__)
+
+    require 'merb-menus/merb_controller'
+    require 'merb-menus/rule'
+    require 'merb-menus/menu'
+    require 'merb-menus/submenu'
+    require 'merb-menus/item'
+
+  end
+
+  Merb::BootLoader.after_app_loads do
+  end
+
+  Merb::Plugins.add_rakefiles "merb-menus/merbtasks"
+
+  module Merb::Menus
+    class << self; attr_accessor :current_menu; end
+
+    class NoMenuError < StandardError;end
+
+    def self.[](menu)
+      Menu[menu]
+    end
+
+    def self.default
+      Menu.find{|menu| menu.default?} || Menu.first
+    end
+
+    def self.reset
+      Menu.reset
+    end
+
+    def self.current_submenu
+      current_menu.current_submenu rescue nil
+    end
+
+    def self.current_item
+      current_submenu.current_item rescue nil
+    end
+  end
+
+end
+

data/spec/merb-menus/item_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Merb::Menus::Item do
+  before do
+    @menu = Merb::Menus::Menu.new(:foo)
+    @menu.display_style(:split) {|thing| thing.to_s.split("_").join(" ")}
+
+    @submenu = Merb::Menus::Submenu.new(:cakes, @menu)
+    @submenu.use_display_style(:split)
+
+    @cheesecake = Merb::Menus::Item.new(:name => :cheese_cake, :submenu => @submenu)
+    @spongecake = Merb::Menus::Item.new(:name => :sponge, :submenu => @submenu, :anchor => "sPOnge cAkE")
+    @poundcake = Merb::Menus::Item.new(:name => :pound, :submenu => @submenu, :href => "http://bettercakesite")
+  end
+
+  it "has a unique key"
+  it "has a submenu" do
+    @cheesecake.submenu.should == @submenu
+  end
+
+  it "sets the anchor based on display rule in submenu" do
+    @cheesecake.anchor.should == "cheese cake"
+  end
+
+  it "overrides default display style if given in opts" do
+    @spongecake.anchor.should == "sPOnge cAkE"
+  end
+
+  it "generates a url" do
+    @cheesecake.href.should == "/cakes/cheese_cake"
+    @spongecake.href.should == "/cakes/sponge"
+    @poundcake.href.should == "http://bettercakesite"
+  end
+
+end
+
+

data/spec/merb-menus/menu_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Merb::Menus::Menu do
+  before do
+    @menu = Merb::Menus::Menu.new(:foo)
+    @menu.submenu(:wutup){}
+    @menu.submenu(:dog){}
+  end
+
+  it "tracks submenus" do
+    @menu.submenus.should have(2).things
+  end
+
+  it "stores different display rules"
+  it "defines a url generator"
+  it "has a default url generation method"
+end
+
+describe Merb::Menus::Menu, "#submenu" do
+  before do
+    @menu = Merb::Menus::Menu.new(:hellothar)
+  end
+
+  it "creates a submenu without taking a block" do
+    lambda{@menu.submenu(:foo)}.should_not raise_error(ArgumentError)
+    @menu.submenus.should have(1).item
+    @menu.submenus.first.name.should == :foo
+  end
+end
+

data/spec/merb-menus/rule.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Merb::Menus::DisplayStyle do
+  before do
+    @menu = Merb::Menus::Menu.new(:foo)
+    @split_rule = Merb::Menus::DisplayStyle.new(:split,@menu){|thing| thing.to_s.split("_").join(" ")}
+    @splitncap = Merb::Menus::DisplayStyle.new(:split,@menu){|thing| thing.to_s.split("_").join(" ")}
+    @dollarfy = Merb::Menus::DisplayStyle.new(:dollar,@menu){|thing| "$#{thing.to_s.gsub(/_/,',')}"}
+  end
+
+  it "has a unique key" do
+    @split_rule.key.should == :split
+    @splitncap.key.should == :split
+
+    @split_rule.rule.call("hello_thar").should == "hello thar"
+    @splitncap.rule.call("wut_the_deal").should == "wut the deal"
+  end
+
+  it "has a styling rule" do
+    Merb::Menus::DisplayStyle.add_rule(:feh).should be_nil
+  end
+end
+

data/spec/merb-menus/submenu_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Merb::Menus::Submenu do
+  before do
+    Merb::Menus::Menu.new :foo
+    @submenu = Merb::Menus::Submenu.new(:berries, Merb::Menus::Menu[:foo])
+    @submenu.item(:straw)
+    @submenu.item(:rasp)
+    @submenu.item(:black, :anchor => "HELLOTHAR", :url => "eek")
+  end
+
+  it "has a unique key" do
+    @submenu.name.should == :berries
+  end
+
+  it "has a collection of items" do
+    @submenu.items.should have(3).things
+  end
+
+  it 'sets item properly' do
+    item = @submenu.items.first
+    item.name.should == :straw
+    item.submenu.should == @submenu
+    item.anchor.should == "straw"
+    item.href.should == "/berries/straw"
+  end
+end
+

data/spec/merb-menus_spec.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Application < Merb::Controller
+  create_menu :main do
+    submenu :cakes, :href => "/cakes" do
+      item :cheese
+      item :chocolate
+      item :devils_food, :anchor => "Devil's Food"
+    end
+
+    submenu :beers, :href => "/beers" do
+      item :budweiser
+      item :rolling_rock
+      item :fosters, :anchor => "Foster's"
+      item :fat_tire
+    end
+
+    submenu :drinks, :href => "/drinks" do
+      item :soda
+    end
+     
+  end
+end
+
+class Cakes < Application
+  use_menu :main
+
+  # this should be associated with item :cheese
+  def cheese
+    'hello'
+  end
+
+  def chocolate
+    menu_item :beers, :budweiser
+
+    'word up'
+  end
+
+  def not_devils_food
+    # associate this action with item :devils_food
+    menu_item :devils_food
+
+    ':)'
+  end
+end
+
+class Beers < Application
+  def fat_tire
+    'yoink'
+  end
+end
+
+class Snack < Application
+  use_menu :main, :cakes
+
+  def cheese_cake
+    menu_item :cheese
+    
+    [current_menu, current_submenu, current_item].join(" ")
+  end
+
+  def pistachios
+    [current_menu, current_submenu, current_item].join(" ")
+  end
+end
+
+class Drinks < Application
+  def soda
+    "#{current_menu}/#{current_submenu}/#{current_item}"
+  end
+end
+
+describe "menu generator", "Merb::Controller" do
+  before do
+    @menu = Merb::Menus[:main]
+  end
+
+  it "should create the menu" do
+    @menu.name.should == :main
+  end
+
+  it "should create all the submenus" do
+    @menu.submenus.should have(3).things
+    @menu.submenus.first.name.should == :cakes
+  end
+
+  it "should create the submenu items" do
+    @menu.submenus.first.items.should have(3).things
+    @menu.submenus.first.items.map{|e| e.name}.should == [:cheese, :chocolate, :devils_food]
+
+    @menu.submenus[1].items.should have(4).things
+    @menu.submenus[1].items.map{|e| e.name}.should == [:budweiser, :rolling_rock, :fosters, :fat_tire]
+  end
+
+  it "is accessible from child controllers"
+
+  it "sets the current menu properly" do
+    request('/cakes/cheese')
+    top = Merb::Menus[:main]
+    top.current_submenu.name.should == :cakes
+    top.current_submenu.current_item.name.should == :cheese
+  end
+
+  it "overrides actions default menu item" do
+    request('/cakes/chocolate')
+    top = Merb::Menus[:main]
+    top.current_submenu.name.should == :beers
+    top.current_submenu.current_item.name.should == :budweiser
+  end
+
+  it "finds the correct controller/action combo automagically" do
+    request '/beers/fat_tire'
+    Merb::Menus.current_menu.name.should == :main
+    Merb::Menus.current_menu.current_submenu.name.should == :beers
+    Merb::Menus.current_menu.current_submenu.current_item.name.should == :fat_tire
+  end
+
+  it "has helpers to access current menu data" do
+    req = request '/drinks/soda'
+
+    req.body.to_s.should == "main/drinks/soda"
+  end
+
+  it do
+    req = request '/snack/cheese_cake'
+    req.body.to_s.should == "main cakes cheese"
+  end
+
+  it "resets all current menus before each request" do
+    req = request '/snack/pistachios'
+    req.body.to_s.should_not == "main cakes cheese" #this would happen w/o the reset
+    req.body.to_s.should == "main cakes "
+  end
+
+   
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'spec'
+require 'merb-core'
+require 'merb-core/test'
+require 'merb-menus'
+
+Merb::Router.prepare {default_routes}
+
+Merb.start :environment => "test", :adapter => "runner"
+
+Spec::Runner.configure {|config| 
+  config.include(Merb::Test::RouteHelper)
+}
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: merb-menus
+version: !ruby/object:Gem::Version 
+  version: 0.0.7
+platform: ruby
+authors: 
+- jonah honeyman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-03 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Merb plugin that provides dot dot dot uh menus
+email: jonah@honeyman.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb-menus/version.rb
+- lib/merb-menus/merb_controller.rb
+- lib/merb-menus/submenu.rb
+- lib/merb-menus/item.rb
+- lib/merb-menus/merbtasks.rb
+- lib/merb-menus/rule.rb
+- lib/merb-menus/menu.rb
+- lib/merb-menus.rb
+- spec/merb-menus/submenu_spec.rb
+- spec/merb-menus/item_spec.rb
+- spec/merb-menus/rule.rb
+- spec/merb-menus/menu_spec.rb
+- spec/spec_helper.rb
+- spec/merb-menus_spec.rb
+has_rdoc: true
+homepage: http://github.com/jonuts/merb-menus
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Merb plugin that provides dot dot dot uh menus
+test_files: []
+