simple-navigation 2.7.3 → 3.0.0.beta1

data/CHANGELOG

@@ -1,3 +1,13 @@
+*3.0.0.beta1
+
+* moving deprecated rails controller methods (navigation, current_navigation) to separate file 'rails_controller_methods'. Deprecations removed. File can be required explicitly if controller methods should be still available.
+* decoupling from Rails. Introducing the concept of adapters to work with several frameworks. 
+* tested with Rails 3.0.0
+* adding support for Sinatra and Padrino frameworks.
+* cherry picking active_support stuff instead of requiring the whole bunch (tested with active_support >= 2.3.2 and 3.0.0)
+* created public sample project which includes demo for Rails2, Rails3, Sinatra and Padrino (will be available on github soon)
+* better src file organization (adapters/core/rendering folders)
+
 *2.7.3
 
 * initializing SimpleNavigation.config_file_path with empty array (was nil before). Allows for adding paths before gem has been initialized.
@@ -62,7 +72,7 @@
 
 *2.2.3
 
-* changed error handling in config-file. Do not ignore errors in config-file anymore. 
+* 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
@@ -92,16 +102,16 @@
 *2.0.0
 
 * added auto_highlight feature. Active navigation is determined by comparing urls, no need to explicitly set it in the controllers anymore. Thanks to Jack Dempsey and Florian Hanke for the support on this.
-* added ability to create multi-level navigations (not just limited to primary and secondary navigation). Thanks again to Jack Dempsey for the motivation ;-) 
+* added ability to create multi-level navigations (not just limited to primary and secondary navigation). Thanks again to Jack Dempsey for the motivation ;-)
 * simplified the process to explicitly set the navigation in the controller (where needed) - only deepest level has to be specified
-* made auto_highlight feature configurable both on global and item_container's level 
+* made auto_highlight feature configurable both on global and item_container's level
 * config file is now evaluated in template if ever possible (not in controller anymore)
 
 *1.4.2
 
 * explicitly loading all source files when requiring 'simple_navigation'.
 
-*1.4.0 
+*1.4.0
 
 * added the capability to have several navigation-contexts
 * doc-fix

data/README

@@ -1,8 +1,7 @@
 
 == Simple Navigation
 
-Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Ruby on Rails application.
-If you upgrade to version 2.x.x please recheck the updated documentation on http://wiki.github.com/andi/simple-navigation.
+Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Rails 2, Rails 3, Sinatra or Padrino applications.
 
 Source code:
   git://github.com/andi/simple-navigation.git

data/Rakefile

@@ -39,6 +39,7 @@ begin
     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_development_dependency('rspec', '>= 1.2.8')
+    gemspec.add_dependency('activesupport', '>= 2.3.2')
     gemspec.authors = ["Andi Schacke"]
     gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
     gemspec.files = FileList["[A-Z]*", "{lib,spec,rails,generators}/**/*"] - FileList["**/*.log"]

data/VERSION.yml

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

data/generators/navigation_config/templates/config/navigation.rb

@@ -1,17 +1,17 @@
 # Configures your navigation
-SimpleNavigation::Configuration.run do |navigation|  
-  # Specify a custom renderer if needed. 
+SimpleNavigation::Configuration.run do |navigation|
+  # Specify a custom renderer if needed.
   # The default renderer is SimpleNavigation::Renderer::List which renders HTML lists.
-  # The renderer can also be specified as option in the render_navigation call. 
+  # The renderer can also be specified as option in the render_navigation call.
   # navigation.renderer = Your::Custom::Renderer
-  
+
   # Specify the class that will be applied to active navigation items. Defaults to 'selected'
   # navigation.selected_class = 'your_selected_class'
-    
+
   # Item keys are normally added to list items as id.
   # This setting turns that off
   # navigation.autogenerate_item_ids = false
-  
+
   # You can override the default logic that is used to autogenerate the item ids.
   # To do this, define a Proc which takes the key of the current item as argument.
   # The example below would add a prefix to each key.
