meta-tags 2.4.1 → 2.5.0

data/lib/meta_tags.rb

@@ -1,3 +1,4 @@
+require 'English'
 require 'action_controller'
 require 'action_view'
 

data/lib/meta_tags/configuration.rb

@@ -9,13 +9,57 @@ module MetaTags
     attr_accessor :keywords_limit
     # Keywords separator - a string to join keywords with.
     attr_accessor :keywords_separator
+    # Custom meta tags that should use `property` attribute instead of `name`
+    # - an array of strings or symbols representing their names or name-prefixes.
+    attr_accessor :property_tags
 
     # Initializes a new instance of Configuration class.
     def initialize
+      reset_defaults!
+    end
+
+    def default_property_tags
+      [
+        # App Link metadata https://developers.facebook.com/docs/applinks/metadata-reference
+        'al',
+        # Open Graph Markup https://developers.facebook.com/docs/sharing/webmasters#markup
+        'fb',
+        'og',
+        # Facebook OpenGraph Object Types https://developers.facebook.com/docs/reference/opengraph
+        'article',
+        'book',
+        'books:author',
+        'books:book',
+        'books:genre',
+        'business:business',
+        'fitness:course',
+        'game:achievement',
+        'music:album',
+        'music:playlist',
+        'music:radio_station',
+        'music:song',
+        'place',
+        'product',
+        'product:group',
+        'product:item',
+        'profile',
+        'restaurant:menu',
+        'restaurant:menu_item',
+        'restaurant:menu_section',
+        'restaurant:restaurant',
+        'video:episode',
+        'video:movie',
+        'video:other',
+        'video:tv_show',
+      ].freeze
+    end
+
+    def reset_defaults!
       @title_limit = 70
       @description_limit = 160
       @keywords_limit = 255
       @keywords_separator = ', '
+      @property_tags = default_property_tags.dup
     end
   end
 end

data/lib/meta_tags/meta_tags_collection.rb

@@ -57,7 +57,7 @@ module MetaTags
     # @return [String] page title.
     #
     def full_title(defaults = {})
-      with_defaults(defaults) { extract_full_title  }
+      with_defaults(defaults) { extract_full_title }
     end
 
     # Deletes and returns a meta tag value by name.
@@ -85,7 +85,7 @@ module MetaTags
       site_title = extract(:site) || ''
       title      = extract_title || []
       separator  = extract_separator
-      reverse    = extract(:reverse) === true
+      reverse    = extract(:reverse) == true
 
       TextNormalizer.normalize_title(site_title, title, separator, reverse)
     end
@@ -99,7 +99,7 @@ module MetaTags
       return unless title
 
       title = Array(title)
-      title.each(&:downcase!) if extract(:lowercase) === true
+      title.each(&:downcase!) if extract(:lowercase) == true
       title
     end
 
@@ -108,7 +108,7 @@ module MetaTags
     # @return [String] page title separator.
     #
     def extract_separator
-      if meta_tags[:separator] === false
+      if meta_tags[:separator] == false
         # Special case: if separator is hidden, do not display suffix/prefix
         prefix = separator = suffix = ''
       else
@@ -147,7 +147,7 @@ module MetaTags
     # @return [HashWithIndifferentAccess] normalized meta tags list.
     #
     def normalize_open_graph(meta_tags)
-      meta_tags = meta_tags.is_a?(HashWithIndifferentAccess) ? meta_tags.dup : meta_tags.with_indifferent_access
+      meta_tags = meta_tags.kind_of?(HashWithIndifferentAccess) ? meta_tags.dup : meta_tags.with_indifferent_access
       meta_tags[:og] = meta_tags.delete(:open_graph) if meta_tags.key?(:open_graph)
       meta_tags
     end
@@ -160,7 +160,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 noindex attribute name and value without deleting it from meta tags list.
@@ -170,7 +170,7 @@ module MetaTags
     #
     def extract_noindex_attribute(name)
       noindex       = extract(name)
-      noindex_name  = String === noindex ? noindex : 'robots'
+      noindex_name  = noindex.kind_of?(String) ? noindex : 'robots'
       noindex_value = noindex ? name.to_s : nil
 
       [ noindex_name, noindex_value ]

data/lib/meta_tags/renderer.rb

@@ -29,11 +29,6 @@ module MetaTags
       render_open_search(tags)
       render_links(tags)
 
-      render_hash(tags, :og, name_key: :property)
-      render_hash(tags, :al, name_key: :property)
-      render_hash(tags, :fb, name_key: :property)
-      render_hash(tags, :article, name_key: :property)
-      render_hash(tags, :place, name_key: :property)
       render_hashes(tags)
       render_custom(tags)
 
@@ -42,15 +37,13 @@ module MetaTags
 
     protected
 
-
     # Renders charset tag.
     #
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_charset(tags)
-      if charset = meta_tags.extract(:charset)
-        tags << Tag.new(:meta, charset: charset) if charset.present?
-      end
+      charset = meta_tags.extract(:charset)
+      tags << Tag.new(:meta, charset: charset) if charset.present?
     end
 
     # Renders title tag.
@@ -68,15 +61,16 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_icon(tags)
-      if icon = meta_tags.extract(:icon)
-        if String === icon
-          tags << Tag.new(:link, rel: 'icon', href: icon, type: 'image/x-icon')
-        else
-          icon = [icon] if Hash === icon
-          icon.each do |icon_params|
-            icon_params = { rel: 'icon', type: 'image/x-icon' }.with_indifferent_access.merge(icon_params)
-            tags << Tag.new(:link, icon_params)
-          end
+      icon = meta_tags.extract(:icon)
+      return unless icon
+
+      if icon.kind_of?(String)
+        tags << Tag.new(:link, rel: 'icon', href: icon, type: 'image/x-icon')
+      else
+        icon = [icon] if icon.kind_of?(Hash)
+        icon.each do |icon_params|
+          icon_params = { rel: 'icon', type: 'image/x-icon' }.with_indifferent_access.merge(icon_params)
+          tags << Tag.new(:link, icon_params)
         end
       end
     end
@@ -108,9 +102,8 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_refresh(tags)
-      if refresh = meta_tags.extract(:refresh)
-        tags << Tag.new(:meta, 'http-equiv' => 'refresh', content: refresh.to_s) if refresh.present?
-      end
+      refresh = meta_tags.extract(:refresh)
+      tags << Tag.new(:meta, 'http-equiv' => 'refresh', content: refresh.to_s) if refresh.present?
     end
 
     # Renders alternate link tags.
@@ -118,15 +111,16 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_alternate(tags)
-      if alternate = meta_tags.extract(:alternate)
-        if Hash === alternate
-          alternate.each do |hreflang, href|
-            tags << Tag.new(:link, rel: 'alternate', href: href, hreflang: hreflang) if href.present?
-          end
-        elsif Array === alternate
-          alternate.each do |link_params|
-            tags << Tag.new(:link, { rel: 'alternate' }.with_indifferent_access.merge(link_params))
-          end
+      alternate = meta_tags.extract(:alternate)
+      return unless alternate
+
+      if alternate.kind_of?(Hash)
+        alternate.each do |hreflang, href|
+          tags << Tag.new(:link, rel: 'alternate', href: href, hreflang: hreflang) if href.present?
+        end
+      elsif alternate.kind_of?(Array)
+        alternate.each do |link_params|
+          tags << Tag.new(:link, { rel: 'alternate' }.with_indifferent_access.merge(link_params))
         end
       end
     end
@@ -136,14 +130,14 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_open_search(tags)
-      if open_search = meta_tags.extract(:open_search)
-        href = open_search[:href]
-        title = open_search[:title]
-        if href.present?
-          type = "application/opensearchdescription+xml"
-          tags << Tag.new(:link, rel: 'search', type: type, href: href, title: title)
-        end
-      end
+      open_search = meta_tags.extract(:open_search)
+      return unless open_search
+
+      href = open_search[:href]
+      title = open_search[:title]
+
+      type = "application/opensearchdescription+xml"
+      tags << Tag.new(:link, rel: 'search', type: type, href: href, title: title) if href.present?
     end
 
     # Renders links.
@@ -165,11 +159,8 @@ module MetaTags
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
     def render_hashes(tags, options = {})
-      meta_tags.meta_tags.each do |property, data|
-        if data.is_a?(Hash)
-          process_hash(tags, property, data, options)
-          meta_tags.extract(property)
-        end
+      meta_tags.meta_tags.keys.each do |property|
+        render_hash(tags, property, options)
       end
     end
 
@@ -179,10 +170,10 @@ module MetaTags
     #
     def render_hash(tags, key, options = {})
       data = meta_tags.meta_tags[key]
-      if data.is_a?(Hash)
-        process_hash(tags, key, data, options)
-        meta_tags.extract(key)
-      end
+      return unless data.kind_of?(Hash)
+
+      process_hash(tags, key, data, options)
+      meta_tags.extract(key)
     end
 
     # Renders custom meta tags.
@@ -192,7 +183,7 @@ module MetaTags
     def render_custom(tags)
       meta_tags.meta_tags.each do |name, data|
         Array(data).each do |val|
-          tags << Tag.new(:meta, name: name, content: val)
+          tags << Tag.new(:meta, configured_name_key(name) => name, content: val)
         end
         meta_tags.extract(name)
       end
