meta_tags-rails 1.0.0

data/spec/view_helper/module_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'module' do
+  subject { ActionView::Base.new }
+
+  it 'should be mixed into ActionView::Base' do
+    expect(ActionView::Base.included_modules).to include(MetaTags::ViewHelper)
+  end
+
+  it 'should respond to "title" helper' do
+    expect(subject).to respond_to(:title)
+  end
+
+  it 'should respond to "description" helper' do
+    expect(subject).to respond_to(:description)
+  end
+
+  it 'should respond to "keywords" helper' do
+    expect(subject).to respond_to(:keywords)
+  end
+
+  it 'should respond to "noindex" helper' do
+    expect(subject).to respond_to(:noindex)
+  end
+
+  it 'should respond to "nofollow" helper' do
+    expect(subject).to respond_to(:nofollow)
+  end
+
+  it 'should respond to "set_meta_tags" helper' do
+    expect(subject).to respond_to(:set_meta_tags)
+  end
+
+  it 'should respond to "display_meta_tags" helper' do
+    expect(subject).to respond_to(:display_meta_tags)
+  end
+
+  it 'should respond to "display_title" helper' do
+    expect(subject).to respond_to(:display_title)
+  end
+end

data/spec/view_helper/noindex_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper do
+  subject { ActionView::Base.new }
+
+  context 'displaying noindex' do
+    it 'should display noindex when "noindex" used' do
+      subject.noindex(true)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex", name: "robots" })
+      end
+    end
+
+    it 'should display noindex when "set_meta_tags" used' do
+      subject.set_meta_tags(noindex: true)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex", name: "robots" })
+      end
+    end
+
+    it 'should use custom noindex if given' do
+      subject.noindex('some-noindex')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex", name: "some-noindex" })
+      end
+    end
+
+    it 'should display nothing by default' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('meta', with: { content: "noindex" })
+      end
+    end
+
+    it "should display nothing if given false" do
+      subject.set_meta_tags(noindex: false)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('meta', with: { content: "robots" })
+      end
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('meta', with: { content: "noindex" })
+      end
+    end
+  end
+
+  context 'displaying nofollow' do
+    it 'should display nofollow when "nofollow" used' do
+      subject.nofollow(true)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "nofollow", name: "robots" })
+      end
+    end
+
+    it 'should display nofollow when "set_meta_tags" used' do
+      subject.set_meta_tags(nofollow: true)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "nofollow", name: "robots" })
+      end
+    end
+
+    it 'should use custom nofollow if given' do
+      subject.nofollow('some-nofollow')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "nofollow", name: "some-nofollow" })
+      end
+    end
+
+    it 'should display nothing by default' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to_not have_tag('meta', with: { content: "nofollow" })
+      end
+    end
+  end
+
+  context 'displaying both nofollow and noindex' do
+    it 'should be displayed when set using helpers' do
+      subject.noindex(true)
+      subject.nofollow(true)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex, nofollow", name: "robots" })
+      end
+    end
+
+    it 'should be displayed when "set_meta_tags" used' do
+      subject.set_meta_tags(nofollow: true, noindex: true)
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex, nofollow", name: "robots" })
+      end
+    end
+
+    it 'should use custom name if string is used' do
+      subject.noindex('some-name')
+      subject.nofollow('some-name')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex, nofollow", name: "some-name" })
+      end
+    end
+
+    it 'should display two meta tags when different names used' do
+      subject.noindex('some-noindex')
+      subject.nofollow('some-nofollow')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to have_tag('meta', with: { content: "noindex", name: "some-noindex" })
+        expect(meta).to have_tag('meta', with: { content: "nofollow", name: "some-nofollow" })
+      end
+    end
+  end
+end

