tabulous 1.3.2 → 2.0.0

data/lib/tabulous/config.rb

@@ -0,0 +1,59 @@
+module Tabulous
+  class Config
+    class << self
+
+      attr_reader :renderer,
+                  :active_tab_clickable,
+                  :when_action_has_no_tab,
+                  :render_subtabs_when_empty,
+                  :use_css_scaffolding,
+                  :background_color,
+                  :text_color,
+                  :active_tab_color,
+                  :hover_tab_color,
+                  :inactive_tab_color,
+                  :inactive_text_color
+
+      attr_writer :active_tab_clickable,
+                  :render_subtabs_when_empty,
+                  :use_css_scaffolding,
+                  :background_color,
+                  :text_color,
+                  :active_tab_color,
+                  :hover_tab_color,
+                  :inactive_tab_color,
+                  :inactive_text_color
+
+      def set_defaults
+        @renderer = :default
+        @active_tab_clickable = true
+        @when_action_has_no_tab = :do_not_render
+        @render_subtabs_when_empty = false
+        @use_css_scaffolding = false
+        @background_color = '#ccc'
+        @text_color = '#444'
+        @active_tab_color = '#fff'
+        @hover_tab_color = '#ddd'
+        @inactive_tab_color = '#aaa'
+        @inactive_text_color = '#888'
+      end
+
+      def renderer=(val)
+        unless val.is_a?(String) || val.is_a?(Symbol)
+          raise ImproperValueError, "renderer must be a string or a symbol"
+        end
+        @renderer = val
+      end
+
+      def when_action_has_no_tab=(val)
+        unless [:do_not_render, :render, :raise_error].include?(val)
+          raise ImproperValueError, "when_action_has_no_tab must be either :render, :do_not_render, or :raise_error"
+        end
+        @when_action_has_no_tab = val
+      end
+
+    end
+  end
+end
+
+Tabulous::Config.set_defaults

data/lib/tabulous/css_scaffolding.rb

@@ -1,111 +1,114 @@
 module Tabulous
