semantic_navigation 0.1.1 → 0.1.3

data/lib/generators/semantic_navigation/list_renderer/list_renderer_generator.rb

@@ -13,7 +13,6 @@ module SemanticNavigation
         register_string = "  register_renderer :#{file_name}, Renderers::#{class_name}\n"
         inject_into_file semantic_navigation_config, register_string, :after => "SemanticNavigation::Configuration.run do\n"
       end
-
     end
   end
 end

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

@@ -1,8 +1,8 @@
 class Renderers::<%= class_name %>
   #Default render helpers. Do not delete this if don't want to write your own.
-  include SemanticNavigation::Renderers::RenderHelpers
+  include SemanticNavigation::Renderers::MixIn::RenderHelpers
   #The default list rendering logic. Do not delete if don't want to write your own.
-  include SemanticNavigation::Renderers::ActsAsList
+  include SemanticNavigation::Renderers::MixIn::ActsAsList
 
   #Default navigation classes
   navigation_active_class [:active]
@@ -53,7 +53,7 @@ class Renderers::<%= class_name %>
     end
   end
 
-  #Navigation leaf block  
+  #Navigation leaf block
   def leaf(object)
     content_tag :li, nil, :id => show_id(:leaf, object.id),
                           :class => merge_classes(:leaf, object.active, object.classes) do
@@ -61,4 +61,4 @@ class Renderers::<%= class_name %>
                                        :class => merge_classes(:link, object.active, object.link_classes)
     end
   end
-end
+end

data/lib/semantic_navigation.rb

@@ -4,3 +4,33 @@ require 'semantic_navigation/renderers'
 require "semantic_navigation/configuration"
 require 'semantic_navigation/railtie' if defined?(Rails)
 
+module SemanticNavigation
+  def self.deprecation_message(type, deprecated_object, new_object, action = nil)
+    if SemanticNavigation::Configuration.display_deprecation_messages
+      message = ["DEPRECATION WARNING:",
+                 "You are using deprecated #{type} `#{deprecated_object}`"]
+      if action
+        message[-1] += " for #{action}."
+      else
+        message[-1] += '.'
+      end
+      message += ["That #{type} will be depreacted soon.",
+                  "Please use `#{new_object}` instead."]
+      puts message.join("\n")
+    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)}
+    raise ["Please create a semantic_navigation configuration",
+           "(rails g semantic_navigation:install)", 
+           "file before starting the project!"].join(" ") 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
+
+end
+

data/lib/semantic_navigation/configuration.rb

@@ -1,11 +1,18 @@
 module SemanticNavigation
   class Configuration
 
-    @@view_object = nil
     @@navigations = {}
     @@renderers = {}
     @@render_styles = {}
 
+    cattr_accessor :view_object do
+      nil
+    end
+
+    cattr_accessor :display_deprecation_messages do
+      true
+    end
+
     def self.run(&block)
       self.class_eval &block if block_given?
     end
@@ -52,14 +59,6 @@ module SemanticNavigation
       "
     end
 
-    def self.view_object
-      @@view_object
-    end
-
-    def self.view_object=(view_object)
-      @@view_object = view_object
-    end
-
     def self.navigation(name)
       @@navigations[name]
     end

data/lib/semantic_navigation/core.rb

@@ -1,8 +1,10 @@
-required_files = %w(base
-                    url_methods
-                    name_methods
-                    navigation
-                    leaf node)
-required_files.each do |file|
+%w(
+base
+mix_in/url_methods
+mix_in/name_methods
+navigation
+leaf
+node
+).each do |file|
   require "semantic_navigation/core/#{file}"
 end

data/lib/semantic_navigation/core/leaf.rb

@@ -1,8 +1,8 @@
 module SemanticNavigation
   module Core
     class Leaf < Base
-      include UrlMethods
-      include NameMethods
+      include MixIn::UrlMethods
+      include MixIn::NameMethods
 
       attr_accessor :link_classes, :link_html
 

data/lib/semantic_navigation/core/mix_in/name_methods.rb

@@ -0,0 +1,24 @@
+module SemanticNavigation
+  module Core
+    module MixIn
+      module NameMethods
+        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
+
+        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
+      end
+    end
+  end
+end

