svgeez 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c36326d5848bbca6e2cad29119a27e1c20b8f31
-  data.tar.gz: 8d2e00d295b978f00321b649c9e3032b15aa671b
+  metadata.gz: 4b5e6d929efa9fcb5c48283aada61cf024d4bdb7
+  data.tar.gz: 86611eebed02b5c8980743bdfe17b6eb044835a6
 SHA512:
-  metadata.gz: 44b7acb9b4d0949341df569e959f680ba4f1fe1ca5989d2cd04c1022d354b77550b3be8dcf7f758a37a8e929d01a73f85fc2d49b40f01eb4ac25f7ee3229197b
-  data.tar.gz: d9211e89a0a1314cf89281780d4ee7a2f02a061eeb2aae34071d670f86e6112f615b4f2f3039dcaf2f94f3f33c1ec9f7f9759184c94a104ffea9264b619c3dc3
+  metadata.gz: c626b106b2cf43412576b9592543092c43451158a1a041dc9f14e26c3e0be844fe4598a670282e6cffdb02899e6158618185b654957f5b9e1d19141439f43ecf
+  data.tar.gz: f910a1fc6b3a7d4d355f9aef5586826032c1e1f6c24839510cb6cb9b9cfdafeeb1b6e9dade04e365490280c54f149c747b18a3fc265eed2e61f21678d1dc96f3

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
   - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.3.4
+  - 2.4.1
 before_install:
   - npm install -g svgo
 notifications:

data/CONTRIBUTING.md

@@ -11,7 +11,7 @@ I definitely appreciate your interest in (and help improving) svgeez. Thanks!
 
 ## Installation
 
