meta-tags 2.4.1 → 2.5.0

data/.travis.yml

@@ -1,39 +1,27 @@
 sudo: false
 cache: bundler
 
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - 2.4.0
-
 env:
-  - "RAILS_VERSION=3.2.0"
-  - "RAILS_VERSION=4.0.0"
-  - "RAILS_VERSION=4.1.0"
-  - "RAILS_VERSION=4.2.0"
-  - "RAILS_VERSION=5.0.0"
-  - "RAILS_VERSION=5.1.0"
+  global:
+    - CC_TEST_REPORTER_ID=8792cbc0d1780830ddd3dd7eb1c25f09f386ba8f04449ad830039469406a6ab3
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
+  matrix:
+    - RAILS_VERSION=4.2.9
+    - RAILS_VERSION=5.0.5
+    - RAILS_VERSION=5.1.3
 
-matrix:
-  exclude:
-    - rvm: 2.0.0
-      env: "RAILS_VERSION=5.0.0"
-    - rvm: 2.1.10
-      env: "RAILS_VERSION=5.0.0"
-    - rvm: 2.0.0
-      env: "RAILS_VERSION=5.1.0"
-    - rvm: 2.1.10
-      env: "RAILS_VERSION=5.1.0"
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 
 notifications:
   recipients:
     - kpumuk@kpumuk.info
 
-addons:
-  code_climate:
-    repo_token: "8792cbc0d1780830ddd3dd7eb1c25f09f386ba8f04449ad830039469406a6ab3"
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
 
-after_success:
-  - bundle exec codeclimate-test-reporter
+after_script:
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT --coverage-input-type clover || true; fi

data/CHANGELOG.md

