middleman-meta-tags 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe44adf5d0dd9f8adbca8e20085e5e426c50c824
-  data.tar.gz: ecee9516396c7bc7b71355eb019f13411bd1a683
+SHA256:
+  metadata.gz: 59169e69789518c47ce31641beab6af4880726df72a26ab5941b254a7b5dca37
+  data.tar.gz: 74d48cfd537a22182d15698f131e56a9b12f796ac6d3d7f3fe9f9154b60c0980
 SHA512:
-  metadata.gz: 3277ee46a35b74a6ef1734e25ce839ee3e3faf919e542f71d29c27265d0c02f9eb90b4a1ee99386f3ffc45087aa728cab93cf9f569de633a0b7b80b4c8cd7897
-  data.tar.gz: 2dfd69b8e6f6aa83343c994fe2b14914f6dd4d48d2f61579e0559a2315122c516245899de185f709ebd94e74a5c85baf87ad8d2c48eccf1ea4b1c92b6aa98555
+  metadata.gz: 20ffc6fcaa9b666ab2c85afd5f2ce0d30dc95bc32fae5fc3ccfe957239d239fc8ee9f91d160931aac9d4fef1937f8200d877eaa5e616f3cebeab75fff23d37c1
+  data.tar.gz: 6695dd19fd1cc06da7da79831d90147d64441e30c54b534d1e04898f20bf538d087f15c5c6f884f66433d549bde7d89c06b47279fc68e5675413871764bb7207

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## Next release
+## 0.5.0 (08/01/20)
+
+* Description truncate to 220 chars
+* Add test
+* Add more tags
 
 ## 0.4.0 (03/28/18)
 

data/README.md

@@ -143,3 +143,8 @@ pull_image 'page/to/image/jpg'
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Publishing
+
+1. `gem build middleman-meta-tags.gemspec`
+2. `bundle exec rake release`

data/lib/middleman-meta-tags/extension.rb

@@ -1,3 +1,4 @@
+require 'middleman-core'
 require 'middleman-meta-tags/helpers'
 
 module Middleman

data/lib/middleman-meta-tags/helpers.rb

@@ -5,46 +5,89 @@ module Middleman
         @meta_tags ||= ActiveSupport::HashWithIndifferentAccess.new
       end
 
+      def link_tags
+        @link_tags ||= ActiveSupport::HashWithIndifferentAccess.new
+      end
+
       def set_meta_tags(meta_tags = {})
         self.meta_tags.merge! meta_tags
       end
 
-      def description(description = nil)
-        set_meta_tags(description: description) unless description.nil?
+      def set_link_tags(link_tags = {})
+        self.link_tags.merge! link_tags
       end
 
-      def keywords(keywords = nil)
-        set_meta_tags(keywords: keywords) unless keywords.nil?
+      def site_data
+        (data['site'] || {}).with_indifferent_access
       end
 
       def title(title = nil)
         set_meta_tags(title: title) unless title.nil?
       end
 
+      def description(description = nil)
+        set_meta_tags(description: description) unless description.nil?
+      end
+
+      def keywords(keywords = nil)
+        set_meta_tags(keywords: keywords) unless keywords.nil?
+      end
+
       def display_meta_tags(default = {})
         result    = []
         meta_tags = default.merge(self.meta_tags).with_indifferent_access
+        link_tags = default.merge(self.link_tags)
+
+        charset = meta_tags.delete(:charset)
+        result << tag(:meta, charset: charset) if charset.present?
+
+        viewport = meta_tags.delete(:viewport)
+        result << tag(:meta, name: :viewport, content: viewport) if viewport.present?
+
+        http_equiv = meta_tags.delete('http-equiv')
+        result << tag(:meta, 'http-equiv': 'X-UA-Compatible', content: http_equiv) if http_equiv.present?
 
-        title = full_title(meta_tags)
+        need_full_title = true
+        need_full_title = meta_tags['full_title'] unless meta_tags['full_title'].nil?
+        need_full_title = current_page.data['full_title'] unless current_page.data['full_title'].nil?
+        title = need_full_title ? full_title(meta_tags) : safe_title(meta_tags[:title])
         meta_tags.delete(:title)
         meta_tags.delete(:separator)
-        result << content_tag(:title, title) unless title.blank?
+        result << content_tag(:title, title) if title.present?
 
         description = safe_description(meta_tags.delete(:description))
-        result << tag(:meta, name: :description, content: description) unless description.blank?
+        result << tag(:meta, name: :description, content: description) if description.present?
 
         keywords = meta_tags.delete(:keywords)
         keywords = keywords.join(', ') if keywords.is_a?(Array)
-        result << tag(:meta, name: :keywords, content: keywords) unless keywords.blank?
+        result << tag(:meta, name: :keywords, content: keywords) if keywords.present?
 
         refresh = meta_tags.delete(:refresh)
-        result << tag(:meta, { :content => refresh, :"http-equiv" => "refresh" }) unless refresh.blank?
+        result << tag(:meta, {content: refresh, 'http-equiv': 'refresh'}) if refresh.present?
 
         meta_tags.each do |name, content|
-          if name.start_with?('og:')
-            result << tag(:meta, property: name, content: content ) unless content.blank?
+          unless content.blank? || %(site latitude longitude).include?(name)
+            if name.start_with?('itemprop:')
+              result << tag(:meta, itemprop: name.gsub('itemprop:', ''), content: content)
+            elsif name.start_with?('og:')
+              result << tag(:meta, property: name, content: content)
+            else
+              result << tag(:meta, name: name, content: content)
+            end
+          end
+        end
+
+        position = [meta_tags.delete(:latitude), meta_tags.delete(:longitude)] if meta_tags['latitude'] && meta_tags['longitude']
+        result << tag(:meta, name: 'geo:position', content: position.join(';')) if position
+        result << tag(:meta, name: 'ICBM', content: position.join(', ')) if position
+
+        link_tags.each do |rel, href|
+          if href.kind_of?(Array)
+            href.each do |link|
+              result << tag(:link, rel: rel, href: link)
+            end
           else
-            result << tag(:meta, name: name, content: content ) unless content.blank?
+            result << tag(:link, rel: rel, href: href) unless href.blank?
           end
         end
 
@@ -53,110 +96,149 @@ module Middleman
       end
 
       def auto_display_meta_tags(default = {})
-        auto_tag
+        auto_set_meta_tags
 
         display_meta_tags default
       end
 
-      def auto_tag
-        site_data = (data['site'] || {}).with_indifferent_access
+      def auto_set_meta_tags
+        geocoding_data = site_data['geocoding'] || {}
+        author_data    = site_data['author'] || {}
 
-        set_meta_tags site: site_data['site']
-        set_meta_tags 'og:site_name' => site_data['site']
+        set_meta_tags charset:      'utf-8',
+                      viewport:     'width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no',
+                      'http-equiv': 'IE=edge,chrome=1'
 
+        fall_through(site_data, :site, 'name')
+        fall_through(site_data, :site, 'site')
         fall_through(site_data, :title, 'title')
         fall_through(site_data, :description, 'description')
         fall_through(site_data, :keywords, 'keywords')
 
+        # Microdata
+        fall_through(site_data,       'itemprop:name', 'name')
+        fall_through(site_data,       'itemprop:name', 'site')
+        fall_through(site_data,       'itemprop:name', 'title')
+        fall_through(site_data,       'itemprop:description', 'description')
+        fall_through_image(site_data, 'itemprop:image', 'thumbnail')
+
         # Twitter cards
-        fall_through(site_data, 'twitter:card', 'twitter_card', 'summary_large_image')
-        fall_through(site_data, 'twitter:creator', 'twitter_author')
-        fall_through(site_data, 'twitter:description', 'description')
-        fall_through_image(site_data, 'twitter:image:src', 'pull_image')
-        fall_through(site_data, 'twitter:site', 'publisher_twitter')
-        fall_through(site_data, 'twitter:title', 'title')
+        set_meta_tags                 'twitter:card': 'summary_large_image'
+        fall_through(site_data,       'twitter:card', 'twitter_card')
+        fall_through(site_data,       'twitter:site', 'name')
+        fall_through(site_data,       'twitter:site', 'site')
+        fall_through(author_data,     'twitter:creator', 'twitter')
+        set_meta_tags                 'twitter:url': current_page_url
+        fall_through(site_data,       'twitter:url', 'url')
+        fall_through(site_data,       'twitter:title', 'name')
+        fall_through(site_data,       'twitter:title', 'site')
+        fall_through(site_data,       'twitter:title', 'title')
+        fall_through(site_data,       'twitter:description', 'description')
+        fall_through_image(site_data, 'twitter:image', 'thumbnail')
 
         # Open Graph
-        fall_through(site_data, 'og:description', 'description')
-        fall_through_image(site_data, 'og:image', 'pull_image')
-        fall_through(site_data, 'og:title', 'title')
+        set_meta_tags                 'og:url': current_page_url
+        fall_through(site_data,       'og:url', 'url')
+        set_meta_tags                 'og:type': 'website'
+        fall_through(site_data,       'og:type', 'type')
+        fall_through(site_data,       'og:title', 'name')
+        fall_through(site_data,       'og:title', 'site')
+        fall_through(site_data,       'og:title', 'title')
+        fall_through_image(site_data, 'og:image', 'thumbnail')
+        fall_through(site_data,       'og:description', 'description')
+        fall_through(site_data,       'og:site_name', 'name')
+        fall_through(site_data,       'og:site_name', 'site')
+        set_meta_tags                 'og:locale': 'en_US'
+        fall_through(site_data,       'og:locale', 'locale')
+
+        # Theme color
+        fall_through(site_data,       'theme-color', 'base_color')
+        fall_through(site_data,       'msapplication-TileColor', 'base_color')
+
+        # Geocoding
+        fall_through(geocoding_data, 'latitude', 'latitude')
+        fall_through(geocoding_data, 'longitude', 'longitude')
+        fall_through(geocoding_data, 'geo.placename', 'place')
+        fall_through(geocoding_data, 'geo.region', 'region')
+
+        # Author
+        set_link_tags author: author_data['website'] if author_data['website']
+        set_link_tags license: site_data['license'] if site_data['license']
+
+        me_link_tags = []
+        me_link_tags << author_data['website'] if author_data['website']
+        me_link_tags << "mailto:#{author_data['email']}" if author_data['email'].present?
+        me_link_tags += ["tel:#{author_data['phone']}", "sms:#{author_data['phone']}"] if author_data['phone'].present?
+        %w(github twitter dribbble medium linkedin facebook instagram gitlab bitbucket).each do |social|
+          me_link_tags << "https://#{social}#{['bitbucket'].include?(social) ? '.org' : '.com'}/#{'in/' if social == 'linkedin'}#{author_data[social]}" if author_data[social].present?
+          set_link_tags me: me_link_tags
+        end
       end
 
-    private
+      private
 
       def fall_through(site_data, name, key, default = nil)
-        need_customized = site_data[:customize_by_frontmatter]
-        value = self.meta_tags[key] ||
-                (need_customized && current_page.data[key]) ||
+        value = current_page.data[key] ||
+                meta_tags[key] ||
                 site_data[key] ||
                 default
-        value = yield value if block_given?
 
-        if key === "description"
-          value = safe_description(value)
-        end
+        value = yield value if block_given?
 
-        if key === "title"
-          value = safe_title(value)
-        end
+        value = safe_title(value) if key == 'title'
+        value = safe_description(value) if key == 'description'
 
-        set_meta_tags name => value unless value.blank?
+        set_meta_tags name => value if value.present?
         value
       end
 
       def fall_through_image(*args)
         fall_through(*args) do |path|
-          is_uri?(path) ? path : meta_tags_image_url(path)
+          uri?(path) && path ? path : meta_tags_image_url(path)
         end
       end
 
+      def current_page_url
+        meta_tags_host + current_page.url unless (data['site'] || {})['host'].nil?
+      end
+
       def meta_tags_image_url(source)
-        meta_tags_host + image_path(source)
+        File.join(meta_tags_host, image_path(source))
       end
 
       def meta_tags_host
         (data['site'] || {})['host'] || ''
       end
 
