jekyll-linkpreview 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587ad3275fda0960afb88ac33ce812ef44c58350a3b8458c84af9373e053337a
-  data.tar.gz: 0c2ddddee8609c2948ec6e2c3e82ca98064e4687d0117fe833ce78d01329224b
+  metadata.gz: d55e7758cdacbdcbd976a0669efd3f4210a77e02f3ac6fa5e1518d8d1ee863e7
+  data.tar.gz: 6ca1a338b6bdc68e3a769b5c6c071a91a1dbaa909fdf86f4e1a41707b2edf043
 SHA512:
-  metadata.gz: 412a6fa311be2724bb3161a8fc41bdd15a576e926c586cbdbe4790d118e279238575618d1641ad435f56fe56f56e9dfbe105c137c83e72b09501c1112bc7a927
-  data.tar.gz: 6f962a6f0ac52e9615b873922bc483b45b07ced265e365b742d383432af68eb8327535e54c6c127f5fc01331ea38e39aefff8ec695fe551e59e7e986cca1fce3
+  metadata.gz: 8390070dc663f7f5a07d5e13c8b6e804a6e6649f1de07bf1443f054048858a8ccad6a6eff970a706c87a71baf3e2a9efc57e750bb82d596defaadc310fbd2719
+  data.tar.gz: ae3b069df61e1b9d151a56d20054ab67b910a3965c76265f7f8f3626e0b7c8a88b91bf56db20cd7d0468a5b46d77c52c28bf51a5860dd2e756355354167f571c

data/.gitignore

@@ -12,3 +12,5 @@
 
 # Appraisal
 *.gemfile.lock
+Gemfile.lock
+vendor/

data/Dockerfile

@@ -1,4 +1,14 @@
 FROM ruby:2.6.5
 
-RUN apt-get -y update
-RUN gem install jekyll bundler
+RUN apt update \
+ && apt install -y \
+    vim \
+ && rm -rf /var/lib/apt/lists/*
+RUN gem install \
+    bundler \
+    jekyll
+RUN mkdir /jekyll-linkpreview
+ADD Gemfile /jekyll-linkpreview
+ADD jekyll-linkpreview.gemspec /jekyll-linkpreview
+ADD lib/jekyll-linkpreview/version.rb /jekyll-linkpreview/lib/jekyll-linkpreview/version.rb
+RUN cd /jekyll-linkpreview && bundle install

data/README.md

@@ -1,59 +1,29 @@
 # Jekyll::Linkpreview
 
-[![Build Status](https://travis-ci.org/ysk24ok/jekyll-linkpreview.svg?branch=master)](https://travis-ci.org/ysk24ok/jekyll-linkpreview)
+[![Build Status](https://travis-ci.com/ysk24ok/jekyll-linkpreview.svg?branch=master)](https://travis-ci.com/ysk24ok/jekyll-linkpreview)
 
 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/ysk24ok/jekyll-linkpreview" %}
 ```
 
 or, can pass a url variable.
 
 ```
-{% assign github_toppage = 'https://github.com' %}
-{% linkpreview github_toppage %}
+{% assign jekyll_linkpreview_page = "https://github.com/ysk24ok/jekyll-linkpreview" %}
+{% linkpreview jekyll_linkpreview_page %}
 ```
 
-The tag above generates following HTML when you run `jekyll build`.
-
-```html
-<div class="jekyll-linkpreview-wrapper">
-  <p><a href="https://github.com" target="_blank">https://github.com</a></p>
-  <div class="jekyll-linkpreview-wrapper-inner">
-    <div class="jekyll-linkpreview-content">
-      <div class="jekyll-linkpreview-image">
-        <a href="https://github.com" target="_blank">
-          <img src="https://github.githubassets.com/images/modules/open_graph/github-logo.png" />
-        </a>
-      </div>
-      <div class="jekyll-linkpreview-body">
-        <h2 class="jekyll-linkpreview-title">
-          <a href="https://github.com" target="_blank">Build software better, together</a>
-        </h2>
-        <div class="jekyll-linkpreview-description">GitHub is where people build software. More than 31 million people use GitHub to discover, fork, and contribute to over 100 million projects.</div>
-      </div>
-    </div>
-    <div class="jekyll-linkpreview-footer">
-      <a href="https://github.com" target="_blank">github.com</a>
-    </div>
-  </div>
-</div>
-```
-
-By applying appropriate CSS, the link preview will be like this.
+By applying [linkpreview.css](assets/css/linkpreview.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">
+<img width="613" alt="スクリーンショット 2020-10-26 19 10 26" src="https://user-images.githubusercontent.com/3449164/97160548-db472f80-17bf-11eb-9cc2-383a076fb14d.png">
 
-When the page does not have Open Graph protocol metadata, following simple HTML will be generated.
+When the page does not have Open Graph protocol metadata, the preview will be like this.
 
-```html
-<div class="jekyll-linkpreview-wrapper">
-  <p><a href="https://example.com" target="_blank">https://example.com</a></p>
-</div>
-```
+<img width="613" alt="スクリーンショット 2020-10-26 19 10 35" src="https://user-images.githubusercontent.com/3449164/97160564-e00be380-17bf-11eb-8adb-55c2a07520f1.png">
 
 You can override the default templates, see [Custom templates](#user-content-custom-templates).
 
@@ -91,7 +61,11 @@ You can override the default templates used for generating previews, both in cas
 
 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 }}`
+ 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 }}`
 
 ## Development
 
@@ -99,6 +73,39 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Test with Jekyll site
+
+First, build a Docker image and run a container.
+
+```console
+$ docker build --no-cache -t jekyll_linkpreview_dev .
+$ docker run --rm -it -w /jekyll-linkpreview -p 4000:4000 jekyll_linkpreview_dev /bin/bash
+```
+
+Create a new Jekyll site and move into the new directory.
+
+```console
+# bundle exec jekyll new testsite && cd testsite
+```
+
+Add this line to `:jekyll_plugins` group of Gemfile.
+
+```console
+gem "jekyll-linkpreview", git: "https://github.com/YOUR_ACCOUNT/jekyll-linkpreview", branch: "YOUR_BRANCH"
+```
+
+Install the dependecies to your new site.
+
+```console
+# bundle install
+```
+
+Add a tag such as `{% linkpreview "https://github.com/ysk24ok/jekyll-linkpreview" %}` to `index.markdown` , then start a Jekyll server.
+
+```console
+# bundle exec jekyll serve --host 0.0.0.0
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ysk24ok/jekyll-linkpreview.

data/assets/css/linkpreview.css

@@ -30,6 +30,10 @@
   margin-right: 110px;
 }
 
+.jekyll-linkpreview-body-nog {
+  margin-right: 10px;
+}
+
 .jekyll-linkpreview-title {
   font-size: 17px;
   margin: 0 0 2px;

data/lib/jekyll-linkpreview.rb

@@ -1,5 +1,6 @@
 require "digest"
 require "json"
+require 'uri'
 
 require "metainspector"
 require "jekyll-linkpreview/version"
@@ -7,31 +8,64 @@ require "jekyll-linkpreview/version"
 module Jekyll
   module Linkpreview
     class OpenGraphProperties
-      def get(url)
-        og_properties = fetch(url)
-        og_url = get_og_property(og_properties, 'og:url')
-        domain = extract_domain(og_url)
-        image_url = get_og_property(og_properties, 'og:image')
+      @@template_file = 'linkpreview.html'
+
+      def initialize(title, url, image, description, domain)
+        @title = title
+        @url = url
+        @image = image
+        @description = description
+        @domain = domain
+      end
+
+      def to_hash()
         {
-          'title'       => get_og_property(og_properties, 'og:title'),
-          'url'         => og_url,
-          'image'       => convert_to_absolute_url(image_url, domain),
-          'description' => get_og_property(og_properties, 'og:description'),
-          'domain'      => domain
+          'title' => @title,
+          'url' => @url,
+          'image' => @image,
+          'description' => @description,
+          'domain' => @domain,
         }
       end
 
+      def to_hash_for_custom_template()
+        {
+          'link_title' => @title,
+          'link_url' => @url,
+          'link_image' => @image,
+          'link_description' => @description,
+          'link_domain' => @domain
+        }
+      end
+
+      def template_file()
+        @@template_file
+      end
+    end
+
+    class OpenGraphPropertiesFactory
+      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)
+      end
+
+      def from_hash(hash)
+        OpenGraphProperties.new(
+          hash['title'], hash['url'], hash['image'], hash['description'], hash['domain'])
+      end
+
       private
       def get_og_property(properties, key)
         if !properties.key? key then
           return nil
         end
-        properties[key][0]
-      end
-
-      private
-      def fetch(url)
-        MetaInspector.new(url).meta_tags['property']
+        properties[key].first
       end
 
       private
@@ -41,54 +75,89 @@ module Jekyll
         end
         # root relative url
         if url[0] == '/' then
-          return "//#{domain}#{url}"
+          return URI.join(domain, url).to_s
         end
         url
       end
+    end
+
+    class NonOpenGraphProperties
+      @@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()
+        @@template_file
+      end
+    end
+
+    class NonOpenGraphPropertiesFactory
+      def from_page(page)
+        NonOpenGraphProperties.new(
+          page.title, page.url, get_description(page), page.host)
+      end
+
+      def from_hash(hash)
+        NonOpenGraphProperties.new(
+          hash['title'], hash['url'], hash['description'], hash['domain'])
+      end
 
       private
-      def extract_domain(url)
-        if url.nil? then
-          return nil
-        end
-        m = url.match(%r{(http|https)://([^/]+).*})
-        if m.nil? then
-          return nil
+      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
-        m[-1]
       end
     end
 
     class LinkpreviewTag < Liquid::Tag
       @@cache_dir = '_cache'
+      @@template_dir = '_includes'
 
       def initialize(tag_name, markup, parse_context)
         super
         @markup = markup.strip()
-        @og_properties = OpenGraphProperties.new
       end
 
       def render(context)
         url = get_url_from(context)
         properties = get_properties(url)
-        title       = properties['title']
-        image       = properties['image']
-        description = properties['description']
-        domain      = properties['domain']
-
-        if title.nil? || image.nil? || domain.nil? then
-          render_linkpreview_nog(context, url)
-        else
-          render_linkpreview_og(context, url, title, image, description, domain)
-        end
+        render_linkpreview properties
       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)
+          hash = load_cache_file(cache_filepath)
+          return create_properties_from_hash(hash)
         end
-        properties = @og_properties.get(url)
+        page = fetch(url)
+        properties = create_properties_from_page(page)
         if Dir.exists?(@@cache_dir) then
           save_cache_file(cache_filepath, properties)
         else
@@ -103,6 +172,11 @@ module Jekyll
         context[@markup]
       end
 
+      private
+      def fetch(url)
+        MetaInspector.new(url)
+      end
+
       private
       def load_cache_file(filepath)
         JSON.parse(File.open(filepath).read)
@@ -110,27 +184,68 @@ module Jekyll
 
       protected
       def save_cache_file(filepath, properties)
-        File.open(filepath, 'w') { |f| f.write JSON.generate(properties) }
+        File.open(filepath, 'w') { |f| f.write JSON.generate(properties.to_hash) }
       end
 
       private
-      def render_linkpreview_og(context, url, title, image, description, domain)
-        template_path = get_linkpreview_og_template()
+      def create_properties_from_page(page)
+        if page.meta_tags['property'].empty? then
+          factory = NonOpenGraphPropertiesFactory.new
+        else
+          factory = OpenGraphPropertiesFactory.new
+        end
+        factory.from_page(page)
+      end
+
+      private
+      def create_properties_from_hash(hash)
+        if hash['image'] then
+          factory = OpenGraphPropertiesFactory.new
+        else
+          factory = NonOpenGraphPropertiesFactory.new
+        end
+        factory.from_hash(hash)
+      end
+
+      private
+      def render_linkpreview(properties)
+        template_path = get_custom_template_path properties
         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})
+          hash = properties.to_hash_for_custom_template
+          gen_custom_template template_path, hash
         else
-          html = <<-EOS
+          gen_default_template properties.to_hash
+        end
+      end
+
+      private
+      def get_custom_template_path(properties)
+        File.join Dir.pwd, @@template_dir, properties.template_file
+      end
+
+      private
+      def gen_default_template(hash)
+        title = hash['title']
+        url = hash['url']
+        description = hash['description']
+        domain = hash['domain']
+        image = hash['image']
+        image_html = ""
+        if image then
+          image_html = <<-EOS
+<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">
-      <div class="jekyll-linkpreview-image">
-        <a href="#{url}" target="_blank">
-          <img src="#{image}" />
-        </a>
-      </div>
+#{image_html}
       <div class="jekyll-linkpreview-body">
         <h2 class="jekyll-linkpreview-title">
           <a href="#{url}" target="_blank">#{title}</a>
@@ -139,40 +254,18 @@ module Jekyll
       </div>
     </div>
     <div class="jekyll-linkpreview-footer">
-      <a href="//#{domain}" target="_blank">#{domain}</a>
+      <a href="#{domain}" target="_blank">#{domain}</a>
     </div>
   </div>
 </div>
 EOS
-          html
-        end
-      end
-
-      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
-          html = <<-EOS
-<div class="jekyll-linkpreview-wrapper">
-  <p><a href="#{url}" target="_blank">#{url}</a></p>
-</div>
-          EOS
-          html
-        end
-      end
-
-      private
-      def get_linkpreview_og_template()
-        File.join Dir.pwd, "_includes", "linkpreview.html"
+        html
       end
 
       private
-      def get_linkpreview_nog_template()
-        File.join Dir.pwd, "_includes", "linkpreview_nog.html"
+      def gen_custom_template(template_path, hash)
+        template = File.read template_path
+        Liquid::Template.parse(template).render!(hash)
       end
     end
   end

data/lib/jekyll-linkpreview/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Linkpreview
-    VERSION = "0.3.2"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linkpreview
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Yusuke Nishioka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll