james
/
jekyll-responsive-image
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #36 from wildlyinaccurate/source-directory-take-2 

Take 2 of "treat paths as relative to Jekyll `source` directory"
This commit is contained in:
Joseph Wynn 2016-10-14 21:18:45 +01:00 committed by GitHub
parent a1a183c3d4 854aa4cf00
commit 1d7273ec5a
20 changed files with 218 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
features/image-generation.feature
View File

@ -39,16 +39,18 @@ Feature: Responsive image generation
And the file "_site/assets/resized/subdir/test-100.png" should exist
Scenario: Honouring Jekyll 'source' configuration
Given I have copied my site to "sub-dir/my-site-copy"
Given I have copied my site to "my-site-copy/src"
And I have a configuration with:
"""
source: sub-dir/my-site-copy
source: my-site-copy/src
responsive_image:
base_path: assets
template: _includes/responsive-image.html
output_path_format: assets/resized/%{dirname}/%{width}/%{basename}
sizes:
- width: 100
"""
And I have a file "sub-dir/my-site-copy/index.html" with "{% responsive_image path: assets/everybody-loves-jalapeño-pineapple-cornbread.png %}"
And I have a file "my-site-copy/src/index.html" with "{% responsive_image path: assets/subdir/test.png %}"
When I run Jekyll
Then the image "sub-dir/my-site-copy/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should have the dimensions "100x50"
And the file "_site/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist
Then the image "my-site-copy/src/assets/resized/subdir/100/test.png" should have the dimensions "100x50"
And the file "_site/assets/resized/subdir/100/test.png" should exist

75
features/image-hashes.feature Normal file
View File

@ -0,0 +1,75 @@
Feature: Image hashes inside responsive image templates
As a Jekyll user
I want to have access to image hashes
In order to create custom responsive image templates
Scenario: Using the {% responsive_image %} tag
Given I have a configuration with:
"""
responsive_image:
template: _includes/hash.html
output_path_format: assets/resized/%{dirname}/%{width}/%{basename}
sizes:
- width: 100
- width: 120
"""
And I have a file "index.html" with "{% responsive_image path: assets/subdir/test.png %}"
When I run Jekyll
Then the file "_site/index.html" should contain:
"""
path: assets/subdir/test.png
width: 300
height: 150
basename: test.png
dirname: subdir
filename: test
extension: png
path: assets/resized/subdir/100/test.png
width: 100
height: 50
basename: test.png
dirname: resized/subdir/100
filename: test
extension: png
path: assets/resized/subdir/120/test.png
width: 120
height: 60
basename: test.png
dirname: resized/subdir/120
filename: test
extension: png
"""
Scenario: Honouring Jekyll 'source' configuration
Given I have copied my site to "my-site-copy/src"
And I have a configuration with:
"""
source: my-site-copy/src
responsive_image:
template: _includes/hash.html
output_path_format: assets/resized/%{dirname}/%{width}/%{basename}
sizes:
- width: 100
"""
And I have a file "my-site-copy/src/index.html" with "{% responsive_image path: assets/subdir/test.png %}"
When I run Jekyll
Then the file "_site/index.html" should contain:
"""
path: assets/subdir/test.png
width: 300
height: 150
basename: test.png
dirname: subdir
filename: test
extension: png
path: assets/resized/subdir/100/test.png
width: 100
height: 50
basename: test.png
dirname: resized/subdir/100
filename: test
extension: png
"""

6
features/step_definitions/jekyll_steps.rb
View File

@ -1,5 +1,3 @@
include Test::Unit::Assertions
When /^I run Jekyll$/ do
run_jekyll
end
@ -43,6 +41,10 @@ Then /^I should see "(.+)" in "(.*)"$/ do |text, file|
assert contents.inspect.include?(text), "Expected to find #{text.inspect} in #{contents.inspect}"
end
Then /^the file "(.+)" should contain:$/ do |file, contents|
assert_equal contents.strip, File.open(file).readlines.join.strip
end
Then /^the file "(.+)" should exist$/ do |path|
assert File.exist?(path)
end

4
features/support/env.rb
View File

