waiter 0.0.1 → 2.0.0

data/spec/waiter/menu_spec.rb

@@ -0,0 +1,298 @@
+require 'spec_helper'
+require 'waiter/menu'
+
+RSpec.describe Waiter::Menu do
+  describe '.serve' do
+    context 'basic DSL' do
+      context 'when explicitly specifying block params' do
+        subject do
+          Waiter::Menu.serve(:test) do |menu|
+            menu.first
+            menu.second
+            menu.third do |submenu|
+              submenu.item1
+              submenu.item2
+            end
+          end
+        end
+
+        it { is_expected.to have_exactly(3).items }
+        it { is_expected.to have_menu_items_named(:first, :second, :third) }
+        it { is_expected.to have_menu_items_named(:second, :third) }
+        it { is_expected.to_not have_a_menu_item_named(:item1) }
+
+        its([:first]) { is_expected.to_not have_a_submenu }
+        its([:second]) { is_expected.to_not have_a_submenu }
+        its([:third]) { is_expected.to have_a_submenu.containing(2).items }
+      end
+
+      context 'when omitting block params' do
+        subject do
+          Waiter::Menu.serve(:test) do
+            first
+            second
+            third do
+              item1
+              item2
+            end
+          end
+        end
+
+        it { is_expected.to have_exactly(3).items }
+        it { is_expected.to have_menu_items_named(:first, :second, :third) }
+        it { is_expected.to have_menu_items_named(:second, :third) }
+        it { is_expected.to_not have_a_menu_item_named(:item1) }
+
+        its([:first]) { is_expected.to_not have_a_submenu }
+        its([:second]) { is_expected.to_not have_a_submenu }
+        its([:third]) { is_expected.to have_a_submenu.containing(2).items }
+      end
+    end
+
+    context 'sections' do
+      subject do
+        Waiter::Menu.serve(:test) do
+          section do
+            first
+            second
+          end
+
+          section do
+            third
+            fourth
+          end
+
+          fifth
+        end
+      end
+
+      it { is_expected.to have_exactly(2).sections }
+      it { is_expected.to have_a_menu_item_named(:fifth) }
+      it { is_expected.to_not have_a_menu_item_named(:fourth) }
+
+      its('sections.first') { is_expected.to have_exactly(2).items }
+      its('sections.first') { is_expected.to have_menu_items_named(:first, :second) }
+    end
+
+    context 'using methods provided in context object' do
+      let(:context) { double('Context Object', foo: 1, bar: 2) }
+
+      subject do
+        Waiter::Menu.serve(:test, context) do
+          first if foo == 1
+          second if foo == 2
+
+          third do
+            fourth if bar == 2
+          end
+        end
+      end
+
+      it { is_expected.to have_exactly(2).items }
+      it { is_expected.to have_menu_items_named(:first, :third) }
+      it { is_expected.to_not have_a_menu_item_named(:second) }
+
+      its([:third]) { is_expected.to have_a_submenu.containing(1).item }
+      its([:third]) { is_expected.to have_a_menu_item_named(:fourth) }
+    end
+
+    context 'options' do
+      subject do
+        Waiter::Menu.serve(:test, nil, foo: 1) do
+          first bar: 2
+          second(bar: 3) do
+            third
+          end
+
+          section(foo: 2) do
+            fourth
+            fifth foo: 3
+          end
+        end
+      end
+
+      before { allow_any_instance_of(Waiter::Menu::Section).to receive(:collect_controllers) }
+      before { allow_any_instance_of(Waiter::Menu::Item).to receive(:collect_controllers) }
+
+      its([:first]) { is_expected.to have_options(foo: 1, bar: 2) }
+      its([:second]) { is_expected.to have_options(foo: 1, bar: 3) }
+      its('sections.first') { is_expected.to have_options(foo: 2) }
+
+      it 'should pass options to submenus' do
+        expect(subject[:second][:third]).to have_options(foo: 1, bar: 3)
+      end
+
+      it 'should pass options to sections' do
+        expect(subject.sections.first[:fourth]).to have_options(foo: 2)
+      end
+
+      it 'should allow passed on options to be overriden' do
+        expect(subject.sections.first[:fifth]).to have_options(foo: 3)
+      end
+    end
+  end
+
+  describe '.new' do
+    let(:context) { double('Context') }
+
+    subject { described_class.new(:test, context) }
+
+    its(:context) { is_expected.to eq context }
+    its(:items) { is_expected.to be_empty }
+    its(:items) { is_expected.to be_a Waiter::Menu::ItemList }
+    its(:options) { is_expected.to be_empty }
+  end
+
+  describe '#draw' do
+    let(:drawer) { double(Waiter::Menu::Drawer).as_null_object }
+
+    subject do
+      Waiter::Menu.serve(:test) do |menu|
+        menu.first
+        menu.second
+        menu.third do |submenu|
+          submenu.item1
+          submenu.item2
+        end
+      end
+    end
+
+    before do
+      allow(Waiter::Menu::Drawer).to receive(:new).and_return(drawer)
+    end
+
+    it 'should create a new drawer' do
+      expect(Waiter::Menu::Drawer).to receive(:new).with(subject, nil)
+      subject.draw
+    end
+
+    it 'should draw the menu' do
+      expect(drawer).to receive(:draw)
+      subject.draw
+    end
+  end
+
+  describe '#add' do
+    subject do
+      m = described_class.new(:test, nil)
+      m.add(:foo, { controller: :path }, { do_something: true })
+      m[:foo]
+    end
+
+    before { allow_any_instance_of(Waiter::Menu::Item).to receive(:collect_controllers) }
+
+    it { is_expected.to be_a Waiter::Menu::Item }
+    it { is_expected.to have_options(do_something: true) }
+    its(:path) { is_expected.to eq(controller: '/path', action: :index) }
+  end
+
+  describe '#add_section' do
+    subject do
+      m = described_class.new(:test, nil)
+      m.add_section({ do_something: true }) do
+        item1
+      end
+      m.sections.last
+    end
+
+    before { allow_any_instance_of(Waiter::Menu::Section).to receive(:collect_controllers) }
+    before { allow_any_instance_of(Waiter::Menu::Item).to receive(:collect_controllers) }
+
+    it { is_expected.to be_a Waiter::Menu::Section }
+    it { is_expected.to have_options(do_something: true) }
+
+    it 'should not add a blank section' do
+      m = described_class.new(:test, nil)
+      m.add_section
+      expect(m.sections.count).to eq 0
+    end
+
+    it 'should not add blank nested sections' do
+      m = described_class.new(:test, nil)
+      m.add_section do
+        section {}
+      end
+      expect(m.sections.count).to eq 0
+    end
+  end
+
+  describe '#sections' do
+    context 'when sections are defined' do
+      subject do
+        m = described_class.new(:test, nil)
+        3.times { m.add_section { item1 } }
+        2.times { |i| m.add("item#{i}".to_sym, :path) }
+        m.sections
+      end
+
+      it { is_expected.to all(be_a(Waiter::Menu::Section)) }
+      its(:size) { is_expected.to eq 3 }
+    end
+
+    context 'when sections are not defined' do
+      subject do
+        m = described_class.new(:test, nil)
+        2.times { |i| m.add("item#{i}".to_sym, :path) }
+        m.sections
+      end
+
+      it { is_expected.to be_empty }
+    end
+  end
+
+  describe '#[]' do
+    subject { described_class.new(:test, nil) }
+
+    context 'when the menu has no items' do
+      its([:item1]) { is_expected.to be_nil }
+    end
+
+    context 'when the menu has items' do
+      before { 2.times { |i| subject.add("item#{i}".to_sym, :path) } }
+
+      its([:item1]) { is_expected.to be_a Waiter::Menu::Item }
+    end
+  end
+
+  describe '#items' do
+    before { allow_any_instance_of(Waiter::Menu::Item).to receive(:translate) { |_, key| key.to_sym } }
+
+    subject do
+      described_class.serve(:test, nil, @options) do
+        foo
+        bar
+        baz
+        quux
+      end
+    end
+
+    it 'should sort by item title' do
+      @options = { sort: :item_title }
+      expect(subject.items(true).names).to match [:bar, :baz, :foo, :quux]
+    end
+
+    it 'should reverse' do
+      @options = { reverse: true }
+      expect(subject.items(true).names).to match [:quux, :baz, :bar, :foo]
+    end
+
+    it 'should sort and reverse at the same time' do
+      @options = { sort: :item_title, reverse: true }
+      expect(subject.items(true).names).to match [:quux, :foo, :baz, :bar]
+    end
+  end
+
+  describe '#top?' do
+    it 'should be true for a new menu' do
+      expect(described_class.new(:test, nil)).to be_top
+    end
+
+    it 'should be false for a submenu' do
+      item = Waiter::Menu::Item.new(double('Parent', options: {}).as_null_object, :item1) do
+        item2
+      end
+
+      expect(item.submenu).to_not be_top
+    end
+  end
+end

