middleman-svg-fallback 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDhjMWNmNjBkNzM4MDVlYWQzZjNkYzVlY2VhM2Q3NDYxNTA3NGI0NA==
-  data.tar.gz: !binary |-
-    M2M4NzM4OTAxNGE5YjAxMTE1MzcyZWM0NzA3OWMyNDAxNTc2Y2MwMg==
+SHA256:
+  metadata.gz: c7d83bf9de5ce0590258e6eaf65979d1f28af8dcd78698ae342d7d9f67325156
+  data.tar.gz: d53d4112953eea550a819332574a74d22bbe4e6da2527d6bf6855446627d6923
 SHA512:
-  metadata.gz: !binary |-
-    NjlmOTE4Y2ZkMDAxZTg0ZTliYmFjN2VlYjM0N2YzYjkzNjY2M2RmMGZmZmMy
-    OGM1MmE5NGM2Mzc4NDEzNmI0NzUyOWFhM2MwZjRjOWZlYWU3MzUwZGYyMTZk
-    OTAwNDY3NTgzMGIwMmQyYWEzMmY0NmRjNzg3ZjgxYjhjOTY0Nzk=
-  data.tar.gz: !binary |-
-    OGIwOWFlYWIzM2M0ZGYyMWVkOGU5Mjg2MTQwNmMwNjA1ZjZjY2E4ZTk1ZTVh
-    ZTIyMzc3MGI0NTE3YmFmNjAwNjk1ZmU4MjM5NTUyYWVjYWJkYTc5OTM2OTU3
-    YjIyZjk4ZTIyYTdkMDczM2M5ZTMzODQ3ZTkwMjYyZGM1YTVkMjI=
+  metadata.gz: 0afa98f3a0c9b407e59a58f32c2737538780ce4c4bf0fa868c0f9a13a37f7e9484be7f41a67a2a36d2baec852d506920ed417dae431b9e981eb130004ee0aa56
+  data.tar.gz: c09cc10f4db603102c2d680daf716d46c3595dec67d6e2642abaf08f456bb1fee8b4413910d1b3eef8349d6bb4f3e295b77efbe20f8116d1a30506227af9929b

data/.gitignore

@@ -1,5 +1,3 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-.rvmrc
+/Gemfile.lock
+/pkg
+/tmp

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to middleman-svg-fallback will be documented in this file.
+
+## v0.2.0
+
+* Require inkscape 1.0 or newer
+* Require imagemagick with the `convert` program

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012-2017 Jan Schulz-Hofen
+
+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

@@ -14,18 +14,36 @@ Add this line to your `Gemfile`:
 gem 'middleman-svg-fallback'
 ```
 
-And something like this to your `config.rb`:
+
+## Configuration
+
+Activate the plugin in your config.rb:
+
+```ruby
+activate :svg_fallback
+```
+
+You may provide the path to your inkscape binary, if it's not in the `PATH`.
+E.g. on macOS, you may use the following configuration:
+
+```ruby
+activate :svg_fallback, inkscape_bin: '/Applications/Inkscape.app/Contents/Resources/bin/inkscape'
+```
+
+Furthermore, you may configure command line arguments, that should be passed on
+to inkscape:
 
 ```ruby
