svg_spriter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76990472a6115293f4a6ed339304131c522d598c
+  data.tar.gz: 5dcf85e41e3546d8519dda6913fe37561d0ffc5d
+SHA512:
+  metadata.gz: 84c19d3c70f7e892b5dad993cb0cbcf06925137e2981799b02bfd4f39b7a2396610f8d5b6ea5aaf66a10284dfbf27ef632b48a185dbda1788b436fdf9e48d02f
+  data.tar.gz: c567b2d24c615d8ba37ab1a268f5082f5ccfc66793955ed740de2708ec71fdcb0d491a8a15ce78e9f9cc10dafa45bfeb61d99ea4a2a8eec620fb87dfdc5bd365

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in svg_spriter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kyle Simmonds
+
+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,52 @@
+# SvgSpriter
+
+Take a directory of SVG files, optimize them, and compile them into a single sprite file using `<symbol>` elements.
+
+Use case for SVG sprites: https://css-tricks.com/svg-sprites-use-better-icon-fonts
+
+This gem is based off [svg-sprite](https://www.npmjs.com/package/svg-sprite) for npm. It will allow you to use SVG sprites while only maintaining one instance of an SVG. Originally built for Nanoc to build a sprite when compiling site, but can be used in any Ruby application that can compile a site.
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'svg_spriter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install svg_spriter
+
+## Usage
+
+During compiling, run:
+
+```ruby
+sprite_svg(source: 'source', output: 'output')
+```
+
+where source is something like /static/svg. Output is optional, and will use the source if not specified.
+
+## TODO
+
++ Allow for more robust SVGs. Currently only simple SVGs compile reliably
++ Allow for subdirectories of source directory
++ Add more tests for checking integrity of compiled sprite
++ Handle SVGs with duplicate ids
+
+## Author’s note
+
+This is my first RubyGem, and my experience with Ruby is limited. This was a way for me to learn more about Ruby and RubyGems, and I don't pretend to know the best way to do things in Ruby. So, any contributions or suggestions for this gem are appreciated.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kylesimmonds/svg_spriter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "svg_spriter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/svg_spriter.rb

@@ -0,0 +1,104 @@
+require 'svg_spriter/version'
+require 'svg_optimizer'
+
+module SvgSpriter
+
+  # class SpriteItem
+  #   def initialize(filename)
+  #     @filename = filename
+  #   end
+  # end
+
+
+
+  def sprite_svg(source: nil, output: nil)
+
+    # if item.nil? or item.undefined? # Check for item
+      # puts "SVG Spriter needs an item to sprite!" # Harass the user
+      # return # End
+    if source.nil? # Check for source
+      puts "SVG Spriter needs a source!" # Harass the user
+      return # End
+    elsif File.directory?(source) == false # Check if source is a directory
+      puts "Source is not a directory, or directory doesn't exit."
+      return # End
+    end
+
+    # @item = SpriteItem.new(item) # Define current item
+    @source = source.to_s.chomp('/') # Get source and remove trailing slash
+    @output = output.nil? ? @source : output.to_s.chomp('/') # Get output and remove trailing slash. Set to source if nil
+
+    list_items()
+  end
+
+
+
+  def list_items
+    @item_list = nil
+    @item_list = Dir[@source + "/*.svg"] # Get the list of all sprites in @source
+    @item_list.delete(@source + "/sprite.svg") # Remove sprite.svg from list
+    @compile_list = @item_list.uniq # Remove any duplicates from item list
+
+    @defs_list = ''
+    @symbols_list = ''
+    @number_of_svgs = 0
+
+    @compile_list.each_with_index do |v, i|
+      # $current_item = SpriteItem.new v
+      @number_of_svgs += 1 # Take a count of how many SVGs there are
+      compile_item v
+    end
+
+    @number_of_symbols = @symbols_list.scan(/<symbol/).count
+    compile_sprite()
+  end
+
+
+
+  def compile_item(current_item)
+    svg = File.read current_item.to_s # Read the current svg
+    id = svg[/id=('|")(.*?)('|")/, 2] # Get id
+    vb = svg[/viewBox=(\'|")(.*?)('|")/, 2] # Get viewbox
+    par = svg[/preserveAspectRatio=(\'|")(.*?)('|")/, 2] # Get preserveAspectRatio
+    # Make sure the three attributes exist
+    add_id = id ? "id='#{id}'" : nil
+    add_vb = vb ? " viewBox='#{vb}'" : nil
+    add_par = par ? " preserveAspectRatio='#{par}'" : nil
+
+    optimized_svg = SvgOptimizer.optimize svg # Optimize the svg
+    symbol = optimized_svg.gsub /<svg (.*?)>/m, "<symbol #{add_id}#{add_vb}#{add_par}>" # Replace the optimized svg tag with a symbol, the id, the viewBox and preserveAspectRatio, if there is one
+    symbol = symbol.gsub '</svg>', '</symbol>'
+
+    defs = symbol[/<defs>(.*?)<\/defs>/m, 1] # Get svg's defs, if any
+    sans_defs = nil
+    if defs
+      pre_defs = symbol[/(.*?)<defs>(.*?)<\/defs>(.* ?)/m, 1] # Get symbol before defs
+      post_defs = symbol[/(.*?)<defs>(.*?)<\/defs>(.* ?)/m, 3] # Get symbol after defs
+      sans_defs = "#{pre_defs}#{post_defs}" # Put them together to remove the defs
+      defs = defs.gsub />\s+</,"><" # Remove all extra space
+      @defs_list << defs # Add the defs to the insertion list for the sprite
+    end
+
+    symbol = sans_defs ? sans_defs : symbol # Set the variable to the symbol without defs, if applicable
+    symbol = symbol.gsub />\s+</,"><" # Remove all extra space
+    @symbols_list << symbol # Add the symbol to the insertion list for the sprite
+  end
+
+
+
+  def compile_sprite
+    $f = File.open @output + '/sprite.svg', 'w+' # Open or create sprite.svg
+    $f.truncate 0 # Delete contents of sprite.svg
+    $f << '<svg version="1.1" id="icon-sprite" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" xml:space="preserve">' # Add svg open tag
+
+    unless @defs_list.empty? # Don't add the defs if there aren't any
+      @defs_list = @defs_list.gsub(/>\s+</,"><").strip # Trim the defs before adding
+      $f << "<defs>#{@defs_list}</defs>" # Add the defs to the sprite
+    end
+    $f << @symbols_list # Add the symbols to the sprite
+    $f << '</svg>' # Close the svg tag
+
+    $f.close # Close the file
+    return $f # Send it back to go to the output
+  end
+end

data/lib/svg_spriter/version.rb

@@ -0,0 +1,3 @@
+module SvgSpriter
+  VERSION = "0.1.0"
+end

data/svg_spriter.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svg_spriter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "svg_spriter"
+  spec.version       = SvgSpriter::VERSION
+  spec.authors       = ["Kyle Simmonds"]
+  spec.email         = ["kylesimmonds@users.noreply.github.com"]
+
+  spec.summary       = %q{Take a directory of SVG files, optimize them, and compile them into a single file using <symbol> elements.}
+  spec.description   = %q{Based off svg-sprite for npm, this basic utility will allow you to use SVG sprites while only maintaining one instance of an SVG.}
+  spec.homepage      = "https://github.com/kylesimmonds/svg-spriter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'svg_optimizer'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: svg_spriter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Simmonds
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: svg_optimizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Based off svg-sprite for npm, this basic utility will allow you to use
+  SVG sprites while only maintaining one instance of an SVG.
+email:
+- kylesimmonds@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/svg_spriter.rb
+- lib/svg_spriter/version.rb
+- svg_spriter.gemspec
+homepage: https://github.com/kylesimmonds/svg-spriter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Take a directory of SVG files, optimize them, and compile them into a single
+  file using <symbol> elements.
+test_files: []