tabulous 1.3.2 → 2.0.0

data/spec/lib/tabulous/dsl/setup_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../../../spec_helper'
+
+describe "the Tabulous.setup DSL" do
+
+  it "should process 'customize' by passing it onto the Dsl::Config" do
+    Tabulous::Dsl::Config.should_receive(:process)
+    Tabulous::Dsl::Setup.process { customize }
+  end
+
+  it "should process 'use_css_scaffolding' by setting use_css_scaffolding to true" do
+    ::Tabulous::Config.use_css_scaffolding = false
+    Tabulous::Dsl::Setup.process { use_css_scaffolding }
+    ::Tabulous::Config.use_css_scaffolding.should be_true
+  end
+
+  it "should process 'use_css_scaffolding' by passing it onto the Dsl::Config if a block is present" do
+    Tabulous::Dsl::Config.should_receive(:process)
+    Tabulous::Dsl::Setup.process do
+      use_css_scaffolding do
+      end
+    end
+  end
+
+  it "should process 'tabs' by passing it onto the Dsl::Tabs" do
+    Tabulous::Dsl::Tabs.should_receive(:process)
+    Tabulous::Dsl::Setup.process { tabs }
+  end
+
+  it "should process 'tabs' by adding a new tabset" do
+    tabset = Tabulous::Tabset.new
+    Tabulous::Dsl::Tabs.should_receive(:process).and_return(tabset)
+    Tabulous::Dsl::Setup.process { tabs(:name) }
+    Tabulous::Tabsets.get(:name).should == tabset
+  end
+
+end

data/spec/lib/tabulous/dsl/tab_spec.rb

@@ -0,0 +1,156 @@
+require_relative '../../../spec_helper'
+
+describe "the tab DSL" do
+  context "with typical declarations" do
+    before(:each) do
+      @tab = Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        visible_when  true
+        enabled_when  false
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+      class DummyViewContext
+        def controller_path
+          'cookies'
+        end
+        def action_name
+          'eat'
+        end
+      end
+      @view = DummyViewContext.new
+    end
+
+    it "should return a tab" do
+      @tab.should be_a(Tabulous::Tab)
+    end
+
+    it "should use the values given" do
+      @tab.text.should == 'text'
+      @tab.link_path.should == 'path'
+      @tab.visible?.should be_true
+      @tab.enabled?.should be_false
+      @tab.active?(@view).should be_true
+    end
+  end
+
+  it "should complain if 'text' is missing" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        link_path     'path'
+        visible_when  true
+        enabled_when  false
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+    }.to raise_error(Tabulous::MissingDeclarationError)
+  end
+
+  it "should complain if 'link_path' is missing" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        visible_when  true
+        enabled_when  false
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+    }.to raise_error(Tabulous::MissingDeclarationError)
+  end
+
+  it "should complain if 'visible_when' is missing" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        enabled_when  false
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+    }.to raise_error(Tabulous::MissingDeclarationError)
+  end
+
+  it "should complain if 'enabled_when' is missing" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        visible_when  true
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+    }.to raise_error(Tabulous::MissingDeclarationError)
+  end
+
+  it "should complain if 'active_when' is missing" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        visible_when  true
+        enabled_when  false
+      end
+    }.to raise_error(Tabulous::MissingDeclarationError)
+  end
+
+  it "should allow multiple actions to be set active" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        visible_when  true
+        enabled_when  false
+        active_when do
+          in_action('foo').of_controller('cookies')
+          in_action('bar').of_controller('cookies')
+        end
+      end
+    }.to_not raise_error
+  end
+
+  it "should allow multiple actions to be set active using in_actions" do
+    expect {
+      Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        visible_when  true
+        enabled_when  false
+        active_when   { in_actions('foo', 'bar').of_controller('cookies') }
+      end
+    }.to_not raise_error
+  end
+
+  context "with literal values" do
+    before(:each) do
+      @tab = Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          'text'
+        link_path     'path'
+        visible_when  true
+        enabled_when  false
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+    end
+
+    it "should use the values given" do
+      @tab.text.should == 'text'
+      @tab.link_path.should == 'path'
+      @tab.visible?.should be_true
+      @tab.enabled?.should be_false
+    end
+  end
+
+  context "with lazily evaluated values" do
+    before(:each) do
+      @tab = Tabulous::Dsl::Tab.process('tab_name', nil) do
+        text          { 'te' + 'xt' }
+        link_path     { 'path' }
+        visible_when  { 5 == 5 }
+        enabled_when  { false }
+        active_when   { in_action('any').of_controller('cookies') }
+      end
+    end
+
+    it "should evaluate the values given" do
+      @tab.text.should == 'text'
+      @tab.link_path.should == 'path'
+      @tab.visible?.should be_true
+      @tab.enabled?.should be_false
+    end
+  end
+end

