README.md
# Seorel
Ruby on Rails SEO Metatags plugins for ActiveRecord models
[](https://badge.fury.io/rb/seorel)
[](https://codeclimate.com/github/dalpo/seorel)
[](https://travis-ci.org/dalpo/seorel)
## Rails Setup
`Gemfile.rb`:
```ruby
gem 'seorel', '~> 0.5.0'
# the edge version can be had using:
# gem 'seorel', github: 'dalpo/seorel'
```
`Console`:
```bash
$ bundle install
$ bundle exec rails generate seorel:install
$ bundle exec rake db:migrate
```
It will generate the `seorel.rb` initializer and a new migration.
### Configurations
You could change default meta tags values into the seorel initializer:
```ruby
Seorel.configure do |config|
config.default_title = 'My default page title goes here'
# config.default_prepend_title = nil
config.default_append_title = ' / Every title will be appended with this string'
config.default_description = 'Lorem ipsum sit dolor...'
# config.default_prepend_description = nil
# config.default_append_description = nil
config.default_keywords = 'RUBY ON RAILS,SEO,METATAGS'
config.default_image = 'http://www.example.com/share_image.png'
# config.store_seorel_if = :empty # Available values :empty | :changed
config.default_og_metas = {
type: 'website'
}
config.default_twitter_metas = {
card: 'summary_large_image'
}
# config.enable_pagination = true
# config.pagination_format = ' - Pag. %page%'
# config.pagination_parameter_name = 'page'
end
```
## Usage
### Usage with an active record model
Given a sample model Post:
```ruby
rails generate model post title:string description:text, publish_date:date
```
Edit `app/models/post.rb`:
```ruby
class Post < ActiveRecord::Base
extend Seorelify
seorelify title: :customized_title, description: :description, image: :share_image
# Or more simply:
# seorelify :customized_title, :description, :share_image
def customized_title
"THE BLOG: #{self.title}"
end
end
```
This will use the `customized_title` and the `description` methods as references to generate automatically the related metatags.
Note that the title and description will be sanitized from HTML and truncated to 255 characters.
### Controllers
In your controllers you may add\_metatags either like a before\_filter or within a method.
```ruby
class PostsController < ApplicationController
def index
###
# Custom meta tags
add_metatags({
title: 'My custom meta title',
description: 'My custom meta description',
image: '/sample_image.png'
})
...
end
def show
@post = Post.find(params[:id])
###
# Extract meta tags info from your Seorelified Model
add_metatags @post
...
end
def history
...
end
end
```
In case of missing `add_metatags` declaration in controller actions, you can define metatags through rails `L10n` library. Simply by defining your locale strings for seorel.
For instance `seorel.en.yml`:
```yaml
# encoding: utf-8
en:
seorel:
# controller_name:
# action_name:
# prepend_title: '...'
# title: '...'
# append_title: '...'
#
# prepend_description: '...'
# description: '...'
# append_description: '...'
posts:
show:
prepend_title: "Details for: "
history:
title: "Posts history metatitle"
description: "Posts history metadescriprion"
tags:
index:
title: "Tag list"
description: "Tag list metadescription"
```
Where `posts` and `tags` are controller names, while `history` and `index` are their actions.
### Views
In your layout <head></head> section just call the `render_meta_tags` helper:
```html
<head>
<%= render_meta_tags %>
...
</head>
```
## Contributing
Submitting a Pull Request:
1. [Fork the repository.][fork]
2. [Create a topic branch.][branch]
3. Implement your feature or bug fix.
4. Add, commit, and push your changes.
5. [Submit a pull request.][pr]
[fork]: http://help.github.com/fork-a-repo/
[branch]: http://learn.github.com/p/branching.html
[pr]: http://help.github.com/send-pull-requests/
## This project rocks and uses MIT-LICENSE.
Copyright 2016 Andrea Dal Ponte
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.