meta-tags 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a5fade8f101dbfec80dc93b0ede2c9c64961497828fa4544fd7b591f889e479
-  data.tar.gz: fb031edc1dc4f16bc286961bc9772f8e9ef34855ce12ad84ae2a3c1306cf0013
+  metadata.gz: 623738e419a62299132050216fd53ae9e8c6bbc44cd1f17befd3e3560a1a4b98
+  data.tar.gz: 89e2a81fd16a51b31512adbcb732d76fa973c01d28f30fa92cdbec8961b9b88c
 SHA512:
-  metadata.gz: a1ce2e4321fb30f1a2a95107436e7c31f2b6da89e4979988f80cea5690e720cfc7c05997c08b084991b8a3c69f13a99b44ad60af2455dd9944aede8d6ed3c598
-  data.tar.gz: ddb7aeb1197227116a51d70d08d9921ce1c9d7194b35dda95fccaa09e4b8caf6e67f76f83b9bd5a46f191806572330d4dac0388a8d0068752e42e33acee8bbf9
+  metadata.gz: e5a8ddfaa667a93609c15955690aadd8e6afa01a02f1d1c7a469a2e0621cb2f1def23efffca69bd2a1c7a2ee5bbf2a2ddf6304d29c49a1024ff36c7c4429185d
+  data.tar.gz: baa13d008e47c3fb9a49826435382256dc14c8395d2a3fe00adb0a80fab9ca1ae8e4f776ab20a21cbfd0f8cd8afb0ce8a12c2efbcdf0af4b7b86d65611035f54

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# Changelog
+
+## 2.15.0 (August 2, 2021) [☰](https://github.com/kpumuk/meta-tags/compare/v2.14.0...v2.15.0)
+
+Changes:
+
+- Added Ruby 3.0 to supported versions
+- Ruby 2.5 is now a required minimum version (we dropped official support for Ruby versions older than 2.5 about 8 months ago)
+- Added `skip_canonical_links_on_noindex` configuration variable that allows to disable canonical links of the pages that are excluded from indexing ([214](https://github.com/kpumuk/meta-tags/pull/214))
+- Added support for `itemprop` in `_` tag for custom tags ([203](https://github.com/kpumuk/meta-tags/pull/203))
+
+Bugfixes:
+
+- Fixed error "can't modify frozen String" in `strip_tags`.
+- Fixed Ruby warning about an instance variable that is not initialized.
+
 ## 2.14.0 (December 10, 2020) [☰](https://github.com/kpumuk/meta-tags/compare/v2.13.0...v2.14.0)
 
 Changes:

data/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Contributing
 
 We love pull requests from everyone. By participating in this project, you
-agree to abide by the [code of conduct](https://github.com/kpumuk/meta-tags/blob/master/CODE_OF_CONDUCT.md).
+agree to abide by the [code of conduct](https://github.com/kpumuk/meta-tags/blob/main/CODE_OF_CONDUCT.md).
 
 ## Configuring Development Environment
 
@@ -29,13 +29,13 @@ Make your change. Add tests for your change. Make the tests pass:
 argument for the meta tag name should be `name`:
 
 ```html
-<meta name="keywords" content="HTML,CSS,XML,JavaScript">
+<meta name="keywords" content="HTML,CSS,XML,JavaScript" />
 ```
 
 Some social networks require to use `property` argument instead (Facebook Open Graph).
 MetaTags supports the most popular meta tags, but there will be tags that are not covered
 by default. If you found one, and you feel like the community would benefit from
-MetaTags supporting it out of the box, feel free to add it to [the list](https://github.com/kpumuk/meta-tags/blob/master/lib/meta_tags/configuration.rb#L23-L57)
+MetaTags supporting it out of the box, feel free to add it to [the list](https://github.com/kpumuk/meta-tags/blob/main/lib/meta_tags/configuration.rb#L23-L57)
 and submit a pull request.
 
 ## Raising a Pull Request
@@ -47,6 +47,6 @@ within couple days. We may suggest some changes or improvements or alternatives.
 
 Some things that will increase the chance that your pull request is accepted:
 
-* Write tests.
-* Make sure [CodeClimate](https://codeclimate.com/github/kpumuk/meta-tags/builds) build is clean.
-* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+- Write tests.
+- Make sure [CodeClimate](https://codeclimate.com/github/kpumuk/meta-tags/builds) build is clean.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

data/Gemfile

@@ -13,7 +13,7 @@ end
 group :test do
   # Lock rubocop to a specific version we use on CI. If you update this,
   # don't forget to switch rubocop channel in the .codeclimate.yml
-  gem 'rubocop', '~> 0.75.0'
+  gem 'rubocop', '~> 1.18.0'
   # Cops for rails apps
   gem 'rubocop-rails'
   # Apply RSpec rubocop cops

data/README.md

@@ -5,13 +5,13 @@
 [![Code Climate](https://codeclimate.com/github/kpumuk/meta-tags/badges/gpa.svg)](https://codeclimate.com/github/kpumuk/meta-tags)
 [![Test Coverage](https://codeclimate.com/github/kpumuk/meta-tags/badges/coverage.svg)](https://codeclimate.com/github/kpumuk/meta-tags/coverage)
 [![Gem Downloads](https://img.shields.io/gem/dt/meta-tags.svg)](https://badge.fury.io/rb/meta-tags)
-[![Changelog](https://img.shields.io/badge/Changelog-latest-blue.svg)](https://github.com/kpumuk/meta-tags/blob/master/CHANGELOG.md)
+[![Changelog](https://img.shields.io/badge/Changelog-latest-blue.svg)](https://github.com/kpumuk/meta-tags/blob/main/CHANGELOG.md)
 
 Search Engine Optimization (SEO) plugin for Ruby on Rails applications.
 
 ## Ruby on Rails
 
-MetaTags master branch fully supports Ruby on Rails 5.1+, and is tested against all
+MetaTags main branch fully supports Ruby on Rails 5.1+, and is tested against all
 major Rails releases up to 6.1.
 
 Ruby versions older than 2.5 are no longer officially supported.
@@ -409,6 +409,9 @@ Canonical link element tells a search engine what is the canonical or main URL
 for a content which have multiple URLs. The search engine will always return
 that URL, and link popularity and authority will be applied to that URL.
 
+Note: If you like follow a hint of John Mueller that you shouldn't mix canonical with noindex, then you can
+set `MetaTags.config.skip_canonical_links_on_noindex = true` and we'll handle it for you.
+
 ```ruby
 set_meta_tags canonical: "http://yoursite.com/canonical/url"
 # <link rel="canonical" href="http://yoursite.com/canonical/url">
@@ -694,6 +697,24 @@ set_meta_tags twitter: {
 # <meta name="twitter:image:height" content="100">
 ```
 
+Special parameter `itemprop` can be used on a "anonymous" tag "\_" to generate "itemprop" HTML attribute:
+
+```ruby
+set_meta_tags twitter: {
+  card:  "photo",
+  image: {
+    _:        "http://example.com/1.png",
+    width:    100,
+    height:   100,
+    itemprop: "image",
+  }
+}
+# <meta name="twitter:card" content="photo">
+# <meta name="twitter:image" content="http://example.com/1.png" itemprop="image">
+# <meta name="twitter:image:width" content="100">
+# <meta name="twitter:image:height" content="100">
+```
+
 Further reading:
 
 - [Twitter Cards Documentation](https://dev.twitter.com/cards/)

data/lib/meta_tags.rb

@@ -32,4 +32,4 @@ require 'meta_tags/content_tag'
 require 'meta_tags/text_normalizer'
 require 'meta_tags/view_helper'
 
-require 'meta_tags/railtie.rb' if defined?(Rails)
+require 'meta_tags/railtie' if defined?(Rails)

data/lib/meta_tags/configuration.rb

@@ -33,6 +33,12 @@ module MetaTags
     # - an array of strings or symbols representing their names or name-prefixes.
     attr_reader :property_tags
 
+    # Configure whenever Meta-Tags should skip canonicals on pages with noindex: true
+    # "shouldn't mix noindex & rel=canonical comes from: they're very contradictory pieces of information for us."
+    # - John Mueller (Webmaster Trends Analyst at Google)
+    # https://www.reddit.com/r/TechSEO/comments/8yahdr/2_questions_about_the_canonical_tag/e2dey9i/
+    attr_accessor :skip_canonical_links_on_noindex
+
     # Initializes a new instance of Configuration class.
     def initialize
       reset_defaults!
@@ -77,6 +83,7 @@ module MetaTags
       @property_tags = default_property_tags.dup
       @open_meta_tags = true
       @minify_output = false
+      @skip_canonical_links_on_noindex = false
     end
   end
 end

data/lib/meta_tags/controller_helper.rb

@@ -15,9 +15,9 @@ module MetaTags
     # Processes the <tt>@page_title</tt>, <tt>@page_keywords</tt>, and
     # <tt>@page_description</tt> instance variables and calls +render+.
     def render(*args, &block)
-      meta_tags[:title]       = @page_title       if @page_title
-      meta_tags[:keywords]    = @page_keywords    if @page_keywords
-      meta_tags[:description] = @page_description if @page_description
+      meta_tags[:title]       = @page_title       if defined?(@page_title) && @page_title
+      meta_tags[:keywords]    = @page_keywords    if defined?(@page_keywords) && @page_keywords
+      meta_tags[:description] = @page_description if defined?(@page_description) && @page_description
 
       super
     end

data/lib/meta_tags/renderer.rb

@@ -26,6 +26,7 @@ module MetaTags
       render_with_normalization(tags, :description)
       render_with_normalization(tags, :keywords)
       render_refresh(tags)
+      render_canonical_link(tags)
       render_noindex(tags)
       render_alternate(tags)
       render_open_search(tags)
@@ -150,7 +151,7 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_links(tags)
-      [ :amphtml, :canonical, :prev, :next, :image_src, :manifest ].each do |tag_name|
+      [ :amphtml, :prev, :next, :image_src, :manifest ].each do |tag_name|
         href = meta_tags.extract(tag_name)
         if href.present?
           @normalized_meta_tags[tag_name] = href
@@ -159,6 +160,19 @@ module MetaTags
       end
     end
 
+    # Renders canonical link
+    #
+    # @param [Array<Tag>] tags a buffer object to store tag in.
+    #
+    def render_canonical_link(tags)
+      href = meta_tags.extract(:canonical) # extract, so its not used anywhere else
+      return if MetaTags.config.skip_canonical_links_on_noindex && meta_tags[:noindex]
+      return if href.blank?
+
+      @normalized_meta_tags[:canonical] = href
+      tags << Tag.new(:link, rel: :canonical, href: href)
+    end
+
     # Renders complex hash objects.
     #
     # @param [Array<Tag>] tags a buffer object to store tag in.
@@ -201,16 +215,17 @@ module MetaTags
     # @param [Hash, Array, String, Symbol] content text content or a symbol reference to
     # top-level meta tag.
     #
-    def process_tree(tags, property, content, **opts)
+    def process_tree(tags, property, content, itemprop: nil, **opts)
       method = case content
                when Hash
                  :process_hash
                when Array
                  :process_array
                else
+                 iprop = itemprop
                  :render_tag
                end
-      __send__(method, tags, property, content, **opts)
+      __send__(method, tags, property, content, itemprop: iprop, **opts)
     end
 
     # Recursive method to process a hash with meta tags
@@ -220,10 +235,16 @@ module MetaTags
     # @param [Hash] content nested meta tag attributes.
     #
     def process_hash(tags, property, content, **opts)
+      itemprop = content.delete(:itemprop)
       content.each do |key, value|
-        key = key.to_s == '_' ? property : "#{property}:#{key}"
+        if key.to_s == '_'
+          iprop = itemprop
+          key = property
+        else
+          key = "#{property}:#{key}"
+        end
         value = normalized_meta_tags[value] if value.kind_of?(Symbol)
-        process_tree(tags, key, value, **opts)
+        process_tree(tags, key, value, **opts.merge(itemprop: iprop))
       end
     end
 
@@ -244,9 +265,9 @@ module MetaTags
     # @param [String, Symbol] value text content or a symbol reference to
     # top-level meta tag.
     #
-    def render_tag(tags, name, value, name_key: nil, value_key: :content)
+    def render_tag(tags, name, value, itemprop: nil)
       name_key ||= configured_name_key(name)
-      tags << Tag.new(:meta, name_key => name.to_s, value_key => value) if value.present?
+      tags << Tag.new(:meta, name_key => name.to_s, content: value, itemprop: itemprop) if value.present?
     end
 
     # Returns meta tag property name for a give meta tag based on the

data/lib/meta_tags/text_normalizer.rb

@@ -110,10 +110,12 @@ module MetaTags
       return '' if string.nil?
       raise ArgumentError, 'Expected a string or an object that implements #to_str' unless string.respond_to?(:to_str)
 
-      strip_tags(string.to_str).tap do |s|
-        s.gsub!(/\s+/, ' ')
-        s.strip! if strip
-      end
+      s = strip_tags(string.to_str)
+      s = s.dup if s.frozen?
+      s.gsub!(/\s+/, ' ')
+      s.strip! if strip
+
+      s
     end
 
     # Cleans multiple strings up.

data/lib/meta_tags/version.rb

@@ -2,6 +2,6 @@
 
 module MetaTags
   # Gem version.
-  VERSION = '2.14.0'
+  VERSION = '2.15.0'
   public_constant :VERSION
 end

data/meta-tags.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://github.com/kpumuk/meta-tags"
   spec.license       = "MIT"
   spec.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.|(bin|test|spec|features)/)}) }
   spec.bindir        = "exe"
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "railties", ">= 3.2.0", "< 6.2"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
   spec.add_development_dependency "rspec-html-matchers", "~> 0.9.1"
 
   spec.cert_chain    = ["certs/kpumuk.pem"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meta-tags
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Dmytro Shteflyuk
@@ -29,7 +29,7 @@ cert_chain:
   U97JEQmXCpruLEeSVT2UqR+iJAWEAxPzqzDbTzZBTSPKn+nXeuF6h81e4hsJtkeJ
   HkYAoatF9iZrxT4E
   -----END CERTIFICATE-----
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -91,14 +91,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="