meta-tags 2.17.0 → 2.19.0

data/lib/meta_tags/configuration.rb

@@ -47,25 +47,25 @@ module MetaTags
     def default_property_tags
       [
         # App Link metadata https://developers.facebook.com/docs/applinks/metadata-reference
-        'al',
+        "al",
         # Open Graph Markup https://developers.facebook.com/docs/sharing/webmasters#markup
-        'fb',
-        'og',
+        "fb",
+        "og",
         # Facebook OpenGraph Object Types https://developers.facebook.com/docs/reference/opengraph
         # Note that these tags are used in a regex, so including e.g. 'restaurant' will affect
         # 'restaurant:category', 'restaurant:price_rating', and anything else under that namespace.
-        'article',
-        'book',
-        'books',
-        'business',
-        'fitness',
-        'game',
-        'music',
-        'place',
-        'product',
-        'profile',
-        'restaurant',
-        'video',
+        "article",
+        "book",
+        "books",
+        "business",
+        "fitness",
+        "game",
+        "music",
+        "place",
+        "product",
+        "profile",
+        "restaurant",
+        "video"
       ].freeze
     end
 
@@ -78,7 +78,7 @@ module MetaTags
       @truncate_site_title_first = false
       @description_limit = 300
       @keywords_limit = 255
-      @keywords_separator = ', '
+      @keywords_separator = ", "
       @keywords_lowercase = true
       @property_tags = default_property_tags.dup
       @open_meta_tags = true

data/lib/meta_tags/controller_helper.rb

@@ -15,8 +15,8 @@ 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 defined?(@page_title) && @page_title
-      meta_tags[:keywords]    = @page_keywords    if defined?(@page_keywords) && @page_keywords
+      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
@@ -25,7 +25,7 @@ module MetaTags
     # Set meta tags for the page.
     #
     # See <tt>MetaTags::ViewHelper#set_meta_tags</tt> for details.
-    def set_meta_tags(meta_tags) # rubocop:disable Naming/AccessorMethodName
+    def set_meta_tags(meta_tags)
       self.meta_tags.update(meta_tags)
     end
     protected :set_meta_tags

data/lib/meta_tags/meta_tags_collection.rb

@@ -39,12 +39,12 @@ module MetaTags
     #
     def update(object = {})
       meta_tags = if object.respond_to?(:to_meta_tags)
-                    # @type var object: (_MetaTagish & Object)
-                    object.to_meta_tags
-                  else
-                    # @type var object: Hash[String | Symbol, untyped]
-                    object
-                  end
+        # @type var object: _MetaTagish & Object
+        object.to_meta_tags
+      else
+        # @type var object: Hash[String | Symbol, untyped]
+        object
+      end
       @meta_tags.deep_merge! normalize_open_graph(meta_tags)
     end
 
@@ -70,14 +70,16 @@ module MetaTags
       with_defaults(defaults) { extract_full_title }
     end
 
-    # Constructs the title without site title (for normalized parameters).
+    # Constructs the title without site title (for normalized parameters). When title is empty,
+    # use the site title instead.
     #
     # @return [String] page title.
     #
     def page_title(defaults = {})
       old_site = @meta_tags[:site]
       @meta_tags[:site] = nil
-      with_defaults(defaults) { extract_full_title }
+      full_title = with_defaults(defaults) { extract_full_title }
+      full_title.presence || old_site || ""
     ensure
       @meta_tags[:site] = old_site
     end
@@ -104,10 +106,10 @@ module MetaTags
     # @return [String] page title.
     #
     def extract_full_title
-      site_title = extract(:site) || ''
-      title      = extract_title
-      separator  = extract_separator
-      reverse    = extract(:reverse) == true
+      site_title = extract(:site) || ""
+      title = extract_title
+      separator = extract_separator
+      reverse = extract(:reverse) == true
 
       TextNormalizer.normalize_title(site_title, title, separator, reverse)
     end
@@ -134,15 +136,15 @@ module MetaTags
     def extract_separator
       if meta_tags[:separator] == false
         # Special case: if separator is hidden, do not display suffix/prefix
-        prefix = separator = suffix = ''
+        prefix = separator = suffix = ""
       else
-        prefix    = extract_separator_section(:prefix, ' ')
-        separator = extract_separator_section(:separator, '|')
-        suffix    = extract_separator_section(:suffix, ' ')
+        prefix = extract_separator_section(:prefix, " ")
+        separator = extract_separator_section(:separator, "|")
+        suffix = extract_separator_section(:suffix, " ")
       end
       delete(:separator, :prefix, :suffix)
 
