bridgetown-seo-tag 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a69aa5dfea8921df56935c8a5c109ac28e07beb3f7c222efc6b08768423b82b
-  data.tar.gz: ec35cb8554ca7f02dff2d10bde9a2e9dc92dbed657e19e022ba550be8124d159
+  metadata.gz: ff4c1b2db4c7aff61742d23ffcf023f2bd52092952e3b6c0d3af2a49e3990b2f
+  data.tar.gz: 7a4cbaa616f17f53c0c5868f3d950cb39e1cd2bcf0cf6d2b90740430ce5a0cc9
 SHA512:
-  metadata.gz: 630e8a49854c0b91436fab5ef2a0621a77ec2c1c2d9c7c09918469a464dcbb6af3860107aad10bf7ebf33b1d3f91bf560bb50acd12d47f8b59d8f060b015574a
-  data.tar.gz: 18185c1b8d4e8d6f690927c2df7238ec450aca247b405d953eac5032352388040fe054f37ae69274cea7d9e21254cd0c9164aa1985f17b414475eec127d6baa3
+  metadata.gz: 4bfa79c801ea61b5a66d8200b890e55090db444824cc9a2be37eafc3f07f798a5d1786109027cd33946ca4891649a8a4684bec7215f3f99b2c249dadedbf32e1
+  data.tar.gz: f64e6d25f016aec3e687ee38f9d6f9d88dc59027b5bb1bfff6ee595703c7f65413ebffe6ff1693b85ad1fafeb126b99b69d33af393a9ff5518f058b87f50ed5b

data/.gitignore

@@ -7,3 +7,4 @@ spec/reports/
 spec/fixtures/.bridgetown-cache
 tmp/
 vendor/bundle
+.ruby-version

data/.rubocop.yml

@@ -1,11 +1,11 @@
 inherit_from: .rubocop_todo.yml
 
-require: rubocop-jekyll
+require: rubocop-bridgetown
 inherit_gem:
-  rubocop-jekyll: .rubocop.yml
+  rubocop-bridgetown: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
     - vendor/**/*
 
@@ -14,6 +14,6 @@ Layout/LineLength:
     - spec/**/*
     - bridgetown-seo-tag.gemspec
 
-Layout/BlockLength:
+Metrics/BlockLength:
   Exclude:
     - spec/**/*

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# master
+
+## 4.0.0 / 2021-04-17
+
+* New release with helper to support Ruby templates like ERB
+
+## 3.0.5  / 2020-06-18
+
+* Final release
+
+## 3.0.5.beta1 / 2020-05-31
+
+* Fix bugs due to Bridgetown 0.15 switch to `render` tag.
+* Switch to using Rubocop Bridgetown gem.
+
+## 3.0.4 / 2020-05-01
+
+Update to require a minimum Ruby version of 2.5.
+
+## 3.0.3 / 2020-04-19
+
+Allow `site.metadata.twitter` data if present. Look for `page.subtitle` if
+`page.description` isn't present.
+
+## 3.0.0 / 2020-04-14
+
+Use Bridgetown gem and rename to bridgetown-seo-tag.

data/README.md

