bettertabs 1.3.6 → 1.4

data/doc/JAVASCRIPTS-DEV-GUIDE.md

@@ -9,11 +9,14 @@ Bettertabs rails helper depends on the jquery.bettertabs plugin to work properly
 The jquery.bettertabs plugin is written using CoffeeScript.
 How to install CoffeeScript: http://jashkenas.github.com/coffee-script/#installation
 
-To install, first make sure you have a working copy of the latest stable version of Node.js, and npm (the Node Package Manager).
+*OR* if you're lazzy and only care about a single compilation, use the online coffee compiler, copy-paste the js code and get back the coffee code, just in the [coffeescript web site](http://jashkenas.github.com/coffee-script/#installation). (if you do this way, please wrap the generated code with `(function() { --code-- }).call(this);`)
+
+To install the coffee comand, first make sure you have a working copy of the latest stable version of Node.js, and npm (the Node Package Manager).
+
 You can then install CoffeeScript with npm:
 
     npm install coffee-script
-    
+
 
 Then you will be able to compile `jquery.bettertabs.js.coffee` into `jquery.bettertabs.js` using the coffee command:
 
@@ -34,4 +37,4 @@ Online compressors:
   * http://refresh-sf.com/yui/
   * http://yui.2clics.net/
   * http://closure-compiler.appspot.com/home
-  * http://compressorrater.thruhere.net/
+  * http://compressorrater.thruhere.net/

data/lib/bettertabs.rb

@@ -1,2 +1,15 @@
+require 'bettertabs/configuration'
 require 'bettertabs/engine'
-require 'bettertabs/bettertabs_builder'
+require 'bettertabs/bettertabs_builder'
+
+module Bettertabs
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/bettertabs/bettertabs_builder.rb

@@ -1,37 +1,48 @@
 class BettertabsBuilder
   require 'uri' # from standard library
-  
+
   TAB_TYPES = [:static, :link, :ajax]
-  
+
   def initialize(bettertabs_id, template, selected_tab_id = nil, options = {})
     @bettertabs_id = bettertabs_id
     @template = template
     @selected_tab_id = selected_tab_id
+    @list_html_options = options.delete(:list_html_options) # sets html_options on the :ul element
     @render_only_active_content = options.delete(:render_only_active_content) # used in ajax calls
     @wrapper_html_options = options
-    
+
     @tabs = []
     @contents = []
   end
-  
+
   # Static tabs generator
   def static(tab_id, *args, &block)
     get_options(args)[:tab_type] = :static
     self.for(tab_id, *args, &block)
   end
-  
+
   # Linked tabs generator
   def link(tab_id, *args, &block)
     get_options(args)[:tab_type] = :link
     self.for(tab_id, *args, &block)
   end
-  
+
   # Ajax tabs generator
   def ajax(tab_id, *args, &block)
     get_options(args)[:tab_type] = :ajax
     self.for(tab_id, *args, &block)
   end
-  
+
+  # No tab generator, to add only content
+  def only_content_block(options = {}, &block)
+    content_html_options = {class: 'content content-only-block'}
+    unless @render_only_active_content
+      content = block_given? ? @template.capture(&block) : @template.render(:partial => options[:partial], :locals => options[:locals])
+      @contents << { content: content, html_options: content_html_options, tab_type: :only_content_block }
+    end
+    nil # returning nil allows the user to call this using <%= tab.only_content_block %> or <% tab.only_content_block %>
+  end
+
   # Generic tab and content generator
   def for(tab_id, *args, &block)
     # Initialize vars and options
@@ -40,25 +51,27 @@ class BettertabsBuilder
     tab_text = get_tab_text(tab_id, args)
     raise "Bettertabs: #{tab_html_id_for(tab_id)} error. Used :partial option and a block of content at the same time." if block_given? and options[:partial]
     partial = options.delete(:partial) || tab_id.to_s unless block_given?
+    raise "Bettertabs: #{tab_html_id_for(tab_id)} error. Used :locals option and a block of content at the same time." if block_given? and options[:locals]
+    locals = options.delete(:locals) unless block_given?
     url = options.delete(:url) || @template.params.merge(:"#{@bettertabs_id}_selected_tab" => tab_id)
     tab_type = (options.delete(:tab_type) || :static).to_sym
     raise "Bettertabs: #{tab_type.inspect} tab type not supported. Use one of #{TAB_TYPES.inspect} instead." unless TAB_TYPES.include?(tab_type)
     ajax_url = options.delete(:ajax_url) || url_for_ajax(url) if tab_type == :ajax
     @selected_tab_id ||= tab_id # defaults to first tab
-    
+
     if @render_only_active_content
       if active?(tab_id)