data/spec/view_helper/open_graph_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'displaying Open Graph meta tags' do
+  subject { ActionView::Base.new }
+
+  it 'should display meta tags specified with :open_graph' do
+    subject.set_meta_tags(open_graph: {
+      title:       'Facebook Share Title',
+      description: 'Facebook Share Description'
+    })
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "Facebook Share Title", property: "og:title" })
+      expect(meta).to have_tag('meta', with: { content: "Facebook Share Description", property: "og:description" })
+    end
+  end
+
+  it 'should display meta tags specified with :og' do
+    subject.set_meta_tags(og: {
+      title:       'Facebook Share Title',
+      description: 'Facebook Share Description'
+    })
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "Facebook Share Title", property: "og:title" })
+      expect(meta).to have_tag('meta', with: { content: "Facebook Share Description", property: "og:description" })
+    end
+  end
+
+  it 'should use deep merge when displaying open graph meta tags' do
+    subject.set_meta_tags(og: { title: 'Facebook Share Title' })
+    subject.display_meta_tags(og: { description: 'Facebook Share Description' }).tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "Facebook Share Title", property: "og:title" })
+      expect(meta).to have_tag('meta', with: { content: "Facebook Share Description", property: "og:description" })
+    end
+  end
+
+  it "should not display meta tags without content" do
+    subject.set_meta_tags(open_graph: {
+      title:       '',
+      description: ''
+    })
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to_not have_tag('meta', with: { content: "", property: "og:title" })
+      expect(meta).to_not have_tag('meta', with: { content: "", property: "og:description" })
+    end
+  end
+
+  it "should display locale meta tags" do
+    subject.display_meta_tags(open_graph: { locale: { _: 'en_GB', alternate: ['fr_FR', 'es_ES'] } }).tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "en_GB", property: "og:locale" })
+      expect(meta).to have_tag('meta', with: { content: "fr_FR", property: "og:locale:alternate" })
+      expect(meta).to have_tag('meta', with: { content: "es_ES", property: "og:locale:alternate" })
+    end
+  end
+
+  it "should display mirrored content" do
+    subject.set_meta_tags(title: 'someTitle')
+    subject.display_meta_tags(open_graph: { title: :title }).tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "someTitle", property: "og:title" })
+    end
+  end
+
+  it "should display open graph meta tags with an array of images" do
+    subject.set_meta_tags(open_graph: {
+      title: 'someTitle',
+      image: [{
+        _:      'http://example.com/1.png',
+        width:  75,
+        height: 75,
+      },
+      {
+        _:      'http://example.com/2.png',
+        width:  50,
+        height: 50,
+      }]
+    })
+    subject.display_meta_tags(site: 'someTitle').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: "someTitle", property: "og:title" })
+      expect(meta).to have_tag('meta', with: { content: "http://example.com/1.png", property: "og:image" })
+      expect(meta).to have_tag('meta', with: { content: "75", property: "og:image:width" })
+      expect(meta).to have_tag('meta', with: { content: "75", property: "og:image:height" })
+      expect(meta).to have_tag('meta', with: { content: "http://example.com/2.png", property: "og:image" })
+      expect(meta).to have_tag('meta', with: { content: "50", property: "og:image:width" })
+      expect(meta).to have_tag('meta', with: { content: "50", property: "og:image:height" })
+    end
+  end
+end

data/spec/view_helper/open_search_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'displaying Open Search meta tags' do
+  subject { ActionView::Base.new }
+
+  it 'should display meta tags specified with :open_search' do
+    subject.set_meta_tags(open_search: {
+        title: 'Open Search Title',
+        href:  '/open_search_path.xml'
+    })
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('link', with: {
+        href:  '/open_search_path.xml',
+        rel:   'search',
+        title: 'Open Search Title',
+        type:  'application/opensearchdescription+xml',
+      })
+    end
+  end
+
+  it 'should not display meta tags without content' do
+    subject.set_meta_tags(open_search: {
+        title: '',
+        href:  '',
+    })
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to_not have_tag('link', with: {
+        rel:   'search',
+        type:  'application/opensearchdescription+xml',
+      })
+    end
+  end
+end

data/spec/view_helper/refresh_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper, 'displaying refresh' do
+  subject { ActionView::Base.new }
+
+  it 'displays refresh when "refresh" is used' do
+    subject.refresh(5)
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: '5', 'http-equiv' => 'refresh' })
+    end
+  end
+
+  it 'displays refresh when "set_meta_tags" used' do
+    subject.set_meta_tags(refresh: 5)
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: '5', 'http-equiv' => 'refresh' })
+    end
+  end
+
+  it 'should use custom refresh if given' do
+    subject.refresh("5;url=http://example.com/")
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to have_tag('meta', with: { content: '5;url=http://example.com/', 'http-equiv' => "refresh" })
+    end
+  end
+
+  it 'should display nothing by default' do
+    subject.display_meta_tags(site: 'someSite').tap do |meta|
+      expect(meta).to_not have_tag('meta', with: { 'http-equiv' => "refresh" })
+    end
+  end
+end

