semantic_navigation 0.0.14 → 0.1.0

data/lib/semantic_navigation/core/navigation.rb

@@ -2,15 +2,17 @@ module SemanticNavigation
   module Core
     class Navigation < Base
       attr_accessor :sub_elements
-      
+
       def initialize(options, level = 0)
         @sub_elements = []
+        @scope_options = {}
         super options, level
       end
 
       def item(id, url=nil, options={}, &block)
         options[:id] = id.to_sym
-        
+        options[:render_if] ||= @scope_options[:render_if]
+
         if url.is_a?(Array)
           options[:url] = [url].flatten(1).map{|url| decode_url(url)}
         else
@@ -18,7 +20,7 @@ module SemanticNavigation
         end
 
         options[:i18n_name] = @i18n_name
-        
+
         if block_given?
           element = Node.new(options, @level+1)
           element.instance_eval &block
@@ -32,21 +34,24 @@ module SemanticNavigation
             puts 'Warning: do not define `dividers` using `item` method. Use `divider` instead. This logic will be deprecated soon.'
           end
         end
-        
+
         @sub_elements.push element
       end
 
       def header(id, options={})
         options[:id] = id.to_sym
+        options[:render_if] ||= @scope_options[:render_if]
         options[:url] = nil
         options[:i18n_name] = @i18n_name
         @sub_elements.push Leaf.new(options, @level+1)
       end
 
-      def divider
-        options = {:id => :divider,
-                   :url => nil,
-                   :i18n_name => nil}
+      def divider(options = {})
+        options[:id] = :divider
+        options[:render_if] ||= @scope_options[:render_if]
+        options[:url] = nil
+        options[:i18n_name] = nil
+        options[:name] = nil
         @sub_elements.push Leaf.new(options, @level+1)
       end
 
@@ -58,8 +63,14 @@ module SemanticNavigation
         end
       end
 
+      def scope(options = {}, &block)
+        @scope_options = options
+        self.instance_eval &block
+        @scope_options = {}
+      end
+
       def mark_active
-        @sub_elements.each do |element| 
+        @sub_elements.each do |element|
           element.mark_active
         end
         @active = !@sub_elements.find{|element| element.active}.nil?
@@ -71,12 +82,12 @@ module SemanticNavigation
         if url.is_a? String
           controller_name, action_name = url.split('#')
           if controller_name && action_name
-            decoded_url = {:controller => controller_name, :action => action_name}  
-          end        
+            decoded_url = {:controller => controller_name, :action => action_name}
+          end
         end
         decoded_url || url
       end
-      
+
     end
   end
 end

data/lib/semantic_navigation/core/node.rb

@@ -1,50 +1,22 @@
 module SemanticNavigation
   module Core
-    class Node < Navigation      
+    class Node < Navigation
+      include UrlMethods
+      include NameMethods
+
       attr_accessor :link_classes, :node_classes
-      
-      def url
-        urls.first
-      end
-      
+
       def initialize(options, level)
         @url = []
         super options, level
       end
-      
-      def name(renderer_name = nil)
-        rendering_name = @name
-        rendering_name = rendering_name[renderer_name.to_sym] || rendering_name[:default] if rendering_name.is_a?(Hash)
-        rendering_name = view_object.instance_eval(&rendering_name).to_s if rendering_name.is_a?(Proc)
-        rendering_name || i18n_name(renderer_name)
-      end
-      
+
       def mark_active
         @sub_elements.each{|element| element.mark_active}
         @active = urls.map{|u| current_page?(u) rescue false}.reduce(:"|")
         @active |= !@sub_elements.find{|element| element.active}.nil?
       end
-            
-      private
-      
-      def i18n_name(renderer_name = nil)
-        name = I18n.t("#{@i18n_name}.#{@id}", :default => '')
-        if name.is_a? Hash
-          name = name[renderer_name.to_sym] || name[:default]
-        end
-        name || ''
-      end
 
-      def urls
-        [@url].flatten(1).map do |url|
-          if url.is_a?(Proc)
-            view_object.instance_eval(&url) rescue ''
-          else
-            url
-          end          
-        end
-      end
-      
     end
   end
 end

data/lib/semantic_navigation/core/url_methods.rb

@@ -0,0 +1,24 @@
+module SemanticNavigation
+  module Core
+  	module UrlMethods
+      
+      def url
+        urls.first
+      end
+
+      private
+      
+      def urls
+        [@url].flatten(1).map do |url|
+          if url.is_a?(Proc)
+            view_object.instance_eval(&url) rescue ''
+          else
+            url
+          end
+        end
+      end
+
+  	end
+
+  end
+end

data/lib/semantic_navigation/railtie.rb

@@ -2,7 +2,7 @@ require 'semantic_navigation/helper_methods'
 
 module SemanticNavigation
   class Railtie < Rails::Railtie