-        @only_active_content = block_given? ? @template.capture(&block) : @template.render(:partial => partial)
+        @only_active_content = block_given? ? @template.capture(&block) : @template.render(:partial => partial, :locals => locals)
       end
     else
       # Tabs
       tab_html_options = options # any other option will be used as tab html_option
       @tabs << { tab_id: tab_id, text: tab_text, url: url, ajax_url: ajax_url, html_options: tab_html_options, tab_type: tab_type, active: active?(tab_id) }
-    
+
       # Content
       content_html_options = { id: content_html_id_for(tab_id), class: "content #{active?(tab_id) ? 'active' : 'hidden'}" }
       if active?(tab_id) or tab_type == :static # Only render content for selected tab (static content is always rendered).
-        content = block_given? ? @template.capture(&block) : @template.render(:partial => partial)
+        content = block_given? ? @template.capture(&block) : @template.render(:partial => partial, :locals => locals)
       else
         content = ''
       end
@@ -66,7 +79,7 @@ class BettertabsBuilder
     end
     nil # returning nil allows the user to call this using <%= tab.for :xxx %> or <% tab.for :xxx %>
   end
-  
+
   # Renders the bettertabs markup.
   # The following instance variables are available:
   # * @tabs: list of tabs. Each one is a hash with the followin keys:
@@ -90,16 +103,19 @@ class BettertabsBuilder
     if @render_only_active_content
       @only_active_content.html_safe
     else
-    
+
       # Wrapper
       @wrapper_html_options ||= {}
       @wrapper_html_options[:"data-initial-active-tab-id"] = tab_html_id_for @selected_tab_id
-      tag(:div, @wrapper_html_options) do
-      
+      content_tag(:div, @wrapper_html_options) do
+
         # Tabs list
-         tag(:ul, class: 'tabs') do
+         @list_html_options ||= {}
+         @list_html_options[:class] ||= ''
+         @list_html_options[:class] += @list_html_options[:class].empty? ? 'tabs' : ' tabs'
+         content_tag(:ul, @list_html_options) do
            @tabs.map do |tab|
-             tag(:li, class: ('active' if tab[:active]), id: tab_html_id_for(tab[:tab_id])) do
+             content_tag(:li, class: ('active' if tab[:active]), id: tab_html_id_for(tab[:tab_id])) do
                tab[:html_options][:"data-tab-type"] ||= tab[:tab_type] # for javascript: change click behavior depending on type :static, :link or :ajax
                tab[:html_options][:"data-show-content-id"] ||= content_html_id_for(tab[:tab_id]) # for javascript: element id to show when select this tab
                tab[:html_options][:"data-ajax-url"] ||= tab[:ajax_url] if tab[:tab_type] == :ajax # for javascript: url to make ajax call
@@ -109,52 +125,52 @@ class BettertabsBuilder
              end
            end.join.html_safe
          end +
-       
+
          # Content sections
          @contents.map do |content|
-           tag(:div, content[:html_options]) do
+           content_tag(:div, content[:html_options]) do
              content[:content] # this should be blank unless content[:active] or content[:tab_type] == :static
            end
          end.join.html_safe
       end.html_safe
-      
+
     end
   end
-  
-  
+
+
   private
-  
+
   # Get the options hash from an array of args. If options are not present, create them and initialize to {}
   def get_options(args)
     args << {} unless args.last.is_a?(Hash)
     args.last
   end
-  
+
   # Get the default name of the tab, from the args list.
   def get_tab_text(tab_id, args)
     String === args.first ? args.first : tab_id.to_s.titleize
   end
-  
+
   # Check if this tab_id is the same as @selected_tab_id
   def active?(tab_id)
     @selected_tab_id.to_s == tab_id.to_s
   end
-  
+
   # Tab html id
   def tab_html_id_for(tab_id)
     "#{tab_id}_#{@bettertabs_id}_tab"
   end
-  
+
   # Content html id
   def content_html_id_for(tab_id)
     "#{tab_id}_#{@bettertabs_id}_content"
   end
-  
-  # Alias of @template.content_tag
-  def tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+
+  # Delegate @template.content_tag
+  def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
     @template.content_tag(name, content_or_options_with_block, options, escape, &block)
   end
-  
+
   # Uses @template.url_for() to create the string url, and then URI.parse to add the ajax=true extra param.
   # This "ajax=true" extra param is important for two reasons:
   #   * It makes easier from the controller to know when a request is ajax or not.
@@ -171,5 +187,5 @@ class BettertabsBuilder
       original_url
     end
   end
-  
-end
+
+end

data/lib/bettertabs/configuration.rb

@@ -0,0 +1,10 @@
+module Bettertabs
+  class Configuration
+    attr_accessor :attach_jquery_bettertabs_inline
+
+    def initialize
+      # defaults
+      @attach_jquery_bettertabs_inline = false
+    end
+  end
+end

data/lib/bettertabs/version.rb

@@ -1,3 +1,3 @@
 module Bettertabs