data/waiter.gemspec

@@ -18,4 +18,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "activesupport", "> 3.0.0"
+  gem.add_dependency "haml"
+  gem.add_development_dependency "rspec", ">= 3.1.0"
+  gem.add_development_dependency "rspec-its"
+  gem.add_development_dependency "rake"
 end

metadata

@@ -1,32 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: waiter
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
   type: :runtime
+  prerelease: false
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: 3.0.0
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: 3.0.0
-  name: activesupport
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides an easy DSL for serving up menus
 email:
 - dvandersluis@selfmgmt.com
@@ -35,39 +88,70 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/images/waiter/bg.gif
+- app/assets/images/waiter/selected-bg.gif
+- app/assets/stylesheets/waiter/menu.css.scss
+- app/views/waiter/_item.haml
+- app/views/waiter/_menu_bar.haml
+- app/views/waiter/_section.haml
+- app/views/waiter/_sub_item.haml
+- app/views/waiter/_submenu.haml
 - lib/waiter.rb
+- lib/waiter/dsl.rb
 - lib/waiter/menu.rb
-- lib/waiter/menu/builder.rb
 - lib/waiter/menu/drawer.rb
+- lib/waiter/menu/item.rb
+- lib/waiter/menu/item_list.rb
+- lib/waiter/menu/section.rb
 - lib/waiter/version.rb