data/spec/lib/tabulous/dsl/tabs_spec.rb

@@ -0,0 +1,6 @@
+require_relative '../../../spec_helper'
+
+describe "the tabs DSL" do
+  # The behavior of this class is difficult to test well in isolation, so
+  # we rely on good integration specs instead.
+end

data/spec/lib/tabulous/html5_renderer_spec.rb

@@ -0,0 +1,56 @@
+require_relative '../../spec_helper'
+
+describe Tabulous::Html5Renderer do
+  include Tabulous::TestData
+
+  before(:each) do
+    create_sample_tabset
+    @renderer = Tabulous::Html5Renderer.new(@tabset, @view)
+  end
+
+  it "should return HTML5 for tabs" do
+    tabs_html = @renderer.tabs_html
+    tabs_html.should be_a(String)
+    expect(tabs_html).to match(/<nav class="tabs">/)
+    expect(tabs_html).to_not match(/<div class="tabs">/)
+  end
+
+  it "should return HTML5 for subtabs" do
+    subtabs_html = @renderer.subtabs_html
+    subtabs_html.should be_a(String)
+    expect(subtabs_html).to match(/<nav class="subtabs">/)
+    expect(subtabs_html).to_not match(/<div class="subtabs">/)
+  end
+
+  it "should not show invisible tabs" do
+    expect(@renderer.tabs_html).to_not match(/cookies/)
+  end
+
+  it "should have the correct HTML for disabled tabs" do
+    expect(@renderer.tabs_html).to match(/<li class="disabled"><span class="tab">cupcakes<\/span><\/li>/)
+  end
+
+  it "should return the expected HTML for tabs" do
+    tabs_html = @renderer.tabs_html
+    expected_html = <<-HTML.strip_heredoc
+      <nav class="tabs">
+        <ul>
+          <li><a href="/cakes" class="tab">cakes</a></li><li class="disabled"><span class="tab">cupcakes</span></li><li class="active"><a href="/breads" class="tab">breads</a></li>
+        </ul>
+      </nav>
+    HTML
+    tabs_html.should == expected_html
+  end
+
+  it "should return the expected HTML for subtabs" do
+    subtabs_html = @renderer.subtabs_html
+    expected_html = <<-HTML.strip_heredoc
+      <nav class="subtabs">
+        <ul>
+          <li class="active"><a href="/breads/spoonbread" class="tab">spoonbread</a></li><li><a href="/breads/banana-bread" class="tab">banana bread</a></li>
+        </ul>
+      </nav>
+    HTML
+    subtabs_html.should == expected_html
+  end
+end

data/spec/lib/tabulous/tab_spec.rb

@@ -0,0 +1,212 @@
+require_relative '../../spec_helper'
+
+describe Tabulous::Tab do
+  before(:each) do
+    class DummyViewContext
+      def some_text
+        'some text'
+      end
+      def some_boolean
+        true
+      end
+      def controller_path
+        'cookies'
+      end
+      def action_name
+        'eat'
+      end
+    end
+    @view = DummyViewContext.new
+  end
+
+  it "should allow name to be set" do
+    subject.name = 'name'
+    subject.name.should == 'name'
+  end
+
+  it "should allow text to be set" do
+    subject.text = 'foo'
+    subject.text.should == 'foo'
+  end
+
+  it "should allow text to be set lazily" do
+    subject.text = lambda { some_text }
+    subject.text(@view).should == 'some text'
+  end
+
+  it "should allow link_path to be set" do
+    subject.link_path = 'foo'
+    subject.link_path.should == 'foo'
+  end
+
+  it "should allow link_path to be set lazily" do
+    subject.link_path = lambda { some_text }
+    subject.link_path(@view).should == 'some text'
+  end
+
+  it "should allow visible_when to be set" do
+    subject.visible_when = false
+    subject.visible?.should be_false
+  end
+
+  it "should allow visible_when to be set lazily" do
+    subject.visible_when = lambda { some_boolean }
+    subject.visible?(@view).should be_true
+  end
+
+  it "should allow enabled_when to be set" do
+    subject.enabled_when = false
+    subject.enabled?.should be_false
+  end
+
+  it "should allow enabled_when to be set lazily" do
+    subject.enabled_when = lambda { some_boolean }
+    subject.enabled?(@view).should be_true
+  end
+
+  it "should be a tab by default" do
+    subject.subtab?.should be_false
+  end
+
+  it "should be able to be a subtab" do
+    subject.kind = :subtab
+    subject.subtab?.should be_true
+  end
+
+  it "should allow parent tab to be set" do
+    parent = Tabulous::Tab.new
+    subtab = Tabulous::Tab.new
+    subtab.kind = :subtab
+    subtab.parent.should be_nil
+    subtab.parent = parent
+    subtab.parent.should == parent
+  end
+
+  it "should not allow parent tab to be set if not a subtab" do
+    parent = Tabulous::Tab.new
+    not_a_subtab = Tabulous::Tab.new
+    expect { not_a_subtab.parent = parent }.to raise_error
+  end
+
+  it "should be in the parent's subtabs after setting parent" do
+    parent = Tabulous::Tab.new
+    subtab = Tabulous::Tab.new
+    subtab.kind = :subtab
+    parent.subtabs.should match_array([])
+    subtab.parent = parent
+    parent.subtabs.should match_array([subtab])
+  end
+
+  describe "#active?" do
+    it "should be false by default" do
+      subject.active?(@view).should be_false
+    end
+
+    it "should be true if the current action and current controller matches the active actions" do
+      subject.add_active_actions('cookies', ['bake', 'eat'])
+      subject.active?(@view).should be_true
+    end
+
+    it "should be false if the current action but not the current controller matches the active actions" do
+      subject.add_active_actions('cakes', ['bake', 'eat'])
+      subject.active?(@view).should be_false
+    end
+
+    it "should be false if the current controller but not the current action matches the active actions" do
+      subject.add_active_actions('cookies', ['bake', 'buy'])
+      subject.active?(@view).should be_false
+    end
+
+    it "should be true if the current controller matches and the active action is any" do
+      subject.add_active_actions('cookies', 'any')
+      subject.active?(@view).should be_true
+    end
+
+    it "should be false if the current controller does not match and the active action is any" do
+      subject.add_active_actions('cakes', 'any')
+      subject.active?(@view).should be_false
+    end
+
+    it "should be true if a subtab is active" do
+      parent = Tabulous::Tab.new
+      subtab = Tabulous::Tab.new
+      subtab.kind = :subtab
+      subtab.parent = parent
+      subtab.add_active_actions('cookies', 'eat')
+      parent.active?(@view).should be_true
+    end
+
+    it "should be true if a subtab is active" do
+      parent = Tabulous::Tab.new
+      subtab = Tabulous::Tab.new
+      subtab.kind = :subtab
+      subtab.parent = parent
+      subtab.add_active_actions('cookies', 'eat')
+      parent.active?(@view).should be_true
+    end
+  end
+
+  describe "#clickable?" do
+    it "should be true if enabled" do
+      subject.enabled_when = true
+      subject.clickable?(@view).should be_true
+    end
+
+    it "should be false if not enabled" do
+      subject.enabled_when = false
+      subject.clickable?(@view).should be_false
+    end
+
+    context "when active and enabled" do
+      before(:each) do
+        @tab = Tabulous::Tab.new
+        @tab.enabled_when = true
+        @tab.add_active_actions('cookies', 'eat')
+      end
+
+      it "should be false if active_tab_clickable is false" do
+        Tabulous::Config.active_tab_clickable = false
+        @tab.clickable?(@view).should be_false
+      end
+
+      it "should be true if active_tab_clickable is true" do
+        Tabulous::Config.active_tab_clickable = true
+        @tab.clickable?(@view).should be_true
+      end
+    end
+  end
+
+  describe "#active_actions_overlap?" do
+    it "should return false if active actions do not overlap" do
+      tab1 = Tabulous::Tab.new
+      tab1.add_active_actions('cookies', 'eat')
+      tab2 = Tabulous::Tab.new
+      tab2.add_active_actions('cookies', 'chew')
+      tab1.active_actions_overlap?(tab2).should be_false
+    end
+
+    it "should return false if active actions do not overlap" do
+      tab1 = Tabulous::Tab.new
+      tab1.add_active_actions('cookies', 'eat')
+      tab2 = Tabulous::Tab.new
+      tab2.add_active_actions('cakes', 'eat')
+      tab1.active_actions_overlap?(tab2).should be_false
+    end
+
+    it "should return true if active actions do overlap" do
+      tab1 = Tabulous::Tab.new
+      tab1.add_active_actions('cookies', 'eat')
+      tab2 = Tabulous::Tab.new
+      tab2.add_active_actions('cookies', 'eat')
+      tab1.active_actions_overlap?(tab2).should be_true
+    end
+
+    it "should return true if active actions do overlap" do
+      tab1 = Tabulous::Tab.new
+      tab1.add_active_actions('cookies', 'any')
+      tab2 = Tabulous::Tab.new
+      tab2.add_active_actions('cookies', 'eat')
+      tab1.active_actions_overlap?(tab2).should be_true
+    end
+  end
+end

