tabulous 2.0.0 → 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 2.1.0 (Nov 9, 2013)
+* Added http_verb tab declaration to support non-GET actions, like sign out links.
+* Added renderer that generates HTML compatible with Bootstrap 3's navbar.
+* Documentation tweaks.
+* Added better float-clearing styles in CSS scaffolding.
+
 ### 2.0.0 (May 12, 2013)
 * Introduced a completely new, non-backwards-compatible syntax for app/tabs/tabulous.rb.
 * You can have more than one tab navigation bar on the same page.

data/CHANGES_FROM_VERSION_ONE.md

@@ -19,6 +19,7 @@ There are three reasons this syntax was abandoned:
 * You can have more than one tab navigation bar on the same page.
 * You can easily customize the generated tab markup.
 * Namespaced controllers are now fully supported.
+* You can now customize the HTTP verb of a tab link.
 
 ## Changes
 

data/OVERVIEW.md

@@ -130,7 +130,7 @@ This creates app/tabs/tabulous.rb.  The generator guesses what your tabs might l
 
 Tabs are displayed in the order they appear.  So if you want a set of tabs that looks like this:
 
-     ,____________, ,____________, ,__________,
+      ____________   ____________   __________
     _|  UNICORNS  |_|  RAINBOWS  |_|  PONIES  |_
 
 your tabs block should look like this:
@@ -161,7 +161,7 @@ Let's say you wanted the unicorns tab to:
 
 * take you to '/unicorns' when clicked
 * be visible only if the user loves unicorns
-* be disabled if it's May
+* be enabled only if it's May
 * and be active whenever the UnicornsController ends up rendering the page.
 
 Your tab declaration would look like this:

data/README.md

@@ -1,6 +1,6 @@
 # Tabulous
 
-## Description
+[![Code Climate](https://codeclimate.com/github/techiferous/tabulous.png)](https://codeclimate.com/github/techiferous/tabulous)
 
 Tabulous provides an easy way to add tabs to your Rails application.
 
@@ -14,4 +14,3 @@ Tabulous works with Rails 3.0, 3.1, 3.2 and 4.0.  It has been tested on MRI Ruby
 * [CHANGES FROM VERSION ONE](CHANGES_FROM_VERSION_ONE.md) -- if you've been using version one of tabulous, read this
 * [REFERENCE](REFERENCE.md) -- complete documentation on the usage of tabulous
 * [CONTRIBUTING](CONTRIBUTING.md) -- if you want to help out
-

data/REFERENCE.md

@@ -10,6 +10,7 @@
 * [Tab Declarations](#tab-declarations)
     * [text](#text)
     * [link_path](#link_path)
+    * [http_verb](#http_verb)
     * [visible_when](#visible_when)
     * [enabled_when](#enabled_when)
     * [active_when](#active_when)
@@ -62,17 +63,17 @@ You can have more than one tabset on a page by passing in a name to the tabs blo
 
 Then, in your layout, you need to tell tabulous which tabset to draw:
 
-    <%= render tabs(:fun) %>
-    <%= render subtabs(:fun) %>
+    <%= tabs(:fun) %>
+    <%= subtabs(:fun) %>
     <p>some markup</p>
-    <%= render tabs(:colors) %>
-    <%= render subtabs(:colors) %>
+    <%= tabs(:colors) %>
+    <%= subtabs(:colors) %>
 
 ### Tab Order
 
 Tabs are displayed in the order they appear.  So if you want a set of tabs that looks like this:
 
-     ,____________, ,____________, ,__________,
+      ____________   ____________   __________
     _|  UNICORNS  |_|  RAINBOWS  |_|  PONIES  |_
 
 your tabs block should look like this:
@@ -93,7 +94,7 @@ your tabs block should look like this:
 
 ### Subtabs
 
-Any tab can have several subtabs associated with it that become visible when the parent tab is clicked.  Declare subtabs just like tabs, except make sure that their name ends in _subtab.  Subtabs should be declared immediately after their parent tab.  Parent tabs must include a_subtab_is_active in their active_when declaration:
+Any tab can have several subtabs associated with it that become visible when the parent tab is clicked.  Declare subtabs just like tabs, except make sure that their name ends in \_subtab.  Subtabs should be declared immediately after their parent tab.  Parent tabs must include a_subtab_is_active in their active_when declaration:
 
     tabs do
       unicorns_tab do
@@ -139,7 +140,9 @@ It doesn't matter what you call a tab, but it must end in \_tab or \_subtab, and
 
 ## Tab Declarations
 
-Each tab has five declarations that you must specify.  The text, link_path, visible_when and enabled_when declarations do not need to be given a block.  If given a block, the block will be executed in the context of the layout where the tabs are rendered.
+Each tab has five required declarations (text, link_path, visible_when, enabled_when and active_when) and one optional declaration (http_verb).
+
+The text, link_path, visible_when and enabled_when declarations do not need to be given a block.  If given a block, the block will be executed in the context of the layout where the tabs are rendered.
 
 Here is an example of a tab with the five required declarations:
 
@@ -173,6 +176,16 @@ Since a block given to link_path is evaluated in the context of a view layout an
       ...
     end
 
+### http_verb
+
+http_verb is an optional declaration that must be either :get, :post, :put, :patch or :delete.  It defaults to :get.  When http_verb is not :get, a data-method attribute will be added to the tab's anchor tag.  This is useful for adding a "sign out" subtab action link, for example.
+
+    narwhals_tab do
+      ...
+      http_verb :delete
+      ...
+    end
+
 ### visible_when
 
 If visible_when evaluates to false (or a falsy value like nil), the HTML for that particular tab will not be generated.
@@ -255,11 +268,12 @@ This specifies the class that the tabs and subtabs view helpers use to generate
       renderer :default
     end
 
-There are three other renderers you can use:
+There are four other renderers you can use:
 
 * **:html5** -- uses nav tags instead of divs
-* **:bootstrap** -- generates markup compatible with Twitter Bootstrap; it uses the "nav-tabs" class
-* **:bootstrap_pill** -- generates markup compatible with Twitter Bootstrap; it uses the "nav-pills" class
+* **:bootstrap** -- generates markup compatible with Twitter Bootstrap; it creates a ul tag with a "nav-tabs" class
+* **:bootstrap_pill** -- generates markup compatible with Twitter Bootstrap; it creates a ul tag with a "nav-pills" class
+* **:bootstrap_navbar** -- generates markup compatible with Twitter Bootstrap's navbar; it creates a ul tag with a "navbar-nav" class
 
 If this doesn't suit your needs, you can write your own custom renderer.  Here's an example of a custom renderer class:
 
@@ -380,21 +394,21 @@ You should turn off the CSS scaffolding and use your own CSS before launching yo
 
 Tabulous generates HTML for you to place in your layout.  It does this with the following helpers:
 
-    <%= render tabs %>
-    <%= render subtabs %>
+    <%= tabs %>
+    <%= subtabs %>
 
 If you have multiple tabsets, you need to call these helpers for each tabset:
 
-    <%= render tabs(:fun) %>
-    <%= render subtabs(:fun) %>
+    <%= tabs(:fun) %>
+    <%= subtabs(:fun) %>
 
-    <%= render tabs(:colors) %>
-    <%= render subtabs(:colors) %>
+    <%= tabs(:colors) %>
+    <%= subtabs(:colors) %>
 
 Some renderers, like the Twitter Bootstrap renderers, generate markup that has subtabs interspersed within tabs instead of a separate list of tabs and subtabs.  If a renderer does this, it is an error to call the subtabs helper:
 
-    <%= render tabs %>     # always ok
-    <%= render subtabs %>  # DO NOT DO THIS if using a Bootstrap renderer
+    <%= tabs %>     # always ok
+    <%= subtabs %>  # DO NOT DO THIS if using a Bootstrap renderer
 
 ## Generators
 

data/lib/generators/tabs/templates/tabulous.rb

@@ -38,7 +38,7 @@ Tabulous.setup do
     # defaults to true
     # active_tab_clickable true
 
-    # what to do when there is no active tab for the currrent controller action
+    # what to do when there is no active tab for the current controller action
     # :render -- draw the tabset, even though no tab is active
     # :do_not_render -- do not draw the tabset
     # :raise_error -- raise an error

data/lib/tabulous.rb

@@ -15,10 +15,12 @@ require 'tabulous/dsl/tab'
 require 'tabulous/dsl/tabs'
 require 'tabulous/dsl/setup'
 require 'tabulous/rendering_coordinator'
+require 'tabulous/renderers/base_renderer'
 require 'tabulous/renderers/split_renderer'
 require 'tabulous/renderers/combined_renderer'
 require 'tabulous/renderers/default_renderer'
 require 'tabulous/renderers/html5_renderer'
 require 'tabulous/renderers/bootstrap_renderer'
 require 'tabulous/renderers/bootstrap_pill_renderer'
+require 'tabulous/renderers/bootstrap_navbar_renderer'
 require 'tabulous/tabulous'

data/lib/tabulous/css_scaffolding.rb

@@ -67,7 +67,7 @@ module Tabulous
           background-color: #{Config.hover_tab_color};
         }
 
-        .tabs ul {
+        .tabs ul, .subtabs ul {
           /* float clearing */
           overflow: hidden;
           display: inline-block; /* Necessary to trigger "hasLayout" in IE */

data/lib/tabulous/dsl/tab.rb

@@ -28,6 +28,11 @@ module Tabulous
           @tab.link_path = block_given? ? block : val
         end
 
+        def http_verb(val = nil, &block)
+          @called << :http_verb
+          @tab.http_verb = block_given? ? block : val
+        end
+
         def visible_when(val = nil, &block)
           @called << :visible_when
           @tab.visible_when = block_given? ? block : val

data/lib/tabulous/renderers/base_renderer.rb

@@ -0,0 +1,45 @@
+# This holds common behavior for all renderer classes.
+
+module Tabulous
+  class BaseRenderer
+
+    def initialize(tabset, view)
+      @view = view
+      @tabset = tabset
+    end
+
+    # all renderers need to have a tabs_html method that returns the
+    # HTML to be embedded when the <%= tabs %> helper method is called
+    def tabs_html
+      raise "override me"
+    end
+
+  protected
+
+    def tab_html(tab)
+      raise "override me"
+    end
+
+    def tab_list_html
+      html = ''
+      for tab in @tabset.primary_tabs
+        html << tab_html(tab)
+      end
+      html
+    end
+
+    def tab_url(tab)
+      tab.link_path(@view)
+    end
+
+    def tab_http_verb_attributes(tab)
+      return '' if tab.http_verb == :get
+      %Q{data-method="#{tab.http_verb}"}
+    end
+
+    def tab_text(tab)
+      tab.text(@view)
+    end
+
+  end
+end

data/lib/tabulous/renderers/bootstrap_navbar_renderer.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/string'
+
+module Tabulous
+  class BootstrapNavbarRenderer < BootstrapRenderer
+
+    def tabs_html
+      <<-HTML.strip_heredoc
+        <ul class="nav navbar-nav">
+          #{ tab_list_html }
+        </ul>
+      HTML
+    end
+
+  end
+end

data/lib/tabulous/renderers/bootstrap_renderer.rb

@@ -38,16 +38,16 @@ module Tabulous
     def tab_link(tab)
       html = ''
       if tab.clickable?(@view) && tab.enabled?(@view)
-        html << %Q{<a href="#{tab.link_path(@view)}">#{tab.text(@view)}</a>}
+        html << %Q{<a href="#{tab_url(tab)}" #{tab_http_verb_attributes(tab)}>#{tab_text(tab)}</a>}
       else
-        html << %Q{<a>#{tab.text(@view)}</a>}
+        html << %Q{<a>#{tab_text(tab)}</a>}
       end
       html
     end
 
     def tab_link_with_subtabs(tab)
       html = ''
-      html << %Q{<a class="dropdown-toggle" data-toggle="dropdown" href="#">#{tab.text(@view)}<b class="caret"></b></a>}
+      html << %Q{<a class="dropdown-toggle" data-toggle="dropdown" href="#">#{tab_text(tab)}<b class="caret"></b></a>}
       html << %Q{<ul class="dropdown-menu">}
       for subtab in tab.subtabs
         next unless subtab.visible?(@view)

data/lib/tabulous/renderers/combined_renderer.rb

@@ -6,16 +6,7 @@
 # everytime.
 
 module Tabulous
-  class CombinedRenderer
-
-    def initialize(tabset, view)
-      @view = view
-      @tabset = tabset
-    end
-
-    def tabs_html
-      raise "override me"
-    end
+  class CombinedRenderer < BaseRenderer
 
     def subtabs_html
       msg = "You have called the subtabs view helper. "
@@ -26,19 +17,5 @@ module Tabulous
       raise SubtabsHelperNotApplicable, msg
     end
 
-  protected
-
-    def tab_html(tab)
-      raise "override me"
-    end
-
-    def tab_list_html
-      html = ''
-      for tab in @tabset.primary_tabs
-        html << tab_html(tab)
-      end
-      html
-    end
-
   end
 end

data/lib/tabulous/renderers/default_renderer.rb

@@ -38,9 +38,9 @@ module Tabulous
         html << %Q{<li class="#{klass}">}
       end
       if tab.clickable?(@view)
-        html << %Q{<a href="#{tab.link_path(@view)}" class="tab">#{tab.text(@view)}</a>}
+        html << %Q{<a href="#{tab_url(tab)}" class="tab" #{tab_http_verb_attributes(tab)}>#{tab_text(tab)}</a>}
       else
-        html << %Q{<span class="tab">#{tab.text(@view)}</span>}
+        html << %Q{<span class="tab">#{tab_text(tab)}</span>}
       end
       html << "</li>"
       html

data/lib/tabulous/renderers/split_renderer.rb

@@ -9,35 +9,16 @@
 # everytime.
 
 module Tabulous
-  class SplitRenderer
-
-    def initialize(tabset, view)
-      @view = view
-      @tabset = tabset
-    end
-
-    def tabs_html
-      raise "override me"
-    end
+  class SplitRenderer < BaseRenderer
 
+    # all split renderers need to have a subtabs_html method that returns the
+    # HTML to be embedded when the <%= subtabs %> helper method is called
     def subtabs_html
       raise "override me"
     end
 
   protected
 
-    def tab_html(tab)
-      raise "override me"
-    end
-
-    def tab_list_html
-      html = ''
-      for tab in @tabset.primary_tabs
-        html << tab_html(tab)
-      end
-      html
-    end
-
     def subtab_list_html
       html = ''
       for tab in subtabs

data/lib/tabulous/tab.rb

@@ -3,13 +3,14 @@ module Tabulous
 
     attr_reader :parent
     attr_accessor :subtabs, :kind, :name, :declared_to_have_subtabs
-    attr_writer :text, :link_path, :visible_when, :enabled_when
+    attr_writer :text, :link_path, :visible_when, :enabled_when, :http_verb
 
     def initialize
       @subtabs = []
       @active_actions = {}
       @kind = :primary_tab
       @declared_to_have_subtabs = false
+      @http_verb = :get
     end
 
     def parent=(tab)
@@ -46,6 +47,19 @@ module Tabulous
       value
     end
 
+    def http_verb(view=nil)
+      value = if @http_verb.respond_to?(:call)
+        view.instance_exec(&@http_verb)
+      else
+        @http_verb
+      end
+      value = value.to_s.downcase.to_sym
+      unless [:get, :post, :delete, :patch, :put].include?(value)
+        raise ImproperValueError, "The http_verb of tab '#{self.name}' must be :get, :post, :delete, :patch or :put."
+      end
+      value
+    end
+
     def visible?(view=nil)
       if @visible_when.respond_to?(:call)
         view.instance_exec(&@visible_when)

data/lib/tabulous/version.rb

@@ -1,3 +1,3 @@
 module Tabulous
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/script/create_test_app

@@ -20,7 +20,7 @@ if ARGV.size != 2
   puts "Usage: create_test_app [app name] [Rails version]"
   puts "  both arguments are required"
   puts "  app name: the name of an application living in spec/applications"
-  puts "  Rails version: the gem version, such as 3.1.11 or 4.0.0.beta"
+  puts "  Rails version: the gem version, such as 3.1.11 or 4.0.1"
   puts
   puts "  Read spec/applications/README for a full understanding of test apps."
   exit

data/spec/applications/bootstrap/rails_4-0-1/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp