simple-navigation 2.2.3 → 2.4.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+*2.4.0
+
+* added Rails3 compatibility
+* added Jeweler::Gemcutter Tasks to Rakefile
+
 *2.2.3
 
 * changed error handling in config-file. Do not ignore errors in config-file anymore. 

data/Rakefile

@@ -38,11 +38,14 @@ begin
     gemspec.email = "andreas.schacke@gmail.com"
     gemspec.homepage = "http://github.com/andi/simple-navigation"
     gemspec.description = "With the simple-navigation gem installed you can easily create multilevel navigations for your Ruby on Rails applications. The navigation is defined in a single configuration file. It supports automatic as well as explicit highlighting of the currently active navigation."
+    gemspec.add_dependency('rails', '>= 2.1.0')
+    gemspec.add_development_dependency('rspec', '>= 1.2.8')
     gemspec.authors = ["Andi Schacke"]
     gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
     gemspec.files = FileList["[A-Z]*", "{lib,spec,rails,generators}/**/*"] - FileList["**/*.log"]
     gemspec.rubyforge_project = 'andi'
   end
+  Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new do |rubyforge|
     rubyforge.doc_task = "rdoc"
   end

data/VERSION.yml

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

data/lib/simple_navigation.rb

@@ -8,15 +8,26 @@ require 'simple_navigation/item_container'
 require 'simple_navigation/items_provider'
 require 'simple_navigation/renderer/base'
 require 'simple_navigation/renderer/list'
+require 'simple_navigation/initializer'
+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, :controller, :template, :explicit_current_navigation
+  mattr_accessor :config_files, :config_file_path, :controller, :template, :explicit_current_navigation, :rails_env, :rails_root
 
   self.config_files = {}
   
   class << self
+
+    def init_rails
+      SimpleNavigation.config_file_path = SimpleNavigation.default_config_file_path unless SimpleNavigation.config_file_path
+      ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
+    end
+  
+    def default_config_file_path
+      File.join(SimpleNavigation.rails_root, 'config')
+    end
   
     def config_file?(navigation_context=nil)
       File.exists?(config_file_name(navigation_context))
@@ -26,7 +37,7 @@ module SimpleNavigation
     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)
-      if ::RAILS_ENV == 'production'
+      if SimpleNavigation.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))
@@ -146,6 +157,7 @@ module SimpleNavigation
 end
 
 # TODOs for the next releases:
+# 0) make sn_set_navigation private in controllers
 # 1) add ability to specify explicit highlighting in the config-file itself (directly with the item)
 #    - item.highlight_on :controller => 'users', :action => 'show' ...^
 #   --> with that we can get rid of the controller_methods...

data/lib/simple_navigation/initializer.rb

@@ -0,0 +1,21 @@
+module SimpleNavigation
+  module Initializer
+
+    class Rails2
+      def self.run
+        SimpleNavigation.rails_root = RAILS_ROOT
+        SimpleNavigation.rails_env = RAILS_ENV
+        SimpleNavigation.init_rails
+      end
+    end
+    
+    class Rails3
+      def self.run
+        SimpleNavigation.rails_root = Rails.root
+        SimpleNavigation.rails_env = Rails.env
+        SimpleNavigation.init_rails
+      end
+    end
+    
+  end
+end

data/lib/simple_navigation/railtie.rb

@@ -0,0 +1,9 @@
+module SimpleNavigation                                                                                                
+  class Railtie < Rails::Railtie                                                                                       
+    railtie_name :simple_navigation                                                                                    
+                                                                                                                       
+    initializer "simple_navigation.init_rails" do |app|                                                                
+      SimpleNavigation::Initializer::Rails3.run
+    end                                                                                                                
+  end                                                                                                                  
+end

data/rails/init.rb

@@ -1,3 +1,5 @@
-default_config_file_path = File.join(RAILS_ROOT, 'config')
-SimpleNavigation.config_file_path = default_config_file_path unless SimpleNavigation.config_file_path
-ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
+if Rails::VERSION::MAJOR == 3
+  SimpleNavigation::Initializer::Rails3.run
+else
+  SimpleNavigation::Initializer::Rails2.run
+end

data/spec/lib/simple_navigation/controller_methods_spec.rb

@@ -10,9 +10,18 @@ describe SimpleNavigation::ControllerMethods do
 
   before(:each) do
     stub_loading_config
-    class ApplicationController < ActionController::Base
+    class TestController
+      class << self
+        def helper_method(*args)
+          @helper_methods = args
+        end
+        def before_filter(*args)
+          @before_filters = args
+        end
+      end
     end
-    @controller = ApplicationController.new
+    TestController.send(:include, SimpleNavigation::ControllerMethods)
+    @controller = TestController.new
   end
   
   describe 'when being included' do
@@ -22,10 +31,8 @@ describe SimpleNavigation::ControllerMethods do
     it "should include the InstanceMethods" do
       @controller.should respond_to(:current_navigation)
     end
