svgeez 1.0.3 → 3.2.0

data/Rakefile

@@ -1,8 +1,18 @@
 require 'bundler/gem_tasks'
+
+require 'reek/rake/task'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = false
+  task.source_files  = FileList['**/*.rb'].exclude('vendor/**/*.rb')
+end
+
 RSpec::Core::RakeTask.new
-RuboCop::RakeTask.new
 
-task default: :spec
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
+
+task default: [:rubocop, :reek, :spec]

data/exe/svgeez

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'mercenary'
+require 'svgeez'
+
+Mercenary.program(:svgeez) do |program|
+  program.version Svgeez::VERSION
+  program.description 'Generate an SVG sprite from a folder of SVG icons.'
+  program.syntax 'svgeez <subcommand> [options]'
+
+  Svgeez::Command.subclasses.each do |command|
+    command.init_with_program(program)
+  end
+
+  program.action do |args, _|
+    if args.empty?
+      puts program
+      abort
+    end
+  end
+end

data/lib/svgeez.rb

@@ -1,21 +1,24 @@
 require 'fileutils'
-require 'listen'
 require 'logger'
 require 'mkmf'
 require 'securerandom'
 
+require 'listen'
+require 'mercenary'
+
 require 'svgeez/version'
 
 require 'svgeez/command'
 require 'svgeez/commands/build'
 require 'svgeez/commands/watch'
 
+require 'svgeez/elements/svg_element'
+require 'svgeez/elements/symbol_element'
+
 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

@@ -1,46 +1,67 @@
 module Svgeez
   class Builder
     SOURCE_IS_DESTINATION_MESSAGE = "Setting `source` and `destination` to the same path isn't allowed!".freeze
+    SOURCE_DOES_NOT_EXIST = 'Provided `source` folder does not exist.'.freeze
     NO_SVGS_IN_SOURCE_MESSAGE = 'No SVGs were found in `source` folder.'.freeze
 
+    attr_reader :source, :destination, :prefix
+
     def initialize(options = {})
-      @options = options
+      @source = Source.new(options)
+      @destination = Destination.new(options)
+      @svgo = options.fetch('svgo', false)
+      @prefix = options.fetch('prefix', @destination.file_id)
+
+      raise SOURCE_IS_DESTINATION_MESSAGE if source_is_destination?
+      raise SOURCE_DOES_NOT_EXIST unless source_exists?
+    rescue RuntimeError => exception
+      logger.error exception.message
+      exit
     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?
+      raise 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}..."
+      logger.info "Generating sprite at `#{destination_file_path}` from #{source_files_count} SVG#{'s' if source_files_count > 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
+      File.open(destination_file_path, 'w') do |file|
+        file.write destination_file_contents
       end
 
-      Svgeez.logger.info "Successfully generated sprite at `#{destination.file_path}`."
+      logger.info "Successfully generated sprite at `#{destination_file_path}`."
+    rescue RuntimeError => exception
+      logger.warn exception.message
     end
     # rubocop:enable Metrics/AbcSize
 
-    def destination
-      @destination ||= Destination.new(@options)
+    private
+
+    def destination_file_contents
+      file_contents = Elements::SvgElement.new(source, destination, prefix).build
+      file_contents = Optimizer.new.optimize(file_contents) if @svgo
+
+      file_contents.insert(4, ' style="display: none;"')
     end
 
-    def source
-      @source ||= Source.new(@options)
+    def destination_file_path
+      @destination_file_path ||= destination.file_path
     end
 
-    private
+    def logger
+      @logger ||= Svgeez.logger
+    end
 
-    def destination_file_contents
-      file_contents = SvgElement.new(source, destination).build
-      file_contents = Optimizer.new.optimize(file_contents) if @options['svgo']
+    def source_exists?
+      File.directory?(source.folder_path)
+    end
 
-      file_contents.insert(4, ' style="display: none;"')
+    def source_files_count
+      source.file_paths.length
     end
 
     def source_is_destination?

data/lib/svgeez/command.rb

@@ -1,18 +1,39 @@
 module Svgeez
   class Command
-    def self.subclasses
-      @subclasses ||= []
-    end
+    class << self
+      def subclasses
+        @subclasses ||= []
+      end
 
-    def self.inherited(base)
-      subclasses << base
-      super(base)
-    end
+      def inherited(base)
+        subclasses << base
+        super(base)
+      end
+
+      def init_with_program(program)
+        program.command(name.split('::').last.downcase.to_sym) do |command|
+          command.description command_description
+          command.syntax command_syntax
+
+          add_actions(command)
+          add_options(command)
+        end
+      end
+
+      private
+
+      def add_actions(command)
+        command.action do |_, options|
+          command_action(options)
+        end
+      end
 
-    def self.add_build_options(c)
-      c.option 'source', '-s', '--source [FOLDER]', 'Source folder (defaults to ./_svgeez)'
-      c.option 'destination', '-d', '--destination [OUTPUT]', 'Destination file or folder (defaults to ./svgeez.svg)'
-      c.option 'svgo', '--with-svgo', 'Optimize source SVGs with SVGO before sprite generation (non-destructive)'
+      def add_options(command)
+        command.option 'source', '-s', '--source [FOLDER]', 'Source folder (defaults to ./_svgeez)'
+        command.option 'destination', '-d', '--destination [OUTPUT]', 'Destination file or folder (defaults to ./svgeez.svg)'
+        command.option 'prefix', '-p', '--prefix [PREFIX]', 'Custom Prefix for icon id (defaults to destination filename)'
+        command.option 'svgo', '--with-svgo', 'Optimize source SVGs with SVGO before sprite generation (non-destructive)'
+      end
     end
   end
 end

data/lib/svgeez/commands/build.rb

@@ -1,21 +1,24 @@
 module Svgeez
   module Commands
     class Build < Command
-      def self.init_with_program(p)
-        p.command(:build) do |c|
-          c.description 'Builds an SVG sprite from a folder of SVG icons'
-          c.syntax 'build [options]'
+      class << self
+        def process(options)
+          Svgeez::Builder.new(options).build
+        end
 
-          add_build_options(c)
+        private
 
-          c.action do |_, options|
-            Build.process(options)
-          end
+        def command_action(options)
+          Build.process(options)
         end
-      end
 
-      def self.process(options)
-        Svgeez::Builder.new(options).build
+        def command_description
+          'Builds an SVG sprite from a folder of SVG icons'
+        end
+
+        def command_syntax
+          'build [options]'
+        end
       end
     end
   end

data/lib/svgeez/commands/watch.rb

@@ -1,33 +1,33 @@
 module Svgeez
   module Commands
     class Watch < Command
-      def self.init_with_program(p)
-        p.command(:watch) do |c|
-          c.description 'Watches a folder of SVG icons for changes'
-          c.syntax 'watch [options]'
+      class << self
+        def process(options)
+          builder = Svgeez::Builder.new(options)
+          folder_path = builder.source.folder_path
 
-          add_build_options(c)
+          Svgeez.logger.info "Watching `#{folder_path}` for changes... Press ctrl-c to stop."
 
-          c.action do |_, options|
-            Build.process(options)
-            Watch.process(options)
-          end
+          Listen.to(folder_path, only: /\.svg\z/) { builder.build }.start
+          sleep
+        rescue Interrupt
+          Svgeez.logger.info 'Quitting svgeez...'
         end
-      end
 
-      def self.process(options)
-        builder = Svgeez::Builder.new(options)
+        private
 
-        listener = Listen.to(builder.source.folder_path, only: /\.svg\z/) do
-          builder.build
+        def command_action(options)
+          Build.process(options)
+          Watch.process(options)
         end
 
-        Svgeez.logger.info "Watching `#{builder.source.folder_path}` for changes... Press ctrl-c to stop."
+        def command_description
+          'Watches a folder of SVG icons for changes'
+        end
 
-        listener.start
-        sleep
-      rescue Interrupt
-        Svgeez.logger.info 'Quitting svgeez...'
+        def command_syntax
+          'watch [options]'
+        end
       end
     end
   end