data/lib/semantic_navigation/core/mix_in/url_methods.rb

@@ -0,0 +1,25 @@
+module SemanticNavigation
+  module Core
+    module MixIn
+      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
+end

data/lib/semantic_navigation/core/navigation.rb

@@ -29,9 +29,15 @@ module SemanticNavigation
           #Deprecation warning message
           #TODO:Should be deleted after moving the header and divider definition via item
           if element.url.nil? && !element.name.empty?
-            puts 'Warning: do not define `headers` using `item` method. Use `header` instead. This logic will be deprecated soon.'
+            SemanticNavigation.deprecation_message(:method,
+                                                   'item',
+                                                   'header',
+                                                   'header definition')
           elsif element.url.nil? && element.name.empty?
-            puts 'Warning: do not define `dividers` using `item` method. Use `divider` instead. This logic will be deprecated soon.'
+            SemanticNavigation.deprecation_message(:method,
+                                                   'item',
+                                                   'header',
+                                                   'divider definition')
           end
         end
 

data/lib/semantic_navigation/core/node.rb

@@ -1,8 +1,8 @@
 module SemanticNavigation
   module Core
     class Node < Navigation
-      include UrlMethods
-      include NameMethods
+      include MixIn::UrlMethods
+      include MixIn::NameMethods
 
       attr_accessor :link_classes, :node_classes,
                     :link_html, :node_html

data/lib/semantic_navigation/deprecations/renderers/acts_as_breadcrumb.rb

@@ -0,0 +1,14 @@
+module SemanticNavigation
+  module Renderers
+    module ActsAsBreadcrumb
+
+      def self.included(base)
+        SemanticNavigation.deprecation_message(:module,
+                          "SemanticNavigation::Renderers::ActsAsBreadcrumb",
+                          "SemanticNavigation::Renderers::MixIn::ActsAsBreadcrumb")
+        base.send :include, SemanticNavigation::Renderers::MixIn::ActsAsBreadcrumb
+      end
+
+    end
+  end
+end

data/lib/semantic_navigation/deprecations/renderers/acts_as_list.rb

@@ -0,0 +1,12 @@
+module SemanticNavigation
+  module Renderers
+    module ActsAsList
+      def self.included(base)
+        SemanticNavigation.deprecation_message(:module,
+                          "SemanticNavigation::Renderers::ActsAsList",
+                          "SemanticNavigation::Renderers::MixIn::ActsAsList")
+        base.send :include, SemanticNavigation::Renderers::MixIn::ActsAsList
+      end
+    end
+  end
+end

data/lib/semantic_navigation/deprecations/renderers/render_helpers.rb

@@ -0,0 +1,14 @@
+module SemanticNavigation
+  module Renderers
+    module RenderHelpers
+
+      def self.included(base)
+        SemanticNavigation.deprecation_message(:module,
+                          "SemanticNavigation::Renderers::RenderHelpers",
+                          "SemanticNavigation::Renderers::MixIn::RenderHelpers")
+        base.send :include, SemanticNavigation::Renderers::MixIn::RenderHelpers
+      end
+
+    end
+  end
+end

data/lib/semantic_navigation/helper_methods.rb

@@ -5,17 +5,21 @@ module SemanticNavigation::HelperMethods
     render_name ||= :list
     SemanticNavigation::Configuration.new.render(name, render_name, options, self)
   end
-  
-  def active_item_for(name, level = nil)
+
+  def active_item_for(name, level = nil, &block)
     SemanticNavigation::Configuration.view_object = self
     navigation = SemanticNavigation::Configuration.navigation(name)
     navigation.mark_active
     item = navigation
     while !item.is_a?(SemanticNavigation::Core::Leaf) &&
-          !item.sub_elements.find{|e| e.active}.nil? && 
+          !item.sub_elements.find{|e| e.active}.nil? &&
           (!level.nil? ? item.level < level : true)
       item = item.sub_elements.find{|e| e.active}
     end
-    item != navigation ? item.name(:active_item_for) : ''
+    if !block_given?
+      item != navigation ? item.name(:active_item_for) : ''
+    else
+      capture(item, &block)  
+    end
   end
 end

data/lib/semantic_navigation/railtie.rb

