meta_tags-rails 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+if ENV['CODECLIMATE_REPO_TOKEN'] && RUBY_VERSION > '1.8.7'
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require 'meta_tags-rails'
+require 'rspec-html-matchers'
+
+RSpec.configure do |config|
+  if config.files_to_run.one?
+    # RSpec filters the backtrace by default so as not to be so noisy.
+    # This causes the full backtrace to be printed when running a single
+    # spec file (e.g. to troubleshoot a particular spec failure).
+    config.full_backtrace = true
+
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.formatter = 'doc' if config.formatters.none?
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.include RSpecHtmlMatchers
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end
+
+shared_examples_for '.set_meta_tags' do
+  it 'should update meta tags' do
+    subject.set_meta_tags(title: 'hello')
+    expect(subject.meta_tags[:title]).to eq('hello')
+
+    subject.set_meta_tags(title: 'world')
+    expect(subject.meta_tags[:title]).to eq('world')
+  end
+
+  it 'should use deep merge when updating meta tags' do
+    subject.set_meta_tags(og: { title: 'hello' })
+    expect(subject.meta_tags[:og]).to eq('title' => 'hello')
+
+    subject.set_meta_tags(og: { description: 'world' })
+    expect(subject.meta_tags[:og]).to eq('title' => 'hello', 'description' => 'world')
+
+    subject.set_meta_tags(og: { admin: { id: 1 } } )
+    expect(subject.meta_tags[:og]).to eq('title' => 'hello', 'description' => 'world', 'admin' => { 'id' => 1 })
+  end
+
+  it 'should normalize :open_graph to :og' do
+    subject.set_meta_tags(open_graph: { title: 'hello' })
+    expect(subject.meta_tags[:og]).to eq('title' => 'hello')
+  end
+end

data/spec/text_normalizer/normalize_title_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe MetaTags::TextNormalizer, '.normalize_title' do
+  context 'when site_title is blank' do
+    it 'should return title when site_title is blank' do
+      expect(subject.normalize_title(nil, 'title', '-')).to eq('title')
+      expect(subject.normalize_title('', 'title', '-')).to eq('title')
+    end
+
+    it 'should join title parts with separator' do
+      expect(subject.normalize_title('', %w[title subtitle], '-')).to eq('title-subtitle')
+    end
+
+    it 'should reverse title parts when reverse is true' do
+      expect(subject.normalize_title('', %w[title subtitle], '-', true)).to eq('subtitle-title')
+    end
+  end
+
+  context 'when site_title is specified' do
+    it 'should join title and site_title with separator' do
+      expect(subject.normalize_title('site', 'title', '-')).to eq('site-title')
+    end
+
+    it 'should join title parts and site_title with separator' do
+      expect(subject.normalize_title('site', %w[title subtitle], '-')).to eq('site-title-subtitle')
+    end
+
+    it 'should reverse title parts when reverse is true' do
+      expect(subject.normalize_title('site', %w[title subtitle], '-', true)).to eq('subtitle-title-site')
+    end
+
+    it 'should not add title when site title is longer than limit' do
+      site_title = 'a' * (MetaTags.config.title_limit - 2)
+      expect(subject.normalize_title(site_title, 'title', '---')).to eq(site_title[0..-2])
+    end
+
+    it 'should truncate title when limit is reached' do
+      site_title = 'a' * 20
+      title = 'b' * (MetaTags.config.title_limit + 10)
+      expect(subject.normalize_title(site_title, title, '-')).to eq("#{site_title}-#{'b' * (MetaTags.config.title_limit - 21)}")
+    end
+  end
+end

