Compare commits

...

12 Commits

Author SHA1 Message Date
Joseph Wynn
dda6d748c8
1.6.0 2021-02-24 12:37:30 +13:00
Joseph Wynn
a31c454ed1
Merge pull request #103 from salomvary/master
Add registers.site to context when rendering template
2021-02-24 12:29:45 +13:00
Joseph Wynn
f2be2c53be
1.5.5 2021-01-25 17:10:01 +13:00
Joseph Wynn
6cc3a082a1
Automatically convert tabbed indentation to spaces 2021-01-25 17:10:00 +13:00
Joseph Wynn
2f7c0124eb
1.5.4 2021-01-25 17:10:00 +13:00
Márton Salomváry
25c6695da4 Add registers.site to context when rendering template
Fixes #101.
2021-01-01 14:07:03 +01:00
Joseph Wynn
7679f4b8f5
Merge pull request #100 from danielpietzsch/improveRegeneratePerformance
Improving build performance when a lot of images have already been resized before
2020-12-15 14:37:15 +13:00
Daniel Pietzsch
82e868966c Making sure full image is loaded when auto_rotate config option is used
because then we need the full image right at the start – as before – and 
there's no need to load "properties only" first, to then load the full 
image right after.
2020-11-08 21:43:29 +01:00
Daniel Pietzsch
fbc35b8ef9 Loading full images when auto_rotate option is turned on.
Because we need the full image for the auto rotation
2020-11-07 23:30:23 +01:00
Daniel Pietzsch
749e6cc068 By default, loading images using .ping instead of .read
This gives an increase in performance and reduces memory usage when a 
lot of resized images already exist. Because this now by default loads 
only images meta data – omitting pixel data.

Pixel data is only loaded when an images actually needs resized versions 
generated.
2020-11-07 23:05:27 +01:00
Joseph Wynn
fa00c4c9cf
Update README.md 2020-07-17 12:33:00 +12:00
Joseph Wynn
4b75f67558
Make it clear that the plugin does nothing without a sizes config 2020-07-17 12:31:13 +12:00
8 changed files with 89 additions and 31 deletions

View File

