jekyll-responsive-image 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b3cf9ae3bb950e0229a1dbd0f6a892e3645c93c
+  data.tar.gz: 56df60468696d856b5b25aac144030c41eab7532
+SHA512:
+  metadata.gz: 32cdee3321bb41690494989f0dfcf02d50b4f72eb33577a9982b868bfd77d5171e92520b9f696f179ad555172e47bc2989617d83958096d94c0fce909ea72179
+  data.tar.gz: 60e7b705ab7f9db9a4bbdc457b77778c6148bfd5acbbd9024f83638275206bf8b84c3f6cd9cffab83fe7575a6cfb1b612f6954e4fa12f577bed83ade55d6e237

data/lib/jekyll/responsive_image.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+require 'yaml'
+
+require 'jekyll'
+require 'rmagick'
+
+require 'jekyll/responsive_image/version'
+require 'jekyll/responsive_image/config'
+require 'jekyll/responsive_image/utils'
+require 'jekyll/responsive_image/render_cache'
+require 'jekyll/responsive_image/image_processor'
+require 'jekyll/responsive_image/resize_handler'
+require 'jekyll/responsive_image/renderer'
+require 'jekyll/responsive_image/tag'
+require 'jekyll/responsive_image/block'
+require 'jekyll/responsive_image/extra_image_generator'
+
+Liquid::Template.register_tag('responsive_image', Jekyll::ResponsiveImage::Tag)
+Liquid::Template.register_tag('responsive_image_block', Jekyll::ResponsiveImage::Block)

data/lib/jekyll/responsive_image/block.rb

@@ -0,0 +1,12 @@
+module Jekyll
+  module ResponsiveImage
+    class Block < Liquid::Block
+      include Jekyll::ResponsiveImage::Utils
+
+      def render(context)
+        attributes = YAML.load(super)
+        Renderer.new(context.registers[:site], attributes).render_responsive_image
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/config.rb

@@ -0,0 +1,22 @@
+module Jekyll
+  module ResponsiveImage
+    class Config
+      DEFAULTS = {
+        'default_quality'    => 85,
+        'base_path'          => 'assets',
+        'output_path_format' => 'assets/resized/%{filename}-%{width}x%{height}.%{extension}',
+        'sizes'              => [],
+        'extra_images'       => []
+      }
+
+      def initialize(site)
+        @site = site
+      end
+
+      def to_h
+        DEFAULTS.merge(@site.config['responsive_image'])
+                .merge(site_source: @site.source, site_dest: @site.dest)
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/extra_image_generator.rb

@@ -0,0 +1,22 @@
+module Jekyll
+  module ResponsiveImage
+    class ExtraImageGenerator < Jekyll::Generator
+      include Jekyll::ResponsiveImage::Utils
+
+      def generate(site)
+        config = Config.new(site).to_h
+        site_source = Pathname.new(site.source)
+
+        config['extra_images'].each do |pathspec|
+          Dir.glob(site.in_source_dir(pathspec)) do |image_path|
+            path = Pathname.new(image_path)
+            relative_image_path = path.relative_path_from(site_source)
+
+            result = ImageProcessor.process(relative_image_path, config)
+            result[:resized].each { |image| keep_resized_image!(site, image) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/image_processor.rb

@@ -0,0 +1,25 @@
+module Jekyll
+  module ResponsiveImage
+    class ImageProcessor
+      include ResponsiveImage::Utils
+
+      def process(image_path, config)
+        absolute_image_path = File.expand_path(image_path.to_s, config[:site_source])
+
+        raise SyntaxError.new("Invalid image path specified: #{image_path}") unless File.file?(absolute_image_path)
+
+        resize_handler = ResizeHandler.new
+        img = Magick::Image::read(absolute_image_path).first
+
+        {
+          original: image_hash(config, image_path, img.columns, img.rows),
+          resized: resize_handler.resize_image(img, config),
+        }
+      end
+
+      def self.process(image_path, config)
+        self.new.process(image_path, config)
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/render_cache.rb

@@ -0,0 +1,21 @@
+module Jekyll
+  module ResponsiveImage
+    class RenderCache
+      attr_accessor :store
+
+      class << self
+        def store
+          @store ||= {}
+        end
+
+        def get(key)
+          store[key]
+        end
+
+        def set(key, val)
+          store[key] = val
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/renderer.rb

@@ -0,0 +1,37 @@
+module Jekyll
+  module ResponsiveImage
+    class Renderer
+      include Jekyll::ResponsiveImage::Utils
+
+      def initialize(site, attributes)
+        @site = site
+        @attributes = attributes
+      end
+
+      def render_responsive_image
+        cache_key = @attributes.to_s
+        result = @attributes['cache'] ? RenderCache.get(cache_key) : nil
+
+        if result.nil?
+          config = Config.new(@site).to_h
+
+          image = ImageProcessor.process(@attributes['path'], config)
+          @attributes['original'] = image[:original]
+          @attributes['resized'] = image[:resized]
+
+          @attributes['resized'].each { |resized| keep_resized_image!(@site, resized) }
+
+          image_template = @site.in_source_dir(@attributes['template'] || config['template'])
+          partial = File.read(image_template)
+          template = Liquid::Template.parse(partial)
+
+          result = template.render!(@attributes.merge(@site.site_payload))
+
+          RenderCache.set(cache_key, result)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/resize_handler.rb

@@ -0,0 +1,68 @@
+module Jekyll
+  module ResponsiveImage
+    class ResizeHandler
+      include ResponsiveImage::Utils
+
+      def resize_image(img, config)
+        resized = []
+
+        config['sizes'].each do |size|
+          width = size['width']
+          ratio = width.to_f / img.columns.to_f
+          height = (img.rows.to_f * ratio).round
+
+          next unless needs_resizing?(img, width)
+
+          image_path = img.filename.force_encoding(Encoding::UTF_8)
+          filepath = format_output_path(config['output_path_format'], config, image_path, width, height)
+          resized.push(image_hash(config, filepath, width, height))
+
+          site_source_filepath = File.expand_path(filepath, config[:site_source])
+          site_dest_filepath = File.expand_path(filepath, config[:site_dest])
+
+          # Don't resize images more than once
+          next if File.exist?(site_source_filepath)
+
+          ensure_output_dir_exists!(site_source_filepath)
+          ensure_output_dir_exists!(site_dest_filepath)
+
+          Jekyll.logger.info "Generating #{site_source_filepath}"
+
+          i = img.scale(ratio)
+          i.write(site_source_filepath) do |f|
+            f.quality = size['quality'] || config['default_quality']
+          end
+
+          # Ensure the generated file is copied to the _site directory
+          Jekyll.logger.info "Copying resized image to #{site_dest_filepath}"
+          FileUtils.copy_file(site_source_filepath, site_dest_filepath)
+
+          i.destroy!
+        end
+
+        img.destroy!
+
+        resized
+      end
+
+      def format_output_path(format, config, image_path, width, height)
+        params = symbolize_keys(image_hash(config, image_path, width, height))
+
+        Pathname.new(format % params).cleanpath.to_s
+      end
+
+      def needs_resizing?(img, width)
+        img.columns > width
+      end
+
+      def ensure_output_dir_exists!(path)
+        dir = File.dirname(path)
+
+        unless Dir.exist?(dir)
+          Jekyll.logger.info "Creating output directory #{dir}"
+          FileUtils.mkdir_p(dir)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/tag.rb

@@ -0,0 +1,20 @@
+module Jekyll
+  module ResponsiveImage
+    class Tag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+
+        @attributes = {}
+
+        markup.scan(::Liquid::TagAttributes) do |key, value|
+          # Strip quotes from around attribute values
+          @attributes[key] = value.gsub(/^['"]|['"]$/, '')
+        end
+      end
+
+      def render(context)
+        Renderer.new(context.registers[:site], @attributes).render_responsive_image
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/utils.rb

@@ -0,0 +1,40 @@
+require 'pathname'
+
+module Jekyll
+  module ResponsiveImage
+    module Utils
+      def keep_resized_image!(site, image)
+        keep_dir = File.dirname(image['path'])
+        site.config['keep_files'] << keep_dir unless site.config['keep_files'].include?(keep_dir)
+      end
+
+      def symbolize_keys(hash)
+        result = {}
+        hash.each_key do |key|
+          result[key.to_sym] = hash[key]
+        end
+        result
+      end
+
+      # Build a hash containing image information
+      def image_hash(config, image_path, width, height)
+        {
+          'path'      => image_path,
+          'dirname'   => relative_dirname(config, image_path),
+          'basename'  => File.basename(image_path),
+          'filename'  => File.basename(image_path, '.*'),
+          'extension' => File.extname(image_path).delete('.'),
+          'width'     => width,
+          'height'    => height,
+        }
+      end
+
+      def relative_dirname(config, image_path)
+        path = Pathname.new(File.expand_path(image_path, config[:site_source]))
+        base = Pathname.new(File.expand_path(config['base_path'], config[:site_source]))
+
+        path.relative_path_from(base).dirname.to_s.delete('.')
+      end
+    end
+  end
+end

data/lib/jekyll/responsive_image/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module ResponsiveImage
+    VERSION = '1.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-responsive-image
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Joseph Wynn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n    Highly configurable Jekyll plugin for managing responsive images.
+  Automatically\n    resizes images and provides a Liquid template tag for loading
+  the images with\n    picture, img srcset, Imager.js, etc.\n  "
+email:
+- joseph@wildlyinaccurate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll/responsive_image.rb
+- lib/jekyll/responsive_image/block.rb
+- lib/jekyll/responsive_image/config.rb
+- lib/jekyll/responsive_image/extra_image_generator.rb
+- lib/jekyll/responsive_image/image_processor.rb
+- lib/jekyll/responsive_image/render_cache.rb
+- lib/jekyll/responsive_image/renderer.rb
+- lib/jekyll/responsive_image/resize_handler.rb
+- lib/jekyll/responsive_image/tag.rb
+- lib/jekyll/responsive_image/utils.rb
+- lib/jekyll/responsive_image/version.rb
+homepage: https://github.com/wildlyinaccurate/jekyll-responsive-image
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Responsive images management for Jekyll
+test_files: []