Gem meta-tags について
今回SEO対策として何か実装したいと考えて調べてみた所、meta-tagsというGemを知りましたので、実際に使ったので備忘録として記入したいと思います。
meta-tagsの導入
routes.rb
Gem 'meta-tags'
bundlerでインストール
bundle exec
これで導入完了です
各種設定
上記の作業を正常に完了してればconfig/initializers/meta_tags.rbという感じにファイルが生成されています。
meta-tagsの内容は下記の通りです。
meta_tags.rb
# Use this setup block to configure all options available in MetaTags.
MetaTags.configure do |config|
# How many characters should the title meta tag have at most. Default is 70.
# Set to nil or 0 to remove limits.
# config.title_limit = 70
# When true, site title will be truncated instead of title. Default is false.
# config.truncate_site_title_first = false
# Maximum length of the page description. Default is 160.
# Set to nil or 0 to remove limits.
# config.description_limit = 160
# Maxumum length of the keywords meta tag. Default is 255.
# config.keywords_limit = 255
# Default separator for keywords meta tag (used when an Array passed with
# the list of keywords). Default is ", ".
# config.keywords_separator = ', '
# When true, keywords will be converted to lowercase, otherwise they will
# appear on the page as is. Default is true.
# config.keywords_lowercase = true
# List of additional meta tags that should use "property" attribute instead
# of "name" attribute in tags.
# config.property_tags.push(
# 'x-hearthstone:deck',
# )
end
こちらの記述は「タイトルでも文字数制限などを設定できますが、デフォルトでも大丈夫らしいので、今回はこのままです。
各種サイトの条件に合わせて設定してください。
metaタグの初期設定をおこなうため、「app/helpers/application_helper.rb」にdefault_meta_tagsメソッドを実装します。
application_helper.rb
module ApplicationHelper
def default_meta_tags
{
site: 'サイト名',
title: 'タイトル',
reverse: true,
charset: 'utf-8',
description: 'description',
keywords: 'キーワード',
canonical: request.original_url,
separator: '|',
icon: [
{ href: image_url('favicon.ico') },
{ href: image_url('icon.jpg'), rel: 'apple-touch-icon', sizes: '180x180', type: 'image/jpg' },
],
og: {
site_name: 'サイト名', # もしくは site_name: :site
title: 'タイトル', # もしくは title: :title
description: 'description', # もしくは description: :description
type: 'website',
url: request.original_url,
image: image_url('ogp.png'),
locale: 'ja_JP',
},
twitter: {
card: 'summary',
site: '@ツイッターのアカウント名',
}
}
end
end
これまでの作業が終わればあとは、application.html.erbのhead内に<%= display_meta_tags(default_meta_tags) %>を記述すればviewに表示できます。
以上です。
railsのコントローラーでAPIの必須項目が入力されているかチェックする方法です。
どんなケースで使うのか具体的な使い方を書いていきます。
rails guideには以下の説明がされています。
In addition, parameters can be marked as required and will flow through a predefined raise/rescue flow that will result in a 400 Bad Request being returned if not all required parameters are passed in.
サンプルコード
class UserController < ApplicationController
rescue_from ActionController::ParameterMissing, with: :handle_parameter_missing
def index
@users = User.search(user_search_params)
end
private
def user_search_params
params.require(:name, :email)
params.permit(:name, :email)
end
def handle_parameter_missing(e)
render json: { message: e.original_message }, status: 400
end
end
コードの説明
indexアクションではユーザの入力値を使ってユーザ情報の検索を行う。
ユーザの入力値はrequireメソッドを使用して必須項目の存在確認を行う。
必須項目が存在しない場合は例外ActionController::ParameterMissingが発生するのでrescue_fromで捕捉する。
rescue_fromで例外を捕捉した後handle_parameter_missing内でエラーメッセージを抽出しレスポンスのjsonを返却する。
コードの詳細な説明
1. actionの定義
ユーザの検索アクションです。User.search引数にユーザの入力値を検証したパラメーターを指定します。
def index
@users = User.search(user_search_params)
end
2. 入力値の検証
def user_search_params
params.require(:name, :email)
params.permit(:name, :email)
end
requireメソッドを使ってパラメータを検証します。
requireメソッドは引数に指定したkeyが存在しない場合、例外ActionController::ParameterMissingを発生させます。
3. 例外ActionController::ParameterMissingの捕捉
rescue_from ActionController::ParameterMissing, with: :handle_parameter_missing
def handle_parameter_missing(e)
render json: { message: e.original_message }, status: 400
end
rescue_fromでActionController::ParameterMissingを捕捉してエラー処理を行います。
エラー処理ではmessagekeyにoriginal_messageで取り出したエラーメッセージを格納します。
また、status codeに400を指定します。
エラーメッセージの抽出について
original_messageメソッドを使用して簡潔なエラーメッセージのみを取り出す事ができます。
$ e.original_message
=> "param is missing or the value is empty: name"
message メソッドだとkeyのサジェストが出てしまいます。
e.message
=> "param is missing or the value is empty: name\nDid you mean? target_date\n rate\n controller\n format"
e.full_messageだとスタックとレースが表示されます。
参考
rails guide
