innetra-easy_navigation 0.1.0

data/Manifest

@@ -0,0 +1,5 @@
+Manifest
+README.rdoc
+Rakefile
+init.rb
+lib/easy_navigation.rb

data/README.rdoc

@@ -0,0 +1,76 @@
+= Uniquify
+
+Rails gem/plugin for generating a tabbed navigation for Rails.
+
+== Requirements
+
+This gem/plugin is intented to be used with Rails 2.2 as it uses i18n
+
+== Install
+
+  gem install innetra-easy_navigation --source http://gems.github.com
+
+== Usage
+
+Once installed simply create config/initializers/easy_navigation.rb file like 
+this:
+
+  EasyNavigation::Builder.config do |map|
+    map.navigation :default, :separator => true do |navigation|
+      navigation.tab :home, :url => { :controller => "dashboard", :action => "index" } do |tab|
+        tab.menu :index, :url => { :controller => "dashboard", :action => "index" } do |menu|
+          menu.connect :except => "new" # if :controller not specified it asumes is the same from tab
+        end
+      end
+      navigation.tab :post, :url => { :controller => "posts", :action => "index" } do |tab|
+        tab.menu :index, :url => { :controller => "posts", :action => "index" } do |menu|
+          menu.connect :except => "new"
+        end
+        tab.menu :new, :url => { :controller => "posts", :action => "new" } do |menu|
+          menu.connect :only => "new"
+        end
+        tab.menu :rss, :url => { :controller => "post_rss", :action => "atom" } do |menu|
+          menu.connect :only => "show"
+        end
+      end
+    end
+  end
+
+For internationalization, edit your en.yml file lique this (NOT TESTED JET):
+
+  easy_navigation:
+    default:
+      home:
+        index: "Home"
+        
+
+As an example, to render you newly created menu called :default in your 
+layout/application.erb :
+
+  <% render_navigation :default %>
+
+Pretty easy, right?
+
+== License
+
+Copyright (c) 2008 Ivan Torres, Innetra Consultancy Services, S.C.
+ 
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('easy_navigation', '0.1.0') do |e|
+  e.description    = "Easy navigation for ruby on rails 2.2 (i18n)"
+  e.url            = "http://github.com/innetra/easy_navigation"
+  e.author         = "Ivan Torres"
+  e.email          = "mexpolk@gmail.com"
+  e.ignore_pattern = ["tmp/*", "script/*"]
+  e.development_dependencies = []
+end

data/easy_navigation.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_navigation}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ivan Torres"]
+  s.date = %q{2008-12-18}
+  s.description = %q{Easy navigation for ruby on rails 2.2 (i18n)}
+  s.email = %q{mexpolk@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/easy_navigation.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/easy_navigation.rb", "easy_navigation.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/innetra/easy_navigation}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Easy_navigation", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{easy_navigation}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Easy navigation for ruby on rails 2.2 (i18n)}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+require "easy_navigation"
+
+ActionView::Base.send :include, EasyNavigation::Helper

data/lib/easy_navigation.rb