data/spec/text_normalizer/truncate_array_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe MetaTags::TextNormalizer, '.truncate_array' do
+  it 'should return array as is when limit is not specified' do
+    arr = %w[a]
+    expect(subject.truncate_array(arr, nil)).to be(arr)
+    expect(subject.truncate_array(arr, 0)).to be(arr)
+  end
+
+  it 'should return a new array when limit is specified' do
+    arr = %w[a]
+    expect(subject.truncate_array(arr, 1)).to_not be(arr)
+  end
+
+  context 'when separator is empty string' do
+    it 'should return the whole array when total size is less than or equal to limit' do
+      arr = %w[a a]
+      expect(subject.truncate_array(arr, 5)).to eq(arr)
+      expect(subject.truncate_array(arr, 2)).to eq(arr)
+    end
+
+    it 'should truncate array to specified limit' do
+      arr = %w[a a a a a]
+      expect(subject.truncate_array(arr, 3)).to eq(%w[a a a])
+    end
+
+    it 'should truncate last word to match the limit' do
+      arr = %w[a a aaaa aa]
+      expect(subject.truncate_array(arr, 4)).to eq(%w[a a aa])
+    end
+
+    it 'should use natural separator when truncating a long word' do
+      arr = ['a', 'aa aaaa', 'aa']
+      expect(subject.truncate_array(arr, 7)).to eq(%w[a aa])
+    end
+  end
+
+  context 'when separator is specified' do
+    it 'should return the whole array when total size is less than or equal to limit' do
+      arr = %w[a a]
+      expect(subject.truncate_array(arr, 5, '-')).to eq(arr)
+      expect(subject.truncate_array(arr, 3, '-')).to eq(arr)
+    end
+
+    it 'should truncate array to specified limit' do
+      arr = %w[a a a a a]
+      expect(subject.truncate_array(arr, 3, '-')).to eq(%w[a a])
+    end
+
+    it 'should truncate last word to match the limit' do
+      arr = %w[a a aaaa aa]
+      expect(subject.truncate_array(arr, 5, '-')).to eq(%w[a a a])
+    end
+
+    it 'should use natural separator when truncating a long word' do
+      arr = ['a', 'aa aaaa', 'aa']
+      expect(subject.truncate_array(arr, 7, '-')).to eq(%w[a aa])
+    end
+  end
+end

data/spec/view_helper/charset_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'displaying charset' do
+  subject { ActionView::Base.new }
+
+  it 'should not display charset if blank' do
+    expect(subject.display_meta_tags).to eq('')
+    expect(subject.display_meta_tags(charset: '')).to eq('')
+  end
+
+  it 'should display charset' do
+    subject.display_meta_tags(charset: 'UTF-8').tap do |meta|
+      expect(meta).to eq('<meta charset="UTF-8" />')
+    end
+  end
+end

data/spec/view_helper/custom_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper do
+  subject { ActionView::Base.new }
+
+  context 'display any named meta tag that you want to' do
+    it 'should display testing meta tag' do
+      subject.display_meta_tags(testing: 'this is a test').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "this is a test", name: "testing" })
+      end
+    end
+
+    it 'should support Array values' do
+      subject.display_meta_tags(testing: ['test1', 'test2']).tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "test1", name: "testing" })
+        expect(meta).to have_tag('meta', with: { content: "test2", name: "testing" })
+      end
+    end
+
+    it 'should support Hash values' do
+      subject.display_meta_tags(testing: { tag: 'value' }).tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "value", name: "testing:tag" })
+      end
+    end
+
+    it 'should support symbolic references in Hash values' do
+      subject.display_meta_tags(title: 'my title', testing: { tag: :title }).tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "my title", name: "testing:tag" })
+      end
+    end
+
+    it 'should not render when value is nil' do
+      subject.display_meta_tags(testing: nil).tap do |meta|
+        expect(meta).to eq('')
+      end
+    end
+
+    it 'should display meta tags with hashes and arrays' do
+      subject.set_meta_tags(foo: {
+        bar: "lorem",
+        baz: {
+          qux: ["lorem", "ipsum"]
+        },
+        quux: [
+          {
+            corge:  "lorem",
+            grault: "ipsum"
+          },
+          {
+            corge:  "dolor",
+            grault: "sit"
+          }
+        ]
+      })
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "lorem", name: "foo:bar" })
+        expect(meta).to have_tag('meta', with: { content: "lorem", name: "foo:baz:qux" })
+        expect(meta).to have_tag('meta', with: { content: "ipsum", name: "foo:baz:qux" })
+        expect(meta).to have_tag('meta', with: { content: "lorem", name: "foo:quux:corge" })
+        expect(meta).to have_tag('meta', with: { content: "ipsum", name: "foo:quux:grault" })
+        expect(meta).to have_tag('meta', with: { content: "dolor", name: "foo:quux:corge" })
+        expect(meta).to have_tag('meta', with: { content: "sit", name: "foo:quux:grault" })
+        expect(meta).to_not have_tag('meta', with: { name: "foo:quux" })
+      end
+    end
+  end
+end