-  VERSION = "1.3.6"
-end
+  VERSION = "1.4"
+end

data/spec/dummy/app/controllers/bettertabs_controller.rb

@@ -1,24 +1,27 @@
 class BettertabsController < ApplicationController
-  
+
   def static
   end
-  
+
   def link_tab_1
   end
-  
+
   def link_tab_2
   end
-  
+
   def ajax
     render partial: 'ajax' and return if request.xhr?
   end
-  
+
+  def only_content_block
+  end
+
   def mixed
     render partial: 'mixed' and return if request.xhr?
   end
-  
+
   def mixed_with_erb
     render partial: 'tab_content' and return if request.xhr? and params[:erb_test_selected_tab] == 'ajax_tab'
   end
-  
+
 end

data/spec/dummy/app/views/bettertabs/_mixed.html.haml

@@ -3,4 +3,6 @@
     Content for the link tab
   = tab.static :static_tab do
     Content for the static tab
-  = tab.ajax :ajax_tab, partial: 'tab_content'
+  = tab.ajax :ajax_tab, partial: 'tab_content'
+  = tab.only_content_block do
+    This block is always visible (has not tab)

data/spec/dummy/app/views/bettertabs/_tab_content.html.haml

@@ -1 +1,4 @@
-tab_content partial content.
+- if local_assigns.has_key? :local_var
+  = local_var
+- else
+  tab_content partial content.

data/spec/dummy/app/views/bettertabs/mixed_with_erb.html.erb

@@ -5,4 +5,7 @@
   <% end %>
   <%= tab.static :static_tab, partial: 'tab_content' %>
   <%= tab.ajax :ajax_tab, partial: 'tab_content' %>
-<% end %>
+  <%= tab.only_content_block do %>
+    This block is always visible (has not tab)
+  <% end %>
+<% end %>

data/spec/dummy/app/views/bettertabs/only_content_block.html.haml

@@ -0,0 +1,12 @@
+%h2 Testing Content Blocks (that have with no tab) mixed with static tabs
+= bettertabs :static, :class => 'bettertabs example', :list_html_options => {:class => 'list_class'} do |tab|
+  = tab.only_content_block do
+    Content for only_content_block_1
+
+  = tab.static :static_tab_1 do
+    Content for static_tab_1
+
+  = tab.only_content_block :partial => 'tab_content', :locals => {:local_var => 'Content for only_content_block_2'}
+
+  = tab.static :static_tab_2 do
+    Content for static_tab_2

data/spec/dummy/app/views/bettertabs/static.html.haml

@@ -1,7 +1,10 @@
 %h2 Testing static tabs
-= bettertabs :static do |tab|
+= bettertabs :static, :class => 'bettertabs example', :list_html_options => {:class => 'list_class'} do |tab|
+
   = tab.static :static_tab_1 do
     Content for static_tab_1
+
   = tab.static :static_tab_2 do
     Content for static_tab_2
-  = tab.static :tab_content, 'Static Tab 3' # should render partial 'tab_content'
+
+  = tab.static :tab_content, 'Static Tab 3', :locals => {:local_var => 'Content for static_tab_3'} # should render partial 'tab_content'

data/spec/dummy/app/views/layouts/application.html.erb

@@ -14,13 +14,14 @@
   <%= link_to 'see code in Github', 'http://github.com/agoragames/bettertabs/tree/master/spec/dummy' %></br>
   For this demo, the hidden content is shown inside a dashed border to see what is loaded when you click a tab,</br>
   click on the links below to see different types of tabs (static, link or ajax).
-  
+
 </p>
 <div class="nav">
-  <%= link_to 'static', { action: 'static'}, title: 'Using only static tabs' %> | 
-  <%= link_to 'link', { action: 'link_tab_1'}, title: 'Using only link tabs' %> | 
-  <%= link_to 'ajax', { action: 'ajax'}, title: 'Using only ajax tabs' %> | 
-  <%= link_to 'mixed', { action: 'mixed'}, title: 'Using static, link and ajax tabs in the same widget' %> | 
+  <%= link_to 'static', { action: 'static'}, title: 'Using only static tabs' %> |
+  <%= link_to 'link', { action: 'link_tab_1'}, title: 'Using only link tabs' %> |
+  <%= link_to 'ajax', { action: 'ajax'}, title: 'Using only ajax tabs' %> |
+  <%= link_to 'content blocks', { action: 'only_content_block'}, title: 'Also content with no tabs' %> |
+  <%= link_to 'mixed', { action: 'mixed'}, title: 'Using static, link and ajax tabs in the same widget' %> |
   <%= link_to 'mixed (erb)', { action: 'mixed_with_erb'}, title: 'Using static, link and ajax tabs in a ERB template' %>
 </div>
 

data/spec/dummy/config/initializers/bettertabs.rb

