svg_optimizer 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 967fe8ee11fe2dfd0f45a43b8162f63407a9b66b
-  data.tar.gz: 92ae939384c1111548a7972cab68c438c24066d3
+  metadata.gz: e80d8684aae3105745cd84db8c935a332bc58b02
+  data.tar.gz: 698bc37343bf931cea862afb939cd0a45547208b
 SHA512:
-  metadata.gz: 00ed5692f1ca0e2cb01b99c3fb4fd05bf7a0f304841ed21f256d4dc819e0c56faf4b3b685d35316879d38632f253fe48ef15f967809ef97865078292d6d403f1
-  data.tar.gz: 6f30a9fba01672b745858889f972fc562025b49f353032dcccdeff418c12daea995cfd3dcac122b9a82700f94cc3fca5b8966da9946ee1afab0e183f6a7c66eb
+  metadata.gz: 1d4bf32d76d719e774137c9a00231de35caaed49d4a7f970606f9f6e58b2729bbae67708df72719ac31a008c29bdbd3b0c3548fe6d54e6dd8a9f7bb888eacddf
+  data.tar.gz: 28a362b536013a61c426e0ccc3e3fc6d1f9674e9e011cfe50772e22d5aab954904925fb9209714e950556aef3700ab91cee876c0b634fae207b36ed3cd201a80

data/README.md

@@ -1,5 +1,11 @@
 # SvgOptimizer
 
+[![Travis-CI](https://travis-ci.org/fnando/svg_optimizer.png)](https://travis-ci.org/fnando/svg_optimizer)
+[![Code Climate](https://codeclimate.com/github/fnando/svg_optimizer/badges/gpa.svg)](https://codeclimate.com/github/fnando/svg_optimizer)
+[![Test Coverage](https://codeclimate.com/github/fnando/svg_optimizer/badges/coverage.svg)](https://codeclimate.com/github/fnando/svg_optimizer/coverage)
+[![Gem](https://img.shields.io/gem/v/svg_optimizer.svg)](https://rubygems.org/gems/svg_optimizer)
+[![Gem](https://img.shields.io/gem/dt/svg_optimizer.svg)](https://rubygems.org/gems/svg_optimizer)
+
 Some small optimizations for SVG files.
 
 ## Installation
@@ -30,6 +36,29 @@ SvgOptimizer.optimize_file("file.svg")
 SvgOptimizer.optimize_file("file.svg", "optimized/file.svg")
 ```
 
+You can specify the plugins you want to enable. The method signature is:
+
+```ruby
+SvgOptimizer.optimize(xml, plugins)
+SvgOptimizer.optimize_file(input, output, plugins)
+```
+
+where `plugins` is an array of classes that implement the following contract:
+
+```ruby
+class MyPlugin < SvgOptimizer::Plugins::Base
+  def process
+    xml.xpath("//comment()").remove
+  end
+end
+```
+
+The default list of plugins is stored at `SvgOptimizer::DEFAULT_PLUGINS`. To use your new plugin, just do something like this:
+
+```ruby
+SvgOptimizer.optimize(xml, SvgOptimizer::DEFAULT_PLUGINS + [MyPlugin])
+```
+
 ## Contributing
 
 1. Fork it

data/lib/svg_optimizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "nokogiri"
 
 require "svg_optimizer/version"
@@ -17,7 +18,7 @@ require "svg_optimizer/plugins/remove_unused_namespace"
 require "svg_optimizer/plugins/remove_useless_stroke_and_fill"
 
 module SvgOptimizer
-  PLUGINS = %w[
+  DEFAULT_PLUGINS = %w[
     CleanupAttribute
     CleanupId
     RemoveComment
@@ -31,20 +32,16 @@ module SvgOptimizer
     RemoveUselessStrokeAndFill
     RemoveEmptyTextNode
     RemoveEmptyContainer
-  ]
+  ].map {|name| Plugins.const_get(name) }
 
-  def self.optimize(contents)
+  def self.optimize(contents, plugins = DEFAULT_PLUGINS)
     xml = Nokogiri::XML(contents)
-    PLUGINS.each do |plugin_name|
-      Plugins.const_get(plugin_name).new(xml).process
-    end
-
+    plugins.each {|plugin| plugin.new(xml).process }
     xml.root.to_xml
   end
 
-  def self.optimize_file(path, target = path)
-    contents = optimize(File.read(path))
-
+  def self.optimize_file(path, target = path, plugins = DEFAULT_PLUGINS)
+    contents = optimize(File.read(path), plugins)
     File.open(target, "w") {|file| file << contents }
     true
   end

data/lib/svg_optimizer/plugins/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class Base

data/lib/svg_optimizer/plugins/cleanup_attribute.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class CleanupAttribute < Base

data/lib/svg_optimizer/plugins/cleanup_id.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class CleanupId < Base

data/lib/svg_optimizer/plugins/collapse_groups.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class CollapseGroups < Base
+      COLLAPSABLE_ATTRS = %w[transform class]
+
       def process
-        xml.css('g:not(:empty)').each do |group|
+        xml.css("g:not(:empty)").each do |group|
           collapse(group)
         end
       end
@@ -19,28 +22,29 @@ module SvgOptimizer
         return unless collapse_attributes?(group, child)
 
         group.attributes.each do |attr, val|
-          if %w(transform class).include?(attr)
-            child[attr] = [val, child[attr]].compact.join(' ')
+          if COLLAPSABLE_ATTRS.include?(attr)
+            child[attr] = [val, child[attr]].compact.join(" ")
           else
             child[attr] ||= val
           end
+
           group.delete(attr)
         end
       end
 
       def collapse?(group)
         group.attributes.empty? &&
-          !group.element_children.map(&:name).include?('animate')
+          !group.element_children.map(&:name).include?("animate")
       end
 
       def collapse_attributes?(group, child)
-        return false unless group.attributes.any?
-        return false unless group.element_children.length == 1
-        return false if child.has_attribute?('id')
-        return false unless !group.has_attribute?('clip-path') ||
-          child.name == 'g' &&
-          !group.has_attribute?('transform') &&
-          !child.has_attribute?('transform')
+        return unless group.attributes.any?
+        return unless group.element_children.length == 1
+        return if child.has_attribute?("id")
+        return unless !group.has_attribute?("clip-path") ||
+                      child.name == "g" &&
+                      !group.has_attribute?("transform") &&
+                      !child.has_attribute?("transform")
         true
       end
     end

data/lib/svg_optimizer/plugins/remove_comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveComment < Base

data/lib/svg_optimizer/plugins/remove_editor_namespace.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveEditorNamespace < Base
@@ -17,6 +18,19 @@ module SvgOptimizer
         http://www.bohemiancoding.com/sketch/ns
       ]
 
+      def process
+        namespaces = xml.namespaces
+        remove_namespaced_attributes
+        xml.remove_namespaces!
+
+        namespaces.each do |name, value|
+          next if NAMESPACES.include?(value)
+
+          _, name = name.split(":")
+          xml.root.add_namespace name, value
+        end
+      end
+
       def namespaces_to_be_removed
         xml.namespaces.map do |name, value|
           _, name = name.split(":")
@@ -34,19 +48,6 @@ module SvgOptimizer
           end
         end
       end
-
-      def process
-        namespaces = xml.namespaces
-        remove_namespaced_attributes
-        xml.remove_namespaces!
-
-        namespaces.each do |name, value|
-          next if NAMESPACES.include?(value)
-
-          _, name = name.split(":")
-          xml.root.add_namespace name, value
-        end
-      end
     end
   end
 end

data/lib/svg_optimizer/plugins/remove_empty_attribute.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveEmptyAttribute < Base
@@ -10,6 +11,7 @@ module SvgOptimizer
       end
 
       private
+
       def remove_if_empty(node, attr)
         node.remove_attribute(attr) if node[attr].empty?
       end

data/lib/svg_optimizer/plugins/remove_empty_container.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveEmptyContainer < Base
@@ -11,6 +12,7 @@ module SvgOptimizer
       end
 
       private
+
       def remove_node(node)
         node.children.empty? && node.remove
         remove_node(node.parent) if node.parent

data/lib/svg_optimizer/plugins/remove_empty_text_node.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveEmptyTextNode < Base
@@ -6,6 +7,7 @@ module SvgOptimizer
       end
 
       private
+
       def remove_if_empty(node)
         node.remove if node.text.gsub(/\s/, "").empty?
       end

data/lib/svg_optimizer/plugins/remove_hidden_element.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveHiddenElement < Base

data/lib/svg_optimizer/plugins/remove_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveMetadata < Base

data/lib/svg_optimizer/plugins/remove_raster_image.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveRasterImage < Base

data/lib/svg_optimizer/plugins/remove_unused_namespace.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveUnusedNamespace < Base

data/lib/svg_optimizer/plugins/remove_useless_stroke_and_fill.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
 module SvgOptimizer
   module Plugins
     class RemoveUselessStrokeAndFill < Base
-      SELECTOR = %w(circle ellipse line path polygon polyline rect).join(',')
-      STROKE_ATTRS = %w(stroke stroke-opacity stroke-width stroke-dashoffset)
-      FILL_ATTRS = %w(fill-opacity fill-rule)
+      SELECTOR = %w[circle ellipse line path polygon polyline rect].join(",")
+      STROKE_ATTRS = %w[stroke stroke-opacity stroke-width stroke-dashoffset]
+      FILL_ATTRS = %w[fill-opacity fill-rule]
 
       def process
-        return if xml.css('style, script').any?
+        return if xml.css("style, script").any?
+
         xml.css(SELECTOR).each do |node|
           remove_useless_attributes(node)
         end
@@ -15,48 +17,47 @@ module SvgOptimizer
       private
 
       def remove_useless_attributes(node)
-        return if inherited_attribute(node, 'id')
+        return if inherited_attribute(node, "id")
         remove_stroke(node) if remove_stroke?(node)
         remove_fill(node) if remove_fill?(node)
       end
 
       def remove_stroke(node)
         STROKE_ATTRS.each { |attr| node.delete(attr) }
-        node['stroke'] = 'none' if decline_inherited_stroke?(node)
+        node["stroke"] = "none" if decline_inherited_stroke?(node)
       end
 
       def remove_fill(node)
         FILL_ATTRS.each { |attr| node.delete(attr) }
-        node['fill'] = 'none' if decline_inherited_fill?(node)
+        node["fill"] = "none" if decline_inherited_fill?(node)
       end
 
       def decline_inherited_stroke?(node)
-        (inherited_attribute(node.parent, 'stroke') || 'none') != 'none'
+        (inherited_attribute(node.parent, "stroke") || "none") != "none"
       end
 
       def decline_inherited_fill?(node)
-        !inherited_attribute(node, 'fill') || node.has_attribute?('fill')
+        !inherited_attribute(node, "fill") || node.has_attribute?("fill")
       end
 
       def remove_stroke?(node)
-        return true if (inherited_attribute(node, 'stroke') || 'none') == 'none'
-        return true if inherited_attribute(node, 'stroke-opacity') == '0'
-        return inherited_attribute(node, 'stroke-width') == '0'
+        return true if (inherited_attribute(node, "stroke") || "none") == "none"
+        return true if inherited_attribute(node, "stroke-opacity") == "0"
+        return inherited_attribute(node, "stroke-width") == "0"
       end
 
       def remove_fill?(node)
-        fill = inherited_attribute(node, 'fill')
-        return true if fill == 'none'
-        return true if inherited_attribute(node, 'fill-opacity') == '0'
+        fill = inherited_attribute(node, "fill")
+        return true if fill == "none"
+        return true if inherited_attribute(node, "fill-opacity") == "0"
         return !fill
       end
 
       def inherited_attribute(node, attr)
-        return nil if node.nil? || node.document?
+        return if node.nil? || node.document?
         return node[attr] if node.has_attribute?(attr)
         inherited_attribute(node.parent, attr)
       end
     end
   end
 end
-

data/lib/svg_optimizer/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SvgOptimizer
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require "bundler/setup"
 require "svg_optimizer"
+require "securerandom"
 
 module RSpecHelpers
   SVG = <<-XML
@@ -11,6 +16,10 @@ module RSpecHelpers
 </svg>
   XML
 
+  def build_svg(content)
+    SVG % content
+  end
+
   def fixtures_path
     File.expand_path("../fixtures", __FILE__)
   end
@@ -24,16 +33,16 @@ module RSpecHelpers
 
   def with_svg_plugin(content)
     let(:file_path) { File.join(fixtures_path, content) }
-    let(:input_content) { File.file?(file_path) ? File.read(file_path) : SVG % content }
+    let(:input_content) { File.file?(file_path) ? File.read(file_path) : build_svg(content) }
     setup_plugin_test
   end
 
   def test_with_fixture_set(name)
-    Dir.glob(File.join(fixtures_path, name, '*.svg')).each do |fixture|
+    Dir.glob(File.join(fixtures_path, name, "*.svg")).each do |fixture|
       context "output from fixture: #{fixture}" do
         let(:fixture_content) { File.read(fixture) }
-        let(:input_content) { fixture_content.split('@@@')[0].strip }
-        let(:expected_content) { fixture_content.split('@@@')[1].strip }
+        let(:input_content) { fixture_content.split("@@@")[0].strip }
+        let(:expected_content) { fixture_content.split("@@@")[1].strip }
         let(:expected) { Nokogiri::XML(expected_content, &:noblanks).root.to_xml }
         subject { xml.root.to_xml }
         setup_plugin_test
@@ -46,8 +55,6 @@ module RSpecHelpers
 end
 
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
   config.order = "random"
   config.extend RSpecHelpers
   config.include RSpecHelpers

data/spec/svg_optimizer/plugins/cleanup_attribute_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::CleanupAttribute do

data/spec/svg_optimizer/plugins/cleanup_id_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::CleanupId do

data/spec/svg_optimizer/plugins/collapse_groups_spec.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::CollapseGroups do
-  test_with_fixture_set('collapse_groups')
+  test_with_fixture_set("collapse_groups")
 end

data/spec/svg_optimizer/plugins/remove_comment_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveComment do

data/spec/svg_optimizer/plugins/remove_editor_namespace_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveEditorNamespace do

data/spec/svg_optimizer/plugins/remove_empty_attribute_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveEmptyAttribute do

data/spec/svg_optimizer/plugins/remove_empty_container_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveEmptyContainer do

data/spec/svg_optimizer/plugins/remove_empty_text_node_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveEmptyTextNode do

data/spec/svg_optimizer/plugins/remove_hidden_element_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveHiddenElement do

data/spec/svg_optimizer/plugins/remove_metadata_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveMetadata do

data/spec/svg_optimizer/plugins/remove_raster_image_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveRasterImage do

data/spec/svg_optimizer/plugins/remove_unused_namespace_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveUnusedNamespace do

data/spec/svg_optimizer/plugins/remove_useless_stroke_and_fill_spec.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe SvgOptimizer::Plugins::RemoveUselessStrokeAndFill do
-  test_with_fixture_set('remove_useless_stroke_and_fill')
+  test_with_fixture_set("remove_useless_stroke_and_fill")
 end

data/spec/svg_optimizer/svg_optimizer_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe SvgOptimizer do
+  context "file saving" do
+    let(:input) { "/tmp/#{SecureRandom.uuid}.svg" }
+    let(:output) { "/tmp/#{SecureRandom.uuid}.svg" }
+    let(:raw_svg) { build_svg("<!-- foo --><text>SVG</text>") }
+    let(:output_svg) { SvgOptimizer.optimize(raw_svg) }
+
+    before do
+      File.open(input, "w") {|file| file << raw_svg }
+    end
+
+    it "overrides existing file with optimized version" do
+      SvgOptimizer.optimize_file(input)
+      expect(File.read(input)).to eq(output_svg)
+    end
+
+    it "saves new file file with optimized version" do
+      SvgOptimizer.optimize_file(input, output)
+      expect(File.read(input)).to eq(raw_svg)
+      expect(File.read(output)).to eq(output_svg)
+    end
+  end
+
+  context "plugin selection" do
+    it "applies all plugins" do
+      svg = build_svg <<-SVG
+        <!-- foo -->
+        <g></g>
+        <!-- bar -->
+      SVG
+
+      xml = Nokogiri::XML(SvgOptimizer.optimize(svg))
+
+      expect(xml.xpath("//comment()")).to be_empty
+      expect(xml.css("g")).to be_empty
+    end
+
+    it "applies just specified plugins" do
+      plugins = [SvgOptimizer::Plugins::RemoveComment]
+      svg = build_svg <<-SVG
+        <!-- foo -->
+        <g></g>
+        <!-- bar -->
+      SVG
+
+      xml = Nokogiri::XML(SvgOptimizer.optimize(svg, plugins))
+
+      expect(xml.xpath("//comment()")).to be_empty
+      expect(xml.css("g").length).to eql(1)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svg_optimizer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Nando Vieira
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
 description: SVG optimization based on Node's SVGO
 email:
 - fnando.vieira@gmail.com
@@ -138,6 +152,7 @@ files:
 - spec/svg_optimizer/plugins/remove_raster_image_spec.rb
 - spec/svg_optimizer/plugins/remove_unused_namespace_spec.rb
 - spec/svg_optimizer/plugins/remove_useless_stroke_and_fill_spec.rb
+- spec/svg_optimizer/svg_optimizer_spec.rb
 homepage: https://github.com/fnando/svg_optimizer
 licenses:
 - MIT
@@ -196,3 +211,4 @@ test_files:
 - spec/svg_optimizer/plugins/remove_raster_image_spec.rb
 - spec/svg_optimizer/plugins/remove_unused_namespace_spec.rb
 - spec/svg_optimizer/plugins/remove_useless_stroke_and_fill_spec.rb
+- spec/svg_optimizer/svg_optimizer_spec.rb