@ -3,7 +3,7 @@ if ENV['CI']
Coveralls.wear!
end
require 'test/unit'
require 'test/unit/assertions'
require 'jekyll/responsive_image'
TEST_DIR = File.join('/', 'tmp', 'jekyll')
@ -14,3 +14,5 @@ def run_jekyll(options = {})
site = Jekyll::Site.new(options)
site.process
end
World(Test::Unit::Assertions)

2
features/test-site/_includes/base-url.html
View File

@ -1 +1 @@
<img src="{{ site.baseurl }}/{{ path }}">
<img src="{{ site.baseurl }}/{{ original.path }}">

16
features/test-site/_includes/hash.html Normal file
View File

@ -0,0 +1,16 @@
path: {{ original.path }}
width: {{ original.width }}
height: {{ original.height }}
basename: {{ original.basename }}
dirname: {{ original.dirname }}
filename: {{ original.filename }}
extension: {{ original.extension }}
{% for i in resized %}
path: {{ i.path }}
width: {{ i.width }}
height: {{ i.height }}
basename: {{ i.basename }}
dirname: {{ i.dirname }}
filename: {{ i.filename }}
extension: {{ i.extension }}
{% endfor %}

2
features/test-site/_includes/responsive-image.html
View File

@ -1 +1 @@
<img alt="{{ alt }}" src="/{{ path }}" title="{{ title }}" srcset="{% for i in resized %}/{{ i.path }} {{ i.width }}w,{% endfor %}/{{ original.path }} {{ original.width }}w">
<img alt="{{ alt }}" src="/{{ original.path }}" title="{{ title }}" srcset="{% for i in resized %}/{{ i.path }} {{ i.width }}w,{% endfor %}/{{ original.path }} {{ original.width }}w">

4
lib/jekyll/responsive_image.rb
View File

@ -5,12 +5,12 @@ require 'jekyll'
require 'rmagick'
require 'jekyll/responsive_image/version'
require 'jekyll/responsive_image/defaults'
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/common'
require 'jekyll/responsive_image/renderer'
require 'jekyll/responsive_image/tag'
require 'jekyll/responsive_image/block'
require 'jekyll/responsive_image/extra_image_generator'

15
lib/jekyll/responsive_image/block.rb
View File

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

46
lib/jekyll/responsive_image/common.rb
View File