data/spec/lib/tabulous/tabset_spec.rb

@@ -0,0 +1,74 @@
+require_relative '../../spec_helper'
+
+describe Tabulous::Tabset do
+  before(:each) do
+    class DummyViewContext
+      def controller_path
+        'cookies'
+      end
+      def action_name
+        'eat'
+      end
+    end
+    @view = DummyViewContext.new
+    @tab1 = Tabulous::Tab.new
+    @tab1.name = 'tab1'
+    @tab1.add_active_actions('cakes', 'any')
+    @subtab1 = Tabulous::Tab.new
+    @subtab1.name = 'subtab1'
+    @subtab1.kind = :subtab
+    @subtab1.parent = @tab1
+    @subtab1.add_active_actions('breads', 'any')
+    @tab2 = Tabulous::Tab.new
+    @tab2.name = 'tab2'
+    @tab2.add_active_actions('cookies', 'any')
+    subject.add_tab(@tab1)
+    subject.add_tab(@subtab1)
+    subject.add_tab(@tab2)
+  end
+
+  describe "#tabs" do
+    it "should return in order all tabs" do
+      subject.tabs.should == [@tab1, @subtab1, @tab2]
+    end
+  end
+
+  describe "#primary_tabs" do
+    it "should return in order all tabs that are not subtabs" do
+      subject.primary_tabs.should == [@tab1, @tab2]
+    end
+  end
+
+  describe "#active_primary_tab" do
+    it "should return the tab that is active according to the current controller and action" do
+      subject.active_primary_tab(@view).should == @tab2
+    end
+  end
+
+  describe "#visible_subtabs" do
+    it "should return an empty array if there are no visible subtabs" do
+      subject.visible_subtabs(@view).should == []
+    end
+    it "should return an ordered array of visible subtabs if there are visible subtabs" do
+      @subtab2 = Tabulous::Tab.new
+      @subtab2.name = 'subtab2'
+      @subtab2.kind = :subtab
+      @subtab2.parent = @tab2
+      @subtab2.visible_when = true
+      @subtab3 = Tabulous::Tab.new
+      @subtab3.name = 'subtab3'
+      @subtab3.kind = :subtab
+      @subtab3.parent = @tab2
+      @subtab3.visible_when = false
+      @subtab4 = Tabulous::Tab.new
+      @subtab4.name = 'subtab4'
+      @subtab4.kind = :subtab
+      @subtab4.visible_when = true
+      @subtab4.parent = @tab2
+      subject.add_tab(@subtab2)
+      subject.add_tab(@subtab3)
+      subject.add_tab(@subtab4)
+      subject.visible_subtabs(@view).should == [@subtab2, @subtab4]
+    end
+  end
+end

data/spec/lib/tabulous/tabsets_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../spec_helper'
+
+describe "Tabulous::Tabsets" do
+  it "should allow you to add and retrieve tabsets by key" do
+    dummy = Object.new
+    Tabulous::Tabsets.add('dummy', dummy)
+    Tabulous::Tabsets.get('dummy').should == dummy
+  end
+
+  it "should treat symbol keys and string keys the same" do
+    dummy = Object.new
+    dummy2 = Object.new
+    Tabulous::Tabsets.add('dummy', dummy)
+    Tabulous::Tabsets.add(:dummy2, dummy2)
+    Tabulous::Tabsets.get('dummy').should == dummy
+    Tabulous::Tabsets.get(:dummy).should == dummy
+    Tabulous::Tabsets.get('dummy2').should == dummy2
+    Tabulous::Tabsets.get(:dummy2).should == dummy2
+  end
+end

