svgeez 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5457b1190e893a9dfac8629a5c06463147685837
-  data.tar.gz: 6c0998ebc8e795b5b5aa2a1953b8824d18c300c0
+  metadata.gz: a3c37bab4033eb6499bc4d2bdfbdfd11c882de9d
+  data.tar.gz: a527d2cdf19b23775367fd9395941dd80d3ca1c4
 SHA512:
-  metadata.gz: 70edd657348bc0d4b44add8f3516b20fcc715e56e9f99601f944f067adee1856a4ae2e4f4b0c16e33dcd5b9242c8449c03c7d1c7b8d0f9e141e3e53cc0facce4
-  data.tar.gz: 6472cae9a52960be99f3349db60283c42cc342b3aad1027c60b58639be049c48a8a08530b010699b991ffb02d648de1d28186c92a762a48a6faaf53595881031
+  metadata.gz: 7b7c8277a22af454dda0b22827b370e1abbf6cb5324a4ddee1e1544b3338237a3eb00c01b7fb0bba6b350109548089c6f92431404a5e5204b3bc8e66676a8439
+  data.tar.gz: b21f4895462d5662266b7f22df1e8a673db0641f031fe6dd50cfce77b458497d6b4bd8cb398c06cd67d4fcaacaec70a1e62b580fc7120777201bd01d1b776f03

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.2.4

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
   - 2.2.3
-before_install: gem install bundler -v 1.10.6
+  - 2.2.4
+notifications:
+  email: false
+  slack: sixtwothree:yATLmjTW15443qR7jbCWr3RO

data/CONTRIBUTING.md

@@ -11,9 +11,9 @@ I definitely appreciate your interest in (and help improving) svgeez. Thanks!
 
 ## Installation
 
