tkosuga / seory

Manage SEO contents in Rails app. based on controller, action and more complex context.

seory

Manage SEO contents in Rails app. based on controller, action and more complex context.

Installation

Add this line to your application's Gemfile:

gem 'seory'

And then execute:

$ bundle

Or install it yourself as:

$ gem install seory

Usage

Specify SEO content as ruby code. For example, config/initializers/seory.rb

# Specify SEO content based on `controller#action` rule
match %w[products#popular products#new_release], {
  title:    'Great products | My Great Site[MGS]'
  desc:     'A lot of greate products'

  keywords: %w[Software Internet Service]

  h1:       'Most popular products'
}

# Can contain dynamic content based on controller using assigned ivar
match 'brands#show' {
  title { assign(:brand).name }
}

# Custom lookup rule with controller
match ->(controller) { controller.params[:page].to_i == 1 }, {
  keywords do
    search = assign(:search_object)

    # do something
  end
}

# Use custom word part
match %w[products#index] do
  misc(:page_name) { "#{controller.params[:page].to_i} page | Good products") }

  title  :page_name
  h1     :page_name

  desc   { "Page for #{page_name}" }
}

default do
  title  'My Great Service'
  h1     { I18n.t("#{controller_name}.h1", scope: 'label.misc_pages' }
end

Then we can use seory in your application.[TODO]

module ApplicationHelper

  # provides seory() method,
  # which returns Seory::Runtime object with configured
  include Seory::Helper
end

%html
  %head
    %title= seory.title
    ...
  %body
    %h1= seory.h1

Contributing

1. Fork it ( https://github.com/esminc/seory/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Thanks

• @libkazz: Specification adviser
• @darashi: God father