bridgetown-seo-tag 3.0.3 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e8233a77aad3796aeb8b05d8a675413be603db165753b3c3ce0d83cd20b042
-  data.tar.gz: 5da4c3c8af5cd303d7a84848600e571d5b21ad97aa8c06f837458db2e74bbec2
+  metadata.gz: abb7aa6ad690aea0cc55f5e18a9dd7be9c1461f4b6d7b57977abfc568ae0f09d
+  data.tar.gz: 27388ed583fc7d3cce45d5eab085bf87d5a30320192a844a97541bb71fbf28da
 SHA512:
-  metadata.gz: 939f24dc652310da83407866d9ea32e1e024acaa745be7889bb2887d68832e7441b5cefd933ed49f3ea0a0c6fbadf9ca665db033399a6fe2751a8159b83dd881
-  data.tar.gz: b3e987f8caf569e358e68a343832b19447294be8a80b63482b27a6d8156ebeaac098fb2e14ddb02f536ecf9a6a1aecd08526f3a4d0bc636806b04ec2d1fad845
+  metadata.gz: faa21316c33fd7e2bf19228dcc848b147b5b40ba03f1d12da9229b9b7f665fd9f0b5279198fa43644a67fe67374d2554d61cdb5def9ee12a5d1ad3b8a2f6d420
+  data.tar.gz: e95daef1af9a8447ac7248fc39b6b9246910150995073b4f8b61160cbf60ac07e48fd3cf721be13310e28eb3cb53d4a1624ea323a0e5d191c6221a509b3758b9

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

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 4.0.1 / 2021-06-04
+
+* Fix bug where resources' relative URLs weren't included properly
+
+## 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

@@ -24,31 +24,117 @@ 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 %}
+```
+
+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:
 
-Bridgetown SEO tag is designed to output machine-readable metadata for search engines and social networks to index and display. 
+  ```yml
+  twitter:
+    username: benbalter
+    card: summary
+  ```
 
-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.
+* `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.
+
+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
+```
 
-## 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,16 +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|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

@@ -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
 
@@ -166,10 +166,12 @@ module Bridgetown
 
       def canonical_url
         @canonical_url ||= begin
-          if page["canonical_url"].to_s.empty?
+          if page["canonical_url"].to_s.present?
+            page["canonical_url"]
+          elsif page["url"].to_s.present?
             filters.absolute_url(page["url"]).to_s.gsub(%r!/index\.html$!, "/")
           else
-            page["canonical_url"]
+            filters.absolute_url(page["relative_url"]).to_s.gsub(%r!/index\.html$!, "/")
           end
         end
       end
@@ -199,7 +201,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.3"
+    VERSION = "4.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-seo-tag
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 4.0.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-19 00:00:00.000000000 Z
+date: 2021-06-04 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,15 +110,15 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".ruby-version"
+- 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
@@ -137,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/.ruby-version

@@ -1 +0,0 @@
-ruby-2.6.4@bridgetown-gems

data/History.markdown

@@ -1,10 +0,0 @@
-# Change Log
-
-## 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.