data/spec/view_helper/description_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'displaying description' do
+  subject { ActionView::Base.new }
+
+  it 'should not display description if blank' do
+    subject.description('')
+    expect(subject.display_meta_tags).to eq('')
+  end
+
+  it 'should display description when "description" used' do
+    subject.description('someDescription')
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "someDescription", name: "description" })
+    end
+  end
+
+  it 'should display description when "set_meta_tags" used' do
+    subject.set_meta_tags(description: 'someDescription')
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "someDescription", name: "description" })
+    end
+  end
+
+  it 'should display default description' do
+    subject.display_meta_tags(site: 'someSite', description: 'someDescription').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "someDescription", name: "description" })
+    end
+  end
+
+  it 'should use custom description if given' do
+    subject.description('someDescription')
+    subject.display_meta_tags(site: 'someSite', description: 'defaultDescription').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "someDescription", name: "description" })
+    end
+  end
+
+  it 'should strip multiple spaces' do
+    subject.display_meta_tags(site: 'someSite', description: "some \n\r\t description").tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some description", name: "description" })
+    end
+  end
+
+  it 'should strip HTML' do
+    subject.display_meta_tags(site: 'someSite', description: "<p>some <b>description</b></p>").tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some description", name: "description" })
+    end
+  end
+
+  it 'should change escape double quotes' do
+    subject.display_meta_tags(site: 'someSite', description: 'some "description"').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some \"description\"", name: "description" })
+    end
+  end
+
+  it 'should truncate correctly' do
+    subject.display_meta_tags(site: 'someSite', description: "Lorem ipsum dolor sit amet, consectetuer sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.").tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "Lorem ipsum dolor sit amet, consectetuer sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At", name: "description" })
+    end
+  end
+end

data/spec/view_helper/icon_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper do
+  subject { ActionView::Base.new }
+
+  it 'should not display icon by default' do
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to_not have_tag('link', with: { rel: 'icon' })
+    end
+  end
+
+  it 'should display icon when "set_meta_tags" used' do
+    subject.set_meta_tags(icon: '/favicon.ico')
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('link', with: { href: '/favicon.ico', rel: 'icon', type: 'image/x-icon' })
+    end
+  end
+
+  it 'should display default canonical url' do
+    subject.display_meta_tags(site: 'someSite', icon: '/favicon.ico').tap do |meta|
+      expect(meta).to have_tag('link', with: { href: '/favicon.ico', rel: 'icon', type: 'image/x-icon' })
+    end
+  end
+
+  it 'should allow to specify hash as an icon' do
+    subject.set_meta_tags(icon: { href: '/favicon.png', type: 'image/png' })
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('link', with: { href: '/favicon.png', rel: 'icon', type: 'image/png' })
+    end
+  end
+
+  it 'should allow to specify multiple icons' do
+    subject.set_meta_tags(icon: [
+      { href: '/images/icons/icon_96.png', sizes: '32x32 96x96', type: 'image/png' },
+      { href: '/images/icons/icon_itouch_precomp_32.png', rel: 'apple-touch-icon-precomposed', sizes: '32x32', type: 'image/png' },
+    ])
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('link', with: { href: '/images/icons/icon_96.png', rel: 'icon', type: 'image/png', sizes: '32x32 96x96' })
+      expect(meta).to have_tag('link', with: { href: '/images/icons/icon_itouch_precomp_32.png', rel: 'apple-touch-icon-precomposed', type: 'image/png', sizes: '32x32' })
+    end
+  end
+end

data/spec/view_helper/keywords_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'displaying keywords' do
+  subject { ActionView::Base.new }
+
+  it 'should not display keywords if blank' do
+    subject.keywords('')
+    expect(subject.display_meta_tags).to eq('')
+
+    subject.keywords([])
+    expect(subject.display_meta_tags).to eq('')
+  end
+
+  it 'should display keywords when "keywords" used' do
+    subject.keywords('some-keywords')
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some-keywords", name: "keywords" })
+    end
+  end
+
+  it 'should display keywords when "set_meta_tags" used' do
+    subject.set_meta_tags(keywords: 'some-keywords')
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some-keywords", name: "keywords" })
+    end
+  end
+
+  it 'should display default keywords' do
+    subject.display_meta_tags(site: 'someSite', keywords: 'some-keywords').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some-keywords", name: "keywords" })
+    end
+  end
+
+  it 'should use custom keywords if given' do
+    subject.keywords('some-keywords')
+    subject.display_meta_tags(site: 'someSite', keywords: 'default_keywords').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "some-keywords", name: "keywords" })
+    end
+  end
+
+  it 'should lowercase keywords' do
+    subject.display_meta_tags(site: 'someSite', keywords: 'someKeywords').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "somekeywords", name: "keywords" })
+    end
+  end
+
+  it 'should join keywords from Array' do
+    subject.display_meta_tags(site: 'someSite', keywords: %w(keyword1 keyword2)).tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "keyword1, keyword2", name: "keywords" })
+    end
+  end
+
+  it 'should join keywords from nested Arrays' do
+    subject.display_meta_tags(site: 'someSite', keywords: [%w(keyword1 keyword2), 'keyword3']).tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "keyword1, keyword2, keyword3", name: "keywords" })
+    end
+  end
+end

