simple-navigation 2.2.2 → 2.2.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+*2.2.3
+
+* changed error handling in config-file. Do not ignore errors in config-file anymore. 
+* only load config-file if it is present. Needed when directly providing items in render_navigation.
+
 *2.2.2
 
 * added lib/simple-navigation.rb to allow 'require simple-navigation' or 'config.gem "simple-navigation"'

data/VERSION.yml

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

data/lib/simple_navigation.rb

@@ -18,10 +18,14 @@ module SimpleNavigation
   
   class << self
   
+    def config_file?(navigation_context=nil)
+      File.exists?(config_file_name(navigation_context))
+    end
+  
     # 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))
+      raise "Config file '#{config_file_name(navigation_context)}' does not exists!" unless config_file?(navigation_context)
       if ::RAILS_ENV == 'production'
         self.config_files[navigation_context] ||= IO.read(config_file_name(navigation_context))
       else
@@ -29,6 +33,18 @@ module SimpleNavigation
       end
     end
 
+    def set_template_from(context)
+      SimpleNavigation.controller = extract_controller_from context
+      SimpleNavigation.template = SimpleNavigation.controller.instance_variable_get(:@template)
+    end
+
+    # Returns the context in which the config file should be evaluated.
+    # This is preferably the template, otherwise te controller
+    def context_for_eval
+      raise 'no context set for evaluation the config file' unless SimpleNavigation.template || SimpleNavigation.controller
+      SimpleNavigation.template || SimpleNavigation.controller
+    end
+
     # Returns the singleton instance of the SimpleNavigation::Configuration
     def config 
       SimpleNavigation::Configuration.instance
@@ -88,8 +104,18 @@ module SimpleNavigation
       end
     end
 
+    # Extracts a controller from the context.
+    def extract_controller_from(context)
+      if context.respond_to? :controller
+        context.controller
+      else
+        context
+      end
+    end
+
     private
   
+  
     # TODO: refactor this ugly thing to make it nice and short
     def parse_explicit_navigation_args
       args = SimpleNavigation.explicit_navigation_args

data/lib/simple_navigation/configuration.rb

@@ -14,31 +14,14 @@ module SimpleNavigation
 
       # 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)
-        SimpleNavigation.controller = extract_controller_from context
-        SimpleNavigation.template = SimpleNavigation.controller.instance_variable_get(:@template)
-        context_for_eval.instance_eval(SimpleNavigation.config_files[navigation_context])
+        SimpleNavigation.set_template_from context
+        SimpleNavigation.context_for_eval.instance_eval(SimpleNavigation.config_files[navigation_context])
       end
       
       # Starts processing the configuration
       def run(&block)
         block.call Configuration.instance
       end    
-
-      # Returns the context in which the config file should be evaluated.
-      # This is preferably the template, otherwise te controller
-      def context_for_eval
-        raise 'no context set for evaluation the config file' unless SimpleNavigation.template || SimpleNavigation.controller
-        SimpleNavigation.template || SimpleNavigation.controller
-      end
-
-      # Extracts a controller from the context.
-      def extract_controller_from(context)
-        if context.respond_to? :controller
-          context.controller
-        else
-          context
-        end
-      end
       
     end #class << self
     

data/lib/simple_navigation/helpers.rb

@@ -35,8 +35,11 @@ module SimpleNavigation
       options = extract_backwards_compatible_options(*args)
       options = {:context => :default, :level => :all}.merge(options)
       ctx = options.delete(:context)
-      SimpleNavigation.load_config(ctx) rescue nil
-      SimpleNavigation::Configuration.eval_config(self, ctx) rescue nil
+      SimpleNavigation.set_template_from self
+      if SimpleNavigation.config_file?(ctx)
+        SimpleNavigation.load_config(ctx) 
+        SimpleNavigation::Configuration.eval_config(self, ctx) 
+      end
       SimpleNavigation.config.items(options[:items]) if options[:items]
       SimpleNavigation.handle_explicit_navigation
       raise "no primary navigation defined, either use a navigation config file or pass items directly to render_navigation" unless SimpleNavigation.primary_navigation

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -18,7 +18,7 @@ describe SimpleNavigation::Configuration do
     before(:each) do
       @context = mock(:context)
       @context.stub!(:instance_eval)
-      SimpleNavigation::Configuration.stub!(:context_for_eval => @context)
+      SimpleNavigation.stub!(:context_for_eval => @context)
       @config_files = {:default => 'default', :my_context => 'my_context'}
       SimpleNavigation.stub!(:config_files).and_return(@config_files)
     end