data/lib/svgeez/destination.rb

@@ -3,7 +3,7 @@ module Svgeez
     DEFAULT_DESTINATION_FILE_NAME = 'svgeez.svg'.freeze
 
     def initialize(options = {})
-      @options = options
+      @destination = File.expand_path(options.fetch('destination', "./#{DEFAULT_DESTINATION_FILE_NAME}"))
     end
 
     def file_id
@@ -12,8 +12,8 @@ module Svgeez
 
     def file_name
       @file_name ||=
-        if destination.end_with?('.svg')
-          File.split(destination)[1]
+        if @destination.end_with?('.svg')
+          File.split(@destination)[1]
         else
           DEFAULT_DESTINATION_FILE_NAME
         end
@@ -25,17 +25,11 @@ module Svgeez
 
     def folder_path
       @folder_path ||=
-        if destination.end_with?('.svg')
-          File.split(destination)[0]
+        if @destination.end_with?('.svg')
+          File.split(@destination)[0]
         else
-          destination
+          @destination
         end
     end
-
-    private
-
-    def destination
-      @destination ||= File.expand_path(@options.fetch('destination', "./#{DEFAULT_DESTINATION_FILE_NAME}"))
-    end
   end
 end

data/lib/svgeez/elements/svg_element.rb

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

data/lib/svgeez/elements/symbol_element.rb

@@ -0,0 +1,38 @@
+module Svgeez
+  module Elements
+    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)
+        id_prefix = @file_id
+        id_suffix = File.basename(@file_path, '.svg').gsub(/['"\s]/, '-')
+        id_attribute = [id_prefix, id_suffix].reject(&:empty?).join('-')
+
+        attrs << %(id="#{id_attribute}")
+      end
+
+      def element_contents(content)
+        content.scan(/\sid="(.+?)"/).flatten.each do |value|
+          uuid = SecureRandom.uuid
+
+          content.gsub!(/\s(id|xlink:href)="(#?#{value})"/m, %( \\1="\\2-#{uuid}"))
+          content.gsub!(/\s(clip-path|fill|filter|marker-end|marker-mid|marker-start|mask|stroke)="url\((##{value})\)"/m, %( \\1="url(\\2-#{uuid})"))
+        end
+
+        content
+      end
+    end
+  end
+end

data/lib/svgeez/optimizer.rb

@@ -1,11 +1,16 @@
 module Svgeez
   class Optimizer
+    SVGO_MINIMUM_VERSION = '1.3.0'.freeze
+    SVGO_MINIMUM_VERSION_MESSAGE = "svgeez relies on SVGO #{SVGO_MINIMUM_VERSION} or newer. Continuing with standard sprite generation...".freeze
     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?
+      raise SVGO_NOT_INSTALLED unless installed?
+      raise SVGO_MINIMUM_VERSION_MESSAGE unless supported?
 
-      `cat <<EOF | svgo --disable=cleanupIDs -i - -o -\n#{file_contents}\nEOF`
+      `cat <<EOF | svgo --disable=cleanupIDs --disable=removeHiddenElems --disable=removeViewBox -i - -o -\n#{file_contents}\nEOF`
+    rescue RuntimeError => exception
+      logger.warn exception.message
     end
 
     private
@@ -13,5 +18,13 @@ module Svgeez
     def installed?
       @installed ||= find_executable0('svgo')
     end
+
+    def logger
+      @logger ||= Svgeez.logger
+    end
+
+    def supported?
+      @supported ||= Gem::Version.new(`svgo -v`.strip) >= Gem::Version.new(SVGO_MINIMUM_VERSION)
+    end
   end
 end

data/lib/svgeez/source.rb

@@ -2,18 +2,16 @@ module Svgeez
   class Source
     DEFAULT_INPUT_FOLDER_PATH = './_svgeez'.freeze
 
+    attr_reader :folder_path
+
     def initialize(options = {})
-      @options = options
+      @folder_path = File.expand_path(options.fetch('source', DEFAULT_INPUT_FOLDER_PATH))
     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