middleman-images 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 964a7c5425a22aaef41c52646d09bb031e96d651635667f9cc559c02138f9311
+  data.tar.gz: ec12a1b00e31d5d597dd081f9f7adfe862e034cab41945113ee11cfdf4ec6b97
+SHA512:
+  metadata.gz: c082d6cc1dfbe762e4c6e9c908e135a8b03d2e120bad55a73e8e67b52a4ab76e2f8c8ddcaf56f0b8b1e9f632570918f1a5f628b2c0b9842a0b71247d8668d2c5
+  data.tar.gz: afc35215b01e2b7543f00c58fd4952b0c71fa3438791e1d8e774ec43468693ee2212daf159fb69ab47e4c184e2ec2c372a37c1643241aa7e52975a43619b4614

data/.gitignore

@@ -0,0 +1,2 @@
+# Ignore test files
+/tmp

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+
+cache: bundler
+before_script:
+  - gem install bundler:1.17.3
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5
+
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.middleman-5.0-rc
+  - gemfiles/Gemfile.middleman-4.3
+  - gemfiles/Gemfile.middleman-4.2
+  - gemfiles/Gemfile.middleman-4.1
+
+jobs:
+  fast_finish: true
+  # We exclude these, since running Bundler 1 with Ruby 2.7 on Travis is not trivial, but Middleman 4.1/4.2 requires Bundler 1.
+  exclude:
+    - rvm: 2.7
+      gemfile: gemfiles/Gemfile.middleman-4.2
+    - rvm: 2.7
+      gemfile: gemfiles/Gemfile.middleman-4.1
+  allow_failures:
+    - gemfile: gemfiles/Gemfile.middleman-5.0-rc
+
+script: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2020-02-05
+### Added
+- Do not resize SVG or GIF files.
+- Added this changelog 🎊.
+- Customizable cache directory by [@pantajosef](https://github.com/pantajosef)
+- Preserve jpg quality when resizing.
+- Ignore original image files by [@pmk1c](https://github.com/pmk1c) and [@TimMoser92](https://github.com/TimMoser92).
+- Support for `image_path` helper by [@juls](https://github.com/juls).
+- Added a README.
+- Image optimization by [@pmk1c](https://github.com/pmk1c).
+- Initial image resizing by [@juls](https://github.com/juls).
+
+### Changed
+- `image_optim` removed as a dependency by [@pantajosef](https://github.com/pantajosef).
+  Make sure to include `image_optim` in your Gemfile if you need to optimize images.
+- `mini_magick` removed as a dependency.
+  Make sure to include `mini_magick` in you Gemfile if you need to resize images.
+- Images are not optimized by default anymore.
+
+### Removed
+- Removed support for Ruby < 2.5
+
+[Unreleased]: https://github.com/zweitag/middleman-images/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/zweitag/middleman-images/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,26 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-images.gemspec
+gemspec
+
+group :development do
+  gem 'middleman', '~> 4.3'
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'capybara'
+  gem 'aruba'
+  gem 'rspec'
+
+  gem 'image_optim'
+  gem 'mini_magick'
+
+  # Version is locked to make sure asset_hash tests are not broken by updated optimizations.
+  gem 'image_optim_pack', '=0.6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,194 @@
+PATH
+  remote: .
+  specs:
+    middleman-images (0.1.0)
+      middleman-core (>= 4.1.14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.7.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aruba (0.14.14)
+      childprocess (>= 0.6.3, < 4.0.0)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9)
+      rspec-expectations (>= 2.99)
+      thor (>= 0.19, < 2.0)
+    backports (3.15.0)
+    builder (3.2.4)
+    capybara (3.31.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    childprocess (3.0.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.1.5)
+    contracts (0.13.0)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    exifr (1.3.6)
+    fast_blank (1.0.0)
+    fastimage (2.1.7)
+    ffi (1.12.2)
+    fspath (3.1.2)
+    gherkin (5.1.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    hashie (3.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    image_optim (0.26.5)
+      exifr (~> 1.2, >= 1.2.2)
+      fspath (~> 3.0)
+      image_size (>= 1.5, < 3)
+      in_threads (~> 1.3)
+      progress (~> 3.0, >= 3.0.1)
+    image_optim_pack (0.6.0)
+      fspath (>= 2.1, < 4)
+      image_optim (~> 0.19)
+    image_size (2.0.2)
+    in_threads (1.5.4)
+    kramdown (1.17.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    memoist (0.16.2)
+    middleman (4.3.5)
+      coffee-script (~> 2.2)
+      haml (>= 4.0.5)
+      kramdown (~> 1.2)
+      middleman-cli (= 4.3.5)
+      middleman-core (= 4.3.5)
+    middleman-cli (4.3.5)
+      thor (>= 0.17.0, < 2.0)
+    middleman-core (4.3.5)
+      activesupport (>= 4.2, < 5.1)
+      addressable (~> 2.3)
+      backports (~> 3.6)
+      bundler
+      contracts (~> 0.13.0)
+      dotenv
+      erubis
+      execjs (~> 2.0)
+      fast_blank
+      fastimage (~> 2.0)
+      hamster (~> 3.0)
+      hashie (~> 3.4)
+      i18n (~> 0.9.0)
+      listen (~> 3.0.0)
+      memoist (~> 0.14)
+      padrino-helpers (~> 0.13.0)
+      parallel
+      rack (>= 1.4.5, < 3)
+      sassc (~> 2.0)
+      servolux
+      tilt (~> 2.0.9)
+      uglifier (~> 3.0)
+    mini_magick (4.10.1)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    multi_json (1.14.1)
+    multi_test (0.1.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    padrino-helpers (0.13.3.4)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.13.3.4)
+      tilt (>= 1.4.1, < 3)
+    padrino-support (0.13.3.4)
+      activesupport (>= 3.1)
+    parallel (1.19.1)
+    progress (3.5.2)
+    public_suffix (4.0.3)
+    rack (2.1.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rdoc (6.2.1)
+    regexp_parser (1.6.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sassc (2.2.1)
+      ffi (~> 1.9)
+    servolux (0.13.0)
+    temple (0.8.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  capybara
+  cucumber
+  image_optim
+  image_optim_pack (= 0.6.0)
+  middleman (~> 4.3)
+  middleman-images!
+  mini_magick
+  rake
+  rdoc
+  rspec
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Zweitag GmbH
+
+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,142 @@
+# Middleman Images Extension
+
+Resize and optimize your images on the fly with Middleman. Just run `middleman build`
+and all your images will get the minimizing treatment. *Middleman Images* currently
+depends on [mini_magick](https://github.com/minimagick/minimagick) for resizing and
+[image_optim](https://github.com/toy/image_optim) for optimizing your images.
+
+[![Build Status](https://api.travis-ci.org/zweitag/middleman-images.png?branch=master)](https://travis-ci.org/zweitag/middleman-images)
+
+* * *
+
+## Installation
+
+```ruby
+gem 'middleman-images'
+
+# For resizing images:
+gem 'mini_magick'
+
+# For optimizing images:
+gem 'image_optim'
+```
+
+Resizing images requires the gem `mini_magick` and ImageMagick binaries to be
+available. Check [`mini_magick`](https://github.com/minimagick/minimagick) for
+more information.
+
+Optimizing images require the gem `image_optim`.
+Check [`image_optim`](https://github.com/toy/image_optim) for more information.
+
+ImageOptim uses different tools to optimize image files. The easiest way to
+make sure, most of these tools are available, is by including them via a seperate
+gem:
+
+```ruby
+gem 'image_optim_pack'
+```
+
+For more information check [`image_optim_pack`](https://github.com/toy/image_optim_pack)
+
+## Configuration
+
+To activate the extension just put this into your `config.rb`:
+
+```ruby
+configure :build do
+  activate :images
+end
+```
+
+Although it is possible to activate the extension in development mode, we do
+not recommend this. Since this will radically drain the performance.
+
+Configure the extension by passing a block to `:activate`:
+
+```ruby
+configure :build do
+  activate :images do |images|
+    # Do not include original images in the build (default: false)
+    images.ignore_original = true
+
+    # Specify another cache directory depending on your root directory (default: 'cache')
+    images.cache_dir = 'funky_cache/subdir_of_funky_cache'
+
+    # Optimize images (default: false)
+    images.optimize = true
+
+    # Provide additional options for image_optim
+    # See https://github.com/toy/image_optim for all available options
+    images.image_optim = {
+      nice: 20,
+      optipng: {
+        level: 5,
+      },
+    }
+  end
+end
+```
+
+By default *Middleman Images* won't do anything to your images.
+
+## Usage
+
+### Resize
+
+To resize your images, set the option `resize` on the middleman helpers `image_tag` or `image_path`.
+
+```erb
+<%= image_tag 'example.jpg', resize: '200x300' %>
+```
+
+becomes:
+
+```html
+<img src="/assets/images/example-200x300-opt.jpg" alt="Example" />
+```
+
+The image `example.jpg` will be resized, optimized and saved to `example-200x300-opt.jpg`.
+
+We use ImageMagick for resizing, which respects the aspect ratio of your images when resizing. You can make ImageMagick ignore the aspect ratio by appending `!` to `resize`.
+
+```erb
+<%= image_tag 'example.jpg', resize: '200x300!' %>
+```
+
+Since *Middleman Images* just passes the `resize` string to ImageMagick, you can use all options available. Check the [ImageMagick documentation for resize](https://www.imagemagick.org/Usage/resize/#resize) for all available options.
+
+### Optimize
+
+You can enable (or disable) optimization for some images by providing the `optimize`
+option.
+
+```erb
+<%= image_path 'example.jpg', resize: '200x300', optimize: false %>
+```
+
+becomes:
+
+```html
+/assets/images/example-200x300.jpg
+```
+
+### srcset
+
+Using `srcset` with *Middleman Images* is possible via the `image_path` helper. This is how Middleman handles srcsets in conjunction with the
+`:asset_hash` option
+(see [Middleman#File Size Optimization](https://middlemanapp.com/advanced/file-size-optimization)).
+
+```erb
+<img src="<%= image_path 'example.jpg', resize: '200x300' %>"
+     srcset="<%= image_path 'example.jpg', resize: '400x600' %> 2x" />
+```
+
+### Cache
+
+*Middleman Images* will create a `cache` Folder in your app directory
+(or the folder name you specified as `cache_dir`). It will
+save the processed images in there. This is necessary to work with other plugins
+like `asset_hash` and to make sure unchanged images are not reprocessed on
+rebuild. Deleting this directory is not critical, but it will force
+*Middleman Images* to rebuild **all** images on the next build, so you should
+do this with care.