navigasmic 0.5.6 → 1.0.0

data/lib/navigasmic/builders/map_builder.rb

@@ -0,0 +1,77 @@
+module Navigasmic::Builder
+  class MapBuilder < Base
+    class Configuration < Base::Configuration
+
+      attr_accessor :option_namespace
+      attr_accessor :wrapper_tag, :group_tag, :item_tag, :label_generator
+
+      def initialize
+        # where you want the changefreq and other options to be looked for
+        @option_namespace = :map
+
+        # tag configurations
+        @wrapper_tag = :urlset
+        @item_tag = :url
+
+        super
+      end
+    end
+
+    def initialize(context, name, options, &block)
+      super
+      @options['xmlns'] ||= 'http://www.sitemaps.org/schemas/sitemap/0.9'
+      @options['xmlns:xsi'] ||= 'http://www.w3.org/2001/XMLSchema-instance'
+      @options['xsi:schemaLocation'] ||= 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd'
+      @options[:changefreq] ||= 'yearly'
+    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(capture(&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)
+
+      concat(capture(&block)) if block_given?
+      return '' unless item.link?
+
+      concat(structure_for(label, item.link, options))
+    end
+
+    private
+
+    def structure_for(label, link, options, &block)
+      content = content_tag(:loc, link_for(link, options))
+      content << content_tag(:name, label)
+      if opts = options.delete(@config.option_namespace)
+        content << content_tag(:changefreq, opts[:changefreq] || 'yearly')
+        content << content_tag(:lastmod, opts[:lastmod]) if opts.has_key?(:lastmod)
+        content << content_tag(:priority, opt[:priority]) if opts.has_key?(:priority)
+      end
+
+      content_tag(@config.item_tag, content.html_safe)
+    end
+
+    def link_for(link, options)
+      host = options.delete(:host) || @context.request.host
+      if link.is_a?(Hash)
+        link[:host] ||= host
+      else
+        link = "#{@context.request.protocol}#{host}#{@context.request.port}#{link}"
+      end
+      url_for(link)
+    end
+
+  end
+end

data/lib/navigasmic/core/builders.rb

@@ -0,0 +1,109 @@
+module Navigasmic::Builder
+  autoload :ListBuilder,  'navigasmic/builders/list_builder'
+  autoload :MapBuilder,   'navigasmic/builders/map_builder'
+  autoload :CrumbBuilder, 'navigasmic/builders/crumb_builder'
+
+  class Base
+    class Configuration
+      attr_accessor :excluded_keys
+
+      def initialize
+        @excluded_keys ||= []
+        yield self if block_given?
+      end
+    end
+
+    def initialize(context, name, options, &block)
+      @definition = block_given? ? block : Navigasmic.configuration.definitions[name]
+      raise ArgumentError, "Missing block or configuration" unless @definition
+
+      @context, @name, @options = context, name, options
+      @config = configuration_or_default
+      remove_excluded_options(@options)
+    end
+
+    def group(label = nil, options = {}, &block)
+      raise "Expected subclass to implement group"
+    end
+
+    def item(label, *args, &block)
+      raise "Expected subclass to implement item"
+    end
+
+    def render
+      raise "Expected subclass to implement render"
+    end
+
+  private
+
+    def configuration_or_default
+      configurations = Navigasmic.configuration.builder_configurations[self.class.to_s]
+      proc = configurations.present? ? configurations[@options.delete(:config) || :default] : nil
+      self.class::Configuration.new(&proc)
+    end
+
+    def remove_excluded_options(options)
+      @config.excluded_keys.each { |key| options.delete(key) }
+    end
+
+    def capture(&block)
+      (block_given? ? @context.capture(self, &block) : nil).to_s.html_safe
+    end
+
+    def eval_in_context(&block)
+      @context.instance_eval(&block)
+    end
+
+    def method_missing(meth, *args, &block)
+      @context.send(meth, *args, &block)
+    end
+
+    def flatten_and_eval_options(options)
+      remove_excluded_options(options)
+      options.inject({}) do |hash, (key, value)|
+        if value.is_a?(Array)
+          value = value.map{ |v| v.is_a?(Proc) ? eval_in_context(&v) : v }
+        elsif value.is_a?(Proc)
+          value = eval_in_context(&value)
+        end
+        hash.update(key => value)
+      end
+    end
+
+    def visible?(options)
+      if options[:hidden_unless].nil?
+        true
+      elsif options[:hidden_unless].is_a?(Proc)
+        eval_in_context(&options[:hidden_unless])
+      else
+        options[:hidden_unless]
+      end
+    end
+
+    def extract_and_determine_link(label, options, *args)
+      determine_link(label, extract_link(options, *args))
+    end
+
+    def extract_link(options, *args)
+      if args.length == 1
+        args.delete_at(0)
+      else
+        hash = {controller: options.delete(:controller), action: options.delete(:action)}
+        hash = options.delete(:link) || hash
+        hash.select{ |key, value| value.present? }
+      end
+    end
+
+    def determine_link(label, link)
+      if link.blank?
+        path_helper = "#{label.to_s.underscore.gsub(/\s/, '_')}_path"
+        @context.send(path_helper) if @context.respond_to?(path_helper)
+      elsif link.is_a?(Proc)
+        eval_in_context(&link)
+      else
+        link
+      end
+    end
+
+  end
+end

data/lib/navigasmic/core/configuration.rb

@@ -0,0 +1,38 @@
+require 'singleton'
+
+module Navigasmic
+  class Configuration
+    include Singleton
+
+    cattr_accessor :default_builder
+    @@default_builder = Navigasmic::Builder::ListBuilder
+
+    cattr_accessor :builder_configurations
+    @@builder_configurations = {}
+
+    cattr_accessor :definitions
+    @@definitions = {}
+
+    def self.semantic_navigation(name, &block)
+      @@definitions[name] = block
+    end
+
+    def self.builder(builder, &block)
+      if builder.is_a?(Hash)
+        name = builder.keys[0]
+        builder = builder[name]
+      else
+        name = :default
+      end
+      @@builder_configurations[builder.to_s] ||= {}
+      @@builder_configurations[builder.to_s][name] = block
+    end
+  end
+
+  mattr_accessor :configuration
+  @@configuration = Configuration
+
+  def self.setup
+    yield @@configuration
+  end
+end

data/lib/navigasmic/core/item.rb

@@ -0,0 +1,66 @@
+class Navigasmic::Item
+
+  attr_accessor :link
+  def initialize(builder, label, link, options = {})
+    @label, @link = label, link
+    @disabled = options.delete(:disabled_if)
+    @visible = builder.send(:visible?, options)
+    options.delete(:hidden_unless)
+
+    highlighting_from(options.delete(:highlights_on))
+  end
+
+  def hidden?
+    !@visible
+  end
+
+  def disabled?
+    @disabled
+  end
+
+  def link?
+    @link.present? && !disabled?
+  end
+
+  def highlights_on?(path, params)
+    params = clean_unwanted_keys(params)
+    result = false
+
+    @highlights_on.each do |highlight|
+      highlighted = true
+
+      case highlight
+        when String then highlighted &= path == highlight
+        when Regexp then highlighted &= path.match(highlight)
+        when TrueClass then highlighted &= highlight
+        when FalseClass then highlighted &= highlight
+        when Hash
+          clean_unwanted_keys(highlight).each do |key, value|
+            value.gsub!(/^\//, '') if key == :controller
+            highlighted &= value == params[key].to_s
+          end
+        else raise 'highlighting rules should be an array containing any of/or a Boolean, String, Regexp, Hash or Proc'
+      end
+
+      result |= highlighted
+    end
+
+    result
+  end
+
+  private
+
+  def highlighting_from(rules)
+    @highlights_on = []
+    @highlights_on << @link if link?
+
+    return if rules.blank?
+    @highlights_on += rules.kind_of?(Array) ? rules : [rules]
+  end
+
+  def clean_unwanted_keys(hash)
+    ignored_keys = [:only_path, :use_route]
+    hash.dup.delete_if { |key, value| ignored_keys.include?(key) }
+  end
+
+end

data/lib/navigasmic/rails.rb

@@ -0,0 +1,2 @@
+require 'navigasmic/rails/view_helpers'
+require 'navigasmic/rails/engine'

data/lib/navigasmic/rails/engine.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Navigasmic
+  class Engine < ::Rails::Engine
+    initializer "navigasmic.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/navigasmic/rails/view_helpers.rb

@@ -0,0 +1,18 @@
+module Navigasmic::ViewHelpers
+
+  # Semantic navigation view helper method
+  #
+  # Example Usage:
+  #
+  #   <%= semantic_navigation :primary, class: 'primary-nav', builder: MyCustomBuilder do |n| %>
+  #     <% n.group 'My Thoughts' do %>
+  #       <% n.item 'Blog Posts', controller: 'posts', class: 'featured', id: 'blog_posts' %>
+  #     <% end %>
+  #   <% end %>
+  def semantic_navigation(name, options = {}, &block)
+
+    builder = options.delete(:builder) || Navigasmic.configuration.default_builder
+    builder.new(self, name, options, &block).render
+  end
+
+end

data/lib/navigasmic/version.rb

@@ -0,0 +1,3 @@
+module Navigasmic
+  VERSION = '1.0.0'
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,13 @@
+class ApplicationController < ActionController::Base
+
+  helper_method :logged_in?
+
+  def welcome; end
+
+  private
+
+  def logged_in?
+    true
+  end
+
+end

data/spec/dummy/app/controllers/blog/links_controller.rb

@@ -0,0 +1,7 @@
+class Blog::LinksController < ApplicationController
+
+  layout 'application'
+
+  def index; end
+  def show; end
+end

data/spec/dummy/app/controllers/blog/posts_controller.rb

@@ -0,0 +1,7 @@
+class Blog::PostsController < ApplicationController
+
+  layout 'application'
+
+  def index; end
+  def show; end
+end

data/spec/dummy/app/views/application/welcome.html.erb

@@ -0,0 +1,4 @@
+ApplicationController#welcome
+<br/>
+<br/>
+<br/>

data/spec/dummy/app/views/application/welcome.xml.builder

@@ -0,0 +1,2 @@
+xml.instruct!
+xml << semantic_navigation(:testing, builder: Navigasmic::Builder::MapBuilder)

data/spec/dummy/app/views/blog/links/index.html

@@ -0,0 +1,4 @@
+Blog::LinksController#index
+<br/>
+<br/>
+<a href="/blog/links/1">#show</a>

data/spec/dummy/app/views/blog/links/show.html

@@ -0,0 +1,4 @@
+Blog::LinksController#show
+<br/>
+<br/>
+<a href="/blog/links">#index</a>

data/spec/dummy/app/views/blog/posts/index.html

@@ -0,0 +1,4 @@
+Blog::PostsController#index
+<br/>
+<br/>
+<a href="/blog/posts/1">#show</a>

data/spec/dummy/app/views/blog/posts/show.html

@@ -0,0 +1,4 @@
+Blog::PostsController#show
+<br/>
+<br/>
+<a href="/blog/posts">#index</a>

data/spec/dummy/app/views/layouts/_navigation.html.erb

@@ -0,0 +1,73 @@
+<h3>Rendering navigation defined in configuration</h3>
+<%= semantic_navigation :primary, config: :blockquote %>
+
+<h3>Rendering navigation defined in view</h3>
+<%= semantic_navigation :primary do |n| %>
+  <!-- Adding custom markup in the view -->
+  <li>Custom node</li>
+
+  <!-- Various examples of group method -->
+  <% n.group 'Group' do %>
+    <li>Custom node - should be rendered</li>
+  <% end %>
+  <% n.group 'Group with various attributes', data: {attr: true}, class: 'foo' do %>
+    Custom content - should be rendered
+  <% end %>
+  <% n.group 'Nested groups' do %>
+    <% n.group 'Level 1' do %>
+      <% n.group 'Level 2' do %>
+        Custom content - should be rendered
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <!-- Using hidden_unless for groups -->
+  <% n.group 'Hidden unless: true', class: 'foo', hidden_unless: true do %>
+    Custom content - should be rendered
+  <% end %>
+  <% n.group 'Hidden unless: false', hidden_unless: false do %>
+    Custom content - shouldn't be rendered
+  <% end %>
+  <% n.group 'Hidden unless: proc{ false }', hidden_unless: proc{ false } do %>
+    Custom content - shouldn't be rendered
+  <% end %>
+
+  <% n.group 'Various item examples within a group' do %>
+    <% n.item 'Using a string for href and various attributes', '/my_awesome_blog', data: {attr: true}, class: 'foo' %>
+    <% n.item 'Providing the controller in options', controller: '/blog/posts', class: 'foo' %>
+    <% n.item 'Providing the controller in the link option', link: {controller: '/blog/posts'} %>
+
+    <!-- Only providing the label, which should auto-link to the images controller -->
+    <% n.item 'My Awesome Blog' %>
+  <% end %>
+
+  <% n.group 'Highlighting under various situations' do %>
+    <% n.item 'When the highlight param is set', highlights_on: params[:highlight].present? %>
+    <% n.item 'Always (using an array)', highlights_on: [true, false, false] %>
+    <% n.item 'When the highlight param is set (using a proc)', highlights_on: proc{ params[:highlight].present? } %>
+    <% n.item 'When the highlight param is set (using a proc in an array)', highlights_on: [proc{ params[:highlight].present? }] %>
+    <% n.item 'When on any path beginning with "my_aw" (using regexp)', highlights_on: [/^\/my_aw/] %>
+    <% n.item 'When on "/my_awesome_blog" (using string)', highlights_on: '/my_awesome_blog' %>
+    <% n.item 'When on any action in the application controller', highlights_on: {controller: 'application'} %>
+  <% end %>
+
+  <!-- Examples of disabling items -->
+  <% n.item 'Disabled if: false', disabled_if: false %>
+  <% n.item 'Disabled if: true', disabled_if: true %>
+  <% n.item 'Disabled if: proc{ true }', disabled_if: proc{ true } %>
+
+  <!-- Examples of hiding items -->
+  <% n.item 'Hidden unless: false', hidden_unless: false %>
+  <% n.item 'Hidden unless: true', hidden_unless: true %>
+  <% n.item 'Hidden unless: proc{ true }', hidden_unless: proc{ true } %>
+
+  <% n.item t("hello"), '/foo' %>
+
+  <% n.item 'Nested items', '/blog/posts', disabled_if: false do %>
+    <% n.item 'Level 1', '/my_awesome_blog' do %>
+      <% n.item 'Level 2', '/foo', disabled_if: true do %>
+        <li>Custom node</li>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>