@@ -4,31 +4,137 @@ A Bridgetown plugin to add metadata tags for search engines and social networks
 
 [![Gem Version](https://badge.fury.io/rb/bridgetown-seo-tag.svg)](https://badge.fury.io/rb/bridgetown-seo-tag)
 
-## What it does
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgetown-seo-tag -g bridgetown_plugins
+```
+
+Or simply add this line to your Gemfile:
+
+```ruby
+gem 'bridgetown-seo-tag', group: "bridgetown_plugins"
+```
+
+And then add the Liquid tag to your HTML head:
+
+```liquid
+{% seo %}
+```
+
+Or if you wish to control your HTML `<title>` tag yourself:
+
+```liquid
+{% seo title=false %}
+```
+
+You can use the `seo` helper in Ruby templates as well:
+
+```erb
+<%= seo %>
+<!-- or -->
+<%= seo title: false %>
+```
+
+## Summary
 
 Bridgetown SEO Tag adds the following meta tags to your site:
 
-* Page title, with site title or description appended
+* Page title, with site title or description appended (optional)
 * Page description
 * Canonical URL
 * Next and previous URLs on paginated pages
 * [Open Graph](https://ogp.me/) title, description, site title, and URL (for Facebook, LinkedIn, etc.)
-* [Twitter Summary Card](https://dev.twitter.com/cards/overview) metadata
+* [Twitter Summary Card](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started) metadata
 
 While you could theoretically add the necessary metadata tags yourself, Bridgetown SEO Tag provides a battle-tested template of crowdsourced best-practices.
 
 **NOTE:** make sure you add your site-wide SEO Tag metadata to `src/_data/site_metadata.yml`, not `bridgetown.config.yml`
 
-## What it doesn't do
+## Usage
+
+The SEO tag will use the following configuration options from `bridgetown.config.yml`:
+
+* `url` - The full URL to your site.
+* `lang` - The locale for the site, or the current document if specified in the document's front matter. Format `language_TERRITORY` — default is `en_US`.
+
+The SEO tag will respect any of the following if included in your site's `site_metadata.yml` (and simply not include them if they're not defined):
+
+* `title` - Your website's title (e.g., Super-cool Website).
+* `tagline` - A short description (e.g., A blog dedicated to reviewing cat gifs), used in instances (like a home page) where there isn't a dedicated document title.
+* `description` - A longer description used for the description meta tag. Also used as fallback for documents that don't provide their own `description` and as part of the home page title tag if `tagline` is not defined.
+* `author` - global author information (see [Advanced usage](https://github.com/bridgetownrb/bridgetown-seo-tag/wiki/Advanced-Usage#author-information))
+
+* `twitter` - You can add a single Twitter handle to be used in Twitter card tags, like "bridgetownrb". Or you use a YAML mapping with additional details:
+  * `twitter:card` - The site's default card type
+  * `twitter:username` - The site's Twitter handle
+
+  Example:
+
+  ```yml
+  twitter:
+    username: benbalter
+    card: summary
+  ```
+
+* `facebook` - The following properties are available:
+  * `facebook:app_id` - a Facebook app ID for Facebook insights
+  * `facebook:publisher` - a Facebook page URL or ID of the publishing entity
+  * `facebook:admins` - a Facebook user ID for domain insights linked to a personal account
+
+  You'll want to describe one or more like so:
+
+  ```yml
+  facebook:
+    app_id: 1234
+    publisher: 1234
+    admins: 1234
+  ```
+
+* `google_site_verification` for verifying ownership for Google Search Console
+* Alternatively, verify ownership with several services at once using the following format:
+
+```yml
+webmaster_verifications:
+  google: 1234
+  bing: 1234
+  alexa: 1234
+  yandex: 1234
+  baidu: 1234
+```
+
+The SEO tag will respect the following YAML front matter if included in a post, page, or document:
+
+* `title` - The title of the document
+* `description` - A short description of the document's content
+* `image` - URL to an image associated with the document (e.g., `/assets/page-pic.jpg`)
+* `author` - Document-specific author information (see [Advanced usage](https://github.com/bridgetownrb/bridgetown-seo-tag/wiki/Advanced-Usage#author-information))
+* `lang` - Document-specific language information
+
+*Note:* Front matter defaults can be used for any of the above values.
+
+### Setting a default image
+
+You can define a default image using [Front Matter defaults](https://www.bridgetownrb.com/docs/configuration/front-matter-defaults/) to provide a default Twitter Card or Open Graph image to all of your documents.
 
-Bridgetown SEO tag is designed to output machine-readable metadata for search engines and social networks to index and display. 
+Here is a very basic example, that you are encouraged to adapt to your needs:
 
-Bridgetown SEO tag isn't designed to accommodate every possible use case. It should work for most site out of the box and without a laundry list of configuration options that serve only to confuse most users.
+```yml
+defaults:
+  - scope:
+      path: ""
+    values:
+      image: /assets/images/default-card.png
+```
 
-## Documentation
+[More advanced usage information is on the Wiki here.](https://github.com/bridgetownrb/bridgetown-seo-tag/wiki/Advanced-Usage)
 
-More detailed documentation forthcoming.
+## Testing
 
+* Run `bundle exec rspec` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and test with rspec together
 
 ## Contributing
 

data/Rakefile

@@ -5,4 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bridgetown-seo-tag.gemspec

@@ -11,18 +11,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/bridgetownrb/bridgetown-seo-tag"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r!^exe/!) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "bridgetown", ">= 0.6", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 0.20.0", "< 2.0"
 
   spec.add_development_dependency "bundler", ">= 1.15"
   spec.add_development_dependency "html-proofer", "~> 3.7"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "rubocop-jekyll", "~> 0.5"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
 end

data/lib/bridgetown-seo-tag.rb

@@ -44,27 +44,32 @@ module Bridgetown
     end
 
     def payload
+      paginator = context.registers[:page].pager if context.registers[:page].respond_to?(:pager)
+
       # site_payload is an instance of UnifiedPayloadDrop
       Bridgetown::Utils.deep_merge_hashes(
         context.registers[:site].site_payload,
         "page"      => context.registers[:page],
-        "paginator" => context["paginator"],
+        "paginator" => paginator,
         "seo_tag"   => drop
       )
     end
 
     def drop
       if context.registers[:site].liquid_renderer.respond_to?(:cache)
-        Bridgetown::SeoTag::Drop.new(@text, @context)
+        Bridgetown::SeoTag::Drop.new(@text, context)
       else
-        @drop ||= Bridgetown::SeoTag::Drop.new(@text, @context)
+        @drop ||= Bridgetown::SeoTag::Drop.new(@text, context)
       end
     end
 
     def info
       {
-        :registers => context.registers,
-        :filters   => [Bridgetown::Filters],
+        registers: {
+          site: context.registers[:site],
+          page: context.registers[:page],
+        },
+        filters: [Bridgetown::Filters],
       }
     end
 
@@ -91,3 +96,5 @@ module Bridgetown
 end
 
 Liquid::Template.register_tag("seo", Bridgetown::SeoTag)
+
+require "bridgetown-seo-tag/builder"

data/lib/bridgetown-seo-tag/builder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class SeoTag
+    class Builder < Bridgetown::Builder
+      def build
+        helper "seo", helpers_scope: true do |title: true|
+          context = Liquid::Context.new({}, {}, { site: site, page: view.page })
+          tag_output = Liquid::Template.parse(
+            "{% seo #{"title=false" unless title} %}"
+          ).render!(context, {})
+          tag_output.respond_to?(:html_safe) ? tag_output.html_safe : tag_output
+        end
+      end
+    end
+  end
+end
+
+Bridgetown::SeoTag::Builder.register

data/lib/bridgetown-seo-tag/drop.rb

@@ -89,19 +89,21 @@ module Bridgetown
 
       def description
         @description ||= begin
-          format_string(page["description"] || page["excerpt"]) || site_description
+          format_string(
+            page["description"] || page["subtitle"] || page["excerpt"]
+          ) || site_description
         end
       end
 
       # A drop representing the page author
       def author
-        @author ||= AuthorDrop.new(:page => page, :site => site)
+        @author ||= AuthorDrop.new(page: page, site: site)
       end
 
       # Returns a Drop representing the page's image
       # Returns nil if the image has no path, to preserve backwards compatability
       def image
-        @image ||= ImageDrop.new(:page => page, :context => @context)
+        @image ||= ImageDrop.new(page: page, context: @context)
         @image if @image.path
       end
 
@@ -197,7 +199,7 @@ module Bridgetown
         total = @context["paginator"]["total_pages"]
         paginator_message = site["seo_paginator_message"] || "Page %<current>s of %<total>s for "
 
-        format(paginator_message, :current => current, :total => total) if current > 1
+        format(paginator_message, current: current, total: total) if current > 1
       end
 
       attr_reader :context

data/lib/bridgetown-seo-tag/version.rb

@@ -5,6 +5,6 @@ module Liquid; class Tag; end; end
 
 module Bridgetown
   class SeoTag < Liquid::Tag
-    VERSION = "3.0.2"
+    VERSION = "4.0.0"
   end
 end

data/lib/template.html

@@ -62,7 +62,7 @@
 {% endif %}
 
 {% if site.metadata.twitter %}
-  <meta name="twitter:site" content="@{{ site.metadata.twitter.username | remove:'@' }}" />
+  <meta name="twitter:site" content="@{{ site.metadata.twitter.username | default: site.metadata.twitter | remove:'@' }}" />
 
   {% if seo_tag.author.twitter %}
     <meta name="twitter:creator" content="@{{ seo_tag.author.twitter | remove:'@' }}" />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-seo-tag
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -87,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rubocop-jekyll
+  name: rubocop-bridgetown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.2'
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -110,25 +110,21 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
-- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile
 - bridgetown-seo-tag.gemspec
 - lib/bridgetown-seo-tag.rb
 - lib/bridgetown-seo-tag/author_drop.rb
+- lib/bridgetown-seo-tag/builder.rb
 - lib/bridgetown-seo-tag/drop.rb
 - lib/bridgetown-seo-tag/filters.rb
 - lib/bridgetown-seo-tag/image_drop.rb
 - lib/bridgetown-seo-tag/url_helper.rb
 - lib/bridgetown-seo-tag/version.rb
 - lib/template.html
-- script/bootstrap
-- script/cibuild
-- script/fmt
-- script/release
-- script/test
 homepage: https://github.com/bridgetownrb/bridgetown-seo-tag
 licenses:
 - MIT
@@ -141,14 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Bridgetown plugin to add metadata tags for search engines and social networks

data/History.markdown

@@ -1,5 +0,0 @@
-# Change Log
-
-## 3.0.0 / 2020-04-14
-
-Use Bridgetown gem and rename to bridgetown-seo-tag.

data/script/bootstrap

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -ex
-
-bundle install

data/script/cibuild

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-set -ex
-
-script/fmt
-script/test

data/script/fmt

@@ -1,10 +0,0 @@
-#!/bin/bash
-set -e
-
-echo "Rubocop $(bundle exec rubocop --version)"
-bundle exec rubocop -D -E $@
-success=$?
-if ((success != 0)); then
-   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
-fi
-exit $success

data/script/release

@@ -1,7 +0,0 @@
-#!/bin/sh
-# Tag and push a release.
-
-set -e
-
-script/cibuild
-bundle exec rake release

data/script/test

@@ -1,4 +0,0 @@
-#!/bin/bash
-set -ex
-
-bundle exec rspec "$@"