-      TextNormalizer.safe_join([prefix, separator, suffix], '')
+      TextNormalizer.safe_join([prefix, separator, suffix], "")
     end
 
     # Extracts noindex settings as a Hash mapping noindex tag name to value.
@@ -157,12 +159,12 @@ module MetaTags
         [:noindex, :index],
         # follow has higher priority than nofollow
         [:follow, :nofollow],
-        :noarchive,
+        :noarchive
       ].each do |attributes|
         calculate_robots_attributes(result, attributes)
       end
 
-      result.transform_values { |v| v.join(', ') }
+      result.transform_values { |v| v.join(", ") }
     end
 
     protected
@@ -186,7 +188,7 @@ module MetaTags
     # @return [String] separator segment value.
     #
     def extract_separator_section(name, default)
-      meta_tags[name] == false ? '' : (meta_tags[name] || default)
+      (meta_tags[name] == false) ? "" : (meta_tags[name] || default)
     end
 
     # Extracts robots attribute (noindex, nofollow, etc) name and value.
@@ -195,11 +197,11 @@ module MetaTags
     # @return [Array<String>] pair of noindex attribute name and value.
     #
     def extract_robots_attribute(name)
-      noindex       = extract(name)
-      noindex_name  = noindex.kind_of?(String) || noindex.kind_of?(Array) ? noindex : 'robots'
+      noindex = extract(name)
+      noindex_name = (noindex.is_a?(String) || noindex.is_a?(Array)) ? noindex : "robots"
       noindex_value = noindex ? name.to_s : nil
 
-      [ noindex_name, noindex_value ]
+      [noindex_name, noindex_value]
     end
 
     def calculate_robots_attributes(result, attributes)

data/lib/meta_tags/railtie.rb

@@ -2,15 +2,15 @@
 
 module MetaTags
   class Railtie < Rails::Railtie
-    initializer 'meta_tags.setup_action_controller' do
+    initializer "meta_tags.setup_action_controller" do
       ActiveSupport.on_load :action_controller do
-        ActionController::Base.include MetaTags::ControllerHelper
+        include MetaTags::ControllerHelper
       end
     end
 
-    initializer 'meta_tags.setup_action_view' do
+    initializer "meta_tags.setup_action_view" do
       ActiveSupport.on_load :action_view do
-        ActionView::Base.include MetaTags::ViewHelper
+        include MetaTags::ViewHelper
       end
     end
   end

data/lib/meta_tags/renderer.rb

@@ -71,12 +71,12 @@ module MetaTags
       return unless icon
 
       # String? Value is an href
-      icon = [{ href: icon }] if icon.kind_of?(String)
+      icon = [{href: icon}] if icon.is_a?(String)
       # Hash? Single icon instead of a list of icons
-      icon = [icon] if icon.kind_of?(Hash)
+      icon = [icon] if icon.is_a?(Hash)
 
       icon.each do |icon_params|
-        icon_params = { rel: 'icon', type: 'image/x-icon' }.with_indifferent_access.merge(icon_params)
+        icon_params = {rel: "icon", type: "image/x-icon"}.with_indifferent_access.merge(icon_params)
         tags << Tag.new(:link, icon_params)
       end
     end
@@ -109,7 +109,7 @@ module MetaTags
     #
     def render_refresh(tags)
       refresh = meta_tags.extract(:refresh)
-      tags << Tag.new(:meta, 'http-equiv' => 'refresh', content: refresh.to_s) if refresh.present?
+      tags << Tag.new(:meta, "http-equiv" => "refresh", :content => refresh.to_s) if refresh.present?
     end
 
     # Renders alternate link tags.
@@ -120,13 +120,13 @@ module MetaTags
       alternate = meta_tags.extract(:alternate)
       return unless alternate
 
-      if alternate.kind_of?(Hash)
+      if alternate.is_a?(Hash)
         alternate.each do |hreflang, href|
-          tags << Tag.new(:link, rel: 'alternate', href: href, hreflang: hreflang) if href.present?
+          tags << Tag.new(:link, rel: "alternate", href: href, hreflang: hreflang) if href.present?
         end
-      elsif alternate.kind_of?(Array)
+      elsif alternate.is_a?(Array)
         alternate.each do |link_params|
