simple-navigation 1.3.1 → 1.4.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+*1.4.0 
+
+* added the capability to have several navigation-contexts
+* doc-fix
+
 *1.3.1
 
 * now compliant with ruby 1.9.1 (thanks to Gernot Kogler for the feedback)

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 0
 :major: 1
-:minor: 3
+:minor: 4

data/lib/simple_navigation.rb

@@ -1,25 +1,40 @@
 # A plugin for generating a simple navigation. See README for resources on usage instructions.
 module SimpleNavigation
 
-  mattr_accessor :config_file
+  mattr_accessor :config_files
   mattr_accessor :config_file_path
   mattr_accessor :controller
+  self.config_files = {}
   
-  # Reads the specified config_file and stores it for later evaluation.
-  def self.load_config
-    raise "config_file_path is not set!" unless self.config_file_path
-    raise "Config file '#{config_file_path}' does not exists!" unless File.exists?(self.config_file_path)
-    self.config_file = IO.read(self.config_file_path)
-  end
+  class << self
+  
+    # Reads the config_file for the specified navigation_context and stores it for later evaluation.
+    def load_config(navigation_context = :default)
+      raise "config_file_path is not set!" unless self.config_file_path
+      raise "Config file '#{config_file_name(navigation_context)}' does not exists!" unless File.exists?(config_file_name(navigation_context))
+      if ::RAILS_ENV == 'production'
+        self.config_files[navigation_context] ||= IO.read(config_file_name(navigation_context))
+      else
+        self.config_files[navigation_context] = IO.read(config_file_name(navigation_context))
+      end
+    end
 
-  # Returns the singleton instance of the SimpleNavigation::Configuration
-  def self.config 
-    Configuration.instance
-  end
+    # Returns the singleton instance of the SimpleNavigation::Configuration
+    def config 
+      Configuration.instance
+    end
   
-  # Returns the ItemContainer that contains the items for the primary navigation
-  def self.primary_navigation
-    config.primary_navigation
+    # Returns the ItemContainer that contains the items for the primary navigation
+    def primary_navigation
+      config.primary_navigation
+    end
+  
+    # Returns the path to the config_file for the given navigation_context
+    def config_file_name(navigation_context = :default)
+      file_name = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
+      File.join(config_file_path, "#{file_name}navigation.rb")
+    end
+
   end
 
 end

data/lib/simple_navigation/configuration.rb

@@ -14,9 +14,9 @@ module SimpleNavigation
 
     class << self
 
-      # Evals the config_file inside the specified context (usually a controller or view)
-      def eval_config(context)
-        context.instance_eval(SimpleNavigation.config_file)
+      # Evals the config_file for the given navigation_context inside the specified context (usually a controller or view)
+      def eval_config(context, navigation_context = :default)
+        context.instance_eval(SimpleNavigation.config_files[navigation_context])
         SimpleNavigation.controller = extract_controller_from context
       end
 

data/lib/simple_navigation/controller_methods.rb

@@ -28,11 +28,11 @@ module SimpleNavigation
   #     
   #     def your_special_action
   #       ...
-  #       current_navigation :special
+  #       current_navigation :account, :special
   #     end
   #   end
   #
-  # This overrides :account as active navigation for your_special_action and sets it to :special.
+  # The code above still sets the active primary navigation to :account but also sets the sub_navigation to :special for 'your_special_action'.
   #
   # Note: The specified symbols must match the keys for your navigation items in your config/navigation.rb file.
   module ControllerMethods

data/lib/simple_navigation/helpers.rb

@@ -15,16 +15,29 @@ module SimpleNavigation
   #
   module Helpers
     
