hieroglyph 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Doug Avery
+
+MIT License
+
+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,54 @@
+# Hieroglyph
+
+Convert a folder full of icons into an SVG icon font, ready for use on the web. 
+To produce the remaining web filetypes (eot, ttf, woff) run the gem through [Fontsquirrel generator](http://www.fontsquirrel.com/fontface/generator).
+If rmagick is installed (optional), hieroglyph will also create a neat little character sheet.
+
+## Installation
+
+	gem install hieroglyph
+
+## Usage
+
+Create a directory full of SVG glyphs, and run:
+
+	hieroglyph -n FontName -g path/to/glyphs -o destination/path
+
+Arguments:
+
+	-n, --name NAME               name of the font you want generated (defaults to MyFont)
+	-o, --output OUTPUT_FOLDER    where to output the generated font (defaults to current folder)
+	-g, --glyphs GLYPH_FOLDER     where to find glyphs to generate from (defaults to "glyphs")
+	-e, --example                 output set of example glyphs
+	-v, --version                 display Hieroglyph version
+	-h, --help                    display this info
+
+Using the -e or -v arguments will NOT output a font.
+
+## Making Glyphs
+
+- In a vector editor (Illustrator, Inkscape), create a 1000pt x 1000pt canvas
+- Draw your icon as a single compound path
+- Center it horizontally
+- Vertically, fit it between ~y288 and ~y1025
+	- Tip: Use Illustrator's Transform palette to set the icon to 737pt high, with a y of 656 and x of 500
+- Save it as a-[iconname].svg in your glyphs folder, 'a' being the letter you want to map the glyph to. [iconname] can be anything, it's just to help you remember which icon you used.
+
+## Known Issues
+
+- If ImageMagick is installed without Ghostscript fonts, the character sheet process will throw an error. The font is still generated correctly, though.
+
+## Thanks
+
+- [Chris Coyier](http://chriscoyier.net/), for brining attention to the [icon fonts.](http://css-tricks.com/using-fonts-for-icons/)
+- [Stephen Wyatt Bush](http://stephenwyattbush.com/), for his in-depth [tutorial.](http://blog.stephenwyattbush.com/2012/02/01/making-an-icon-font)
+- [Jeremy Holland](http://www.jeremypholland.com/), for the [Savage SVG parsing gem.](https://github.com/awebneck/savage)
+- [Inkscape contributors](https://launchpad.net/inkscape/+topcontributors), who provided the original SVG font tool I used a lot on this project.
+
+## Todo
+
+- Clean up Glyph class. It's crazy!
+- Parse from EPS _or_ SVG. Not sure if this is doable with available open-source technology.
+- Use private use unicode symbols, for accessibility reasons:
+	- http://twitter.com/#!/danscotton/statuses/180321697449263106
+	- http://en.wikipedia.org/wiki/Private_Use_(Unicode)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/hieroglyph

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby
+
+require "#{File.dirname(__FILE__)}/../lib/hieroglyph/command_line.rb"
+
+Hieroglyph::CommandLine.new

data/hieroglyph.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hieroglyph/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Doug Avery"]
+  gem.email         = ["dougunderscorenelson@gmail.com"]
+  gem.description   = "Generate a web-ready SVG font from a directory of SVG icons"
+  gem.summary       = "Icon font creator"
+  gem.homepage      = "http://github.com/averyvery/hieroglyph"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hieroglyph"
+  gem.require_paths = ["lib"]
+  gem.version       = Hieroglyph::VERSION
+	gem.add_dependency("nokogiri", ">= 0")
+  gem.add_dependency("savage", ">= 0")
+end

data/lib/hieroglyph/assets/footer

@@ -0,0 +1,3 @@
+<glyph unicode="&#xe000;" horiz-adv-x="500" d="M0 0v0v0v0v0z" />
+</font>
+</defs></svg> 

data/lib/hieroglyph/assets/glyphs/C-checkcircle.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="1000px" height="1000px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
+<path fill="#0B0B0B" d="M499.969,287.5c-203.459,0-368.516,164.966-368.516,368.516c0,203.58,164.994,368.484,368.516,368.484
+	c203.584,0,368.578-164.967,368.578-368.484C868.547,452.521,703.553,287.5,499.969,287.5z M442.059,872.52L255.41,680.097
+	l85.249-85.253c0,0,73.045,73.494,101.938,104.123c39.248-39.271,197.062-197.361,216.028-216.293
+	c25.124,25.034,86.683,86.596,86.683,86.596L442.059,872.52z"/>
+</svg>

data/lib/hieroglyph/assets/glyphs/a-star.svg

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="1000px" height="1000px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
+<path fill="#050606" d="M859.99,566.467c-7.105-8.475-14.604-11.277-20.729-13.07c-6.258-1.662-11.994-2.117-17.959-2.117
+	l-206.608-0.131c-1.923,0.131-6.355-1.174-10.038-4.041c-3.781-2.805-6.16-6.682-6.584-8.541l-59.842-215.115
+	c-1.988-6.779-4.173-12.906-8.671-19.557c-4.105-5.996-13.135-16.003-29.562-16.395c-16.329,0.326-25.455,10.332-29.562,16.395
+	c-4.498,6.715-6.714,12.843-8.604,19.621L401.99,538.502c-0.393,1.891-2.869,5.801-6.617,8.539
+	c-3.65,2.869-8.083,4.172-10.006,4.105l-206.642,0.066c-7.953,0.129-15.386,0.65-24.381,4.465
+	c-4.433,1.988-9.646,5.051-14.242,10.725c-4.661,5.475-7.855,14.016-7.726,21.674c0.261,12.256,5.41,19.719,9.647,24.902
+	c4.498,5.246,9.19,8.963,14.472,12.449l166.519,109.74c2.968,1.271,8.183,10.496,7.726,16.689c0,1.531-0.195,2.77-0.456,3.717
+	l-64.73,212.117c-1.792,6.127-3.16,12.059-3.227,19.295c0.098,6.061,0.814,13.947,6.941,22.814
+	c5.933,9.125,19.101,14.828,28.097,14.275c17.014-0.912,24.119-7.627,32.527-14.016l162.805-138.619
+	c1.336-1.238,4.726-2.674,8.538-2.674c3.685,0,6.91,1.305,8.246,2.479l171.604,139.76c8.507,6.16,15.481,12.549,32.104,13.461
+	c0.393,0,0.815,0.033,1.206,0.033c8.572,0,20.566-5.184,26.435-13.854c6.258-8.801,7.04-16.816,7.104-22.75
+	c-0.064-7.789-1.598-14.016-3.781-20.631l-72.748-213.455c-0.325-0.912-0.555-2.215-0.555-3.846
+	c-0.424-5.736,4.303-13.949,7.008-15.123L843.53,625.49c5.28-3.488,10.007-7.236,14.505-12.482c4.172-5.217,9.354-12.646,9.583-24.9
+	C867.812,580.48,864.618,571.941,859.99,566.467z"/>
+</svg>

data/lib/hieroglyph/assets/glyphs/c-check.svg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="1000px" height="1000px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
+<path fill="#0B0B0B" d="M442.597,698.967c-28.893-30.629-101.938-104.123-101.938-104.123l-85.249,85.253L442.059,872.52
+	l303.249-303.25c0,0-61.559-61.562-86.683-86.596C639.658,501.605,481.845,659.696,442.597,698.967z"/>
+</svg>

data/lib/hieroglyph/assets/glyphs/d-downcaret.svg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="1000px" height="1000px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
+<polygon fill="#151514" points="745.365,410.643 499.029,656.965 252.729,410.643 131.5,531.97 377.77,778.218 377.759,778.229 
+	500.882,901.357 868.5,533.771 "/>
+</svg>

data/lib/hieroglyph/assets/header

@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
+<svg xmlns="http://www.w3.org/2000/svg">
+<defs>
+<font id="{{NAME}}" horiz-adv-x="1024" >
+<font-face units-per-em="1024" ascent="819" descent="-205" />
+<missing-glyph horiz-adv-x="500" />
+<glyph d="M0 0h1000v1024h-1000v-1024z" />
+<glyph d="M0 0h1000v1024h-1000v-1024z" />

data/lib/hieroglyph/character_sheet.rb

@@ -0,0 +1,46 @@
+module Hieroglyph
+
+  class CharacterSheet
+
+    def initialize(options)
+      if Hieroglyph.rmagick_installed?
+        require 'rmagick'
+        @options = options
+        @output_path = File.join(@options[:output_folder], @options[:name]) + "_characters.png"
+        if File.exist? @output_path
+          Hieroglyph.log "  #{@output_path} exists, deleting"
+          File.delete @output_path
+        end
+        @characters = Magick::ImageList.new
+      else
+        Hieroglyph.log "  ImageMagick not installed, skipping character sheet"
+      end
+    end
+
+    def add(file, name)
+      if Hieroglyph.rmagick_installed?
+        character = Magick::Image::read(file).first
+        character['Label'] = name
+        @characters.push character
+      end
+    end 
+
+    def save
+      if Hieroglyph.rmagick_installed?
+        name = @options[:name]
+        img = @characters.montage do
+          self.background_color = "#ffffff"
+          self.border_width = 20
+          self.border_color = "#ffffff"
+          self.fill = "#000000"
+          self.geometry = "150x150+10+5"
+          self.matte_color = "#ffffff"
+          self.title = name
+        end
+        img.write(@output_path)
+      end
+    end
+
+  end
+
+end

data/lib/hieroglyph/command_line.rb

@@ -0,0 +1,60 @@
+require "optparse"
+require File.expand_path(File.dirname(__FILE__) + '/../hieroglyph')
+
+module Hieroglyph
+
+  class CommandLine
+
+    BANNER = <<-EOS
+
+Usage: hieroglyph OPTIONS
+
+Run hieroglyph to generate an SVG font from a folder of SVG glyphs.
+
+Options:
+    EOS
+
+    def initialize
+      @execute = true
+      parse_options
+      if @execute
+        Hieroglyph.make @options
+        Hieroglyph.log "", "  Saved to #{@options[:output_folder]}", "", "=== #{@options[:name]} generated ===", ""
+        Hieroglyph.log "To create a full set of webfonts, upload to:", "http://www.fontsquirrel.com/fontface/generator", ""
+      end
+    end
+
+    def parse_options
+      @options = {
+        :name => "MyFont",
+        :output_folder => "./",
+        :glyph_folder => "glyphs"
+      }
+      @option_parser = OptionParser.new do |opts|
+        opts.on("-n", "--name NAME", "name of the font you want generated") do |name|
+          @options[:name] = name
+        end
+        opts.on("-o", "--output OUTPUT_FOLDER", "where to output the generated font") do |output_folder|
+          @options[:output_folder] = output_folder
+        end
+        opts.on("-g", "--glyphs GLYPH_FOLDER", "where to find glyphs to generate from") do |glyph_folder|
+          @options[:glyph_folder] = glyph_folder
+        end
+        opts.on("-e", "--example", "output set of example glyphs") do |output_folder|
+          @execute = false
+          Hieroglyph.log "Example glyphs saved to #{Dir.pwd}/glyphs"
+          glyphs_path = File.join(File.dirname(__FILE__), "assets/glyphs")
+          exec "cp -r #{glyphs_path} ./"
+        end
+        opts.on_tail('-v', '--version', 'display Hieroglyph version') do
+          @execute = false
+          Hieroglyph.log "Hieroglyph version #{Hieroglyph::VERSION}"
+        end
+      end
+      @option_parser.banner = BANNER
+      @option_parser.parse!(ARGV)
+    end
+
+  end
+
+end

data/lib/hieroglyph/font.rb

@@ -0,0 +1,60 @@
+module Hieroglyph
+
+  class Font
+
+    def initialize(options)
+      @options = options
+      @output_path = File.join(@options[:output_folder], @options[:name] + ".svg")
+      @contents = ""
+      setup
+      add_glyphs
+      finish
+    end
+
+    def add_header
+      header_path = File.join(File.dirname(__FILE__), "assets/header")
+      header = File.open(header_path).read
+      header.gsub!("{{NAME}}", @options[:name])
+      add header
+    end 
+
+    def add_footer
+      footer_path = File.join(File.dirname(__FILE__), "assets/footer")
+      footer = File.open(footer_path).read
+      add footer
+    end
+
+    def setup 
+      Hieroglyph.log "", "=== Generating #{@options[:name]} ===", ""
+      if File.exist? @output_path
+        Hieroglyph.log "  #{@output_path} exists, deleting"
+        File.delete @output_path
+      end
+      @character_sheet = CharacterSheet.new(@options)
+      add_header
+    end
+
+    def finish
+      add_footer
+      File.open(@output_path, "w") do |file|
+        file.puts @contents
+        file.close
+      end
+      @character_sheet.save
+    end
+
+    def add(str)
+      @contents << str
+    end
+
+    def add_glyphs
+      Hieroglyph.log "", "  Reading from #{@options[:glyph_folder]}...", ""
+      Dir.glob(File.join(@options[:glyph_folder], "*.svg")).each do |file|
+        glyph = Glyph.new(file, @options[:glyph_folder])
+        @character_sheet.add(file, glyph.name)
+        add glyph.to_node
+      end
+    end
+  end
+
+end

data/lib/hieroglyph/glyph.rb

@@ -0,0 +1,90 @@
+require "nokogiri"
+require "savage"
+
+module Hieroglyph
+
+  class Glyph
+
+    attr_accessor :name
+
+    def initialize(file, source)
+      @name = file.gsub(source, "").gsub("/", "").each_char.first
+      Hieroglyph.log "    #{@name} -> reading..."
+      @contents = Nokogiri::XML(File.new(file))
+      @polygon = @contents.root.at_css("polygon")
+      @path = @polygon.nil? ? convert_path: convert_polygon
+      flip_paths
+    end
+
+    def flip_paths
+      @path.subpaths.each do |subpath|
+        subpath.directions.each do |direction|
+          case direction
+          when Savage::Directions::MoveTo
+            if(direction.absolute?)
+              direction.target.y = flip_y(direction.target.y)
+            else
+              direction.target.y = -1 * direction.target.y
+            end
+          when Savage::Directions::VerticalTo
+            if(direction.absolute?)
+              direction.target = flip_y(direction.target)
+            else
+              direction.target = -1 * direction.target
+            end
+          when Savage::Directions::LineTo
+            if(direction.absolute?)
+              direction.target.y = flip_y(direction.target.y)
+            else
+              direction.target.y = -1 * direction.target.y
+            end
+          when Savage::Directions::CubicCurveTo
+            if(direction.absolute?)
+              direction.control.y = flip_y(direction.control.y)
+              direction.target.y = flip_y(direction.target.y)
+              if(defined?(direction.control_1) && defined?(direction.control_1.y))
+                direction.control_1.y = flip_y(direction.control_1.y)
+              end
+            else
+              direction.control.y = -1 * direction.control.y
+              direction.target.y = -1 * direction.target.y
+              if(defined?(direction.control_1) && defined?(direction.control_1.y))
+                direction.control_1.y = -1 * direction.control_1.y
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def convert_path
+      @path = @contents.root.at_css("path")["d"] 
+      @path = Savage::Parser.parse @path
+    end
+
+    def convert_polygon
+      Hieroglyph.log "      -> converting polygon to path"
+      points = @polygon["points"].split(" ")
+      Savage::Path.new do |path|
+        start_position = points.shift.split(",")
+        path.move_to(start_position[0], start_position[1])
+        points.each do |point|
+          position = point.split(",")
+          path.line_to(position[0], position[1])
+        end
+        path.close_path
+      end
+    end
+
+    def flip_y(value)
+      value = value.to_f
+      value = (value - 500) * -1 + 500
+    end
+
+    def to_node
+      return "<glyph unicode=\"#{@name}\" d=\"#{@path.to_command}\" />\n"
+    end
+
+  end
+
+end

data/lib/hieroglyph/version.rb

@@ -0,0 +1,3 @@
+module Hieroglyph
+  VERSION = "0.1"
+end

data/lib/hieroglyph.rb

@@ -0,0 +1,25 @@
+require 'hieroglyph/glyph'
+require 'hieroglyph/font'
+require 'hieroglyph/character_sheet'
+
+module Hieroglyph
+
+  VERSION = "0.1"
+
+  def self.log(*args)
+    args.each do |arg|
+      puts arg
+    end
+  end
+
+  def self.make(options)
+    Font.new(options)
+  end
+
+  def self.rmagick_installed?
+    Gem::Specification.find_by_name("rmagick")
+  rescue Gem::LoadError
+    false
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: hieroglyph
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Doug Avery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70103367137480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70103367137480
+- !ruby/object:Gem::Dependency
+  name: savage
+  requirement: &70103367136980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70103367136980
+description: Generate a web-ready SVG font from a directory of SVG icons
+email:
+- dougunderscorenelson@gmail.com
+executables:
+- hieroglyph
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/hieroglyph
+- hieroglyph.gemspec
+- lib/hieroglyph.rb
+- lib/hieroglyph/assets/footer
+- lib/hieroglyph/assets/glyphs/C-checkcircle.svg
+- lib/hieroglyph/assets/glyphs/a-star.svg
+- lib/hieroglyph/assets/glyphs/c-check.svg
+- lib/hieroglyph/assets/glyphs/d-downcaret.svg
+- lib/hieroglyph/assets/header
+- lib/hieroglyph/character_sheet.rb
+- lib/hieroglyph/command_line.rb
+- lib/hieroglyph/font.rb
+- lib/hieroglyph/glyph.rb
+- lib/hieroglyph/version.rb
+homepage: http://github.com/averyvery/hieroglyph
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Icon font creator
+test_files: []