-svgeez is written in [Ruby](https://www.ruby-lang.org/en/) (version 2.2.6) and development dependencies are managed using the [Bundler](http://bundler.io/) gem. [Travis CI builds](https://travis-ci.org/jgarber623/svgeez) are done using Ruby 2.2.6, 2.3.3, and 2.4.0.
+svgeez is written in [Ruby](https://www.ruby-lang.org/en/) (version 2.2.6) and development dependencies are managed using the [Bundler](http://bundler.io/) gem. [Travis CI builds](https://travis-ci.org/jgarber623/svgeez) use Ruby 2.2.6, 2.3.4, and 2.4.1.
 
 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.6 using your method of choice, install the project's gems by running:
 

data/README.md

@@ -2,26 +2,27 @@
 
 **A Ruby gem for automatically generating an SVG sprite from a folder of SVG icons.**
 
-[![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)
+[![Gem Version](https://img.shields.io/gem/v/svgeez.svg?label=gem%20version)](https://rubygems.org/gems/svgeez)
+[![Downloads](https://img.shields.io/gem/dt/svgeez.svg)](https://rubygems.org/gems/svgeez)
+[![Build Status](https://img.shields.io/travis/jgarber623/svgeez/master.svg?label=build%20status)](https://travis-ci.org/jgarber623/svgeez)
+[![Code Climate](https://img.shields.io/codeclimate/github/jgarber623/svgeez.svg)](https://codeclimate.com/github/jgarber623/svgeez)
+[![Coverage](https://img.shields.io/codeclimate/coverage/github/jgarber623/svgeez.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.
+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. 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.
 
 _For more on why SVG sprites are the bee's knees as far as icon systems go, give Chris Coyier's original post, [Icon System with SVG Sprites](https://css-tricks.com/svg-sprites-use-better-icon-fonts/), and his follow-up article, [SVG \`symbol\` a Good Choice for Icons](https://css-tricks.com/svg-symbol-good-choice-icons/) a read-through._
 
 ## Key Features
 
-- Provides a simple [CLI](https://en.wikipedia.org/wiki/Command-line_interface) for generating SVG sprite files.
-- Easily integrates with existing projects (e.g. alongside a Rails application using [Foreman](https://github.com/ddollar/foreman)).
+- Provides a [CLI](https://en.wikipedia.org/wiki/Command-line_interface) for generating SVG sprite files.
+- Integrates with existing projects (e.g. alongside a Rails application using [Foreman](https://github.com/ddollar/foreman)).
 - Optionally optimizes SVG files with [SVGO](https://github.com/svg/svgo/).
 
 ## Getting Started
 
 Before installing and using svgeez, you'll want to have Ruby 2.2.6 (or newer) 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 developed in 2.2.6.
+svgeez _might_ work with other versions of Ruby, but it's developed in 2.2.6 and automatically tested against 2.3.4 and 2.4.1 by [Travis CI](https://travis-ci.org/jgarber623/svgeez).
 
 ## Installation
 
@@ -77,7 +78,13 @@ Tweaking the example from above:
 $ svgeez watch --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
 ```
 
-svgeez will remaing running, watching for new, removed, or updated SVG files in the provided source folder. As SVG files are added, deleted, or modified in the source folder, svgeez will keep pumping out updated SVG sprite files to the destination folder.
+svgeez will remaing running, watching for new, removed, or updated SVG files in the provided source folder. As SVG files are added, deleted, or modified in the source folder, svgeez will pump out updated SVG sprite files to the destination folder.
+
+### Preparing SVG files for svgeez
+
+svgeez works best with well-organized SVG files. If you're using tools like Sketch or Adobe Illustrator, your source SVG files _may_ contain unnecessary cruft like comments and editor-specific attributes. svgeez will do its best to work with source SVG files, but as a general rule it's good practice to make sure that the SVG files exported from your editor are as concise as possible.
+
+The first section of Jayden Seric's post, [How to optimize SVG](http://jaydenseric.com/blog/how-to-optimize-svg), offers some helpful advice on optimizing SVGs prior to exporting from editing software.
 
 ### Optimizing generated files with SVGO
 
@@ -218,6 +225,7 @@ svgeez is written and maintained by [Jason Garber](https://github.com/jgarber623
 - [Brett Wilkins](https://github.com/bwilkins)
 - [danny](https://github.com/f96q)
 - [Denis Hovart](https://github.com/dhovart)
+- [Desmond Sadler](https://github.com/dezman)
 
 ## License
 

data/lib/svgeez.rb

@@ -2,12 +2,20 @@ require 'fileutils'
 require 'listen'
 require 'logger'
 require 'mkmf'
+require 'securerandom'
 
 require 'svgeez/version'
+
 require 'svgeez/command'
 require 'svgeez/commands/build'
 require 'svgeez/commands/watch'
-require 'svgeez/sprite_builder'
+
+require 'svgeez/builder'
+require 'svgeez/destination'
+require 'svgeez/optimizer'
+require 'svgeez/source'
+require 'svgeez/svg_element'
+require 'svgeez/symbol_element'
 
 module Svgeez
   def self.logger

data/lib/svgeez/builder.rb

@@ -0,0 +1,54 @@
+module Svgeez
+  class Builder
+    SOURCE_IS_DESTINATION_MESSAGE = "Setting `source` and `destination` to the same path isn't allowed!".freeze
+    NO_SVGS_IN_SOURCE_MESSAGE = 'No SVGs were found in `source` folder.'.freeze
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def build
+      return Svgeez.logger.error(SOURCE_IS_DESTINATION_MESSAGE) if source_is_destination?
+      return Svgeez.logger.warn(NO_SVGS_IN_SOURCE_MESSAGE) if source_is_empty?
+
+      Svgeez.logger.info "Generating sprite at `#{destination.file_path}` from #{source.file_paths.length} SVG#{'s' if source.file_paths.length > 1}..."
+
+      # Make destination folder
+      FileUtils.mkdir_p(destination.folder_path)
+
+      # Write the file
+      File.open(destination.file_path, 'w') do |f|
+        f.write destination_file_contents
+      end
+
+      Svgeez.logger.info "Successfully generated sprite at `#{destination.file_path}`."
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def destination
+      @destination ||= Destination.new(@options)
+    end
+
+    def source
+      @source ||= Source.new(@options)
+    end
+
+    private
+
+    def destination_file_contents
+      file_contents = SvgElement.new(source, destination).build
+      file_contents = Optimizer.new.optimize(file_contents) if @options['svgo']
+
+      file_contents.insert(4, ' style="display: none;"')
+    end
+
+    def source_is_destination?
+      /\A#{source.folder_path}/ =~ destination.folder_path
+    end
+
+    def source_is_empty?
+      source.file_paths.empty?
+    end
+  end
+end

data/lib/svgeez/commands/build.rb

@@ -9,13 +9,13 @@ module Svgeez
           add_build_options(c)
 
           c.action do |_, options|
-            Svgeez::Commands::Build.process(options)
+            Build.process(options)
           end
         end
       end
 
       def self.process(options)
-        Svgeez::SpriteBuilder.new(options).build
+        Svgeez::Builder.new(options).build
       end
     end
   end

data/lib/svgeez/commands/watch.rb

@@ -9,20 +9,20 @@ module Svgeez
           add_build_options(c)
 
           c.action do |_, options|
-            Svgeez::Commands::Build.process(options)
-            Svgeez::Commands::Watch.process(options)
+            Build.process(options)
+            Watch.process(options)
           end
         end
       end
 
       def self.process(options)
-        sprite_builder = Svgeez::SpriteBuilder.new(options)
+        builder = Svgeez::Builder.new(options)
 
-        listener = Listen.to(sprite_builder.source, only: /\.svg\z/) do
-          sprite_builder.build
+        listener = Listen.to(builder.source.folder_path, only: /\.svg\z/) do
+          builder.build
         end
 
-        Svgeez.logger.info "Watching `#{sprite_builder.source}` for changes... Press ctrl-c to stop."
+        Svgeez.logger.info "Watching `#{builder.source.folder_path}` for changes... Press ctrl-c to stop."
 
         listener.start
         sleep

data/lib/svgeez/destination.rb

@@ -0,0 +1,41 @@
+module Svgeez
+  class Destination
+    DEFAULT_DESTINATION_FILE_NAME = 'svgeez.svg'.freeze
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def file_id
+      @file_id ||= File.basename(file_name, '.svg').tr(' ', '-')
+    end
+
+    def file_name
+      @file_name ||=
+        if destination.end_with?('.svg')
+          File.split(destination)[1]
+        else
+          DEFAULT_DESTINATION_FILE_NAME
+        end
+    end
+
+    def file_path
+      @file_path ||= File.join(folder_path, file_name)
+    end
+
+    def folder_path
+      @folder_path ||=
+        if destination.end_with?('.svg')
+          File.split(destination)[0]
+        else
+          destination
+        end
+    end
+
+    private
+
+    def destination
+      @destination ||= File.expand_path(@options.fetch('destination', "./#{DEFAULT_DESTINATION_FILE_NAME}"))
+    end
+  end
+end

data/lib/svgeez/optimizer.rb

@@ -0,0 +1,17 @@
+module Svgeez
+  class Optimizer
+    SVGO_NOT_INSTALLED = 'Unable to find `svgo` in your PATH. Continuing with standard sprite generation...'.freeze
+
+    def optimize(file_contents)
+      return Svgeez.logger.warn(SVGO_NOT_INSTALLED) unless installed?
+
+      `cat <<EOF | svgo --disable=cleanupIDs -i - -o -\n#{file_contents}\nEOF`
+    end
+
+    private
+
+    def installed?
+      @installed ||= find_executable0('svgo')
+    end
+  end
+end

data/lib/svgeez/source.rb

@@ -0,0 +1,23 @@
+module Svgeez
+  class Source
+    DEFAULT_INPUT_FOLDER_PATH = './_svgeez'.freeze
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def file_paths
+      Dir.glob(file_paths_pattern)
+    end
+
+    def folder_path
+      @folder_path ||= File.expand_path(@options.fetch('source', DEFAULT_INPUT_FOLDER_PATH))
+    end
+
+    private
+
+    def file_paths_pattern
+      @file_paths_pattern ||= File.join(folder_path, '*.svg')
+    end
+  end
+end

data/lib/svgeez/svg_element.rb

@@ -0,0 +1,18 @@
+module Svgeez
+  class SvgElement
+    def initialize(source, destination)
+      @source = source
+      @destination = destination
+    end
+
+    def build
+      %(<svg id="#{@destination.file_id}" version="1.1" xmlns="http://www.w3.org/2000/svg">#{element_contents}</svg>)
+    end
+
+    private
+
+    def element_contents
+      @source.file_paths.map { |file_path| SymbolElement.new(file_path, @destination.file_id).build }.join
+    end
+  end
+end

data/lib/svgeez/symbol_element.rb

@@ -0,0 +1,30 @@
+module Svgeez
+  class SymbolElement
+    def initialize(file_path, file_id)
+      @file_path = file_path
+      @file_id = file_id
+    end
+
+    def build
+      IO.read(@file_path).match(%r{^<svg\s*?(?<attributes>.*?)>(?<content>.*?)</svg>}m) do |matches|
+        %(<symbol #{element_attributes(matches[:attributes]).sort.join(' ')}>#{element_contents(matches[:content])}</symbol>)
+      end
+    end
+
+    private
+
+    def element_attributes(attributes)
+      attrs = attributes.scan(/(?:viewBox|xmlns:.+?)=".*?"/m)
+
+      attrs << %(id="#{@file_id}-#{File.basename(@file_path, '.svg').gsub(/['"\s]/, '-')}")
+    end
+
+    def element_contents(content)
+      content.scan(/\sid="(.+?)"/).flatten.each do |value|
+        content.gsub!(/\s(id|xlink:href)="(#?#{value})"/m, %( \\1="\\2-#{SecureRandom.uuid}"))
+      end
+
+      content
+    end
+  end
+end

data/lib/svgeez/version.rb

@@ -1,3 +1,3 @@
 module Svgeez
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svgeez
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,10 +131,15 @@ files:
 - Rakefile
 - bin/svgeez
 - lib/svgeez.rb
+- lib/svgeez/builder.rb
 - lib/svgeez/command.rb
 - lib/svgeez/commands/build.rb
 - lib/svgeez/commands/watch.rb
-- lib/svgeez/sprite_builder.rb
+- lib/svgeez/destination.rb
+- lib/svgeez/optimizer.rb
+- lib/svgeez/source.rb
+- lib/svgeez/svg_element.rb
+- lib/svgeez/symbol_element.rb
 - lib/svgeez/version.rb
 - svgeez.gemspec
 homepage: https://github.com/jgarber623/svgeez

data/lib/svgeez/sprite_builder.rb

@@ -1,101 +0,0 @@
-module Svgeez
-  class SpriteBuilder
-    DEFAULT_DESTINATION_FILE_NAME = 'svgeez.svg'.freeze
-
-    def initialize(options = {})
-      @options = options
-    end
-
-    def build
-      if source_is_destination?
-        Svgeez.logger.error "Setting `source` and `destination` to the same path isn't allowed!"
-      elsif source_file_paths.empty?
-        Svgeez.logger.warn "No SVGs were found in `#{source}`."
-      else
-        Svgeez.logger.info "Generating sprite at `#{destination_file_path}` from #{source_file_paths.length} SVG#{'s' if source_file_paths.length > 1}..."
-
-        # Make destination folder
-        FileUtils.mkdir_p(destination_folder_path)
-
-        # Write the file
-        File.open(destination_file_path, 'w') do |f|
-          f.write build_destination_file_contents
-        end
-
-        Svgeez.logger.info "Successfully generated sprite at `#{destination_file_path}`."
-      end
-    end
-
-    def destination
-      @destination ||= File.expand_path(@options.fetch('destination', "./#{DEFAULT_DESTINATION_FILE_NAME}"))
-    end
-
-    def source
-      @source ||= File.expand_path(@options.fetch('source', './_svgeez'))
-    end
-
-    private
-
-    def build_destination_file_contents
-      destination_file_contents = "<svg>#{collect_source_files_contents.join}</svg>"
-
-      if svgo_use?
-        if svgo_installed?
-          destination_file_contents = `cat <<EOF | svgo --disable=cleanupIDs -i - -o -\n#{destination_file_contents}\nEOF`
-        else
-          Svgeez.logger.warn 'Unable to find `svgo` in your PATH. Continuing with standard sprite generation...'
-        end
-      end
-
-      destination_file_contents.insert(4, %( id="#{destination_file_id}" style="display: none;" version="1.1" xmlns="http://www.w3.org/2000/svg"))
-    end
-
-    def collect_source_files_contents
-      source_file_paths.collect do |file_path|
-        IO.read(file_path).match(%r{^<svg.*?(?<viewbox>viewBox=".*?").*?>(?<content>.*?)</svg>}m) do |matches|
-          %(<symbol id="#{destination_file_id}-#{File.basename(file_path, '.svg').gsub(/['"\s]/, '-')}" #{matches[:viewbox]}>#{matches[:content]}</symbol>)
-        end
-      end
-    end
-
-    def destination_file_id
-      @destination_file_id ||= File.basename(destination_file_name, '.svg').tr(' ', '-')
-    end
-
-    def destination_file_name
-      if destination.end_with?('.svg')
-        File.split(destination)[1]
-      else
-        DEFAULT_DESTINATION_FILE_NAME
-      end
-    end
-
-    def destination_file_path
-      @destination_file_path ||= File.join(destination_folder_path, destination_file_name)
-    end
-
-    def destination_folder_path
-      if destination.end_with?('.svg')
-        File.split(destination)[0]
-      else
-        destination
-      end
-    end
-
-    def source_file_paths
-      @source_file_paths ||= Dir.glob(File.join(source, '*.svg'))
-    end
-
-    def source_is_destination?
-      /\A#{source}/ =~ destination_folder_path
-    end
-
-    def svgo_use?
-      @svgo_use ||= @options['svgo']
-    end
-
-    def svgo_installed?
-      @svgo_installed ||= find_executable0('svgo')
-    end
-  end
-end