middleman-images 0.1.0

data/lib/middleman-images/image.rb

@@ -0,0 +1,68 @@
+module Middleman
+  module Images
+    class Image
+      attr_reader :destination, :source
+
+      IGNORE_RESIZING = {
+        ".svg" =>  "WARNING: We did not resize %{file}. Resizing SVG files will lead to ImageMagick creating an SVG with an embedded binary image thus making the file way bigger.",
+        ".gif" =>  "WARNING: We did not resize %{file}. Resizing GIF files will remove the animation. If your GIF file is not animated, use JPG or PNG instead.",
+      }.freeze
+
+      def initialize(app, source, destination, options = {})
+        @app = app
+        @source = source
+        @destination = destination
+        @options = options
+        @cache = File.join(app.root, options[:cache_dir], destination).to_s
+        FileUtils.mkdir_p File.dirname(cache)
+      end
+
+      def process
+        return if File.exist?(cache) && File.mtime(source) < File.mtime(cache)
+
+        app.logger.info "== Images: Processing #{destination}"
+        FileUtils.copy(source, cache)
+        resize(cache, options[:resize]) unless options[:resize].nil?
+        optimize(cache, options[:image_optim]) if options[:optimize]
+      end
+
+      def resource
+        @resource ||= ::Middleman::Sitemap::Resource.new(app.sitemap, destination, cache)
+      end
+
+      private
+
+      def resize(image_path, options)
+        begin
+          require 'mini_magick'
+        rescue LoadError
+          raise 'The gem "mini_magick" is required for image resizing. Please install "mini_magick" or remove the resize option.'
+        end
+
+        image_ext = File.extname(image_path)
+        if IGNORE_RESIZING.keys.include? image_ext
+          app.logger.warn("== Images: " + (IGNORE_RESIZING[image_ext] % { file: image_path }))
+          return
+        end
+
+        image = MiniMagick::Image.new(image_path) do |i|
+          i.resize(options)
+          i.define('jpeg:preserve-settings')
+        end
+        image.write image_path
+      end
+
+      def optimize(image_path, options)
+        begin
+          require 'image_optim'
+        rescue LoadError
+          raise "The gem 'image_option' is required for image optimization. Please install the gem 'image_optim' or set the option optimize: false."
+        end
+
+        ImageOptim.new(options).optimize_image!(image_path)
+      end
+
+      attr_accessor :app, :cache, :options
+    end
+  end
+end

data/lib/middleman-images/manipulator.rb

@@ -0,0 +1,49 @@
+module Middleman
+  module Images
+    class Manipulator
+      def initialize(app, ignore_original)
+        @app = app
+        @images = []
+        @required_originals = []
+        @ignore_original = ignore_original
+      end
+
+      def add(image)
+        unless images.collect(&:destination).include? image.destination
+          images << image
+        end
+      end
+
+      def preserve_original(resource)
+        required_originals << resource.source_file
+      end
+
+      def manipulate_resource_list(resources)
+        ignore_orginal_resources(resources) if ignore_original
+        resources + processed_images
+      end
+
+      private
+
+      attr_accessor :app, :images, :ignore_original, :required_originals
+
+      def processed_images
+        images.each(&:process)
+        images.collect(&:resource)
+      end
+
+      def ignore_orginal_resources(resources)
+        originals = images.map(&:source)
+        unused_originals = originals - required_originals
+
+        resources.each do |resource|
+          if unused_originals.include? resource.source_file
+            resource.ignore!
+          elsif required_originals.include? resource.source_file
+            resource.ignored = false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/middleman-images/version.rb

@@ -0,0 +1,3 @@
+module MiddlemanImages
+  VERSION = "0.1.0"
+end

data/middleman-images.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-images/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-images"
+  s.version     = MiddlemanImages::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ["MIT"]
+  s.authors     = ["Ruben Grimm", "Julian Schneider"]
+  s.email       = ["ruben.grimm@zweitag.de", "julian.schneider@zweitag.de"]
+  s.homepage    = "https://www.github.com/zweitag/middleman-images"
+  s.summary     = "Resize and optimize images for Middleman"
+  s.description = "Resize and optimize images for Middleman"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.5.0'
+
+  s.add_runtime_dependency("middleman-core", [">= 4.1.14"])
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: middleman-images
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ruben Grimm
+- Julian Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.14
+description: Resize and optimize images for Middleman
+email:
+- ruben.grimm@zweitag.de
+- julian.schneider@zweitag.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- features/building.feature
+- features/ignore_original.feature
+- features/image_path.feature
+- features/optimization.feature
+- features/relative_path.feature
+- features/resize.feature
+- features/support/env.rb
+- features/support/middleman_images_steps.rb
+- fixtures/image/source/images/fox.jpg
+- gemfiles/Gemfile.middleman-4.1
+- gemfiles/Gemfile.middleman-4.1.lock
+- gemfiles/Gemfile.middleman-4.2
+- gemfiles/Gemfile.middleman-4.2.lock
+- gemfiles/Gemfile.middleman-4.3
+- gemfiles/Gemfile.middleman-4.3.lock
+- gemfiles/Gemfile.middleman-5.0-rc
+- gemfiles/Gemfile.middleman-5.0-rc.lock
+- lib/middleman-images.rb
+- lib/middleman-images/extension.rb
+- lib/middleman-images/image.rb
+- lib/middleman-images/manipulator.rb
+- lib/middleman-images/version.rb
+- middleman-images.gemspec
+homepage: https://www.github.com/zweitag/middleman-images
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Resize and optimize images for Middleman
+test_files:
+- features/building.feature
+- features/ignore_original.feature
+- features/image_path.feature
+- features/optimization.feature
+- features/relative_path.feature
+- features/resize.feature
+- features/support/env.rb
+- features/support/middleman_images_steps.rb