meta-tags 2.0.0 → 2.1.0

data/Rakefile

@@ -4,8 +4,8 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
+task test: :spec
+task default: :spec
 
 desc 'Starts irb with MetaTags gem loaded'
 task :console do

data/lib/meta_tags.rb

@@ -3,10 +3,28 @@ require 'action_view'
 
 # MetaTags gem namespace.
 module MetaTags
+  # Returns MetaTags gem configuration.
+  #
+  def self.config
+    @@config ||= Configuration.new
+  end
+
+  # Configures MetaTags gem.
+  #
+  # @yield [Configuration] configuration object.
+  # @example
+  #
+  #   MetaTags.configure do |config|
+  #     # config.title_limit = 100
+  #   end
+  def self.configure
+    yield config
+  end
 end
 
 require 'meta_tags/version'
 
+require 'meta_tags/configuration'
 require 'meta_tags/controller_helper'
 require 'meta_tags/meta_tags_collection'
 require 'meta_tags/renderer'

data/lib/meta_tags/configuration.rb

@@ -0,0 +1,21 @@
+module MetaTags
+  # MetaTags configuration.
+  class Configuration
+    # How many characters to truncate title to.
+    attr_accessor :title_limit
+    # How many characters to truncate description to.
+    attr_accessor :description_limit
+    # How many characters to truncate keywords to.
+    attr_accessor :keywords_limit
+    # Keywords separator - a string to join keywords with.
+    attr_accessor :keywords_separator
+
+    # Initializes a new instance of Configuration class.
+    def initialize
+      @title_limit = 70
+      @description_limit = 160
+      @keywords_limit = 255
+      @keywords_separator = ', '
+    end
+  end
+end

data/lib/meta_tags/meta_tags_collection.rb

@@ -82,17 +82,12 @@ module MetaTags
     # @return [String] page title.
     #
     def extract_full_title
-      title = extract_title || []
-      separator = extract_separator
+      site_title = extract(:site) || ''
+      title      = extract_title || []
+      separator  = extract_separator
+      reverse    = extract(:reverse) === true
 
-      site_title = extract(:site).presence
-      title.unshift(site_title) if site_title
-      title = TextNormalizer.normalize_title(title)
-
-      title.reverse! if extract(:reverse) === true
-      title = TextNormalizer.safe_join(title, separator)
-
-      title
+      TextNormalizer.normalize_title(site_title, title, separator, reverse)
     end
 
     # Extracts page title as an array of segments without site title and separators.

data/lib/meta_tags/renderer.rb

@@ -18,15 +18,18 @@ module MetaTags
     def render(view)
       tags = []
 
+      render_charset(tags)
       render_title(tags)
-      render_description(tags)
-      render_keywords(tags)
+      render_icon(tags)
+      render_with_normalization(tags, :description)
+      render_with_normalization(tags, :keywords)
       render_refresh(tags)
       render_noindex(tags)
       render_alternate(tags)
+      render_open_search(tags)
       render_links(tags)
 
-      render_hash(tags, :twitter, :name_key => :name)
+      render_hash(tags, :og, name_key: :property)
       render_hashes(tags)
       render_custom(tags)
 
@@ -35,6 +38,17 @@ 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
+    end
+
     # Renders title tag.
     #
     # @param [Array<Tag>] tags a buffer object to store tag in.
@@ -42,27 +56,37 @@ module MetaTags
     def render_title(tags)
       title = meta_tags.extract_full_title
       normalized_meta_tags[:title] = title
-      tags << ContentTag.new(:title, :content => title) if title.present?
+      tags << ContentTag.new(:title, content: title) if title.present?
     end
 
-    # Renders description meta tag.
+    # Renders icon(s) tag.
     #
     # @param [Array<Tag>] tags a buffer object to store tag in.
     #
-    def render_description(tags)
-      description = TextNormalizer.normalize_description(meta_tags.extract(:description))
-      normalized_meta_tags[:description] = description
-      tags << Tag.new(:meta, :name => :description, :content => description) if description.present?
+    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
+        end
+      end
     end
 
-    # Renders keywords meta tag.
+    # Renders meta tag with normalization (should have a corresponding normalize_
+    # method in TextNormalizer).
     #
     # @param [Array<Tag>] tags a buffer object to store tag in.
