svg_optimizer 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 252e3ad0e74992fe85def8ef8d749d2f55975b6a
-  data.tar.gz: 0ab2451d8cf7ee5ec69a0cf6462adcba953575e2
+SHA256:
+  metadata.gz: ec1327e57cc38ef5060b4e20afa3bce438abb6e967b8eb2b1691c571871fe293
+  data.tar.gz: 3945086145b7e192f93adb176b19d970c8707e6981ed8e7f14dcdc5ffbb0c723
 SHA512:
-  metadata.gz: bfd401c30de6a280c6daddc788678f8635f0e179b7119ddc9ead993dbfbd0d08d70c30cf61153a6a6e7ff224dbdfd8b336c0027c65cbb916b8d115e262d966e6
-  data.tar.gz: 0db71a133efeaa39992777d7a34fd4c1c309afafb4367fa1b9741fa73af26f4755cdb834ee3f2e8f80948794bf03f3190397e0a24e9e34e6e8395fffca9292a2
+  metadata.gz: '099effe7f458ba87feef6323f0df44caefbc9fec401cf626b6d4452fccbb60ec9f9c2eb8ea407eab470278ffb2f9084413dafde9dbea736acf6541bafddcd0d9'
+  data.tar.gz: 6e8831f708e90f74176342ba2a681894099e4dbaaa0122fb12959b395addf79638326dd629efe61d082a7b262a7671b1cb31013bfaff760529ed59a9f8d707a9

data/README.md

@@ -1,8 +1,6 @@
 # SvgOptimizer
 
