semantic_navigation 0.0.14 → 0.1.0

data/Changelog.md

@@ -1,4 +1,9 @@
-### 0.0.14
+### 0.1.0 
+* Making register_renderer function to catch already registered renderer class by received symbol name
+* Added scoping for items definitions
+* Added renderers generators
+
+### 0.0.14 / August 29, 2012
 * Now in render_if proc there is possibility to catch self(rendering element)
 * Items accept procs for links definitions
 * Fixed bug in active_item_for method

data/README.md

@@ -4,7 +4,7 @@ This is semantic_navigation gem
 Forget fat layouts, views and controllers. This gem will do all the menu staff for you.
 You simply just have to generate configuration file, fill it with your menu hierarchy and renderer it wherever you want.
 
-Symply and customizable it will make for you all the routings you were spending a lot of time before.
+Simply and customizable it will make for you all the routins you were spending a lot of time before.
 
 * semantic_navigation supports defining as many separate menus as you want and they can be as deep as you need.
 * supports different styles of url definitions ('route#like', :symbols, 'strings', {hash: 'like'})
@@ -35,7 +35,7 @@ $ rails generate semantic_navigation:install
 
 ###Quick start
 
-Configure your navigation in config/semantic_navigation.rb
+Configure your navigation in config/initializers/semantic_navigation.rb
 
 <pre><code>
 SemanticNavigation::Configuration.run do
@@ -66,4 +66,4 @@ For the information of how to configure and render your navigation read the <a h
 Dependence:
 
 * Ruby >= 1.9.2
-* Rails >= 3.0.0 
+* Rails >= 3.0.0

data/lib/generators/semantic_navigation/breadcrumb_renderer/breadcrumb_renderer_generator.rb

@@ -0,0 +1,19 @@
+module SemanticNavigation
+  module Generators
+    class BreadcrumbRendererGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates list like rendering class"
+
+      def generate_list_renderer
+        template "breadcrumb_renderer.rb", "app/models/renderers/#{file_name}.rb"
+      end
+
+      def register_renderer
+        semantic_navigation_config = Railtie.actual_config_location
+        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/breadcrumb_renderer/templates/breadcrumb_renderer.rb

@@ -0,0 +1,62 @@
+class Renderers::<%= class_name %>
+  #Default render helpers. Do not delete this if don't want to write your own.      
+  include RenderHelpers
+  #The default list rendering logic. Do not delete if don't want to write your own.
+  include ActsAsBreadcrumb
+  style_accessor :last_as_link => false,
+                 :breadcrumb_separator => '/'
+
+  #Default navigation classes
+  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 ['<%= file_name %>']
+  node_default_classes ['<%= file_name %>']
+  leaf_default_classes ['<%= file_name %>']
+  link_default_classes ['<%= file_name %>']      
+
+  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))
+    end +
+    content_tag(:li) do
+      breadcrumb_separator
+    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
+      if last_as_link
+        link_to object_name(object), object.url, :id => show_id(:link, object.id),
+                                       :class => merge_classes(:link, object.active, object.link_classes)
+      else
+        object_name(object)
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module SemanticNavigation
     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
         +===============================================================+
@@ -12,7 +12,7 @@ module SemanticNavigation
         | http://github.com/fr33z3/semantic_navigation/wiki.            |
         +===============================================================+
         EOM
-        copy_file "semantic_navigation.rb", "config/semantic_navigation.rb"
+        copy_file "semantic_navigation.rb", "config/initializers/semantic_navigation.rb"
         copy_file "semantic_navigation.en.yml", "config/locales/semantic_navigation.en.yml"
       end
     end

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

@@ -2,20 +2,20 @@
 SemanticNavigation::Configuration.run do
   # Read wiki https://github.com/fr33z3/semantic_navigation/wiki to lear about
   # semantic_navigation configuration
-  
+
   #Override renderer default styles:
   #styles_for :list do
   #  show_navigation_active_class true
   #  navigation_active_class [:some_active_class]
   #end
-  
+
   # You can register your custom renderer:
   #register_renderer :some_renderer, SomeRendererClass
-  
+
   # The example of the navigation:
   #navigate :navigation do
   #  header :header_item, :name => 'Header Item'
-  #  item :first_item, :first_item_route, :ico => 'user' do 
+  #  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
@@ -24,6 +24,6 @@ SemanticNavigation::Configuration.run do
   #  divider
   #  item :second_item, :second_item_route
   #end
-  
+
 end
 

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

@@ -0,0 +1,19 @@
+module SemanticNavigation
+  module Generators
+    class ListRendererGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates list like rendering class"
+
+      def generate_list_renderer
+        template "list_renderer.rb", "app/models/renderers/#{file_name}.rb"
+      end
+
+      def register_renderer
+        semantic_navigation_config = Railtie.actual_config_location
+        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

