goose 0.6.1 → 0.7.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Bruce Williams
+Copyright (c) 2010-2011 Bruce Williams
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -103,6 +103,61 @@ And use `yield` wherever it makes sense in your layout:
 
 It's that simple.
 
+Generating Breadcrumbs
+----------------------
+
+Let's say we had navigation that looked like:
+
+    <% content_for :main_navigation do %>
+      <nav>
+        <ul>
+          <%= nav_to 'People', people_path %>
+          <%= nav_to 'Places', places_path %>
+          <%= nav_to 'Things', things_path %>
+        </ul>
+      </nav>
+    <% end %>
+
+In our action templates, we would usually use `nav_at` to indicate the
+currently active navigation item:
+
+    <%= nav_at 'Places' %>
+
+We could give it even more detail if we'd like breadcrumbs.  In this
+example we're looking at a page for an arrondissement in Paris:
+
+    <%= nav_at 'Places', 'Paris', 'Enclos-St-Laurent' %>
+
+This `nav_at` invocation will still render the `main` partial in
+`app/views`, we just need to add a `content_for` for breadcrumbs.
+We'll make it a simple list that we can style later with CSS:
+
+    <% content_for :breadcrumbs do %>
+      <nav id='breadcrumbs'>
+        <ul>
+          <% breadcrumbs.each do |crumb| %>
+            <li><%= crumb %></li>
+          <% end %>
+        </ul>
+      </nav>
+    <% end %>
+
+Remember, we need to tell the layout where to put the breadcrumbs.
+We just defined the content for `:breadcrumbs`, so we'll add a
+matching `yield` to our `application.html.erb`:
+
+    <%= yield :breadcrumbs %>
+
+If we run this and pull up the page in a browser, we'll notice that
+only the `Places` breadcrumb is a link (it automatically picked it up
+from the `nav_to` in the main nav, handy!) -- if we want the other
+breadcrumbs to be linked (usually all but the last), we can pass the
+URLs as well:
+
+    <%= nav_at 'Places', ['Paris', place_path(@paris)], 'Enclos-St-Laurent' %>
+
+Now both `Places` and `Paris` are linked.
+
 Customizing Goose
 -----------------
 
@@ -111,4 +166,4 @@ See `config/initializers/goose.rb` for options.
 Copyright
 ---------
 
-Copyright (c) 2010 Bruce Williams. See LICENSE for details.
+Copyright (c) 2010-2011 Bruce Williams. See LICENSE for details.

data/lib/generators/goose/templates/goose.rb

@@ -10,4 +10,7 @@ Goose.setup do |config|
   # Default options added to nav_to wrapper when not current location
   # config.inactive_options = {}
 
+  # Default method to create links in breadcrumbs
+  # config.breadcrumb_linker = lambda { |view, *args| view.link_to(*args) }
+  
 end

data/lib/goose/address.rb

@@ -0,0 +1,45 @@
+module Goose
+
+  class Address
+    include Enumerable
+    
+    def initialize(head, *tail)
+      if head.is_a?(Array)
+        @head = head
+      else
+        @head_name = head
+      end
+      @tail = tail
+    end
+
+    def at?(head_name)
+      if resolved?
+        @head.first == head_name
+      else
+        @head_name == head_name
+      end
+    end
+
+    def each(&block)
+      list.each(&block)
+    end
+
+    def resolve(url)
+      unless resolved?
+        @head = [@head_name, url]
+      end
+    end
+
+    private
+
+    def list
+      @list ||= [@head, *@tail].compact
+    end
+
+    def resolved?
+      @head
+    end
+    
+  end
+
+end

data/lib/goose/config.rb

@@ -2,7 +2,7 @@ module Goose
 
   class Config
 
-    attr_writer :wrapper_tag, :active_options, :inactive_options
+    attr_writer :wrapper_tag, :active_options, :inactive_options, :breadcrumb_linker
 
     def wrapper_tag
       @wrapper_tag ||= :li
@@ -12,6 +12,10 @@ module Goose
       @active_options ||= {:class => 'active'}
     end
 
+    def breadcrumb_linker
+      @breadcrumb_linker ||= lambda { |view, *args| view.link_to(*args) }
+    end
+
     def inactive_options
       @inactive_options ||= {}
     end

data/lib/goose/helper.rb

@@ -8,20 +8,33 @@ module Goose
 
     def nav_to(place, url, options = {}, &block)
       if goose.at?(place)
+        goose.current_address.resolve(url)
         options.update(Goose.config.active_options)
       end
-      content = link_to(place, url) if url 
+      content = link_to(place, url) if url
       content_tag(Goose.config.wrapper_tag, content, options, &block)
     end
     
-    def nav_at(place, options = {})
+    def nav_at(*places)
+      options = places.last.is_a?(Hash) ? args.pop : {}
       nav = options[:in] || :main
-      goose.render(nav, place)
+      address = Address.new(*places)
+      goose.render(nav, address)
     end
     
     def nav(name = nil)
       nav_at(nil, :in => name)
     end
+
+    def breadcrumbs
+      goose.current_address.map do |crumb|
+        if crumb.is_a?(Array)
+          Goose.config.breadcrumb_linker.call(self, *crumb)
+        else
+          crumb
+        end
+      end
+    end
     
   end
   

data/lib/goose/state.rb

@@ -7,18 +7,26 @@ module Goose
       @stack ||= []
     end
 
-    def render(nav, place)
-      at(nav, place) { @view.render(:partial => "nav/#{nav}") }
+    def render(nav, address)
+      at(nav, address) { @view.render(:partial => "nav/#{nav}") }
     end
 
     def at?(place)
-      @stack.last == place
+      current_address.at?(place)
     end
 
-    private
+    def breadcrumbs
+      current_address.breadcrumbs
+    end
+    
+    def current_address
+      @stack.last
+    end
 
-    def at(nav, place, &block)
-      @stack << place
+    private
+    
+    def at(nav, address, &block)
+      @stack << address
       result = yield
       @stack.pop
       result

data/lib/goose/version.rb

@@ -1,3 +1,3 @@
 module Goose
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/goose.rb

@@ -1,5 +1,6 @@
 module Goose
 
+  autoload :Address, 'goose/address'
   autoload :Config,  'goose/config'
   autoload :Helper,  'goose/helper'
   autoload :State,   'goose/state'
@@ -12,11 +13,6 @@ module Goose
   def self.setup(&block)
     yield config
   end
-
-  # Not recommended for production use.
-  def self.eject! #:nodoc:
-    raise NotImplementedError, "BOOM...Crunch"
-  end
   
 end
 

metadata

@@ -2,7 +2,7 @@
 name: goose
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors: 
 - Bruce Williams
@@ -26,6 +26,7 @@ files:
 - lib/generators/goose/install_generator.rb
 - lib/generators/goose/templates/goose.rb
 - lib/generators/goose/USAGE
+- lib/goose/address.rb
 - lib/goose/config.rb
 - lib/goose/ext/action_view.rb
 - lib/goose/helper.rb