jekyll-pdf-thumbnail 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f7bf101fc85d603f19be64eb90a542d164e64fe9428169113dbbb57742c9f91
-  data.tar.gz: ed78e574d487215b44672ca301c59e26b0741f38f0da5e71f0f82e7a1e04d9eb
+  metadata.gz: 6aa634af38ffa22e2b31b0710d02544aeb1448ba322861049f3df1a1caf71999
+  data.tar.gz: a29926988e56c70194d8f3822ff282c02444665dff20123aab60cec16f2b9295
 SHA512:
-  metadata.gz: cccb40e7c9b65f44697863c55700474ab1993d4752377579e731fd6f4c0c62803a60066fcac7bb487a74df885e0efa2977e0dc6fe52bb090d0aeb676a7cb2db8
-  data.tar.gz: e3072a706e5a0620a66920a2c95b845541ed3ece2f9a60ec7ff77ed2192c442355c974abf71fe7f361ef5dd444309487c0d1d72f2f405f4b54dd890df652948b
+  metadata.gz: 2a0be4b925cf86697ba75aad72c448ad35bd20c28c861e3154e34f0deb0382e20a3d9f81c315160205e1f2f8acf6c679426c7e9889d6eabfea9fbb380a0ee94d
+  data.tar.gz: c63da7b588b7279ce58ad7c486d2a565d38cb03e4b479618acb9612f4c05a44da36df524b8434004900080ee43eb30c09620ce25cda4ed6c4f53357295efd54b

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll PDF thumbnails generator
 
-A Jekyll plugin to generate thumbnails for all PDF files.
+A Jekyll plugin to generate thumbnails for your PDF files
 
 
 ## Usage
@@ -20,7 +20,7 @@ A Jekyll plugin to generate thumbnails for all PDF files.
 
 3. Use it in your `.md` files and liquid templates. Example markdown file:
 
-```md
+```markdown
     ---
     title: Homepage
     layout: null
@@ -34,5 +34,25 @@ A Jekyll plugin to generate thumbnails for all PDF files.
     - 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 }})
+    - 50% resize: {{page.pdf_file | pdf_thumbnail: resize:'50%' }}
+    - 25% resize: {{page.pdf_file | pdf_thumbnail: resize:'25%' }}
+    - 25% resize, 50% quality: {{page.pdf_file | pdf_thumbnail: resize:'25%', quality:'50'}}
 ```
 
+- The format of the `resize` parameter is the **image geometry** as defined in the [ImageMagick manual](https://imagemagick.org/script/command-line-processing.php#geometry).
+- The format of the `quality` parameter is a number between 1 and 100 as defined in the [Image Magick manual](https://imagemagick.org/script/command-line-options.php#quality). Currently, only png thumbnails are supported. According to the manual: 
+  > ... the quality value sets the zlib compression level (quality / 10) and filter-type (quality % 10). The default PNG "quality" is 75, which means compression level 7 with adaptive PNG filtering, unless the image has a color map, in which case it means compression level 7 with no PNG filtering.
+
+## Developing this extension
+
+- **Setup**: Clone the extension and execute `bundle install` to install the dependencies
+- **Run tests**: ``bundle exec rspec``
+- **Releasing a new version**
+  - Update [jekyll-pdf-thumbnail.gemspec](jekyll-pdf-thumbnail.gemspec) with new version and metadata.
+  - Commit your changes.
+  - Create a new git tag:  `git tag -a vx.y.z -m "Version x.y.z"`
+  - Push all the changes to github: `git push origin && git push origin --tags`
+  - Build the Gem: ``gem build``
+  - Upload the new gem: ``gem push jekyll-pdf-thumbnail-x.y.z.gem``
+
+

data/lib/jekyll-pdf-thumbnail.rb

@@ -3,12 +3,23 @@ require 'jekyll'
 require "digest"
 
 
-
 module PDFThumbnail
+
+
   CACHE_DIR = "/assets/pdf_thumbnails/"
   HASH_LENGTH = 32
+  @@cache_dir_present = false
+
+  def _get_cache_dir(site)
+    full_cache_dir = File.join(site.source, CACHE_DIR)
+    if not @@cache_dir_present
+      FileUtils.mkdir_p(full_cache_dir)
+      @@cache_dir_present = true
+    end
+    full_cache_dir
+  end
 
-  def _dest_filename(src_path)
+  def _dest_filename(src_path, resize, quality)
     # Generates a thumbnail name using the SHA256 digest of the PDF file
     #
     # Example:
@@ -17,9 +28,20 @@ module PDFThumbnail
     #
     # Arguments:
     #   src_path: (String)
+    #   resize: (String) as used in the -resize parameter of convert
+    #   quality: (String) as used in the -quality parameter of convert
     hash = Digest::SHA256.file(src_path)
     short_hash = hash.hexdigest()[0, HASH_LENGTH]
-    "#{short_hash}.png"
+    basename = short_hash
+    if resize
+      cleaned = resize.gsub(/[^\da-z]+/i, "")
+      basename << "_r#{cleaned}"
+    end
+    if quality
+      cleaned = quality.gsub(/[^\da-z]+/i, "")
+      basename << "_q#{cleaned}"
+    end
+    basename << ".png"
   end
 
   def _must_create?(src_path, dest_path)
@@ -27,35 +49,16 @@ module PDFThumbnail
     !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
+  def generate_thumbnail(pdf, thumbnail, resize='50%', quality="80%")
+    first = PDFToImage.open(pdf).first
+    first.args << "-thumbnail #{resize}"
+    first.save(thumbnail)
   end
 
   module Filters
     include PDFThumbnail
 
-    def pdf_thumbnail(pdf)
+    def pdf_thumbnail(pdf, args=nil)
       # Returns the thumbnail path for a given pdf file.
       # Example:
       #   >> pdf_thumbnail "/path/to/sample_1.pdf"
@@ -67,9 +70,28 @@ module PDFThumbnail
       #
       # Arguments:
       #   pdf: (String)
+      #   args: a dict that can contain "resize" and "quality"
+      if args == nil
+        args = {"resize"=> "50%", "quality": '80%'}
+      end
+      resize = args.fetch("resize", "50%")
+      quality = args.fetch("quality", "80%")
       site = @context.registers[:site]
+      full_cache_dir = _get_cache_dir(site)
       full_pdf_path = File.join(site.source, pdf)
-      File.join(CACHE_DIR, _dest_filename(full_pdf_path))
+      thumbnail = _dest_filename(full_pdf_path, resize, quality)
+      rel_thumb_path = File.join(CACHE_DIR, thumbnail)
+      full_thumb_path = File.join(_get_cache_dir(site), thumbnail)
+      if _must_create?(full_pdf_path, full_thumb_path)
+        puts "Creating thumbnail of' #{pdf}' to '#{rel_thumb_path}'"
+        generate_thumbnail(full_pdf_path, full_thumb_path, resize, quality)
+        # site - The Site.
+        # base - The String path to the <source>.
+        # dir - The String path between <source> and the file.
+        # name - The String filename of the file.
+        site.static_files << Jekyll::StaticFile.new(site, site.source, CACHE_DIR, thumbnail)
+      end
+      rel_thumb_path
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pdf-thumbnail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Noe Nieto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pdftoimage
@@ -72,26 +72,6 @@ dependencies:
     - - "~>"
       - !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