-          tags << Tag.new(:link, { rel: 'alternate' }.with_indifferent_access.merge(link_params))
+          tags << Tag.new(:link, {rel: "alternate"}.with_indifferent_access.merge(link_params))
         end
       end
     end
@@ -143,7 +143,7 @@ module MetaTags
       title = open_search[:title]
 
       type = "application/opensearchdescription+xml"
-      tags << Tag.new(:link, rel: 'search', type: type, href: href, title: title) if href.present?
+      tags << Tag.new(:link, rel: "search", type: type, href: href, title: title) if href.present?
     end
 
     # Renders links.
@@ -151,7 +151,7 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_links(tags)
-      [ :amphtml, :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
@@ -189,7 +189,7 @@ module MetaTags
     #
     def render_hash(tags, key, **opts)
       data = meta_tags.meta_tags[key]
-      return unless data.kind_of?(Hash)
+      return unless data.is_a?(Hash)
 
       process_hash(tags, key, data, **opts)
       meta_tags.extract(key)
@@ -202,7 +202,7 @@ module MetaTags
     def render_custom(tags)
       meta_tags.meta_tags.each do |name, data|
         Array(data).each do |val|
-          tags << Tag.new(:meta, configured_name_key(name) => name, content: val)
+          tags << Tag.new(:meta, configured_name_key(name) => name, :content => val)
         end
         meta_tags.extract(name)
       end
@@ -217,14 +217,14 @@ module MetaTags
     #
     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
+      when Hash
+        :process_hash
+      when Array
+        :process_array
+      else
+        iprop = itemprop
+        :render_tag
+      end
       __send__(method, tags, property, content, itemprop: iprop, **opts)
     end
 
@@ -237,18 +237,18 @@ module MetaTags
     def process_hash(tags, property, content, **opts)
       itemprop = content.delete(:itemprop)
       content.each do |key, value|
-        if key.to_s == '_'
+        if key.to_s == "_"
           iprop = itemprop
           key = property
         else
           key = "#{property}:#{key}"
         end
 
-        normalized_value = if value.kind_of?(Symbol)
-                             normalized_meta_tags[value]
-                           else
-                             value
-                           end
+        normalized_value = if value.is_a?(Symbol)
+          normalized_meta_tags[value]
+        else
+          value
+        end
         process_tree(tags, key, normalized_value, **opts.merge(itemprop: iprop))
       end
     end
@@ -273,7 +273,7 @@ module MetaTags
     #
     def render_tag(tags, name, value, itemprop: nil)
       name_key ||= configured_name_key(name)
-      tags << Tag.new(:meta, name_key => name.to_s, content: value, itemprop: itemprop) 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

@@ -44,7 +44,7 @@ module MetaTags
       # serves the same purpose we could just as it to convert itself to str
       # and continue from there
       description = cleanup_string(description)
-      return '' if description.blank?
+      return "" if description.blank?
 
       truncate(description, MetaTags.config.description_limit)
     end
@@ -56,7 +56,7 @@ module MetaTags
     #
     def normalize_keywords(keywords)
       keywords = cleanup_strings(keywords)
-      return '' if keywords.blank?
+      return "" if keywords.blank?
 
       keywords.each(&:downcase!) if MetaTags.config.keywords_lowercase
       separator = cleanup_string MetaTags.config.keywords_separator, strip: false
@@ -107,12 +107,12 @@ module MetaTags
     # space characters squashed into a single space.
     #
     def cleanup_string(string, strip: true)
-      return '' if string.nil?
-      raise ArgumentError, 'Expected a string or an object that implements #to_str' unless string.respond_to?(:to_str)
+      return "" if string.nil?
+      raise ArgumentError, "Expected a string or an object that implements #to_str" unless string.respond_to?(:to_str)
 
       s = strip_tags(string.to_str)
       s = s.dup if s.frozen?
-      s.gsub!(/\s+/, ' ')
+      s.gsub!(/\s+/, " ")
       s.strip! if strip
 
       s
@@ -137,15 +137,15 @@ module MetaTags
     # @param [String] natural_separator natural separator to truncate at.
     # @return [String] truncated string.
     #
-    def truncate(string, limit = nil, natural_separator = ' ')
-      return string if limit.to_i == 0 # rubocop:disable Lint/NumberConversion
+    def truncate(string, limit = nil, natural_separator = " ")
+      return string if limit.to_i == 0
 
       helpers.truncate(
         string,
-        length:    limit,
+        length: limit,
         separator: natural_separator,
-        omission:  '',
-        escape:    true,
+        omission: "",
+        escape: true
       )
     end
 
@@ -157,7 +157,7 @@ module MetaTags
     # @param [String] natural_separator natural separator to truncate at.
     # @return [Array<String>] truncated array of strings.
     #
-    def truncate_array(string_array, limit = nil, separator = '', natural_separator = ' ')
+    def truncate_array(string_array, limit = nil, separator = "", natural_separator = " ")
       return string_array if limit.nil? || limit <= 0
 
       length = 0
@@ -188,14 +188,14 @@ module MetaTags
     end
 
     def truncate_title(site_title, title, separator)
-      global_limit = MetaTags.config.title_limit.to_i # rubocop:disable Lint/NumberConversion
+      global_limit = MetaTags.config.title_limit.to_i
       if global_limit > 0
         site_title_limited_length, title_limited_length = calculate_title_limits(
-          site_title, title, separator, global_limit,
+          site_title, title, separator, global_limit
         )
 
-        title = title_limited_length > 0 ? truncate_array(title, title_limited_length, separator) : []
-        site_title = site_title_limited_length > 0 ? truncate(site_title, site_title_limited_length) : nil
+        title = (title_limited_length > 0) ? truncate_array(title, title_limited_length, separator) : []
+        site_title = (site_title_limited_length > 0) ? truncate(site_title, site_title_limited_length) : nil
       end
 
       [site_title, title]
@@ -208,13 +208,13 @@ module MetaTags
       main_length = main_title.map(&:length).sum + ((main_title.size - 1) * separator.length)
       main_limited_length = global_limit
 
-      secondary_limited_length = global_limit - (main_length > 0 ? main_length + separator.length : 0)
+      secondary_limited_length = global_limit - ((main_length > 0) ? main_length + separator.length : 0)
       secondary_limited_length = [0, secondary_limited_length].max
 
       if MetaTags.config.truncate_site_title_first
-        [ secondary_limited_length, main_limited_length ]
+        [secondary_limited_length, main_limited_length]
       else
-        [ main_limited_length, secondary_limited_length ]
+        [main_limited_length, secondary_limited_length]
       end
     end
   end

data/lib/meta_tags/version.rb

@@ -2,6 +2,6 @@
 
 module MetaTags
   # Gem version.
-  VERSION = '2.17.0'
+  VERSION = "2.19.0"
   public_constant :VERSION
 end

data/lib/meta_tags/view_helper.rb

@@ -55,7 +55,7 @@ module MetaTags
     #
     # @see #display_meta_tags
     #
-    def title(title = nil, headline = '')
+    def title(title = nil, headline = "")
       set_meta_tags(title: title) unless title.nil?
       headline.presence || meta_tags[:title]
     end
@@ -203,7 +203,7 @@ module MetaTags
     #   <div data-page-container="true" title="<%= display_title title: 'My Page', site: 'PJAX Site' %>">
     #
     def display_title(defaults = {})
-      @meta_tags.full_title(defaults)
+      meta_tags.full_title(defaults)
     end
   end
 end

data/lib/meta_tags.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'active_support/core_ext/hash/indifferent_access'
+require "set"
+require "active_support/core_ext/hash/indifferent_access"
 
 # MetaTags gem namespace.
 module MetaTags
@@ -24,15 +24,15 @@ module MetaTags
   end
 end
 
-require 'meta_tags/version'
+require "meta_tags/version"
 
-require 'meta_tags/configuration'
-require 'meta_tags/controller_helper'
-require 'meta_tags/meta_tags_collection'
-require 'meta_tags/renderer'
-require 'meta_tags/tag'
-require 'meta_tags/content_tag'
-require 'meta_tags/text_normalizer'
-require 'meta_tags/view_helper'
+require "meta_tags/configuration"
+require "meta_tags/controller_helper"
+require "meta_tags/meta_tags_collection"
+require "meta_tags/renderer"
+require "meta_tags/tag"
+require "meta_tags/content_tag"
+require "meta_tags/text_normalizer"
+require "meta_tags/view_helper"
 
-require 'meta_tags/railtie' if defined?(Rails)
+require "meta_tags/railtie" if defined?(Rails)

data/meta-tags.gemspec

@@ -1,43 +1,52 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'meta_tags/version'
+require "meta_tags/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "meta-tags"
-  spec.version       = MetaTags::VERSION
-  spec.authors       = ["Dmytro Shteflyuk"]
-  spec.email         = ["kpumuk@kpumuk.info"]
-
-  spec.summary       = "Collection of SEO helpers for Ruby on Rails."
-  spec.description   = "Search Engine Optimization (SEO) plugin for Ruby on Rails applications."
-  spec.homepage      = "https://github.com/kpumuk/meta-tags"
-  spec.license       = "MIT"
-  spec.platform      = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.6.0'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.|(bin|test|spec|features)/)}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.name = "meta-tags"
+  spec.version = MetaTags::VERSION
+  spec.authors = ["Dmytro Shteflyuk"]
+  spec.email = ["kpumuk@kpumuk.info"]
+
+  spec.summary = "Collection of SEO helpers for Ruby on Rails."
+  spec.description = "Search Engine Optimization (SEO) plugin for Ruby on Rails applications."
+  spec.homepage = "https://github.com/kpumuk/meta-tags"
+  spec.license = "MIT"
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.|(bin|test|spec|features)/)}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "actionpack", ">= 3.2.0", "< 7.1"
+  spec.add_runtime_dependency "actionpack", ">= 3.2.0", "< 7.2"
 
