jekyll-image-optim 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7e3a1f3f196f12ab47e90b8906d08d53a9c8eef1a17a4621196459d0bd53a23
+  data.tar.gz: 59019ce9484c743d5da45ca74c5c4f190535055053260fa4c47886343df0a531
+SHA512:
+  metadata.gz: efaf08f42010fba69e61c4a098bbfd309c48fbd157ff378f911cb5ca5b050e2a9826b8b8877ae9cb84324da9392887d5a73f677f6785289da4d7f92d5dd49a58
+  data.tar.gz: 4ba4a0aff9454336552b4f98ee46a6e5ef1a2afbf4a1da6f397da468db41a3d2eb62b387a7cbac510d7e92e83fd023556fdd10100057ebe29f740048d1e43f03

data/image_optim.rb

@@ -0,0 +1,101 @@
+require "image_optim"
+require 'yaml'
+
+module Jekyll
+
+  class ImageOptimGenerator < Generator
+    safe true
+
+    ###########################################################################
+    # Entry point for the plugin.
+    def generate(site)
+      # Read configuration. Defaults first, then overrides from _config.yml.
+      config = YAML::load_file "_config.yml"
+      config = config["image_optim"] || {}
+      @config = default_options.merge! config
+
+      # Initialize the ImageOptim library, which does the heavy lifting.
+      @image_optim = ImageOptim.new(
+        {
+          :allow_lossy => true,  #Allow worker, it is always lossy (defaults to false)
+          :svgo => false,
+          :pngout => false,
+          :verbose => false,
+          :pngquant => {:quality => 70..85},  #min..max - don't save below min, use less colors below max (both in range 0..100; in yaml - !ruby/range 0..100), ignored in default/lossless mode (defaults to 100..100, 0..100 in lossy mode)
+          :jpegrecompress => {:quality => 0},   #JPEG quality preset: 0 - low, 1 - medium, 2 - high, 3 - veryhigh (defaults to 3)
+          :jpegoptim => {:max_quality => 50}
+        })
+
+      # Read the cache file, if it exists.
+      @last_update = YAML::load_file @config["cache_file"] if File.file? @config["cache_file"]
+      @last_update ||= {}
+
+      # Create the originals directory.
+      FileUtils.mkdir_p @config["archive_dir"]
+
+      # Iterate over all images, optimizing as necessary.
+      Dir.glob(@config["image_glob"]) { |image| analyze image }
+
+      # Save modifications back to the cache file.
+      File.open(@config["cache_file"], "w") { |file| file.write @last_update.to_yaml }
+    end
+
+    ###########################################################################
+    # Native settings for the plugin.
+    # Override with corresonding entries to _config.yml under "image_optim"
+    #
+    # Example:
+    #
+    #   [_config.yml]
+    #   image_optim:
+    #     archive_dir: "_my_original_images"
+    #     cache_file: "_custom_file.yml"
+    #     image_glob: "webroot/images/*.png"
+    def default_options
+      {
+        # Where do we store archival copies of the originals?
+        "archive_dir" => "_image_optim_archive",
+        # Where do we store our cache file?
+        "cache_file" => "_image_optim_cache.yml",
+        # What images do we search for?
+        "image_glob" => "images/**/*.{gif,jpg,jpeg,png}",
+      }
+    end
+
+    ###########################################################################
+    # Determine whether or not optimization needs to occur.
+    def analyze(image)
+      if @last_update.has_key? image
+        # If we've touched the image before, but it's been modified, optimize.
+        optimize image if @last_update[image] != File.mtime(image)
+      else
+        # If the image is new, optimize.
+        optimize image
+      end
+    end
+
+    ###########################################################################
+    # In-place image optimization per the ImageOptim library.
+    def optimize(image)
+      puts "Optimizing #{image}"
+      FileUtils.copy image, archival_filename(image)
+      @image_optim.optimize_image! image
+      @last_update[image] = File.mtime image
+    end
+
+    ###########################################################################
+    # Adds the date/time of archival as well as the MD5 digest of the original
+    # source file.
+    def archival_filename(image)
+      ext = File.extname(image)
+      "%s/%s-%s-%s%s" % [
+        @config["archive_dir"],
+        File.basename(image, ext),
+        DateTime.now.strftime("%Y-%m-%d-%H-%M-%S"),
+        Digest::MD5.file(image).hexdigest,
+        ext,
+      ]
+    end
+
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-image-optim
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Areeb Khan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: image_optim_pack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Plugin to compress images. Configuration and usage instructions can be
+  found at https://github.com/chrisanthropic/image_optim-jekyll-plugin
+email:
+- areebk@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- image_optim.rb
+homepage: https://github.com/chrisanthropic/image_optim-jekyll-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple Jekyll plugin to optimize images using image_optim
+test_files: []