-[![Travis-CI](https://travis-ci.org/fnando/svg_optimizer.svg)](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)
+[![Tests](https://github.com/fnando/svg_optimizer/workflows/ruby-tests/badge.svg)](https://github.com/fnando/svg_optimizer)
 [![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)
 
@@ -10,17 +8,15 @@ Some small optimizations for SVG files.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'svg_optimizer'
-
-And then execute:
-
-    $ bundle
+```bash
+gem install svg_optimizer
+```
 
-Or install it yourself as:
+Or add the following line to your project's Gemfile:
 
-    $ gem install svg_optimizer
+```ruby
+gem "svg_optimizer"
+```
 
 ## Usage
 
@@ -36,6 +32,20 @@ SvgOptimizer.optimize_file("file.svg")
 SvgOptimizer.optimize_file("file.svg", "optimized/file.svg")
 ```
 
+You may have a need to optimize a *trusted* SVG document with entities that need to be
+expanded. **Only if you are sure the file is trusted**, you may enable this additional entity
+processing by passing the `trusted:` keyword argument:
+
+``` ruby
+# Optimize an existing trusted String which requires entity expansion.
+xml = File.read("file.svg")
+optimized = SvgOptimizer.optimize(xml, trusted: true)
+
+# Optimize a trusted file which requires entity expansion - it will override the original file.
+SvgOptimizer.optimize_file("file.svg", trusted: true)
+```
+
+
 You can specify the plugins you want to enable. The method signature is:
 
 ```ruby
@@ -53,16 +63,34 @@ class MyPlugin < SvgOptimizer::Plugins::Base
 end
 ```
 
-The default list of plugins is stored at `SvgOptimizer::DEFAULT_PLUGINS`. To use your new plugin, just do something like this:
+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])
 ```
 
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
+
+- https://github.com/fnando/svg_optimizer/contributors
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+For more details about how to contribute, please read
+https://github.com/fnando/svg_optimizer/blob/main/CONTRIBUTING.md.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/svg_optimizer/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the svg_optimizer project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/svg_optimizer/blob/main/CODE_OF_CONDUCT.md).

data/lib/svg_optimizer/plugins/cleanup_id.rb

@@ -9,7 +9,7 @@ module SvgOptimizer
       ].freeze
 
       IDS = LETTERS.dup.concat(LETTERS.combination(2).to_a).freeze
-      XLINK_NAMESPACE = "http://www.w3.org/1999/xlink".freeze
+      XLINK_NAMESPACE = "http://www.w3.org/1999/xlink"
 
       def ids
         @ids ||= IDS.dup

data/lib/svg_optimizer/plugins/remove_editor_namespace.rb

@@ -50,6 +50,7 @@ module SvgOptimizer
       def remove_matching_attribute(node, name)
         node.attributes.each do |_, attr|
           next unless attr.namespace
+
           attr.remove if attr.namespace.prefix == name
         end
       end

data/lib/svg_optimizer/plugins/remove_empty_attribute.rb

@@ -11,9 +11,7 @@ module SvgOptimizer
         end
       end
 
-      private
-
-      def remove_if_empty(node, attr)
+      private def remove_if_empty(node, attr)
         node.remove_attribute(attr) if node[attr].empty?
       end
     end

data/lib/svg_optimizer/plugins/remove_empty_container.rb

@@ -3,7 +3,17 @@
 module SvgOptimizer
   module Plugins
     class RemoveEmptyContainer < Base
-      ELEMENTS = %w[a defs g marker mask missing-glyph pattern switch symbol].freeze
+      ELEMENTS = %w[
+        a
+        defs
+        g
+        marker
+        mask
+        missing-glyph
+        pattern
+        switch
+        symbol
+      ].freeze
       SELECTOR = ELEMENTS.map {|element| %[#{element}:empty] }.join(", ")
 
       def process
@@ -12,9 +22,7 @@ module SvgOptimizer
         end
       end
 
-      private
-
-      def remove_node(node)
+      private def remove_node(node)
         node.children.empty? && node.remove
         remove_node(node.parent) if node.parent
       end

data/lib/svg_optimizer/plugins/remove_empty_text_node.rb

@@ -7,9 +7,7 @@ module SvgOptimizer
         xml.xpath("//text()").each(&method(:remove_if_empty))
       end
 
-      private
-
-      def remove_if_empty(node)
+      private def remove_if_empty(node)
         node.remove if node.text.gsub(/\s/, "").empty?
       end
     end

data/lib/svg_optimizer/plugins/remove_title.rb

@@ -4,7 +4,7 @@ module SvgOptimizer
   module Plugins
     class RemoveTitle < Base
       def process
-        xml.xpath("//title").remove
+        xml.css("title").remove
       end
     end
   end

data/lib/svg_optimizer/plugins/remove_useless_stroke_and_fill.rb

@@ -4,7 +4,12 @@ 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].freeze
+      STROKE_ATTRS = %w[
+        stroke
+        stroke-opacity
+        stroke-width
+        stroke-dashoffset
+      ].freeze
       FILL_ATTRS = %w[fill-opacity fill-rule].freeze
 
       def process
@@ -15,40 +20,39 @@ module SvgOptimizer
         end
       end
 
-      private
-
-      def remove_useless_attributes(node)
+      private def remove_useless_attributes(node)
         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)
+      private def remove_stroke(node)
         STROKE_ATTRS.each {|attr| node.delete(attr) }
         node["stroke"] = "none" if decline_inherited_stroke?(node)
       end
 
-      def remove_fill(node)
+      private def remove_fill(node)
         FILL_ATTRS.each {|attr| node.delete(attr) }
         node["fill"] = "none" if decline_inherited_fill?(node)
       end
 
-      def decline_inherited_stroke?(node)
+      private def decline_inherited_stroke?(node)
         (inherited_attribute(node.parent, "stroke") || "none") != "none"
       end
 
-      def decline_inherited_fill?(node)
+      private def decline_inherited_fill?(node)
         !inherited_attribute(node, "fill") || node.has_attribute?("fill")
       end
 
-      def remove_stroke?(node)
+      private def remove_stroke?(node)
         return true if (inherited_attribute(node, "stroke") || "none") == "none"
         return true if inherited_attribute(node, "stroke-opacity") == "0"
 
         inherited_attribute(node, "stroke-width") == "0"
       end
 
-      def remove_fill?(node)
+      private def remove_fill?(node)
         fill = inherited_attribute(node, "fill")
 
         return true if fill == "none"
@@ -57,7 +61,7 @@ module SvgOptimizer
         !fill
       end
 
-      def inherited_attribute(node, attr)
+      private def inherited_attribute(node, attr)
         return if node.nil? || node.document?
         return node[attr] if node.has_attribute?(attr)
 

data/lib/svg_optimizer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SvgOptimizer
-  VERSION = "0.2.5".freeze
+  VERSION = "0.3.0"
 end

data/lib/svg_optimizer.rb

@@ -37,14 +37,23 @@ module SvgOptimizer
     RemoveEmptyContainer
   ].map {|name| Plugins.const_get(name) }
 
-  def self.optimize(contents, plugins = DEFAULT_PLUGINS)
-    xml = Nokogiri::XML(contents)
+  def self.optimize(contents, plugins = DEFAULT_PLUGINS, trusted: false)
+    xml = Nokogiri::XML(contents) do |config|
+      config.recover.noent if trusted
+    end
+
     plugins.each {|plugin| plugin.new(xml).process }
+
     xml.root.to_xml
   end
 
-  def self.optimize_file(path, target = path, plugins = DEFAULT_PLUGINS)
-    contents = optimize(File.read(path), plugins)
+  def self.optimize_file(
+    path,
+    target = path,
+    plugins = DEFAULT_PLUGINS,
+    trusted: false
+  )
+    contents = optimize(File.read(path), plugins, trusted: trusted)
     File.open(target, "w") {|file| file << contents }
     true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svg_optimizer
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-utils
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - lib/svg_optimizer.rb
 - lib/svg_optimizer/plugins/base.rb
@@ -123,8 +151,9 @@ files:
 homepage: https://github.com/fnando/svg_optimizer
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,16 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: SVG optimization based on Node's SVGO
 test_files: []