meta-tags 2.14.0 → 2.22.1

data/lib/meta_tags/text_normalizer.rb

@@ -8,29 +8,29 @@ module MetaTags
     # Normalize title value.
     #
     # @param [String] site_title site title.
-    # @param [String, Array<String>] title title string.
+    # @param [Array<String>] title title string.
     # @param [String] separator a string to join title parts with.
     # @param [true,false] reverse whether title should be reversed.
-    # @return [Array<String>] array of title parts with tags removed.
+    # @return [String] title with HTML tags removed.
     #
     def normalize_title(site_title, title, separator, reverse = false)
-      title = cleanup_strings(title)
-      title.reverse! if reverse
+      clean_title = cleanup_strings(title)
+      clean_title.reverse! if reverse
 
       site_title = cleanup_string(site_title)
       separator = cleanup_string(separator, strip: false)
 
       # Truncate title and site title
-      site_title, title = truncate_title(site_title, title, separator)
+      site_title, clean_title = truncate_title(site_title, clean_title, separator)
 
       if site_title.present?
         if reverse
-          title.push(site_title)
+          clean_title.push(site_title)
         else
-          title.unshift(site_title)
+          clean_title.unshift(site_title)
         end
       end
-      safe_join(title, separator)
+      safe_join(clean_title, separator)
     end
 
     # Normalize description value.
@@ -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
@@ -102,23 +102,25 @@ module MetaTags
 
     # Removes HTML tags and squashes down all the spaces.
     #
-    # @param [String] string input string.
+    # @param [String, nil] string input string.
     # @return [String] input string with no HTML tags and consequent white
     # 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)
 
-      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.
     #
-    # @param [Array<String>] strings input strings.
+    # @param [String, Array<String>] strings input string(s).
     # @return [Array<String>] clean strings.
     # @see cleanup_string
     #
@@ -132,30 +134,28 @@ module MetaTags
     #
     # @param [String] string input strings.
     # @param [Integer,nil] limit characters number to truncate to.
-    # @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)
+      return string if limit.to_i == 0
 
       helpers.truncate(
         string,
-        length:    limit,
-        separator: natural_separator,
-        omission:  '',
-        escape:    true,
+        length: limit,
+        separator: MetaTags.config.truncate_on_natural_separator,
+        omission: "",
+        escape: true
       )
     end
 
-    # Truncates a string to a specific limit.
+    # Truncates an array of strings to a specific limit.
     #
     # @param [Array<String>] string_array input strings.
     # @param [Integer,nil] limit characters number to truncate to.
     # @param [String] separator separator that will be used to join array later.
-    # @param [String] natural_separator natural separator to truncate at.
-    # @return [String] truncated string.
+    # @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 = "")
       return string_array if limit.nil? || limit <= 0
 
       length = 0
@@ -165,15 +165,15 @@ module MetaTags
         limit_left = calculate_limit_left(limit, length, result, separator)
 
         if string.length > limit_left
-          result << truncate(string, limit_left, natural_separator)
-          break
+          result << truncate(string, limit_left)
+          break string_array
         end
 
         length += (result.any? ? separator.length : 0) + string.length
         result << string
 
         # No more strings will fit
-        break if length + separator.length >= limit
+        break string_array if length + separator.length >= limit
       end
 
       result
@@ -186,30 +186,33 @@ module MetaTags
     end
 
     def truncate_title(site_title, title, separator)
-      if MetaTags.config.title_limit.to_i > 0 # rubocop:disable Lint/NumberConversion
-        site_title_limited_length, title_limited_length = calculate_title_limits(site_title, title, separator)
-
-        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
+      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
+        )
+
+        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]
     end
 
-    def calculate_title_limits(site_title, title, separator)
+    def calculate_title_limits(site_title, title, separator, global_limit)
       # What should we truncate first: site title or page title?
       main_title = MetaTags.config.truncate_site_title_first ? title : [site_title]
 
-      main_length = main_title.map(&:length).sum + (main_title.size - 1) * separator.length
-      main_limited_length = MetaTags.config.title_limit
+      main_length = main_title.map(&:length).sum + ((main_title.size - 1) * separator.length)
+      main_limited_length = global_limit
 
-      secondary_limited_length = MetaTags.config.title_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.14.0'
+  VERSION = "2.22.1"
   public_constant :VERSION
 end

data/lib/meta_tags/view_helper.rb

@@ -27,7 +27,7 @@ module MetaTags
     #
     # @see #display_meta_tags
     #
-    def set_meta_tags(meta_tags = {}) # rubocop:disable Naming/AccessorMethodName
+    def set_meta_tags(meta_tags = {})
       self.meta_tags.update(meta_tags)
     end
 
@@ -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
@@ -97,8 +97,8 @@ module MetaTags
 
     # Set the noindex meta tag
     #
-    # @param [Boolean, String] noindex a noindex value.
-    # @return [Boolean, String] passed value.
+    # @param [Boolean, String, Array<String>] noindex a noindex value.
+    # @return [Boolean, String, Array<String>] passed value.
     #
     # @example
     #   noindex true
@@ -113,8 +113,8 @@ module MetaTags
 
     # Set the nofollow meta tag
     #
-    # @param [Boolean, String] nofollow a nofollow value.
-    # @return [Boolean, String] passed value.
+    # @param [Boolean, String, Array<String>] nofollow a nofollow value.
+    # @return [Boolean, String, Array<String>] passed value.
     #
     # @example
     #   nofollow true
@@ -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,5 +1,8 @@
 # frozen_string_literal: true
 
+require "set"
+require "active_support/core_ext/hash/indifferent_access"
+
 # MetaTags gem namespace.
 module MetaTags
   # Returns MetaTags gem configuration.
@@ -21,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.rb' if defined?(Rails)
+require "meta_tags/railtie" if defined?(Rails)

data/sig/lib/_internal/rails.rbs

@@ -0,0 +1,59 @@
+class ::Hash[unchecked out K, unchecked out V]
+  def with_indifferent_access: () -> ActiveSupport::HashWithIndifferentAccess[K, V]
+  def deep_merge!: (instance | ActiveSupport::HashWithIndifferentAccess[K, V] other) -> self
+  def with_defaults: (instance | ActiveSupport::HashWithIndifferentAccess[K, V] other) -> self
+end
+
+class ::Object
+  $OFS: String
+
+  def presence: () -> self?
+  def blank?: () -> bool
+  def present?: () -> bool
+end
+
+class ::Loofah
+  module TextBehavior
+    def text: (?Hash[Symbol, untyped]? options) -> String
+  end
+
+  class DocumentFragment
+    include TextBehavior
+  end
+
+  def self.fragment: (String tags, ?String? encoding) -> DocumentFragment
+end
+
+class ::Rails
+end
+
+module ActionController
+  class Base
+    include _ActionControllerBase
+
+    def self.helpers: () -> _ActionViewBase
+  end
+end
+
+module ActiveSupport
+  class HashWithIndifferentAccess[unchecked out K, unchecked out V] < Hash[K, V]
+    def with_indifferent_access: () -> self
+    def deep_merge!: (instance | Hash[K, V] other) -> self
+  end
+end
+
+interface _ActionControllerBase
+  def render: (*untyped args) { () -> untyped } -> untyped
+end
+
+interface _ActionViewBase
+  def tag: (String name, ?Hash[String | Symbol, untyped] options, ?bool open) -> void
+
+  def content_tag: (String name, String content, ?Hash[String | Symbol, untyped] options, ?bool open) -> void
+
+  def safe_join: (Array[String], String) -> String
+
+  def truncate: (String text, ?Hash[Symbol, untyped] options) -> String
+
+  def strip_tags: (String html) -> String
+end

data/sig/lib/meta_tags/configuration.rbs

@@ -0,0 +1,26 @@
+module MetaTags
+  class Configuration
+    type html_tag_key = String | Symbol
+    type html_tag_value = Hash[html_tag_key, html_tag_value] | html_tag_content
+    type html_tag_content = String? | Symbol | (_Stringish & Object)
+
+
+    attr_accessor title_limit: Integer?
+    attr_accessor truncate_site_title_first: bool
+    attr_accessor truncate_on_natural_separator: String?|Regexp
+    attr_accessor title_tag_attributes: Hash[html_tag_key, html_tag_value]?
+    attr_accessor description_limit: Integer
+    attr_accessor keywords_limit: Integer
+    attr_accessor keywords_separator: String
+    attr_accessor keywords_lowercase: bool
+    attr_accessor open_meta_tags: bool
+    attr_accessor minify_output: bool
+    attr_reader property_tags: Array[String | Symbol]
+    attr_accessor skip_canonical_links_on_noindex: bool
+
+    def initialize: () -> void
+    def default_property_tags: () -> Array[String | Symbol]
+    def open_meta_tags?: () -> bool
+    def reset_defaults!: () -> void
+  end
+end

data/sig/lib/meta_tags/content_tag.rbs

@@ -0,0 +1,5 @@
+module MetaTags
+  class ContentTag < Tag
+    def render: (_ActionViewBase view) -> untyped
+  end
+end

data/sig/lib/meta_tags/controller_helper.rbs

@@ -0,0 +1,14 @@
+module MetaTags
+  module ControllerHelper : _ActionControllerBase
+    @meta_tags: MetaTagsCollection?
+    @page_title: String?
+    @page_description: String?
+    @page_keywords: String? | Array[String]
+
+    def render: (*untyped args) { () -> untyped } -> untyped
+
+    def set_meta_tags: (ViewHelper::meta_tags | (_MetaTagish & Object) meta_tags) -> void
+
+    def meta_tags: () -> MetaTagsCollection
+  end
+end

data/sig/lib/meta_tags/meta_tags_collection.rbs

@@ -0,0 +1,41 @@
+module MetaTags
+  class MetaTagsCollection
+    attr_reader meta_tags: Hash[String | Symbol, untyped]
+
+    def initialize: () -> void
+
+    def []: (String | Symbol name) -> untyped
+
+    def []=: (String | Symbol name, untyped value) -> untyped
+
+    def update: (?::Hash[String | Symbol, untyped] | (_MetaTagish & Object) object) -> Hash[String | Symbol, untyped]
+
+    def with_defaults: (?::Hash[String | Symbol, untyped] defaults) { () -> untyped } -> untyped
+
+    def full_title: (?::Hash[String | Symbol, untyped] defaults) -> String
+
+    def page_title: (?::Hash[String | Symbol, untyped] defaults) -> String
+
+    def extract: (String | Symbol name) -> untyped
+
+    def delete: (*String | Symbol names) -> void
+
+    def extract_full_title: () -> String
+
+    def extract_title: () -> Array[String | (_Stringish & Object)]
+
+    def extract_separator: () -> String
+
+    def extract_robots: () -> Hash[String, String]
+
+    def normalize_open_graph: (Hash[String | Symbol, untyped] meta_tags) -> ActiveSupport::HashWithIndifferentAccess[String | Symbol, untyped]
+
+    def extract_separator_section: (String | Symbol name, String default) -> String
+
+    def extract_robots_attribute: (String | Symbol name) -> [String | Array[String | Symbol], String?]
+
+    def calculate_robots_attributes: (untyped result, untyped attributes) -> untyped
+
+    def apply_robots_value: (untyped result, untyped name, untyped value, untyped processed) -> (nil | untyped)
+  end
+end

data/sig/lib/meta_tags/renderer.rbs

@@ -0,0 +1,50 @@
+module MetaTags
+  class Renderer
+    type meta_key = String | Symbol
+    type meta_value = Hash[meta_key, meta_value] | Array[meta_value] | meta_content
+    type meta_content = String? | Symbol | Integer | bool | (_Timish & Object) | (_Stringish & Object)
+
+    attr_reader meta_tags: MetaTagsCollection
+    attr_reader normalized_meta_tags: Hash[Symbol, meta_value]
+
+    def initialize: (MetaTagsCollection meta_tags) -> void
+
+    def render: (_ActionViewBase view) -> String
+
+    def render_charset: (Array[Tag] tags) -> void
+
+    def render_title: (Array[Tag] tags) -> void
+
+    def render_icon: (Array[Tag] tags) -> void
+
+    def render_with_normalization: (Array[Tag] tags, Symbol name) -> void
+
+    def render_noindex: (Array[Tag] tags) -> void
+
+    def render_refresh: (Array[Tag] tags) -> void
+
+    def render_alternate: (Array[Tag] tags) -> void
+
+    def render_open_search: (Array[Tag] tags) -> void
+
+    def render_links: (Array[Tag] tags) -> void
+
+    def render_canonical_link: (Array[Tag] tags) -> void
+
+    def render_hashes: (Array[Tag] tags, **untyped opts) -> void
+
+    def render_hash: (Array[Tag] tags, untyped key, **untyped opts) -> void
+
+    def render_custom: (Array[Tag] tags) -> void
+
+    def process_tree: (Array[Tag] tags, meta_key property, meta_value content, ?itemprop: meta_key? itemprop, **untyped opts) -> void
+
+    def process_hash: (Array[Tag] tags, meta_key property, Hash[meta_key, meta_value] content, **untyped opts) -> void
+
+    def process_array: (Array[Tag] tags, meta_key property, Array[meta_value] content, **untyped opts) -> void
+
+    def render_tag: (Array[Tag] tags, meta_key name, meta_content value, ?itemprop: meta_key? itemprop) -> void
+
+    def configured_name_key: (meta_key name) -> Symbol
+  end
+end

data/sig/lib/meta_tags/tag.rbs

@@ -0,0 +1,12 @@
+module MetaTags
+  class Tag
+    attr_reader name: String
+    attr_reader attributes: Hash[String | Symbol, untyped]
+
+    def initialize: (String | Symbol name, ?Hash[String | Symbol, untyped] attributes) -> void
+
+    def render: (_ActionViewBase view) -> void
+
+    def prepare_attributes: (Hash[String | Symbol, untyped] attributes) -> Hash[String | Symbol, untyped]
+  end
+end