-  spec.add_development_dependency "railties", ">= 3.2.0", "< 7.1"
+  spec.add_development_dependency "railties", ">= 3.2.0", "< 7.2"
   spec.add_development_dependency "rake", "~> 13.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"]
-  spec.signing_key   = File.expand_path("~/.ssh/gem-kpumuk.pem") if $PROGRAM_NAME.end_with?('gem')
+  spec.add_development_dependency "rspec", "~> 3.12.0"
+  spec.add_development_dependency "rspec-html-matchers", "~> 0.10.0"
+  spec.add_development_dependency "appraisal", "~> 2.5.0"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
+  # Code style
+  spec.add_development_dependency "standard", "~> 1.29"
+  spec.add_development_dependency "rubocop-rails", "~> 2.20.2"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.23.0"
+  # Format RSpec output for CircleCI
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.6.0"
+
+  spec.cert_chain = ["certs/kpumuk.pem"]
+  spec.signing_key = File.expand_path("~/.ssh/gem-kpumuk.pem") if $PROGRAM_NAME.end_with?("gem")
 
   spec.metadata = {
-    "bug_tracker_uri"       => "https://github.com/kpumuk/meta-tags/issues/",
-    "changelog_uri"         => "https://github.com/kpumuk/meta-tags/blob/main/CHANGELOG.md",
-    "documentation_uri"     => "https://rubydoc.info/github/kpumuk/meta-tags/",
-    "homepage_uri"          => "https://github.com/kpumuk/meta-tags/",
-    "source_code_uri"       => "https://github.com/kpumuk/meta-tags/",
-    "rubygems_mfa_required" => "true",
+    "bug_tracker_uri" => "https://github.com/kpumuk/meta-tags/issues/",
+    "changelog_uri" => "https://github.com/kpumuk/meta-tags/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://rubydoc.info/github/kpumuk/meta-tags/",
+    "homepage_uri" => "https://github.com/kpumuk/meta-tags/",
+    "source_code_uri" => "https://github.com/kpumuk/meta-tags/",
+    "rubygems_mfa_required" => "true"
   }
 end

data/sig/lib/_internal/rails.rbs

@@ -4,7 +4,9 @@ class ::Hash[unchecked out K, unchecked out V]
 end
 
 class ::Object
-  def presence: () -> String?
+  $OFS: String
+
+  def presence: () -> self?
   def blank?: () -> bool
   def present?: () -> bool
 end

data/sig/lib/meta_tags/controller_helper.rbs

@@ -1,5 +1,6 @@
 module MetaTags
   module ControllerHelper : _ActionControllerBase
+    @meta_tags: MetaTagsCollection?
     @page_title: String?
     @page_description: String?
     @page_keywords: String? | Array[String]

data/sig/lib/meta_tags/view_helper.rbs

@@ -1,5 +1,7 @@
 module MetaTags
   module ViewHelper : Module, _ActionViewBase
+    @meta_tags: MetaTagsCollection?
+
     # type meta_tags = {
     #     site: String?,
     #     title: Array[String] | String?,

data/sig/lib/meta_tags.rbs

@@ -1,4 +1,6 @@
 module MetaTags
+  self.@config: Configuration
+
   def self.config: () -> Configuration
   def self.configure: () { (Configuration) -> void } -> void