-   
+
     initializer "semantic_navigation.extend_helper_methods" do
       ActiveSupport.on_load :action_view do
         ActionView::Base.send :include, HelperMethods
@@ -16,7 +16,7 @@ module SemanticNavigation
       conf.register_renderer :bootstrap_tabs, TwitterBootstrap::Tabs
       conf.register_renderer :bootstrap_pills, TwitterBootstrap::Tabs
       conf.register_renderer :bootstrap_simple_nav, SemanticNavigation::Renderers::List
-      
+
       conf.styles_for :bootstrap_pills do
         navigation_default_classes [:nav, 'nav-pills']
       end
@@ -24,16 +24,26 @@ module SemanticNavigation
         navigation_default_classes [:nav]
       end
     end
-    
+
+    def self.actual_config_location
+      locations =  ["#{Rails.root}/config/initializers/semantic_navigation.rb", 
+                    "#{Rails.root}/config/semantic_navigation.rb"]
+      actual_location = locations.find{|l| File.exists?(l)}
+      throw "Please create a semantic_navigation configuration file before starting the project!" unless actual_location
+      puts "DEPRECATION WARNING: Please move the configuration file from #{locations.second} 
+            to #{locations.first}! Current configuration file path will be deprecated soon!" if locations.find_index(actual_location) == 1
+      actual_location
+    end
+   
     if Rails.env == "production"
       config.after_initialize {
-        load "#{Rails.root}/config/semantic_navigation.rb"
+        load SemanticNavigation::Railtie.actual_config_location
       }
     else
       ActionDispatch::Callbacks.before {
-        load "#{Rails.root}/config/semantic_navigation.rb"
-      }      
+        load SemanticNavigation::Railtie.actual_config_location
+      }
     end
-    
+
   end
 end

data/lib/semantic_navigation/renderers/acts_as_breadcrumb.rb

@@ -1,7 +1,7 @@
 module SemanticNavigation
   module Renderers
     module ActsAsBreadcrumb
-      
+
       def render_navigation(object)
         return '' unless object.render_if
         navigation(object) do
@@ -13,30 +13,30 @@ module SemanticNavigation
             active_element = object.sub_elements.find{|e| e.active}
             active_element.render(self) if active_element
           end
-        end  
+        end
       end
 
       def render_node(object)
         active_element = object.sub_elements.find{|e| e.active}
         if active_element && !active_element.id.in?([except_for].flatten) && active_element.render_if
-          render_element = active_element.render(self)  
+          render_element = active_element.render(self)
         end
         if render_element
           node(object) do
             render_element
-          end          
+          end
         else
           render_leaf(object)
-        end        
+        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

data/lib/semantic_navigation/renderers/acts_as_list.rb

@@ -1,47 +1,48 @@
 module SemanticNavigation
   module Renderers
     module ActsAsList
-        
-        def render_navigation(object)
-          return '' unless object.render_if
-          navigation(object) do
-            while !object.class.in?(SemanticNavigation::Core::Leaf, NilClass) && 
-                  from_level.to_i > object.level
-              object = object.sub_elements.find{|e| e.active}
-            end
-            show = !until_level.nil? && !object.nil? ? object.level <= until_level : true
-            if !object.class.in?(SemanticNavigation::Core::Leaf, NilClass) && show
-              object.sub_elements.map{|element| element.render(self)}.compact.sum
-            end
-          end
-        end
 
-        def render_node(object)
-          if !object.id.in?([except_for].flatten) && object.render_if
-            content = render_node_content(object)
-            if content
-              node(object) do
-                content
-              end
-            else
-              render_leaf(object)
-            end  
+      def render_navigation(object)
+        return '' unless object.render_if
+        navigation(object) do
+          while !object.class.in?(SemanticNavigation::Core::Leaf, NilClass) &&
+                from_level.to_i > object.level
+            object = object.sub_elements.find{|e| e.active}
+          end
+          show = !until_level.nil? && !object.nil? ? object.level <= until_level : true
+          if !object.class.in?(SemanticNavigation::Core::Leaf, NilClass) && show
+            object.sub_elements.map{|element| element.render(self)}.compact.sum
           end
         end
-        
-        def render_node_content(object)
-          if (!until_level.nil? && until_level >= object.level) || until_level.nil?
-            node_content(object) do
-              object.sub_elements.map{|element| element.render(self)}.compact.sum
+      end
+
+      def render_node(object)
+        if !object.id.in?([except_for].flatten) && object.render_if
+          content = render_node_content(object)
+          if content
+            node(object) do
+              content
             end
+          else
+            render_leaf(object)
           end
         end
+      end
 
-        def render_leaf(object)
-          if !object.id.in?([except_for].flatten) && object.render_if
-            leaf(object)
+      def render_node_content(object)
+        if (!until_level.nil? && until_level >= object.level) || until_level.nil?
+          node_content(object) do
+            object.sub_elements.map{|element| element.render(self)}.compact.sum
           end
-        end     
+        end
+      end
+
+      def render_leaf(object)
+        if !object.id.in?([except_for].flatten) && object.render_if
+          leaf(object)
+        end
+      end
+
     end
   end
 end

data/lib/semantic_navigation/renderers/bread_crumb.rb

@@ -6,22 +6,22 @@ module SemanticNavigation
 
       style_accessor :last_as_link => false,
                      :breadcrumb_separator => '/'
-      
+
       navigation_default_classes [:breadcrumb]
       show_navigation_active_class false
       show_node_active_class false
       show_leaf_active_class false
       show_link_active_class false
-      
+
       private
-      
+
       def navigation(object)
         content_tag :ul, nil, :id => show_id(:navigation, object.id),
                               :class => merge_classes(:navigation, object.active, object.classes) do
           yield
         end
       end
-      
+
       def node(object)
         content_tag(:li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes)) do
@@ -33,7 +33,7 @@ module SemanticNavigation
         end +
         yield
       end
-     
+
       def leaf(object)
         content_tag :li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes) do

data/lib/semantic_navigation/renderers/list.rb

@@ -3,34 +3,34 @@ module SemanticNavigation
     class List
       include RenderHelpers
       include ActsAsList
-      
+
       navigation_default_classes [:list]
-      
+
       private
-      
+
       def navigation(object)
         content_tag :ul, nil, :id => show_id(:navigation, object.id),
                               :class => merge_classes(:navigation, object.active, object.classes) do
           yield
         end
       end
-      
+
       def node(object)
         content_tag :li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes) do
           link_to(object_name(object), object.url, :id => show_id(:link, object.id),
                                            :class => merge_classes(:link, object.active, object.link_classes))+
           yield
-        end 
+        end
       end
-      
+
       def node_content(object)
         content_tag(:ul, nil, :id => show_id(:node, object.id),
                               :class => merge_classes(:node, object.active, object.node_classes)) do
-          yield  
+          yield
         end
       end
-      
+
       def leaf(object)
         content_tag :li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes) do
@@ -38,7 +38,7 @@ module SemanticNavigation
                                            :class => merge_classes(:link, object.active, object.link_classes)
         end
       end
-      
+
     end
   end
 end

data/lib/semantic_navigation/renderers/render_helpers.rb

@@ -1,33 +1,20 @@
 module SemanticNavigation
   module Renderers
     module RenderHelpers
-      
+
       def self.included(base)
         base.send :include, InstanceMethods
         base.extend(ClassMethods)
         base.class_eval do
-          style_accessor :navigation_active_class => [:active],
-                         :node_active_class => [:active],
-                         :leaf_active_class => [:active],
-                         :link_active_class => [:active],
-      
-                         :show_navigation_active_class => true,
-                         :show_node_active_class => true,
-                         :show_leaf_active_class => true,
-                         :show_link_active_class => true,
-      
-                         :show_navigation_id => true,
-                         :show_node_id => true,
-                         :show_leaf_id => true,
-                         :show_link_id => true,
-      
-                         :navigation_default_classes => [], 
-                         :node_default_classes => [],
-                         :leaf_default_classes => [],
-                         :link_default_classes => []   
+          [:navigation, :node, :leaf, :link].each do |e|
+            style_accessor :"#{e}_active_class" => [:active],
+                           :"show_#{e}_active_class" => true,
+                           :"show_#{e}_id" => true,
+                           :"#{e}_default_classes" => []
+          end
         end
       end
-      
+
       module ClassMethods
 
         def style_accessor(hash)
@@ -50,9 +37,9 @@ module SemanticNavigation
              end
             "
             send key, hash[key]
-          end        
+          end
         end
-        
+
         def property_for(class_name,name)
           class_object = "semantic_navigation/core/#{class_name}".classify.constantize
           class_object.class_eval "
@@ -64,24 +51,24 @@ module SemanticNavigation
           "
         end
       end
-      
-      module InstanceMethods  
+
+      module InstanceMethods
         attr_accessor :from_level, :until_level, :except_for, :name
-        
+
         def level=(level)
           @from_level = level
           @until_level = level
         end
-        
+
         def levels=(level_range)
           @from_level = level_range.first
           @until_level = level_range.last
         end
-        
+
         def initialize
           @view_object = SemanticNavigation::Configuration.view_object
         end
-        
+
         private
 
         def content_tag(tag_name, content = nil, options={}, &block)
@@ -107,9 +94,9 @@ module SemanticNavigation
         def object_name(object)
           object.name(self.name)
         end
-        
+
       end
-  
-    end    
+
+    end
   end
 end