-    # Renders the navigation according to the specified <tt>level</tt>. 
-    # 
-    # The <tt>level</tt> defaults to :nested which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
-    # 
-    # Other possible levels are 
-    # 
-    # :primary which only renders the primary_navigation (also see render_primary_navigation) and :secondary which only renders the sub_navigation (see render_sub_navigation).
-    def render_navigation(level = :nested)
-      SimpleNavigation.load_config unless ::RAILS_ENV == 'production'
-      SimpleNavigation::Configuration.eval_config(self)
+    # Renders the navigation according to the specified options-hash. 
+    #
+    # The following options are supported:
+    # * <tt>level</tt> - defaults to :nested which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
+    #   Other possible levels are :primary which only renders the primary_navigation (also see render_primary_navigation) and :secondary which only renders the sub_navigation (see render_sub_navigation).
+    # * <tt>context</tt> - specifies the context for which you would render the navigation. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb)
+    #   if you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>render_navigation(:context => :admin)</tt> the file config/admin_navigation.rb
+    #   will be loaded and used for rendering the navigation.
+    #   
+    def render_navigation(*args)
+      args = [Hash.new] if args.empty?
+      default_options = {:context => :default, :level => :nested}
+      level, navigation_context = case args.first 
+      when Hash
+        options = default_options.merge(args.first)
+        [options[:level], options[:context]]
+      when Symbol
+        [args[0], default_options.merge(args[1] || {})[:context]]
+      else
+        raise ArgumentError, "Invalid arguments"
+      end
+      SimpleNavigation.load_config(navigation_context)
+      SimpleNavigation::Configuration.eval_config(self, navigation_context)
       case level
       when :primary
         SimpleNavigation.primary_navigation.render(@current_primary_navigation)
@@ -38,14 +51,14 @@ module SimpleNavigation
       end
     end
     
-    # Renders the primary_navigation with the configured renderer. Calling render_navigation(:primary) has the same effect.
-    def render_primary_navigation
-      render_navigation(:primary)
+    # Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => :primary) has the same effect.
+    def render_primary_navigation(options = {})
+      render_navigation(options.merge(:level => :primary))
     end
     
-    # Renders the sub_navigation with the configured renderer. Calling render_navigation(:secondary) has the same effect.
-    def render_sub_navigation
-      render_navigation(:secondary)
+    # Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => :secondary) has the same effect.
+    def render_sub_navigation(options = {})
+      render_navigation(options.merge(:level => :secondary))
     end
     
   end

data/rails/init.rb

@@ -1,4 +1,3 @@
-default_config_file_path = File.join(RAILS_ROOT, 'config', 'navigation.rb')
+default_config_file_path = File.join(RAILS_ROOT, 'config')
 SimpleNavigation.config_file_path = default_config_file_path unless SimpleNavigation.config_file_path
-SimpleNavigation.load_config
 ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)

