simple-navigation 2.7.1 → 2.7.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+*2.7.2
+
+* added ability to have more than one config_file_path (useful if simple-navigation is used as a part of another gem/plugin). Credits to Luke Imhoff.
+
 *2.7.1
 
 * added SimpleNavigation.request and SimpleNavigation.request_uri as abstraction for getting request_uri (rails2/rails3)

data/VERSION.yml

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

data/lib/simple_navigation.rb

@@ -16,7 +16,7 @@ require 'simple_navigation/railtie' if Rails::VERSION::MAJOR == 3
 # A plugin for generating a simple navigation. See README for resources on usage instructions.
 module SimpleNavigation
 
-  mattr_accessor :config_files, :config_file_path, :default_renderer, :controller, :template, :explicit_current_navigation, :rails_env, :rails_root, :registered_renderers
+  mattr_accessor :config_files, :config_file_paths, :default_renderer, :controller, :template, :explicit_current_navigation, :rails_env, :rails_root, :registered_renderers
 
   self.config_files = {}
   self.registered_renderers = {
@@ -30,7 +30,7 @@ module SimpleNavigation
 
     # Sets the config file path and installs the ControllerMethods in ActionController::Base.
     def init_rails
-      SimpleNavigation.config_file_path = SimpleNavigation.default_config_file_path unless SimpleNavigation.config_file_path
+      SimpleNavigation.config_file_paths ||= [SimpleNavigation.default_config_file_path]
       ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
     end
   
@@ -40,17 +40,42 @@ module SimpleNavigation
   
     # Returns true if the config_file for specified context does exist.
     def config_file?(navigation_context = :default)
-      File.exists?(config_file_name(navigation_context))
+      !!config_file(navigation_context)
+    end
+    
+    # Returns the config file for the given navigation context or nil if no matching config file can be found.
+    # If multiple config_paths are set, it returns the first matching file.
+    #
+    def config_file(navigation_context = :default)
+      config_file_paths.collect { |path| File.join(path, config_file_name(navigation_context)) }.detect {|full_path| File.exists?(full_path)}
+    end
+  
+    # Returns the name of the config file for the given navigation_context
+    def config_file_name(navigation_context = :default)
+      prefix = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
+      "#{prefix}navigation.rb"      
+    end
+
+    # Returns a nice sentence including all config_paths
+    def config_file_paths_sentence
+      self.config_file_paths.to_sentence(
+        :last_word_connector => ', or ',
+        :two_words_connector => ' or '
+      )
+    end
+    
+    # Sets the config_file_path
+    def config_file_path=(path)
+      self.config_file_paths = [path]
     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 config_file?(navigation_context)
+      raise "Config file for #{navigation_context} context not found in #{config_file_paths_sentence}!" unless config_file?(navigation_context)      
       if SimpleNavigation.rails_env == 'production'
-        self.config_files[navigation_context] ||= IO.read(config_file_name(navigation_context))
+        self.config_files[navigation_context] ||= IO.read(config_file(navigation_context))
       else
-        self.config_files[navigation_context] = IO.read(config_file_name(navigation_context))
+        self.config_files[navigation_context] = IO.read(config_file(navigation_context))
       end
     end
 
@@ -76,12 +101,6 @@ module SimpleNavigation
       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
-
     def explicit_navigation_args
       self.controller.instance_variable_get(:"@sn_current_navigation_args")
     end

data/spec/lib/simple_navigation_spec.rb

@@ -11,47 +11,125 @@ describe SimpleNavigation do
     end
   end
   
-  describe 'config_file?' do
-    it "should check for the file existance with the file_name" do
-      File.should_receive(:exists?).with('path_to_config/ctx_navigation.rb')
-      SimpleNavigation.config_file?(:ctx)
+  describe 'config_file_name' do
+    context 'for :default navigation_context' do
+      it "should return the name of the default config file" do
+        SimpleNavigation.config_file_name.should == 'navigation.rb'
+      end
     end
-    it "should check for the file existance on default context" do
-      File.should_receive(:exists?).with('path_to_config/navigation.rb')
-      SimpleNavigation.config_file?
+    context 'for other navigation_context' do
+      it "should return the name of the config file matching the specified context" do
+        SimpleNavigation.config_file_name(:my_other_context).should == 'my_other_context_navigation.rb'
+      end
+      it "should convert camelcase-contexts to underscore" do
+        SimpleNavigation.config_file_name(:WhyWouldYouDoThis).should == 'why_would_you_do_this_navigation.rb'
+      end
     end
-    context 'config file exists' do
+  end
+  
+  describe 'config_file_paths_sentence' do
+    context 'no paths are set' do
       before(:each) do
-        File.stub!(:exists? => true)
+        SimpleNavigation.config_file_paths = []
       end
-      it {SimpleNavigation.config_file?(:ctx).should be_true}
+      it {SimpleNavigation.config_file_paths_sentence.should == ''}
     end
-    context 'config file does not exist' do
+    context 'one path is set' do
       before(:each) do
-        File.stub!(:exists? => false)
+        SimpleNavigation.config_file_paths = ['first_path']
       end
-      it {SimpleNavigation.config_file?(:ctx).should be_false}
+      it {SimpleNavigation.config_file_paths_sentence.should == 'first_path'}
+    end
+    context 'two paths are set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = ['first_path', 'second_path']
+      end
+      it {SimpleNavigation.config_file_paths_sentence.should == 'first_path or second_path'}
+    end
+    context 'three pahts are set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = ['first_path', 'second_path', 'third_path']
+      end
+      it {SimpleNavigation.config_file_paths_sentence.should == 'first_path, second_path, or third_path'}
     end
   end
   
-  describe 'config_file_name' do
+  describe 'config_file_path=' do
     before(:each) do
-      SimpleNavigation.config_file_path = 'path_to_config'
+      SimpleNavigation.config_file_paths = ['existing_path']
     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'
+    it "should override the config_file_paths" do
+      SimpleNavigation.config_file_path = 'new_path'
+      SimpleNavigation.config_file_paths.should == ['new_path']
+    end
+  end
+  
+  describe 'config_file' do
+    context 'no config_file_paths are set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = []
+      end
+      it "should return nil" do
+        SimpleNavigation.config_file.should be_nil
       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'
+    context 'one config_file_path is set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = ['my_config_file_path']
       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'
+      context 'requested config file does exist' do
+        before(:each) do
+          File.stub!(:exists? => true)
+        end
+        it "should return the path to the config_file" do
+          SimpleNavigation.config_file.should == 'my_config_file_path/navigation.rb'
+        end
+      end
+      context 'requested config file does not exist' do
+        before(:each) do
+          File.stub!(:exists? => false)
+        end
+        it "should return nil" do
+          SimpleNavigation.config_file.should be_nil        
+        end
       end
     end
+    context 'multiple config_file_paths are set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = ['first_path', 'second_path']
+      end
+      context 'requested config file does exist' do
+        before(:each) do
+          File.stub!(:exists? => true)
+        end
+        it "should return the path to the first matching config_file" do
+          SimpleNavigation.config_file.should == 'first_path/navigation.rb'
+        end
+      end
+      context 'requested config file does not exist' do
+        before(:each) do
+          File.stub!(:exists? => false)
+        end
+        it "should return nil" do
+          SimpleNavigation.config_file.should be_nil        
+        end
+      end
+    end
+  end
+  
+  describe 'config_file?' do
+    context 'config_file present' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file => 'file')
+      end
+      it {SimpleNavigation.config_file?.should be_true}
+    end
+    context 'config_file not present' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file => nil)
+      end
+      it {SimpleNavigation.config_file?.should be_false}
+    end
   end
   
   describe 'set_template_from' do
