svgo_wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d28e56255a9c92c101eb2245cddb434becf08f4
+  data.tar.gz: ad9a828921e3f26868aaaa94f26d09a8cb12de93
+SHA512:
+  metadata.gz: 910fd2cc795027853bad42d7e340fc44c75a5e1ef7fbd877a671dd57f16d28ecc47577617b6d0bc165cafc55f0f1a4ffeda2c4272a8c4390e9168c7f75807ea3
+  data.tar.gz: 749424df3f68830942b94b1b58c44067b6c2f83755c1890b3b93e98791482a5c82206ab1f54a62e1f73bcefc4ac91a9a9cabf661e23a7807ef7776f9b9ac022f

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.buildpath
+.project
+/.settings/

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Metrics/LineLength:
+  Max: 120
+Style/AndOr:
+  EnforcedStyle: conditionals
+Style/Documentation:
+  Enabled: false
+Style/SignalException:
+  EnforcedStyle: only_raise
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start { add_filter "/spec/" }

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+gemspec
+
+group :development do
+  gem "byebug", "~> 3.5.1"
+  gem "guard", "~> 2.10.2"
+  gem "guard-rspec", "~> 4.4.2"
+  gem "guard-rubocop", "~> 1.2.0"
+  gem "libnotify", "~> 0.8.4"
+  gem "rubocop", "~> 0.28.0"
+end
+
+group :development, :test do
+  gem "rake", "~> 10.4.2"
+  gem "rspec", "~> 3.1.0"
+  gem "simplecov", "~> 0.9.1"
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rubocop, all_on_start: false do
+  watch(/^.+\.rb$/)
+  watch(/^(?:.+\/)?\.rubocop\.yml$/) {|m| File.dirname(m[0]) }
+  watch(/^(?:.+\/)?.+\.gemspec$/)
+  watch(/^(?:.+\/)?(?:Gem|Rake)file$/)
+end
+
+guard :rspec, cmd: "bundle exec rspec -fd" do
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/) {|m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb") { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gabriel de Oliveira
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# SvgoWrapper
+
+This is a simple wrapper for the `svgo` command line tool.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "svgo_wrapper"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install svgo_wrapper
+
+## Usage
+
+```ruby
+require "svgo_wrapper"
+
+# Create a wrapper with enabled and disabled plugins.
+# All attributes are optional.
+wrapper = SvgoWrapper.new enabled: :removeTitle,
+                          disabled: [:convertColors, :removeMetadata],
+                          timeout: 10 # seconds
+
+# Parse image data
+wrapper.optimize_images_data " <svg> </svg> "  #=> "<svg/>\n"
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir[File.join(File.dirname(__FILE__), "tasks", "**", "*.rb")].each do |file|
+  require file
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :coverage

data/lib/svgo_wrapper.rb

@@ -0,0 +1,63 @@
+require "set"
+
+require "open4"
+
+require "svgo_wrapper/constants"
+require "svgo_wrapper/error"
+require "svgo_wrapper/parser_error"
+require "svgo_wrapper/svgo_check"
+require "svgo_wrapper/version"
+
+class SvgoWrapper
+  attr_reader :disabled_plugins, :enabled_plugins, :timeout
+
+  def initialize(enable: nil, disable: nil, timeout: DEFAULT_TIMEOUT)
+    self.enabled_plugins = enable
+    self.disabled_plugins = disable
+    self.plugin_args = generate_plugin_args(enabled: enabled_plugins, disabled: disabled_plugins)
+    self.timeout = timeout
+  end
+
+  def optimize_images_data(data)
+    begin
+      Open4.spawn ["svgo", *plugin_args, "-i", "-", "-o", "-"],
+                  stdin: data,
+                  stdout: output = "",
+                  stdout_timeout: timeout
+    rescue Open4::SpawnError => e
+      raise Error, "Unexpected error (#{e.exitstatus})\n"
+    end
+
+    raise ParserError, output unless output.start_with? "<svg"
+    output
+  end
+
+  def timeout=(value)
+    if value.is_a? Numeric
+      @timeout = value
+    elsif @timeout.nil?
+      @timeout = DEFAULT_TIMEOUT
+    end
+  end
+
+  private
+
+  attr_accessor :plugin_args
+
+  def disabled_plugins=(values)
+    @disabled_plugins = filter_plugins(Set[*values]).freeze
+  end
+
+  def enabled_plugins=(values)
+    @enabled_plugins = filter_plugins(Set[*values]).freeze
+  end
+
+  def filter_plugins(plugins)
+    VALID_PLUGINS & plugins.map(&:to_sym)
+  end
+
+  def generate_plugin_args(enabled:, disabled:)
+    (disabled.map {|v| "--disable=#{v}".freeze } +
+     enabled.map {|v| "--enable=#{v}".freeze }).freeze
+  end
+end

data/lib/svgo_wrapper/constants.rb

@@ -0,0 +1,13 @@
+require "set"
+
+class SvgoWrapper
+  DEFAULT_TIMEOUT = 60 # seconds
+
+  VALID_PLUGINS = Set[:cleanupAttrs, :cleanupEnableBackground, :cleanupIDs, :cleanupNumericValues, :collapseGroups,
+                      :convertColors, :convertPathData, :convertShapeToPath, :convertStyleToAttrs, :convertTransform,
+                      :mergePaths, :moveElemsAttrsToGroup, :moveGroupAttrsToElems, :removeComments, :removeDesc,
+                      :removeDoctype, :removeEditorsNSData, :removeEmptyAttrs, :removeEmptyContainers, :removeEmptyText,
+                      :removeHiddenElems, :removeMetadata, :removeNonInheritableGroupAttrs, :removeRasterImages,
+                      :removeTitle, :removeUnknownsAndDefaults, :removeUnusedNS, :removeUselessStrokeAndFill,
+                      :removeViewBox, :removeXMLProcInst, :sortAttrs, :transformsWithOnePath].freeze
+end

data/lib/svgo_wrapper/error.rb

@@ -0,0 +1,4 @@
+class SvgoWrapper
+  class Error < StandardError
+  end
+end

data/lib/svgo_wrapper/parser_error.rb

@@ -0,0 +1,6 @@
+require "svgo_wrapper/error"
+
+class SvgoWrapper
+  class ParserError < Error
+  end
+end

data/lib/svgo_wrapper/svgo_check.rb

@@ -0,0 +1,30 @@
+require "open4"
+require "svgo_wrapper/constants"
+
+class SvgoWrapper
+  class << self
+    def svgo_present?
+      begin
+        Open4.spawn "svgo -i - -o -",
+                    stdin: " <svg/>",
+                    stdout: output = "",
+                    stdout_timeout: 5
+      rescue
+        return false
+      end
+
+      output.start_with?("<svg")
+    end
+  end
+
+  unless svgo_present?
+    # We will warn the user once if the `svgo` tool isn't present on this system when the gem is required. This check
+    # will not be performed again in the code for performance reasons.
+    # :nocov:
+    warn <<-EOS
+WARNING: Required tool `svgo` not found on the system.
+         Please follow these instructions to install it: https://github.com/svg/svgo#how-to-use
+    EOS
+    # :nocov:
+  end
+end

data/lib/svgo_wrapper/version.rb

@@ -0,0 +1,3 @@
+class SvgoWrapper
+  VERSION = "0.0.1".freeze
+end

data/spec/lib/svgo_wrapper/constants_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe SvgoWrapper::DEFAULT_TIMEOUT do
+  it { is_expected.to be_a(Numeric) }
+end
+
+describe SvgoWrapper::VALID_PLUGINS do
+  it "contains safe names" do
+    expect(subject).to all(match(/\A\w+\z/))
+  end
+end

data/spec/lib/svgo_wrapper/svgo_check_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe SvgoWrapper do
+  subject { described_class }
+
+  it "finds the `svgo` tool in the current system" do
+    expect(subject.svgo_present?).to be(true)
+  end
+
+  context "`svgo` tool does not exist" do
+    before(:each) do
+      allow(Open4).to receive(:spawn).and_raise
+    end
+
+    it "does not find the `svgo` tool in the current system" do
+      expect(subject.svgo_present?).to be(false)
+    end
+  end
+end

data/spec/lib/svgo_wrapper/version_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe SvgoWrapper::VERSION do
+  it { is_expected.not_to be_nil }
+end

data/spec/lib/svgo_wrapper_spec.rb

@@ -0,0 +1,177 @@
+require "spec_helper"
+
+describe SvgoWrapper do
+  # The valid plugin sample consists of 3 existing plugins. The first and last ones are symbols, and the one in the
+  # middle is a string.
+  let(:sample_size) { 3 }
+  let(:valid_plugins) do
+    described_class::VALID_PLUGINS.to_a.sample(sample_size).map.with_index {|v, i| i.even? ? v : v.to_s }
+  end
+  let(:invalid_plugins) { valid_plugins + ["inv4lid", :plug1ns] }
+  let(:valid_plugins_as_symbols) { valid_plugins.map(&:to_sym) }
+
+  describe "valid_plugins" do
+    subject { valid_plugins }
+
+    it "consists of Symbols and Strings" do
+      expect(subject.map(&:class)).to eq([Symbol, String, Symbol])
+    end
+  end
+
+  describe "enabled plugins" do
+    context "when none are passed" do
+      subject { described_class.new.enabled_plugins }
+
+      it { is_expected.to be_empty }
+      it { is_expected.to be_frozen }
+    end
+
+    context "when valid are passed" do
+      subject { described_class.new(enable: valid_plugins).enabled_plugins }
+
+      it { is_expected.to be_frozen }
+      it { is_expected.to contain_exactly(*valid_plugins_as_symbols) }
+    end
+
+    context "when invalid are passed" do
+      subject { described_class.new(enable: invalid_plugins).enabled_plugins }
+
+      it { is_expected.to be_frozen }
+      it { is_expected.to contain_exactly(*valid_plugins_as_symbols) }
+    end
+  end
+
+  describe "disabled plugins" do
+    context "when none are passed" do
+      subject { described_class.new.disabled_plugins }
+
+      it { is_expected.to be_empty }
+      it { is_expected.to be_frozen }
+    end
+
+    context "when valid are passed" do
+      subject { described_class.new(disable: valid_plugins).disabled_plugins }
+
+      it { is_expected.to be_frozen }
+      it { is_expected.to contain_exactly(*valid_plugins_as_symbols) }
+    end
+
+    context "when invalid are passed" do
+      subject { described_class.new(disable: invalid_plugins).disabled_plugins }
+
+      it { is_expected.to be_frozen }
+      it { is_expected.to contain_exactly(*valid_plugins_as_symbols) }
+    end
+  end
+
+  describe "timeout" do
+    let(:default_timeout) { described_class::DEFAULT_TIMEOUT }
+    let(:valid_timeout) { 25.5 }
+    let(:invalid_timeout) { :XVIII }
+
+    context "when none is passed" do
+      subject { described_class.new }
+
+      it "has a default value" do
+        expect(subject.timeout).to eq(default_timeout)
+      end
+
+      it "can set a new valid value" do
+        subject.timeout = invalid_timeout
+        expect(subject.timeout).to eq(default_timeout)
+        subject.timeout = valid_timeout
+        expect(subject.timeout).to eq(valid_timeout)
+      end
+    end
+
+    context "when valid value is passed" do
+      let(:valid_timeout_2) { 32 }
+
+      subject { described_class.new(timeout: valid_timeout) }
+
+      it "has that value set" do
+        expect(subject.timeout).to eq(valid_timeout)
+      end
+
+      it "can set a new valid value" do
+        subject.timeout = invalid_timeout
+        expect(subject.timeout).to eq(valid_timeout)
+        subject.timeout = valid_timeout_2
+        expect(subject.timeout).to eq(valid_timeout_2)
+      end
+    end
+
+    context "when invalid value is passed" do
+      subject { described_class.new(timeout: invalid_timeout) }
+
+      it "has a default value" do
+        expect(subject.timeout).to eq(default_timeout)
+      end
+
+      it "can set a new valid value" do
+        subject.timeout = invalid_timeout
+        expect(subject.timeout).to eq(default_timeout)
+        subject.timeout = valid_timeout
+        expect(subject.timeout).to eq(valid_timeout)
+      end
+    end
+  end
+
+  describe "#optimize_images_data" do
+    let(:svg_image) { " <svg><metadata>My Metadata</metadata><title>My Title</title></svg>" }
+
+    context "without plugins" do
+      subject { described_class.new.optimize_images_data svg_image }
+
+      it { is_expected.to start_with("<svg") }
+      it { is_expected.to end_with("/svg>\n") }
+    end
+
+    context "using plugins" do
+      context "to remove the title and keep the metadata" do
+        subject { described_class.new(enable: :removeTitle, disable: [:removeMetadata]).optimize_images_data svg_image }
+
+        it { is_expected.to match(/My Metadata/) }
+        it { is_expected.not_to match(/My Title/) }
+      end
+
+      context "to keep the title and remove the metadata" do
+        subject { described_class.new(enable: [:removeMetadata], disable: :removeTitle).optimize_images_data svg_image }
+
+        it { is_expected.to match(/My Title/) }
+        it { is_expected.not_to match(/My Metadata/) }
+      end
+    end
+
+    context "with incorrect data" do
+      let(:invalid_svg_image) { " <svg><title>This is wrong...</svg>" }
+      subject { described_class.new.optimize_images_data invalid_svg_image }
+
+      it "raises a parsing error" do
+        expect { subject }.to raise_error(described_class::ParserError, "Unexpected close tag\n")
+      end
+    end
+
+    context "`svgo` tool unexpectedly fails" do
+      let(:mocked_status) do
+        # A mock of Process::Status
+        Object.new.tap do |o|
+          o.instance_eval do
+            define_singleton_method :signaled?, proc { false }
+            define_singleton_method :exitstatus, proc { 123 }
+          end
+        end
+      end
+
+      subject { described_class.new.optimize_images_data svg_image }
+
+      before(:each) do
+        allow(Open4).to receive(:spawn).and_raise(Open4::SpawnError.new("command example", mocked_status))
+      end
+
+      it "raises a general error" do
+        expect { subject }.to raise_error(described_class::Error, "Unexpected error (123)\n")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "simplecov" unless ENV["COVERAGE"].nil?
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "svgo_wrapper"
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = :rand
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+# Bind randomized execution to the current seed in RSpec (i.e. for Array#sample).
+srand RSpec.configuration.seed

data/svgo_wrapper.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "svgo_wrapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "svgo_wrapper"
+  spec.required_ruby_version = ">= 2.1"
+  spec.version = SvgoWrapper::VERSION
+  spec.authors = ["Gabriel de Oliveira"]
+  spec.email = ["gdeoliveira@tribune.com"]
+  spec.summary = "This is a simple wrapper for Kir Belevich's `svgo` tool."
+  spec.description = "This gem wraps the SVG image optimization tool by Kir Belevich (svgo).\n" \
+                     "It supports enabling and disabling specific cleanup plugins before optimizing the image data."
+  spec.homepage = "https://github.com/tribune/svgo_wrapper"
+  spec.license = "MIT"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "open4", "~> 1.3.4"
+end

data/tasks/coverage.rb

@@ -0,0 +1,5 @@
+desc "Run tests and generate coverage report"
+task :coverage do
+  ENV["COVERAGE"] = "true"
+  Rake::Task[:spec].invoke
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: svgo_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gabriel de Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: |-
+  This gem wraps the SVG image optimization tool by Kir Belevich (svgo).
+  It supports enabling and disabling specific cleanup plugins before optimizing the image data.
+email:
+- gdeoliveira@tribune.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/svgo_wrapper.rb
+- lib/svgo_wrapper/constants.rb
+- lib/svgo_wrapper/error.rb
+- lib/svgo_wrapper/parser_error.rb
+- lib/svgo_wrapper/svgo_check.rb
+- lib/svgo_wrapper/version.rb
+- spec/lib/svgo_wrapper/constants_spec.rb
+- spec/lib/svgo_wrapper/svgo_check_spec.rb
+- spec/lib/svgo_wrapper/version_spec.rb
+- spec/lib/svgo_wrapper_spec.rb
+- spec/spec_helper.rb
+- svgo_wrapper.gemspec
+- tasks/coverage.rb
+homepage: https://github.com/tribune/svgo_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: This is a simple wrapper for Kir Belevich's `svgo` tool.
+test_files:
+- spec/lib/svgo_wrapper/constants_spec.rb
+- spec/lib/svgo_wrapper/svgo_check_spec.rb
+- spec/lib/svgo_wrapper/version_spec.rb
+- spec/lib/svgo_wrapper_spec.rb
+- spec/spec_helper.rb