logical_tabs 0.8.0

data/lib/logical_tabs/tabbed_panel.rb

@@ -0,0 +1,98 @@
+require 'logical_tabs/tab_pane'
+
+module LogicalTabs
+  class DuplicateTabID < Exception
+  end
+
+  # a collection of tabs with their associated panes, I.E. a tabbed panel
+  class TabbedPanel
+    attr_reader :tabs, :base_id
+
+    # view must be an instance of ActionView::Base.   This class
+    # depends on it for access to the capture and content_tag methods
+    def initialize(view, options = {})
+      @view = view
+      @tabs = []
+      @base_id = options[:base_id] || build_generic_id(options)
+    end
+
+    def build_generic_id(options)
+      base_id = "tabbed_panel".html_safe
+      base_id += "_#{options[:seq]}".html_safe if options[:seq]
+      base_id
+    end
+
+    # Add a new tab (with pane) to this tabbed panel.   Either pass
+    # a block with the content for the panel, or pass :content => 'my_content'.
+    #
+    # Name is required and serves as the internal identifier for the tab.  By
+    # default, it is also the displayed text of the tab.
+    #
+    #
+    # Other options:
+    #   :base_id  The string used as the beginning of the ID for CSS
+    #             IDs for the tab and pane.  :base_id => 'foo' will
+    #             generate a tab with ID 'foo_tab' and a panel with ID
+    #             'foo_panel'.  Defaults to name.downcase
+    #
+    #   :tab_text The text to display in the tab.  Defaults to name.
+    #
+    #   :content  The content for the panel itself, in HTML
+    def add_tab(name, options = {},  &block)
+      # debugger
+      options[:content] ||= v.capture(&block)
+      tab = TabPane.new(self, name, options)
+      if @tabs.any?{ |t| t.base_id == tab.base_id }
+        raise DuplicateTabID
+      else
+        @tabs << tab
+      end
+      return nil
+    end
+
+    # Render a UL containing all the tabs as LIs.   Which tab is
+    # shown as selected is determined by the return value of selected?
+    def render_tabs
+      v.content_tag(:ul,
+        @tabs.map{ |tab| tab.render_tab(selected?(tab)) }.join.html_safe,
+        :class => 'tabs'.html_safe
+      ).html_safe
+    end
+
+    # Render a sequence of DIVs containing the panes.
+    def render_panes
+      v.content_tag(:div,
+        @tabs.map{ |tab| tab.render_pane(selected?(tab)) }.join.html_safe,
+        :class => 'panes'.html_safe
+      ).html_safe
+    end
+
+    # render the entire tabbed panel and all contents.
+    def render
+      out = v.content_tag(:div,
+        render_tabs + render_panes,
+        :id => @base_id.to_s.html_safe,
+        :class => 'tabbed_panel'.html_safe
+      ).html_safe
+      out
+    end
+
+    # For the moment, the first tab is the one selected
+    def selected_tab
+      @tabs.first
+    end
+
+    def selected?(tab)
+      tab == selected_tab
+    end
+
+    # returns the array of TabPanes
+    def tabs
+      @tabs
+    end
+
+    # shortcut to the View
+    def v; @view end
+
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: logical_tabs
+version: !ruby/object:Gem::Version 
+  hash: 63
+  prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
+platform: ruby
+authors: 
+- Evan Dorn
+- Judson Lester
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "    LogicalTabs assists in the creation of a tabbed panel UI for Rails apps\n    with several advantages.   A Rails helper generates the tedious (but\n    semantically clean) HTML structures for you.  Tab selection persists across\n    page loads, the page is functional when JavaScript and/or CSS are\n    unavaliable.  Sensible default print styling allows printouts\n    to show all the panel content.  JavaScript is provided for use with\n    either jQuery or Prototype.\n"
+email: evan@lrdesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/generators/logical_tabs/install/install_generator.rb
+- lib/generators/logical_tabs/install/templates/javascripts/logical_tabs_jquery.js
+- lib/generators/logical_tabs/install/templates/javascripts/logical_tabs_prototype.js
+- lib/generators/logical_tabs/install/templates/stylesheets/logical_tabs.css
+- lib/generators/logical_tabs/install/templates/stylesheets/sass/logical_tabs.sass
+- lib/logical_tabs/helper.rb
+- lib/logical_tabs/tab_pane.rb
+- lib/logical_tabs/tabbed_panel.rb
+- lib/logical_tabs.rb
+- doc/README
+has_rdoc: true
+homepage: http://lrdesign.com/tools
+licenses: 
+- MIT
+post_install_message: Another tidy package brought to you by Logical Reality Design
+rdoc_options: []
+
+require_paths: 
+- lib/
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Tabbed panel UI tool for Rails
+test_files: []
+