-  require "middleman-svg-fallback"
-  activate :svg_fallback,
-    :inkscape_bin => '/Applications/Inkscape.app/Contents/Resources/bin/inkscape',
-    :inkscape_options => '--export-dpi=100 --export-background-opacity=0'
+activate :svg_fallback, inkscape_options: '--export-dpi=100 --export-background-opacity=0'
 ```
 
-(supposed you're working on a Mac)
 
-Then, during build, middleman-svg-fallback will generate the fallbacks as you would expect and you can use them with a [modernizr](http://modernizr.com/) based CSS rule, like this for example:
+## Usage
+
+If configured properly, middleman-svg-fallback will generate fallback images
+(PNGs and JPGs) for all SVGs within your `images_dir` as you would expect. You
+can use them with a [modernizr](http://modernizr.com/) based CSS rule, like this
+for example:
 
 ```css
 .illustration {
@@ -37,17 +55,15 @@ Then, during build, middleman-svg-fallback will generate the fallbacks as you wo
 }
 ```
 
-The JPEG files are intended for use with [OpenGraph](http://ogp.me/). Facebook doesn't like PNGs in `og:image` properties, so the JPG versions will come in handy.
+The generated JPEG files are intended for use with [OpenGraph](http://ogp.me/).
+Facebook doesn't like PNGs in `og:image` properties, so the JPG versions will
+come in handy.
 
-## License
 
-MIT; Copyright (c) 2012 Jan Schulz-Hofen
-
-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:
+## License
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+This software is licensed under the MIT License. [View the license](LICENSE).
 
-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.
 
 ## Contributing
 
@@ -55,4 +71,16 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request
+
+
+## Running the tests
+
+To run the tests follow these steps:
+
+1. Clone the repository
+2. Run `bundle install` to install all development dependencies
+3. Use `rake` to execute the test suite
+   a. If inkscape is not in your PATH, you may provide the optional
+      `INKSCAPE_PATH` environment variable, e.g.
+      `INKSCAPE_PATH=/path/to/inkscape rake`

data/Rakefile

@@ -1,2 +1,14 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-svg-fallback')

data/features/svg-fallback.feature

@@ -0,0 +1,36 @@
+Feature: Create fallbacks for SVG images
+
+  Scenario: No changes if svg-fallback is not activated
+    Given a fixture app "image-app"
+    And a file named "config.rb" with:
+      """
+      """
+    And a successfully built app at "image-app"
+    Then the file "build/images/sample.svg" should exist
+    And the file "build/images/sample.png" should not exist
+    And the file "build/images/sample.jpg" should not exist
+    And the file "build/images/sample.svgz" should not exist
+
+    And the file "build/images/sample2.svgz" should exist
+    And the file "build/images/sample2.png" should not exist
+    And the file "build/images/sample2.jpg" should not exist
+    And the file "build/images/sample2.svg" should not exist
+
+
+  Scenario: Creates svgz, jpg, and png if svg-fallback is activated
+    Given a fixture app "image-app"
+    And a file named "config.rb" with:
+      """
+        activate :svg_fallback, inkscape_bin: ENV['INKSCAPE_BIN'] || 'inkscape'
+      """
+    And a successfully built app at "image-app"
+
+    Then the file "build/images/sample.svg" should exist
+    And the file "build/images/sample.png" should exist
+    And the file "build/images/sample.jpg" should exist
+    And the file "build/images/sample.svgz" should exist
+
+    And the file "build/images/sample2.svgz" should exist
+    And the file "build/images/sample2.png" should exist
+    And the file "build/images/sample2.jpg" should exist
+    And the file "build/images/sample2.svg" should exist

data/fixtures/image-app/source/images/sample.svg

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+
+<svg xmlns="http://www.w3.org/2000/svg"
+     width="467" height="462">
+  <rect x="80" y="60" width="250" height="250" rx="20"
+      style="fill:#ff0000; stroke:#000000;stroke-width:2px;" />
+
+  <rect x="140" y="120" width="250" height="250" rx="40"
+      style="fill:#0000ff; stroke:#000000; stroke-width:2px;
+      fill-opacity:0.7;" />
+
+  <rect x="140" y="120" width="250" height="250" rx="40"
+      style="fill:#00ff00; stroke:#0000cc; stroke-width:5px;
+      fill-opacity:1.0;" />
+</svg>

data/lib/middleman/svg_fallback.rb

@@ -0,0 +1,36 @@
+class Middleman::SVGFallback < Middleman::Extension
+  option :inkscape_bin, 'inkscape', 'Path to Inkscape binary, e.g. "/Applications/Inkscape.app/Contents/Resources/bin/inkscape" on a Mac, defaults to "inkscape"'
+  option :inkscape_options, '', 'Command line arguments, that shall be passed on to inkscape, e.g. "--export-dpi=100 --export-background-opacity=0", defaults to ""'
+
+  option :convert_bin, 'convert', 'Path to convert binary, e.g. "/usr/local/bin/convert" on a Mac, defaults to "convert"'
+  option :convert_options, '', 'Command line arguments, that shall be passed on to convert", defaults to ""'
+
+  def after_build(builder)
+    dir = File.join(app.config[:build_dir], app.config[:images_dir])
+
+    run_args = { capture: true, verbose:  app.config.cli_options['verbose'] }
+
+    Dir[File.join(dir, '**', '*.svg*')].each do |file|
+      # make sure we have both an svg and an svgz version
+      unprefixed = file.sub(/\.svgz?$/, '')
+      basename = File.expand_path(unprefixed)
+
+      unless File.exists? "#{basename}.svg"
+        builder.thor.run("gunzip --to-stdout #{basename}.svgz > #{basename}.svg", run_args)
+        builder.thor.say_status :svg, "#{unprefixed}.svg"
+      end
+
+      unless File.exists? "#{basename}.svgz"
+        builder.thor.run("gzip --to-stdout #{basename}.svg > #{basename}.svgz", run_args)
+        builder.thor.say_status :svgz, "#{unprefixed}.svgz"
+      end
+
+      # generate fallbacks
+      builder.thor.run("#{options.inkscape_bin} --export-filename=#{basename}.png #{options.inkscape_options} #{basename}.svg", run_args)
+      builder.thor.say_status :svg_fallback, "#{unprefixed}.png"
+
+      builder.thor.run("#{options.convert_bin} #{options.convert_options} #{basename}.png #{basename}.jpg", run_args)
+      builder.thor.say_status :svg_fallback, "#{unprefixed}.jpg"
+    end
+  end
+end

data/lib/middleman-svg-fallback.rb

@@ -1,8 +1,6 @@
-require "middleman-core"
+require 'middleman-core'
 
-require "middleman-svg-fallback/version"
-
-::Middleman::Extensions.register(:svg_fallback) do
-  require "middleman-svg-fallback/extension"
-  ::Middleman::SVGFallback
-end
+Middleman::Extensions.register(:svg_fallback) do
+  require 'middleman/svg_fallback'
+  Middleman::SVGFallback
+end

data/middleman-svg-fallback.gemspec

@@ -1,21 +1,26 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "middleman-svg-fallback/version"
 
 Gem::Specification.new do |s|
   s.name        = "middleman-svg-fallback"
-  s.version     = Middleman::SVGFallback::VERSION
+  s.version     = "0.2.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jan Schulz-Hofen"]
   s.email       = ["jan@launchco.com"]
-  s.homepage    = "https://github.com/yeah/middleman-svg-fallback"
+  s.homepage    = "https://github.com/planio-gmbh/middleman-svg-fallback"
   s.summary     = %q{Generate nice JPEG and PNG files from any SVG files.}
   s.description = s.summary
+  s.license = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency("middleman", [">= 3.0.0"])
-  s.add_runtime_dependency("rake", [">= 0"])
+  s.add_runtime_dependency("middleman-core", "~> 4.2")
+
+  s.add_development_dependency("aruba")
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("capybara")
+  s.add_development_dependency("cucumber")
+  s.add_development_dependency("middleman-cli")
+  s.add_development_dependency("rake")
 end

metadata

@@ -1,41 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: middleman-svg-fallback
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jan Schulz-Hofen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: middleman
+  name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: middleman-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Generate nice JPEG and PNG files from any SVG files.
@@ -45,36 +115,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
+- features/support/env.rb
+- features/svg-fallback.feature
+- fixtures/image-app/source/images/sample.svg
+- fixtures/image-app/source/images/sample2.svgz
 - lib/middleman-svg-fallback.rb
-- lib/middleman-svg-fallback/extension.rb
-- lib/middleman-svg-fallback/version.rb
-- lib/middleman_extension.rb
+- lib/middleman/svg_fallback.rb
 - middleman-svg-fallback.gemspec
-homepage: https://github.com/yeah/middleman-svg-fallback
-licenses: []
+homepage: https://github.com/planio-gmbh/middleman-svg-fallback
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.7
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Generate nice JPEG and PNG files from any SVG files.
-test_files: []
+test_files:
+- features/support/env.rb
+- features/svg-fallback.feature

data/lib/middleman-svg-fallback/extension.rb

@@ -1,42 +0,0 @@
-require 'rake'
-module Middleman
-  module SVGFallback
-    class << self
-      def registered(app, options={})
-
-        options[:inkscape_bin] ||= 'inkscape'
-
-        app.after_configuration do
-
-          dir = File.join(build_dir, images_dir)
-          prefix = build_dir + File::SEPARATOR
-
-          after_build do |builder|
-            files = FileList["#{dir}/**/*.svg*"]
-
-            files.each do |file|
-              # make sure we have both an svg and an svgz version
-              basename = File.expand_path(file.sub(/\.svgz?$/,''))
-
-              unless File.exists? "#{basename}.svg"
-                `gunzip --to-stdout --suffix .svgz  #{basename}.svgz > #{basename}.svg`
-                builder.say_status :svg, "#{basename}.svg"
-              end
-              unless File.exists? "#{basename}.svgz"
-                `gzip --to-stdout #{basename}.svg > #{basename}.svgz`
-                builder.say_status :svgz, "#{basename}.svgz"
-              end
-
-              # generate fallbacks
-              %w(jpg png).each do |ext|
-                `#{options[:inkscape_bin]} --export-png=#{basename}.#{ext} #{options[:inkscape_options]} --without-gui #{basename}.svg > /dev/null 2>&1`
-                builder.say_status :svg_fallback, "#{basename}.#{ext}"
-              end
-            end
-          end
-        end
-      end
-      alias :included :registered
-    end
-  end
-end

data/lib/middleman-svg-fallback/version.rb

@@ -1,5 +0,0 @@
-module Middleman
-  module SVGFallback
-    VERSION = "0.1.1"
-  end
-end

data/lib/middleman_extension.rb

@@ -1 +0,0 @@
-require "middleman-svg-fallback"