@@ -34,82 +34,9 @@ describe SimpleNavigation::Configuration do
         SimpleNavigation::Configuration.eval_config(@context, :my_context)
       end
     end
-    it "should set the controller" do
-      @controller = stub(:controller)
-      SimpleNavigation::Configuration.should_receive(:extract_controller_from).with(@context).and_return(@controller)
-      SimpleNavigation.should_receive(:controller=).with(@controller)
-      SimpleNavigation::Configuration.eval_config(@context)
-    end
-    it "should set the template" do
-      @template = stub(:template)
-      @controller = stub(:controller, :instance_variable_get => @template)
-      SimpleNavigation.stub!(:controller => @controller)
-      SimpleNavigation.should_receive(:template=).with(@template)
-      SimpleNavigation::Configuration.eval_config(@context)
-    end
-  end
-
-  describe 'context_for_eval' do
-    context 'controller is present' do
-      before(:each) do
-        @controller = stub(:controller)
-        SimpleNavigation.stub!(:controller => @controller)
-      end
-      context 'template is present' do
-        before(:each) do
-          @template = stub(:template)
-          SimpleNavigation.stub!(:template => @template)
-        end
-        it {SimpleNavigation::Configuration.context_for_eval.should == @template}
-      end
-      context 'template is not present' do
-        before(:each) do
-          SimpleNavigation.stub!(:template => nil)
-        end
-        it {SimpleNavigation::Configuration.context_for_eval.should == @controller}
-      end
-    end
-    context 'controller is not present' do
-      before(:each) do
-        SimpleNavigation.stub!(:controller => nil)
-      end
-      context 'template is present' do
-        before(:each) do
-          @template = stub(:template)
-          SimpleNavigation.stub!(:template => @template)
-        end
-        it {SimpleNavigation::Configuration.context_for_eval.should == @template}
-      end
-      context 'template is not present' do
-        before(:each) do
-          SimpleNavigation.stub!(:template => nil)
-        end
-        it {lambda {SimpleNavigation::Configuration.context_for_eval}.should raise_error}
-      end
-    end
-  end
-
-  describe 'self.extract_controller_from' do
-    before(:each) do
-      @nav_context = stub(:nav_context)
-    end
-    
-    context 'object responds to controller' do
-      before(:each) do
-        @controller = stub(:controller)
-        @nav_context.stub!(:controller).and_return(@controller)
-      end
-      
-      it "should return the controller" do
-        SimpleNavigation::Configuration.extract_controller_from(@nav_context).should == @controller
-      end
-      
-    end
-    
-    context 'object does not respond to controller' do
-      it "should return the nav_context" do
-        SimpleNavigation::Configuration.extract_controller_from(@nav_context).should == @nav_context
-      end
+    it "should set the template from the specified context" do
+      SimpleNavigation.should_receive(:set_template_from).with(@context)
+      SimpleNavigation::Configuration.eval_config(@context, :my_context)
     end
   end
   

data/spec/lib/simple_navigation/helpers_spec.rb

@@ -11,28 +11,49 @@ describe SimpleNavigation::Helpers do
     SimpleNavigation::Configuration.stub!(:eval_config)
     @primary_navigation = stub(:primary_navigation, :null_object => true)
     SimpleNavigation.stub!(:primary_navigation).and_return(@primary_navigation)
+    SimpleNavigation.stub!(:config_file? => true)
   end
   
   describe 'render_navigation' do
-    describe 'regarding loading of the config-file' do
-      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
+    
+    context 'with config_file present' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file? => true)
+      end
+      describe 'regarding loading of the config-file' do
+        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
-      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)
+    
+        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, :default)
+        @controller.render_navigation
+      end
     end
-    
-    it "should eval the config on every request" do
-      SimpleNavigation::Configuration.should_receive(:eval_config).with(@controller, :default)
-      @controller.render_navigation
+    context 'with config_file not present' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file? => false)
+      end
+      it "should not load the config file" do
+        SimpleNavigation.should_not_receive(:load_config)
+        @controller.render_navigation
+      end
+  
+      it "should not eval the config on every request" do
+        SimpleNavigation::Configuration.should_not_receive(:eval_config)
+        @controller.render_navigation
+      end
     end
         
     describe 'regarding setting of items' do

data/spec/lib/simple_navigation_spec.rb

@@ -11,6 +11,28 @@ describe SimpleNavigation do
     end
   end
   