@@ -0,0 +1,172 @@
+module EasyNavigation
+
+  module Helper
+  
+    def render_navigation(name)
+    
+      html = ""
+      class_name = ""
+      
+      EasyNavigation::Builder.navigation[name][:tabs].each do |tab|
+        menus_html = ""
+        current_tab = false
+        tab[:menus].each do |menu|
+          class_name = "menu"
+          if current_menu?(menu)
+            class_name << " current"
+            current_tab = true
+          end 
+          menus_html << content_tag("li", link_to(t(menu[:text]), menu[:url]), 
+            :class => class_name, :id => menu[:name])
+         if EasyNavigation::Builder.navigation[name][:options][:separator]
+           menus_html << content_tag("li", "|", :class => "separator") 
+         end
+        end
+        class_name = "tab"
+        class_name << " current" if current_tab
+        html << content_tag("li",
+          "#{link_to(t(tab[:text]), tab[:url])} #{content_tag("ul", menus_html)}", 
+          :class => class_name, :id => tab[:name])
+      end
+      content_tag("ul", html, :id => "navigation")
+    end
+    
+    private
+
+    def current_menu?(menu)
+      current = controller.controller_name == menu[:url][:controller] && 
+        (controller.action_name == menu[:url][:action] || menu[:url][:action] == nil)
+      if menu.has_key?:on 
+         (menu[:on].is_a?(Array) ? menu[:on] : [menu[:on]]).each do |controllers|
+          (controllers.is_a?(Array) ? controllers : [controllers]).each do |c|
+             current |= controller.controller_name == c[:controller]
+            if c.has_key?:only
+              current &= (c[:only].is_a?(Array) ? c[:only] : [c[:only]]).include?controller.action_name
+            end
+            if c.has_key?:except
+              current &= !((c[:except].is_a?(Array) ? c[:except] : [c[:except]]).include?controller.action_name)
+            end
+          end
+        end      
+      end
+      current
+    end
+
+  end # EasyNavigation::Helper
+
+  class Configuration
+
+    attr_accessor :navigation
+    
+    def initialize
+      self.navigation = {}
+    end
+    
+    def config(&block)
+      builder = Builder.new
+      yield builder
+      builder.navigations.each { |tmp| 
+        self.navigation[tmp[:name]] = tmp
+      }
+    end
+    
+    class Builder
+      
+      attr_accessor :navigations
+    
+      def initialize
+        self.navigations = []
+      end
+        
+      def navigation(name, options = {}, &block)
+        navigation = Navigation.new(name, options.merge!(:prefix => "navigation"))
+        yield navigation
+        self.navigations << navigation.build
+      end
+      
+      def build
+        { :navigations => navigations }
+      end
+      
+      class Navigation
+      
+        attr_accessor :tabs, :name, :options, :prefix
+      
+        def initialize(name, options = {})
+          self.tabs = []
+          self.name = name
+          self.options = options
+          self.prefix = options[:prefix]
+        end
+      
+        def tab(name, options = {}, &block)
+          tab = Tab.new(name, options.merge!(:prefix => [self.prefix, self.name]))
+          yield tab
+          self.tabs << tab.build
+        end
+        
+        def build
+          self.options[:separator] = false unless self.options.has_key?(:separator)
+          { :name => self.name.to_sym, :tabs => self.tabs, :options => self.options }
+        end
+        
+        class Tab
+        
+          attr_accessor :menus, :name, :url, :options, :prefix
+          
+          def initialize(name, options = {})
+            self.menus = []
+            self.name = name
+            self.url = options[:url]
+            self.options = options
+            self.prefix = options[:prefix]
+          end
+          
+          def menu(name, options = {}, &block)
+            menu = Menu.new(name, options.merge!(:prefix => [self.prefix, self.name]))
+            yield menu
+            self.menus << menu.build
+          end
+          
+          def build
+            { :name => [self.prefix, self.name].join("_").to_sym, 
+              :text => [self.prefix, self.name].join("."), 
+              :url => self.url, 
+              :options => self.options, 
+              :menus => self.menus }
+          end
+          
+          class Menu
+            
+            attr_accessor :name, :url, :options, :active_urls, :prefix
+            
+            def initialize(name, params = {})
+              self.active_urls = []
+              self.name = name
+              self.url = params[:url]
+              self.options = params
+              self.prefix = params[:prefix]
+            end
+            
+            def build
+              self.prefix << self.name
+              { :name => self.prefix.join("_").to_sym, 
+                :text => self.prefix.join("."), 
+                :url => self.url, 
+                :on => self.active_urls }
+            end
+            
+            def connect(options = {})
+              options[:controller] = self.options[:url][:controller] unless options.has_key?(:controller)
+              self.active_urls << options
+            end
+
+          end #Menu
+        end # Tab
+      end # Navigation
+    end # Builder
+  end # Configuration
+  
+  Builder = Configuration.new
+  
+end# EasyNavigation

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: innetra-easy_navigation
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ivan Torres
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Easy navigation for ruby on rails 2.2 (i18n)
+email: mexpolk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/easy_navigation.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/easy_navigation.rb
+- easy_navigation.gemspec
+has_rdoc: true
+homepage: http://github.com/innetra/easy_navigation
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Easy_navigation
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: easy_navigation
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easy navigation for ruby on rails 2.2 (i18n)
+test_files: []
+