data/spec/lib/tabulous/tabulous_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../../spec_helper'
+
+describe Tabulous do
+  it "should have a setup method" do
+    Tabulous.should respond_to(:setup)
+  end
+end

data/spec/lib/tabulous/view_helpers_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../spec_helper'
+
+describe Tabulous::ViewHelpers do
+  before(:each) do
+    class DummyClass
+      include Tabulous::ViewHelpers
+    end
+  end
+
+  it "should define tabs" do
+    DummyClass.new.should respond_to(:tabs)
+  end
+
+  it "should define subtabs" do
+    DummyClass.new.should respond_to(:subtabs)
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 require 'diffy'
 Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+require 'tabulous'

data/spec/support/test_data.rb

@@ -0,0 +1,76 @@
+module Tabulous
+  module TestData
+
+    class DummyViewContext
+      def controller_path
+        'breads'
+      end
+      def action_name
+        'spoonbread'
+      end
+    end
+
+    def create_sample_tabset
+      @view = DummyViewContext.new
+      @tabset = Tabulous::Tabset.new
+
+      @cakes_tab = Tabulous::Tab.new
+      @cakes_tab.name = 'cakes'
+      @cakes_tab.text = 'cakes'
+      @cakes_tab.link_path = '/cakes'
+      @cakes_tab.visible_when = true
+      @cakes_tab.enabled_when = true
+      @cakes_tab.add_active_actions('cakes', 'any')
+      @tabset.add_tab(@cakes_tab)
+
+      @cookies_tab = Tabulous::Tab.new
+      @cookies_tab.name = 'cookies'
+      @cookies_tab.text = 'cookies'
+      @cookies_tab.link_path = '/cookies'
+      @cookies_tab.visible_when = false
+      @cookies_tab.enabled_when = true
+      @cookies_tab.add_active_actions('cookies', 'any')
+      @tabset.add_tab(@cookies_tab)
+
+      @cupcakes_tab = Tabulous::Tab.new
+      @cupcakes_tab.name = 'cupcakes'
+      @cupcakes_tab.text = 'cupcakes'
+      @cupcakes_tab.link_path = '/cupcakes'
+      @cupcakes_tab.visible_when = true
+      @cupcakes_tab.enabled_when = false
+      @cupcakes_tab.add_active_actions('cupcakes', 'any')
+      @tabset.add_tab(@cupcakes_tab)
+
+      @breads_tab = Tabulous::Tab.new
+      @breads_tab.name = 'breads'
+      @breads_tab.text = 'breads'
+      @breads_tab.link_path = '/breads'
+      @breads_tab.visible_when = true
+      @breads_tab.enabled_when = true
+      @tabset.add_tab(@breads_tab)
+
+      @spoonbread_tab = Tabulous::Tab.new
+      @spoonbread_tab.name = 'spoonbread'
+      @spoonbread_tab.kind = :subtab
+      @spoonbread_tab.parent = @breads_tab
+      @spoonbread_tab.text = 'spoonbread'
+      @spoonbread_tab.link_path = '/breads/spoonbread'
+      @spoonbread_tab.visible_when = true
+      @spoonbread_tab.enabled_when = true
+      @spoonbread_tab.add_active_actions('breads', 'spoonbread')
+      @tabset.add_tab(@spoonbread_tab)
+
+      @banana_bread_tab = Tabulous::Tab.new
+      @banana_bread_tab.name = 'banana bread'
+      @banana_bread_tab.kind = :subtab
+      @banana_bread_tab.parent = @breads_tab
+      @banana_bread_tab.text = 'banana bread'
+      @banana_bread_tab.link_path = '/breads/banana-bread'
+      @banana_bread_tab.visible_when = true
+      @banana_bread_tab.enabled_when = true
+      @banana_bread_tab.add_active_actions('breads', 'banana_bread')
+      @tabset.add_tab(@banana_bread_tab)
+    end
+
+  end
+end

data/tabulous.gemspec

@@ -20,9 +20,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "capybara", "~> 2.0.2"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 2.13"
-  if RUBY_VERSION < "1.9"
-    s.add_development_dependency "redgreen"
-  end
   s.add_development_dependency "launchy"
   s.add_development_dependency "diffy"
   s.add_development_dependency 'sqlite3', '>= 1.3.7'