@@ -1,9 +1,17 @@
-## 2.4.1 (May 15, 2017)
+## 2.5.0 (August 23, 2017) [☰](https://github.com/kpumuk/meta-tags/compare/v2.4.1...v2.5.0)
+
+Features:
+  - Fully support [Open Graph objects](https://developers.facebook.com/docs/reference/opengraph) meta tags.
+
+Changes:
+  - Dropped official support for Rails older than 4.2 and Ruby older than 2.2 (both reached their End of Life)
+
+## 2.4.1 (May 15, 2017) [☰](https://github.com/kpumuk/meta-tags/compare/v2.4.0...v2.4.1)
 
 Features:
   - Rails 5.1 support added
 
-## 2.4.0 (December 8, 2016)
+## 2.4.0 (December 8, 2016) [☰](https://github.com/kpumuk/meta-tags/compare/v2.3.1...v2.4.0)
 
 Features:
   - Added amphtml links support
@@ -11,7 +19,7 @@ Features:
 Bugfixes:
   - Fixed `place` attribute meta tag generation
 
-## 2.3.1 (September 13, 2016)
+## 2.3.1 (September 13, 2016) [☰](https://github.com/kpumuk/meta-tags/compare/v2.2.0...v2.3.1)
 
 Changes:
   - Added follow meta tag support
@@ -21,7 +29,7 @@ Features:
 
 Bugfixes:
 
-## 2.2.0 (August 24, 2016)
+## 2.2.0 (August 24, 2016) [☰](https://github.com/kpumuk/meta-tags/compare/v2.1.0...v2.2.0)
 
 Changes:
 
@@ -40,7 +48,7 @@ Bugfixes:
   - Fixed the issue when title was truncated in some cases, when site_title was blank
   - Fixed meta tag attributes for `fb:` meta tags
 
-## 2.1.0 (October 6, 2015)
+## 2.1.0 (October 6, 2015) [☰](https://github.com/kpumuk/meta-tags/compare/v2.0.0...v2.1.0)
 
 Changes:
 
@@ -58,7 +66,7 @@ Bugfixes
   - Generate `<meta name=""/>` instead of `<meta property=""/>` for custom meta tags
   - Double HTML escaping in meta tags
 
-## 2.0.0 (April 15, 2014)
+## 2.0.0 (April 15, 2014) [☰](https://github.com/kpumuk/meta-tags/compare/v1.6.0...v2.0.0)
 
 Features:
 
@@ -68,7 +76,7 @@ Bugfixes:
 
   - Symlink references in nested hashes include use normalized meta tag values.
 
-## 1.6.0 (April 14, 2014)
+## 1.6.0 (April 14, 2014) [☰](https://github.com/kpumuk/meta-tags/compare/v1.5.0...v1.6.0)
 
 Features:
 
@@ -80,26 +88,26 @@ Breaking changes:
 
   - Removed support of Rails older than 3.0.0 due to the bug in `Hash#deep_merge` (does not support `HashWithIndifferentAccess`)
 
-## 1.5.0 (May 7, 2013)
+## 1.5.0 (May 7, 2013) [☰](https://github.com/kpumuk/meta-tags/compare/v1.4.1...v1.5.0)
 
 Features:
 
   - Added "prev" and "next" links support
   - Added refresh meta tag support
 
-## 1.4.1 (March 14, 2013)
+## 1.4.1 (March 14, 2013) [☰](https://github.com/kpumuk/meta-tags/compare/v1.4.0...v1.4.1)
 
 Bugfixes:
 
   - Added support for Hash inside of an Array
 
-## 1.4.0 (March 14, 2013)
+## 1.4.0 (March 14, 2013) [☰](https://github.com/kpumuk/meta-tags/compare/v1.3.0...v1.4.0)
 
 Features:
 
   - Added support of custom meta tags
 
-## 1.3.0 (February 13, 2013)
+## 1.3.0 (February 13, 2013) [☰](https://github.com/kpumuk/meta-tags/compare/v1.2.6...v1.3.0)
 
 Features:
 
@@ -112,13 +120,13 @@ Bugfixes:
   - Do not display title HTML tag when title is blank
   - Do not display OpenGraph tags when content is empty
 
-## 1.2.6 (March 4, 2012)
+## 1.2.6 (March 4, 2012) [☰](https://github.com/kpumuk/meta-tags/compare/v1.2.5...v1.2.6)
 
 Features:
 
   - jQuery.pjax support via `display_title` method. Check README for details
 
-## 1.2.5 (March 3, 2012)
+## 1.2.5 (March 3, 2012) [☰](https://github.com/kpumuk/meta-tags/compare/v1.2.4...v1.2.5)
 
 Bugfixes:
 
@@ -126,7 +134,7 @@ Bugfixes:
   - Fixed incorrect page title when `:site` is is blank
   - Normalize `:og` attribute to `:open_graph`
 
-## 1.2.4 (April 26, 2011)
+## 1.2.4 (April 26, 2011) [☰](https://github.com/kpumuk/meta-tags/compare/v1.2.3...v1.2.4)
 
 Features:
 
@@ -137,34 +145,34 @@ Bugfixes:
   - Fixed bug with double HTML escaping in title separator
   - Allow to set meta title without a separator
 
-## 1.2.2, 1.2.3 (June 10, 2010)
+## 1.2.2, 1.2.3 (June 10, 2010) [☰](https://github.com/kpumuk/meta-tags/compare/v1.2.1...v1.2.3)
 
 Bugfixes:
 
   - Fixed action\_pack integration (welcome back `alias_method_chain`)
   - Fixed bug when `@page_*` variables did not work
 
-## 1.2.1 (June 2, 2010)
+## 1.2.1 (June 2, 2010) [☰](https://github.com/kpumuk/meta-tags/compare/v1.2.0...v1.2.1)
 
 Bugfixes:
 
   - Fixed deprecation warning about `html_safe!`
 
-## 1.2.0 (May 31, 2010)
+## 1.2.0 (May 31, 2010) [☰](https://github.com/kpumuk/meta-tags/compare/v1.1.1...v1.2.0)
 
 Bugfixes:
 
   - Fixed bug when title is set through Array, and `:lowercase` is true
   - Updated `display_meta_tags` to be compatible with rails_xss
 
-## 1.1.1 (November 21, 2009)
+## 1.1.1 (November 21, 2009) [☰](https://github.com/kpumuk/meta-tags/compare/v1.1.0...v1.1.1)
 
 Features:
 
   - Added support for canonical link element
   - Added YARD documentation
 
-## 1.1.0 (November 5, 2009)
+## 1.1.0 (November 5, 2009) [☰](https://github.com/kpumuk/meta-tags/commits/v1.1.0)
 
 Features:
 

data/Gemfile

@@ -13,5 +13,4 @@ end
 
 group :test do
   gem 'simplecov'
-  gem 'codeclimate-test-reporter', '~> 1.0.0'
 end

data/README.md

@@ -9,10 +9,13 @@ Search Engine Optimization (SEO) plugin for Ruby on Rails applications.
 
 ## Ruby on Rails
 
-MetaTags master branch now fully supports Rails 3.2+, and is tested against all
+MetaTags master branch fully supports Ruby on Rails 4.2+, and is tested against all
 major Rails releases up to 5.1.
 
-Ruby versions older than 2.0.0 are no longer officially supported.
+Ruby versions older than 2.2.0 are no longer officially supported.
+
+_Please note_ that we are no longer support Ruby versions older than 2.2.0 and
+Ruby on Rails older than 4.2, because they [reached their End of Life](https://github.com/kpumuk/meta-tags/pull/143).
 
 ## Installation
 
@@ -33,13 +36,241 @@ preferences. In order to do that, you can create an initializer
 
 ```ruby
 MetaTags.configure do |c|
-  c.title_limit        = 70
-  c.description_limit  = 160
-  c.keywords_limit     = 255
-  c.keywords_separator = ', '
+  c.title_limit          = 70
+  c.description_limit    = 160
+  c.keywords_limit       = 255
+  c.keywords_separator   = ', '
+  c.property_tags.push(
+    'x-hearthstone:deck',
+  )
 end
 ```
 
+By default meta tags are rendered with the key `name`. Since, some meta tags are
+required to use `property` instead (like Facebook Open Graph object), MetaTags gem
+allows to configure which tags to render with `property` attribute. By default
+the pre-configured list includes all possible Facebook Open Graph object types, but
+you can add your own in case you need it.
+
+**Please note**: Use `c.property_tags.push` instead of `c.property_tags =`, so you
+do not reset the list of default tags, which would lead to invalid Open Graph
+meta tags.
+
+## MetaTags Usage
+
+First, add this code to your main layout:
+
+```erb
+<head>
+  <%= display_meta_tags site: 'My website' %>
+</head>
+```
+
+Then, to set the page title, add this to each of your views (see below for other options):
+
+```erb
+<h1><%= title 'My page title' %></h1>
+```
+
+When views are rendered, the page title will be included in the right spots:
+
+```html
+<head>
+  <title>My website | My page title</title>
+</head>
+<body>
+  <h1>My page title</h1>
+</body>
+```
+
+You can find allowed options for `display_meta_tags` method below.
+
+### Using MetaTags in controller
+
+You can define following instance variables:
+
+```ruby
+@page_title       = 'Member Login'
+@page_description = 'Member login page.'
+@page_keywords    = 'Site, Login, Members'
+```
+
+Also you could use `set_meta_tags` method to define all meta tags simultaneously:
+
+```ruby
+set_meta_tags title: 'Member Login',
+              description: 'Member login page.',
+              keywords: 'Site, Login, Members'
+```
+
+You can find allowed options for `set_meta_tags` method below.
+
+### Using MetaTags in view
+
+To set meta tags you can use following methods:
+
+```erb
+<% title 'Member Login' %>
+<% description 'Member login page.' %>
+<% keywords 'Member login page.' %>
+<% nofollow %>
+<% noindex %>
+<% refresh 3 %>
+```
+
+Also there is `set_meta_tags` method exists:
+
+```erb
+<% set_meta_tags title: 'Member Login',
+                 description: 'Member login page.',
+                 keywords: 'Site, Login, Members' %>
+```
+
+The `title` method returns title itself, so you can use it to show the title
+somewhere on the page:
+
+```erb
+<h1><%= title 'Member Login' %></h1>
+```
+
+If you want to set the title and display another text, use this:
+
+```erb
+<h1><%= title 'Member Login', 'Here you can login to the site:' %></h1>
+```
+
+### Allowed options for `display_meta_tags` and `set_meta_tags` methods
+
+Use these options to customize the title format:
+
+* `:site` — site title;
+* `:title` — page title;
+* `:description` — page description;
+* `:keywords` — page keywords;
+* `:charset` — page character set;
+* `: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;
+* `:noindex` — add noindex meta tag; when true, 'robots' will be used, otherwise the string will be used;
+* `:nofollow` — add nofollow meta tag; when true, 'robots' will be used, otherwise the string will be used;
+* `:follow` – add follow meta tag; when true, 'robots' will be used, otherwise the string will be used;
+* `:canonical` — add canonical link tag;
+* `:author` — add author link tag;
+* `:publisher` — add publisher link tag;
+* `:prev` — add prev link tag;
+* `:next` — add next link tag;
+* `:image_src`  — add image_src link tag;
+* `:og` — add Open Graph tags (Hash);
+* `:twitter` — add Twitter tags (Hash);
+* `:refresh` — refresh interval and optionally url to redirect to.
+
+And here are a few examples to give you ideas.
+
+```erb
+<%= display_meta_tags separator: "&mdash;".html_safe %>
+<%= display_meta_tags prefix: false, separator: ":" %>
+<%= display_meta_tags lowercase: true %>
+<%= display_meta_tags reverse: true, prefix: false %>
+<%= display_meta_tags og: { title: 'The Rock', type: 'video.movie' } %>
+<%= display_meta_tags alternate: { 'zh-Hant' => 'http://example.com.tw/base/url' } %>
+```
+
+### Allowed values
+
+You can specify `:title` as a string or array:
+
+```ruby
+set_meta_tags title: ['part1', 'part2'], site: 'site'
+# site | part1 | part2
+set_meta_tags title: ['part1', 'part2'], reverse: true, site: 'site'
+# part2 | part1 | site
+```
+
+Keywords can be passed as string of comma-separated values, or as an array:
+
+```ruby
+set_meta_tags keywords: ['tag1', 'tag2']
+# tag1, tag2
+```
+
+Description is a string (HTML will be stripped from output string).
+
+### Mirrored values
+
+Sometimes, it is desirable to mirror meta tag values down into namespaces. A
+common use case is when you want open graph's `og:title` to be identical to
+the `title`.
+
+Say, you have the following in your application layout:
+
+```ruby
+display_meta_tags og: {
+  title: :title
+}
+```
+
+The value of `og[:title]` is a symbol and therefore references the value of the
+top level `title` meta tag. With the following in any view:
+
+```ruby
+title 'my great view'
+```
+
+You get this open graph meta tag for free:
+
+```html
+<meta property="og:title" content="my great view"></meta>
+```
+
+### Using with Turbolinks
+
+[Turbolinks](https://github.com/turbolinks/turbolinks) is a simple solution for getting
+the performance benefits of a single-page application without the added complexity of a
+client-side JavaScript framework. MetaTags supports Turbolinks out of the box, no
+configuration is necessary.
+
+### Using with pjax
+
+[jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation
+without full page reload. The main difference is that layout file will not be rendered,
+so page title will not change. To fix this, when using a page fragment, pjax will check
+the fragment DOM element for a `title` or `data-title` attribute and use any value it finds.
+
+MetaTags simplifies this with `display_title` method, which returns fully resolved
+page title (include site, prefix/suffix, etc.) But in this case you will have to
+set default parameters (e.g, `:site`) both in layout file and in your views. To minimize
+code duplication, you can define a helper in `application_helper.rb`:
+
+```ruby
+def default_meta_tags
+  {
+    title:       'Member Login',
+    description: 'Member login page.',
+    keywords:    'Site, Login, Members',
+    separator:   "&mdash;".html_safe,
+  }
+end
+```
+
+Then in your layout file use:
+
+```erb
+<%= display_meta_tags(default_meta_tags) %>
+```
+
+And in your pjax templates:
+
+```erb
+<!-- set title here, so we can use it both in "display_title" and in "title" -->
+<% title "My Page title" %>
+<%= content_tag :div, data: { title: display_title(default_meta_tags) } do %>
+    <h1><%= title %></h1>
+    <!-- HTML goes here -->
+<% end %>
+```
+
 ## SEO Basics and MetaTags
 
 ### Titles
@@ -499,214 +730,6 @@ set_meta_tags author: [ "Dmytro Shteflyuk", "John Doe" ]
 # <meta name="author" content="John Doe"/>
 ```
 
-## MetaTags Usage
-
-First, add this code to your main layout:
-
-```erb
-<head>
-  <%= display_meta_tags site: 'My website' %>
-</head>
-```
-
-Then, to set the page title, add this to each of your views (see below for other options):
-
-```erb
-<h1><%= title 'My page title' %></h1>
-```
-
-When views are rendered, the page title will be included in the right spots:
-
-```html
-<head>
-  <title>My website | My page title</title>
-</head>
-<body>
-  <h1>My page title</h1>
-</body>
-```
-
-You can find allowed options for `display_meta_tags` method below.
-
-### Using MetaTags in controller
-
-You can define following instance variables:
-
-```ruby
-@page_title       = 'Member Login'
-@page_description = 'Member login page.'
-@page_keywords    = 'Site, Login, Members'
-```
-
-Also you could use `set_meta_tags` method to define all meta tags simultaneously:
-
-```ruby
-set_meta_tags title: 'Member Login',
-              description: 'Member login page.',
-              keywords: 'Site, Login, Members'
-```
-
-You can find allowed options for `set_meta_tags` method below.
-
-### Using MetaTags in view
-
-To set meta tags you can use following methods:
-
-```erb
-<% title 'Member Login' %>
-<% description 'Member login page.' %>
-<% keywords 'Member login page.' %>
-<% nofollow %>
-<% noindex %>
-<% refresh 3 %>
-```
-
-Also there is `set_meta_tags` method exists:
-
-```erb
-<% set_meta_tags title: 'Member Login',
-                 description: 'Member login page.',
-                 keywords: 'Site, Login, Members' %>
-```
-
-The `title` method returns title itself, so you can use it to show the title
-somewhere on the page:
-
-```erb
-<h1><%= title 'Member Login' %></h1>
-```
-
-If you want to set the title and display another text, use this:
-
-```erb
-<h1><%= title 'Member Login', 'Here you can login to the site:' %></h1>
-```
-
-### Allowed options for `display_meta_tags` and `set_meta_tags` methods
-
-Use these options to customize the title format:
-
-* `:site` — site title;
-* `:title` — page title;
-* `:description` — page description;
-* `:keywords` — page keywords;
-* `:charset` — page character set;
-* `: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;
-* `:noindex` — add noindex meta tag; when true, 'robots' will be used, otherwise the string will be used;
-* `:nofollow` — add nofollow meta tag; when true, 'robots' will be used, otherwise the string will be used;
-* `:follow` – add follow meta tag; when true, 'robots' will be used, otherwise the string will be used;
-* `:canonical` — add canonical link tag;
-* `:author` — add author link tag;
-* `:publisher` — add publisher link tag;
-* `:prev` — add prev link tag;
-* `:next` — add next link tag;
-* `:image_src`  — add image_src link tag;
-* `:og` — add Open Graph tags (Hash);
-* `:twitter` — add Twitter tags (Hash);
-* `:refresh` — refresh interval and optionally url to redirect to.
-
-And here are a few examples to give you ideas.
-
-```erb
-<%= display_meta_tags separator: "&mdash;".html_safe %>
-<%= display_meta_tags prefix: false, separator: ":" %>
-<%= display_meta_tags lowercase: true %>
-<%= display_meta_tags reverse: true, prefix: false %>
-<%= display_meta_tags og: { title: 'The Rock', type: 'video.movie' } %>
-<%= display_meta_tags alternate: { 'zh-Hant' => 'http://example.com.tw/base/url' } %>
-```
-
-### Allowed values
-
-You can specify `:title` as a string or array:
-
-```ruby
-set_meta_tags title: ['part1', 'part2'], site: 'site'
-# site | part1 | part2
-set_meta_tags title: ['part1', 'part2'], reverse: true, site: 'site'
-# part2 | part1 | site
-```
-
-Keywords can be passed as string of comma-separated values, or as an array:
-
-```ruby
-set_meta_tags keywords: ['tag1', 'tag2']
-# tag1, tag2
-```
-
-Description is a string (HTML will be stripped from output string).
-
-### Mirrored values
-
-Sometimes, it is desirable to mirror meta tag values down into namespaces. A
-common use case is when you want open graph's `og:title` to be identical to
-the `title`.
-
-Say, you have the following in your application layout:
-
-```ruby
-display_meta_tags og: {
-  title: :title
-}
-```
-
-The value of `og[:title]` is a symbol and therefore references the value of the
-top level `title` meta tag. With the following in any view:
-
-```ruby
-title 'my great view'
-```
-
-You get this open graph meta tag for free:
-
-```html
-<meta property="og:title" content="my great view"></meta>
-```
-
-### Using with pjax
-
-[jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation
-without full page reload. The main difference is that layout file will not be rendered,
-so page title will not change. To fix this, when using a page fragment, pjax will check
-the fragment DOM element for a `title` or `data-title` attribute and use any value it finds.
-
-MetaTags simplifies this with `display_title` method, which returns fully resolved
-page title (include site, prefix/suffix, etc.) But in this case you will have to
-set default parameters (e.g, `:site`) both in layout file and in your views. To minimize
-code duplication, you can define a helper in `application_helper.rb`:
-
-```ruby
-def default_meta_tags
-  {
-    title:       'Member Login',
-    description: 'Member login page.',
-    keywords:    'Site, Login, Members',
-    separator:   "&mdash;".html_safe,
-  }
-end
-```
-
-Then in your layout file use:
-
-```erb
-<%= display_meta_tags(default_meta_tags) %>
-```
-
-And in your pjax templates:
-
-```erb
-<!-- set title here, so we can use it both in "display_title" and in "title" -->
-<% title "My Page title" %>
-<%= content_tag :div, data: { title: display_title(default_meta_tags) } do %>
-    <h1><%= title %></h1>
-    <!-- HTML goes here -->
-<% end %>
-```
-
 ## Author
 
 [Dmytro Shteflyuk](https://github.com/kpumuk), [https://kpumuk.info](http://kpumuk.info/)