@@ -0,0 +1,6 @@
+Bettertabs.configure do |config|
+  # Render a Javascript snippet to initialize the tabs automatically after rendering the tabs.
+  # This requires that you include jQuery before the tabs are rendered.
+  # Default: false
+  config.attach_jquery_bettertabs_inline = true
+end

data/spec/requests/bettertabs_spec.rb

@@ -6,11 +6,12 @@
 #    * options can be:
 #       * :selected_tab => tab_id to select by default
 #         * :selected_tab should be overridden with params[:"#{bettertabs_id}_selected_tab"] if present
+#       * :list_html_options => html_options for the :ul element
 #       * any other option is used as wrapper html_options (wrapper is the top-level widget dom element).
 #  * The bettertabs helper should render clear markup:
 #     * A wrapper with class 'bettertabs'
 #     * Tabs markup
-#        * ul.tabs > li > a  
+#        * ul.tabs > li > a
 #        * selected tab is ul.tabs > li.active > a
 #        * each a element has element attributes:
 #           * data-tab-type (for javascript: change click behavior depending on type "static", "link" or "ajax")
@@ -34,82 +35,105 @@
 require 'spec_helper'
 
 describe "Bettertabs requests" do
+
   describe "GET /bettertabs/static" do
-    before(:all) { get '/bettertabs/static' } 
-    
+    before(:all) { get '/bettertabs/static' }
+
     it "has a 200 status code" do
       response.status.should be(200)
     end
-    
+
     it "should render all content even for hidden tabs" do
       response.body.should include("Content for static_tab_1")
       response.body.should include("Content for static_tab_2")
-      response.body.should include("tab_content partial content")
+      response.body.should include("Content for static_tab_3")
     end
-    
+
     it "should not include the attribute data-ajax-url in static tabs" do
       response.body.should_not include("data-ajax-url")
     end
+
+    it "should set the requested wrapper class" do
+      response.body.should have_selector("div.bettertabs.example")
+    end
+
+    it "should set the requested list class" do
+      response.body.should have_selector("ul.list_class")
+    end
   end
-  
+
   describe "GET /bettertabs/link_tab_1" do
-    before(:all) { get '/bettertabs/link_tab_1' } 
+    before(:all) { get '/bettertabs/link_tab_1' }
     it "has a 200 status code" do
       response.status.should be(200)
     end
-    
+
     it "should not include the attribute data-ajax-url in link tabs" do
       response.body.should_not include("data-ajax-url")
     end
-    
+
   end
 
   describe "GET /bettertabs/link_tab_2" do
-    before(:all) { get '/bettertabs/link_tab_2' } 
+    before(:all) { get '/bettertabs/link_tab_2' }
     it "has a 200 status code" do
       response.status.should be(200)
     end
   end
 
   describe "GET /bettertabs/ajax" do
-    before(:all) { get '/bettertabs/ajax' } 
+    before(:all) { get '/bettertabs/ajax' }
     it "has a 200 status code" do
       response.status.should be(200)
     end
-    
+
     it "should include the attribute data-ajax-url in ajax tabs" do
       response.body.should include("data-ajax-url")
     end
-    
+
     it "should include the default ajax=true extra param in the data-ajax-url" do
       response.body.should include("data-ajax-url=\"/bettertabs/ajax/ajax_tab_2?ajax=true\"")
     end
-    
+
     it "should render only the selected tab content" do
       response.body.should include("Content for the ajax_tab_1")
       response.body.should_not include("Content for the ajax_tab_2")
     end
-    
+
     it "should select another tab if requested in the URL" do
       get '/bettertabs/ajax?ajax_selected_tab=ajax_tab_2'
       response.body.should_not include("Content for the ajax_tab_1")
       response.body.should include("Content for the ajax_tab_2")
     end
   end
-  
+
+  describe "GET /bettertabs/only_content_block" do
+    before(:all) { get '/bettertabs/only_content_block' }
+
+    it "has a 200 status code" do
+      response.status.should be(200)
+    end
+
+    it "should render all content including content blocks" do
+      response.body.should include("Content for only_content_block_1")
+      response.body.should include("Content for static_tab_1")
+      response.body.should include("Content for only_content_block_2")
+      response.body.should include("Content for static_tab_2")
+    end
+  end
+
   describe "GET /bettertabs/mixed" do
-    before(:all) { get '/bettertabs/mixed' } 
+    before(:all) { get '/bettertabs/mixed' }
     it "has a 200 status code" do
       response.status.should be(200)
     end
   end
-  
+
   describe "GET /bettertabs/mixed_with_erb" do
-    before(:all) { get '/bettertabs/mixed_with_erb' } 
+    before(:all) { get '/bettertabs/mixed_with_erb' }
     it "has a 200 status code" do
       response.status.should be(200)
     end
-  end 
+  end
 
-  
 end