@@ -36,18 +36,18 @@ SimpleNavigation::Configuration.run do |navigation|
     #                     be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
     #                     proc should evaluate to a true or false value and is evaluated in the context of the view.
     #           :method - Specifies the http-method for the generated link - default is :get.
-    #           :highlights_on - if autohighlighting is turned off and/or you want to explicitly specify 
-    #                            when the item should be highlighted, you can set a regexp which is matched 
+    #           :highlights_on - if autohighlighting is turned off and/or you want to explicitly specify
+    #                            when the item should be highlighted, you can set a regexp which is matched
     #                            against the current URI.
     #
     primary.item :key_1, 'name', url, options
-    
+
     # Add an item which has a sub navigation (same params, but with block)
     primary.item :key_2, 'name', url, options do |sub_nav|
       # Add an item to the sub navigation (same params again)
       sub_nav.item :key_2_1, 'name', url, options
-    end 
-  
+    end
+
     # You can also specify a condition-proc that needs to be fullfilled to display an item.
     # Conditions are part of the options. They are evaluated in the context of the views,
     # thus you can use all the methods and vars you have available in the views.
@@ -58,10 +58,10 @@ SimpleNavigation::Configuration.run do |navigation|
     # works for all levels of the menu
     # primary.dom_id = 'menu-id'
     # primary.dom_class = 'menu-class'
-    
+
     # You can turn off auto highlighting for a specific level
     # primary.auto_highlight = false
-  
+
   end
-  
+
 end

data/lib/simple_navigation.rb

@@ -1,122 +1,121 @@
-# Load all source files (if this is not done explicitly some naming conflicts may occur if rails app has classes with the same name)
-require 'simple_navigation/configuration'
-require 'simple_navigation/helpers'
-require 'simple_navigation/controller_methods'
-require 'simple_navigation/item_adapter'
-require 'simple_navigation/item'
-require 'simple_navigation/item_container'
-require 'simple_navigation/items_provider'
-require 'simple_navigation/renderer/base'
-require 'simple_navigation/renderer/list'
-require 'simple_navigation/renderer/links'
-require 'simple_navigation/renderer/breadcrumbs'
-require 'simple_navigation/initializer'
-require 'simple_navigation/railtie' if Rails::VERSION::MAJOR == 3
+# cherry picking active_support stuff
+require 'active_support/core_ext/array'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'simple_navigation/core'
+require 'simple_navigation/rendering'
+require 'simple_navigation/adapters'
+
+require 'forwardable'
 
 # A plugin for generating a simple navigation. See README for resources on usage instructions.
 module SimpleNavigation
+  
+  mattr_accessor :adapter_class, :adapter, :config_files, :config_file_paths, :default_renderer, :registered_renderers, :root, :environment
 
-  mattr_accessor :config_files, :config_file_paths, :default_renderer, :controller, :template, :explicit_current_navigation, :rails_env, :rails_root, :registered_renderers
-
+  # Cache for loaded config files
   self.config_files = {}
+
+  # Allows for multiple config_file_paths. Needed if a plugin itself uses simple-navigation and therefore has its own config file
   self.config_file_paths = []
+  
+  # Maps renderer keys to classes. The keys serve as shortcut in the render_navigation calls (:renderer => :list)
   self.registered_renderers = {
     :list         => SimpleNavigation::Renderer::List,
     :links        => SimpleNavigation::Renderer::Links,
     :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs
   }
   
-  
   class << self
+    extend Forwardable
+    
+    def_delegators :adapter, :request, :request_uri, :request_path, :context_for_eval, :current_page?
+    def_delegators :adapter_class, :register
+
+    # Sets the root path and current environment as specified. Also sets the default config_file_path.
+    def set_env(root, environment)
+      self.root = root
+      self.environment = environment
+      self.config_file_paths << SimpleNavigation.default_config_file_path
+    end
+
+    # Returns the current framework in which the plugin is running.
+    def framework
+      return :rails if defined?(Rails)
+      return :padrino if defined?(Padrino)
+      return :sinatra if defined?(Sinatra)
+      raise 'simple_navigation currently only works for Rails, Sinatra and Padrino apps'
+    end
+    
+    # Loads the adapter for the current framework
+    def load_adapter
+      self.adapter_class = case framework
+      when :rails
+        SimpleNavigation::Adapters::Rails
+      when :sinatra
+        SimpleNavigation::Adapters::Sinatra
+      when :padrino
+        SimpleNavigation::Adapters::Padrino
+      end
+    end
 
-    # Sets the config file path and installs the ControllerMethods in ActionController::Base.
-    def init_rails
-      SimpleNavigation.config_file_paths << SimpleNavigation.default_config_file_path
-      ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
+    # Creates a new adapter instance based on the context in which render_navigation has been called.
+    def init_adapter_from(context)
+      self.adapter = self.adapter_class.new(context)
     end
   
     def default_config_file_path
-      File.join(SimpleNavigation.rails_root, 'config')
+      File.join(SimpleNavigation.root, 'config')
     end
-  
+
     # Returns true if the config_file for specified context does exist.
     def config_file?(navigation_context = :default)
       !!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.
-    #
+
+    # Returns the path to 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 path.
     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
+    # Resets the list of config_file_paths to the specified 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 for #{navigation_context} context not found in #{config_file_paths_sentence}!" unless config_file?(navigation_context)      
-      if SimpleNavigation.rails_env == 'production'
+      raise "Config file '#{config_file_name(navigation_context)}' not found in path(s) #{config_file_paths.join(', ')}!" unless config_file?(navigation_context)      
+      if self.environment == 'production'
         self.config_files[navigation_context] ||= IO.read(config_file(navigation_context))
       else
         self.config_files[navigation_context] = IO.read(config_file(navigation_context))
       end
     end
 
-    def set_template_from(context)
-      SimpleNavigation.controller = extract_controller_from context
-      SimpleNavigation.template = SimpleNavigation.controller.instance_variable_get(:@template) || (SimpleNavigation.controller.respond_to?(:view_context) ? SimpleNavigation.controller.view_context : nil)
-    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 
+    def config
       SimpleNavigation::Configuration.instance
     end
-  
+
     # Returns the ItemContainer that contains the items for the primary navigation
     def primary_navigation
       config.primary_navigation
     end
 
-    def explicit_navigation_args
-      self.controller.instance_variable_get(:"@sn_current_navigation_args")
-    end
-
-    # Reads the current navigation for the specified level from the controller.
-    # Returns nil if there is no current navigation set for level.
-    def current_navigation_for(level)
-      self.controller.instance_variable_get(:"@sn_current_navigation_#{level}")
-    end
-
     # Returns the active item container for the specified level. Valid levels are
     # * :all - in this case the primary_navigation is returned.
     # * a specific level - the active item_container for the specified level will be returned
     # * a range of levels - the active item_container for the range's minimum will be returned
-    # 
+    #
     # Returns nil if there is no active item_container for the specified level.
     def active_item_container_for(level)
       case level
@@ -130,104 +129,23 @@ module SimpleNavigation
         raise ArgumentError, "Invalid navigation level: #{level}"
       end
     end
-    
-    # If any navigation has been explicitely set in the controller this method evaluates the specified args set in the controller and sets
-    # the correct instance variable in the controller.
-    def handle_explicit_navigation
-      if SimpleNavigation.explicit_navigation_args
-        begin
-          level, navigation = parse_explicit_navigation_args
-          self.controller.instance_variable_set(:"@sn_current_navigation_#{level}", navigation)
-        rescue
-          #we do nothing here
-          #TODO: check if this is the right way to handle wrong explicit navigation
-        end
-      end
-    end
-
-    # Extracts a controller from the context.
-    def extract_controller_from(context)
-      if context.respond_to? :controller
-        context.controller
-      else
-        context
-      end
-    end
-    
+        
     # Registers a renderer.
     #
     # === Example
