meta_tags-rails 1.0.0

data/lib/meta_tags-rails/tag.rb

@@ -0,0 +1,25 @@
+module MetaTags
+  # Represents an HTML meta tag with no content (<tag />).
+  class Tag
+    attr_reader :name, :attributes
+
+    # Initializes a new instance of Tag class.
+    #
+    # @param [String, Symbol] name HTML tag name
+    # @param [Hash] attributes list of HTML tag attributes
+    #
+    def initialize(name, attributes = {})
+      @name = name
+      @attributes = attributes
+    end
+
+    # Render tag into a Rails view.
+    #
+    # @param [ActionView::Base] view instance of a Rails view.
+    # @return [String] HTML string for the tag.
+    #
+    def render(view)
+      view.tag(name, attributes)
+    end
+  end
+end

data/lib/meta_tags-rails/text_normalizer.rb

@@ -0,0 +1,148 @@
+module MetaTags
+  # Module contains helpers that normalize text meta tag values.
+  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(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.
+    #
+    # @param [String] description description string.
+    # @return [String] text with tags removed, squashed spaces, truncated
+    # to 200 characters.
+    #
+    def self.normalize_description(description)
+      return '' if description.blank?
+      description = cleanup_string(description)
+      truncate(description, MetaTags.config.description_limit)
+    end
+
+    # Normalize keywords value.
+    #
+    # @param [String, Array<String>] keywords list of keywords as a string or Array.
+    # @return [String] list of keywords joined with comma, with tags removed.
+    #
+    def self.normalize_keywords(keywords)
+      return '' if keywords.blank?
+      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.
+    #
+    # @return [ActionView::Base] proxy object to access Rails helpers.
+    #
+    def self.helpers
+      ActionController::Base.helpers
+    end
+
+    # Strips all HTML tags from the +html+, including comments.
+    #
+    # @param [String] string HTML string.
+    # @return [String] string with no HTML tags.
+    #
+    def self.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>
+    # would return. All items in the array, including the supplied separator, are
+    # html escaped unless they are html safe, and the returned string is marked
+    # as html safe.
+    #
+    # @param [Array<String>] array list of strings to join.
+    # @param [String] sep separator to join strings with.
+    # @return [String] input strings joined together using a given separator.
+    #
+    def self.safe_join(array, sep = $,)
+      helpers.safe_join(array, sep)
+    end
+
+    # Removes HTML tags and squashes down all the spaces.
+    #
+    # @param [String] string input string.
+    # @return [String] input string with no HTML tags and consequent white
+    # space characters squashed into a single space.
+    #
+    def self.cleanup_string(string)
+      strip_tags(string).gsub(/\s+/, ' ').strip.html_safe
+    end
+
+    # Cleans multiple strings up.
+    #
+    # @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

data/lib/meta_tags-rails/version.rb

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

data/lib/meta_tags-rails/view_helper.rb

@@ -0,0 +1,205 @@
+module MetaTags
+  # Contains methods to use in views and helpers.
+  #
+  module ViewHelper
+    # Get meta tags for the page.
+    def meta_tags
+      @meta_tags ||= MetaTagsCollection.new
+    end
+
+    # Set meta tags for the page.
+    #
+    # Method could be used several times, and all options passed will
+    # be merged. If you will set the same property several times, last one
+    # will take precedence.
+    #
+    # Usually you will not call this method directly. Use {#title}, {#keywords},
+    # {#description} for your daily tasks.
+    #
+    # @param [Hash] meta_tags list of meta tags. See {#display_meta_tags}
+    #   for allowed options.
+    #
+    # @example
+    #   set_meta_tags title: 'Login Page', description: 'Here you can login'
+    #   set_meta_tags keywords: 'authorization, login'
+    #
+    # @see #display_meta_tags
+    #
+    def set_meta_tags(meta_tags = {})
+      self.meta_tags.update(meta_tags)
+    end
+
+    # Set the page title and return it back.
+    #
+    # This method is best suited for use in helpers. It sets the page title
+    # and returns it (or +headline+ if specified).
+    #
+    # @param [nil, String, Array] title page title. When passed as an
+    #   +Array+, parts will be joined using configured separator value
+    #   (see {#display_meta_tags}). When nil, current title will be returned.
+    # @param [String] headline the value to return from method. Useful
+    #   for using this method in views to set both page title
+    #   and the content of heading tag.
+    # @return [String] returns +title+ value or +headline+ if passed.
+    #
+    # @example Set HTML title to "Please login", return "Please login"
+    #   title 'Login Page'
+    # @example Set HTML title to "Login Page", return "Please login"
+    #   title 'Login Page', 'Please login'
+    # @example Set title as array of strings
+    #   title title: ['part1', 'part2'] # => "part1 | part2"
+    # @example Get current title
+    #   title
+    #
+    # @see #display_meta_tags
+    #
+    def title(title = nil, headline = '')
+      set_meta_tags(title: title) unless title.nil?
+      headline.blank? ? meta_tags[:title] : headline
+    end
+
+    # Set the page keywords.
+    #
+    # @param [String, Array] keywords meta keywords to render in HEAD
+    #   section of the HTML document.
+    # @return [String, Array] passed value.
+    #
+    # @example
+    #   keywords 'keyword1, keyword2'
+    #   keywords %w(keyword1 keyword2)
+    #
+    # @see #display_meta_tags
+    #
+    def keywords(keywords)
+      set_meta_tags(keywords: keywords)
+      keywords
+    end
+
+    # Set the page description.
+    #
+    # @param [String] description page description to be set in HEAD section of
+    #   the HTML document. Please note, any HTML tags will be stripped
+    #   from output string, and string will be truncated to 200
+    #   characters.
+    # @return [String] passed value.
+    #
+    # @example
+    #   description 'This is login page'
+    #
+    # @see #display_meta_tags
+    #
+    def description(description)
+      set_meta_tags(description: description)
+      description
+    end
+
+    # Set the noindex meta tag
+    #
+    # @param [Boolean, String] noindex a noindex value.
+    # @return [Boolean, String] passed value.
+    #
+    # @example
+    #   noindex true
+    #   noindex 'googlebot'
+    #
+    # @see #display_meta_tags
+    #
+    def noindex(noindex = true)
+      set_meta_tags(noindex: noindex)
+      noindex
+    end
+
+    # Set the nofollow meta tag
+    #
+    # @param [Boolean, String] nofollow a nofollow value.
+    # @return [Boolean, String] passed value.
+    #
+    # @example
+    #   nofollow true
+    #   nofollow 'googlebot'
+    #
+    # @see #display_meta_tags
+    #
+    def nofollow(nofollow = true)
+      set_meta_tags(nofollow: nofollow)
+      nofollow
+    end
+
+    # Set the refresh meta tag
+    #
+    # @param [Integer, String] refresh a refresh value.
+    # @return [Integer, String] passed value.
+    #
+    # @example
+    #   refresh 5
+    #   refresh "5;url=http://www.example.com/"
+    #
+    # @see #display_meta_tags
+    #
+    def refresh(refresh)
+      set_meta_tags(refresh: refresh)
+      refresh
+    end
+
+    # Set default meta tag values and display meta tags. This method
+    # should be used in layout file.
+    #
+    # @param [Hash] defaults default meta tag values.
+    # @option default [String] :site (nil) site title;
+    # @option default [String] :title ("") page title;
+    # @option default [String] :description (nil) page description;
+    # @option default [String] :keywords (nil) page keywords;
+    # @option default [String, Boolean] :prefix (" ") text between site name and separator; when +false+, no prefix will be rendered;
+    # @option default [String] :separator ("|") text used to separate website name from page title;
+    # @option default [String, Boolean] :suffix (" ") text between separator and page title; when +false+, no suffix will be rendered;
+    # @option default [Boolean] :lowercase (false) when true, the page title will be lowercase;
+    # @option default [Boolean] :reverse (false) when true, the page and site names will be reversed;
+    # @option default [Boolean, String] :noindex (false) add noindex meta tag; when true, 'robots' will be used, otherwise the string will be used;
+    # @option default [Boolean, String] :nofollow (false) add nofollow meta tag; when true, 'robots' will be used, otherwise the string will be used;
+    # @option default [String] :canonical (nil) add canonical link tag.
+    # @option default [Hash] :alternate ({}) add alternate link tag.
+    # @option default [String] :prev (nil) add prev link tag;
+    # @option default [String] :next (nil) add next link tag.
+    # @option default [String] :author (nil) add author link tag;
+    # @option default [String] :publisher (nil) add publisher link tag.
+    # @option default [String, Integer] :refresh (nil) meta refresh tag;
+    # @option default [Hash] :open_graph ({}) add Open Graph meta tags.
+    # @option default [Hash] :open_search ({}) add Open Search link tag.
+    # @return [String] HTML meta tags to render in HEAD section of the
+    #   HTML document.
+    #
+    # @example
+    #   <head>
+    #     <%= display_meta_tags site: 'My website' %>
+    #   </head>
+    #
+    def display_meta_tags(defaults = {})
+      self.meta_tags.with_defaults(defaults) { Renderer.new(meta_tags).render(self) }
+    end
+
+    # Returns full page title as a string without surrounding <title> tag.
+    #
+    # The only case when you may need this helper is when you use pjax. This means
+    # that your layout file (with display_meta_tags helper) will not be rendered,
+    # so you have to pass default arguments like site title in here. You probably
+    # want to define helper with default options to minimize code duplication.
+    #
+    # @param [Hash] defaults list of meta tags.
+    # @option default [String] :site (nil) site title;
+    # @option default [String] :title ("") page title;
+    # @option default [String, Boolean] :prefix (" ") text between site name and separator; when +false+, no prefix will be rendered;
+    # @option default [String] :separator ("|") text used to separate website name from page title;
+    # @option default [String, Boolean] :suffix (" ") text between separator and page title; when +false+, no suffix will be rendered;
+    # @option default [Boolean] :lowercase (false) when true, the page name will be lowercase;
+    # @option default [Boolean] :reverse (false) when true, the page and site names will be reversed;
+    #
+    # @example
+    #   <div data-page-container="true" title="<%= display_title title: 'My Page', site: 'PJAX Site' %>">
+    #
+    def display_title(defaults = {})
+      @meta_tags.full_title(defaults)
+    end
+
+    # safe_helper :display_meta_tags if defined?(:safe_helper)
+  end
+end

data/meta-tags.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'meta_tags-rails/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'meta_tags-rails'
+  s.version     = MetaTags::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "MIT"
+  s.authors     = ['Dmytro Shteflyuk', 'Yves Siegrist']
+  s.email       = ['Elektron1c97@gmail.com']
+  s.homepage    = 'http://github.com/Elektron1c97/meta_tags-rails'
+  s.summary     = %q{Collection of SEO helpers for Ruby on Rails.}
+  s.description = %q{Search Engine Optimization (SEO) plugin for Ruby on Rails applications.}
+
+  s.add_dependency 'actionpack', '>= 3.0.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.3.0'
+  s.add_development_dependency 'rspec-html-matchers'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bluecloth'
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = ['README.md', 'CHANGELOG.md']
+  s.rdoc_options     = ['--charset=UTF-8']
+  s.require_paths    = ['lib']
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe MetaTags::Configuration do
+  it 'should be returned by MetaTags.config' do
+    expect(MetaTags.config).to be_instance_of(MetaTags::Configuration)
+  end
+
+  it 'should be yielded by MetaTags.configure' do
+    MetaTags.configure do |c|
+      expect(c).to be_instance_of(MetaTags::Configuration)
+      expect(c).to be(MetaTags.config)
+    end
+  end
+end

data/spec/controller_helper_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class MetaTagsController < ActionController::Base
+  attr_reader :rendered
+
+  def render_without_meta_tags
+    @rendered = true
+  end
+
+  def index
+    @page_title       = 'title'
+    @page_keywords    = 'key1, key2, key3'
+    @page_description = 'description'
+    render
+  end
+
+  public :set_meta_tags, :meta_tags
+end
+
+describe MetaTags::ControllerHelper do
+  subject { MetaTagsController.new }
+
+  context 'module' do
+    it 'should be mixed into ActionController::Base' do
+      expect(ActionController::Base.included_modules).to include(MetaTags::ControllerHelper)
+    end
+
+    it 'should respond to "set_meta_tags" helper' do
+      expect(subject).to respond_to(:set_meta_tags)
+    end
+  end
+
+  describe '.render' do
+    it 'should set meta tags from instance variables' do
+      subject.index
+      expect(subject.rendered).to be_truthy
+      expect(subject.meta_tags.meta_tags).to eq('title' => 'title', 'keywords' => 'key1, key2, key3', 'description' => 'description')
+    end
+  end
+
+  it_behaves_like '.set_meta_tags'
+end