data/simple-navigation.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple-navigation}
-  s.version = "1.3.1"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andi Schacke"]
-  s.date = %q{2009-06-28}
+  s.date = %q{2009-08-10}
   s.description = %q{Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.}
   s.email = %q{andreas.schacke@gmail.com}
   s.extra_rdoc_files = [

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -18,13 +18,21 @@ describe SimpleNavigation::Configuration do
     before(:each) do
       @context = mock(:context)
       @context.stub!(:instance_eval)
-      @config_file = stub(:config_file)
-      SimpleNavigation.stub!(:config_file).and_return(@config_file)
+      @config_files = {:default => 'default', :my_context => 'my_context'}
+      SimpleNavigation.stub!(:config_files).and_return(@config_files)
+    end
+    context "with default navigation context" do
+      it "should instance_eval the default config_file-string inside the context" do
+        @context.should_receive(:instance_eval).with('default')
+        SimpleNavigation::Configuration.eval_config(@context)
+      end    
+    end
+    context 'with non default navigation context' do
+      it "should instance_eval the specified config_file-string inside the context" do
+        @context.should_receive(:instance_eval).with('my_context')
+        SimpleNavigation::Configuration.eval_config(@context, :my_context)
+      end
     end
-    it "should instance_eval the config_file-string inside the context" do
-      @context.should_receive(:instance_eval).with(@config_file)
-      SimpleNavigation::Configuration.eval_config(@context)
-    end    
     it "should set the controller" do
       @controller = stub(:controller)
       SimpleNavigation::Configuration.should_receive(:extract_controller_from).with(@context).and_return(@controller)

data/spec/lib/simple_navigation/helpers_spec.rb

@@ -15,50 +15,23 @@ describe SimpleNavigation::Helpers do
   
   describe 'render_navigation' do
     describe 'regarding loading of the config-file' do
-      context "RAILS_ENV undefined" do
-        before(:each) do
-          ::RAILS_ENV = nil
-        end
-        it "should load the config file" do
-          SimpleNavigation.should_receive(:load_config)
+      context 'no options specified' do
+        it "should load the config-file for the default context" do
+          SimpleNavigation.should_receive(:load_config).with(:default)
           @controller.render_navigation
         end
       end
-      context "RAILS_ENV defined" do
-        before(:each) do
-          ::RAILS_ENV = 'production'
-        end
-        context "RAILS_ENV=production" do
-          it "should not load the config file" do
-            SimpleNavigation.should_not_receive(:load_config)
-            @controller.render_navigation          
-          end
-        end
-        
-        context "RAILS_ENV=development" do
-          before(:each) do
-            ::RAILS_ENV = 'development'
-          end
-          it "should load the config file" do
-            SimpleNavigation.should_receive(:load_config)
-            @controller.render_navigation
-          end
-        end
-        
-        context "RAILS_ENV=test" do
-          before(:each) do
-            ::RAILS_ENV = 'test'
-          end
-          it "should load the config file" do
-            SimpleNavigation.should_receive(:load_config)
-            @controller.render_navigation
-          end
+      
+      context 'with options specified' do
+        it "should load the config-file for the specified context" do
+          SimpleNavigation.should_receive(:load_config).with(:my_context)
+          @controller.render_navigation(:context => :my_context)
         end
       end
     end
     
     it "should eval the config on every request" do
-      SimpleNavigation::Configuration.should_receive(:eval_config).with(@controller)
+      SimpleNavigation::Configuration.should_receive(:eval_config).with(@controller, :default)
       @controller.render_navigation
     end
     
@@ -70,6 +43,10 @@ describe SimpleNavigation::Helpers do
         @primary_navigation.should_receive(:render).with(:current_primary)
         @controller.render_navigation(:primary)
       end
+      it "should call render on the primary_navigation (specifying level through options)" do
+        @primary_navigation.should_receive(:render).with(:current_primary)
+        @controller.render_navigation(:level => :primary)
+      end
     end
     
     context 'secondary' do
@@ -125,20 +102,22 @@ describe SimpleNavigation::Helpers do
     end
     
     context 'unknown level' do
-      it {lambda {@controller.render_navigation(:unknown)}.should raise_error(ArgumentError)}
+      it "should raise an error" do
+        lambda {@controller.render_navigation(:unknown)}.should raise_error(ArgumentError)
+      end
     end
   end
   
   describe 'render_primary_navigation' do  
     it "should delegate to render_navigation(:primary)" do
-      @controller.should_receive(:render_navigation).with(:primary)
+      @controller.should_receive(:render_navigation).with(:level => :primary)
       @controller.render_primary_navigation
     end
   end
   
   describe 'render_sub_navigation' do
     it "should delegate to render_navigation(:secondary)" do
-      @controller.should_receive(:render_navigation).with(:secondary)
+      @controller.should_receive(:render_navigation).with(:level => :secondary)
       @controller.render_sub_navigation
     end
   end

data/spec/lib/simple_navigation_spec.rb

@@ -2,10 +2,40 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe SimpleNavigation do
   
+  describe 'config_files' do
+    before(:each) do
+      SimpleNavigation.config_files = {}
+    end
+    it "should be an empty hash after loading the module" do
+      SimpleNavigation.config_files.should == {}
+    end
+  end
+  
+  describe 'config_file_name' do
+    before(:each) do
+      SimpleNavigation.config_file_path = 'path_to_config'
+    end
+    context 'for :default navigation_context' do
+      it "should return the path to default config file" do
+        SimpleNavigation.config_file_name.should == 'path_to_config/navigation.rb'
+      end
+    end
+    
+    context 'for other navigation_context' do
+      it "should return the path to the config file matching the specified context" do
+        SimpleNavigation.config_file_name(:my_other_context).should == 'path_to_config/my_other_context_navigation.rb'
+      end
+      it "should convert camelcase-contexts to underscore" do
+        SimpleNavigation.config_file_name(:WhyWouldYouDoThis).should == 'path_to_config/why_would_you_do_this_navigation.rb'
+      end
+    end
+  end
+  
   describe 'load_config' do
     context 'config_file_path is set' do
       before(:each) do
         SimpleNavigation.config_file_path = 'path_to_config'
+        #SimpleNavigation.stub!(:config_file_name => 'path_to_config/navigation.rb')
       end
       
       context 'config_file does exist' do
@@ -16,13 +46,19 @@ describe SimpleNavigation do
         it "should not raise an error" do
           lambda{SimpleNavigation.load_config}.should_not raise_error
         end
-        it "should read the config file from disc" do
-          IO.should_receive(:read).with('path_to_config')
+        it "should read the specified config file from disc" do
+          IO.should_receive(:read).with('path_to_config/navigation.rb')
           SimpleNavigation.load_config
         end
-        it "should store the read content in the module" do
-          SimpleNavigation.should_receive(:config_file=).with('file_content')
+        it "should store the read content in the module (default context)" do
+          SimpleNavigation.should_receive(:config_file_name).with(:default).twice
           SimpleNavigation.load_config
+          SimpleNavigation.config_files[:default].should == 'file_content'
+        end
+        it "should store the content in the module (non default context)" do
+          SimpleNavigation.should_receive(:config_file_name).with(:my_context).twice
+          SimpleNavigation.load_config(:my_context)
+          SimpleNavigation.config_files[:my_context].should == 'file_content'
         end
       end
       
@@ -40,6 +76,61 @@ describe SimpleNavigation do
       end
       it {lambda{SimpleNavigation.load_config}.should raise_error}
     end
+    
+    describe 'regarding caching of the config-files' do
+      before(:each) do
+        IO.stub!(:read).and_return('file_content')
+        SimpleNavigation.config_file_path = 'path_to_config'
+        File.stub!(:exists? => true)
+      end
+      context "RAILS_ENV undefined" do
+        before(:each) do
+          ::RAILS_ENV = nil
+        end
+        it "should load the config file twice" do
+          IO.should_receive(:read).twice
+          SimpleNavigation.load_config
+          SimpleNavigation.load_config
+        end
+      end
+      context "RAILS_ENV defined" do
+        before(:each) do
+          ::RAILS_ENV = 'production'
+        end
+        context "RAILS_ENV=production" do
+          it "should load the config file only once" do
+            IO.should_receive(:read).once
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config   
+          end
+        end
+        
+        context "RAILS_ENV=development" do
+          before(:each) do
+            ::RAILS_ENV = 'development'
+          end
+          it "should load the config file twice" do
+            IO.should_receive(:read).twice
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config
+          end
+        end
+        
+        context "RAILS_ENV=test" do
+          before(:each) do
+            ::RAILS_ENV = 'test'
+          end
+          it "should load the config file twice" do
+            IO.should_receive(:read).twice
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config
+          end
+        end
+      end
+      after(:each) do
+        SimpleNavigation.config_files = {}
+      end
+    end
   end
   
   describe 'config' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-28 00:00:00 +02:00
+date: 2009-08-10 00:00:00 +02:00
 default_executable: 
 dependencies: []