svgeez 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 563813efa4871b6fa125c35a124918baad701d29
+  data.tar.gz: 9841c3d7f577d03364aa7ceac0309b740d278710
+SHA512:
+  metadata.gz: f59c9a8dafdc8eb977f494dd95fd53179bed4e28b0df83272f7853e3f2f8aac7485a6cd6a57dfafa8072478abad0dc26eb8c47acadb7dc39d2942cee94c27dca
+  data.tar.gz: 426edfc2169c9e2566a33affeec95c1bcdb60f02cce1c8420a65cb1d484ffbb2aace021dbab32f7cb8ea499df6c101eb5944ae5a1eba5ec311e52ce78f1bb84a

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.svg]
+insert_final_newline = false

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+ruby '2.2.3'
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in svgeez.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jason Garber
+
+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,167 @@
+# svgeez
+
+**A Ruby gem for automatically generating an SVG sprite from a folder of SVG icons.**
+
+[![Build Status](https://travis-ci.org/jgarber623/svgeez.svg?branch=master)](https://travis-ci.org/jgarber623/svgeez)
+
+If you're using an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icon system in your Web projects, svgeez can help speed up your workflow by automating the SVG sprite generation process. Simply run svgeez alongside your existing project (or integrate it into your current build system); add, edit, or delete SVG files from a directory; and marvel as svgeez generates a single SVG sprite file ready for inclusion in your user interface.
+
+_For more on why SVG sprites are the bee's knees as far as icon systems go, give Chris Coyier's original post, [Icon System with SVG Sprites](https://css-tricks.com/svg-sprites-use-better-icon-fonts/), and his follow-up article, [SVG \`symbol\` a Good Choice for Icons](https://css-tricks.com/svg-symbol-good-choice-icons/) a read-through._
+
+## Key Features
+
+- Provides a simple [CLI](https://en.wikipedia.org/wiki/Command-line_interface) for generating SVG sprite files.
+- Easily integrates with existing projects (e.g. alongside a Rails application using [Foreman](https://github.com/ddollar/foreman)).
+- Optionally optimizes SVG files with [SVGO](https://github.com/svg/svgo/).
+
+## Getting Started
+
+Before installing and using svgeez, you'll want to have Ruby 2.2.3 installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). If you're developing on a Mac and using [Homebrew](http://brew.sh/), installing rbenv is [super easy](https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x).
+
+svgeez _might_ work with other versions of Ruby, but it's tested against 2.2.3.
+
+## Installation
+
+If you're using Bundler, add svgeez to your project's Gemfile:
+
+```rb
+ruby '2.2.3'
+
+source 'https://rubygems.org' do
+  gem 'svgeez'
+end
+```
+
+…and hop over to your command prompt and run…
+
+`$ bundle`
+
+You may also install svgeez directly by issuing the following command:
+
+`$ gem install svgeez`
+
+## Usage
+
+svgeez is a command line program with several useful subcommands. From the root of your project, run `svgeez -h` for a complete list of commands.
+
+### The `build` command
+
+You can manually generate an SVG sprite from a folder of SVGs with the `build` command which takes two options, a path to your folder of individual SVGs and a path to the desired output folder. _These paths must be different!_
+
+A basic example:
+
+```sh
+$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images
+```
+
+The above example will combine all SVG files in `~/Sites/sixtwothree.org/images/icons` into a single SVG sprite in `~/Sites/sixtwothree.org/images`. The resulting sprite file will be named `icons.svg` (this file name is derived from the name of the provided source folder).
+
+### The `watch` command
+
+The `watch` command takes the same arguments as the `build` command but uses the [Listen gem](https://github.com/guard/listen) to observe changes in the source folder.
+
+Tweaking the example from above:
+
+```sh
+$ svgeez watch --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images
+```
+
+svgeez will remaing running, watching for new, removed, or updated SVG files in the provided source folder. As SVG files are added, deleted, or modified in the source folder, svgeez will keep pumping out updated SVG sprite files to the destination folder.
+
+### Optimizing generated files with SVGO
+
+If you have the excellent [SVGO](https://github.com/svg/svgo/) utility installed on your system (and the `svgo` command is available in your PATH), you can use the `--with-svgo` option and optimize source SVGs before generating the sprite file.
+
+```sh
+$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images --with-svgo
+```
+
+Optimizing source SVG files with SVGO is done on-the-fly and the original files are left intact. Depending on the number of individual SVG files in the source directory, using the `--with-svgo` option can add considerable time to SVG sprite generation.
+
+## Working with SVG sprites
+
+Within generated SVG sprite files, each icon is wrapped in a `<symbol>` element and assigned an `id` attribute with a value combining the SVG sprite's file name and the original, individual icon's file name.
+
+For example, a file named `menu.svg` in `~/Sites/sixtwothree.org/images/icons` will be assigned an `id` value of `icons-menu`.
+
+```svg
+<symbol  fill="currentcolor" id="icons-menu" viewBox="0 0 32 32">
+    <path d="…"/>
+</symbol>
+```
+
+### Markup
+
+To use an svgeez-generated SVG sprite file, first include the file's contents at the top of your HTML page, just after open `<body>` element.
+
+In a Rails 4 application:
+
+```erb
+<body>
+    <%= raw assets.find_asset('icons.svg') %>
+</body>
+```
+
+Or, with PHP:
+
+```php
+<body>
+    <?php include_once('path/to/icons.svg'); ?>
+</body>
+```
+
+Next, wherever you want to include an icon in your user interface, use HTML similar to the following, replacing the identifier `#icons-menu` with a value corresponding to the ID of the `<symbol>` in the relevant SVG sprite file:
+
+```html
+<svg><use xlink:href="#icons-menu"></svg>
+```
+
+A more complete example from a Rails 4 application's layout file:
+
+```erb
+<body>
+    <%= raw assets.find_asset('icons.svg') %>
+
+    <button>
+        <svg><use xlink:href="#icons-menu"></svg>
+        Menu
+    </button>
+</body>
+```
+
+In this example, the contents of the svgeez-generated SVG sprite file is included on every page and isn't terribly cacheable. How onerous this is depends on the size of your icon system.
+
+For smaller icon sets, this may be an acceptable balance of user and developer needs. For larger icon sets, you may want to investigate more advanced techniques for loading and caching an SVG sprite file (perhaps with [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Storage/LocalStorage)…?)
+
+### Styling embedded icons
+
+Icons embedded with the inline `<use>` technique will inherit their fill color from the nearest parent's `color` value (thanks to each `<symbol>`'s `fill="currentcolor"` attribute), but this can be overriden with CSS:
+
+```css
+button {
+    color: #333;
+}
+
+button svg {
+    fill: #c00; // Absent this declaration, the icon's fill color would be #333
+}
+```
+
+## Acknowledgements
+
+svgeez benefited greatly from the hard work done by the folks working on the following projects:
+
+- [Jekyll](https://github.com/jekyll/jekyll)
+- [jekyll-watch](https://github.com/jekyll/jekyll-watch)
+- [Mercenary](https://github.com/jekyll/mercenary)
+- [Listen](https://github.com/guard/listen)
+
+Additionally, Chris Coyier's [CSS Tricks](https://css-tricks.com/) posts linked above got me interested in SVG sprites.
+
+Lastly, the sample icons in `spec/fixtures/icons` are from [@jxnblk](https://github.com/jxnblk)'s [Geomicons Open](https://github.com/jxnblk/geomicons-open) icon set.
+
+svgeez is written and maintained by [@jgarber623](https://github.com/jgarber623).
+
+## License
+
+svgeez is freely available under the [MIT License](http://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.

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/svgeez

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+
+require 'svgeez'
+require 'mercenary'
+
+Mercenary.program(:svgeez) do |p|
+  p.version Svgeez::VERSION
+  p.description 'Generate an SVG sprite from a folder of SVG icons.'
+  p.syntax 'svgeez <subcommand> [options]'
+
+  Svgeez::Command.subclasses.each { |c| c.init_with_program(p) }
+
+  p.action do |args, options|
+    if args.empty?
+      puts p
+      abort
+    end
+  end
+end

data/lib/svgeez/command.rb

@@ -0,0 +1,20 @@
+module Svgeez
+  class Command
+    class << self
+      def subclasses
+        @subclasses ||= []
+      end
+
+      def inherited(base)
+        subclasses << base
+        super(base)
+      end
+
+      def add_build_options(c)
+        c.option 'source', '-s', '--source [DIR]', 'Source directory (defaults to ./)'
+        c.option 'destination', '-d', '--destination [DIR]', 'Destination directory (defaults to ./_svgeez)'
+        c.option 'svgo', '--with-svgo', 'Optimize source SVGs with SVGO before sprite generation (non-destructive)'
+      end
+    end
+  end
+end

data/lib/svgeez/commands/build.rb

@@ -0,0 +1,22 @@
+module Svgeez
+  module Commands
+    class Build < Command
+      def self.init_with_program(p)
+        p.command(:build) do |c|
+          c.description 'Builds an SVG sprite from a folder of SVG icons'
+          c.syntax 'build [options]'
+
+          add_build_options(c)
+
+          c.action do |_, options|
+            Svgeez::Commands::Build.process(options)
+          end
+        end
+      end
+
+      def self.process(options)
+        Svgeez::SpriteBuilder.new(options).build
+      end
+    end
+  end
+end

data/lib/svgeez/commands/watch.rb

@@ -0,0 +1,33 @@
+module Svgeez
+  module Commands
+    class Watch < Command
+      class << self
+        def init_with_program(p)
+          p.command(:watch) do |c|
+            c.description 'Watches a folder of SVG icons for changes'
+            c.syntax 'watch [options]'
+
+            add_build_options(c)
+
+            c.action do |_, options|
+              Svgeez::Commands::Build.process(options)
+              Svgeez::Commands::Watch.process(options)
+            end
+          end
+        end
+
+        def process(options)
+          Svgeez.logger.info %{Watching `#{File.expand_path(options['source'])}` for changes... Press ctrl-c to stop.}
+
+          listener = Listen.to(options['source'], only: /\.svg$/) do |modified, added, removed|
+            Svgeez::Commands::Build.process(options)
+          end
+
+          listener.start
+          sleep
+        rescue Interrupt => e
+        end
+      end
+    end
+  end
+end

data/lib/svgeez/sprite_builder.rb

@@ -0,0 +1,76 @@
+module Svgeez
+  class SpriteBuilder
+    def initialize(options)
+      @source = File.expand_path(options.fetch('source', './'))
+      @destination = File.expand_path(options.fetch('destination', './_svgeez'))
+      @with_svgo = options['svgo']
+    end
+
+    def build
+      unless source_is_destination?
+        if input_file_paths.any?
+          Svgeez.logger.info %{Generating sprite at `#{output_file_path}` from #{input_file_paths.length} SVG#{'s' if input_file_paths.length > 1}...}
+
+          # Make destination directory
+          FileUtils.mkdir_p(@destination)
+
+          # Notify if SVGO requested but not found
+          if @with_svgo && !svgo_installed?
+            Svgeez.logger.warn %{Unable to find `svgo` in your PATH. Continuing with standard sprite generation...}
+          end
+
+          # Write the file
+          File.open(output_file_path, 'w') do |f|
+            f.write build_output_file_contents
+          end
+
+          Svgeez.logger.info %{Successfully generated sprite at `#{output_file_path}`.}
+        else
+          Svgeez.logger.warn %{No SVGs were found in `#{@source}`.}
+        end
+      else
+        Svgeez.logger.error %{Setting `source` and `destination` to the same path isn't allowed!}
+      end
+    end
+
+    def build_output_file_contents
+      '<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">'.tap do |output_file_contents|
+        # Loop over all input files, grabbing their content, and appending to `output_file_contents`
+        input_file_paths.each do |file_path|
+          file_contents = use_svgo? ? `svgo -i #{file_path} -o -` : IO.read(file_path)
+          pattern = /^<svg.*?(?<viewbox>viewBox=".*?").*?>(?<content>.*?)<\/svg>$/m
+
+          file_contents.match(pattern) do |matches|
+            output_file_contents << %{<symbol fill="currentcolor" id="#{source_basename}-#{File.basename(file_path, '.svg').downcase}" #{matches[:viewbox]}>#{matches[:content]}</symbol>}
+          end
+        end
+
+        output_file_contents << '</svg>'
+      end
+    end
+
+    def input_file_paths
+      Dir.glob(File.join(@source, '*.svg'))
+    end
+
+    def output_file_path
+      File.join(@destination, %{#{source_basename}.svg})
+    end
+
+    def source_basename
+      @source_basename ||= File.basename(@source)
+    end
+
+    def source_is_destination?
+      @source == @destination
+    end
+
+    def svgo_installed?
+      @svgo_installed ||= find_executable0('svgo')
+    end
+
+    def use_svgo?
+      @use_svgo ||= @with_svgo && svgo_installed?
+    end
+  end
+end

data/lib/svgeez/version.rb

@@ -0,0 +1,3 @@
+module Svgeez
+  VERSION = '0.1.0'
+end

data/lib/svgeez.rb

@@ -0,0 +1,22 @@
+require 'fileutils'
+require 'listen'
+require 'logger'
+require 'mkmf'
+
+require 'svgeez/version'
+require 'svgeez/command'
+require 'svgeez/commands/build'
+require 'svgeez/commands/watch'
+require 'svgeez/sprite_builder'
+
+module Svgeez
+  class << self
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+
+  self.logger.formatter = proc do |severity, datetime, progname, msg|
+    %{#{msg}\n}
+  end
+end

data/svgeez.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svgeez/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'svgeez'
+  spec.version       = Svgeez::VERSION
+  spec.authors       = ['Jason Garber']
+  spec.email         = ['jason@sixtwothree.org']
+
+  spec.summary       = %{Automatically generate an SVG sprite from a folder of SVG icons.}
+  spec.description   = %{Automatically generate an SVG sprite from a folder of SVG icons.}
+  spec.homepage      = 'https://github.com/jgarber623/svgeez'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'listen', '~> 3.0'
+  spec.add_runtime_dependency 'mercenary', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: svgeez
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Garber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !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'
+description: Automatically generate an SVG sprite from a folder of SVG icons.
+email:
+- jason@sixtwothree.org
+executables:
+- svgeez
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/svgeez
+- lib/svgeez.rb
+- lib/svgeez/command.rb
+- lib/svgeez/commands/build.rb
+- lib/svgeez/commands/watch.rb
+- lib/svgeez/sprite_builder.rb
+- lib/svgeez/version.rb
+- svgeez.gemspec
+homepage: https://github.com/jgarber623/svgeez
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Automatically generate an SVG sprite from a folder of SVG icons.
+test_files: []