mbleigh-uberkit 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Michael Bleigh and Intridea, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,77 @@
+Uberkit
+=======
+
+The Uberkit is a set of helpers to ease the development of common UI
+practices.
+
+Installation
+------------
+
+Uberkit is available both as a gem and as a traditional plugin. To use
+it as a gem, add this to your environment.rb:
+
+  config.gem 'mbleigh-uberkit', :lib => 'uberkit', :source => 'http://gems.github.com/'
+  
+To install it as a plugin (Rails 2.1 or later):
+
+  script/plugin install git://github.com/mbleigh/uberkit.git
+  
+UberMenu
+--------
+
+UberMenu is the simplest way to generate the markup for CSS menus,
+including state representation and special hooks for cross-browser
+advanced CSS needs.
+
+=== Basic Example
+
+<% ubermenu do |m| %>
+  <% m.action 'Home', '/' %>
+  <% m.action 'Users', users_path %>
+  <% m.action 'Log Out', logout_path, :class => "special" %>
+<% end %>
+
+Becomes...
+
+<ul>
+  <li class="first current first_current"><a href="/">Home</a></li>
+  <li><a href="/users">Users</a></li>
+  <li class="special last"><a href="/logout">Log Out</a></li>
+</ul>
+
+=== Submenus
+
+You can nest ubermenus for subnavigation using the 'submenu' method.
+If you pass :delegate instead of a url to the submenu option, it will
+automatically pick up the url of the first action in the submenu instead.
+
+<% ubermenu 'nav' do |m| %>
+  <% m.action 'Home', home_path %>
+  <% m.submenu 'Services', services_home_path do |s| %>
+    <% s.action 'Service A', service_path('a') %>
+    <% s.action 'Service B', service_path('b') %>
+  <% end %>
+<% end %>
+
+=== State
+
+UberMenus automatically retain state using the current_page? helper.
+You can specify further by passing a :current boolean expression to 
+evaluate whether or not the menu item is selected:
+
+<% ubermenu 'nav' do |m| %>
+  <% m.action 'Users', users_path, :current => controller.controller_name == 'users' %>
+<% end %>
+
+=== Method Listing
+
+* action - like link_to with additional options (see below)
+    :current - a boolean expression to determine whether this menu option is selected,
+        works with current_page? (if current_page? is true this will be true regardless)
+    :force_current - boolean expression that ignores the current_page?
+    :disabled - adds 'disabled' to class and forces non-current
+* remote_action - like link_to_remote
+* custom_action - only builds the outer <li>, accepts block for contents
+* submenu - accepts a block yielding a new menu object
+
+Copyright (c) 2008 Michael Bleigh and Intridea, Inc., released under the MIT license

data/lib/uberkit/displayer.rb

@@ -0,0 +1,15 @@
+module Uberkit
+  class Displayer
+    include ActionView::Helpers::CaptureHelper
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::TagHelper
+
+    def initialize(template)
+      @template = template
+    end
+
+    def is_haml?
+      false
+    end
+  end
+end

data/lib/uberkit/menu.rb

@@ -0,0 +1,82 @@
+module Uberkit
+  module Menu
+    def ubermenu(options = {}, &block)
+      nav = NavigationMenu.new(self,options)
+      yield nav
+      concat(nav.to_html, block.binding) if nav.actions.any?
+    end
+
+    class NavigationMenu < Uberkit::Displayer
+      def initialize(template,options = {})
+        super(template)
+        @actions = []
+        @subnavs = []
+        @id = options.delete(:id)
+        @class_name = options.delete(:class)
+      end
+
+      def action_wrapper(contents, options = {}, url_for_options = {})
+        classes = Array.new        
+        classes << "first" if @actions.first == [contents, options, url_for_options]
+        classes << "last" if @actions.last == [contents, options, url_for_options]
+        classes << "current" if merits_current?(contents,options,url_for_options)
+        classes << "disabled" if options.delete(:disabled)    
+        classes << classes.join("_") if classes.size > 1
+        content_tag(:li, contents, :class => classes.join(" "))
+      end
+
+      def merits_current?(contents,options={},url_for_options={})
+        if options[:force_current]
+          return true if options.delete(:current) == true && !options[:disabled]
+        else
+          return true if (options.delete(:current) == true || (!url_for_options.is_a?(Symbol) && (@template.current_page?(url_for_options)) && url_for_options != {}) and !options[:disabled])
+        end
+         false
+      end
+
+      def action(name, options = {}, html_options = {})
+        wrapper_options = { :current => html_options.delete(:current), :disabled => html_options.delete(:disabled), :force_current => html_options.delete(:force_current), :url => options }
+        @actions << [@template.link_to(name,options,html_options), wrapper_options, options]
+      end
+
+      def actions
+        @actions
+      end
+
+      def remote_action(name, options = {}, html_options = {})
+        wrapper_options = { :current => options.delete(:current), :disabled => options.delete(:disabled), :force_current => options.delete(:force_current), :url => options[:url] }
+        @actions << [@template.link_to_remote(name,options,html_options), wrapper_options, options[:url]]
+      end
+
+      def custom_action(options = {}, &block)
+        options[:force_current] = true
+        @actions << [capture(&block), options, {}]
+      end
+
+      def submenu(name, options = {}, html_options = {}, &block)
+        subnav = NavigationMenu.new(@template,html_options)
+        @subnavs << subnav
+        yield subnav
+
+        if subnav.actions.any?
+          if options == :delegate
+            @actions << [@template.link_to(name, subnav.actions.first[1][:url]) + subnav.to_html, {:current => subnav.any_current?, :url => subnav.actions.first[1][:url]}, options]
+          else
+            @actions << [@template.link_to(name,options,html_options) + subnav.to_html, {:current => subnav.any_current?, :url => options}, options] if subnav.actions.any?
+          end
+        end
+      end
+
+      def any_current?
+        @actions.select{|a| merits_current?(*a)}.any?
+      end
+
+      def build
+        content_tag :ul, @actions.collect{|a| action_wrapper(*a)}.join("\n"),
+                    :id => @id,
+                    :class => @class_name
+      end
+      alias :to_html :build
+    end
+  end
+end

data/lib/uberkit.rb

@@ -0,0 +1,2 @@
+require 'uberkit/displayer'
+require 'uberkit/menu'

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'uberkit'
+
+ActionView::Base.send :include, Uberkit::Menu

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: mbleigh-uberkit
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: UberKit is a set of tools for common UI problems in Rails including menus.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- lib/uberkit/displayer.rb
+- lib/uberkit/menu.rb
+- lib/uberkit.rb
+- rails/init.rb
+has_rdoc: false
+homepage: http://www.actsascommunity.com/projects/uberkit
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails plugin for a common set of UI tools and helpers for building interfaces.
+test_files: []
+