RubyGems - hierarchical_page_titles - Versions diffs - 0.1.0.pre.2 → 0.1.1 - Mend

hierarchical_page_titles 0.1.0.pre.2 → 0.1.1

Files changed (11) hide show

data/README.md +52 -51
data/hierarchical_page_titles.gemspec +4 -4
data/lib/hierarchical_page_titles/shared_instance_methods.rb +0 -3
data/lib/hierarchical_page_titles/version.rb +1 -1
data/lib/hierarchical_page_titles/view_helpers.rb +8 -1
metadata +10 -19
data/.gitignore +0 -3
data/.rvmrc +0 -1
data/Gemfile +0 -3
data/README.textile +0 -69
data/Rakefile +0 -2

data/README.md CHANGED Viewed

@@ -2,7 +2,7 @@
 ### What is this?
-This is a little gem that provides controller and view methods to make displaying of window/page titles DRYer.
+hierarchical_page_titles is a little gem that provides controller and view methods to make displaying of window/page titles DRYer. Currently, it's only compatible with Rails 3.
 ### Why did you make it?
@@ -12,9 +12,9 @@ I made it because I found that I was doing the same thing over and over in my Ra
 I'm going to walk through a few use cases and hopefully you'll get the idea.
-#### Window and page title are the same
+#### One
-Here's what your layout might look like:
+The simplest case is if every page in your site has a title, and you want the window title to reflect the page title. hierarchical_page_titles gives you two helpers, `window_title` and `page_title`, that you can use in your layout. So let's do that:
       <html>
         <head><title><%= window_title %></title></head>
@@ -24,12 +24,12 @@ Here's what your layout might look like:
         </body>
       </html>
-So in your view, you'd do this:
+Now in your view, you use `title` to set the title for that page:
       <% title "Some Page" %>
       <p>Some content</p>
-And now when your layout is rendered, it will be this:
+And now you get this when the page is rendered:
       <html>
         <head><title>Some Page</title></head>
@@ -39,9 +39,9 @@ And now when your layout is rendered, it will be this:
         </body>
       </html>
-#### Window title with prefix
+#### Two
-Nothing special required here, just put it in your layout:
+What if you want the name of your site to show up in the window title? The easiest way is to just hard-code it in your layout:
       <html>
         <head><title>My Site - <%= window_title %></title></head>
@@ -51,7 +51,7 @@ Nothing special required here, just put it in your layout:
         </body>
       </html>
-And when the page is rendered:
+And this is what you get when a page is rendered:
       <html>
         <head><title>My Site - Some Page</title></head>
@@ -61,45 +61,39 @@ And when the page is rendered:
         </body>
       </html>
-#### Hiding page title for certain pages
-#### A page hierarchy
-Controllers:
-<pre>
-<code>
-  class ApplicationController < ActionController::Base
-    window_title "My Site Name"
-  end
-  class SupportController < ApplicationController
-    window_title "Support"
-    def billing; end
-  end
-</code>
-</pre>
-Views:
-<pre>
-<code>
-  #==== app/views/layouts/application.html.erb ====
-  <html>
-    <head><title><%= window_title %></title></head>
-    <body>
-      <h2><%= page_title %></h2>
-    </body>
-  </html>
-  #==== app/views/support/billing.html.erb ====
-  # this adds to the window title and the page title at the same time
-  <% title "Billing FAQs" %>
-</code>
-</pre>
-When the billing view is rendered:
-* The window title will be "My Site Name - Support - Billing FAQs"
-* The page title (in the &lt;h2&gt; tag) will be "Billing FAQs"
+#### Three
+What if there are some pages on your site in which you don't want to show a page title? Well, another helper hierarchical_page_titles gives you is `page_title?`, which will return true if the page title has been set. So let's say your layout looks like this:
+    <html>
+      <head><title><%= window_title %></title></head>
+      <body>
+        <% if page_title? %>
+          <h1><%= page_title %></h1>
+        <% end %>
+        <%= yield %>
+      </body>
+    </html>
+And you have a view in which you set the window title, but not the page title:
+    <% window_title "Some Page" %>
+    <p>Some content</p>
+In this case your page will get rendered as follows:
+    <html>
+      <head><title>Some Page</title></head>
+      <body>
+        <p>Some content</p>
+      </body>
+    </html>
+#### Four
+Let's combine the last two examples. That it, what happens if you want the
+....
 ### How is it different from XYZ?
@@ -116,11 +110,18 @@ There are several related gems/plugins:
 ### How do I install it?
+Just the usual way:
     gem install hierarchical_page_titles
+### I found a bug! or, I have a feature request...
+Okay! Please file any issues in [Issues](http://github.com/mcmire/hierarchical_page_titles/issues).
 ### How do I contribute?
-### Who wrote this?
+Pull down the code, make a branch, and send me a pull request.
+### Author/Copyright/License
-(c) 2009 Elliot Winkler (elliot dot winkler at gmail dot com).
-Released under the MIT license.
+(c) 2009-2011 Elliot Winkler (email: <elliot.winkler@gmail.com>, twitter: [@mcmire](http://twitter.com/mcmire)). You are free to do whatever you want with this code, as long as I'm not held responsible, blah blah.

data/hierarchical_page_titles.gemspec CHANGED Viewed

@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
   s.description = %q{A gem that provides controller and view methods to make displaying of window/page titles DRYer.}
   #s.rubyforge_project = "title_helpers"
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = ["README.md", "hierarchical_page_titles.gemspec"] + Dir["lib/**/*"]
+  s.test_files    = Dir["{test,spec,features}/**/*"]
+  s.executables   = Dir["bin/**/*"].map {|f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/lib/hierarchical_page_titles/shared_instance_methods.rb CHANGED Viewed

@@ -12,7 +12,6 @@ module HierarchicalPageTitles
       else
         @_window_titles += titles
       end
-      @_window_title_set = true
     end
     # Call this in your view with a string to set the page title to that string.
@@ -21,7 +20,6 @@ module HierarchicalPageTitles
       options = args.extract_options!
       title = args.first
       @_page_title = (block_given? ? instance_eval(&block) : title)
-      @_page_title_set = true
     end
     # Call this in your view to set the window title and the page title at the same time.
@@ -30,7 +28,6 @@ module HierarchicalPageTitles
       options = args.extract_options!
       window_title(*args, &block)
       page_title(args.last, &block)
-      @_title_set = true
     end
     def titles

data/lib/hierarchical_page_titles/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module HierarchicalPageTitles
-  VERSION = "0.1.0.pre.2"
+  VERSION = "0.1.1"
 end

data/lib/hierarchical_page_titles/view_helpers.rb CHANGED Viewed

@@ -14,6 +14,7 @@ module HierarchicalPageTitles
         @_window_titles ||= []
         @_window_titles.join(options[:separator])
       else
+        @_window_title_set = true
         super
       end
     end
@@ -25,10 +26,16 @@ module HierarchicalPageTitles
       if args.empty?
         @_page_title
       else
+        @_page_title_set = true
         super
       end
     end
+    def title(*args)
+      @_title_set = true
+      super
+    end
     # TODO: Document
     def page_title?
       @_page_title.present?
@@ -41,7 +48,7 @@ module HierarchicalPageTitles
     # TODO: Document
     def page_title_set?
-      @_window_title_set
+      @_page_title_set
     end
     # TODO: Document

metadata CHANGED Viewed

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hierarchical_page_titles
 version: !ruby/object:Gem::Version
-  hash: -223651651
-  prerelease: true
+  hash: 25
+  prerelease: false
   segments:
   - 0
   - 1
-  - 0
-  - pre
-  - 2
-  version: 0.1.0.pre.2
+  - 1
+  version: 0.1.1
 platform: ruby
 authors:
 - Elliot Winkler
@@ -17,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-12-13 00:00:00 -07:00
+date: 2011-01-06 00:00:00 -07:00
 default_executable:
 dependencies: []
@@ -31,19 +29,14 @@ extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- Gemfile
 - README.md
-- README.textile
-- Rakefile
 - hierarchical_page_titles.gemspec
-- lib/hierarchical_page_titles.rb
 - lib/hierarchical_page_titles/controller_helpers.rb
 - lib/hierarchical_page_titles/railtie.rb
 - lib/hierarchical_page_titles/shared_instance_methods.rb
 - lib/hierarchical_page_titles/version.rb
 - lib/hierarchical_page_titles/view_helpers.rb
+- lib/hierarchical_page_titles.rb
 has_rdoc: true
 homepage: http://github.com/mcmire/hierarchical_page_titles
 licenses: []
@@ -65,14 +58,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      hash: 25
+      hash: 3
       segments:
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 rubyforge_project:

data/.gitignore DELETED Viewed

@@ -1,3 +0,0 @@
-.DS_Store
-*.tmproj
-*.gem

data/.rvmrc DELETED Viewed

	@@ -1 +0,0 @@
1	- rvm 1.8.7@hierarchical_page_titles

data/Gemfile DELETED Viewed

@@ -1,3 +0,0 @@
-source "http://rubygems.org"
-gemspec

data/README.textile DELETED Viewed

@@ -1,69 +0,0 @@
-h2. title_helpers
-h3. Summary
-Rails plugin that provides controller and view methods to make displaying of
-window/page titles DRYer.
-h3. Rationale
-Most web sites you'll build have some sort of hierarchy. And most times this
-hierarchy will correspond to your controllers. For instance, let's say you have a
-support section on your website (@SupportController@), and under that you have FAQs
-about billing (the @billing@ action). Now, I think it's important for the window
-title to be informative -- in fact, it should come directly from the page hierarchy.
-So, going back to our billing FAQs page, you might want the window title to be
-"Foo.com - Support - Billing FAQs". But that's going to be a pattern, isn't it?
-"Foo.com - #{some controller} - #{some action}". You're not really going to define
-the full window title for every action in your code, are you? I'm certainly not going
-to. Wouldn't it be better if you could set the window title on a controller basis,
-and then, in your view, set the window title for just the action?
-h3. Example
-Controllers:
-<pre>
-<code>
-  class ApplicationController < ActionController::Base
-    window_title "My Site Name"
-  end
-  class SupportController < ApplicationController
-    window_title "Support"
-    def billing; end
-  end
-</code>
-</pre>
-Views:
-<pre>
-<code>
-  #==== app/views/layouts/application.html.erb ====
-  <html>
-    <head><title><%= window_title %></title></head>
-    <body>
-      <h2><%= page_title %></h2>
-    </body>
-  </html>
-  #==== app/views/support/billing.html.erb ====
-  # this adds to the window title and the page title at the same time
-  <% title "Billing FAQs" %>
-</code>
-</pre>
-When the billing view is rendered:
-* The window title will be "My Site Name - Support - Billing FAQs"
-* The page title (in the &lt;h2&gt; tag) will be "Billing FAQs"
-h3. Installation
-<pre>
-  script/plugin install git://github.com/mcmire/title_helpers.git
-</pre>
-h3. Author
-(c) 2009 Elliot Winkler (elliot dot winkler at gmail dot com).
-Released under the MIT license.

data/Rakefile DELETED Viewed

	@@ -1,2 +0,0 @@
1	- require 'bundler'
2	- Bundler::GemHelper.install_tasks