+- spec/spec_helper.rb
+- spec/support/matchers/have_a_submenu.rb
+- spec/support/matchers/have_exactly.rb
+- spec/support/matchers/have_menu_items_named.rb
+- spec/support/matchers/have_options.rb
+- spec/support/shared_examples/menu_item_shared_examples.rb
+- spec/waiter/menu/item_list_spec.rb
+- spec/waiter/menu/item_spec.rb
+- spec/waiter/menu/section_spec.rb
+- spec/waiter/menu_spec.rb
 - waiter.gemspec
 homepage: https://github.com/dvandersluis/waiter
 licenses: []
+metadata: {}
 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.8.24
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Quick and easy DSL for generating menus for use in Rails applications
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/support/matchers/have_a_submenu.rb
+- spec/support/matchers/have_exactly.rb
+- spec/support/matchers/have_menu_items_named.rb
+- spec/support/matchers/have_options.rb
+- spec/support/shared_examples/menu_item_shared_examples.rb
+- spec/waiter/menu/item_list_spec.rb
+- spec/waiter/menu/item_spec.rb
+- spec/waiter/menu/section_spec.rb
+- spec/waiter/menu_spec.rb
 has_rdoc: 

data/lib/waiter/menu/builder.rb

@@ -1,18 +0,0 @@
-module Waiter
-  class Menu
-    # Builds a menu structure from the DSL
-    class Builder
-      def initialize(menu)
-        @menu = menu
-      end
-
-      def method_missing(name, *args, &block)
-        @menu.add name, *args
-        if block_given?
-          @menu.submenus[name] = Menu.new(@menu.options.merge(:controller => (args.first.andand[:controller] || name)))
-          yield Builder.new(@menu.submenus[name])
-        end
-      end
-    end
-  end
-end