-    # To register your own renderer: 
+    # To register your own renderer:
     #
     #   SimpleNavigation.register_renderer :my_renderer => My::RendererClass
-    # 
+    #
     # Then in the view you can call:
     #
     #   render_navigation(:renderer => :my_renderer)
-    #
     def register_renderer(renderer_hash)
       self.registered_renderers.merge!(renderer_hash)
-    end
-
-    # Returns the current request.
-    #
-    def request
-      SimpleNavigation.template.request if SimpleNavigation.template
-    end
-
-    # Returns the current request's URI.
-    #
-    def request_uri
-      return '' unless SimpleNavigation.request
-      return SimpleNavigation.request.fullpath if SimpleNavigation.request.respond_to?(:fullpath)
-      SimpleNavigation.request.request_uri
-    end
-
-    private
-  
-  
-    # TODO: refactor this ugly thing to make it nice and short
-    def parse_explicit_navigation_args
-      args = SimpleNavigation.explicit_navigation_args
-      args = [Hash.new] if args.empty?
-      if args.first.kind_of? Hash
-        options = args.first
-      else # args is a list of current navigation for several levels
-        options = {}
-        if args.size == 1 #only an navi-key has been specified, try to find out level
-          level = SimpleNavigation.primary_navigation.level_for_item(args.first)
-          options[:"level_#{level}"] = args.first if level
-        else
-          args.each_with_index {|arg, i| options[:"level_#{i + 1}"] = arg}
-        end
-      end
-      #only the deepest level is relevant
-      level = options.inject(0) do |max, kv|
-        kv.first.to_s =~ /level_(\d)/
-        max = $1.to_i if $1.to_i > max
-        max
-      end
-      raise ArgumentError, "Invalid level specified or item key not found" if level == 0
-      [level, options[:"level_#{level}"]]
-    end
+    end    
 
   end
 
 end
 
-# TODOs for the next releases:
-# 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...
-#
-# 2) ability to turn off autohighlighting for a single item... 
-# 
-# 3) add JoinRenderer (HorizontalRenderer?) (wich does not render a list, but just the items joined with a specified char (e.g. | ))
-#
-# 4) Enhance SampleProject (more examples)
-#
-# 5) Make SampleProject public
-#
-# - allow :function navigation item to specify function
-# - allow specification of link-options in item (currently options are passed to li-element)
-# - render_navigation: do not rescue from config-file not found error if no items are passed in directly
+SimpleNavigation.load_adapter

data/lib/simple_navigation/adapters.rb

@@ -0,0 +1,9 @@
+require 'simple_navigation/adapters/base'
+
+module SimpleNavigation
+  module Adapters
+    autoload :Rails, 'simple_navigation/adapters/rails'
+    autoload :Padrino, 'simple_navigation/adapters/padrino'
+    autoload :Sinatra, 'simple_navigation/adapters/sinatra'
+  end
+end

data/lib/simple_navigation/adapters/base.rb

@@ -0,0 +1,37 @@
+module SimpleNavigation
+  module Adapters
+    
+    # This is the base class for all adapters. This class mainly exists for documenting reasons.
+    # It lists all the methods that an adapter should implement.
+    #
+    class Base
+      attr_reader :context, :request
+      
+      # This method is usually called when the framework is initialized. 
+      # It should call SimpleNavigation.set_env and install SimpleNavigation::Helpers where appropriate.
+      def self.register; end
+      
+      # Returns the full path incl. query params
+      def request_uri; end
+      
+      # Returns the path without query params
+      def request_path; end
+      
+      # Returns the context in which the config files will be evaluated
+      def context_for_eval; end
+      
+      # Returns true if the current request's url matches the specified url. 
+      # Used to determine if an item should be autohighlighted.
+      def current_page?(url); end
+      
+      # Returns a link with the specified name, url and options.
+      # Used for rendering.
+      def link_to(name, url, options={}); end
+      
+      # Returns a tag of the specified type, content and options.
+      # Used for rendering.
+      def content_tag(type, content, options={}); end
+      
+    end
+  end
+end