+  describe 'config_file?' do
+    before(:each) do
+      SimpleNavigation.stub!(:config_file_name => 'file_name')
+    end
+    it "should check for the file existance with the file_name" do
+      File.should_receive(:exists?).with('file_name')
+      SimpleNavigation.config_file?(:ctx)
+    end
+    context 'config file exists' do
+      before(:each) do
+        File.stub!(:exists? => true)
+      end
+      it {SimpleNavigation.config_file?(:ctx).should be_true}
+    end
+    context 'config file does not exist' do
+      before(:each) do
+        File.stub!(:exists? => false)
+      end
+      it {SimpleNavigation.config_file?(:ctx).should be_false}
+    end
+  end
+  
   describe 'config_file_name' do
     before(:each) do
       SimpleNavigation.config_file_path = 'path_to_config'
@@ -31,6 +53,91 @@ describe SimpleNavigation do
     end
   end
   
+  describe 'set_template_from' do
+    before(:each) do
+      @context = stub :context
+      SimpleNavigation.stub!(:extract_controller_from => @controller)
+    end
+    it "should set the controller" do
+      @controller = stub(:controller)
+      SimpleNavigation.should_receive(:extract_controller_from).with(@context).and_return(@controller)
+      SimpleNavigation.should_receive(:controller=).with(@controller)
+      SimpleNavigation.set_template_from @context
+    end
+    it "should set the template" do
+      @template = stub(:template)
+      @controller = stub(:controller, :instance_variable_get => @template)
+      SimpleNavigation.stub!(:controller => @controller)
+      SimpleNavigation.should_receive(:template=).with(@template)
+      SimpleNavigation.set_template_from @context
+    end
+  end
+
+  describe 'self.extract_controller_from' do
+    before(:each) do
+      @nav_context = stub(:nav_context)
+    end
+    
+    context 'object responds to controller' do
+      before(:each) do
+        @controller = stub(:controller)
+        @nav_context.stub!(:controller).and_return(@controller)
+      end
+      
+      it "should return the controller" do
+        SimpleNavigation.send(:extract_controller_from, @nav_context).should == @controller
+      end
+      
+    end
+    
+    context 'object does not respond to controller' do
+      it "should return the nav_context" do
+        SimpleNavigation.send(:extract_controller_from, @nav_context).should == @nav_context
+      end
+    end
+  end
+  
+  describe 'context_for_eval' do
+    context 'controller is present' do
+      before(:each) do
+        @controller = stub(:controller)
+        SimpleNavigation.stub!(:controller => @controller)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          SimpleNavigation.stub!(:template => @template)
+        end
+        it {SimpleNavigation.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          SimpleNavigation.stub!(:template => nil)
+        end
+        it {SimpleNavigation.context_for_eval.should == @controller}
+      end
+    end
+    context 'controller is not present' do
+      before(:each) do
+        SimpleNavigation.stub!(:controller => nil)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          SimpleNavigation.stub!(:template => @template)
+        end
+        it {SimpleNavigation.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          SimpleNavigation.stub!(:template => nil)
+        end
+        it {lambda {SimpleNavigation.context_for_eval}.should raise_error}
+      end
+    end
+  end
+
+
   describe 'load_config' do
     context 'config_file_path is set' do
       before(:each) do
@@ -40,7 +147,7 @@ describe SimpleNavigation do
       
       context 'config_file does exist' do
         before(:each) do
-          File.stub!(:exists?).and_return(true)
+          SimpleNavigation.stub!(:config_file? => true)
           IO.stub!(:read).and_return('file_content')
         end
         it "should not raise an error" do
@@ -51,12 +158,12 @@ describe SimpleNavigation do
           SimpleNavigation.load_config
         end
         it "should store the read content in the module (default context)" do
-          SimpleNavigation.should_receive(:config_file_name).with(:default).twice
+          SimpleNavigation.should_receive(:config_file_name).with(:default)
           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.should_receive(:config_file_name).with(:my_context)
           SimpleNavigation.load_config(:my_context)
           SimpleNavigation.config_files[:my_context].should == 'file_content'
         end
@@ -64,7 +171,7 @@ describe SimpleNavigation do
       
       context 'config_file does not exist' do
         before(:each) do
-          File.stub!(:exists?).and_return(false)
+          SimpleNavigation.stub!(:config_file? => false)
         end
         it {lambda{SimpleNavigation.load_config}.should raise_error}
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 +01:00
+date: 2010-02-21 00:00:00 +01:00
 default_executable: 
 dependencies: []