svg_sprite 0.2.2 → 1.0.2

data/lib/svg_sprite/cli.rb

@@ -1,4 +1,6 @@
-module SvgSprite
+# frozen_string_literal: true
+
+class SvgSprite
   class CLI < Thor
     check_unknown_options!
 
@@ -6,10 +8,6 @@ module SvgSprite
       true
     end
 
-    def self.formats
-      TEMPLATES.keys
-    end
-
     desc "version", "Display svg_sprite version"
     map %w[-v --version] => :version
 
@@ -17,31 +15,50 @@ module SvgSprite
       say SvgSprite::VERSION
     end
 
-    desc "generate", "Generate the SVG sprite by embedding the images as data URIs."
-    option :source, aliases: %w[-s], required: true, desc: "The source directory. Will match SOURCE/**/*.svg."
-    option :output, aliases: %w[-o], required: true, desc: "The output file."
-    option :name, aliases: %w[-n], default: "sprite", desc: "The sprite name. This will be used as the variable for dynamic files."
-    option :format, aliases: %w[-f], desc: "The output format. When not provided, will be inferred from output file's extension. Can be any of #{formats.join("|")}."
+    desc "generate",
+         "Generate the SVG sprite by embedding the images as data URIs."
+    option :input,
+           aliases: %w[-i],
+           required: true,
+           desc: "The input directory. Will match INPUT/**/*.svg."
+    option :css_path,
+           aliases: %w[-c],
+           required: true,
+           desc: "The CSS output file path."
+    option :sprite_path,
+           aliases: %w[-s],
+           required: true,
+           desc: "The SVG output file path."
+    option :name,
+           aliases: %w[-n],
+           default: DEFAULT_SPRITE_NAME,
+           desc: "The sprite name. This will be used as the variable for " \
+                 "dynamic files."
+    option :optimize,
+           aliases: %w[-o],
+           default: true,
+           type: :boolean,
+           desc: "Optimize SVG files."
+    option :stroke,
+           aliases: %w[-t],
+           enum: %w[current-color remove],
+           desc: "Stroke replacement strategy."
+    option :fill,
+           aliases: %w[-f],
+           enum: %w[current-color remove],
+           desc: "Fill replacement strategy."
     def generate
-      format = options["format"] || File.extname(options["output"])[1..-1]
-      fail Error, "ERROR: invalid output format. Must be one of #{formats.join("|")}." unless valid_format?(format)
+      input = File.expand_path(options["input"])
 
