tophat 1.3.0 → 1.3.1

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - jruby
+  - rbx
+  - ree
+  - ruby-head

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/tophat/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_helper_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -1,5 +1,5 @@
-TopHat
-======
+TopHat [![Build Status](https://secure.travis-ci.org/spagalloco/tophat.png)](http://travis-ci.org/spagalloco/tophat)
+====================================================================================================================
 
 TopHat is a set of view helpers to keep your layouts and views DRY.
 
@@ -32,12 +32,14 @@ Usage Options
 
 Use these options to customize the title format:
 
-* :prefix (text between site name and separator)
-* :separator (text used to separate website name from page title)
-* :suffix (text between separator and page title)
-* :lowercase (when true, the page name will be lowercase)
-* :reverse (when true, the page and site names will be reversed)
-* :default (default title to use when title is blank)
+* `:prefix` (text between site name and separator) [default: '']
+* `:separator` (text used to separate website name from page title)
+* `:suffix` (text between separator and page title) [default: ' ']
+* `:lowercase` (when true, the entire title will be lowercase)
+* `:uppercase` (when true, the entire title will be uppercase)
+* `:reverse` (when true, the page and site names will be reversed)
+* `:reverse_on_default` (when true it will lead to a 'Default Title | Site' title when using a default title)
+* `:default` (default title to use when title is blank)
 
 And here are a few examples to give you ideas.
 
@@ -51,8 +53,8 @@ These options can be set as defaults for your layout, or when setting the title
 
     <% title "My page title", :lowercase => true, :separator => "~" %>
 
-Meta Tag Usage
---------------
+Meta Tags
+---------
 
 TopHat also works with keywords and descriptions.  In your view, simply declare the keywords and description.
 
@@ -82,6 +84,71 @@ want to merge your default tags with those in your view? just pass merge_default
 
     <%= keywords :default => 'Yoko, Linda', :merge_default => true %>
 
+There are also convenience methods for a few common meta tags:
+
+    <%= noindex() %>          # outputs: <meta content="noindex" name="robots" />
+    <%= noindex('googlebot')  # outputs: <meta content="noindex" name="googlebot" />
+    <%= nofollow() %>         # outputs: <meta content="nofollow" name="robots" />
+    <%= nofollow('googlebot') # outputs: <meta content="nofollow" name="googlebot" />
+    <%= canonical('http://mysite.com/somepath/') %> # outputs: <link href="http://mysite.com/somepath/" rel="canonical" />
+
+Browser Conditionals
+--------------------
+
+TopHat can generate a lot of different browser conditional comments as well:
+
+    ie_5_conditional do
+      stylesheet_link_tag 'ie'
+    end
+
+will render:
+
+    <!--[if IE 5]>
+      <link href="/stylesheets/ie.css" media="screen" rel="stylesheet" type="text/css" />
+    <![endif]-->
+
+You can also pass in conditions via an argument to the conditional:
+
+    ie_5_5_conditional(:lt) => <!--[if lt IE 5.5]>
+    ie_5_5_conditional(:gt) => <!--[if gt IE 5.5]>
+    ie_5_conditional(:lte) => <!--[if lte IE 5]>
+    ie_5_conditional(:gte) => <!--[if gte IE 5]>
+    if_5_5_conditional(:not) => <!--[if !IE 5]>
+    webkit_conditional(:eq) => <!--[if eq Webkit]>
+
+A lot of browsers are supported, check the code for the full listing.
+
+OpenGraph Helpers
+-----------------
+
+TopHat can also generate Facebook OpenGraph tags.  In your views, you can assign any number of attributes by passing a block to the opengraph helper.  This will store the attributes for that page.
+
+    opengraph do |graph|
+      graph.title 'Rain Man'
+      graph.type 'Movie'
+    end
+
+To embed OpenGraph tags on your page, you'll need to reference opengraph in your layout.
+
+    <%= opengraph %>
+
+You can add an app_id and/or admin ids in your layout:
+
+    <%= opengraph(:app_id => 'MyApp', :admins => [123, 1234]) %>
+
+When used in combination, TopHat will render:
+
+    <meta content="MyApp" property="fb:app_id" />
+    <meta content="123,1234" property="fb:admins" />
+    <meta content="movie" property="og:type" />
+    <meta content="Rain Man" property="og:title" />
+
+There's also a helper for the html tag along with the opengraph namespaces:
+
+    html_with_opengraph => <html xmlns:fb...>
+
+
+Note: TopHat does not include a "Like" button helper. TopHat's focus is inside the `<head>` tag.
 
 Note on Patches/Pull Requests
 -----------------------------

data/lib/tophat/opengraph.rb

@@ -52,6 +52,12 @@ module TopHat
 
     end
 
+    def html_with_opengraph
+      '<html xmlns="http://www.w3.org/1999/xhtml"
+            xmlns:og="http://ogp.me/ns#"
+            xmlns:fb="https://www.facebook.com/2008/fbml">'
+    end
+
     def opengraph(options=nil, &block)
       if options.kind_of? Hash
         @tophat_open_graph_defaults = options

data/lib/tophat/title.rb

@@ -2,25 +2,46 @@ module TopHat
   module TitleHelper
 
     def title(title=nil, options={})
-      if title.is_a? String
+      if title.is_a?(String) || title.is_a?(Array)
         save_tophat_title(title, options)
       else
-        display_tophat_title(title)
+        display_tophat_title(title || options)
       end
     end
 
     private
 
       def save_tophat_title(title, options)
-        @tophat_title = title.gsub(/<\/?[^>]*>/, '')
+        @tophat_title = title
         @tophat_title_options = options
         title
       end
 
-      def display_tophat_title(options={})
-        options ||= {}
+      def display_tophat_title(options)
         options = options.merge(@tophat_title_options) unless @tophat_title_options.nil?
 
+        title_segments = []
+        title_segments << options[:site] if options[:site]
+        title_segments << (@tophat_title.blank? ? options[:default] : @tophat_title)
+
+        title_segments.flatten! # flatten out in case the title is an array
+        title_segments.compact! # clean out any nils
+        title_segments.map! { |t| t.downcase! } if options[:lowercase]
+        title_segments.map! { |t| t.upcase! } if options[:uppercase]
+        title_segments.map! { |t| strip_tags(t) }
+
+        reverse = options[:reverse]
+        reverse = false if options[:default] && @tophat_title.blank? && options[:reverse_on_default] == false
+
+        title_segments.reverse! if reverse
+
+        content_tag :title, title_segments.join(delimiter_from(options)).strip
+      end
+      alias t title
+
+      def delimiter_from(options={})
+        return "" if options.empty?
+
         # Prefix (leading space)
         if options[:prefix]
           prefix = options[:prefix]
@@ -42,48 +63,7 @@ module TopHat
           suffix = ' '
         end
 
-        # site name
-        site_name = options[:site] || ''
-
-        # Lowercase title?
-        if options[:lowercase] == true
-          @tophat_title.downcase! unless @tophat_title.blank?
-          site_name.downcase! unless site_name.blank?
-        end
-
-        # Default page title
-        if @tophat_title.blank? && options[:default]
-          @tophat_title = options[:default]
-          @tophat_title_defaulted = true
-        end
-
-        # figure out reversing
-        if options[:reverse] == true
-          if @tophat_title_defaulted
-            @tophat_reserve = options[:reverse_on_default] != false
-          else
-            @tophat_reverse = true
-          end
-        else
-          @tophat_reverse = false
-        end
-
-        # Set website/page order
-        if @tophat_title.blank?
-          # If title is blank, return only website name
-          content_tag :title, site_name if options[:site]
-        else
-          display_title = if @tophat_reverse == true
-            # Reverse order => "Page : Website"
-            @tophat_title + prefix + separator + suffix + site_name
-          else
-            # Standard order => "Website : Page"
-            site_name + prefix + separator + suffix + @tophat_title
-          end
-
-          return content_tag(:title, display_title.strip)
-        end
+        prefix + separator + suffix
       end
-      alias t title
   end
 end

data/lib/tophat/version.rb

@@ -1,3 +1,3 @@
 module TopHat
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/spec/tophat/opengraph_helper_spec.rb

@@ -6,6 +6,14 @@ describe TopHat::OpenGraphHelper do
     @template = ActionView::Base.new
   end
 
+  context 'html_with_opengraph' do
+    it 'should render an html tag with namespace' do
+      @template.html_with_opengraph.should =~ /<html/
+      @template.html_with_opengraph.should =~ /xmlns\:og/
+      @template.html_with_opengraph.should =~ /xmlns\:fb/
+    end
+  end
+
   context "site admins when configured" do
     context "as a string" do
       it "should generate a site admin tag" do

data/spec/tophat/title_helper_spec.rb

@@ -46,6 +46,11 @@ describe TopHat::TitleHelper do
       @template.title(:site => "Miles Davis", :lowercase => true, :separator => '|').should == "<title>miles davis | kind of blue</title>"
     end
 
+    it "should be uppercase if :uppercase" do
+      save_basic_title
+      @template.title(:site => "Miles Davis", :uppercase => true, :separator => '|').should == "<title>MILES DAVIS | KIND OF BLUE</title>"
+    end
+
     it "should use custom separator if :separator" do
       save_basic_title
       @template.title(:site => "Miles Davis", :separator => "-").should == "<title>Miles Davis - Kind of Blue</title>"
@@ -83,6 +88,11 @@ describe TopHat::TitleHelper do
       save_custom_title
       @template.title(:site => "Freddie Freeloader", :separator => '|').should == "<title>Kind of Blue | Freddie Freeloader</title>"
     end
+
+    it "should accept an array of strings as the title" do
+      @template.title(['My', 'Favorite', 'Things'])
+      @template.title(:site => "Freddie Freeloader", :separator => '|').should == "<title>Freddie Freeloader | My | Favorite | Things</title>"
+    end
   end
 
   def save_basic_title(title='Kind of Blue')

data/tophat.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('simplecov', '~> 0.3')
   s.add_development_dependency('shoulda', '>= 0')
   s.add_development_dependency('rails', '>= 3.0.0')
+  s.add_development_dependency('guard-rspec', '~> 0.4')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,131 +1,139 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tophat
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.3.1
   prerelease: 
-  version: 1.3.0
 platform: ruby
-authors: 
+authors:
 - Steve Agalloco
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-19 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: actionpack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157007300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157007300
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157006800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157006800
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157006340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2157006340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157005880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2157005880
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157005420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.6"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: maruku
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2157005420
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: &2157004960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.6"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2157004960
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2157004500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.3"
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2157004500
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2157037560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2157037560
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2157037100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: *2157037100
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2157036640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: *2157036640
 description: simple view helpers for your layouts
-email: 
+email:
 - steve.agalloco@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -144,35 +152,31 @@ files:
 - spec/tophat/title_helper_spec.rb
 - spec/tophat_spec.rb
 - tophat.gemspec
-has_rdoc: true
 homepage: https://github.com/spagalloco/tophat
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: simple view helpers for your layouts
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/tophat/meta_helper_spec.rb
 - spec/tophat/opengraph_helper_spec.rb