@@ -226,7 +217,7 @@ module MetaTags
     def process_hash(tags, property, content, options = {})
       content.each do |key, value|
         key = key.to_s == '_' ? property : "#{property}:#{key}"
-        value = normalized_meta_tags[value] if value.is_a?(Symbol)
+        value = normalized_meta_tags[value] if value.kind_of?(Symbol)
         process_tree(tags, key, value, options)
       end
     end
@@ -249,9 +240,22 @@ module MetaTags
     # top-level meta tag.
     #
     def render_tag(tags, name, value, options = {})
-      name_key = options.fetch(:name_key, :name)
+      name_key = options.fetch(:name_key, configured_name_key(name))
       value_key = options.fetch(:value_key, :content)
       tags << Tag.new(:meta, name_key => name.to_s, value_key => value) unless value.blank?
     end
+
+    # Returns meta tag property name for a give meta tag based on the
+    # configured list of property tags in MetaTags::Configuration#property_tags.
+    #
+    # @param [String, Symbol] meta tag key.
+    # @return [String] meta tag attribute name ("property" or "name").
+    #
+    def configured_name_key(name)
+      is_property_tag = MetaTags.config.property_tags.any? do |tag_name|
+        name.to_s.match(/^#{Regexp.escape(tag_name.to_s)}\b/)
+      end
+      is_property_tag ? :property : :name
+    end
   end
 end

data/lib/meta_tags/text_normalizer.rb

@@ -10,18 +10,12 @@ module MetaTags
     # @return [Array<String>] array of title parts with tags removed.
     #
     def self.normalize_title(site_title, title, separator, reverse = false)
-      title = Array(title).flatten.map(&method(:strip_tags))
-      title.reject!(&:blank?)
+      title = Array(title).flatten.map(&method(:strip_tags)).reject(&:blank?)
       site_title = strip_tags(site_title)
       separator = strip_tags(separator)
 
       if MetaTags.config.title_limit
-        limit = if site_title.present?
-          MetaTags.config.title_limit - separator.length
-        else
-          # separtor won't be used: ignore its length
-          MetaTags.config.title_limit
-        end
+        limit = calculate_limit(site_title, separator)
 
         if limit > site_title.length
           title = truncate_array(title, limit - site_title.length, separator)
@@ -95,7 +89,7 @@ module MetaTags
     # @param [String] sep separator to join strings with.
     # @return [String] input strings joined together using a given separator.
     #
-    def self.safe_join(array, sep = $,)
+    def self.safe_join(array, sep = $OFS)
       helpers.safe_join(array, sep)
     end
 
@@ -140,21 +134,37 @@ module MetaTags
     # @return [String] truncated string.
     #
     def self.truncate_array(string_array, limit = nil, separator = '', natural_separator = ' ')
-      return string_array if limit.nil? || limit == 0
+      return string_array if limit.nil? || limit.zero?
+
       length = 0
       result = []
+
       string_array.each do |string|
-        limit_left = limit - length - (result.any? ? separator.length : 0)
+        limit_left = calculate_limit_left(limit, length, result, separator)
+
         if string.length > limit_left
           result << truncate(string, limit_left, natural_separator)
           break
         end
+
         length += (result.any? ? separator.length : 0) + string.length
         result << string
+
         # No more strings will fit
         break if length + separator.length >= limit
       end
+
       result
     end
+
+    def self.calculate_limit_left(limit, length, result, separator)
+      limit - length - (result.any? ? separator.length : 0)
+    end
+
+    def self.calculate_limit(site_title, separator)
+      return MetaTags.config.title_limit unless site_title.present?
+
+      MetaTags.config.title_limit - separator.length
+    end
   end
 end

data/lib/meta_tags/version.rb

@@ -1,4 +1,4 @@
 module MetaTags
   # Gem version.
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

data/meta-tags.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-html-matchers", "~> 0.8.0"
 
   spec.cert_chain    = ["certs/kpumuk.pem"]
-  spec.signing_key   = File.expand_path("~/.ssh/gem-kpumuk.pem") if $0 =~ /gem\z/
+  spec.signing_key   = File.expand_path("~/.ssh/gem-kpumuk.pem") if $PROGRAM_NAME =~ /gem\z/
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meta-tags
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Dmytro Shteflyuk
@@ -30,7 +30,7 @@ cert_chain:
   He5T3dBG5WWdIclQcE+JgohBpQ78TcVs1pFNjFmW9pC/P7Rm2GlYqOPHBQG1/Qx9
   ySbbrGHRLVz8DCxQbhKw+mdT5bg=
   -----END CERTIFICATE-----
-date: 2017-05-15 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack