bridgetown-seo-tag 3.0.4 → 3.0.5.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2663e12f9227a535665e3f8a3b0950744a3455098c03af97f7f0d442b59df71f
-  data.tar.gz: 90faa60655df73595b5c51b1109950570cb96b8954f163d8cede8eb41b874f8d
+  metadata.gz: 0fb136d90e02d2d69b5269ffbe7464a4cbe3e123e2a3c7ac718e6fc27243cc82
+  data.tar.gz: 035d0bc9e0dd579d93ce3dd27c53301cfcd9aa9d81659ed3819fd535a2a15983
 SHA512:
-  metadata.gz: 2c19b7a99e0ee861d54b24084b35947c0abcbbfa6b5e5152833a09a0c3309f7bd45618a07c2ff3bea3bc830ae879174168e6743f23c89d53a73175b717b23f66
-  data.tar.gz: b56199df66f8caa74fc17109471ef4b11430520bb6c90d561a2df03b92b45d78c4fa6cc624e15ae9d7c6de2821085ca3a3cc6337a61c5d5538c9d3eee19d7d41
+  metadata.gz: 36cedb645d26109e2555ee02c1ca0c538c7de4e4ceec99716b3c14b9e4c208d4135af7245fb00e4aeaf7b0366d6b111f6639e34e99cd089c853e389a0c14d888
+  data.tar.gz: 40fbbf1462cfff3c55655584447b7271e69d49395c7da35e92e993bc0bf60e32ed12fc22efb1a79eda86b458e61390a72f6e785857a9731918d2e318534a8057

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/**/*
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # master
 
+## 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.

data/README.md

@@ -24,30 +24,104 @@ And then add the Liquid tag to your HTML head:
 {% seo %}
 ```
 
-## What it does
+Or if you wish to control your HTML `<title>` tag yourself:
+
+```liquid
+{% 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
+  ```
 
-Bridgetown SEO tag is designed to output machine-readable metadata for search engines and social networks to index and display. 
+* `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
 
-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.
+  You'll want to describe one or more like so:
 
-## Documentation
+  ```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.
+
+Here is a very basic example, that you are encouraged to adapt to your needs:
+
+```yml
+defaults:
+  - scope:
+      path: ""
+    values:
+      image: /assets/images/default-card.png
+```
 
-More detailed documentation forthcoming.
+[More advanced usage information is on the Wiki here.](https://github.com/bridgetownrb/bridgetown-seo-tag/wiki/Advanced-Usage)
 
 ## Testing
 

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

@@ -16,11 +16,11 @@ Gem::Specification.new do |spec|
   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.15.0.beta2", "< 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
 

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

@@ -97,13 +97,13 @@ module Bridgetown
 
       # 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
 
@@ -199,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.4"
+    VERSION = "3.0.5.beta1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-seo-tag
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.5.beta1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2020-05-31 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.15.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.15.0.beta2
     - - "<"
       - !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: []
@@ -139,9 +139,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.6
 signing_key: