RubyGems - meta-tags - Versions diffs - 2.0.0 → 2.1.0 - Mend

meta-tags 2.0.0 → 2.1.0

Files changed (38) hide show

checksums.yaml +5 -13
data/.gitignore +1 -0
data/.rspec +3 -0
data/.ruby-version +1 -1
data/.travis.yml +7 -13
data/CHANGELOG.md +18 -0
data/Gemfile +5 -0
data/README.md +163 -71
data/Rakefile +2 -2
data/lib/meta_tags.rb +18 -0
data/lib/meta_tags/configuration.rb +21 -0
data/lib/meta_tags/meta_tags_collection.rb +5 -10
data/lib/meta_tags/renderer.rb +114 -37
data/lib/meta_tags/text_normalizer.rb +71 -6
data/lib/meta_tags/version.rb +1 -1
data/lib/meta_tags/view_helper.rb +12 -11
data/meta-tags.gemspec +2 -1
data/spec/configuration_spec.rb +14 -0
data/spec/controller_helper_spec.rb +4 -4
data/spec/spec_helper.rb +69 -13
data/spec/text_normalizer/normalize_title_spec.rb +43 -0
data/spec/text_normalizer/truncate_array_spec.rb +60 -0
data/spec/view_helper/charset_spec.rb +16 -0
data/spec/view_helper/custom_spec.rb +67 -0
data/spec/view_helper/description_spec.rb +61 -0
data/spec/view_helper/icon_spec.rb +42 -0
data/spec/view_helper/keywords_spec.rb +58 -0
data/spec/view_helper/links_spec.rb +125 -0
data/spec/view_helper/module_spec.rb +41 -0
data/spec/view_helper/noindex_spec.rb +107 -0
data/spec/view_helper/open_graph_spec.rb +86 -0
data/spec/view_helper/open_search_spec.rb +33 -0
data/spec/view_helper/refresh_spec.rb +32 -0
data/spec/view_helper/title_spec.rb +155 -0
data/spec/view_helper/twitter_spec.rb +31 -0
data/spec/view_helper_spec.rb +57 -0
metadata +53 -21
data/spec/meta_tags_spec.rb +0 -570

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

data/lib/meta_tags/view_helper.rb CHANGED

@@ -20,8 +20,8 @@ module MetaTags
     #   for allowed options.
     #
     # @example
-    #   set_meta_tags :title => 'Login Page', :description => 'Here you can login'
-    #   set_meta_tags :keywords => 'authorization, login'
+    #   set_meta_tags title: 'Login Page', description: 'Here you can login'
+    #   set_meta_tags keywords: 'authorization, login'
     #
     # @see #display_meta_tags
     #
@@ -47,14 +47,14 @@ module MetaTags
     # @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"
+    #   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?
+      set_meta_tags(title: title) unless title.nil?
       headline.blank? ? meta_tags[:title] : headline
     end
@@ -71,7 +71,7 @@ module MetaTags
     # @see #display_meta_tags
     #
     def keywords(keywords)
-      set_meta_tags(:keywords => keywords)
+      set_meta_tags(keywords: keywords)
       keywords
     end
@@ -89,7 +89,7 @@ module MetaTags
     # @see #display_meta_tags
     #
     def description(description)
-      set_meta_tags(:description => description)
+      set_meta_tags(description: description)
       description
     end
@@ -105,7 +105,7 @@ module MetaTags
     # @see #display_meta_tags
     #
     def noindex(noindex = true)
-      set_meta_tags(:noindex => noindex)
+      set_meta_tags(noindex: noindex)
       noindex
     end
@@ -121,7 +121,7 @@ module MetaTags
     # @see #display_meta_tags
     #
     def nofollow(nofollow = true)
-      set_meta_tags(:nofollow => nofollow)
+      set_meta_tags(nofollow: nofollow)
       nofollow
     end
@@ -137,7 +137,7 @@ module MetaTags
     # @see #display_meta_tags
     #
     def refresh(refresh)
-      set_meta_tags(:refresh => refresh)
+      set_meta_tags(refresh: refresh)
       refresh
     end
@@ -164,12 +164,13 @@ module MetaTags
     # @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' %>
+    #     <%= display_meta_tags site: 'My website' %>
     #   </head>
     #
     def display_meta_tags(defaults = {})
@@ -193,7 +194,7 @@ module MetaTags
     # @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' %>">
+    #   <div data-page-container="true" title="<%= display_title title: 'My Page', site: 'PJAX Site' %>">
     #
     def display_title(defaults = {})
       @meta_tags.full_title(defaults)

data/meta-tags.gemspec CHANGED

@@ -15,7 +15,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'actionpack', '>= 3.0.0'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  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'

data/spec/configuration_spec.rb ADDED

@@ -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 CHANGED

@@ -22,19 +22,19 @@ describe MetaTags::ControllerHelper do
   context 'module' do
     it 'should be mixed into ActionController::Base' do
-      ActionController::Base.included_modules.should include(MetaTags::ControllerHelper)
+      expect(ActionController::Base.included_modules).to include(MetaTags::ControllerHelper)
     end
     it 'should respond to "set_meta_tags" helper' do
-      subject.should respond_to(:set_meta_tags)
+      expect(subject).to respond_to(:set_meta_tags)
     end
   end
   describe '.render' do
     it 'should set meta tags from instance variables' do
       subject.index
-      subject.rendered.should be_true
-      subject.meta_tags.meta_tags.should eq('title' => 'title', 'keywords' => 'key1, key2, key3', 'description' => 'description')
+      expect(subject.rendered).to be_truthy
+      expect(subject.meta_tags.meta_tags).to eq('title' => 'title', 'keywords' => 'key1, key2, key3', 'description' => 'description')
     end
   end

data/spec/spec_helper.rb CHANGED

@@ -1,28 +1,84 @@
-require 'bundler/setup'
+if ENV['CODECLIMATE_REPO_TOKEN'] && RUBY_VERSION > '1.8.7'
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
 require 'meta_tags'
+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')
-    subject.meta_tags[:title].should == 'hello'
+    subject.set_meta_tags(title: 'hello')
+    expect(subject.meta_tags[:title]).to eq('hello')
-    subject.set_meta_tags(:title => 'world')
-    subject.meta_tags[:title].should == 'world'
+    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' })
-    subject.meta_tags[:og].should == { 'title' => 'hello' }
+    subject.set_meta_tags(og: { title: 'hello' })
+    expect(subject.meta_tags[:og]).to eq('title' => 'hello')
-    subject.set_meta_tags(:og => { :description => 'world' })
-    subject.meta_tags[:og].should == { 'title' => 'hello', 'description' => 'world' }
+    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 } } )
-    subject.meta_tags[:og].should == { 'title' => 'hello', 'description' => 'world', 'admin' => { 'id' => 1 } }
+    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' })
-    subject.meta_tags[:og].should == { 'title' => 'hello' }
+    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 ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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