data/spec/view_helper/title_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe MetaTags::ViewHelper do
+  subject { ActionView::Base.new }
+
+  context 'displaying title' do
+    it 'should not display title if blank' do
+      expect(subject.display_meta_tags).to eq('')
+      subject.title('')
+      expect(subject.display_meta_tags).to eq('')
+    end
+
+    it 'should use website name if title is empty' do
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to eq('<title>someSite</title>')
+      end
+    end
+
+    it 'should display title when "title" used' do
+      subject.title('someTitle')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to eq('<title>someSite | someTitle</title>')
+      end
+    end
+
+    it 'should display title only when "site" is empty' do
+      subject.title('someTitle')
+      expect(subject.display_meta_tags).to eq('<title>someTitle</title>')
+    end
+
+    it 'should display title when "set_meta_tags" used' do
+      subject.set_meta_tags(title: 'someTitle')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to eq('<title>someSite | someTitle</title>')
+      end
+    end
+
+    it 'should display custom title if given' do
+      subject.title('someTitle')
+      subject.display_meta_tags(site: 'someSite', title: 'defaultTitle').tap do |meta|
+        expect(meta).to eq('<title>someSite | someTitle</title>')
+      end
+    end
+
+    it 'should use website before page by default' do
+      subject.display_meta_tags(site: 'someSite', title: 'someTitle').tap do |meta|
+        expect(meta).to eq('<title>someSite | someTitle</title>')
+      end
+    end
+
+    it 'should only use markup in titles in the view' do
+      expect(subject.title('<b>someTitle</b>')).to eq('<b>someTitle</b>')
+      subject.display_meta_tags(site: 'someSite').tap do |meta|
+        expect(meta).to eq('<title>someSite | someTitle</title>')
+      end
+    end
+
+    it 'should use page before website if :reverse' do
+      subject.display_meta_tags(site: 'someSite', title: 'someTitle', reverse: true).tap do |meta|
+        expect(meta).to eq('<title>someTitle | someSite</title>')
+      end
+    end
+
+    it 'should be lowercase if :lowercase' do
+      subject.display_meta_tags(site: 'someSite', title: 'someTitle', lowercase: true).tap do |meta|
+        expect(meta).to eq('<title>someSite | sometitle</title>')
+      end
+    end
+
+    it 'should use custom separator if :separator' do
+      subject.title('someTitle')
+      subject.display_meta_tags(site: 'someSite', separator: '-').tap do |meta|
+        expect(meta).to eq('<title>someSite - someTitle</title>')
+      end
+      subject.display_meta_tags(site: 'someSite', separator: ':').tap do |meta|
+        expect(meta).to eq('<title>someSite : someTitle</title>')
+      end
+      subject.display_meta_tags(site: 'someSite', separator: '&amp;').tap do |meta|
+        expect(meta).to eq('<title>someSite &amp;amp;amp; someTitle</title>')
+      end
+      subject.display_meta_tags(site: 'someSite', separator: '&amp;'.html_safe).tap do |meta|
+        expect(meta).to eq('<title>someSite &amp;amp; someTitle</title>')
+      end
+      subject.display_meta_tags(site: 'someSite: ', separator: false).tap do |meta|
+        expect(meta).to eq('<title>someSite: someTitle</title>')
+      end
+    end
+
+    it 'should use custom prefix and suffix if available' do
+      subject.display_meta_tags(site: 'someSite', title: 'someTitle', prefix: ' -', suffix: '- ').tap do |meta|
+        expect(meta).to eq('<title>someSite -|- someTitle</title>')
+      end
+    end
+
+    it 'should collapse prefix if false' do
+      subject.display_meta_tags(site: 'someSite', title: 'someTitle', prefix: false).tap do |meta|
+        expect(meta).to eq('<title>someSite| someTitle</title>')
+      end
+    end
+
+    it 'should collapse suffix if false' do
+      subject.display_meta_tags(site: 'someSite', title: 'someTitle', suffix: false).tap do |meta|
+        expect(meta).to eq('<title>someSite |someTitle</title>')
+      end
+    end
+
+    it 'should use all custom options if available' do
+      subject.display_meta_tags({
+        site:      'someSite',
+        title:     'someTitle',
+        prefix:    ' -',
+        suffix:    '+ ',
+        separator: ':',
+        lowercase: true,
+        reverse:   true,
+      }).tap do |meta|
+        expect(meta).to eq('<title>sometitle -:+ someSite</title>')
+      end
+    end
+
+    it 'should allow Arrays in title' do
+      subject.display_meta_tags(site: 'someSite', title: ['someTitle', 'anotherTitle']).tap do |meta|
+        expect(meta).to eq('<title>someSite | someTitle | anotherTitle</title>')
+      end
+    end
+
+    it 'should allow Arrays in title with :lowercase' do
+      subject.display_meta_tags(site: 'someSite', title: ['someTitle', 'anotherTitle'], lowercase: true).tap do |meta|
+        expect(meta).to eq('<title>someSite | sometitle | anothertitle</title>')
+      end
+    end
+
+    it 'should build title in reverse order if :reverse' do
+      subject.display_meta_tags({
+        site:      'someSite',
+        title:     ['someTitle', 'anotherTitle'],
+        prefix:    ' -',
+        suffix:    '+ ',
+        separator: ':',
+        reverse:   true,
+      }).tap do |meta|
+        expect(meta).to eq('<title>anotherTitle -:+ someTitle -:+ someSite</title>')
+      end
+    end
+  end
+
+  context '.display_title' do
+    it 'should display custom title if given' do
+      subject.title('someTitle')
+      subject.display_title(site: 'someSite', title: 'defaultTitle').tap do |meta|
+        expect(meta).to eq('someSite | someTitle')
+      end
+    end
+  end
+end