@@ -0,0 +1,64 @@
+class Renderers::<%= class_name %>
+  #Default render helpers. Do not delete this if don't want to write your own.
+  include SemanticNavigation::Renderers::RenderHelpers
+  #The default list rendering logic. Do not delete if don't want to write your own.
+  include SemanticNavigation::Renderers::ActsAsList
+
+  #Default navigation classes
+  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 ['<%= file_name %>']
+  node_default_classes ['<%= file_name %>']
+  leaf_default_classes ['<%= file_name %>']
+  link_default_classes ['<%= file_name %>']
+
+  private
+
+  #Main navigation block
+  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
+
+  #Navigation node block
+  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
+
+  #Block rendering inside the node block
+  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
+    end
+  end
+
+  #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
+      link_to object_name(object), object.url, :id => show_id(:link, object.id),
+                                       :class => merge_classes(:link, object.active, object.link_classes)
+    end
+  end
+end

data/lib/semantic_navigation/configuration.rb

@@ -1,6 +1,6 @@
 module SemanticNavigation
   class Configuration
-    
+
     @@view_object = nil
     @@navigations = {}
     @@renderers = {}
@@ -9,7 +9,7 @@ module SemanticNavigation
     def self.run(&block)
       self.class_eval &block if block_given?
     end
-    
+
     def self.navigate(id, options = {}, &block)
       options[:id] = id.to_sym
       options[:i18n_name] = "semantic_navigation.#{id}"
@@ -17,7 +17,7 @@ module SemanticNavigation
       navigation.instance_eval &block if block_given?
       @@navigations[id.to_sym] = navigation
     end
-    
+
     def render(menu_id, renderer_name, options, view_object)
       @@view_object = view_object
       renderer = @@renderers[renderer_name].new
@@ -25,23 +25,23 @@ module SemanticNavigation
         renderer.instance_eval &@@render_styles[renderer_name]
       end
       options.keys.each{|key| renderer.send "#{key}=", options[key]}
-      renderer.name = renderer_name      
+      renderer.name = renderer_name
       navigation = @@navigations[menu_id]
       navigation.mark_active
       navigation.render(renderer)
     end
-    
+
     def self.styles_for(name)
       @@render_styles[name.to_sym] = proc
     end
-       
+
     def self.register_renderer(*options)
       if options.count == 1
         name = options[0].name.demodulize.underscore.to_sym
         renderer_class = options[0]
-      elsif options.count == 2 
+      elsif options.count == 2
         name = options[0].to_sym
-        renderer_class = options[1]
+        renderer_class = options[1].is_a?(Symbol) ? @@renderers[options[1]] : options[1]
       end
       @@renderers[name] = renderer_class
       SemanticNavigation::HelperMethods.class_eval "
@@ -51,7 +51,7 @@ module SemanticNavigation
         end
       "
     end
-    
+
     def self.view_object
       @@view_object
     end
@@ -59,7 +59,7 @@ module SemanticNavigation
     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,4 +1,8 @@
-require 'semantic_navigation/core/base'
-require 'semantic_navigation/core/navigation'
-require 'semantic_navigation/core/leaf'
-require 'semantic_navigation/core/node'
+required_files = %w(base
+                    url_methods
+                    name_methods
+                    navigation
+                    leaf node)
+required_files.each do |file|
+  require "semantic_navigation/core/#{file}"
+end

data/lib/semantic_navigation/core/base.rb

@@ -1,14 +1,14 @@
 module SemanticNavigation
   module Core
-    class Base      
-      
+    class Base
+
       attr_accessor :id, :level, :classes, :active
       attr_writer :render_if
-      
+
       def render_if
         !@render_if.nil? ? view_object.instance_exec(self, &@render_if) : true
       end
-      
+
       def initialize(options, level)
         @level = level
         options.keys.each do |option_name|
@@ -20,9 +20,9 @@ module SemanticNavigation
         class_name = self.class.name.split('::').last.downcase
         renderer.send :"render_#{class_name}", self
       end
-      
+
       private
-      
+
       def view_object
         SemanticNavigation::Configuration.view_object
       end
@@ -38,7 +38,7 @@ module SemanticNavigation
         end
         result
       end
-      
-    end    
+
+    end
   end
 end

data/lib/semantic_navigation/core/leaf.rb

@@ -1,23 +1,15 @@
 module SemanticNavigation
   module Core
     class Leaf < Base
+      include UrlMethods
+      include NameMethods
+
       attr_accessor :link_classes
-      
-      def url
-        urls.first
-      end
 
       def initialize(options, level)
         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
         if @url
           @active = urls.map{|u| current_page?(u) rescue false}.reduce(:"|")
@@ -26,26 +18,6 @@ module SemanticNavigation
         end
       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
 end

data/lib/semantic_navigation/core/name_methods.rb

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