semantic_navigation 0.0.6 → 0.0.8

data/Changelog.md

@@ -1,4 +1,13 @@
-### 0.0.6 /February 10th, 2012
+### 0.0.8 /
+
+* New configuration logic
+* New helper render method
+* Reloadable in development, and caching in production
+* I18n support
+* Render config, can be set through helper render method
+* Included support for custom renderers
+
+### 0.0.6 / February 10th, 2012
 
 * Now uses fileutils raver ftools for ruby-1.9.x
 * Some fixes for ruby-1.9.x

data/README.md

@@ -1,9 +1,15 @@
 This is semantic_navigation
 
-Current version: 0.1.0
+Current version: 0.0.8
 
 ###Purpose
-The purpose of this gem is to generate simple and usefull navigation. You can define different menus and render them separately, specify root nodes, setup your own renderers and other.
+This gem generates the navigation for your Rails app.
+Really customizable and simple to use.
+Using this gem you have 4 types of renderers: menu, breadcrumb, tabs, and, pills
+
+You can define different menus and render them separatelly.
+
+Now with simple integration with a twitter-bootstrap css framework.
 
 ###How to install
 
@@ -19,7 +25,30 @@ $ bundle install
 
 Generate the config file:
 <pre><code>
-$ rake semantic_navigation:install
+$ rails generate semantic_navigation:install
 </code></pre>
 
-For the information of how to configure and render your menus read the <a href='https://github.com/fr33z3/semantic_navigation/wiki'>Wiki</a>
+###Quick start
+
+Configure your navigation in config/semantic_navigation.rb
+
+<pre><code>
+SemanticNavigation::Configuration.run do
+  navigate :root_menu do
+    item :header_item, nil, :name => 'Header'
+    item :first_item, '#', :name => 'First Item', :ico => :tag
+    item :divide
+    item :second_item, '#', :name => 'Second Item', :ico => :user
+  end
+end
+</code></pre>
+
+And try to render it in your layout(code in haml):
+<pre><code>
+.well
+  = navigation_for :root_menu, :as => :bootstrap_list
+</code></pre>
+
+Render the navigation using the semantic_navigation helper methods and options for them.
+
+For the information of how to configure and render your navigation read the <a href='https://github.com/fr33z3/semantic_navigation/wiki'>Wiki</a>

data/Rakefile

@@ -1 +1,4 @@
+require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new('spec')

data/lib/generators/semantic_navigation/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SemanticNavigation
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates config file for your navigation"
+      
+      def add_semantic_navigation
+        puts <<-EOM
+        +===============================================================+
+        |              SemanticNavigation install                       |
+        | Please read the Wiki to learn how to define your navigation.  |
+        | http://github.com/fr33z3/semantic_navigation/wiki.            |
+        +===============================================================+
+        EOM
+        copy_file "semantic_navigation.rb", "config/semantic_navigation.rb"
+        copy_file "semantic_navigation.en.yml", "config/locales/semantic_navigation.en.yml"
+      end
+    end
+  end
+end

data/lib/generators/semantic_navigation/install/templates/semantic_navigation.en.yml

@@ -0,0 +1,2 @@
+en:
+  semantic_navigation:

data/lib/generators/semantic_navigation/install/templates/semantic_navigation.rb

@@ -0,0 +1,25 @@
+SemanticNavigation::Configuration.run do
+  # Read wiki https://github.com/fr33z3/semantic_navigation/wiki to lear about
+  # semantic_navigation configuration
+  
+  #styles_for :list do
+  #  show_navigation_active_class true
+  #  navigation_active_class [:some_active_class]
+  #end
+  
+  #register_renderer :some_renderer, SomeRendererClass
+  
+  #navigate :navigation do
+  #  item :header_item, :name => 'Header Item'
+  #  item :first_item, :first_item_route, :ico => 'user' do 
+  #    item :sub_item, :sub_item_route do
+  #      item :sub_sub_item, :sub_sub_item_route
+  #    end
+  #    item :second_sub, :second_sub_route, :ico => 'user'
+  #  end
+  #  item :divide
+  #  item :second_item, :second_item_route
+  #end
+  
+end
+