-      # borrowed from Rails 3
-      # http://apidock.com/rails/v3.2.8/ActionView/AssetPaths/is_uri%3F
-      def is_uri?(path)
+      def uri?(path)
         path =~ %r{^[-a-z]+://|^(?:cid|data):|^//}
       end
 
       def full_title(meta_tags)
-        separator   = meta_tags[:separator] || '|'
+        separator   = meta_tags[:separator] || '-'
         full_title  = ''
         title       = safe_title(meta_tags[:title])
 
-        (full_title << title) unless title.blank?
+        (full_title << title) if title.present?
         (full_title << " #{separator} ") unless title.blank? || meta_tags[:site].blank?
-        (full_title << meta_tags[:site]) unless meta_tags[:site].blank?
+        (full_title << meta_tags[:site]) if meta_tags[:site].present?
         full_title
       end
 
       def safe_description(description)
-        if description.is_a?(Hash) && description[I18n.locale]
-          description = description[I18n.locale]
-        end
+        description = description[I18n.locale] if description.is_a?(Hash) && description[I18n.locale]
 
-        if description && description.start_with?('t:')
-          description = I18n.t(description[2..-1])
-        end
+        description = I18n.t(description[2..-1]) if description&.start_with?('t:')
 
-        truncate(strip_tags(description), length: 300)
+        truncate(strip_tags(description), length: 220)
       end
 
       def safe_title(title)
-        if title.is_a?(Hash) && title[I18n.locale]
-          title = title[I18n.locale]
-        end
+        title = title[I18n.locale] if title.is_a?(Hash) && title[I18n.locale]
 
-        if title && title.start_with?('t:')
-          title = I18n.t(title[2..-1])
-        end
+        title = I18n.t(title[2..-1]) if title&.start_with?('t:')
 
-        title = strip_tags(title)
+        strip_tags(title)
       end
     end
   end

data/lib/middleman-meta-tags/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module MetaTags
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/middleman-meta-tags.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency     'middleman-core', ['>= 3.0.0']
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2'
 end

data/spec/middleman-meta-tags/helpers_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Middleman::MetaTags::Helpers do
+  let(:h) { Class.new { extend Middleman::MetaTags::Helpers } }
+
+  before(:each) do
+    allow(h).to receive_message_chain(:current_page, :data).and_return({ full_title: nil })
+  end
+
+  it 'transforms title tag' do
+    h.set_meta_tags title: 'Relevant title'
+    expect(h.display_meta_tags).to eql('<title>Relevant title</title>')
+  end
+
+  it 'transforms description tag' do
+    h.set_meta_tags description: 'Relevant title of more than 220 characters
+1 Relevant title of more than 220 characters
+2 Relevant title of more than 220 characters
+3 Relevant title of more than 220 characters
+4 Relevant title of more than 220 characters'
+    expect(h.display_meta_tags).to eql('<meta name="description" content="Relevant title of more than 220 characters
+1 Relevant title of more than 220 characters
+2 Relevant title of more than 220 characters
+3 Relevant title of more than 220 characters
+4 Relevant title of more than 220 chara..." />')
+  end
+
+  it 'transforms keywords tag' do
+    h.set_meta_tags keywords: %w(some seo keywords)
+    expect(h.display_meta_tags).to eql('<meta name="keywords" content="some, seo, keywords" />')
+  end
+
+  it 'transforms site tag' do
+    expect(h.display_meta_tags site: 'My Awesome Website').to eql('<title>My Awesome Website</title>
+<link rel="site" href="My Awesome Website" />')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'active_support/all'
+require 'middleman-core'
+require 'middleman-meta-tags/extension'
+require 'padrino-helpers'
+
+include Padrino::Helpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-meta-tags
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Baptiste Lecocq
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Easy integration of meta tags into your Middleman applications
 email:
 - hello@tiste.io
@@ -59,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -73,11 +88,13 @@ files:
 - lib/middleman-meta-tags/version.rb
 - lib/middleman_extension.rb
 - middleman-meta-tags.gemspec
+- spec/middleman-meta-tags/helpers_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/tiste/middleman-meta-tags
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +109,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Meta tags for Middleman
-test_files: []
+test_files:
+- spec/middleman-meta-tags/helpers_spec.rb
+- spec/spec_helper.rb