-  def self.embed_styles
-    return '' unless @@css.scaffolding
-    %Q{
-      <style type="text/css">
-      
-      body {
-        margin: 0;
-        padding: 0;
-      }
-      
-      #tabs, #tabs ul, #tabs ul li, #tabs ul li span, #tabs ul li a,
-      #subtabs, #subtabs ul, #subtabs ul li, #subtabs ul li span, #subtabs ul li a {
-        margin: 0;
-        padding: 0;
-        line-height: 1;
-      }
-
-      #tabs, #tabs a, #tabs a:visited, #tabs a:hover {
-        color: #{@@css.text_color};
-      }
-
-      #tabs li.disabled, #tabs li.disabled a, #tabs li.disabled a:visited, #tabs li.disabled a:hover,
-      #subtabs li.disabled, #subtabs li.disabled a, #subtabs li.disabled a:visited, #subtabs li.disabled a:hover {
-        color: #{@@css.inactive_text_color};
-      }
-
-      #tabs a {
-        text-decoration: none;
-      }
-
-      #tabs ul {
-        font-size: 24px;
-        height: 57px;
-        list-style-type: none;
-        background-color: #{@@css.background_color};
-        padding: 0 0 0 50px;
-      }
-
-      #tabs ul li {
-        padding-top: 25px;
-        padding-right: 5px;
-        float: left;
-      }
-
-      #tabs ul li .tab {
-        background-color: #{@@css.inactive_tab_color};
-        padding: 5px 15px 3px 15px;
-        float: left;
-      	-webkit-border-top-left-radius: 8px;
-      	-khtml-border-radius-topleft: 8px;	
-      	-moz-border-radius-topleft: 8px;
-      	border-top-left-radius: 8px;
-      	-webkit-border-top-right-radius: 8px;
-      	-khtml-border-radius-topright: 8px;	
-      	-moz-border-radius-topright: 8px;
-      	border-top-right-radius: 8px;
-      }
-
-      #tabs ul li.active .tab {
-        background-color: #{@@css.active_tab_color};
-        padding-bottom: 14px;
-      }
-
-      #tabs ul li a:hover {
-        background-color: #{@@css.hover_tab_color};
-      }
-
-      #tabs ul {
-        /* float clearing */
-        overflow: hidden;
-        display: inline-block; /* Necessary to trigger "hasLayout" in IE */
-        display: block; /* Sets element back to block */
-      }
-
-      #subtabs ul {
-        margin-top: 5px;
-      }
-
-      #subtabs, #subtabs a, #subtabs a:visited {
-        color: #{@@css.text_color};
-      }
-
-      #subtabs li.active {
-        font-weight: bold;
-      }
-
-      #subtabs a {
-        text-decoration: none;
-      }
-
-      #subtabs ul {
-        font-size: 16px;
-        height: 30px;
-        list-style-type: none;
-        padding: 0 0 0 50px;
-      }
-
-      #subtabs ul li {
-        padding: 10px;
-        float: left;
-      }
-
-      #subtabs ul li a:hover {
-        text-decoration: underline;
-      }
+  class CssScaffolding
+
+    def self.embeddable_styles
+      %Q{
+        <style type="text/css">
+
+        body {
+          margin: 0;
+          padding: 0;
+        }
+
+        .tabs, .tabs ul, .tabs ul li, .tabs ul li span, .tabs ul li a,
+        .subtabs, .subtabs ul, .subtabs ul li, .subtabs ul li span, .subtabs ul li a {
+          margin: 0;
+          padding: 0;
+          line-height: 1;
+        }
+
+        .tabs, .tabs a, .tabs a:visited, .tabs a:hover {
+          color: #{Config.text_color};
+        }
+
+        .tabs li.disabled, .tabs li.disabled a, .tabs li.disabled a:visited, .tabs li.disabled a:hover,
+        .subtabs li.disabled, .subtabs li.disabled a, .subtabs li.disabled a:visited, .subtabs li.disabled a:hover {
+          color: #{Config.inactive_text_color};
+        }
+
+        .tabs a {
+          text-decoration: none;
+        }
+
+        .tabs ul {
+          font-size: 24px;
+          height: 57px;
+          list-style-type: none;
+          background-color: #{Config.background_color};
+          padding: 0 0 0 50px;
+        }
+
+        .tabs ul li {
+          padding-top: 25px;
+          padding-right: 5px;
+          float: left;
+        }
+
+        .tabs ul li .tab {
+          background-color: #{Config.inactive_tab_color};
+          padding: 5px 15px 3px 15px;
+          float: left;
+          -webkit-border-top-left-radius: 8px;
+          -khtml-border-radius-topleft: 8px;
+          -moz-border-radius-topleft: 8px;
+          border-top-left-radius: 8px;
+          -webkit-border-top-right-radius: 8px;
+          -khtml-border-radius-topright: 8px;
+          -moz-border-radius-topright: 8px;
+          border-top-right-radius: 8px;
+        }
+
+        .tabs ul li.active .tab {
+          background-color: #{Config.active_tab_color};
+          padding-bottom: 14px;
+        }
+
+        .tabs ul li a:hover {
+          background-color: #{Config.hover_tab_color};
+        }
+
+        .tabs ul {
+          /* float clearing */
+          overflow: hidden;
+          display: inline-block; /* Necessary to trigger "hasLayout" in IE */
+          display: block; /* Sets element back to block */
+        }
+
+        .subtabs ul {
+          margin-top: 5px;
+        }
+
+        .subtabs, .subtabs a, .subtabs a:visited {
+          color: #{Config.text_color};
+        }
+
+        .subtabs li.active {
+          font-weight: bold;
+        }
+
+        .subtabs a {
+          text-decoration: none;
+        }
+
+        .subtabs ul {
+          font-size: 16px;
+          height: 30px;
+          list-style-type: none;
+          padding: 0 0 0 50px;
+        }
+
+        .subtabs ul li {
+          padding: 10px;
+          float: left;
+        }
+
+        .subtabs ul li a:hover {
+          text-decoration: underline;
+        }
+
+        </style>
+      }
+    end
 
-      </style>
-    }
   end
 end

data/lib/tabulous/dsl/config.rb

@@ -0,0 +1,17 @@
+module Tabulous
+  module Dsl
+    class Config
+      class << self
+
+        def process(&block)
+          instance_exec(&block)
+        end
+
+        def method_missing(method, *args, &block)
+          ::Tabulous::Config.send("#{method}=", *args)
+        end
+
+      end
+    end
+  end
+end

data/lib/tabulous/dsl/setup.rb

@@ -0,0 +1,31 @@
+module Tabulous
+  module Dsl
+    class Setup
+      class << self
+
+        def process(&block)
+          instance_exec(OldVersionChecker.new, &block)
+        end
+
+        def customize(&block)
+          Dsl::Config.process(&block)
+        end
+
+        def use_css_scaffolding(&block)
+          ::Tabulous::Config.use_css_scaffolding = true
+          Dsl::Config.process(&block) if block_given?
+        end
+
+        def tabs(tabset_name = :default, &block)
+          tabset = Dsl::Tabs.process(&block)
+          Tabsets.add(tabset_name, tabset)
+        end
+
+        def method_missing(method, *args, &block)
+          raise UnknownDeclarationError, "Unknown declaration '#{method}'. Valid declarations here are tabs, customize, and use_css_scaffolding."
+        end
+
+      end
+    end
+  end
+end