data/sig/lib/meta_tags/text_normalizer.rbs

@@ -0,0 +1,36 @@
+module MetaTags
+  module TextNormalizer
+    extend ::MetaTags::TextNormalizer
+
+    type keyword = String? | (_Stringish & Object)
+    type keywords = keyword | Array[keywords]
+
+    def normalize_title: (String? site_title, keywords title, String separator, ?bool reverse) -> String
+
+    def normalize_description: (keyword description) -> String
+
+    def normalize_keywords: (keywords keywords) -> String
+
+    def helpers: () -> _ActionViewBase
+
+    def strip_tags: (String string) -> String
+
+    def safe_join: (Array[String] array, ?String sep) -> String
+
+    def cleanup_string: (keyword string, ?strip: bool strip) -> String
+
+    def cleanup_strings: (keywords? strings, ?strip: bool strip) -> Array[String]
+
+    def truncate: (String string, ?Integer? limit) -> String
+
+    def truncate_array: (Array[String] string_array, ?Integer? limit, ?String separator) -> Array[String]
+
+    private
+
+    def calculate_limit_left: (Integer limit, Integer length, Array[String] result, String separator) -> untyped
+
+    def truncate_title: (String site_title, Array[String] title, String separator) -> ::Array[untyped]
+
+    def calculate_title_limits: (String site_title, Array[String] title, String separator, Integer global_limit) -> untyped
+  end
+end

data/sig/lib/meta_tags/version.rbs

@@ -0,0 +1,4 @@
+module MetaTags
+  # Gem version.
+  VERSION: ::String
+end

data/sig/lib/meta_tags/view_helper.rbs

@@ -0,0 +1,57 @@
+module MetaTags
+  module ViewHelper : Module, _ActionViewBase
+    @meta_tags: MetaTagsCollection?
+
+    # type meta_tags = {
+    #     site: String?,
+    #     title: Array[String] | String?,
+    #     description: String?,
+    #     keywords: Array[String] | String?,
+    #     charset: String,
+    #     prefix: String,
+    #     separator: String,
+    #     suffix: String,
+    #     lowercase: bool,
+    #     reverse: bool,
+    #     noindex: bool | String | Array[String],
+    #     index: bool | String | Array[String],
+    #     nofollow: bool | String | Array[String],
+    #     follow: bool | String | Array[String],
+    #     noarchive: bool | String | Array[String],
+    #     canonical: String,
+    #     prev: String,
+    #     next: String,
+    #     image_src: String,
+    #     alternate: String,
+    #     amphtml: String,
+    #     manifest: String,
+    #     og: Hash[Renderer::meta_key, Renderer::meta_value],
+    #     twitter: Hash[Renderer::meta_key, Renderer::meta_value],
+    #     open_search: Hash[Renderer::meta_key, Renderer::meta_value],
+    #     article: Hash[Renderer::meta_key, Renderer::meta_value],
+    #     al: Hash[Renderer::meta_key, Renderer::meta_value],
+    #     refresh: Integer | String | nil,
+    #   } & Hash[Renderer::meta_key, Renderer::meta_value]
+    type meta_tags = Hash[Renderer::meta_key, Renderer::meta_value]
+
+    def meta_tags: () -> MetaTagsCollection
+
+    def set_meta_tags: (?meta_tags | (_MetaTagish&Object) meta_tags) -> void
+
+    def title: (?String? title, ?::String? headline) -> String
+
+    def keywords: (Array[String] | String? keywords) -> (Array[String] | String?)
+
+    def description: (String? description) -> String?
+
+    def noindex: (?String | Array[String] | bool noindex) -> (String | bool | Array[String])
+
+    def nofollow: (?String | Array[String] | bool nofollow) -> (String | bool | Array[String])
+
+    def refresh: (String? | Integer? refresh) -> (String? | Integer?)
+
+    def display_meta_tags: (?meta_tags defaults) -> String
+
+    def display_title: (?meta_tags defaults) -> String
+  end
+end

data/sig/lib/meta_tags.rbs

@@ -0,0 +1,18 @@
+module MetaTags
+  self.@config: Configuration
+
+  def self.config: () -> Configuration
+  def self.configure: () { (Configuration) -> void } -> void
+
+  interface _Stringish
+    def to_str: () -> String
+  end
+
+  interface _Timish
+    def iso8601: () -> String
+  end
+
+  interface _MetaTagish
+    def to_meta_tags: () -> Hash[String | Symbol, untyped]
+  end
+end