waiter 0.0.1 → 2.0.0

data/lib/waiter.rb

@@ -1,4 +1,13 @@
-require "waiter/version"
 require "waiter/menu"
-require "waiter/menu/builder"
-require "waiter/menu/drawer"
+require "waiter/dsl"
+require "waiter/menu/drawer"
+
+module Waiter
+  class Engine < ::Rails::Engine
+    initializer :assets do |config|
+      Rails.application.config.assets.precompile += %w{ waiter/menu.css }
+      Rails.application.config.assets.paths << root.join("app", "assets", "stylesheets")
+      Rails.application.config.assets.paths << root.join("app", "assets", "images")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+require 'rspec/its'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/matchers/have_a_submenu.rb

@@ -0,0 +1,34 @@
+RSpec::Matchers.define :have_a_submenu do
+  match do |actual|
+    result = !actual.submenu.nil?
+    result &&= actual.submenu.items.size == @count unless @count.nil?
+    result
+  end
+
+  description do
+    desc = "have a submenu"
+    desc << " with #{@count} items" unless @count.nil?
+    desc
+  end
+
+  failure_message do
+    msg = "expected menu item to have a submenu"
+
+    unless @count.nil?
+      msg << " with #{@count} items but it actually has #{actual.submenu.items.size}"
+    end
+
+    msg
+  end
+
+  failure_message_when_negated do
+    msg = "expected menu item to not have a submenu"
+  end
+
+  chain :containing do |count|
+    @count = count
+  end
+
+  chain(:item) {}
+  chain(:items) {}
+end

data/spec/support/matchers/have_exactly.rb

@@ -0,0 +1,24 @@
+RSpec::Matchers.define :have_exactly do |expected|
+  match do |actual|
+    if @sections
+      actual.sections.size == expected
+    else
+      actual.items.size == expected
+    end
+  end
+
+  description do
+    "contain exactly #{expected} menu #{@sections ? 'sections' : 'items'}"
+  end
+
+  failure_message do
+    msg = "expected that the menu would contain #{expected} #{@sections ? 'sections' : 'items'}; actually contains "
+    msg << (@sections ? actual.sections.size : actual.items.size).to_s
+    msg
+  end
+
+  chain(:item) { @sections = false }
+  chain(:items) { @sections = false }
+  chain(:section) { @sections = true }
+  chain(:sections) { @sections = true }
+end

data/spec/support/matchers/have_menu_items_named.rb

@@ -0,0 +1,32 @@
+RSpec::Matchers.define :have_menu_items_named do |*expected|
+  match do |actual|
+    actual.items.names & expected == expected
+  end
+
+  description do
+    if expected.one?
+      "contain a menu item named #{expected.first.to_s}"
+    else
+      "contain menu items named #{expected.map(&:to_s).join(', ')}"
+    end
+  end
+
+  failure_message do
+    msg = if expected.one?
+            "expected menu to contain a menu item named #{expected}"
+          else
+            "expected menu to contain a menu items named #{expected}"
+          end
+
+    msg << "\nDiff:"
+
+    differ = RSpec::Support::Differ.new(
+        :object_preparer => lambda { |object| RSpec::Matchers::Composable.surface_descriptions_in(object) },
+        :color => RSpec::Matchers.configuration.color?
+    )
+
+    msg << differ.diff(actual.items.names.join("\n"), expected.join("\n"))
+  end
+end
+
+RSpec::Matchers.alias_matcher :have_a_menu_item_named, :have_menu_items_named

data/spec/support/matchers/have_options.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext/hash/except'
+
+RSpec::Matchers.define :have_options do |expected|
+  match do |actual|
+    options == expected
+  end
+
+  failure_message do
+    msg = "expected to contain options #{expected} but actually contained #{options}\nDiff:"
+
+    differ = RSpec::Support::Differ.new(
+        :object_preparer => lambda { |object| RSpec::Matchers::Composable.surface_descriptions_in(object) },
+        :color => RSpec::Matchers.configuration.color?
+    )
+
+    msg << differ.diff(options, expected)
+    msg
+  end
+
+  def options
+    expected.key?(:controllers) ? actual.options : actual.options.except(:controllers)
+  end
+end

data/spec/support/shared_examples/menu_item_shared_examples.rb