@@ -25,25 +25,15 @@ module SemanticNavigation
       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 SemanticNavigation::Railtie.actual_config_location
-      }
-    else
-      ActionDispatch::Callbacks.before {
-        load SemanticNavigation::Railtie.actual_config_location
-      }
-    end
+     if Rails.env == "production"
+       config.after_initialize {
+         load SemanticNavigation.actual_config_location
+       }
+     else
+       ActionDispatch::Callbacks.before {
+         load SemanticNavigation.actual_config_location
+       }
+     end
 
   end
 end

data/lib/semantic_navigation/renderers.rb

@@ -1,8 +1,15 @@
-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'
+%w(
+renderers/mix_in/render_helpers
+renderers/mix_in/acts_as_list
+renderers/mix_in/acts_as_breadcrumb
+deprecations/renderers/render_helpers
+deprecations/renderers/acts_as_breadcrumb
+deprecations/renderers/acts_as_list
+renderers/list
+renderers/bread_crumb
+twitter_bootstrap/breadcrumb
+twitter_bootstrap/list
+twitter_bootstrap/tabs
+).each do |file|
+  require "semantic_navigation/#{file}"
+end

data/lib/semantic_navigation/renderers/bread_crumb.rb

@@ -1,8 +1,8 @@
 module SemanticNavigation
   module Renderers
     class BreadCrumb
-      include RenderHelpers
-      include ActsAsBreadcrumb
+      include MixIn::RenderHelpers
+      include MixIn::ActsAsBreadcrumb
 
       style_accessor last_as_link: false,
                      breadcrumb_separator: '/'
@@ -27,8 +27,8 @@ module SemanticNavigation
         content_tag(:li, nil, {id: show_id(:leaf, object.id),
                                class: merge_classes(:leaf, object.active, object.classes)
                               }.merge(object.html)) do
-          link_to(object_name(object), 
-                  object.url, 
+          link_to(object_name(object),
+                  object.url,
                   {id: show_id(:link, object.id),
                    class: merge_classes(:link, object.active, object.link_classes)
                   }.merge(object.link_html))
@@ -44,8 +44,8 @@ module SemanticNavigation
                                class: merge_classes(:leaf, object.active, object.classes)
                               }.merge(object.html) do
           if last_as_link
-            link_to object_name(object), 
-                    object.url, 
+            link_to object_name(object),
+                    object.url,
                     {id: show_id(:link, object.id),
                      class: merge_classes(:link, object.active, object.link_classes)
                     }.merge(object.link_html)

data/lib/semantic_navigation/renderers/list.rb

@@ -1,8 +1,8 @@
 module SemanticNavigation
   module Renderers
     class List
-      include RenderHelpers
-      include ActsAsList
+      include MixIn::RenderHelpers
+      include MixIn::ActsAsList
 
       navigation_default_classes [:list]
 
@@ -20,8 +20,8 @@ module SemanticNavigation
         content_tag :li, nil, {id: show_id(:leaf, object.id),
                                class: merge_classes(:leaf, object.active, object.classes)
                               }.merge(object.html) do
-          link_to(object_name(object), 
-                  object.url, 
+          link_to(object_name(object),
+                  object.url,
                   {id: show_id(:link, object.id),
                    class: merge_classes(:link, object.active, object.link_classes)
                   }.merge(object.link_html))+
@@ -41,8 +41,8 @@ module SemanticNavigation
         content_tag :li, nil, {id: show_id(:leaf, object.id),
                                class: merge_classes(:leaf, object.active, object.classes)
                               }.merge(object.html) do
-          link_to object_name(object), 
-                  object.url, 
+          link_to object_name(object),
+                  object.url,
                   {id: show_id(:link, object.id),
                    class: merge_classes(:link, object.active, object.link_classes)
                   }.merge(object.link_html)

data/lib/semantic_navigation/renderers/mix_in/acts_as_breadcrumb.rb

@@ -0,0 +1,43 @@
+module SemanticNavigation
+  module Renderers
+    module MixIn
+      module ActsAsBreadcrumb
+
+        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(&: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}
+          if active_element && !active_element.id.in?([except_for].flatten) && active_element.render_if
+            render_element = active_element.render(self)
+          end
+          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
+end