-      SvgSprite.export(
-        source: File.expand_path(options["source"]),
-        output: File.expand_path(options["output"]),
-        format: format,
-        name: options["name"]
+      SvgSprite.call(
+        input: input,
+        sprite_path: File.expand_path(options["sprite_path"]),
+        css_path: File.expand_path(options["css_path"]),
+        name: options["name"],
+        optimize: options["optimize"],
+        stroke: options["stroke"],
+        fill: options["fill"]
       )
     end
-
-    private
-
-    def valid_format?(format)
-      formats.include?(format)
-    end
-
-    def formats
-      self.class.formats
-    end
   end
 end

data/lib/svg_sprite/svg.rb

@@ -1,74 +1,73 @@
-module SvgSprite
+# frozen_string_literal: true
+
+class SvgSprite
   class SVG
-    attr_reader :path
+    attr_reader :filepath, :name, :optimize, :stroke, :fill
 
-    def initialize(path)
-      @path = path
+    def initialize(filepath, name:, optimize:, stroke:, fill:)
+      @name = name
+      @filepath = filepath
+      @optimize = optimize
+      @stroke = stroke
+      @fill = fill
     end
 
-    # Return the image file name without the extension.
-    def name
-      File.basename(path, ".*")
+    def svg
+      @svg ||= xml.css("svg").first
     end
 
-    # Detect if SVG has all dimensions defined.
-    def has_dimensions?
-      width && height
-    end
+    def symbol
+      @symbol ||= svg.clone.tap do |node|
+        node.name = "symbol"
+        node.set_attribute :id, id
+        node.remove_attribute "width"
+        node.remove_attribute "height"
 
-    # Return a Nokogiri representation of the <svg> element.
-    def svg
-      @svg ||= Nokogiri::XML(contents).css("svg").first
+        process_stroke(node)
+        process_fill(node)
+      end
     end
 
-    # Return the <svg>'s width.
     def width
-      svg["width"]
+      svg[:width]
     end
 
-    # Return the <svg>'s height.
     def height
-      svg["height"]
+      svg[:height]
     end
 
-    # Return the raw content. This content is not optimized by svg_optimizer.
-    def contents
-      @contents ||= File.read(path)
+    def id
+      @id ||= [name, File.basename(filepath, ".*")].join("--")
     end
 
-    # Return the optimized content.
-    def optimized
-      @optimized ||= SvgOptimizer.optimize(contents)
+    private def xml
+      @xml ||= begin
+        contents = File.read(filepath)
+        contents = SvgOptimizer.optimize(contents) if optimize
+        Nokogiri::XML(contents)
+      end
     end
 
-    # Return the URL-encoded version of the content.
-    def encoded
-      URI.escape(contents)
+    private def process_stroke(node)
+      process_attribute(node, "stroke", stroke)
     end
 
-    # Return the Base64-encoded version of the content.
-    def base64
-      Base64.strict_encode64(optimized)
+    private def process_fill(node)
+      process_attribute(node, "fill", fill)
     end
 
-    # Return the smaller data URI.
-    def data_uri
-      [base64_data_uri, urlencoded_data_uri].sort_by(&:bytesize).first
-    end
-
-    # Return the Base64 version of the data URI.
-    def base64_data_uri
-      %[data:image/svg+xml;base64,#{base64}]
-    end
+    private def process_attribute(symbol, attribute, value)
+      return unless value
 
-    # Return the URL-encoded version of the data URI.
-    def urlencoded_data_uri
-      %[data:image/svg+xml;charset=#{encoding},#{encoded}]
-    end
+      symbol.css("[#{attribute}]").each do |node|
+        if value == "current-color" && node[attribute] != "none"
+          node.set_attribute(attribute, "currentColor")
+        end
 
-    # The output encoding based on the global configuration.
-    def encoding
-      Encoding.default_external.name
+        if value == "remove" && node[attribute] != "none"
+          node.remove_attribute(attribute)
+        end
+      end
     end
   end
 end

data/lib/svg_sprite/version.rb

@@ -1,3 +1,5 @@
-module SvgSprite
-  VERSION = "0.2.2"
+# frozen_string_literal: true
+
+class SvgSprite
+  VERSION = "1.0.2"
 end

data/lib/svg_sprite.rb

@@ -1,36 +1,149 @@
-module SvgSprite
-  require "base64"
-  require "uri"
-  require "erb"
-  require "svg_optimizer"
-  require "thor"
-  require "fileutils"
+# frozen_string_literal: true
+
+require "svg_optimizer"
+require "thor"
+require "fileutils"
+require "shellwords"
+require "pathname"
+
+class SvgSprite
+  NOKOGIRI_SAVE_OPTIONS = {
+    save_with: Nokogiri::XML::Node::SaveOptions::DEFAULT_XML |
+               Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+  }.freeze
+
+  DEFAULT_SPRITE_NAME = "sprite"
 
   require "svg_sprite/version"
-  require "svg_sprite/template/scss"
-  require "svg_sprite/template/css"
-  require "svg_sprite/template"
-  require "svg_sprite/sprite"
-  require "svg_sprite/source"
-  require "svg_sprite/svg"
   require "svg_sprite/cli"
+  require "svg_sprite/svg"
 
-  def self.create(options)
-    Sprite.new(
-      Source.new(options[:source]),
-      find_template(options[:format]),
-      options
-    )
+  def self.call(
+    input:,
+    sprite_path:,
+    css_path:,
+    name: DEFAULT_SPRITE_NAME,
+    optimize: true,
+    stroke: nil,
+    fill: nil
+  )
+    new(
+      name: name,
+      input: input,
+      sprite_path: sprite_path,
+      css_path: css_path,
+      optimize: optimize,
+      stroke: stroke,
+      fill: fill
+    ).tap(&:call)
   end
 
-  def self.export(options)
-    FileUtils.mkdir_p(File.dirname(options[:output]))
-    File.open(options[:output], "w") do |file|
-      file << create(options).render
+  attr_reader :name, :sprite_path, :input, :css_path, :optimize, :stroke, :fill,
+              :input_files
+
+  def initialize(
+    name:, input:, sprite_path:, css_path:, optimize:, stroke:, fill:
+  )
+    @name = name
+    @input = input
+    @input_files = Dir["#{input}/**/*.svg"].sort
+    @sprite_path = sprite_path
+    @css_path = css_path
+    @optimize = optimize
+    @stroke = stroke
+    @fill = fill
+  end
+
+  def call
+    save_file sprite_path, svg_sprite
+    save_file css_path, manifest(css_definitions.chomp)
+    self
+  end
+
+  private def manifest(css)
+    <<~TEXT
+      /*
+      This file was generated by https://rubygems.org/gems/svg_sprite with the
+      following command:
+
+      #{command}
+      */
+
+      #{css}
+    TEXT
+  end
+
+  private def command
+    cwd = Pathname.new(Dir.pwd)
+
+    cmd = [
+      "svg_sprite",
+      "generate",
+      "--input",
+      Pathname.new(input).relative_path_from(cwd).to_s,
+      "--sprite-path",
+      Pathname.new(sprite_path).relative_path_from(cwd).to_s,
+      "--css-path",
+      Pathname.new(css_path).relative_path_from(cwd).to_s
+    ]
+
+    cmd.push("--name", name) if name != DEFAULT_SPRITE_NAME
+    cmd.push("--no-optimize") unless optimize
+    cmd.push("--stroke", stroke) if stroke
+    cmd.push("--fill", fill) if fill
+
+    cmd.map {|segment| Shellwords.escape(segment) }.join(" ")
+  end
+
+  private def svgs
+    @svgs ||= input_files
+              .map {|file| build_svg(file) }
+              .sort_by(&:id)
+  end
+
+  private def build_svg(file)
+    SVG.new(file, name: name, optimize: optimize, stroke: stroke, fill: fill)
+  end
+
+  private def css_definitions
+    svgs.each_with_object(StringIO.new) do |svg, io|
+      io << ".#{svg.id} {\n"
+      io << "  width: #{svg.width};\n"
+      io << "  height: #{svg.height};\n"
+      io << "}\n\n"
+    end.tap(&:rewind).read.chomp
+  end
+
+  private def save_file(filepath, content)
+    FileUtils.mkdir_p(File.dirname(filepath))
+
+    File.open(filepath, "w") do |io|
+      io << content
+    end
+  end
+
+  private def svg_sprite
+    builder = sprite_builder
+    add_symbols(builder.doc.css("defs").first)
+
+    Nokogiri::XML(builder.to_xml) {|doc| doc.default_xml.noblanks }
+            .to_xml(NOKOGIRI_SAVE_OPTIONS.dup.merge(indent: 2))
+  end
+
+  private def sprite_builder
+    Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+      xml.svg(
+        xmlns: "http://www.w3.org/2000/svg",
+        style: "display: none"
+      ) do |svg|
+        svg.defs { } # rubocop:disable Lint/EmptyBlock
+      end
     end
   end
 
-  def self.find_template(format)
-    TEMPLATES[format] || fail("Invalid output format.")
+  private def add_symbols(defs)
+    svgs.each do |svg|
+      defs << svg.symbol
+    end
   end
 end

data/svg_sprite.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "./lib/svg_sprite/version"
 
 Gem::Specification.new do |spec|
@@ -5,24 +7,31 @@ Gem::Specification.new do |spec|
   spec.version       = SvgSprite::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["fnando.vieira@gmail.com"]
+  spec.required_ruby_version = ">= 2.7"
+  spec.metadata = {"rubygems_mfa_required" => "true"}
 
-  spec.summary       = "Create SVG sprites using data URIs."
+  spec.summary       = "Create SVG sprites using SVG links."
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/fnando/svg_sprite"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject {|f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "svg_optimizer"
   spec.add_dependency "nokogiri"
+  spec.add_dependency "svg_optimizer"
   spec.add_dependency "thor"
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "css_parser"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
   spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: svg_sprite
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.2
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: svg_optimizer
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: svg_optimizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,44 +56,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: css_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,49 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Create SVG sprites using data URIs.
+- !ruby/object:Gem::Dependency
+  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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create SVG sprites using SVG links.
 email:
 - fnando.vieira@gmail.com
 executables:
@@ -130,40 +172,47 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- examples/README.md
+- examples/images/doc-fill.svg
+- examples/images/doc.svg
+- examples/images/trash-fill.svg
+- examples/images/trash.svg
 - examples/index.html
-- examples/source/a/blue-square.svg
-- examples/source/a/orange-square.svg
-- examples/source/b/green-square.svg
-- examples/source/b/yellow-square.svg
-- examples/source/scss.scss
+- examples/sprite/current-color.css
+- examples/sprite/current-color.svg
+- examples/sprite/original.css
+- examples/sprite/original.svg
+- examples/sprite/remove.css
+- examples/sprite/remove.svg
 - exe/svg_sprite
 - lib/svg_sprite.rb
 - lib/svg_sprite/cli.rb
-- lib/svg_sprite/source.rb
-- lib/svg_sprite/sprite.rb
 - lib/svg_sprite/svg.rb
-- lib/svg_sprite/template.rb
-- lib/svg_sprite/template/css.erb
-- lib/svg_sprite/template/css.rb
-- lib/svg_sprite/template/scss.erb
-- lib/svg_sprite/template/scss.rb
 - lib/svg_sprite/version.rb
 - svg_sprite.gemspec
 homepage: https://github.com/fnando/svg_sprite
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,16 +220,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.3.3
+signing_key:
 specification_version: 4
-summary: Create SVG sprites using data URIs.
+summary: Create SVG sprites using SVG links.
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2

data/examples/README.md

@@ -1,19 +0,0 @@
-# Exporting Sass files
-
-Run this command to export the sprite:
-
-```
-RUBYOPT="-I./lib" ./exe/svg_sprite generate -s examples/source -o examples/source/_icons.scss
-```
-
-Then run this command to export the styles:
-
-````
-scss examples/source/scss.scss examples/dist/scss.css
-````
-
-# Exporting vanilla CSS
-
-```
-RUBYOPT="-I./lib" ./exe/svg_sprite generate -s examples/source -o examples/dist/css.css
-```