jekyll-linkpreview 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 597a9685dd537f7fddef541e75b596cdcda260cc
-  data.tar.gz: f4a9201088c0881410bf7e87d3963f04e9942de5
+SHA256:
+  metadata.gz: 3984e2c6d457274fc633918eaca10fe60d9ea2c38fe04a7c79ff40964b95ea82
+  data.tar.gz: ba8cdb6e832ac5fd46d5102ebe630b723a841708628f9c691ef43d078076ed42
 SHA512:
-  metadata.gz: e9affa10e185284257a77d68d44736f8c3f0f0d9a324aa4578fdb7fc454504dad883f69b0b2875ef5cdbd0766768709dc0c81a140b219c88bd607714cd1bbe9e
-  data.tar.gz: bd20c259e0becb55c2976f384f1e220b835e53778b7edc1a0382e37ccf49e00d6eb0aac38b77a453d9281f3cb11802925ac5095b1aa3a9d14c61e072afecf7db
+  metadata.gz: 2d4fd1726eb2384afb0363d918b6e3e2698577570682df2f289df8fe0bb4e98024154d5266f262fb3248441792ab2c1b27aeb9eb12c4396ee6bd51dc4f4c12a7
+  data.tar.gz: 4a67e9fb18a940ef4f32312d3ea84103fc90751e272a2523ab30fd2ea21a2168260dd8037ae77b35d57b8fd80acff94aaa79c8dd9d51a440bccb448ed220ba0a

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Appraisal
+*.gemfile.lock

data/.travis.yml

@@ -4,4 +4,13 @@ language: ruby
 cache: bundler
 rvm:
   - 2.4.2
+  - 2.7.0
 before_install: gem install bundler -v 2.0.1
+gemfile:
+  - gemfiles/jekyll_3.gemfile
+  - gemfiles/jekyll_4.gemfile
+script: "bundle exec rake test"
+matrix:
+  exclude:
+    - rvm: 2.4.2
+      gemfile: gemfiles/jekyll_4.gemfile

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "jekyll-3" do
+  gem "jekyll", "3.5.0"
+end
+
+appraise "jekyll-4" do
+  gem "jekyll", "4.0.0"
+end

data/Dockerfile

@@ -0,0 +1,4 @@
+FROM ruby:2.6.5
+
+RUN apt-get -y update
+RUN gem install bundler

data/README.md

@@ -1,21 +1,23 @@
 # Jekyll::Linkpreview
 
-Jekyll plugin to generate link preview by `{% linkpreview %}` tag. The plugin fetches [Open Graph protocols](http://ogp.me/) of the designated page to generate preview. The og properties are saved as JSON for caching and it is used when rebuilding the site.
+[![Build Status](https://travis-ci.org/ysk24ok/jekyll-linkpreview.svg?branch=master)](https://travis-ci.org/ysk24ok/jekyll-linkpreview)
 
-You can pass url directly to the tag, 
+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.
+
+You can pass url directly to the tag,
 
 ```
-{% linkpreview https://github.com %}
+{% linkpreview "https://github.com" %}
 ```
 
 or, can pass a url variable.
 
 ```
-{% assign github_toppage = 'https://github.com'%}
+{% assign github_toppage = 'https://github.com' %}
 {% linkpreview github_toppage %}
 ```
 
-The tag above generates following HTML when you run `jekyll build`,
+The tag above generates following HTML when you run `jekyll build`.
 
 ```html
 <div class="jekyll-linkpreview-wrapper">
@@ -41,17 +43,27 @@ The tag above generates following HTML when you run `jekyll build`,
 </div>
 ```
 
-Applying appropriate CSS, the link preview will be like this.
+By applying appropriate CSS, the link preview will be like this.
 
 <img width="613" alt="スクリーンショット 2019-04-03 20 52 50" src="https://user-images.githubusercontent.com/3449164/55479970-35baf100-565a-11e9-8c5d-709213917f74.png">
 
+When the page does not have Open Graph protocol metadata, following simple HTML will be generated.
+
+```html
+<div class="jekyll-linkpreview-wrapper">
+  <p><a href="https://example.com" target="_blank">https://example.com</a></p>
+</div>
+```
+
+You can override the default templates, see [Custom templates](#user-content-custom-templates).
+
 ## Installation
 
 See https://jekyllrb.com/docs/plugins/installation/ .
 
 ## Usage
 
-1. Create `_cache` directory where you run `jekyll build` or `jekyll serve`.
+1. Create `_cache` directory.
 
 1. Embed [linkpreview.css](assets/css/linkpreview.css) into your Website.
 
@@ -59,6 +71,28 @@ See https://jekyllrb.com/docs/plugins/installation/ .
 
 1. Run `jekyll build` or `jekyll serve`.
 
+
+## Custom templates
+
+You can override the default templates used for generating previews, both in case Open Graph protocol metadata exists or does not exist for a given page.
+
+### Template for pages where Open Graph protocol metadata exists
+
+ 1. Place `linkpreview.html` file inside `_includes/` folder of your Jekyll site (`_includes/linkpreview.html`)
+
+ 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 }}`
+
+### 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`)
+
+2. Use built-in **link_url** variable to render URL data, i.e. `{{ link_url }}`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

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

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/jekyll_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.5.0"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "4.0.0"
+
+gemspec path: "../"

data/jekyll-linkpreview.gemspec

@@ -18,9 +18,11 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", "~> 3.5"
+  spec.add_dependency "jekyll", ">= 3.5", "< 4.1"
   spec.add_dependency "metainspector"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.2.0"
+  spec.add_development_dependency "wwtd", "~> 1.4.1"
 end

data/lib/jekyll-linkpreview.rb

@@ -51,7 +51,11 @@ module Jekyll
         if url.nil? then
           return nil
         end
-        url.match(%r{(http|https)://([^/]+).*})[-1]
+        m = url.match(%r{(http|https)://([^/]+).*})
+        if m.nil? then
+          return nil
+        end
+        m[-1]
       end
     end
 
@@ -60,7 +64,7 @@ module Jekyll
 
       def initialize(tag_name, markup, parse_context)
         super
-        @markup = markup.rstrip()
+        @markup = markup.strip()
         @og_properties = OpenGraphProperties.new
       end
 
@@ -71,15 +75,53 @@ module Jekyll
         image       = properties['image']
         description = properties['description']
         domain      = properties['domain']
-        if title.nil? || image.nil? || description.nil? || domain.nil? then
-          html = <<-EOS
-<div class="jekyll-linkpreview-wrapper">
-  <p><a href="#{url}" target="_blank">#{url}</a></p>
-</div>
-          EOS
-          return html
+
+        if title.nil? || image.nil? || domain.nil? then
+          render_linkpreview_nog(context, url)
+        else
+          render_linkpreview_og(context, url, title, image, description, domain)
+        end
+      end
+
+      def get_properties(url)
+        cache_filepath = "#{@@cache_dir}/%s.json" % Digest::MD5.hexdigest(url)
+        if File.exist?(cache_filepath) then
+          return load_cache_file(cache_filepath)
+        end
+        properties = @og_properties.get(url)
+        if Dir.exists?(@@cache_dir) then
+          save_cache_file(cache_filepath, properties)
+        else
+          # TODO: This message will be shown at all linkprevew tag
+          warn "'#{@@cache_dir}' directory does not exist. Create it for caching."
         end
-        html = <<-EOS
+        properties
+      end
+
+      private
+      def get_url_from(context)
+        context[@markup]
+      end
+
+      private
+      def load_cache_file(filepath)
+        JSON.parse(File.open(filepath).read)
+      end
+
+      protected
+      def save_cache_file(filepath, properties)
+        File.open(filepath, 'w') { |f| f.write JSON.generate(properties) }
+      end
+
+      private
+      def render_linkpreview_og(context, url, title, image, description, domain)
+        template_path = get_linkpreview_og_template()
+        if File.exist?(template_path)
+          template_file = File.read template_path
+          site = context.registers[:site]
+          template_file = (Liquid::Template.parse template_file).render site.site_payload.merge!({"link_url" => url, "link_title" => title, "link_image" => image, "link_description" => description, "link_domain" => domain})
+        else
+          html = <<-EOS
 <div class="jekyll-linkpreview-wrapper">
   <p><a href="#{url}" target="_blank">#{url}</a></p>
   <div class="jekyll-linkpreview-wrapper-inner">
@@ -101,38 +143,36 @@ module Jekyll
     </div>
   </div>
 </div>
-        EOS
-        html
+EOS
+          html
+        end
       end
 
-      def get_properties(url)
-        cache_filepath = "#{@@cache_dir}/%s.json" % Digest::MD5.hexdigest(url)
-        if File.exist?(cache_filepath) then
-          return load_cache_file(cache_filepath)
-        end
-        properties = @og_properties.get(url)
-        if Dir.exists?(@@cache_dir) then
-          save_cache_file(cache_filepath, properties)
+      private
+      def render_linkpreview_nog(context, url)
+        template_path = get_linkpreview_nog_template()
+        if File.exist?(template_path)
+          template_file = File.read template_path
+          site = context.registers[:site]
+          template_file = (Liquid::Template.parse template_file).render site.site_payload.merge!({"link_url" => url})
         else
-          # TODO: This message will be shown at all linkprevew tag
-          warn "'#{@@cache_dir}' directory does not exist. Create it for caching."
+          html = <<-EOS
+<div class="jekyll-linkpreview-wrapper">
+  <p><a href="#{url}" target="_blank">#{url}</a></p>
+</div>
+          EOS
+          html
         end
-        properties
       end
 
       private
-      def get_url_from(context)
-        context.scopes[0].key?(@markup) ? context.scopes[0][@markup] : @markup
+      def get_linkpreview_og_template()
+        File.join Dir.pwd, "_includes", "linkpreview.html"
       end
 
       private
-      def load_cache_file(filepath)
-        JSON.parse(File.open(filepath).read)
-      end
-
-      protected
-      def save_cache_file(filepath, properties)
-        File.open(filepath, 'w').write(JSON.generate(properties))
+      def get_linkpreview_nog_template()
+        File.join Dir.pwd, "_includes", "linkpreview_nog.html"
       end
     end
   end

data/lib/jekyll-linkpreview/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Linkpreview
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linkpreview
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yusuke Nishioka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: metainspector
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +86,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 description: 
 email:
 - yusuke.nishioka.0713@gmail.com
@@ -90,6 +124,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,6 +133,9 @@ files:
 - assets/css/linkpreview.css
 - bin/console
 - bin/setup
+- gemfiles/.bundle/config
+- gemfiles/jekyll_3.gemfile
+- gemfiles/jekyll_4.gemfile
 - jekyll-linkpreview.gemspec
 - lib/jekyll-linkpreview.rb
 - lib/jekyll-linkpreview/version.rb
@@ -119,8 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll tag plugin to generate link preview