data/spec/view_helper/links_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper do
+  subject { ActionView::Base.new }
+
+  context 'displaying canonical url' do
+    it 'should not display canonical url by default' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('link', with: { href: "http://example.com/base/url", rel: "canonical" })
+      end
+    end
+
+    it 'should display canonical url when "set_meta_tags" used' do
+      subject.set_meta_tags(canonical: 'http://example.com/base/url')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.com/base/url", rel: "canonical" })
+      end
+    end
+
+    it 'should display default canonical url' do
+      subject.display_meta_tags(site: 'someSite', canonical: 'http://example.com/base/url').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.com/base/url", rel: "canonical" })
+      end
+    end
+  end
+
+  context 'displaying alternate url' do
+    it 'should not display alternate url by default' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('link', with: { href: "http://example.fr/base/url", hreflang: "fr", rel: "alternate" })
+      end
+    end
+
+    it 'should display alternate url when "set_meta_tags" used' do
+      subject.set_meta_tags(alternate: { 'fr' => 'http://example.fr/base/url' })
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.fr/base/url", hreflang: "fr", rel: "alternate" })
+      end
+    end
+
+    it 'should display default alternate url' do
+      subject.display_meta_tags(site: 'someSite', alternate: { 'fr' => 'http://example.fr/base/url' }).tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.fr/base/url", hreflang: "fr", rel: "alternate" })
+      end
+    end
+
+    it "should not display alternate without content" do
+      subject.display_meta_tags(site: 'someSite', alternate: {'zh-Hant' => ''}).tap do |meta|
+        expect(meta).to_not have_tag('link', with: { href: "", hreflang: "zh-Hant", rel: "alternate" })
+      end
+    end
+
+    it 'should allow to specify an array of alternate links' do
+      subject.display_meta_tags(site: 'someSite', alternate: [
+        { href: 'http://example.fr/base/url', hreflang: 'fr' },
+        { href: 'http://example.com/feed.rss', type: 'application/rss+xml', title: 'RSS' },
+        { href: 'http://m.example.com/page-1', media: 'only screen and (max-width: 640px)'},
+      ]).tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.fr/base/url", hreflang: "fr", rel: "alternate" })
+        expect(meta).to have_tag('link', with: { href: "http://example.com/feed.rss", type: "application/rss+xml", title: 'RSS', rel: "alternate" })
+        expect(meta).to have_tag('link', with: { href: "http://m.example.com/page-1", media: 'only screen and (max-width: 640px)', rel: "alternate" })
+      end
+    end
+  end
+
+  context 'displaying author link' do
+    it 'should display author link when "set_meta_tags" used' do
+      subject.set_meta_tags(author: 'http://plus.google.com/profile/url')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://plus.google.com/profile/url", rel: "author" })
+      end
+    end
+  end
+
+  context 'displaying publisher link' do
+    it 'should display publisher link when "set_meta_tags" used' do
+      subject.set_meta_tags(publisher: 'http://plus.google.com/myprofile_url')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://plus.google.com/myprofile_url", rel: "publisher" })
+      end
+    end
+  end
+
+  context 'displaying prev url' do
+    it 'should not display prev url by default' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('link', with: { href: "http://example.com/base/url", rel: "prev" })
+      end
+    end
+
+    it 'should display prev url when "set_meta_tags" used' do
+      subject.set_meta_tags(prev: 'http://example.com/base/url')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.com/base/url", rel: "prev" })
+      end
+    end
+
+    it 'should display default prev url' do
+      subject.display_meta_tags(site: 'someSite', prev: 'http://example.com/base/url').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.com/base/url", rel: "prev" })
+      end
+    end
+  end
+
+  context 'displaying next url' do
+    it 'should not display next url by default' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('link', with: { href: "http://example.com/base/url", rel: "next" })
+      end
+    end
+
+    it 'should display next url when "set_meta_tags" used' do
+      subject.set_meta_tags(next: 'http://example.com/base/url')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.com/base/url", rel: "next" })
+      end
+    end
+
+    it 'should display default next url' do
+      subject.display_meta_tags(site: 'someSite', next: 'http://example.com/base/url').tap do |meta|
+        expect(meta).to have_tag('link', with: { href: "http://example.com/base/url", rel: "next" })
+      end
+    end
+  end
+end