jekyll-linkpreview 0.6.0.rc1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c51945d7da1fdd7145948dffd3f991f1675a1c8dc0f64f3a44d19afc700fd3f
-  data.tar.gz: e18b2a9aa699e6d6208343790cf7e548fee7942f51cb197f87e8db36077b4394
+  metadata.gz: 3644c879680eba2cb17840f40258ec2adeb0493505ca28572cdcadcc72c87ced
+  data.tar.gz: 3925c9a5330bc589b239908cde01dc6be7493d05d35bf6bf2f8e52e3538b643a
 SHA512:
-  metadata.gz: b73fa9cdc4ef0ef09906df15b56563f7c048af2c5ade7e78a87d1938f4654022f3073d243a32b4d5d11a62ba50622d9914b26a0cabe14a98156e08285452e8ea
-  data.tar.gz: 654a1d448bc7c74785beba8c6cfb1e2d6303e7e4db63b341955ee029ec10309334cbc03297b93666b55d804d4a8e9540968041437c8825f656e1f60040f0814e
+  metadata.gz: 4246f72fc2c59ad23149b2c187864533f0fe85e09d1ca7f84feef875ad2404e6861aa6a37255f3ec3e76d2edff367fb5a6061d3f8c497c117edbdafba9801a5f
+  data.tar.gz: 689f9e31a23fb6846db6cb4854adabc464a890816418a988a1732d5cc9b4e34bc7df143774ec274e693d66f51d9af5d41b52ec731b8d3dab980afcd816378e0c

data/.github/workflows/release.yaml

@@ -15,6 +15,9 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 2
+      # See https://github.com/actions/runner-images/issues/6775.
+      - name: Suppress 'detected dubious ownership' error.
+        run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
       - id: check-release
         name: Decide whether to release
         run: |
@@ -34,6 +37,9 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      # See https://github.com/actions/runner-images/issues/6775.
+      - name: Suppress 'detected dubious ownership' error.
+        run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
       - env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
         name: Set credentials for RubyGems
@@ -43,7 +49,7 @@ jobs:
           chmod 0600 ~/.gem/credentials
       - name: Configure git
         run: |
-          git config --global user.email "yusuke.nishioka.0713@gmail..com"
+          git config --global user.email "yusuke.nishioka.0713@gmail.com"
           git config --global user.name "Yusuke Nishioka"
       - name: Install dependencies
         run: bundle install

data/.github/workflows/test.yaml

@@ -1,5 +1,11 @@
 name: Test
-on: [push]
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
 jobs:
   test:
     container:
@@ -7,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ["2.7", "3.1"]
+        ruby: ["2.7", "3.1", "3.2"]
         appraisal:
           - jekyll-35
           - jekyll-36
@@ -28,9 +34,29 @@ jobs:
             appraisal: jekyll-37
           - ruby: "3.1"
             appraisal: jekyll-38
+          - ruby: "3.2"
+            appraisal: jekyll-35
+          - ruby: "3.2"
+            appraisal: jekyll-36
+          - ruby: "3.2"
+            appraisal: jekyll-37
+          - ruby: "3.2"
+            appraisal: jekyll-38
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      # See https://github.com/actions/runner-images/issues/6775.
+      - name: Suppress 'detected dubious ownership' error
+        run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
+      - if: matrix.ruby == '2.7'
+        name: Update RubyGems version
+        # sass-embedded 1.57.1, which is one of dependencies of jekyll-sass-converter 3.0,
+        # requires rubygems version >= 3.3.22
+        # (see https://jekyllrb.com/news/2022/12/21/jekyll-sass-converter-3.0-released/
+        #  for the jekyll-sass-converter 3.0 release).
+        # Just running `gem update --system` upgrades rubygems version to '>= 2.4',
+        # which appraisal 2.4.1 can't work with.
+        run: gem update --system 3.3.22
       - name: Install dependencies
         run: bundle install
       - name: Install dependencies for each appraisal

data/Gemfile

@@ -2,3 +2,12 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in jekyll-linkpreview.gemspec
 gemspec
+
+# The issue that appraisal 2.4.1 can't work with bundler >= 2.4 was solved
+# (see https://github.com/thoughtbot/appraisal/issues/199 for details),
+# but a new version has not been released yet as of Apr 2023.
+# As it's not possible to install a gem from a git repository in the gemspec file,
+# appraisal is being installed in Gemfile.
+group :development do
+  gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal'
+end

data/README.md

@@ -1,6 +1,7 @@
 # Jekyll::Linkpreview
 
-[![Build Status](https://travis-ci.com/ysk24ok/jekyll-linkpreview.svg?branch=master)](https://travis-ci.com/ysk24ok/jekyll-linkpreview)
+[![Test](https://github.com/ysk24ok/jekyll-linkpreview/actions/workflows/test.yaml/badge.svg)](https://github.com/ysk24ok/jekyll-linkpreview/actions/workflows/test.yaml)
+[![Release](https://github.com/ysk24ok/jekyll-linkpreview/actions/workflows/release.yaml/badge.svg)](https://github.com/ysk24ok/jekyll-linkpreview/actions/workflows/release.yaml)
 
 Jekyll plugin to generate link preview by `{% linkpreview %}` tag. The plugin fetches [Open Graph protocol](http://ogp.me/) metadata of the designated page to generate preview. The og properties are saved as JSON for caching and it is used when rebuilding the site.
 
@@ -49,28 +50,53 @@ You can override the default templates used for generating previews, both in cas
 
 ### Template for pages where Open Graph protocol metadata exists
 
- 1. Place `linkpreview.html` file inside `_includes/` folder of your Jekyll site (`_includes/linkpreview.html`)
+1. Place `linkpreview.html` file inside `_includes/` folder of your Jekyll site (`_includes/linkpreview.html`)
      * The folder is the same one you would store files for use with `{% include fragment.html %}` tag. 
        Therefore, it *must* be under the [site's source](https://jekyllrb.com/docs/configuration/options/).
 
- 2. Use built-in variables to extract data which you would like to render. Available variables are:
-  * **link_url** i.e. `{{ link_url }}`
-  * **link_title** i.e. `{{ link_title }}`
-  * **link_image** i.e. `{{ link_image }}`
-  * **link_description** i.e. `{{ link_description }}`
-  * **link_domain** i.e. `{{ link_domain }}`
+2. Use built-in variables to extract data which you would like to render. Available variables are:
+    * basic metadata
+        * `{{ title }}` for `og:title`
+        * `{{ type }}` for `og:type`
+        * `{{ image }}` for `og:image`
+        * `{{ url }}` for `og:url`
+    * optional metadata
+        * `{{ description }}` for `og:description`
+        * `{{ determiner }}` for `og:determiner`
+        * `{{ locale }}` for `og:locale`
+        * `{{ locale_alternate }}` for `og:locale:alternate`
+        * `{{ site_name }}` for `og:site_name`
+        * image
+            * `{{ image }}` for `og:image`
+            * `{{ image_secure_url }}` for `og:image:secure_url`
+            * `{{ image_type }}` for `og:image:type`
+            * `{{ image_width }}` for `og:image:width`
+            * `{{ image_height }}` for `og:image:height`
+            * `{{ image_alt }}` for `og:image:alt`
+        * video
+            * `{{ video }}` for `og:video`
+            * `{{ video_secure_url }}` for `og:video:secure_url`
+            * `{{ video_type }}` for `og:video:type`
+            * `{{ video_width }}` for `og:video:width`
+            * `{{ video_height }}` for `og:video:height`
+        * audio
+            * `{{ audio }}` for `og:audio`
+            * `{{ audio_secure_url }}` for `og:audio:secure_url`
+            * `{{ audio_type }}` for `og:audio:type`
+    * non og metadata
+        * `{{ domain }}`
 
 ### Template for pages where Open Graph protocol metadata does not exist
 
 1. Place `linkpreview_nog.html` file inside `_includes/` folder of your Jekyll site (`_includes/linkpreview_nog.html`)
-   * The folder is the same one you would store files for use with `{% include fragment.html %}` tag.
-     Therefore, it *must* be under the [site's source](https://jekyllrb.com/docs/configuration/options/).
-
- 2. Use built-in variables to extract data which you would like to render. Available variables are:
-  * **link_url** i.e. `{{ link_url }}`
-  * **link_title** i.e. `{{ link_title }}`
-  * **link_description** i.e. `{{ link_description }}`
-  * **link_domain** i.e. `{{ link_domain }}`
+    * The folder is the same one you would store files for use with `{% include fragment.html %}` tag.
+      Therefore, it *must* be under the [site's source](https://jekyllrb.com/docs/configuration/options/).
+
+2. Use built-in variables to extract data which you would like to render. Available variables are:
+    * `{{ title }}`
+    * `{{ url }}`
+    * `{{ description }}`
+    * `{{ domain }}`
 
 ## Development
 

data/jekyll-linkpreview.gemspec

@@ -24,6 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-parameterized", "~> 0.5.2"
-  spec.add_development_dependency "appraisal", "~> 2.2.0"
   spec.add_development_dependency "wwtd", "~> 1.4.1"
 end

data/lib/jekyll-linkpreview/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Linkpreview
-    VERSION = "0.6.0.rc1"
+    VERSION = "0.7.0"
   end
 end

data/lib/jekyll-linkpreview.rb

@@ -7,61 +7,81 @@ require "jekyll-linkpreview/version"
 
 module Jekyll
   module Linkpreview
-    class OpenGraphProperties
-      @@template_file = 'linkpreview.html'
-
-      def initialize(title, url, image, description, domain)
-        @title = title
-        @url = url
-        @image = image
-        @description = description
-        @domain = domain
+    class Properties
+      def initialize(properties, template_file)
+        @properties = properties
+        @template_file = template_file
       end
 
       def to_hash()
-        {
-          'title' => @title,
-          'url' => @url,
-          'image' => @image,
-          'description' => @description,
-          'domain' => @domain,
-        }
+        @properties
       end
 
       def to_hash_for_custom_template()
-        {
-          'link_title' => @title,
-          'link_url' => @url,
-          'link_image' => @image,
-          'link_description' => @description,
-          'link_domain' => @domain
+        hash_for_custom_template = {}
+        @properties.each{ |key, value|
+          hash_for_custom_template[key] = value
+          # NOTE: 'link_*' variables will be deleted in v1.0.0.
+          hash_for_custom_template['link_' + key] = value
         }
+        hash_for_custom_template
       end
 
       def template_file()
-        @@template_file
+        @template_file
       end
     end
 
     class OpenGraphPropertiesFactory
+      @@template_file = 'linkpreview.html'
+
+      def self.template_file
+        @@template_file
+      end
+
       def from_page(page)
-        og_properties = page.meta_tags['property']
-        image_url = get_og_property(og_properties, 'og:image')
-        title = get_og_property(og_properties, 'og:title')
-        url = get_og_property(og_properties, 'og:url')
-        image = convert_to_absolute_url(image_url, page.root_url)
-        description = get_og_property(og_properties, 'og:description')
-        domain = page.host
-        OpenGraphProperties.new(title, url, image, description, domain)
+        properties = page.meta_tags['property']
+        og_properties = {
+          # basic metadata (https://ogp.me/#metadata)
+          'title' => get_property(properties, 'og:title'),
+          'type' => get_property(properties, 'og:type'),
+          'url' => get_property(properties, 'og:url'),
+          'image' => convert_to_absolute_url(get_property(properties, 'og:image'), page.root_url),
+          # optional metadata (https://ogp.me/#optional)
+          ## image
+          'image_secure_url' => convert_to_absolute_url(get_property(properties, 'og:image:secure_url'), page.root_url),
+          'image_type' => get_property(properties, 'og:image:type'),
+          'image_width' => get_property(properties, 'og:image:width'),
+          'image_height' => get_property(properties, 'og:image:height'),
+          'image_alt' => get_property(properties, 'og:image:alt'),
+          ## video
+          'video' => convert_to_absolute_url(get_property(properties, 'og:video'), page.root_url),
+          'video_secure_url' => convert_to_absolute_url(get_property(properties, 'og:video:secure_url'), page.root_url),
+          'video_type' => get_property(properties, 'og:video:type'),
+          'video_width' => get_property(properties, 'og:video:width'),
+          'video_height' => get_property(properties, 'og:video:height'),
+          ## audio
+          'audio' => convert_to_absolute_url(get_property(properties, 'og:audio'), page.root_url),
+          'audio_secure_url' => convert_to_absolute_url(get_property(properties, 'og:audio:secure_url'), page.root_url),
+          'audio_type' => get_property(properties, 'og:audio:type'),
+          ## other optional metadata
+          'description' => get_property(properties, 'og:description'),
+          'determiner' => get_property(properties, 'og:determiner'),
+          'locale' => get_property(properties, 'og:locale'),
+          'locale_alternate' => get_property(properties, 'og:locale:alternate'),
+          'site_name' => get_property(properties, 'og:site_name'),
+          # not defined in OGP
+          'domain' => page.host,
+        }
+        Properties.new(og_properties, @@template_file)
       end
 
       def from_hash(hash)
-        OpenGraphProperties.new(
-          hash['title'], hash['url'], hash['image'], hash['description'], hash['domain'])
+        Properties.new(hash, @@template_file)
       end
 
       private
-      def get_og_property(properties, key)
+      def get_property(properties, key)
         if !properties.key? key then
           return nil
         end
@@ -81,57 +101,24 @@ module Jekyll
       end
     end
 
-    class NonOpenGraphProperties
+    class NonOpenGraphPropertiesFactory
       @@template_file = 'linkpreview_nog.html'
 
-      def initialize(title, url, description, domain)
-        @title = title
-        @url = url
-        @description = description
-        @domain = domain
-      end
-
-      def to_hash()
-        {
-          'title' => @title,
-          'url' => @url,
-          'description' => @description,
-          'domain' => @domain,
-        }
-      end
-
-      def to_hash_for_custom_template()
-        {
-          'link_title' => @title,
-          'link_url' => @url,
-          'link_description' => @description,
-          'link_domain' => @domain
-        }
-      end
-
-      def template_file()
+      def self.template_file
         @@template_file
       end
-    end
 
-    class NonOpenGraphPropertiesFactory
       def from_page(page)
-        NonOpenGraphProperties.new(
-          page.title, page.url, get_description(page), page.host)
+        Properties.new({
+          'title' => page.best_title,
+          'url' => page.url,
+          'description' => page.best_description,
+          'domain' => page.host,
+        }, @@template_file)
       end
 
       def from_hash(hash)
-        NonOpenGraphProperties.new(
-          hash['title'], hash['url'], hash['description'], hash['domain'])
-      end
-
-      private
-      def get_description(page)
-        if !page.parsed.xpath('//p[normalize-space()]').empty? then
-          return page.parsed.xpath('//p[normalize-space()]').map(&:text).first[0..180] + "..."
-        else
-          return "..."
-        end
+        Properties.new(hash, @@template_file)
       end
     end
 
@@ -158,7 +145,7 @@ module Jekyll
         end
         page = fetch(url)
         properties = create_properties_from_page(page)
-        if Dir.exists?(@@cache_dir) then
+        if Dir.exist?(@@cache_dir) then
           save_cache_file(cache_filepath, properties)
         else
           # TODO: This message will be shown at all linkprevew tag
@@ -189,7 +176,9 @@ module Jekyll
 
       private
       def create_properties_from_page(page)
-        if page.meta_tags['property'].empty? then
+        if !%w[og:title og:type og:url og:image].all? { |required_tag|
+          page.meta_tags['property'].include?(required_tag)
+        }
           factory = NonOpenGraphPropertiesFactory.new
         else
           factory = OpenGraphPropertiesFactory.new
@@ -239,16 +228,15 @@ module Jekyll
         image_html = ""
         if image then
           image_html = <<-EOS
-<div class="jekyll-linkpreview-image">
-  <a href="#{url}" target="_blank">
-    <img src="#{image}" />
-  </a>
-</div>
+      <div class="jekyll-linkpreview-image">
+        <a href="#{url}" target="_blank">
+          <img src="#{image}" />
+        </a>
+      </div>
 EOS
         end
         html = <<-EOS
 <div class="jekyll-linkpreview-wrapper">
-  <p><a href="#{url}" target="_blank">#{url}</a></p>
   <div class="jekyll-linkpreview-wrapper-inner">
     <div class="jekyll-linkpreview-content">
 #{image_html}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linkpreview
 version: !ruby/object:Gem::Version
-  version: 0.6.0.rc1
+  version: 0.7.0
 platform: ruby
 authors:
 - Yusuke Nishioka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -100,20 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.2
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: wwtd
   requirement: !ruby/object:Gem::Requirement
@@ -166,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.26
 signing_key: