TopHat is a set of view helpers to keep your Rails layouts and views DRY.
Ruby
Latest commit c49a7ec Apr 24, 2017 @stve version 2.3.1

README.md

TopHat

Gem Version Build Status Dependency Status Code Climate

TopHat is a set of view helpers to keep your layouts and views DRY. Easily include meta tags like keywords and descriptions, Open Graph and Twitter Cards in your Rails views.

Installation

Just add it to your Gemfile:

gem 'tophat'

Note: TopHat is compatible with Rails 3.0+.

Changes in 2.1

TopHat version < 2.1 aliased the title as t and conflicted with an existing Rails helper used for i18n translation. Version 2.1 removes this alias. If you were using t as part of TopHat previously, you will need to change your code to use TopHat's title helper instead.

Layout Usage

You'll want to add the relevant TopHat helpers to your layouts:

<head>
  <%= title :site => "My website", :separator => '|' %>
  <%= keywords :default => "Some default, keywords, that can be overridden" %>
  <%= description :default => "A description" %>
</head>

View Usage

To set the page title, use the title method to each of your views:

<% title "My page title" %>

When rendered, the page title will be included in your view.

<head>
  <title>My website | My page title</title>
</head>

Usage Options

Use these options to customize the title format:

  • :prefix (text between site name and separator) [default: '']
  • :separator (text used to separate website name from page title) [default: '']
  • :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.

<%= title :separator => "|" %>
<%= title :prefix => false, :separator => ":" %>
<%= title :lowercase => true %>
<%= title :reverse => true, :prefix => false %>
<%= title :default => "The ultimate site for Rails" %>

These options can be set as defaults for your layout, or when setting the title in your views, you can override any of the default settings by passing an optional hash

<% title "My page title", :lowercase => true, :separator => "~" %>

Meta Tags

TopHat also works with keywords and descriptions. In your view, simply declare the keywords and description.

<% description('You say goodbye, I say hello.') %>
<% keywords('John, Paul, George, Ringo') %>

Keywords can also be passed as an array:

<% keywords(%w{ John Paul George Ringo }) %>

Then in your layout, add the keyword and description helpers:

<%= keywords %>
<%= description %>

which will output the meta-tags:

<meta name="keywords" content="John, Paul, George, Ringo" />
<meta name="description" content="You say goodbye, I say hello." />

Keywords and descriptions can also take a default in the layout:

<%= keywords :default => 'Yoko, Linda' %>
<%= description :default => 'default description if none is passed' %>

Want to merge your default tags with those in your view? just pass merge_default => true

<%= keywords :default => 'Yoko, Linda', :merge_default => true %>

There are also convenience methods for 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:

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:

opengraph_html => <html xmlns:fb...>

Note: TopHat does not include a "Like" button helper. TopHat's focus is inside the <head> tag.

Twitter Card Helpers

TopHat has support for Twitter Cards.

twitter_card('summary') do |card|
  card.url 'http://mysite.com/page'
  card.title 'this is my page title'
  card.description 'some interesting info about my page'
  card.image 'http://mysite.com/animage.jpg'
end

You can nest attributes inside a twitter card:

twitter_card('player') do |card|
  card.player 'https://example.com/embed/a' do |player|
    player.height '251'
    player.width '435'
  end
end

Which will render a twitter card like so:

<meta name="twitter:card" value="player">
<meta name="twitter:player" value="https://example.com/embed/a">
<meta name="twitter:player:width" value="435">
<meta name="twitter:player:height" value="251">

To render the twitter card in your layout, simply call the twitter_card helper with no arguments:

<%= twitter_card %>

Contributing

Pull requests welcome: fork, make a topic branch, commit (squash when possible) with tests and I'll happily consider.

Copyright

Copyright (c) 2014 Steve Agalloco. See LICENSE for details.