esvg 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5617c1952dc7fd76da427719eb2a7ddb5a8e7910
+  data.tar.gz: 7ab87e15d4af16d39aac5c53116e9f945719b09c
+SHA512:
+  metadata.gz: f1fd6835394f4aad7832edf92997f79a89e2f3a2d9b4cf1f1aab4e2bad25ea088c5d4f8b93f35e250f2e447edd6fa3c0e649c6536149e58d72fa42df82ee283e
+  data.tar.gz: 94a0b8da7fc8e9314bcbecc1f0052f4dca9934214e8ea4a013400d73d24f44a03afdd300f6ff1d36ac6d013afd17a857355851bfcbd4de31534707b0937bc154

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brandon Mathis
+
+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,114 @@
+# Esvg
+
+Easily embed optimized SVGs in HTML or CSS. Use as a standalone tool or with Rails.
+
+[![Gem Version](http://img.shields.io/gem/v/esvg.svg)](https://rubygems.org/gems/esvg)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://imathis.mit-license.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esvg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install esvg
+
+## Usage: Rails
+
+Add SVG files to your `app/assets/svg_icons/` directory, then embed these SVGs in your application layout like this:
+
+```
+<head>
+...
+<%= embed_svgs %>
+</head>
+```
+
+To reference an SVG, use the `svg_icon` helper.
+
+```
+# Syntax: svg_icon name, [options]
+
+# Standard example
+<%= svg_icon 'kitten' %>
+
+# Output:
+# <svg class="icon kitten-icon"><use xlink:href="#kitten-icon"/></svg>
+
+# Add custom classnames
+<%= svg_icon 'kitten', class: 'adorbs' %>
+
+# Output: 
+# <svg class="icon kitten-icon adorbs"><use xlink:href="#kitten-icon"/></svg>
+
+# Add title and desc tags for SVG accessibility.
+<%= svg_icon 'kitten', title: "Mr. Snuggles", desc: "A graphic of a cat snuggling a ball of yarn" %>
+
+# Output: 
+# <svg class="icon kitten-icon"><use xlink:href="#kitten-icon"/>
+#   <title>Mr. Snuggles</title>
+#   <desc>A graphic of a cat snuggling a ball of yarn</desc>
+# </svg>
+```
+
+## Usage: stand-alone CLI
+
+```
+# Syntax:
+$ esvg PATH [options]
+
+# Examples:
+$ esvg                          # Read icons from current directory, write HTML to ./esvg.html
+$ esvg icons --output embedded  # Read icons from 'icons' directory, write HTML to embedded/esvg.html
+$ esvg --stylesheet             # Embed icons in Stylesheet and write to ./esvg.scss
+$ esvg --config foo.yml         # Read confguration from foo.yml
+```
+
+## Configuration: Rails
+
+Esvg reads configuration from `config/esvg.yml` if used with Rails.
+
+Options when used with Rails:
+
+```
+path: app/assets/svg_icons  # Where to find SVG icons
+namespace: icon             # Add to the filename when creating symbol ids
+namespace_after: true       # Add after the name, e.g. kitten-icon
+
+
+stylesheet_embed: false     # Embed as a stylesheet
+font_size: 1em              # Default size for SVGs (if embeded in stylesheets)
+```
+
+## Configuration: stand-alone CLI
+
+If you're using esvg from the command line, configuration files are read from `./esvg.yml` or you can pass a path with the `--config` option to read the config file from elsewhere.
+
+```
+path: .                     # Where to find SVG icons
+namespace: icon             # Add to the filename when creating symbol ids
+namespace_after: true       # Add after the name, e.g. kitten-icon
+
+
+stylesheet_embed: false     # Embed as a stylesheet
+font_size: 1em              # Default size for SVGs (if embeded in stylesheets)
+
+output_path: .              # Where to write output files
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/imathis/esvg. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "esvg"
+
+# 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/esvg.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'esvg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "esvg"
+  spec.version       = Esvg::VERSION
+  spec.authors       = ["Brandon Mathis"]
+  spec.email         = ["brandon@imathis.com"]
+
+  spec.summary       = %q{Embed svgs in HTML or CSS}
+  spec.homepage      = "https://github.com/imathis/esvg"
+  spec.license       = "MIT"
+
+  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_runtime_dependency "svg_optimizer", "~> 0.0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug"
+end

data/exe/esvg

@@ -0,0 +1,32 @@
+#! /usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require 'optparse'
+require 'esvg'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.on("-s", "--stylesheet", "Embed SVGs in Sass file") do
+    options[:stylesheet_embed] = true
+  end
+
+  opts.on("-c", "--config PATH", String, "Path to a config file (default: esvg.yml or config/esvg.yml)") do |path|
+    options[:config_file] = path
+  end
+
+  opts.on("-o", "--output PATH", String, "Where should SCSS/HTML files be written, (default: current directory)") do |path|
+    options[:output_path] = path
+  end
+end.parse!
+
+options[:path] = ARGV.shift
+
+esvg = Esvg::SVG.new(options)
+
+if options[:stylesheet_embed]
+  esvg.write_stylesheet
+else
+  esvg.write_html
+end

data/lib/esvg.rb

@@ -0,0 +1,51 @@
+require "svg_optimizer"
+require "fileutils"
+
+require "esvg/version"
+require "esvg/svg"
+
+if defined?(Rails)
+  require "esvg/helpers" 
+  require "esvg/railties" 
+end
+
+module Esvg
+  extend self
+
+  def icons(options={})
+    @icons ||= SVG.new(options)
+
+    if rails? && ::Rails.env != 'production' && @icons.modified?
+      @icons.read_icons
+    end
+
+    @icons
+  end
+
+  def embed_svgs
+    icons.html.html_safe
+  end
+
+  def svg_icon(name, options={})
+    name = icons.icon_name(name)
+    %Q{<svg class="icon #{name} #{options[:class] || ""}"><use xlink:href="##{name}"/>#{title(options)}#{desc(options)}</svg>}.html_safe
+  end
+
+  def rails?
+    defined?(Rails)
+  end
+
+  private
+
+  def title(options)
+    if options[:title]
+      "<title>#{options[:title]}</title>"
+    end
+  end
+
+  def desc(options)
+    if options[:desc]
+      "<desc>#{options[:desc]}</desc>"
+    end
+  end
+end

data/lib/esvg/helpers.rb

@@ -0,0 +1,9 @@
+module Esvg::Helpers
+  def embed_svgs
+    Esvg.embed_svgs
+  end
+
+  def svg_icon(name, options={})
+    Esvg.svg_icon(name, options)
+  end
+end

data/lib/esvg/railties.rb

@@ -0,0 +1,9 @@
+module Esvg
+  class Railtie < ::Rails::Railtie
+    initializer "my_gem.configure_view_controller" do |app|
+      ActiveSupport.on_load :action_view do
+        include Esvg::Helpers
+      end
+    end
+  end
+end

data/lib/esvg/svg.rb

@@ -0,0 +1,168 @@
+module Esvg
+  class SVG
+
+    attr_accessor :files
+
+    CONFIG = {
+      path: Dir.pwd,
+      namespace: 'icon',
+      namespace_after: true,
+      font_size: '1em',
+      stylesheet_embed: false,
+      output_path: Dir.pwd
+    }
+
+    CONFIG_RAILS = {
+      path: "app/assets/svg_icons",
+      css_path: "app/assets/stylesheets/_svg_icons.scss",
+      html_path: "app/views/shared/_svg_icons.html"
+    }
+
+    def initialize(options={})
+      config(options)
+
+      @mtime = File.mtime(config[:path])
+      read_icons
+    end
+
+    def modified?
+      @mtime != File.mtime(config[:path])
+    end
+
+    def read_icons
+      @files = {}
+
+      find_files.each do |f|
+        svg = File.read(f)
+        @files[File.basename(f, ".*")] = SvgOptimizer.optimize(svg)
+      end
+    end
+
+    def write_stylesheet
+      unless @files.empty?
+        FileUtils.mkdir_p(File.expand_path(File.dirname(config[:css_path])))
+
+        File.open(config[:css_path], 'w') do |io|
+          io.write(stylesheet)
+        end
+      end
+    end
+    
+    def write_html
+      unless @files.empty?
+        FileUtils.mkdir_p(File.expand_path(File.dirname(config[:html_path])))
+
+        File.open(config[:html_path], 'w') do |io|
+          io.write(html)
+        end
+      end
+    end 
+
+    def stylesheet
+      styles = []
+      preamble = %Q{%svg-icon { 
+    clip: auto;
+    font-size: #{config[:font_size]};
+    background: {
+      size: auto 1em;
+      repeat: no-repeat;
+      position: center center;
+    }
+    display: inline-block;
+    overflow: hidden;
+    height: 1em;
+    width: 1em;
+    color: transparent;
+    vertical-align: middle;
+  }}
+      styles << preamble
+
+      files.each do |name, contents|
+        f = contents.gsub(/</, '%3C') # escape <
+                    .gsub(/>/, '%3E') # escape >
+                    .gsub(/#/, '%23') # escape #
+                    .gsub(/\n/,'')    # remove newlines
+        styles << ".#{icon_name(name)} { background-image: url('data:image/svg+xml;utf-8,#{f}'); @extend %svg-icon; }"
+      end
+      styles.join("\n")
+    end
+
+    def html
+      if @files.empty?
+        ''
+      else
+        svg = []
+        svg << %Q{<svg class="icon-symbols" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none">}
+        files.each do |name, contents|
+          svg << contents.gsub(/<svg.+?>/, %Q{<symbol id="#{icon_name(name)}" #{dimensions(contents)}>})  # convert svg to symbols
+                         .gsub(/<\/svg/, '</symbol')     # convert svg to symbols
+                         .gsub(/style=['"].+?['"]/, '')  # remove inline styles
+                         .gsub(/\n/, '')                 # remove endlines
+                         .gsub(/\s{2,}/, ' ')            # remove whitespace
+                         .gsub(/>\s+</, '><')            # remove whitespace between tags
+        end
+        svg << %Q{</svg>}
+        svg.join("\n")
+      end
+    end
+
+    def config(options={})
+      @config ||= begin
+        paths = [options[:config_file], 'config/esvg.yml', 'esvg.yml'].compact
+
+        config = if path = paths.select{ |p| File.exist?(p)}.first
+          CONFIG.merge(symbolize_keys(YAML.load(File.read(path) || {}))).merge(options)
+        else
+          CONFIG.merge(options)
+        end
+
+        config.merge!(CONFIG_RAILS) if Esvg.rails?
+        config.merge(options)
+
+        config[:css_path]  ||= File.join(config[:output_path], 'esvg.scss')
+        config[:html_path] ||= File.join(config[:output_path], 'esvg.html')
+        config.delete(:output_path)
+
+        config
+      end
+    end
+
+    def symbolize_keys(hash)
+      h = {}
+      hash.each {|k,v| h[k.to_sym] = v }
+      h
+    end
+
+    def dimensions(input)
+      dimensions = [] 
+      %w(viewBox).map do |dimension|
+          dimensions << input.scan(/<svg.+(#{dimension}=["'].+?["'])/).flatten.first
+      end
+      dimensions.compact.join(' ')
+    end
+
+    def icon_name(name)
+      if @files[name].nil?
+        raise "No icon named #{name} exists at #{config[:path]}"
+      end
+
+      name = dasherize(name)
+      if config[:namespace_after]
+        "#{name}-#{config[:namespace]}"
+      else
+        "#{config[:namespace]}-#{name}"
+      end
+    end
+
+    def dasherize(input)
+      input.gsub(/\W/, '-').gsub(/-{2,}/, '-')
+    end
+
+    def find_files
+      path = File.join(config[:path], '*.svg')
+
+      Dir[path].uniq
+    end
+
+  end
+end

data/lib/esvg/version.rb

@@ -0,0 +1,3 @@
+module Esvg
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: esvg
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: svg_optimizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !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: pry-byebug
+  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: 
+email:
+- brandon@imathis.com
+executables:
+- esvg
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- esvg.gemspec
+- exe/esvg
+- lib/esvg.rb
+- lib/esvg/helpers.rb
+- lib/esvg/railties.rb
+- lib/esvg/svg.rb
+- lib/esvg/version.rb
+homepage: https://github.com/imathis/esvg
+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.7
+signing_key: 
+specification_version: 4
+summary: Embed svgs in HTML or CSS
+test_files: []