middleman-imageoptim 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a614256397db9fad85c5420cd82494e86601865
-  data.tar.gz: 31242425727e75d2159c44e6b89ef71c42426532
+  metadata.gz: 139f5d4341e9f282b48469c083333f52954d41c2
+  data.tar.gz: c43cb5965b95b8628f66e5f7472b7cee64cfe26f
 SHA512:
-  metadata.gz: 6f4d987028e5253337be3dadcf1ae59b501022b35d71a11be84052eb7c8bc1b91bb4bdccf6ae5d7efd1cbb374f75d1750b702384170e7187db4130dd72927388
-  data.tar.gz: 64321b6ca80e4220b7bc0f63a3592c3ded2c39c74d36750b52a3ec67ed3eea3e3e04286205e07b341e46149b9dadffefb7a49f443b28c3257537c722111498a5
+  metadata.gz: 84a90a10b3d1867a69b8a99adfd43e407bd80950e52f56e75b03b30fd9add3e9b14ff17a4a85cfcbbf6f6d67530650fbcc5a6de01f7951cb5cdfb3c33ad01fb3
+  data.tar.gz: 6cf1a88f097cb595b7db35204fabaa6c21532550132720d63adbed7b53bb5688435c211d3beee32f5a7e3742e1824b8fb1437e2b7ff8af3a15a7f7e2f6ad0af4

data/.gitignore

@@ -4,3 +4,5 @@ pkg
 .bundle
 bin
 coverage
+tmp
+fixtures/*/build

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'pkg/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,46 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-05 15:23:36 +1100 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/AmbiguousOperator:
+  Enabled: false
+
+# Offense count: 1
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Offense count: 11
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 133
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 7
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/EachWithObject:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/FormatString:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.start do
+  FileUtils.rm_rf 'coverage'
+
+  refuse_coverage_drop
+  add_filter '/spec/'
+  add_filter '/features/'
+end

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 bundler_args: --binstubs
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-after_success:
-  - script/quality
 matrix:
   include:
     - rvm: 2.0.0

data/Gemfile

@@ -1,12 +1,2 @@
-# If you have OpenSSL installed, we recommend updating
-# the following line to use "https"
-source 'http://rubygems.org'
-
-# Specify your gem's dependencies in middleman-imageoptim.gemspec
+source 'https://rubygems.org'
 gemspec
-
-group :development do
-  gem "rake", "~> 0.9.2"
-  gem "rdoc", "~> 3.9"
-  gem "yard", "~> 0.8.0"
-end

data/README.md

@@ -5,10 +5,12 @@
 Serving big images is for numb-skulls! Compress and optimise your imagery during `middleman build` by running [image_optim](https://github.com/toy/image_optim) over it. Aww yiss!
 
 [![Build Status](https://travis-ci.org/plasticine/middleman-imageoptim.png?branch=master)](https://travis-ci.org/plasticine/middleman-imageoptim)
-[![Coverage Status](https://coveralls.io/repos/plasticine/middleman-imageoptim/badge.png)](https://coveralls.io/r/plasticine/middleman-imageoptim)
+[![Code Climate](https://codeclimate.com/github/plasticine/middleman-imageoptim.png)](https://codeclimate.com/github/plasticine/middleman-imageoptim)
 [![Gem Version](https://badge.fury.io/rb/middleman-imageoptim.png)](http://badge.fury.io/rb/middleman-imageoptim)
 [![Dependency Status](https://gemnasium.com/plasticine/middleman-imageoptim.png)](https://gemnasium.com/plasticine/middleman-imageoptim)
 
+* * *
+
 ![](http://cl.ly/image/0h0b330F2p3C/Terminal%20%E2%80%94%20zsh%20%E2%80%94%20109%C3%9712.png)
 
 ## Installation
@@ -16,7 +18,7 @@ Serving big images is for numb-skulls! Compress and optimise your imagery during
 Go set up the [image_optim](https://github.com/toy/image_optim) external utilities, then;
 
 ```ruby
-gem "middleman-imageoptim", "~> 0.1.4"
+gem 'middleman-imageoptim'
 ```
 
 ## Usage
@@ -30,7 +32,13 @@ Below is the default configuration showing all available options;
 
 ```ruby
 activate :imageoptim do |options|
-  # print out skipped images
+  # Use a build manifest to prevent re-compressing images between builds
+  options.manifest = true
+
+  # Silence problematic image_optim workers
+  options.skip_missing_workers = true
+
+  # Cause image_optim to be in shouty-mode
   options.verbose = false
 
   # Setting these to true or nil will let options determine them (recommended)
@@ -38,17 +46,18 @@ activate :imageoptim do |options|
   options.threads = true
 
   # Image extensions to attempt to compress
-  options.image_extensions = %w(.png .jpg .gif)
+  options.image_extensions = %w(.png .jpg .gif .svg)
 
-  # compressor worker options, individual optimisers can be disabled by passing
+  # Compressor worker options, individual optimisers can be disabled by passing
   # false instead of a hash
-  options.pngcrush_options  = {:chunks => ['alla'], :fix => false, :brute => false}
-  options.pngout_options    = {:copy_chunks => false, :strategy => 0}
-  options.optipng_options   = {:level => 6, :interlace => false}
-  options.advpng_options    = {:level => 4}
-  options.jpegoptim_options = {:strip => ['all'], :max_quality => 100}
-  options.jpegtran_options  = {:copy_chunks => false, :progressive => true, :jpegrescan => true}
-  options.gifsicle_options  = {:interlace => false}
+  options.advpng    = { :level => 4 }
+  options.gifsicle  = { :interlace => false }
+  options.jpegoptim = { :strip => ['all'], :max_quality => 100 }
+  options.jpegtran  = { :copy_chunks => false, :progressive => true, :jpegrescan => true }
+  options.optipng   = { :level => 6, :interlace => false }
+  options.pngcrush  = { :chunks => ['alla'], :fix => false, :brute => false }
+  options.pngout    = { :copy_chunks => false, :strategy => 0 }
+  options.svgo      = {}
 end
 ```
 
@@ -56,19 +65,26 @@ end
 
 ## Changelog
 
+##### `0.2.0`
+- Big cleanup to codebase.
+- More tests.
+- Caching between builds using a manifest file to skip over already-compressed assets (thanks for your work on this @jagthedrummer).
+- Updates `image_optim` gem to latest version (`0.20.2`).
+- Adds dependency on `image_optim_pack` to ensure that binaries are available.
+
 ##### `0.1.4`
-- Respect plugin ordering in config.rb (thanks @jeffutter) [#8](https://github.com/plasticine/middleman-imageoptim/pull/8)
+- Respect plugin ordering in config.rb (thanks @jeffutter) [#8](https://github.com/plasticine/middleman-imageoptim/pull/8).
 
 ##### `0.1.3`
-- fix missing license in gemspec
+- Fix missing license in gemspec.
 
 ##### `0.1.2`
-- minor bugfix
+- Minor bugfix.
 
 ##### `0.1.1`
-- remove legacy requirement for padrino
+- Remove legacy requirement for padrino.
 
 ##### `0.1.0`
-- complete refactor and clean-up
-- introduced an options class. options now work (lol, yay!), thanks @andrew-aladev for your help there
-- change of extension activation name from `:image_optim` to `:imageoptim` for consistency with internal naming
+- Complete refactor and clean-up.
+- Introduced an options class. options now work (lol, yay!), thanks @andrew-aladev for your help there.
+- Change of extension activation name from `:image_optim` to `:imageoptim` for consistency with internal naming.

data/Rakefile

@@ -5,29 +5,21 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/clean'
 require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
 
 namespace :spec do
-  begin
-    require 'cane/rake_task'
-    desc "Run cane to check quality metrics"
-    Cane::RakeTask.new(:quality) do |cane|
-      cane.abc_max = 10
-      cane.add_threshold 'coverage/covered_percent', :>=, 74
-      cane.no_style = true
-      cane.abc_exclude = %w(Middleman::Imageoptim::Optimizer#optimizer)
-    end
-
-    task :default => :quality
-  rescue LoadError
-    warn "cane not available, quality task not provided."
+  desc 'Run unit specs'
+  RSpec::Core::RakeTask.new(:unit) do |config|
+    config.pattern = 'spec/unit/*_spec.rb'
+    config.rspec_opts = '--require spec_helper'
   end
 
-  desc 'Run unit specs'
-  RSpec::Core::RakeTask.new(:unit) do |spec|
-    spec.pattern = "spec/unit/*_spec.rb"
-    spec.rspec_opts = "--require spec_helper"
+  desc 'Run feature tests'
+  Cucumber::Rake::Task.new(:features) do |config|
+    config.cucumber_opts = 'features --format pretty'
   end
 end
 
-desc 'Default: run unit tests.'
-task :default => ['spec:unit']
+desc 'Default: run the tests.'
+task default: ['spec:unit', 'spec:features']

data/features/manifest.feature

@@ -0,0 +1,31 @@
+Feature: Manifest
+  Scenario: Don't reoptimize images that have already been optimized
+    Given a fixture app "basic-app"
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Then the following files should exist:
+      | build/imageoptim.manifest.yml |
+    Then the manifest should have the right timestamp for "build/images/table.jpg"
+
+  Scenario: Don't write a manifest file if it is disabled
+    Given a fixture app "basic-app"
+    And app "basic-app" is using config "disabled-manifest"
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Then the following files should not exist:
+      | build/imageoptim.manifest.yml |
+
+  Scenario: Skipping optimization when the timestamp hasn't changed
+    Given a fixture app "basic-app"
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Given a modification time for a file named "build/images/table.jpg"
+    Given some time has passed
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Then the file "build/images/table.jpg" should not have been updated
+
+  Scenario: Regenerating the build image if the source has changed
+    Given a fixture app "basic-app"
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Given a modification time for a file named "build/images/table.jpg"
+    Given some time has passed
+    Given an updated file at "source/images/table.jpg"
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Then the file "build/images/table.jpg" should have been updated

data/features/optimization.feature

@@ -0,0 +1,10 @@
+Feature: Optimization
+  Scenario: Basic optimization
+    Given a fixture app "basic-app"
+    Then the following files should exist:
+      | source/images/table.jpg      |
+    Then the file "source/images/table.jpg" should be 225252 bytes
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Then the following files should exist:
+      | build/images/table.jpg |
+    Then the file "build/images/table.jpg" should be less than 225252 bytes

data/features/permissions.feature

@@ -0,0 +1,14 @@
+Feature: Permissions
+  Scenario: Preserving permissions
+    Given a fixture app "basic-app"
+    Then the following files should exist:
+      | source/images/table.jpg      |
+      | source/images/oh_my_glob.gif |
+    Then the mode of filesystem object "source/images/table.jpg" should match "0644"
+    Then the mode of filesystem object "source/images/oh_my_glob.gif" should match "0644"
+    Given a successfully built app at "basic-app" with flags "--verbose"
+    Then the following files should exist:
+      | build/images/table.jpg      |
+      | build/images/oh_my_glob.gif |
+    Then the mode of filesystem object "build/images/table.jpg" should match "0644"
+    Then the mode of filesystem object "build/images/oh_my_glob.gif" should match "0644"

data/features/support/env.rb

@@ -0,0 +1,7 @@
+ENV['TEST'] = 'true'
+ENV['AUTOLOAD_SPROCKETS'] = 'false'
+
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require 'middleman-imageoptim'

data/features/support/step_definitions.rb

@@ -0,0 +1,39 @@
+Then(/^the file "(.*?)" should be (\d+) bytes$/) do |img, size|
+  expect(File.size(File.join(current_dir, img))).to eql(size.to_i)
+end
+
+Then(/^the file "(.*?)" should be less than (\d+) bytes$/) do |img, size|
+  expect(File.size(File.join(current_dir, img))).to be < size.to_i
+end
+
+Then(/^the manifest should have the right timestamp for "(.*?)"$/) do |file|
+  manifest = YAML.load(File.read(manifest_path))
+  file_stamp = File.mtime(File.join(current_dir, file))
+  expect(manifest[file]).to eql(file_stamp)
+end
+
+Given(/^a primed manifest for "(.*?)"$/) do |file|
+  manifest = { file: File.mtime(File.join(current_dir, file)) }
+  File.open(path, 'w') do |manifest_file|
+    manifest_file.write(YAML.dump(manifest))
+  end
+end
+
+Given(/^some time has passed$/) do
+  # this needs to be > 1 to get out of the single second resolution of a
+  # file timestamp
+  sleep(1.5)
+end
+
+Given(/^an updated file at "(.*?)"$/) do |file|
+  FileUtils.touch(File.join(current_dir, file))
+end
+
+Then(/^the file "([^\"]*)" should have been updated$/) do |file|
+  target = File.join(current_dir, file)
+  expect(File.mtime(target)).not_to eql(@modification_times[target])
+end
+
+def manifest_path
+  File.join(current_dir, 'build', 'imageoptim.manifest.yml')
+end

data/fixtures/basic-app/config-disabled-manifest.rb

@@ -0,0 +1,3 @@
+activate :imageoptim do |options|
+  options.manifest = false
+end

data/fixtures/basic-app/config.rb

@@ -0,0 +1 @@
+activate :imageoptim

data/lib/middleman-imageoptim.rb

@@ -1,15 +1,19 @@
-require "middleman-core"
-require "middleman-imageoptim/optimizer"
-require "middleman-imageoptim/options"
+require 'middleman-core'
+require 'middleman-imageoptim/optimizer'
+require 'middleman-imageoptim/options'
+require 'middleman-imageoptim/resource_list'
+require 'middleman-imageoptim/utils'
+require 'middleman-imageoptim/manifest'
+require 'middleman-imageoptim/manifest_resource'
 
 ::Middleman::Extensions.register(:imageoptim) do
-  require "middleman-imageoptim/extension"
-  ::Middleman::Imageoptim
+  require 'middleman-imageoptim/extension'
+  ::Middleman::Imageoptim::Extension
 end
 
 ::Middleman::Extensions.register(:image_optim) do
-  warn ":image_optim is deprecated. Please use `:imageoptim` instead."
+  warn ':image_optim is deprecated. Please use `:imageoptim` instead.'
 
-  require "middleman-imageoptim/extension"
-  ::Middleman::Imageoptim
+  require 'middleman-imageoptim/extension'
+  ::Middleman::Imageoptim::Extension
 end

data/lib/middleman-imageoptim/extension.rb

@@ -1,24 +1,25 @@
-require "middleman-core"
+require 'middleman-core'
 
 module Middleman
-
   # Middleman extension entry point
   module Imageoptim
-    class << self
-      def registered(app, options_hash = {}, &block)
-        options = Middleman::Imageoptim::Options.new(options_hash)
-        yield options.user_options if block_given?
-
-        app.after_configuration do
+    class Extension < Middleman::Extension
+      def after_build(builder)
+        Middleman::Imageoptim::Optimizer.optimize!(app, builder, options)
+      end
 
-          app.after_build  do |builder|
-            Middleman::Imageoptim::Optimizer.new(app, builder, options).optimize!
-          end
+      def manipulate_resource_list(resources)
+        return resources unless options.manifest
+        Middleman::Imageoptim::ResourceList.manipulate(app, resources, options)
+      end
 
-        end
+      private
 
+      def setup_options(options_hash = {}, &_block)
+        @options = Middleman::Imageoptim::Options.new(options_hash)
+        yield @options if block_given?
+        @options.freeze
       end
-      alias :included :registered
     end
   end
 end

data/lib/middleman-imageoptim/manifest.rb

@@ -0,0 +1,52 @@
+module Middleman
+  module Imageoptim
+    class Manifest
+      MANIFEST_FILENAME = 'imageoptim.manifest.yml'
+
+      attr_reader :app
+
+      def initialize(app)
+        @app = app
+      end
+
+      def path
+        File.join(app.build_dir, MANIFEST_FILENAME)
+      end
+
+      def build_and_write(new_resources)
+        write(dump(build(new_resources)))
+      end
+
+      def resource(key)
+        resources[key.to_s]
+      end
+
+      private
+
+      def resources
+        @resources ||= load(path)
+      end
+
+      def dump(source)
+        YAML.dump(source)
+      end
+
+      def load(path)
+        YAML.load(File.read(path))
+      end
+
+      def build(resources)
+        resources.inject({}) do |new_manifest, resource|
+          new_manifest[resource.to_s] = File.mtime(resource)
+          new_manifest
+        end
+      end
+
+      def write(manifest)
+        File.open(path, 'w') do |manifest_file|
+          manifest_file.write(manifest)
+        end
+      end
+    end
+  end
+end