data/lib/tabulous/dsl/tab.rb

@@ -0,0 +1,86 @@
+require 'ostruct'
+
+module Tabulous
+  module Dsl
+    class Tab
+      class << self
+
+        def process(name, parent_tab, &block)
+          @tab = ::Tabulous::Tab.new
+          @tab.name = name.to_s
+          if parent_tab
+            @tab.kind = :subtab
+            @tab.parent = parent_tab
+          end
+          @called = []
+          instance_exec(&block)
+          check_for_errors!
+          @tab
+        end
+
+        def text(val = nil, &block)
+          @called << :text
+          @tab.text = block_given? ? block : val
+        end
+
+        def link_path(val = nil, &block)
+          @called << :link_path
+          @tab.link_path = block_given? ? block : val
+        end
+
+        def visible_when(val = nil, &block)
+          @called << :visible_when
+          @tab.visible_when = block_given? ? block : val
+        end
+
+        def enabled_when(val = nil, &block)
+          @called << :enabled_when
+          @tab.enabled_when = block_given? ? block : val
+        end
+
+        def active_when(&block)
+          @called << :active_when
+          instance_exec(&block)
+        end
+
+        def a_subtab_is_active
+          @tab.declared_to_have_subtabs = true
+        end
+
+        def in_actions(*actions)
+          @active_mediator = OpenStruct.new
+          @active_mediator.this = self
+          @active_mediator.actions = actions
+          def @active_mediator.of_controller(controller)
+            self.controller = controller
+            self.this.send(:register_rule)
+          end
+          @active_mediator
+        end
+
+        def in_action(action)
+          in_actions(action)
+        end
+
+        def method_missing(method, *args, &block)
+          raise UnknownDeclarationError, "Unknown declaration '#{method}'."
+        end
+
+      private
+
+        def check_for_errors!
+          [:text, :link_path, :visible_when, :enabled_when, :active_when].each do |advice|
+            if !@called.include?(advice)
+              raise MissingDeclarationError, "Missing '#{advice}' in tab #{@tab.name}."
+            end
+          end
+        end
+
+        def register_rule
+          @tab.add_active_actions(@active_mediator.controller, @active_mediator.actions)
+        end
+
+      end
+    end
+  end
+end

data/lib/tabulous/dsl/tabs.rb

@@ -0,0 +1,59 @@
+module Tabulous
+  module Dsl
+    class Tabs
+      class << self
+
+        def process(&block)
+          @tabset = Tabset.new
+          @parent_tab = nil
+          instance_exec(&block)
+          check_for_errors!
+          @tabset
+        end
+
+        def method_missing(method, *args, &block)
+          method_name = method.to_s
+          if method_name =~ /^(.+)_subtab/
+            if @parent_tab.nil?
+              raise SubtabOutOfOrderError, "You cannot start a tabs declaration with a subtab: '#{method_name}'."
+            end
+            tab = Dsl::Tab.process($1, @parent_tab, &block)
+          elsif method_name =~ /^(.+)_tab/
+            tab = Dsl::Tab.process($1, nil, &block)
+            @parent_tab = tab
+          else
+            raise TabNameError, "Incorrect tab name: '#{method_name}'.  Tab names must end with _tab or _subtab."
+          end
+          @tabset.add_tab(tab)
+        end
+
+      private
+
+        def check_for_errors!
+          check_for_missing_subtab_declaration
+          check_for_conflicting_active_actions
+        end
+
+        def check_for_missing_subtab_declaration
+          for tab in @tabset.primary_tabs
+            if !tab.subtabs.empty? && tab.declared_to_have_subtabs == false
+              raise MissingActiveTabRuleError, "The tab '#{tab.name}' has subtabs but is missing the 'a_subtab_is_active' rule in its active_when declaration."
+            end
+          end
+        end
+
+        def check_for_conflicting_active_actions
+          for tab in @tabset.tabs
+            for other_tab in @tabset.tabs
+              next if tab == other_tab
+              if tab.active_actions_overlap?(other_tab)
+                raise AmbiguousActiveTabRulesError, "Ambiguous declaration: the active_when rules in the tab #{tab.name} conflict with the active_when rules in the tab #{other_tab.name}."
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/tabulous/errors.rb

@@ -7,10 +7,15 @@ module Tabulous
     end
   end
 
-  class ColumnError < TabulousError; end
-  class NoTabFoundError < TabulousError; end
-  class UnknownTabError < TabulousError; end
+  class SubtabOutOfOrderError < TabulousError; end
+  class MissingDeclarationError < TabulousError; end
+  class UnknownDeclarationError < TabulousError; end
   class TabNameError < TabulousError; end