-    it "should install the Helpers Module" do
-      [:render_navigation, :render_primary_navigation, :render_sub_navigation].each do |m|
-        @controller.master_helper_module.instance_methods.map(&:to_s).should include(m.to_s)
-      end
+    it "should install the helper methods" do
+      @controller.class.instance_variable_get(:@helper_methods).should == [:render_navigation, :render_primary_navigation, :render_sub_navigation]
     end
   end
   

data/spec/lib/simple_navigation_spec.rb

@@ -73,6 +73,39 @@ describe SimpleNavigation do
     end
   end
 
+  describe 'self.init_rails' do
+    before(:each) do
+      SimpleNavigation.stub!(:default_config_file_path => 'default_path')
+      ActionController::Base.stub!(:include)
+    end
+    context 'SimpleNavigation.config_file_path is already set' do
+      before(:each) do
+        SimpleNavigation.config_file_path = 'my_path'
+      end
+      it "should not override the config_file_path" do
+        SimpleNavigation.init_rails
+        SimpleNavigation.config_file_path.should == 'my_path'
+      end
+    end
+    context 'SimpleNavigation.config_file_path is not set' do
+      before(:each) do
+        SimpleNavigation.config_file_path = nil
+      end
+      it "should set the config_file_path to the default" do
+        SimpleNavigation.init_rails
+        SimpleNavigation.config_file_path.should == 'default_path'
+      end
+    end
+    it "should extend the ActionController::Base" do
+      ActionController::Base.should_receive(:include).with(SimpleNavigation::ControllerMethods)
+      SimpleNavigation.init_rails
+    end
+  end
+
+  describe 'self.default_config_file_path' do
+    it {SimpleNavigation.default_config_file_path.should == './config'}
+  end
+
   describe 'self.extract_controller_from' do
     before(:each) do
       @nav_context = stub(:nav_context)
@@ -192,7 +225,7 @@ describe SimpleNavigation do
       end
       context "RAILS_ENV undefined" do
         before(:each) do
-          ::RAILS_ENV = nil
+          SimpleNavigation.rails_env = nil
         end
         it "should load the config file twice" do
           IO.should_receive(:read).twice
@@ -202,7 +235,7 @@ describe SimpleNavigation do
       end
       context "RAILS_ENV defined" do
         before(:each) do
-          ::RAILS_ENV = 'production'
+          SimpleNavigation.rails_env = 'production'
         end
         context "RAILS_ENV=production" do
           it "should load the config file only once" do
@@ -214,7 +247,7 @@ describe SimpleNavigation do
         
         context "RAILS_ENV=development" do
           before(:each) do
-            ::RAILS_ENV = 'development'
+            SimpleNavigation.rails_env = 'development'
           end
           it "should load the config file twice" do
             IO.should_receive(:read).twice
@@ -225,7 +258,7 @@ describe SimpleNavigation do
         
         context "RAILS_ENV=test" do
           before(:each) do
-            ::RAILS_ENV = 'test'
+            SimpleNavigation.rails_env = 'test'
           end
           it "should load the config file twice" do
             IO.should_receive(:read).twice

data/spec/spec_helper.rb

@@ -1,17 +1,22 @@
 ENV["RAILS_ENV"] = "test"
-RAILS_ENV = "test" unless defined? RAILS_ENV
 require 'rubygems'
 require 'spec'
 require 'active_support'
 require 'action_controller'
 
-RAILS_ROOT = './' unless defined? RAILS_ROOT
+module Rails
+  module VERSION
+    MAJOR = 2
+  end
+end unless defined? Rails
 
 $:.unshift File.dirname(__FILE__)
 $:.unshift File.join(File.dirname(__FILE__), '../lib')
 
 require 'simple_navigation'
 
+SimpleNavigation.rails_root = './'
+
 # Spec::Runner.configure do |config|
   # no special config
 # endx

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 2.2.3
+  version: 2.4.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,10 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-21 00:00:00 +01:00
+date: 2010-03-01 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
 description: With the simple-navigation gem installed you can easily create multilevel navigations for your Ruby on Rails applications. The navigation is defined in a single configuration file. It supports automatic as well as explicit highlighting of the currently active navigation.
 email: andreas.schacke@gmail.com
 executables: []
@@ -34,10 +53,12 @@ files:
 - lib/simple_navigation/configuration.rb
 - lib/simple_navigation/controller_methods.rb
 - lib/simple_navigation/helpers.rb
+- lib/simple_navigation/initializer.rb
 - lib/simple_navigation/item.rb
 - lib/simple_navigation/item_adapter.rb
 - lib/simple_navigation/item_container.rb
 - lib/simple_navigation/items_provider.rb
+- lib/simple_navigation/railtie.rb
 - lib/simple_navigation/renderer/base.rb
 - lib/simple_navigation/renderer/list.rb
 - rails/init.rb