+    # @see TextNormalizer
     #
-    def render_keywords(tags)
-      keywords = TextNormalizer.normalize_keywords(meta_tags.extract(:keywords))
-      normalized_meta_tags[:keywords] = keywords
-      tags << Tag.new(:meta, :name => :keywords, :content => keywords) if keywords.present?
+    def render_with_normalization(tags, name)
+      value = TextNormalizer.public_send("normalize_#{name}", meta_tags.extract(name))
+      normalized_meta_tags[name] = value
+      tags << Tag.new(:meta, name: name, content: value) if value.present?
     end
 
     # Renders noindex and nofollow meta tags.
@@ -71,7 +95,7 @@ module MetaTags
     #
     def render_noindex(tags)
       meta_tags.extract_noindex.each do |name, content|
-        tags << Tag.new(:meta, :name => name, :content => content) if content.present?
+        tags << Tag.new(:meta, name: name, content: content) if content.present?
       end
     end
 
@@ -81,7 +105,7 @@ module MetaTags
     #
     def render_refresh(tags)
       if 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
     end
 
@@ -91,8 +115,29 @@ module MetaTags
     #
     def render_alternate(tags)
       if alternate = meta_tags.extract(:alternate)
-        alternate.each do |hreflang, href|
-          tags << Tag.new(:link, :rel => 'alternate', :href => href, :hreflang => hreflang) if href.present?
+        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
+        end
+      end
+    end
+
+    # Renders open_search link tag.
+    #
+    # @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
     end
@@ -106,7 +151,7 @@ module MetaTags
         href = meta_tags.extract(tag_name)
         if href.present?
           @normalized_meta_tags[tag_name] = href
-          tags << Tag.new(:link, :rel => tag_name, :href => href)
+          tags << Tag.new(:link, rel: tag_name, href: href)
         end
       end
     end
@@ -118,7 +163,7 @@ module MetaTags
     def render_hashes(tags, options = {})
       meta_tags.meta_tags.each do |property, data|
         if data.is_a?(Hash)
-          process_tree(tags, property, data)
+          process_hash(tags, property, data, options)
           meta_tags.extract(property)
         end
       end
@@ -131,7 +176,7 @@ module MetaTags
     def render_hash(tags, key, options = {})
       data = meta_tags.meta_tags[key]
       if data.is_a?(Hash)
-        process_tree(tags, key, data, options)
+        process_hash(tags, key, data, options)
         meta_tags.extract(key)
       end
     end
@@ -143,7 +188,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, name: name, content: val)
         end
         meta_tags.extract(name)
       end
@@ -152,25 +197,57 @@ module MetaTags
     # Recursive method to process all the hashes and arrays on meta tags
     #
     # @param [Array<Tag>] tags a buffer object to store tag in.
-    # @param [Hash, String] property a Hash or a String to render as meta tag.
-    # @param [String, Symbol] content text content or a symbol reference to
+    # @param [String, Symbol] property a Hash or a String to render as meta tag.
+    # @param [Hash, Array, String, Symbol] content text content or a symbol reference to
     # top-level meta tag.
     #
     def process_tree(tags, property, content, options = {})
-      content = [content] if content.is_a?(Hash)
-      Array(content).each do |c|
-        if c.is_a?(Hash)
-          c.each do |key, value|
-            key = key.to_s == '_' ? property : "#{property}:#{key}"
-            value = normalized_meta_tags[value] if value.is_a?(Symbol)
-            process_tree(tags, key, value, options)
-          end
-        else
-          name_key = options.fetch(:name_key, :property)
-          value_key = options.fetch(:value_key, :content)
-          tags << Tag.new(:meta, name_key => property.to_s, value_key => c) unless c.blank?
-        end
+      method = case content
+      when Hash
+        :process_hash
+      when Array
+        :process_array
+      else
+        :render_tag
+      end
+      send(method, tags, property, content, options)
+    end
+
+    # Recursive method to process a hash with meta tags
+    #
+    # @param [Array<Tag>] tags a buffer object to store tag in.
+    # @param [String, Symbol] property a Hash or a String to render as meta tag.
+    # @param [Hash] content nested meta tag attributes.
+    #
+    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)
+        process_tree(tags, key, value, options)
       end
     end
+
+    # Recursive method to process a hash with meta tags
+    #
+    # @param [Array<Tag>] tags a buffer object to store tag in.
+    # @param [String, Symbol] property a Hash or a String to render as meta tag.
+    # @param [Array] content array of nested meta tag attributes or values.
+    #
+    def process_array(tags, property, content, options = {})
+      content.each { |v| process_tree(tags, property, v, options) }
+    end
+
+    # Recursive method to process a hash with meta tags
+    #
+    # @param [Array<Tag>] tags a buffer object to store tag in.
+    # @param [String, Symbol] name a Hash or a String to render as meta tag.
+    # @param [String, Symbol] value text content or a symbol reference to
+    # top-level meta tag.
+    #
+    def render_tag(tags, name, value, options = {})
+      name_key = options.fetch(: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
   end
 end

data/lib/meta_tags/text_normalizer.rb

@@ -3,11 +3,32 @@ module MetaTags
   module TextNormalizer
     # Normalize title value.
     #
+    # @param [String] site_title site title.
     # @param [String, 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.
     #
-    def self.normalize_title(title)
-      Array(title).flatten.map(&method(:strip_tags))
+    def self.normalize_title(site_title, title, separator, reverse = false)
+      title = Array(title).flatten.map(&method(:strip_tags))
+      title.reject!(&:blank?)
+      site_title = strip_tags(site_title)
+      separator = strip_tags(separator)
+
+      if MetaTags.config.title_limit
+        limit = MetaTags.config.title_limit - separator.length
+        if limit > site_title.length
+          title = truncate_array(title, limit - site_title.length, separator)
+        else
+          site_title = truncate(site_title, limit)
+          # Site title is too long, we have to skip page title
+          title = []
+        end
+      end
+
+      title.unshift(site_title) if site_title.present?
+      title.reverse! if reverse
+      safe_join(title, separator)
     end
 
     # Normalize description value.
@@ -18,7 +39,8 @@ module MetaTags
     #
     def self.normalize_description(description)
       return '' if description.blank?
-      helpers.truncate(cleanup_string(description), :length => 200)
+      description = cleanup_string(description)
+      truncate(description, MetaTags.config.description_limit)
     end
 
     # Normalize keywords value.
@@ -28,7 +50,11 @@ module MetaTags
     #
     def self.normalize_keywords(keywords)
       return '' if keywords.blank?
-      cleanup_strings(keywords).join(', ').downcase
+      keywords = cleanup_strings(keywords).each(&:downcase!)
+      separator = strip_tags MetaTags.config.keywords_separator
+
+      keywords = truncate_array(keywords, MetaTags.config.keywords_limit, separator)
+      safe_join(keywords, separator)
     end
 
     # Easy way to get access to Rails helpers.
@@ -45,7 +71,7 @@ module MetaTags
     # @return [String] string with no HTML tags.
     #
     def self.strip_tags(string)
-      helpers.strip_tags(string)
+      ERB::Util.html_escape helpers.strip_tags(string)
     end
 
     # This method returns a html safe string similar to what <tt>Array#join</tt>
@@ -68,7 +94,7 @@ module MetaTags
     # space characters squashed into a single space.
     #
     def self.cleanup_string(string)
-      strip_tags(string).gsub(/\s+/, ' ').strip
+      strip_tags(string).gsub(/\s+/, ' ').strip.html_safe
     end
 
     # Cleans multiple strings up.
@@ -76,8 +102,47 @@ module MetaTags
     # @param [Array<String>] strings input strings.
     # @return [Array<String>] clean strings.
     # @see cleanup_string
+    #
     def self.cleanup_strings(strings)
       Array(strings).flatten.map(&method(:cleanup_string))
     end
+
+    # Truncates a string to a specific limit.
+    #
+    # @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 self.truncate(string, limit = nil, natural_separator = ' ')
+      string = helpers.truncate(string, length: limit, separator: natural_separator, omission: '') if limit
+      string
+    end
+
+    # Truncates a string 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.
+    #
+    def self.truncate_array(string_array, limit = nil, separator = '', natural_separator = ' ')
+      return string_array if limit.nil? || limit == 0
+      length = 0
+      result = []
+      string_array.each do |string|
+        limit_left = limit - length - (result.any? ? separator.length : 0)
+        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
   end
 end