-svgeez is a written in [Ruby](https://www.ruby-lang.org/en/) (version 2.2.3) and development dependencies are managed using the [Bundler](http://bundler.io/) gem.
+svgeez is a written in [Ruby](https://www.ruby-lang.org/en/) (version 2.2.4) and development dependencies are managed using the [Bundler](http://bundler.io/) gem.
 
-I manage Ruby versions with [rbenv](https://github.com/rbenv/rbenv). I'd recommend you do the same or use a similar Ruby version manager ([chruby](https://github.com/postmodern/chruby/) or [RVM](https://rvm.io/) come to mind). Once you've installed Ruby 2.2.3 using your method of choice, install the project's gems by running:
+I manage Ruby versions with [rbenv](https://github.com/rbenv/rbenv). I'd recommend you do the same or use a similar Ruby version manager ([chruby](https://github.com/postmodern/chruby/) or [RVM](https://rvm.io/) come to mind). Once you've installed Ruby 2.2.4 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/Gemfile

@@ -1,5 +1,3 @@
-ruby '2.2.3'
-
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in svgeez.gemspec

data/README.md

@@ -5,6 +5,7 @@
 [![Gem Version](https://badge.fury.io/rb/svgeez.svg)](https://badge.fury.io/rb/svgeez)
 [![Build Status](https://travis-ci.org/jgarber623/svgeez.svg?branch=master)](https://travis-ci.org/jgarber623/svgeez)
 [![Code Climate](https://codeclimate.com/github/jgarber623/svgeez/badges/gpa.svg)](https://codeclimate.com/github/jgarber623/svgeez)
+[![Test Coverage](https://codeclimate.com/github/jgarber623/svgeez/badges/coverage.svg)](https://codeclimate.com/github/jgarber623/svgeez/coverage)
 
 If you're using an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icon system in your Web projects, svgeez can help speed up your workflow by automating the SVG sprite generation process. Simply run svgeez alongside your existing project (or integrate it into your current build system); add, edit, or delete SVG files from a folder; and marvel as svgeez generates a single SVG sprite file ready for inclusion in your user interface.
 
@@ -18,16 +19,16 @@ _For more on why SVG sprites are the bee's knees as far as icon systems go, give
 
 ## Getting Started
 
-Before installing and using svgeez, you'll want to have Ruby 2.2.3 installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). If you're developing on a Mac and using [Homebrew](http://brew.sh/), installing rbenv is [super easy](https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x).
+Before installing and using svgeez, you'll want to have Ruby 2.2.4 installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). If you're developing on a Mac and using [Homebrew](http://brew.sh/), installing rbenv is [super easy](https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x).
 
-svgeez _might_ work with other versions of Ruby, but it's tested against 2.2.3.
+svgeez _might_ work with other versions of Ruby, but it's developed in 2.2.4.
 
 ## Installation
 
 If you're using Bundler, add svgeez to your project's Gemfile:
 
 ```rb
-ruby '2.2.3'
+ruby '2.2.4'
 
 source 'https://rubygems.org' do
   gem 'svgeez'
@@ -100,22 +101,28 @@ For example, a file named `menu.svg` in `~/Sites/sixtwothree.org/images/icons` w
 </symbol>
 ```
 
+**Note:** Single quotes, double quotes, and spaces in individual icon file names will be replaced with dashes. This _could_ result in two `<symbol>`s with the same `id` attribute value. Keep this in mind when naming your source icon files.
+
 ### Markup
 
-To use an svgeez-generated SVG sprite file, first include the file's contents at the top of your HTML page, just after the opening `<body>` element.
+To use an svgeez-generated SVG sprite file, first include the file's contents at the bottom of your HTML page.
 
 In a Rails 4 application:
 
 ```erb
 <body>
-    <%= raw assets.find_asset('icons.svg') %>
+    <!-- Your page’s awesome content goes here! -->
+
+    <%= raw Rails.application.assets.find_asset('icons.svg') %>
 </body>
 ```
 
 Or, with PHP:
 
-```php
+```html
 <body>
+    <!-- Your page’s awesome content goes here! -->
+
     <?php include_once('path/to/icons.svg'); ?>
 </body>
 ```
@@ -130,12 +137,12 @@ A more complete example from a Rails 4 application's layout file:
 
 ```erb
 <body>
-    <%= raw assets.find_asset('icons.svg') %>
-
     <button>
         <svg><use xlink:href="#icons-menu"></svg>
         Menu
     </button>
+
+    <%= raw Rails.application.assets.find_asset('icons.svg') %>
 </body>
 ```
 
@@ -153,7 +160,7 @@ button {
 }
 
 button svg {
-    fill: #c00; // Absent this declaration, the icon's fill color would be #333
+    fill: #c00; // Absent this declaration, the icon’s fill color would be #333
 }
 ```
 

data/bin/svgeez

@@ -12,7 +12,7 @@ Mercenary.program(:svgeez) do |p|
 
   Svgeez::Command.subclasses.each { |c| c.init_with_program(p) }
 
-  p.action do |args, options|
+  p.action do |args, _|
     if args.empty?
       puts p
       abort

data/lib/svgeez/commands/watch.rb

@@ -19,13 +19,13 @@ module Svgeez
         def process(options)
           Svgeez.logger.info %{Watching `#{File.expand_path(options['source'])}` for changes... Press ctrl-c to stop.}
 
-          listener = Listen.to(options['source'], only: /\.svg$/) do |modified, added, removed|
+          listener = Listen.to(options['source'], only: /\.svg$/) do
             Svgeez::Commands::Build.process(options)
           end
 
           listener.start
           sleep
-        rescue Interrupt => e
+        rescue Interrupt
         end
       end
     end

data/lib/svgeez/sprite_builder.rb

@@ -37,11 +37,15 @@ module Svgeez
       %{<svg id="#{destination_file_id}" style="display: none;" version="1.1">}.tap do |destination_file_contents|
         # Loop over all source files, grabbing their content, and appending to `destination_file_contents`
         source_file_paths.each do |file_path|
-          file_contents = use_svgo? ? `svgo -i #{file_path} -o -` : IO.read(file_path)
+          file_contents = IO.read(file_path)
           pattern = /^<svg.*?(?<viewbox>viewBox=".*?").*?>(?<content>.*?)<\/svg>/m
 
+          if use_svgo?
+            file_contents = `cat <<EOF | svgo -i - -o -\n#{file_contents}\nEOF`
+          end
+
           file_contents.match(pattern) do |matches|
-            destination_file_contents << %{<symbol id="#{destination_file_id}-#{File.basename(file_path, '.svg').downcase}" #{matches[:viewbox]}>#{matches[:content]}</symbol>}
+            destination_file_contents << %{<symbol id="#{destination_file_id}-#{File.basename(file_path, '.svg').gsub(/['"\s]/, '-').downcase}" #{matches[:viewbox]}>#{matches[:content]}</symbol>}
           end
         end
 
@@ -78,7 +82,7 @@ module Svgeez
     end
 
     def source_is_destination?
-      @source == destination_folder_path
+      %r{^#{@source}} =~ destination_folder_path
     end
 
     def svgo_installed?

data/lib/svgeez/version.rb

@@ -1,3 +1,3 @@
 module Svgeez
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/svgeez.rb

@@ -16,7 +16,7 @@ module Svgeez
     end
   end
 
-  self.logger.formatter = proc do |severity, datetime, progname, msg|
+  self.logger.formatter = proc do |_, _, _, msg|
     %{#{msg}\n}
   end
 end

data/svgeez.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'listen', '~> 3.0'
-  spec.add_runtime_dependency 'mercenary', '~> 0.3'
-
   spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'listen', '~> 3.0'
+  spec.add_runtime_dependency 'mercenary', '~> 0.3'
 end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: svgeez
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: mercenary
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
+        version: '1.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: Automatically generate an SVG sprite from a folder of SVG icons.
 email:
 - jason@sixtwothree.org