@ -35,11 +35,15 @@ For more advanced templates, see the [**Templates**](#templates) section below.
### 3. Configure the plugin
You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. The minimum required configuration is a `template` path:
You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. At a minimum, your `responsive_image` configuration should have a template path and a list of sizes.
```yaml
responsive_image:
template: _includes/responsive-image.html
sizes:
- width: 320
- width: 480
- width: 800
```
For a list of all the available configuration options, see the [**All configuration options**](#all-configuration-options) section below.

View File

@ -13,6 +13,20 @@ Feature: Jekyll responsive_image_block tag
When I run Jekyll
Then I should see "<img alt=\"Lorem ipsum\" src=\"/assets/everybody-loves-jalapeño-pineapple-cornbread.png\" title=\"Magic rainbow adventure!\"" in "_site/index.html"
Scenario: Tabs for indentation
Given I have a responsive_image configuration with "template" set to "_includes/responsive-image.html"
And I have a file "index.html" with:
"""
{% assign path = 'assets/everybody-loves-jalapeño-pineapple-cornbread.png' %}
{% responsive_image_block %}
path: {{ path }}
title: Magic rainbow adventure!
alt: Lorem ipsum
{% endresponsive_image_block %}
"""
When I run Jekyll
Then I should see "<img alt=\"Lorem ipsum\" src=\"/assets/everybody-loves-jalapeño-pineapple-cornbread.png\" title=\"Magic rainbow adventure!\"" in "_site/index.html"
Scenario: Global variables available in templates
Given I have a file "index.html" with:
"""

View File

@ -1 +1,3 @@
{% assign largest = resized | sort: 'width' | last %}
<img alt="{{ alt }}" src="/{{ original.path }}" title="{{ title }}" srcset="{% for i in resized %}/{{ i.path }} {{ i.width }}w,{% endfor %}/{{ original.path }} {{ original.width }}w">

View File

@ -4,7 +4,13 @@ module Jekyll
include Jekyll::ResponsiveImage::Utils
def render(context)
attributes = YAML.load(super)
content = super
if content.include?("\t")
content = content.lines.map {|line| line.gsub(/\G[\t ]/, " ")}.join("\n")
end
attributes = YAML.load(content)
Renderer.new(context.registers[:site], attributes).render_responsive_image
end
end

View File

@ -8,12 +8,11 @@ module Jekyll
Jekyll.logger.warn "Invalid image path specified: #{image_path.inspect}" unless File.file?(absolute_image_path)
resize_handler = ResizeHandler.new
img = Magick::Image::read(absolute_image_path).first
resize_handler = ResizeHandler.new(absolute_image_path, config)
{
original: image_hash(config, image_path, img.columns, img.rows),
resized: resize_handler.resize_image(img, config),
original: image_hash(config, image_path, resize_handler.original_image.columns, resize_handler.original_image.rows),
resized: resize_handler.resize_image,
}
end

View File

@ -25,7 +25,11 @@ module Jekyll
partial = File.read(image_template)
template = Liquid::Template.parse(partial)
result = template.render!(@attributes.merge(@site.site_payload))
info = {
registers: { site: @site }
}
result = template.render!(@attributes.merge(@site.site_payload), info)
RenderCache.set(cache_key, result)
end

View File

@ -3,26 +3,39 @@ module Jekyll
class ResizeHandler
include ResponsiveImage::Utils
def resize_image(img, config)
img.auto_orient! if config['auto_rotate']
attr_reader :original_image
def initialize(original_image_absolute_path, config)
@config = config
@original_image_absolute_path = original_image_absolute_path
if @config['auto_rotate']
load_full_image
@original_image.auto_orient!
else
load_image_properties_only
end
end
def resize_image
resized = []
config['sizes'].each do |size|
@config['sizes'].each do |size|
width = size['width']
ratio = width.to_f / img.columns.to_f
height = (img.rows.to_f * ratio).round
ratio = width.to_f / @original_image.columns.to_f
height = (@original_image.rows.to_f * ratio).round
next unless needs_resizing?(img, width)
next unless needs_resizing?(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))
image_path = @original_image.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])
site_source_filepath = File.expand_path(filepath, @config[:site_source])
site_dest_filepath = File.expand_path(filepath, @config[:site_dest])
if config['save_to_source']
if @config['save_to_source']
target_filepath = site_source_filepath
else
target_filepath = site_dest_filepath
@ -36,16 +49,22 @@ module Jekyll
Jekyll.logger.info "Generating #{target_filepath}"
if config['strip']
img.strip!
end
i = img.scale(ratio)
i.write(target_filepath) do |f|
f.interlace = i.interlace
f.quality = size['quality'] || config['default_quality']
load_full_image unless @original_image_pixels_loaded
if @config['strip']
@original_image.strip!
end
if config['save_to_source']
i = @original_image.scale(ratio)
quality = size['quality'] || @config['default_quality']
i.write(target_filepath) do |f|
f.interlace = i.interlace
f.quality = quality
end
if @config['save_to_source']
# 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)
@ -54,7 +73,7 @@ module Jekyll
i.destroy!
end
img.destroy!
@original_image.destroy!
resized
end
@ -65,8 +84,18 @@ module Jekyll
Pathname.new(format % params).cleanpath.to_s
end
def needs_resizing?(img, width)
img.columns > width
def needs_resizing?(width)
@original_image.columns > width
end
def load_full_image
@original_image = Magick::Image::read(@original_image_absolute_path).first
@original_image_pixels_loaded = true
end
def load_image_properties_only
@original_image = Magick::Image::ping(@original_image_absolute_path).first
@original_image_pixels_loaded = false
end
def ensure_output_dir_exists!(path)

View File

@ -1,5 +1,5 @@
module Jekyll
module ResponsiveImage
VERSION = '1.5.3'.freeze
VERSION = '1.6.0'.freeze
end
end