navigasmic 0.5.6 → 1.0.0

data/LICENSE

@@ -1,4 +1,10 @@
-Copyright (c) 2010 Jeremy Jackson
+Navigasmic is a semantic way to build beautifully simple navigation
+structures in Rails.
+
+Documentation and other useful information can be found at
+https://github.com/jejacks0n/navigasmic
+
+Copyright (c) 2011 Jeremy Jackson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/generators/navigasmic/install/POST_INSTALL

@@ -0,0 +1,6 @@
++============================================================================+
+Congratulations! Navigasmic was successfully installed. Documentation and more
+can be found at: https://github.com/jejacks0n/navigasmic
+
+You should start defining some navigation in config/initializers/navigasmic.rb
+

data/lib/generators/navigasmic/install/install_generator.rb

@@ -0,0 +1,17 @@
+module Navigasmic
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../', __FILE__)
+
+      desc "Installs the Navigasmic initializer into your application."
+
+      def copy_initializer
+        copy_file 'templates/initializer.rb', 'config/initializers/navigasmic.rb'
+      end
+
+      def display_readme
+        readme 'POST_INSTALL' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/navigasmic/install/templates/initializer.rb

@@ -0,0 +1,145 @@
+Navigasmic.setup do |config|
+
+  # Defining Navigation Structures:
+  #
+  # You can begin by defining your navigation structures here.  You can also define them directly in the view if you'd
+  # like, but it's recommended to eventually move them here to clean help up your views.  You can read about Navigasmic
+  # at https://github.com/jejacks0n/navigasmic
+  #
+  # When you're defining navigation here, it's basically the same as if you were doing it in the view but the scope is
+  # different.  It's important to understand that -- and use procs where you want things to execute in the view scope.
+  #
+  # Once you've defined some navigation structures and configured your builders you can render navigation in your views
+  # using the `semantic_navigation` view helper.  You can also use the same syntax to define your navigation structures
+  # in your views, and eventually move them here (it's handy to prototype navigation/css by putting them in the views
+  # first).
+  #
+  # <%= semantic_navigation :primary %>
+  #
+  # You can optionally provided a :builder and :config option to the semantic_navigation view helper.
+  #
+  # <%= semantic_navigation :primary, config: :blockquote %>
+  # <%= semantic_navigation :primary, builder: Navigasmic::Builder::MapBuilder %>
+  #
+  # When defining navigation in your views just pass it a block (the same as here basically).
+  #
+  # <%= semantic_navigation :primary do |n| %>
+  #   <% n.item 'About Me' %>
+  # <% end %>
+  #
+  # Here's a basic example:
+  config.semantic_navigation :primary do |n|
+
+    n.item 'Home', '/'
+
+    # Groups and Items:
+    #
+    # You can create a structure using `group`, and `item`.  You can nest items inside groups or items.  In the
+    # following example, the "Articles" item will always highlight on the blog/posts controller, and the nested article
+    # items will only highlight when on those specific pages.  The "Links" item will be disabled unless the user is
+    # logged in.
+    #
+    #n.group 'Blog' do
+    #  n.item 'Articles', controller: '/blog/posts' do
+    #    n.item 'First Article', '/blog/posts/1'
+    #    n.item 'Second Article', '/blog/posts/2', map: {changefreq: 'weekly'}
+    #  end
+    #  n.item 'Links', controller: '/blog/links', disabled_if: proc{ !logged_in? }
+    #end
+    #
+    # You can hide specific specific items or groups.  Here we specify that the "About" section of navigation should
+    # only be displayed if the user is logged in.
+    #
+    #n.group 'About', hidden_unless: proc{ logged_in? } do
+    #  n.item 'About Me', class: 'featured', link_html: {class: 'about-me'}
+    #end
+    #
+    # Scoping:
+    #
+    # Scoping is different than in the view here, so we've provided some nice things for you to get around that.  In
+    # the above example we just provide '/' as what the home page is, but that may not be correct.  You can also access
+    # the path helpers, using a proc, or by proxying them through the navigation object.  Any method called on the
+    # navigation scope will be called within the view scope.
+    #
+    #n.item 'Home', proc{ root_path }
+    #n.item 'Home', n.root_path
+    #
+    # This proxy behavior can be used for I18n as well.
+    #
+    #n.item n.t('hello'), '/'
+
+  end
+
+
+  # Setting the Default Builder:
+  #
+  # By default the Navigasmic::Builder::ListBuilder is used unless otherwise specified.
+  #
+  # You can change this here:
+  #config.default_builder = MyCustomBuilder
+
+
+  # Configuring Builders:
+  #
+  # You can change various builder options here by specifying the builder you want to configure and the options you
+  # want to change.
+  #
+  # Changing the default ListBuilder options:
+  config.builder Navigasmic::Builder::ListBuilder do |builder|
+    builder.wrapper_class = 'semantic-navigation'
+  end
+
+
+  # Naming Builder Configurations:
+  #
+  # If you want to define a named configuration for a builder, just provide a hash with the name, and the builder to
+  # configure.  The named configurations can then be used during rendering by specifying a `:config => :bootstrap`
+  # option to the `semantic_navigation` view helper.
+  #
+  # A Twitter Bootstrap configuration:
+  #
+  # Example usage:
+  #
+  # <%= semantic_navigation :primary, config: :bootstrap, class: 'nav-pills' %>
+  #
+  # Or to create a full navigation bar using twitter bootstrap you could use the following in your view:
+  # <div class="navbar">
+  #   <div class="navbar-inner">
+  #     <a class="brand" href="/">Title</a>
+  #     <%= semantic_navigation :primary, config: :bootstrap %>
+  #   </div>
+  # </div>
+  config.builder bootstrap: Navigasmic::Builder::ListBuilder do |builder|
+
+    # Set the nav and nav-pills css (you can also use 'nav nav-tabs') -- or remove them if you're using this inside a
+    # navbar.
+    builder.wrapper_class = 'nav nav-pills'
+
+    # Set the classed for items that have nested items, and that are nested items.
+    builder.has_nested_class = 'dropdown'
+    builder.is_nested_class = 'dropdown-menu'
+
+    # For dropdowns to work you'll need to include the bootstrap dropdown js
+    # For groups, we adjust the markup so they'll be clickable and be picked up by the javascript.
+    builder.label_generator = proc do |label, has_link, has_nested|
+      if !has_nested || has_link
+        "<span>#{label}</span>"
+      else
+        link_to("#{label}<b class='caret'></b>".html_safe, '#', class: 'dropdown-toggle', data: {toggle: 'dropdown'})
+      end
+    end
+
+    # For items, we adjust the links so they're '#', and do the same as for groups.  This allows us to use more complex
+    # highlighting rules for dropdowns.
+    builder.link_generator = proc do |label, link, options, has_nested|
+      if has_nested
+        link = '#'
+        label << "<b class='caret'></b>"
+        options.merge!(class: 'dropdown-toggle', data: {toggle: 'dropdown'})
+      end
+      link_to(label, link, options)
+    end
+
+  end
+
+end

