bridgetown-seo-tag 3.0.5.beta1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fb136d90e02d2d69b5269ffbe7464a4cbe3e123e2a3c7ac718e6fc27243cc82
-  data.tar.gz: 035d0bc9e0dd579d93ce3dd27c53301cfcd9aa9d81659ed3819fd535a2a15983
+  metadata.gz: 700724012209f996a9aafe12a6fea52c050e39e0f6afba904e6ea41c5205f6dd
+  data.tar.gz: 383ad71d2b5dd8923f40bc8c5e01d7f437ebbce97b3c80d0c84847c2c1895d8a
 SHA512:
-  metadata.gz: 36cedb645d26109e2555ee02c1ca0c538c7de4e4ceec99716b3c14b9e4c208d4135af7245fb00e4aeaf7b0366d6b111f6639e34e99cd089c853e389a0c14d888
-  data.tar.gz: 40fbbf1462cfff3c55655584447b7271e69d49395c7da35e92e993bc0bf60e32ed12fc22efb1a79eda86b458e61390a72f6e785857a9731918d2e318534a8057
+  metadata.gz: 31d8e25501780ce3b73f9b8d9abfff7efa8ddfe1b0f547627742d606458483f454e029b30c1c2cf7cea1040633f347f569198cfdd40dcafd516e3ba0c999395c
+  data.tar.gz: cdf16c8875a8b632cc59707fa251a1428f8b64e51871eac6db143615b681f98d8b935e8749edd1d41f02e15dd36bd8c830682d3114890b00b55bbdc1da0fb5c9

data/.rubocop.yml

@@ -17,3 +17,10 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+
+Lint/MissingSuper:
+  Enabled: false
+
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - spec/**/*

data/CHANGELOG.md

@@ -1,19 +1,37 @@
-# master
+# Changelog
+
+## 5.0.0 / 2021-10-17
+
+- Change "Site Title | Site Tagline" format to "Site Title: Site Tagline"
+  - also handle Bridgetown 1.0 templates where the homepage title defaults to `Index`
+  - upgrade rubocop-bridgetown gem to 0.3
+
+## 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.
+- 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.
+- 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
+- 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.
+- Use Bridgetown gem and rename to bridgetown-seo-tag.

data/README.md

@@ -30,6 +30,14 @@ Or if you wish to control your HTML `<title>` tag yourself:
 {% 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:

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.15.0.beta2", "< 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-bridgetown", "~> 0.2"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
 end

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

@@ -41,8 +41,7 @@ module Bridgetown
 
       private
 
-      attr_reader :page
-      attr_reader :site
+      attr_reader :page, :site
 
       # Finds the page author in the page.author, page.authors, or site.author
       #
@@ -62,10 +61,9 @@ module Bridgetown
       # Returns a hash representing additional metadata or an empty hash
       def site_data_hash
         @site_data_hash ||= begin
-          return {} unless resolved_author.is_a?(String)
-          return {} unless site.data["authors"].is_a?(Hash)
-
-          author_hash = site.data["authors"][resolved_author]
+          author_hash = if site.data.authors.is_a?(Hash) && resolved_author.is_a?(String)
+                          site.data.authors[resolved_author]
+                        end
           author_hash.is_a?(Hash) ? author_hash : {}
         end
       end
@@ -74,15 +72,14 @@ module Bridgetown
       # including site-wide metadata if the author is provided as a string,
       # or an empty hash, if the author cannot be resolved
       def author_hash
-        @author_hash ||= begin
-          if resolved_author.is_a? Hash
-            resolved_author
-          elsif resolved_author.is_a? String
-            { "name" => resolved_author }.merge(site_data_hash)
-          else
-            {}
-          end
-        end
+        @author_hash ||= case resolved_author
+                         when Hash
+                           resolved_author
+                         when String
+                           { "name" => resolved_author }.merge(site_data_hash)
+                         else
+                           {}
+                         end
       end
 
       # Since author_hash is aliased to fallback_data, any values in the hash

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

@@ -6,6 +6,7 @@ module Bridgetown
       include Bridgetown::SeoTag::UrlHelper
 
       TITLE_SEPARATOR = " | "
+      TAGLINE_SEPARATOR = ": "
       FORMAT_STRING_METHODS = [
         :markdownify, :strip_html, :normalize_whitespace, :escape_once,
       ].freeze
@@ -47,7 +48,14 @@ module Bridgetown
 
       # Page title without site title or description appended
       def page_title
-        @page_title ||= format_string(page["title"]) || site_title
+        @page_title ||= format_string(
+          if (page["title"] == "Index" || page["title"].blank?) &&
+              site_tagline_or_description
+            "#{site_title}#{TAGLINE_SEPARATOR}#{site_tagline_or_description}"
+          else
+            page["title"]
+          end
+        ) || site_title
       end
 
       def site_tagline_or_description
@@ -55,23 +63,18 @@ module Bridgetown
       end
 
       # Page title with site title or description appended
-      # rubocop:disable Metrics/CyclomaticComplexity
       def title
-        @title ||= begin
-          if site_title && page_title != site_title
-            page_title + TITLE_SEPARATOR + site_title
-          elsif site_description && site_title
-            site_title + TITLE_SEPARATOR + site_tagline_or_description
-          else
-            page_title || site_title
-          end
-        end
+        @title ||= if site_title && page_title != site_title &&
+            !format_string(page_title).start_with?(site_title + TAGLINE_SEPARATOR)
+                     page_title + TITLE_SEPARATOR + site_title
+                   else
+                     page_title || site_title
+                   end
 
         return page_number + @title if page_number
 
         @title
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       def name
         return @name if defined?(@name)
@@ -88,11 +91,9 @@ module Bridgetown
       end
 
       def description
-        @description ||= begin
-          format_string(
-            page["description"] || page["subtitle"] || page["excerpt"]
-          ) || site_description
-        end
+        @description ||= format_string(
+          page["description"] || page["subtitle"] || page["excerpt"]
+        ) || site_description
       end
 
       # A drop representing the page author
@@ -125,39 +126,33 @@ module Bridgetown
       end
 
       def type
-        @type ||= begin
-          if page_seo["type"]
-            page_seo["type"]
-          elsif homepage_or_about?
-            "WebSite"
-          elsif page["date"]
-            "BlogPosting"
-          else
-            "WebPage"
-          end
-        end
+        @type ||= if page_seo["type"]
+                    page_seo["type"]
+                  elsif homepage_or_about?
+                    "WebSite"
+                  elsif page["date"]
+                    "BlogPosting"
+                  else
+                    "WebPage"
+                  end
       end
 
       def links
-        @links ||= begin
-          if page_seo["links"]
-            page_seo["links"]
-          elsif homepage_or_about? && site_social["links"]
-            site_social["links"]
-          end
-        end
+        @links ||= if page_seo["links"]
+                     page_seo["links"]
+                   elsif homepage_or_about? && site_social["links"]
+                     site_social["links"]
+                   end
       end
 
       def logo
-        @logo ||= begin
-          return unless site.data.dig("site_metadata", "logo")
-
-          if absolute_url? site.data.dig("site_metadata", "logo")
-            filters.uri_escape site.data.dig("site_metadata", "logo")
-          else
-            filters.uri_escape filters.absolute_url site.data.dig("site_metadata", "logo")
-          end
-        end
+        @logo ||= if !site.data.dig("site_metadata", "logo")
+                    nil
+                  elsif absolute_url? site.data.dig("site_metadata", "logo")
+                    filters.uri_escape site.data.dig("site_metadata", "logo")
+                  else
+                    filters.uri_escape filters.absolute_url site.data.dig("site_metadata", "logo")
+                  end
       end
 
       def page_lang
@@ -165,13 +160,15 @@ module Bridgetown
       end
 
       def canonical_url
-        @canonical_url ||= begin
-          if page["canonical_url"].to_s.empty?
-            filters.absolute_url(page["url"]).to_s.gsub(%r!/index\.html$!, "/")
-          else
-            page["canonical_url"]
-          end
-        end
+        @canonical_url ||= 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
+                             filters.absolute_url(page["relative_url"]).to_s.gsub(
+                               %r!/index\.html$!, "/"
+                             )
+                           end
       end
 
       private
@@ -225,7 +222,7 @@ module Bridgetown
       end
 
       def site_social
-        @site_social ||= sub_hash(site.data.dig("site_metadata"), "social")
+        @site_social ||= sub_hash(site.data["site_metadata"], "social")
       end
 
       # Safely returns a sub hash

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

@@ -34,14 +34,14 @@ module Bridgetown
 
       private
 
-      attr_accessor :page
-      attr_accessor :context
+      attr_accessor :page, :context
 
       # The normalized image hash with a `path` key (which may be nil)
       def image_hash
-        @image_hash ||= if page["image"].is_a?(Hash)
+        @image_hash ||= case page["image"]
+                        when Hash
                           { "path" => nil }.merge(page["image"])
-                        elsif page["image"].is_a?(String)
+                        when String
                           { "path" => page["image"] }
                         else
                           { "path" => nil }
@@ -50,9 +50,7 @@ module Bridgetown
       alias_method :fallback_data, :image_hash
 
       def raw_path
-        @raw_path ||= begin
-          image_hash["path"] || image_hash["facebook"] || image_hash["twitter"]
-        end
+        @raw_path ||= image_hash["path"] || image_hash["facebook"] || image_hash["twitter"]
       end
 
       def absolute_url

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Prevent bundler errors
-module Liquid; class Tag; end; end
+module Liquid; class Tag; end; end # rubocop:disable Lint/EmptyClass
 
 module Bridgetown
   class SeoTag < Liquid::Tag
-    VERSION = "3.0.5.beta1"
+    VERSION = "5.0.0"
   end
 end

data/lib/bridgetown-seo-tag.rb

@@ -81,18 +81,16 @@ module Bridgetown
       private
 
       def template_contents
-        @template_contents ||= begin
-          File.read(template_path).gsub(MINIFY_REGEX, "")
-        end
+        @template_contents ||= File.read(template_path).gsub(MINIFY_REGEX, "")
       end
 
       def template_path
-        @template_path ||= begin
-          File.expand_path "./template.html", File.dirname(__FILE__)
-        end
+        @template_path ||= File.expand_path "./template.html", File.dirname(__FILE__)
       end
     end
   end
 end
 
 Liquid::Template.register_tag("seo", Bridgetown::SeoTag)
+
+require "bridgetown-seo-tag/builder"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-seo-tag
 version: !ruby/object:Gem::Version
-  version: 3.0.5.beta1
+  version: 5.0.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
+date: 2021-10-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.15.0.beta2
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0.beta2
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -118,6 +118,7 @@ files:
 - 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
@@ -139,11 +140,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Bridgetown plugin to add metadata tags for search engines and social networks