data/lib/semantic_navigation.rb

@@ -1,4 +1,6 @@
 require "semantic_navigation/version"
+require 'semantic_navigation/core'
+require 'semantic_navigation/renderers'
 require "semantic_navigation/configuration"
 require 'semantic_navigation/railtie' if defined?(Rails)
 

data/lib/semantic_navigation/configuration.rb

@@ -1,55 +1,63 @@
-require 'semantic_navigation/item'
-
 module SemanticNavigation
   class Configuration
     
-    def self.run
-      instance = self.new
-      yield instance if block_given?
-      instance
+    @@navigations = {}
+    @@renderers = {:list => Renderers::List,
+                   :breadcrumb => Renderers::BreadCrumb,
+                   :bootstrap_breadcrumb => TwitterBootstrap::Breadcrumb,
+                   :bootstrap_list => TwitterBootstrap::List,
+                   :bootstrap_tabs => TwitterBootstrap::Tabs,
+                   :bootstrap_pills => TwitterBootstrap::Tabs
+                  }
+    @@render_styles = {:bootstrap_pills => proc {
+        navigation_default_classes [:nav, 'nav-pills']
+      }  
+    }
+        
+    def self.run(&block)
+      self.class_eval &block if block_given?
     end
-
-    def initialize
-      @menus = {}
+    
+    def self.navigate(id, options = {}, &block)
+      options[:id] = id.to_sym
+      options[:i18n_name] = "semantic_navigation.#{id}"
+      navigation = Core::Navigation.new(options)
+      navigation.instance_eval &block if block_given?
+      @@navigations[id.to_sym] = navigation
     end
-  
-    def method_missing(name, *args)
-      name = name.to_s
-      if name.chomp('=') != name
-        SemanticNavigation::Item.set_default_option(name.chop,args[0])
-      else  
-        menu = Item.new(name, args, nil)
-        menu.level = 0
-        @menus.merge!({name.to_sym => menu})
-        yield menu if block_given?
+    
+    def render(menu_id, renderer_name, options, view_object)
+      renderer = @@renderers[renderer_name].new(view_object)
+      unless @@render_styles[renderer_name].nil?
+        renderer.instance_eval &@@render_styles[renderer_name]
       end
+      options.keys.each{|key| renderer.send "#{key}=", options[key]}
+      navigation = @@navigations[menu_id]
+      navigation.mark_active(view_object)
+      navigation.render(renderer)
     end
-
-    def render(name, command = :render)
-      if @menus[name.to_sym]
-        if command == :render
-          return @menus[name.to_sym].render
-        elsif command == :active_item_name
-          item = @menus[name.to_sym].find_active_item
-          !item.nil? ? item.name : ''
-        elsif command == :active_item_parent_name
-          item = @menus[name.to_sym].find_active_item
-          !item.nil? && !item.parent.nil? ? item.parent.name : ''
-        elsif command == :breadcrumb
-          return @menus[name.to_sym].render_breadcrumb
-        elsif command == :root
-          return @menus[name.to_sym].render_levels 1
-        elsif command.is_a?(Hash) && command.keys == [:levels]
-          return @menus[name.to_sym].render_levels command[:levels]
-        elsif command.is_a?(Hash) && command.keys == [:from_level]
-          return @menus[name.to_sym].render_from command[:from_level]
-        else
-          raise NoMethodError.new("Wrong menu render parameter:`#{command.to_s}`")
-        end
-      else
-        raise NoMethodError.new("No such menu name:`#{name}` check your #{Rails.root}/config/semantic_navigation.rb file")
+    
+    def self.styles_for(name)
+      @@render_styles[name.to_sym] = proc
+    end
+    
+    def self.to_s
+      "<#{self.name}:#{@@navigations};#{@@renderers}>"
+    end
+    
+    def self.register_renderer(*options)
+      if options.count == 1
+        name = options[0].name.demodulize.underscore.to_sym
+        @@renderers[name] = options[0]
+      elsif options.count == 2 
+        name = options[0].to_sym
+        @@renderers[name] = options[1]
       end
     end
-
+    
+    def navigation(name)
+      @@navigations[name]
+    end
+  
   end
 end

data/lib/semantic_navigation/core.rb

@@ -0,0 +1,4 @@
+require 'semantic_navigation/core/base'
+require 'semantic_navigation/core/navigation'
+require 'semantic_navigation/core/leaf'
+require 'semantic_navigation/core/node'

data/lib/semantic_navigation/core/base.rb

@@ -0,0 +1,21 @@
+module SemanticNavigation
+  module Core
+    class Base      
+      
+      attr :id, :level, :classes, :active
+      
+      def initialize(options, level)
+        @level = level
+        options.keys.each do |option_name|
+          instance_variable_set :"@#{option_name}", options[option_name]
+        end
+      end
+
+      def render(renderer)
+        class_name = self.class.name.split('::').last.downcase
+        renderer.send :"render_#{class_name}", self
+      end
+      
+    end    
+  end
+end

data/lib/semantic_navigation/core/leaf.rb

@@ -0,0 +1,25 @@
+module SemanticNavigation
+  module Core
+    class Leaf < Base
+      attr :url, :link_classes
+      
+      def initialize(options, level)
+        super options, level
+      end
+      
+      def name
+        rendering_name = @name || I18n.t("#{@i18n_name}.#{@id}", :default => '')
+        rendering_name.is_a?(Proc) ? rendering_name.call.to_s : rendering_name
+      end
+      
+      def mark_active(view_object)
+        if @url
+          @active = view_object.current_page?(@url)
+        else
+          @active = false
+        end
+      end
+      
+    end    
+  end
+end

data/lib/semantic_navigation/core/navigation.rb

@@ -0,0 +1,35 @@
+module SemanticNavigation
+  module Core
+    class Navigation < Base
+      attr :sub_elements
+      
+      def initialize(options, level = 0)
+        @sub_elements = []
+        super options, level
+      end
+
+      def item(id, url=nil, options={}, &block)
+        options[:id] = id.to_sym
+        options[:url] = url unless url.nil?
+        options[:i18n_name] = @i18n_name
+        
+        if block_given?
+          element = Node.new(options, @level+1)
+          element.instance_eval &block
+        else
+          element = Leaf.new(options, @level+1)
+        end
+        
+        @sub_elements.push element
+      end 
+      
+      def mark_active(view_object)
+        @sub_elements.each do |element| 
+          element.mark_active(view_object)
+        end
+        @active = !@sub_elements.find{|element| element.active}.nil?
+      end
+      
+    end
+  end
+end

data/lib/semantic_navigation/core/node.rb

@@ -0,0 +1,29 @@
+module SemanticNavigation
+  module Core
+    class Node < Navigation      
+      attr :url, :link_classes, :node_classes
+      
+      def initialize(options, level)
+        super options, level
+      end
+      
+      def name
+        rendering_name = @name || i18n_name
+        rendering_name.is_a?(Proc) ? rendering_name.call.to_s : rendering_name
+      end
+      
+      def mark_active(view_object)
+        @sub_elements.each{|element| element.mark_active(view_object)}
+        @active = view_object.current_page?(@url)
+        @active |= !@sub_elements.find{|element| element.active}.nil?
+      end
+            
+      private
+      
+      def i18n_name
+        I18n.t("#{@i18n_name}.#{@id}", :default => '')
+      end
+      
+    end
+  end
+end

data/lib/semantic_navigation/helper_methods.rb