@ -1,46 +0,0 @@
module Jekyll
class ResponsiveImage
module Common
include Jekyll::ResponsiveImage::Utils
def make_config(site)
ResponsiveImage.defaults.dup
.merge(site.config['responsive_image'])
.merge(:site_source => site.source, :site_dest => site.dest)
end
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 render_responsive_image(context, attributes)
cache_key = attributes.to_s
result = attributes['cache'] ? RenderCache.get(cache_key) : nil
if result.nil?
site = context.registers[:site]
config = make_config(site)
absolute_image_path = site.in_source_dir(attributes['path'].to_s)
image = ImageProcessor.process(absolute_image_path, 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

22
lib/jekyll/responsive_image/config.rb Normal file
View File

@ -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

15
lib/jekyll/responsive_image/defaults.rb
View File

@ -1,15 +0,0 @@
module Jekyll
class ResponsiveImage
@defaults = {
'default_quality' => 85,
'base_path' => 'assets',
'output_path_format' => 'assets/resized/%{filename}-%{width}x%{height}.%{extension}',
'sizes' => [],
'extra_images' => []
}.freeze
class << self
attr_reader :defaults
end
end
end

12
lib/jekyll/responsive_image/extra_image_generator.rb
View File

@ -1,16 +1,18 @@
module Jekyll
class ResponsiveImage
module ResponsiveImage
class ExtraImageGenerator < Jekyll::Generator
include Jekyll::ResponsiveImage::Common
include Jekyll::ResponsiveImage::Utils
def generate(site)
config = make_config(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|
relative_image_path = image_path.sub(/^#{Regexp.escape(image_path)}/, '')
path = Pathname.new(image_path)
relative_image_path = path.relative_path_from(site_source)
result = ImageProcessor.process(image_path, relative_image_path, config)
result = ImageProcessor.process(relative_image_path, config)
result[:resized].each { |image| keep_resized_image!(site, image) }
end
end

14
lib/jekyll/responsive_image/image_processor.rb
View File

@ -1,22 +1,24 @@
module Jekyll
class ResponsiveImage
module ResponsiveImage
class ImageProcessor
include ResponsiveImage::Utils
def process(absolute_image_path, relative_image_path, config)
raise SyntaxError.new("Invalid image path specified: #{absolute_image_path}") unless File.file?(absolute_image_path)
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['base_path'], relative_image_path, img.columns, img.rows),
original: image_hash(config, image_path, img.columns, img.rows),
resized: resize_handler.resize_image(img, config),
}
end
def self.process(absolute_image_path, relative_image_path, config)
self.new.process(absolute_image_path, relative_image_path, config)
def self.process(image_path, config)
self.new.process(image_path, config)
end
end
end

2
lib/jekyll/responsive_image/render_cache.rb
View File

@ -1,5 +1,5 @@
module Jekyll
class ResponsiveImage
module ResponsiveImage
class RenderCache
attr_accessor :store

37
lib/jekyll/responsive_image/renderer.rb Normal file
View File

@ -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

23
lib/jekyll/responsive_image/resize_handler.rb
View File

@ -1,5 +1,5 @@
module Jekyll
class ResponsiveImage
module ResponsiveImage
class ResizeHandler
include ResponsiveImage::Utils
@ -14,8 +14,8 @@ module Jekyll
next unless needs_resizing?(img, width)
image_path = img.filename.force_encoding(Encoding::UTF_8)
filepath = format_output_path(config['output_path_format'], config['base_path'], image_path, width, height)
resized.push(image_hash(config['base_path'], filepath, width, height))
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])
@ -23,10 +23,10 @@ module Jekyll
# Don't resize images more than once
next if File.exist?(site_source_filepath)
ensure_output_dir_exists!(File.dirname(site_source_filepath))
ensure_output_dir_exists!(File.dirname(site_dest_filepath))
ensure_output_dir_exists!(site_source_filepath)
ensure_output_dir_exists!(site_dest_filepath)
Jekyll.logger.info "Generating #{filepath}"
Jekyll.logger.info "Generating #{site_source_filepath}"
i = img.scale(ratio)
i.write(site_source_filepath) do |f|
@ -34,6 +34,7 @@ module Jekyll
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!
@ -44,11 +45,19 @@ module Jekyll
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!(dir)
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)

6
lib/jekyll/responsive_image/tag.rb
View File

@ -1,8 +1,6 @@
module Jekyll
class ResponsiveImage
module ResponsiveImage
class Tag < Liquid::Tag
include Jekyll::ResponsiveImage::Common
def initialize(tag_name, markup, tokens)
super
@ -15,7 +13,7 @@ module Jekyll
end
def render(context)
render_responsive_image(context, @attributes)
Renderer.new(context.registers[:site], @attributes).render_responsive_image
end
end
end

23
lib/jekyll/responsive_image/utils.rb
View File

@ -1,8 +1,13 @@
require 'pathname'
module Jekyll
class ResponsiveImage
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|
@ -11,17 +16,11 @@ module Jekyll
result
end
def format_output_path(format, base_path, image_path, width, height)
params = symbolize_keys(image_hash(base_path, image_path, width, height))
Pathname.new(format % params).cleanpath.to_s
end
# Build a hash containing image information
def image_hash(base_path, image_path, width, height)
def image_hash(config, image_path, width, height)
{
'path' => image_path,
'dirname' => relative_dirname(base_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('.'),
@ -30,9 +29,9 @@ module Jekyll
}
end
def relative_dirname(base_path, image_path)
path = Pathname.new(image_path).expand_path
base = Pathname.new(base_path).expand_path
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

4
lib/jekyll/responsive_image/version.rb
View File

@ -1,5 +1,5 @@
module Jekyll
class ResponsiveImage
VERSION = '1.0.0.pre3'.freeze
module ResponsiveImage
VERSION = '1.0.0.pre4'.freeze
end
end