@@ -119,16 +197,16 @@ describe SimpleNavigation do
       end
       it "should not override the config_file_path" do
         SimpleNavigation.init_rails
-        SimpleNavigation.config_file_path.should == 'my_path'
+        SimpleNavigation.config_file_paths.should == ['my_path']
       end
     end
-    context 'SimpleNavigation.config_file_path is not set' do
+    context 'SimpleNavigation.config_file_paths are not set' do
       before(:each) do
-        SimpleNavigation.config_file_path = nil
+        SimpleNavigation.config_file_paths = nil
       end
       it "should set the config_file_path to the default" do
         SimpleNavigation.init_rails
-        SimpleNavigation.config_file_path.should == 'default_path'
+        SimpleNavigation.config_file_paths.should == ['default_path']
       end
     end
     it "should extend the ActionController::Base" do
@@ -226,29 +304,27 @@ describe SimpleNavigation do
   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')
+        SimpleNavigation.stub!(:config_file => 'path_to_config_file')
       end
-      
       context 'config_file does exist' do
         before(:each) do
           SimpleNavigation.stub!(:config_file? => true)
-          IO.stub!(:read).and_return('file_content')
+          IO.stub!(:read => 'file_content')
         end
         it "should not raise an error" do
           lambda{SimpleNavigation.load_config}.should_not raise_error
         end
         it "should read the specified config file from disc" do
-          IO.should_receive(:read).with('path_to_config/navigation.rb')
+          IO.should_receive(:read).with('path_to_config_file')
           SimpleNavigation.load_config
         end
         it "should store the read content in the module (default context)" do
-          SimpleNavigation.should_receive(:config_file_name).with(:default)
+          SimpleNavigation.should_receive(:config_file).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)
+          SimpleNavigation.should_receive(:config_file).with(:my_context)
           SimpleNavigation.load_config(:my_context)
           SimpleNavigation.config_files[:my_context].should == 'file_content'
         end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 2
   - 7
-  - 1
-  version: 2.7.1
+  - 2
+  version: 2.7.2
 platform: ruby
 authors: 
 - Andi Schacke
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-12 00:00:00 +02:00
+date: 2010-08-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 2
@@ -88,23 +91,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: andi
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Ruby on Rails application.