@@ -0,0 +1,67 @@
+RSpec.shared_examples 'a menu item' do |instance_options|
+  let(:parent) { double(Waiter::Menu, context: nil, name: :parent, options: {}) }
+
+  before { allow_any_instance_of(Waiter::Menu::Item).to receive(:collect_controllers) }
+
+  context 'when given a block' do
+    subject do
+      described_class.new(parent, *instance_options) do
+        first
+      end
+    end
+
+    its(:submenu) { is_expected.to have_exactly(1).item }
+    its(:submenu) { is_expected.to have_a_menu_item_named(:first) }
+
+    context 'with options' do
+      before { allow(parent).to receive(:options).and_return(foo: :bar) }
+
+      subject do
+        described_class.new(parent, *instance_options) do
+          first foo: :baz
+          second
+          third quux: true
+        end
+      end
+
+      its([:first]) { is_expected.to have_options(foo: :baz) }
+      its([:second]) { is_expected.to have_options(foo: :bar) }
+      its([:third]) { is_expected.to have_options(foo: :bar, quux: true) }
+    end
+  end
+
+  describe '#items' do
+    context 'when a block is not given' do
+      its(:items) { is_expected.to be_empty }
+    end
+
+    context 'when a block is given' do
+      subject do
+        described_class.new(parent, *instance_options) do
+          first
+          second
+        end
+      end
+
+      its('items.size') { is_expected.to eq(2) }
+    end
+  end
+
+  describe '#[]' do
+    context 'when a block is not given' do
+      its([:third]) { is_expected.to be_nil }
+    end
+
+    context 'when a block is given' do
+      subject do
+        described_class.new(parent, *instance_options) do
+          first
+          second
+        end
+      end
+
+      its([:second]) { is_expected.to be_a(Waiter::Menu::Item) }
+      its([:third]) { is_expected.to be_nil }
+    end
+  end
+end

data/spec/waiter/menu/item_list_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'waiter/menu/item_list'
+
+RSpec.describe Waiter::Menu::ItemList do
+  let(:item1) { double('Item', name: :foo) }
+  let(:item2) { double('Item', name: :bar) }
+  let(:item3) { double('Item', name: :baz) }
+
+  subject { described_class.new [item1, item2, item3] }
+
+  describe '#include?' do
+    it { is_expected.to include item1 }
+    it { is_expected.to include item2 }
+    it { is_expected.to include item3 }
+
+    it { is_expected.to include :foo }
+    it { is_expected.to include :bar }
+    it { is_expected.to include :baz }
+
+    it { is_expected.to_not include :foobarbaz }
+  end
+
+  describe '#[]' do
+    its([0]) { is_expected.to eq item1 }
+    its([1]) { is_expected.to eq item2 }
+    its([2]) { is_expected.to eq item3 }
+
+    its([:foo]) { is_expected.to eq item1 }
+    its([:bar]) { is_expected.to eq item2 }
+    its([:baz]) { is_expected.to eq item3 }
+
+    its([:foobarbaz]) { is_expected.to be nil }
+  end
+
+  describe '#names' do
+    its(:names) { is_expected.to contain_exactly(:foo, :bar, :baz) }
+  end
+end