@@ -1,23 +1,20 @@
 module SemanticNavigation::HelperMethods
-  
-  def method_missing(name, command = :render)
-    name = name.to_s
-    if name[0..6] == 'render_'
-      SemanticNavigation::Item.set_default_option('view_object',self)
-      semantic_navigation_config.render(name[7..-1], command)
-    else
-      raise NoMethodError.new("NoMethodError:#{name}")
-    end
-  end
 
-  private
- 
-  def semantic_navigation_config
-    if @__semantic_navigation_config.nil?
-      @__semantic_navigation_config = eval(IO.read("#{Rails.root}/config/semantic_navigation.rb"))
+  def navigation_for(name, options = {})
+    render_name = options.delete :as
+    render_name ||= :list
+    SemanticNavigation::Configuration.new.render(name, render_name, options, self)
+  end
+  
+  def active_item_for(name, level = nil)
+    navigation = SemanticNavigation::Configuration.new.navigation(name)
+    item = navigation
+    while !item.is_a?(SemanticNavigation::Core::Leaf) &&
+          !item.sub_elements.find{|e| e.active}.nil? && 
+          (!level.nil? ? item.level < level : true)
+      item = item.sub_elements.find{|e| e.active}
     end
-    @__semantic_navigation_config
+    item.name if item != navigation
   end
- 
 
 end

data/lib/semantic_navigation/railtie.rb

@@ -2,14 +2,22 @@ require 'semantic_navigation/helper_methods'
 
 module SemanticNavigation
   class Railtie < Rails::Railtie
-    
-    initializer "semantic_navigation.helper_methods" do
-      ActionView::Base.send :include, HelperMethods
+   
+    initializer "semantic_navigation.extend_helper_methods" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, HelperMethods
+      end
     end
     
-    rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each {|f| load f}
+    if Rails.env == "production"
+      config.after_initialize {
+        load "#{Rails.root}/config/semantic_navigation.rb"
+      }
+    else
+      ActionDispatch::Callbacks.before {
+        load "#{Rails.root}/config/semantic_navigation.rb"
+      }      
     end
-  
+    
   end
 end

data/lib/semantic_navigation/renderers.rb

@@ -0,0 +1,8 @@
+require 'semantic_navigation/renderers/render_helpers'
+require 'semantic_navigation/renderers/acts_as_list'
+require 'semantic_navigation/renderers/acts_as_breadcrumb'
+require 'semantic_navigation/renderers/list'
+require 'semantic_navigation/renderers/bread_crumb'
+require 'semantic_navigation/twitter_bootstrap/breadcrumb'
+require 'semantic_navigation/twitter_bootstrap/list'
+require 'semantic_navigation/twitter_bootstrap/tabs'

data/lib/semantic_navigation/renderers/acts_as_breadcrumb.rb

@@ -0,0 +1,39 @@
+module SemanticNavigation
+  module Renderers
+    module ActsAsBreadcrumb
+      
+      def render_navigation(object)
+        navigation(object) do
+          while !object.class.in?(SemanticNavigation::Core::Leaf, NilClass) &&
+                from_level.to_i > object.level
+            object = object.sub_elements.find(&:active)
+          end
+          unless object.class.in?(SemanticNavigation::Core::Leaf, NilClass)
+            active_element = object.sub_elements.find{|e| e.active}
+            active_element.render(self) if active_element
+          end
+        end  
+      end
+
+      def render_node(object)
+        active_element = object.sub_elements.find{|e| e.active}
+        render_element = active_element.render(self) if active_element
+        if render_element
+          node(object) do
+            render_element
+          end          
+        else
+          render_leaf(object)
+        end        
+      end
+        
+      def render_leaf(object)
+        show = !until_level.nil? ? object.level <= until_level+1 : true
+        return nil unless show
+        
+        leaf(object)
+      end
+      
+    end
+  end
+end