svgo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c216063430e455819ad08549b9b6bff0a7b2c34b
+  data.tar.gz: 9183a0a0c245e92cbcde98f6f41f947aa82599c7
+SHA512:
+  metadata.gz: c163a831dbb98c72c2534bf3082c0337d0b515bafe63c061a4e6d99731919d9961b92b20e64ae3127da184e853124fdadf7a34b84a1b80a0ef2da5bee42a1eb3
+  data.tar.gz: cbfb979e20b28027197b96be6e25c47af9509c9e1d92577cfc070820f7cb7198d4d64421161ac7e8644f71a5d8c64432db41bc7f28d0dceb460739dd08885d0f

data/.dockerignore

@@ -0,0 +1,25 @@
+# Ignore bundler config
+/.bundle
+vendor
+# Ignore the build directory
+/build
+# Ignore cache
+/.sass-cache
+/.cache
+# Ignore .DS_store file
+.DS_Store
+# Temporary files
+*.swp
+.nfs*
+tmp
+
+# other
+.gitlab/
+.gitlab-ci.yml
+.eslintrc.yml
+yarn.lock
+package.json
+.editorconfig
+Gemfile.lock
+.ruby-version
+node_modules/

data/.eslintrc.yml

@@ -0,0 +1,106 @@
+env:
+  node: true
+extends: 'eslint:recommended'
+parserOptions:
+  ecmaVersion: 5
+globals:
+  $: false
+  jQuery: false
+  I18n: false
+  locale: true
+rules:
+  indent:
+    - warn
+    - 2
+    -
+      SwitchCase: 1
+      MemberExpression: 1
+      FunctionDeclaration:
+        body: 1
+        parameters: 2
+      CallExpression:
+        arguments: 1
+      ArrayExpression: 1
+      ObjectExpression: 1
+
+  linebreak-style:
+    - warn
+    - unix
+  quotes:
+    - warn
+    - double
+    -
+      avoidEscape: true
+  semi:
+    - error
+    - always
+  camelcase:
+    - warn
+    -
+      properties: never
+      ignoreDestructuring: false
+  brace-style:
+    - warn
+    - 1tbs
+    -
+      allowSingleLine: true
+  comma-spacing:
+    - warn
+  multiline-comment-style:
+    - warn
+    - separate-lines
+  spaced-comment:
+    - warn
+    - always
+    -
+      line:
+        markers:
+          - "="
+      block:
+        exceptions:
+          - "*"
+        balanced: true
+  no-multiple-empty-lines:
+    - error
+    -
+      max: 2
+      maxBOF: 0
+      maxEOF: 1
+  unicode-bom:
+    - error
+    - never
+  dot-location:
+    - error
+    - property
+  dot-notation:
+    - warn
+  no-alert:
+    warn
+  no-console:
+    warn
+  no-eval:
+    error
+  valid-jsdoc:
+    - error
+    -
+      prefer:
+        arg: param
+        argument: param
+        return: returns
+      preferType:
+        object: Object
+        array: Array
+        list: Array
+        hash: Object
+        dict: Object
+      requireReturn: false
+      requireReturnType: true
+      requireParamType: true
+      requireParamDescription: true
+      matchDescription: ".+"
+      requireReturnDescription: true
+  no-unused-vars:
+    - error
+    -
+      vars: all
+      argsIgnorePattern: "window|document|event|el|element|_"

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.4-slim
+RUN apt-get update && apt-get install git-core bash make build-essential -y
+ADD ./ /
+RUN bundle install
+ENTRYPOINT ["/bin/svgo-ruby"]
+CMD ["--pretty", "--multi-pass"]

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    svgo (0.1.0)
+      execjs (>= 2.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    execjs (2.7.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (>= 0.11.3)
+  svgo!
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2018 Greenhost BV
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.MD

@@ -0,0 +1,102 @@
+# A Ruby wrapper for Node SVGO
+
+Removes metadata and editor data elements and attributes that are redundant
+from SVG files. Can strip files so they are optimised for web use. Go to [SVGO]
+(https://github.com/svg/svgo) for more documentation on features.
+
+## How to use?
+
+### As a library
+
+As intended: a Ruby library. Add it to your Gemfile or *.gemspec file and
+install it.
+
+#### Method 1 (Recommended)
+
+By supplying a block that modifies the default options in `SvgoOptions`.
+
+```ruby
+require('svgo')
+svg_file = "path/to/a.svg"
+svgo = SvgOptimizer.new() do | options |
+    options.plugins << :removeRasterImages # (disabled by default)
+    options.plugins.delete(:cleanupIDs) # (enabled by default)
+    options.js2svg.pretty = true
+end
+svgo.optimize(File.read(svg_file))
+# => <svg xmlns="http://www.w3.org/2000/svg" ...
+```
+
+#### Method 2
+
+You can manually pass options to the class that correspond to [SVGO]
+(https://github.com/svg/svgo)'s documentation.
+
+```ruby
+require('svgo')
+svg_file = "path/to/a.svg"
+options = {
+    floatPrecision: 7,
+    js2svg: {
+        pretty: true
+    },
+    multipass: false
+}
+svgo = SvgOptimizer.new(options)
+svgo.optimize(File.read(svg_file))
+# => <svg xmlns="http://www.w3.org/2000/svg" ...
+
+# OR..
+
+svgo.optimize_file(svg_file)
+# => <svg xmlns="http://www.w3.org/2000/svg" ...
+```
+
+You can also choose the plugins to use, you can either pass the exact plugins you want with their configuration, or you can modify the default plugin list.
+
+```ruby
+require('svgo')
+svg_file = "path/to/a.svg"
+options = {
+    plugins: {
+        :addAttributesToSVGElement=>true,
+        :addClassesToSVGElement=>true,
+        :cleanupAttrs=>false,
+        :cleanupEnableBackground=>true,
+        :cleanupIDs=>false,
+        :cleanupListOfValues=>true,
+        :cleanupNumericValues=>true,
+        :collapseGroups=>true,
+        #etc..
+    }
+}
+svgo = SvgOptimizer.new(options)
+```
+
+### As a CLI tool
+
+Strictly speaking this mode is for testing only. But if you can't install NodeJS, and you do have a Ruby environment and you really need a CLI tool, you might be able to squeeze out some optimised files from this utility.
+
+``` bash
+gem install svgo-ruby
+svgo-ruby --pretty < test/fixtures/ruby.svg > test/fixtures/ruby.optim.svg
+ls -hl test/fixtures
+total 72
+-rw-r--r--  1 user  staff   9.5K Nov  5 22:16 ruby.optim.svg
+-rw-r--r--  1 user  staff    23K Nov  5 22:12 ruby.svg
+```
+
+### As a CLI tool from docker
+
+Because this uses a Node utility from a monolithic JavaScript environment which
+is highly dependent on whatever version is available on your system, etc.
+There is a Dockerfile which should always build correctly and run the CLI tool.
+
+This is also only intended for testing purposes.
+
+``` bash
+docker build -t svgo ./
+docker run -i svgo < test/fixtures/ruby.svg > test/fixtures/ruby.optim.svg
+-rw-r--r--  1 user  staff   9.5K Nov  5 22:16 ruby.optim.svg
+-rw-r--r--  1 user  staff    23K Nov  5 22:12 ruby.svg
+```

data/Rakefile

@@ -0,0 +1,14 @@
+desc "Build svgo to single module."
+task :build do
+  sh(%q(npx browserify --standalone svgo \
+    -o ./svgo-js/svgo-built.js \
+    ./svgo-js/svgo-wrapper.js
+  ))
+end
+
+task :install do
+  sh("yarn install")
+end
+
+task :default =>  :build
+

data/bin/svgo-ruby

@@ -0,0 +1,224 @@
+#!/usr/bin/env ruby
+
+##
+# This is a command line tool primarily to test wrapping Node SVGO, it is NOT
+# a drop-in replacement of the node SVGO command line tool. Feel free to add
+# that functionality through a Pull Request if you require it.
+##
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'svgo'
+require 'version'
+require 'optparse'
+require 'pp'
+require 'ostruct'
+
+options = SvgoOptions.new
+output_file = nil
+plugins = {
+addAttributesToSVGElement:
+  "adds attributes to an outer <svg> element",
+addClassesToSVGElement:
+  "adds classnames to an outer <svg> element",
+cleanupAttrs:
+  "cleanups attributes from newlines, trailing and repeating spaces",
+cleanupEnableBackground:
+  "remove or cleanup enable-background attribute when possible",
+cleanupIDs:
+  "removes unused IDs and minifies used",
+cleanupListOfValues:
+  "rounds list of values to the fixed precision",
+cleanupNumericValues:
+  "rounds numeric values to the fixed precision, removes default ‘px’ units",
+collapseGroups:
+  "collapses useless groups",
+convertColors:
+  "converts colors: rgb() to #rrggbb and #rrggbb to #rgb",
+convertPathData:
+  "optimizes path data: writes in shorter form, applies transformations",
+convertShapeToPath:
+  "converts basic shapes to more compact path form",
+convertStyleToAttrs:
+  "converts style to attributes",
+convertTransform:
+  "collapses multiple transformations and optimizes it",
+inlineStyles:
+  "inline styles (additional options)",
+mergePaths:
+  "merges multiple paths in one if possible",
+minifyStyles:
+  "minifies styles and removes unused styles based on usage data",
+moveElemsAttrsToGroup:
+  "moves elements attributes to the existing group wrapper",
+moveGroupAttrsToElems:
+  "moves some group attributes to the content elements",
+prefixIds:
+  "prefix IDs",
+removeComments:
+  "removes comments",
+removeDesc:
+  "removes <desc>",
+removeDimensions:
+  "removes width and height in presence of viewBox (opposite to removeViewBox, disable it first)",
+removeDoctype:
+  "removes doctype declaration",
+removeEditorsNSData:
+  "removes editors namespaces, elements and attributes",
+removeElementsByAttr:
+  "removes arbitrary elements by ID or className (disabled by default)",
+removeEmptyAttrs:
+  "removes empty attributes",
+removeEmptyContainers:
+  "removes empty container elements",
+removeEmptyText:
+  "removes empty <text> elements",
+removeHiddenElems:
+  "removes hidden elements (zero sized, with absent attributes)",
+removeMetadata:
+  "removes <metadata>",
+removeNonInheritableGroupAttrs:
+  "removes non-inheritable group’s presentational attributes",
+removeRasterImages:
+  "removes raster images (disabled by default)",
+removeScriptElement:
+  "removes <script> elements (disabled by default)",
+removeStyleElement:
+  "removes <style> element (disabled by default)",
+removeTitle:
+  "removes <title>",
+removeUnknownsAndDefaults:
+  "removes unknown elements content and attributes, removes attrs with default values",
+removeUnusedNS:
+  "removes unused namespaces declaration",
+removeUselessDefs:
+  "removes elements in <defs> without id",
+removeUselessStrokeAndFill:
+  "removes useless stroke and fill attributes",
+removeViewBox:
+  "removes viewBox attribute when possible",
+removeXMLNS:
+  "removes xmlns attribute (for inline svg, disabled by default)",
+removeXMLProcInst:
+  "removes XML processing instructions",
+sortAttrs:
+  "sorts element attributes (disabled by default)"
+}
+
+options.plugins = Hash[
+  plugins.map { |k, str| [k, !str.include?("disabled by default")]}
+]
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: svgo-ruby [options] [input file]"
+  opts.separator ""
+  opts.separator "Specific options:"
+  #opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+  #  options.verbose = v
+  #end
+  opts.on("-o", "--out [file]", String, "Output file.") do |file|
+    output_file = file
+  end
+  opts.on("-p", "--precision [1..9]", Integer,
+    "Number between 1 and 9, the amount of decimals in path coordinates." \
+    "Set this to the highest number that makes no visual difference for " \
+    "your SVGs. (default=7)"
+    ) do |precision|
+      unless precision.between? 1, 9
+        puts "Invalid precision, should be in range 1 - 9."
+        exit 2
+      end
+      options.floatPrecision = precision
+  end
+  opts.on_tail("--version", "Show version") do
+    puts SvgoVersion::VERSION
+    exit
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  opts.on("--[no-]pretty", "Pretty print SVG.") do |state|
+    options.js2svg.pretty = state
+  end
+  opts.on(
+    "--[no-]multi-pass",
+    "Try to optimize multiple times, maximum of 10 times, or until there " \
+    "is no size difference.") do |state|
+    options.multipass = state
+  end
+  opts.separator ""
+  opts.separator "Enabling/disabling plugins:"
+  plugins.each do |p, desc|
+    opts.on("--[no-]#{p}", desc) do |state|
+        options.plugins[p.to_sym] = state
+    end
+  end
+  opts.on("--removeAttrs", String, %q(
+    A comma separated list of Javascript compatible regular expressions.
+    The format described in the plugin:
+
+    [element]:([attribute]|[attribute])
+
+    Elements and attributes should be separated by a colon.
+
+    examples:
+
+    .*:id
+
+    path:(id|stroke)
+
+    fill
+
+    path:(id|stroke), fill
+
+    To get an idea of what should happen imagine your expressions wrapped in:
+
+    ^<expression>$
+
+    Eg:
+
+    ^.*$:^(stroke|path)$
+
+    For more information on the format see:
+    https://github.com/svg/svgo/blob/master/plugins/removeAttrs.js
+    ).sub(/^\n\s+/,'').gsub(/ {4}/, " " * 12)) do |plugin_args|
+      patterns = plugin_args.sub(/\s*,\s*/, ",").split(",")
+      options.plugins.removeAttrs = patterns
+    end
+end
+
+parser.parse!
+
+svgo = SvgOptimizer.new(options)
+
+# Read from stdin..
+unless STDIN.tty? and not STDIN.closed?
+    input_data = ARGF.read
+    result = svgo.optimize(input_data)
+else
+    # See if there is an input file name
+    input_file = ARGV.pop
+    unless input_file
+        puts "No input file specified."
+        puts parser.banner
+        exit 2
+    else
+        result = svgo.optimize_file(input_file)
+    end
+end
+
+if result['errors'].length > 0
+  if result['errors'].length > 1
+    puts %Q(Errors occurred: \n - #{result['errors'].join("\n - s")})
+  else
+    puts "An error occurred: #{result['errors'][0]}"
+  end
+  exit(1)
+end
+
+unless output_file
+    puts result['data']
+else
+    File.new(output_file, 'w').write(result['data'])
+end
+
+