jekyll-thumb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5782f1e77d7731e352385aa2af92366c76aaf564bbe7c3391d02318548064128
+  data.tar.gz: 06e511b964f7a608461ed16f90ac0c89bcba8ae23703691b513ead2dc5ac19f7
+SHA512:
+  metadata.gz: 1ec16956aa7d0f8768667a675cecd2faccfac76a833ce85a91564fc2b1ae5a53215d1025c37d88c237509e043dd0bd6e1e4f9b9ef625a9b09bf2521ad60505fc
+  data.tar.gz: eb902bc4b38b74a15c26b6c4d2732dbac7b246f8045236f8a25ce36192e4fab79df1ab91c97daa8c9fcadd0522d1a50ac859b9e1ea372dbafe2e6bb3a4537e47

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-thumb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Jonathan Davies
+
+MIT License
+
+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,95 @@
+# jekyll-thumb
+
+This Jekyll plugin automatically generates image thumnails using the [vips](https://jcupitt.github.io/libvips) library and the accompanying ruby wrapper, [ruby-vips.](https://github.com/jcupitt/ruby-vips)
+
+libvips is like imagemagick but less bloated.
+
+The plugin adds a `thumb` Liquid tag that can be used like so:
+
+```html
+{% thumb src="/image.png" width="100" %}
+```
+
+This will generate the thumbnail and output something like:
+
+```html
+<a href="/image.png" target="_blank" class="thumb">
+  <img src="/image-100w.png" width="100" height="50">
+</a>
+```
+
+## Development Status
+
+This project was made because I needed thumbnails for [my blog](https://cleverna.me) and I didn't want to use imagemagick. I made it in like an hour and it definitely has bugs. OTOH it's 119 lines of code so if you don't like something you can just change it.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'jekyll-thumb'
+```
+
+Then bundle:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-thumb
+    
+Finally install vips using your operating system's package manager, eg.
+
+    $ brew install vips
+
+## Usage
+
+Use it like this in any Liquid template:
+
+```html
+{% thumb src="/image.png" width="100" %}
+```
+
+You must specify either a `width` or a `height`, but not both. Whichever dimension you specify, the other will be scaled to a matching ratio.
+
+To use variables for the image or the dimensions, simply leave out the quotes:
+
+```html
+{% thumb src=page.cover_image height=page.cover_image_height %}
+```
+
+## Optipng
+
+If you have `optipng` installed and in your PATH, you can tell the plugin to run it on all generated png images.
+
+Just add:
+
+```
+thumb:
+  optipng: true
+```
+
+To your \_config.yml
+
+Currently the plugin doesn't optimize other image formats, except for stripping color palettes.
+
+## Caching images
+
+Optimizing and resizing can take a while for some images. You can specify a cache folder in your Jekyll config to let jekyll-thumb cache images between runs.
+
+```
+thumb:
+  cache: "/tmp/images"
+```
+
+## Contributing
+
+Make an issue, send a pull request, you know the drill.
+
+## Acknowledgements
+
+Project shamelessly ripped off of [netlify/jekyll-srcset](https://github.com/netlify/jekyll-srcset), it's basically a find-and-replace job.
+
+## Copyright
+
+Copyright (c) 2018 Jonathan Davies. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jekyll-thumb.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/thumb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-thumb"
+  spec.version       = Jekyll::Thumb::VERSION
+  spec.authors       = ["Jonathan Davies"]
+  spec.email         = ["jonnie@cleverna.me"]
+  spec.summary       = %q{This Jekyll plugin adds a thumb tag which will autogenerate image thumbnails}
+  spec.description   = %q{
+  This Jekyll plugin autogenerates image thumbnails using the vips library
+
+  \{% thumb src="/image.png" width="100" %\}
+}
+  spec.homepage      = "https://github.com/JonnieCache/jekyll-thumb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-vips"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'jekyll', '> 2'
+end

data/lib/jekyll/thumb/tag.rb

@@ -0,0 +1,118 @@
+require "ruby-vips"
+require "digest/sha1"
+require "pry"
+require "pry-byebug"
+
+module Jekyll
+  class ThumbTag < Liquid::Tag
+    attr_accessor :markup
+
+    def self.optipng?
+      @optinpng ||= system("which optipng")
+    end
+
+    def initialize(tag_name, markup, _)
+      @markup = markup
+      super
+    end
+
+    def render(context)
+      options = parse_options(markup, context)
+
+      return "Bad options to thumb_tag, syntax is: {% thumb_tag src=\"image.png\" width=\"100\"}" unless options["src"]
+      return "Error resizing - can't set both width and height" if options["width"] && options["height"]
+
+      site = context.registers[:site]
+      img_attrs = generate_image(site, options["src"], options)
+
+      %Q{<a href="#{options['src']}" target="_blank" class="thumb"><img #{options.merge(img_attrs).map {|k,v| "#{k}=\"#{v}\""}.join(" ")}></a>}
+    end
+
+    def parse_options(markup, context)
+      options = {}
+      markup.scan(/(\w+)=((?:"[^"]+")|(?:'[^']+')|[\w\.\_-]+)/) do |key,value|
+        if (value[0..0] == "'" && value[-1..-1]) == "'" || (value[0..0] == '"' && value[-1..-1] == '"')
+          options[key] = value[1..-2]
+        else
+          options[key] = context[value]
+        end
+      end
+      options
+    end
+
+    def config(site)
+      site.config['thumb'] || {}
+    end
+
+    def optimize?(site)
+      config(site)['optipng']
+    end
+
+    def cache_dir(site)
+      config(site)['cache']
+    end
+
+    def generate_image(site, src, attrs)
+      cache = cache_dir(site)
+      
+      sha = cache && Digest::SHA1.hexdigest(attrs.sort.inspect + File.read(File.join(site.source, src)) + (optimize?(site) ? "optimize" : ""))
+      if sha
+        if File.exists?(File.join(cache, sha))
+          img_attrs = JSON.parse(File.read(File.join(cache,sha,"json")))
+          filename = img_attrs["src"].sub(/^\//, '')
+          dest = File.join(site.dest, filename)
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(File.join(cache,sha,"img"), dest)
+
+          site.config['keep_files'] << filename unless site.config['keep_files'].include?(filename)
+
+          return img_attrs
+        end
+      end
+      original_img_path = File.join(site.source, src)
+      original_img = Vips::Image.new_from_file original_img_path
+      
+      img_attrs = {}
+      
+      if attrs['width']
+        scale = attrs['width'].to_f / original_img.width
+        attrs['height'] = original_img.height * scale
+      elsif attrs['height']
+        scale = attrs['height'].to_f / original_img.height
+        attrs['width'] = original_img.width * scale
+      else
+        raise 'must specify either width or height'
+      end
+
+      img_attrs["height"] = attrs["height"].to_i if attrs["height"]
+      img_attrs["width"]  = attrs["width"].to_i  if attrs["width"]
+      img_attrs["src"] = src.sub(/(\.\w+)$/, "-#{img_attrs["width"]}w" + '\1')
+
+      filename = img_attrs["src"].sub(/^\//, '')
+      dest = File.join(site.dest, filename)
+      
+      FileUtils.mkdir_p(File.dirname(dest))
+
+      unless File.exist?(dest)
+        thumb = Vips::Image.thumbnail original_img_path, img_attrs["width"]
+        thumb.write_to_file(dest, strip: true)
+        if dest.match(/\.png$/) && optimize?(site) && self.class.optipng?
+          `optipng #{dest}`
+        end
+      end
+      site.config['keep_files'] << filename unless site.config['keep_files'].include?(filename)
+      # Keep files around for incremental builds in Jekyll 3
+      site.regenerator.add(filename) if site.respond_to?(:regenerator)
+
+      if sha
+        FileUtils.mkdir_p(File.join(cache, sha))
+        FileUtils.cp(dest, File.join(cache, sha, "img"))
+        File.open(File.join(cache, sha, "json"), "w") do |f|
+          f.write(JSON.generate(img_attrs))
+        end
+      end
+
+      img_attrs
+    end
+  end
+end

data/lib/jekyll/thumb/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Thumb
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/thumb.rb

@@ -0,0 +1,8 @@
+require "jekyll/thumb/version"
+require "jekyll/thumb/tag"
+require "jekyll"
+
+module Jekyll
+  module Thumb
+  end
+end

data/lib/jekyll-thumb.rb

@@ -0,0 +1,3 @@
+require "jekyll/thumb"
+
+Liquid::Template.register_tag('thumb', Jekyll::ThumbTag)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-thumb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Davies
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: |2
+
+    This Jekyll plugin autogenerates image thumbnails using the vips library
+
+    {% thumb src="/image.png" width="100" %}
+email:
+- jonnie@cleverna.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-thumb.gemspec
+- lib/jekyll-thumb.rb
+- lib/jekyll/thumb.rb
+- lib/jekyll/thumb/tag.rb
+- lib/jekyll/thumb/version.rb
+homepage: https://github.com/JonnieCache/jekyll-thumb
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: This Jekyll plugin adds a thumb tag which will autogenerate image thumbnails
+test_files: []