jekyll-pdf-thumbnail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f7bf101fc85d603f19be64eb90a542d164e64fe9428169113dbbb57742c9f91
+  data.tar.gz: ed78e574d487215b44672ca301c59e26b0741f38f0da5e71f0f82e7a1e04d9eb
+SHA512:
+  metadata.gz: cccb40e7c9b65f44697863c55700474ab1993d4752377579e731fd6f4c0c62803a60066fcac7bb487a74df885e0efa2977e0dc6fe52bb090d0aeb676a7cb2db8
+  data.tar.gz: e3072a706e5a0620a66920a2c95b845541ed3ece2f9a60ec7ff77ed2192c442355c974abf71fe7f361ef5dd444309487c0d1d72f2f405f4b54dd890df652948b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2004 Noe Nieto<nnieto@noenieto.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Jekyll PDF thumbnails generator
+
+A Jekyll plugin to generate thumbnails for all PDF files.
+
+
+## Usage
+
+1. Add the following to your site's Gemfile:
+
+  ```ruby
+  gem 'jekyll-pdf-thumbnail'
+  ```
+
+2. Add the following to your site's config file:
+
+  ```yml
+  plugins:
+    - jekyll-pdf-thumbnail
+  ```
+
+3. Use it in your `.md` files and liquid templates. Example markdown file:
+
+```md
+    ---
+    title: Homepage
+    layout: null
+    pdf_file: /assets/sample_1.pdf
+    ---
+    # {{ page.title }}
+
+    {% assign other_pdf = 'sample_2.pdf' %}
+
+    - This is a link to [{{page.pdf_file}}]({{page.pdf_file | absolute_url}})
+    - This is a preview of ![sample_1.pdf]({{ page.pdf_file| pdf_thumbnail }})
+    - This is a link to [sample_2.pdf]({{other_pdf | absolute_url }})
+    - This is a preview of ![sample_2.pdf]({{ other_pdf | pdf_thumbnail }})
+```
+

data/lib/jekyll-pdf-thumbnail.rb

@@ -0,0 +1,78 @@
+require 'pdftoimage'
+require 'jekyll'
+require "digest"
+
+
+
+module PDFThumbnail
+  CACHE_DIR = "/assets/pdf_thumbnails/"
+  HASH_LENGTH = 32
+
+  def _dest_filename(src_path)
+    # Generates a thumbnail name using the SHA256 digest of the PDF file
+    #
+    # Example:
+    #   >> _dest_filename("sample_1.pdf")
+    #   => a35383ccca791ba6aa67ab3acde65287.png
+    #
+    # Arguments:
+    #   src_path: (String)
+    hash = Digest::SHA256.file(src_path)
+    short_hash = hash.hexdigest()[0, HASH_LENGTH]
+    "#{short_hash}.png"
+  end
+
+  def _must_create?(src_path, dest_path)
+    # Returns true if dest_path doesn't exists or src_path is newer than dest_path
+    !File.exist?(dest_path) || File.mtime(dest_path) <= File.mtime(src_path)
+  end
+
+
+  # The PDF thumbnail generator
+  class Generator < Jekyll::Generator
+    include PDFThumbnail
+    def generate(site)
+      # Ensure the cache dir exists
+      full_cache_path = File.join(site.source, CACHE_DIR)
+      FileUtils.mkdir_p(full_cache_path)
+
+      site.static_files.each do |static_file|
+        if static_file.extname.downcase == ".pdf"
+          full_pdf_path = File.join(site.source, static_file.relative_path)
+          thumb = _dest_filename(full_pdf_path)
+          full_thumb_path = File.join(full_cache_path, thumb)
+          rel_thumb_path = File.join(CACHE_DIR, thumb)
+          if _must_create?(full_pdf_path, full_thumb_path)
+            puts "Creating thumbnail of' #{static_file.relative_path}' to '#{rel_thumb_path}'"
+            PDFToImage.open(full_pdf_path).first.resize('50%').save(full_thumb_path)
+            site.static_files << Jekyll::StaticFile.new(site, site.source, CACHE_DIR, thumb)
+          end
+        end
+      end
+    end
+  end
+
+  module Filters
+    include PDFThumbnail
+
+    def pdf_thumbnail(pdf)
+      # Returns the thumbnail path for a given pdf file.
+      # Example:
+      #   >> pdf_thumbnail "/path/to/sample_1.pdf"
+      #   => /assets/pdf_thumbnails/a35383ccca791ba6aa67ab3acde65287.png
+      #
+      # Or as a liquid filter:
+      #  {% assign my_pdf = 'sample_2.pdf' %}
+      #  {{ my_pdf | pdf_preview }}
+      #
+      # Arguments:
+      #   pdf: (String)
+      site = @context.registers[:site]
+      full_pdf_path = File.join(site.source, pdf)
+      File.join(CACHE_DIR, _dest_filename(full_pdf_path))
+    end
+  end
+
+end
+
+Liquid::Template.register_filter(PDFThumbnail::Filters)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pdf-thumbnail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noe Nieto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pdftoimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: This plugin generates thumbnails for each PDF in your site using the
+  pdftoimage gem
+email: nnieto@noenieto.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-pdf-thumbnail.rb
+homepage: https://rubygems.org/gems/jekyll-pdf-thumbnail
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Generates PNG thumbnails of your PDFs
+test_files: []