middleman-scavenger 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff8b44f8dbce06ca842ceb97ff6361517944a5a9
-  data.tar.gz: be77b5fdecdb4256b1edb8fc4abaec7c36267a43
+  metadata.gz: 2249fd88795e0594c5d497c2ebba0b7ff9c7daaf
+  data.tar.gz: 919da96b31f4e656869bc21b3ed6faac1e931ba7
 SHA512:
-  metadata.gz: 442e333059553fe734ef7b3e4c0077aab40727cd3a7cb360f0590243fd2b32b700ead857d6365b891fcffb9bebac4123b987c8e8d63d2ebec1ab469fea1338fb
-  data.tar.gz: 459c6ef5920597aa693118e370593ac7a269148888b1fb737b4ac83606cc82cb9c835fcbc1987e91926d74ed5ee0e1bcc15cc1528c55f9245ed907d25320f937
+  metadata.gz: cb823d68707d7ffcf449934b812e4dc0dd071c240cbf9a0992e58d019869b6c98bd2cb9374d03e07c6784eb552cc3c6d223878bd0a1efab78317052340d24348
+  data.tar.gz: 142ebfb3a55305915275f2efe2dfcddd6c7c87b40217197fdd1e17301598fc344f68418e649333929bb49af86b3bab4c9fe7560e592b0370c97f78a9419b2857

data/README.md

@@ -4,6 +4,13 @@
 
 A Middleman extension for creating svg sprite sheets. It's usable in modern (IE9+) browsers, uses `<symbol>` to include the svg:s, and can optionally inline the SVG images for speed. If you need legacy browser support it combines well with [svg4everybody](https://github.com/jonathantneal/svg4everybody).
 
+## Important info about older and newer middleman versions!
+
+A bunch of things have happened in Middleman core since this plugin was created. There were some changes between minor versions in Middleman 3.x in regard to how files are resolved. This created some unfortunate incompatibilities in middleman-scavenger and to simplify things, the master branch of middleman-scavenger is only compatible with 3.4.x. Middleman 4 has thrown out the Sprockets asset pipeline completely, which is... interesting for us. So, in short:
+
+- If you're using Middleman 3.4.x, just include everything as usual
+- If you're on Middleman 3.3.x (or maybe earlier?) you should lock your version of `middleman-scavenger` to 1.0.2
+- If you've upgraded to Middleman 4, hold on while we figure things out and use [This branch](https://github.com/varvet/middleman-scavenger/tree/feature/middleman-4-support) in the meantime, as documented [here](https://github.com/varvet/middleman-scavenger/pull/11).
 
 ## Installation and quick start
 
@@ -26,7 +33,7 @@ If you don't like the default settings, you can change them at activation time.
   activate :middleman_scavenger do |config|
     config.path = "./source/my-svg-directory/"
     config.prefix = "icon-"
-    config.sprite_path = "another-directory/my-sprite.svg"
+    config.sprite_path = "source/javascripts/my-sprite.svg"
   end
 ```
 
@@ -54,14 +61,14 @@ If you want to reference the sprite directly, you can use `scavenger_sprite_path
 
 Middleman-scavenger uses an SVG processor based on [Nokogiri](http://www.nokogiri.org) to load and parse the SVG images in the folder into a sprite sheet, each image in its own `<symbol>` with its own viewBox. The sprite sheet is cached in memory and written to disk, so it can be asynchronously loaded or quickly inlined into the document. Whenever an SVG is added, removed, or changed in development mode Middleman-scavenger will make a new in-memory and on-disk version. The rebuild process fires at build time as well.
 
-The bundled javascript will asynchronously load the SVG sprite sheet as text and insert it at the top of the body. This makes it possible to control the SVG sprites via CSS. An externally referenced SVG will create a shadow DOM boundary that is impossible to cross, but inserting the sprite sheet into the document removes that obstacle and makes for easy transitions and hover states.
+The bundled javascript will asynchronously load the SVG sprite sheet as text and insert it at the top of the body. This makes it possible to control the SVG sprites via CSS. An externally referenced SVG will create a shadow DOM boundary that is impossible to cross, but inserting the sprite sheet into the document removes that obstacle and makes it possible to control transitions and hover states.
 
 
 ## Gotchas
 
 ### Sizing
 
-SVG sizing is always a little difficult, and even more so with sprite sheets. Middleman-scavenger uses [Nokogiri](http://www.nokogiri.org) to parse the SVG images and put them in `<symbol>` elements, so each image can have its own viewBox. That way, they will scale as expected when given width or height parameters. Including an SVG without sizing information will constrain it to the dimensions of the element it was included in, so it's advisable to add `width:` or `height:` or a styled CSS selector to the `svg` helper.
+SVG sizing is always a little difficult, and even more so with sprite sheets. Middleman-scavenger allows each image to have its own viewBox, which means they will scale as expected when given width or height parameters. Including an SVG without sizing information will constrain it to the dimensions of the element it was included in, so it's advisable to add `width:` or `height:` or a styled CSS selector to the `svg` helper.
 
 
 ### FONI

data/assets/javascripts/middleman-scavenger.js.erb

@@ -7,7 +7,7 @@
   function requestSprite() {
     var oReq = new XMLHttpRequest();
     oReq.addEventListener('load', requestListener);
-    oReq.open('GET', '<%= image_path svg_sprite_path %>');
+    oReq.open('GET', '<%= scavenger_sprite_path %>');
     oReq.send();
   }
 

data/lib/middleman-scavenger.rb

@@ -5,7 +5,7 @@ require "middleman-core"
 class MiddlemanScavenger < ::Middleman::Extension
   option :path, "./source/images/svg", "Directory containing SVG files"
   option :prefix, "", "Optional prefix for icon names"
-  option :sprite_path, "sprite.svg", "Static file to write svg spritesheet to"
+  option :sprite_path, "./source/images/sprite.svg", "Static file to write svg spritesheet to"
 
   def initialize(app, options_hash={}, &block)
     super
@@ -34,7 +34,7 @@ class MiddlemanScavenger < ::Middleman::Extension
 
   helpers do
     def scavenger_sprite_path
-      image_path svg_sprite_path
+      image_path File.basename(svg_sprite_path)
     end
 
     def inline_svg_sprite
@@ -42,7 +42,7 @@ class MiddlemanScavenger < ::Middleman::Extension
     end
 
     def svg(name, options=nil)
-      if defined?(options)
+      if !options.nil?
         attrs = options.map {|k,v| "#{k}=\"#{v}\"" }.join(" ")
         "<svg #{attrs}><use xlink:href=\"##{name}\" /></svg>"
       else

data/lib/svg_processor.rb

@@ -10,7 +10,7 @@ class SVGProcessor
 
   def rebuild
     @svgs = Dir["#{@path}/*.svg"].map { |file| get_svg(file) }
-    logger.debug "rebuilding: #{@svgs.length} svgs found"
+    logger.info "rebuilding: #{@svgs.length} svgs found"
     @symbols = @svgs.map { |svg| convert_to_symbol(svg) }
 
     @symbol_string = @symbols.join("\n")

data/middleman-scavenger.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "middleman-scavenger"
-  s.version     = "1.0.3"
+  s.version     = "1.0.4"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Johan Halse"]
   s.email       = ["johan.halse@varvet.com"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # The version of middleman-core your extension depends on
-  s.add_runtime_dependency("middleman-core", [">= 3.3.1", "< 4.0.0"])
+  s.add_runtime_dependency("middleman-core", [">= 3.4.0", "< 4.0.0"])
 
   # Additional dependencies
   s.add_runtime_dependency("nokogiri", "~> 1.6")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-scavenger
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Johan Halse
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.4.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.4.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0