-  class FormattingError < TabulousError; end
+  class NoTabFoundError < TabulousError; end
+  class MissingActiveTabRuleError < TabulousError; end
+  class AmbiguousActiveTabRulesError < TabulousError; end
+  class ImproperValueError < TabulousError; end
+  class OldVersionError < TabulousError; end
+  class SubtabsHelperNotApplicable < TabulousError; end
 
 end

data/lib/tabulous/old_version_checker.rb

@@ -0,0 +1,23 @@
+module Tabulous
+  class OldVersionChecker
+
+    # The old version of the tabulous.rb file starts like this:
+    #
+    #   Tabulous.setup do |config|
+    #
+    # The new version starts like this:
+    #
+    #   Tabulous.setup do
+    #
+    # This class is a dummy class that will intercept any methods sent to
+    # the config object if the tabulous.rb file is using the old format.
+    #
+    def method_missing(meth, *args, &block)
+      msg = "It looks like your tabulous.rb file is written for an "
+      msg << "old version of tabulous. This newer version of tabulous "
+      msg << "uses a new syntax that is not backwards-compatible."
+      raise OldVersionError, msg
+    end
+
+  end
+end

data/lib/tabulous/railtie.rb

@@ -3,11 +3,8 @@ require 'rails'
 
 module Tabulous
   class Railtie < Rails::Railtie
-    rake_tasks do
-      load "tasks/tabulous.rake"
-    end
-    initializer 'tabulous.helper' do |app|  
-      ActionView::Base.send :include, Tabulous::Helpers
+    initializer 'tabulous.helper' do |app|
+      ActionView::Base.send :include, Tabulous::ViewHelpers
     end
     config.to_prepare do
       filename = File.join(Rails.root.to_s, 'app/tabs/tabulous.rb')

data/lib/tabulous/renderers/bootstrap_pill_renderer.rb

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

data/lib/tabulous/renderers/bootstrap_renderer.rb

@@ -0,0 +1,68 @@
+require 'active_support/core_ext/string'
+
+module Tabulous
+  class BootstrapRenderer < CombinedRenderer
+
+    def tabs_html
+      <<-HTML.strip_heredoc
+        <ul class="nav nav-tabs">
+          #{ tab_list_html }
+        </ul>
+      HTML
+    end
+
+  protected
+
+    def tab_html(tab)
+      return '' unless tab.visible?(@view)
+      html = ''
+      klass = ''
+      klass << 'active' if tab.active?(@view)
+      klass << ' disabled' unless tab.enabled?(@view)
+      klass << ' dropdown' if tab.subtabs.any?
+      klass.strip!
+      if klass.empty?
+        html << '<li>'
+      else
+        html << %Q{<li class="#{klass}">}
+      end
+      if tab.subtabs.empty?
+        html << tab_link(tab)
+      else
+        html << tab_link_with_subtabs(tab)
+      end
+      html << "</li>"
+      html
+    end
+
+    def tab_link(tab)
+      html = ''
+      if tab.clickable?(@view) && tab.enabled?(@view)
+        html << %Q{<a href="#{tab.link_path(@view)}">#{tab.text(@view)}</a>}
+      else
+        html << %Q{<a>#{tab.text(@view)}</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{<ul class="dropdown-menu">}
+      for subtab in tab.subtabs
+        next unless subtab.visible?(@view)
+        klass = (subtab.enabled?(@view) ? '' : 'disabled')
+        if klass.empty?
+          html << '<li>'
+        else
+          html << %Q{<li class="#{klass}">}
+        end
+        html << tab_link(subtab)
+        html << "</li>"
+      end
+      html << "</ul>"
+      html
+    end
+
+  end
+end

data/lib/tabulous/renderers/combined_renderer.rb

@@ -0,0 +1,44 @@
+# A "combined" renderer is one that renders subtab HTML directly inside the
+# HTML list of tabs, rather than two separate HTML lists for tabs and subtabs.
+#
+# This class is meant to be subclassed.  It encapsulates the code
+# common to all combined renderers so that it doesn't have to be recoded
+# everytime.
+
+module Tabulous
+  class CombinedRenderer
+
+    def initialize(tabset, view)
+      @view = view
+      @tabset = tabset
+    end
+
+    def tabs_html
+      raise "override me"
+    end
+
+    def subtabs_html
+      msg = "You have called the subtabs view helper. "
+      msg << "However, the renderer that you've chosen does not support "
+      msg << "this view helper, since this renderer renders subtabs when "
+      msg << "the tabs helper is called. Simply remove the call to "
+      msg << "subtabs to fix this error."
+      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