svgsprite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e30b8d45143456fa8b7e786a6a9869df9160b16a
+  data.tar.gz: 239e29d77b3e6124aa3231028442b21258a354fc
+SHA512:
+  metadata.gz: 35a44a2fffa2f05253cef8e5c2438426486f2c1bbae6ce263249ee61cc9512c2560674024cb729c80ee9197d53b38b8e062bd251e95e3b25bd40614c4a09f736
+  data.tar.gz: 2fb649cc55e531d71433d781fcfa43c0125c15ec1ba81e7b765121cde54fe069dec93a0629b27121198110458f136f5b38b18df40e4f41fc049d1f350dc1139e

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Etienne Lemay
+
+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,33 @@
+# SVGSprite
+Very early stage of an untested tool that merges a folder of SVGs together into a single SVG file.<br>
+See [Chris Coyier’s article](http://css-tricks.com/svg-sprites-use-better-icon-fonts) about SVG sprites.
+
+## Usage
+```sh
+$ svgsprite                                                                                                                                        Wed 21 May 2014 16:09:39 EDT
+SVGSprite commands:
+  svgsprite help [COMMAND]   # Describe available commands or one specific command
+  svgsprite merge [OPTIONS]  # Merge SVGs from a folder
+
+Options:
+  -i, [--input=INPUT]            # The folder where the separated SVGs are.
+                                 # Default: ./svgsprite/svgs
+
+  -o, [--output=OUTPUT]          # Where the merged SVG is saved.
+                                 # Default: ./app/assets/images
+
+  -s, [--stdout], [--no-stdout]  # Outputs the result to STDOUT.
+
+  -f, [--filename=FILENAME]      # Merged file name.
+                                 # Default: svgsprite
+
+  -p, [--prefix=PREFIX]          # SVG IDs prefix.
+                                 # Default: icon
+```
+
+### Static HTML
+```sh
+$ svgsprite merge --stdout | pbcopy
+```
+
+Then paste into your HTML file.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/svgsprite

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'svgsprite/cli'
+SVGSprite::CLI.start(ARGV)

data/lib/svgsprite/base.rb

@@ -0,0 +1,9 @@
+module SVGSprite
+  class Base
+    def initialize(options)
+      @options = options
+      svgs = SVGSprite::Extractor.extract!(@options)
+      SVGSprite::Exporter.export!(svgs, @options)
+    end
+  end
+end

data/lib/svgsprite/cli.rb

@@ -0,0 +1,33 @@
+require 'thor'
+require 'svgsprite'
+
+module SVGSprite
+  class CLI < Thor
+    package_name 'SVGSprite'
+
+    class_option :input, aliases: '-i', type: :string,
+      desc: 'The folder where the separated SVGs are.',
+      default: './svgsprite/svgs'
+
+    class_option :output, aliases: '-o', type: :string,
+      desc: 'Where the merged SVG is saved.',
+      default: './app/assets/images'
+
+    class_option :stdout, aliases: '-s', type: :boolean,
+      desc: 'Outputs the result to STDOUT.',
+      default: true
+
+    class_option :filename, aliases: '-f', type: :string,
+      desc: 'Merged file name.',
+      default: 'svgsprite'
+
+    class_option :prefix, aliases: '-p', type: :string,
+      desc: 'SVG IDs prefix.',
+      default: 'icon'
+
+    desc 'merge [OPTIONS]', 'Merge SVGs from a folder'
+    def merge
+      Base.new(options)
+    end
+  end
+end

data/lib/svgsprite/exporter.rb

@@ -0,0 +1,56 @@
+module SVGSprite
+  class Exporter
+    XMLNS = {
+      'xmlns' => 'http://www.w3.org/2000/svg',
+      'xmlns:sketch' => 'http://www.bohemiancoding.com/sketch/ns',
+      'xmlns:xlink' => 'http://www.w3.org/1999/xlink'
+    }
+
+    # Class methods
+    def self.export!(svgs, options)
+      exporter = self.new(svgs, options)
+      exporter.create_output_dir!
+
+      if options[:stdout]
+        exporter.export_to_stdout
+      else
+        exporter.export_to_file
+      end
+    end
+
+    # Instance methods
+    def initialize(svgs, options)
+      @options = options
+      @svgs = svgs
+    end
+
+    def create_output_dir!
+      FileUtils.mkdir_p(@options[:output])
+    end
+
+    def export_to_stdout
+      STDOUT.write(svg_string)
+    end
+
+    def export_to_file
+      output_file = "#{@options[:output]}/#{@options[:filename]}.svg"
+      File.open(output_file, 'w') { |f| f.write(svg_string) }
+    end
+
+    def svg_string
+      icon_nodes = @svgs.map { |svg_hash| icon_node(svg_hash) }
+      xmlns = XMLNS.map { |k, v| %(#{k}="#{v}") }.join(' ')
+
+      %(<svg style="display: none" #{xmlns}><defs>#{icon_nodes.join('')}</defs></svg>)
+    end
+
+    def icon_node(svg_hash)
+      prefix = @options[:prefix]
+      svg = svg_hash[:svg]
+      filename = svg_hash[:filename]
+      id = "#{prefix}-#{filename}"
+
+      %(<g id="#{id}">#{svg}</g>)
+    end
+  end
+end

data/lib/svgsprite/extractor.rb

@@ -0,0 +1,34 @@
+require 'nokogiri'
+
+module SVGSprite
+  class Extractor
+    # Class methods
+    def self.extract!(options)
+      self.new(options).extract_svgs
+    end
+
+    # Instance methods
+    def initialize(options)
+      @options = options
+      @input = @options[:input]
+    end
+
+    def extract_svgs
+      Dir.glob("#{@input}/*.svg").map do |filepath|
+        filename = File.basename(filepath, '.svg')
+        file = File.open(filepath)
+
+        {
+          filename: filename,
+          svg: extract_svg_from(file)
+        }
+      end
+    end
+
+    def extract_svg_from(file)
+      doc = Nokogiri::HTML(file)
+      node = doc.css('g').last.children
+      node.to_s.strip
+    end
+  end
+end

data/lib/svgsprite/version.rb

@@ -0,0 +1,3 @@
+module SVGSprite
+  VERSION = '0.0.1'
+end

data/lib/svgsprite.rb

@@ -0,0 +1,7 @@
+require 'svgsprite/version'
+require 'svgsprite/base'
+require 'svgsprite/extractor'
+require 'svgsprite/exporter'
+
+module SVGSprite
+end

data/svgsprite.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svgsprite/version'
+
+Gem::Specification.new do |gem|
+  gem.name     = 'svgsprite'
+  gem.version  = SVGSprite::VERSION
+  gem.authors  = ['Etienne Lemay']
+  gem.email    = ['etienne@heliom.ca']
+  gem.summary  = 'Merge SVGs from a folder'
+  gem.homepage = 'https://github.com/EtienneLem/svgsprite'
+  gem.license  = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec)/})
+  gem.require_paths = ['lib']
+
+  gem.bindir = 'bin'
+  gem.executables << 'svgsprite'
+
+  gem.add_dependency 'thor', '~> 0.14'
+  gem.add_dependency 'nokogiri', '~> 1.6.2.1'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: svgsprite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Etienne Lemay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2.1
+description: 
+email:
+- etienne@heliom.ca
+executables:
+- svgsprite
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/svgsprite
+- lib/svgsprite.rb
+- lib/svgsprite/base.rb
+- lib/svgsprite/cli.rb
+- lib/svgsprite/exporter.rb
+- lib/svgsprite/extractor.rb
+- lib/svgsprite/version.rb
+- svgsprite.gemspec
+homepage: https://github.com/EtienneLem/svgsprite
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Merge SVGs from a folder
+test_files: []