data/lib/navigasmic.rb

@@ -1,147 +1,6 @@
-# coding: utf-8
-require 'builders/html_builder'
-require 'builders/xml_builder'
+require 'navigasmic/version'
+require 'navigasmic/rails'
 
-module Navigasmic #:nodoc:
-
-  # Semantic navigation helper methods
-  #
-  # Example Usage:
-  #
-  #   <% semantic_navigation :primary, :html => {:class => 'primary'} do |n| %>
-  #     <%= n.item 'Blog Posts', :link => {:controller => 'posts'} %>
-  #   <% end %>
-  #
-  #   <% semantic_navigation :primary, :builder => MyCustomBuilder do |n| %>
-  #     <%= n.group 'My Thoughts' do %>
-  #       <%= n.item 'Blog Posts', :link => {:controller => 'posts'} %>
-  #     <% end %>
-  #   <% end %>
-  #
-  #   <% semantic_navigation :primary do |n| %>
-  #     <%= n.group 'My Thoughts' do %>
-  #       <%= n.item 'Blog Posts', :link => {:controller => 'posts'} do %>
-  #         <ul>
-  #           <%= n.item 'Recent Posts', :link => {:controller => 'posts', :action => 'recent'} %>
-  #         </ul>
-  #       <% end %>
-  #     <% end %>
-  #   <% end %>
-  module SemanticNavigationHelper
-
-    @@builder = ::Navigasmic::HtmlNavigationBuilder
-    mattr_accessor :builder
-
-    def semantic_navigation(name, *args, &proc)
-      raise ArgumentError, "Missing block" unless block_given?
-
-      options = args.extract_options!
-
-      options[:html] ||= {}
-      options[:html][:class] = add_html_class(options[:html][:class], 'semantic-navigation')
-      options[:html][:id] ||= name.to_s.underscore  unless options[:html].has_key?(:id)
-
-      builder = options.delete(:builder) || @@builder
-      builder.new(self, name, options, &proc)
-    end
-
-    def add_html_class(classnames, classname)
-      out = (classnames.is_a?(String) ? classnames.split(' ') : []) << classname
-      out.join(' ')
-    end
-
-  end
-
-  #
-  #
-  #
-  #
-  #
-  class NavigationItem
-
-    attr_accessor :label, :link
-
-    def initialize(label, options = {}, template = nil)
-      @label = label
-
-      if options[:link]
-        @link = options[:link]
-      elsif template.present?
-        method = "#{label.to_s.underscore.gsub(/\s/, '_')}_path"
-        @link = template.send(method) if template.respond_to? method
-      end
-      @link ||= {}
-
-      @disabled_conditions = options[:disabled_if] || proc { false }
-      @visible = options[:hidden_unless].nil? ? true : options[:hidden_unless].is_a?(Proc) ? template.instance_eval(&options[:hidden_unless]) : options[:hidden_unless]
-
-      options[:highlights_on] = [options[:highlights_on]] if options[:highlights_on].kind_of?(Hash) || options[:highlights_on].kind_of?(String)
-      @highlights_on = options[:highlights_on] || []
-
-      if link?
-        if @link.is_a?(Proc)
-          @highlights_on << template.instance_eval(&@link)
-        else
-          @highlights_on << @link if link?
-        end
-      end
-    end
-
-    def link?
-      @link && !@link.blank?
-    end
-
-    def disabled?
-      @disabled_conditions.call
-    end
-
-    def hidden?
-      !@visible
-    end
-
-    def highlighted?(path, params = {}, template = nil)
-      params = clean_unwanted_keys(params)
-      result = false
-
-      @highlights_on.each do |highlight|
-        highlighted = true
-
-        case highlight
-        when String
-          highlighted &= path == highlight
-        when Proc
-          h = template.instance_eval(&highlight)
-          raise 'proc highlighting rules must evaluate to TrueClass or FalseClass' unless (h.is_a?(TrueClass) || h.is_a?(FalseClass))
-          highlighted &= h
-        when Regexp
-          highlighted &= path.match(highlight)
-        when Hash
-          h = clean_unwanted_keys(highlight)
-          h.each_key do |key|
-            h_key = h[key].to_s.dup
-            h_key.gsub!(/^\//, '') if key == :controller
-            highlighted &= h_key == params[key].to_s
-          end
-        else
-          raise 'highlighting rules should be a String, Proc, Regexp or a Hash'
-        end
-
-        result |= highlighted
-      end
-
-      return result
-    end
-
-    private
-
-    # removes unwanted keys from a Hash and returns a new hash
-    def clean_unwanted_keys(hash)
-      ignored_keys = [:only_path, :use_route]
-      hash.dup.delete_if { |key, value| ignored_keys.include?(key) }
-    end
-
-  end
-
-end
-
-ActionController::Base.helper Navigasmic::SemanticNavigationHelper
+require 'navigasmic/core/builders'
+require 'navigasmic/core/configuration'
+require 'navigasmic/core/item'

data/lib/navigasmic/builders/crumb_builder.rb

@@ -0,0 +1,20 @@
+module Navigasmic::Builder
+  class CrumbBuilder < Base
+    class Configuration < Base::Configuration
+    end
+
+    def initialize(context, name, options, &block)
+      super
+    end
+
+    def render
+    end
+
+    def group(label = nil, options = {}, &block)
+    end
+
+    def item(label, *args, &block)
+    end
+
+  end
+end

data/lib/navigasmic/builders/list_builder.rb

@@ -0,0 +1,90 @@
+module Navigasmic::Builder
+  class ListBuilder < Base
+    class Configuration < Base::Configuration
+
+      attr_accessor :wrapper_class, :has_nested_class, :is_nested_class, :disabled_class, :highlighted_class
+      attr_accessor :wrapper_tag, :group_tag, :item_tag
+      attr_accessor :link_generator, :label_generator
+
+      def initialize
+        # which keys (for other builder) should be removed from options
+        @excluded_keys = [:map]
+
+        # tag configurations
+        @wrapper_tag = :ul
+        @group_tag = :ul
+        @item_tag = :li
+
+        # class configurations
+        @wrapper_class = 'semantic-navigation'
+        @has_nested_class = 'has-nested'
+        @is_nested_class = 'is-nested'
+        @disabled_class = 'disabled'
+        @highlighted_class = 'active'
+
+        # generator callbacks
+        @link_generator = proc{ |label, link, options, is_nested| link_to(label, link, options.delete(:link_html)) }
+        @label_generator = proc{ |label, is_linked, is_nested| "<span>#{label}</span>" }
+
+        super
+      end
+    end
+
+    def initialize(context, name, options, &block)
+      super
+      @options[:id] ||= name.to_s.underscore unless @options.has_key?(:id)
+      @options[:class] = merge_classes!(@options, @config.wrapper_class)
+    end
+
+    def render
+      content_tag(@config.wrapper_tag, capture(&@definition), @options)
+    end
+
+    def group(label = nil, options = {}, &block)
+      raise ArgumentError, "Missing block for group" unless block_given?
+      return '' unless visible?(options)
+
+      concat(structure_for(label, false, options, &block))
+    end
+
+    def item(label, *args, &block)
+      options = args.extract_options!
+      options = flatten_and_eval_options(options)
+      return '' unless visible?(options)
+
+      item = Navigasmic::Item.new(self, label, extract_and_determine_link(label, options, *args), options)
+
+      merge_classes!(options, @config.disabled_class) if item.disabled?
+      merge_classes!(options, @config.highlighted_class) if item.highlights_on?(@context.request.path, @context.params)
+
+      concat(structure_for(label, item.link? ? item.link : false, options, &block))
+    end
+
+    private
+
+    def structure_for(label, link = false, options = {}, &block)
+      label = label_for(label, link, block_given?, options)
+
+      content = ''
+      if block_given?
+        merge_classes!(options, @config.has_nested_class)
+        content = content_tag(@config.group_tag, capture(&block), {class: @config.is_nested_class})
+      end
+
+      content_tag(@config.item_tag, "#{label}#{content}".html_safe, options)
+    end
+
+    def label_for(label, link, is_nested = false, options = {})
+      if label.present?
+        label = @context.instance_exec(label, !!link, is_nested, &@config.label_generator).html_safe
+      end
+      label = @context.instance_exec(label, link, options.delete(:link_html) || {}, is_nested, &@config.link_generator).html_safe if link
+      label
+    end
+
+    def merge_classes!(hash, classname)
+      hash[:class] = (hash[:class] ? "#{hash[:class]} " : '') << classname
+    end
+
+  end
+end