data/spec/waiter/menu/item_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+require 'waiter/menu/item'
+require 'waiter/menu'
+
+RSpec.describe Waiter::Menu::Item do
+  let(:parent) { double(Waiter::Menu, name: :parent, options: {}, top?: false) }
+  subject { described_class.new(parent, :item1, 'path') }
+
+  before { allow_any_instance_of(described_class).to receive(:collect_controllers) }
+
+  it { is_expected.to_not be_section }
+
+  its(:name) { is_expected.to eq :item1 }
+  its(:path) { is_expected.to eq 'path' }
+  its(:options) { is_expected.to be_empty }
+  its(:submenu) { is_expected.to be_nil }
+
+  it_behaves_like 'a menu item', [:item1, 'path']
+
+  context 'collecting controllers' do
+    before { allow_any_instance_of(described_class).to receive(:collect_controllers).and_call_original }
+
+    it 'should add its controller to the parent' do
+      described_class.new(parent, :item1, controller: :foo)
+      expect(parent.options[:controllers]).to contain_exactly('foo')
+    end
+
+    it 'should strip slashes from the controller name' do
+      described_class.new(parent, :item1, controller: '/foo')
+      expect(parent.options[:controllers]).to contain_exactly('foo')
+    end
+
+    it 'should retain controllers given in options' do
+      parent.options[:controllers] = ['bar']
+      described_class.new(parent, :item1, controller: :foo)
+      expect(parent.options[:controllers]).to contain_exactly('foo', 'bar')
+    end
+
+    it 'should not duplicate controllers' do
+      parent.options[:controllers] = ['foo']
+      described_class.new(parent, :item1, controller: :foo)
+      expect(parent.options[:controllers]).to contain_exactly('foo')
+    end
+  end
+
+  describe '#selected?' do
+    let(:parent) { double(Waiter::Menu, context: context, options: {}).as_null_object }
+    let(:context) { double('Context', params: { controller: @controller }) }
+
+    subject do
+      item = described_class.new(parent, :item1)
+      allow(item).to receive(:controllers).and_return(@controllers)
+      item
+    end
+
+    it 'should return true if the controller matches' do
+      @controller = 'foo'
+      @controllers = %w(foo)
+      expect(subject).to be_selected
+    end
+
+    it "should return false if the controller doesn't match" do
+      @controller = 'foo'
+      @controllers = %w(bar baz quux)
+      expect(subject).to_not be_selected
+    end
+
+    it 'should return true if the controller matches a wildcard' do
+      @controller = 'foo/bar/baz'
+      @controllers = %w(foo/*)
+      expect(subject).to be_selected
+    end
+
+    it 'should return true if a simple controller matches a wildcard' do
+      @controller = 'foo'
+      @controllers = %w(foo/*)
+      expect(subject).to be_selected
+    end
+
+    it "should return false if the wildcard doesn't match" do
+      @controller = 'foo'
+      @controllers = %w(foo/bar/*)
+      expect(subject).to_not be_selected
+    end
+
+    it 'should return false if the controller only matches part of a wildcard' do
+      @controller = 'foo/baz'
+      @controllers = %w(foo/bar/*)
+      expect(subject).to_not be_selected
+    end
+
+    context 'when a selected item is specified' do
+      subject { described_class.new(parent, :item1, nil, selected: :foo) }
+
+      it 'should return true if the item has the same name as the selection' do
+        allow(subject).to receive(:name).and_return(:foo)
+        expect(subject).to be_selected
+      end
+
+      it 'should return false if the item does not have the same name as the selection' do
+        expect(subject).to_not be_selected
+      end
+    end
+  end
+
+  describe "#path" do
+    let(:menu) { Waiter::Menu.new(:test, nil) }
+
+    it 'should be nil if not specified for a top level item' do
+      item = described_class.new(menu, :item1, nil)
+      menu.add(item)
+
+      expect(item.path).to be_nil
+    end
+
+    it 'should not be nil for a submenu item' do
+      item = described_class.new(menu, :item1, nil) do
+        subitem1
+      end
+      menu.add(item)
+
+      expect(item.submenu[:subitem1].path).to eq(controller: '/subitem1', action: :index)
+    end
+
+    it 'should add an index if missing' do
+      item = described_class.new(menu, :item1, nil) do
+        subitem1 controller: :foo
+      end
+      menu.add(item)
+
+      expect(item.submenu[:subitem1].path).to eq(controller: '/foo', action: :index)
+    end
+
+    it 'should add a controller if missing' do
+      item = described_class.new(menu, :item1, nil) do
+        subitem1 action: :foo
+      end
+      menu.add(item)
+
+      expect(item.submenu[:subitem1].path).to eq(controller: '/subitem1', action: :foo)
+    end
+
+    it 'should not add anything if given a string' do
+      item = described_class.new(menu, :item1, nil) do
+        subitem1 '/foo/bar/baz'
+      end
+      menu.add(item)
+
+      expect(item.submenu[:subitem1].path).to eq '/foo/bar/baz'
+    end
+
+    it 'should not add anything if given controller & action' do
+      item = described_class.new(menu, :item1, nil) do
+        subitem1 controller: :foo, action: :bar, id: 123
+      end
+      menu.add(item)
+
+      expect(item.submenu[:subitem1].path).to eq(controller: '/foo', action: :bar, id: 123)
+    end
+  end
+end

data/spec/waiter/menu/section_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'waiter/menu/section'
+require 'waiter/menu'
+
+RSpec.describe Waiter::Menu::Section do
+  let(:parent) { double(Waiter::Menu, name: :parent, options: {}) }
+  subject { described_class.new(parent) }
+
+  before do
+    allow_any_instance_of(described_class).to receive(:collect_controllers)
+  end
+
+  it { is_expected.to be_section }
+
+  its(:name) { is_expected.to be_nil }
+  its(:path) { is_expected.to be_nil }
+  its(:options) { is_expected.to be_empty }
+  its(:submenu) { is_expected.to be_nil }
+
+  it_behaves_like 'a menu item', []
+end