fontrobot 0.1

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## 0.1.4 (2/19/2013)
+
+* Instructions for stopping watcher ([#46](https://github.com/FontCustom/fontcustom/issues/46))
+* Dev/contribution instructions ([#45](https://github.com/FontCustom/fontcustom/issues/45))
+
+## 0.1.3 (2/2/2013)
+
+* Add --debug CLI option, which shows fontforge output ([#37](https://github.com/FontCustom/fontcustom/issues/37))
+* Patch for Illustrator CS6 SVG output ([#42](https://github.com/FontCustom/fontcustom/pull/42))
+* Generate IE7 stylesheet ([#43](https://github.com/FontCustom/fontcustom/pull/43))
+* Option to set custom font path for @font-face ([#43](https://github.com/FontCustom/fontcustom/pull/43))
+* Option to generate test HTML file showing all glyphs ([#43](https://github.com/FontCustom/fontcustom/pull/43))
+* Use eotlite.py instead of mkeot ([#43](https://github.com/FontCustom/fontcustom/pull/43))
+
+## 0.1.0 (12/2/2012)
+
+* Changed API to use Thor `class_option`s
+* Added option to change the name of the font and generated files ([#6](https://github.com/FontCustom/fontcustom/issues/6))
+* Added option to disable the file name hash ([#13](https://github.com/FontCustom/fontcustom/issues/13))
+* `fontcustom watch` compiles automatically on the first run
+* Better help messages
+
+## 0.0.2 (11/26/2012)
+
+* Fixed gemspec dependency bug ([#2](https://github.com/FontCustom/fontcustom/pull/2))
+* Fixed Windows Chrome PUA bug ([#1](https://github.com/FontCustom/fontcustom/issues/1))

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Fontrobot Contributing Checklist
+
+## A short list to help you get started:
+
+* Check out [issues]() for ideas. Is someone else working on something similar?
+* Fork the repo and work out of a named topic branch, a la `git checkout -b my_sweet_contribution`. Please don't work directly off `master`.
+* Run tests with `guard`.
+* Add/improve tests for your contributions.
+* Submit a pull request!

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'spork' do
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard 'rspec', :cli => '--color --drb' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/fontrobot/(.+)\.rb$})    { |m| "spec/fontrobot/#{m[1]}_spec.rb" }
+  watch('lib/fontrobot.rb')              { 'spec/fontrobot/fontrobot_spec.rb' }
+  watch('lib/fontrobot/core.rb')         { 'spec/fontrobot/fontrobot_spec.rb' }
+  watch('spec/spec_helper.rb')            { 'spec' }
+end

data/LICENSES.txt

@@ -0,0 +1,60 @@
+fontrobot
+
+    Copyright (c) 2013 Tim Barkow
+
+    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.
+
+
+sfnt2woff
+
+    Version: MPL 1.1/GPL 2.0/LGPL 2.1
+
+    The contents of this file are subject to the Mozilla Public License Version
+    1.1 (the "License"); you may not use this file except in compliance with
+    the License. You may obtain a copy of the License at
+    http://www.mozilla.org/MPL/
+
+    Software distributed under the License is distributed on an "AS IS" basis,
+    WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+    for the specific language governing rights and limitations under the
+    License.
+
+    The Original Code is WOFF font packaging code.
+
+    The Initial Developer of the Original Code is Mozilla Corporation.
+    Portions created by the Initial Developer are Copyright (C) 2009
+    the Initial Developer. All Rights Reserved.
+
+    Contributor(s):
+      Jonathan Kew <jfkthame@gmail.com>
+
+    Alternatively, the contents of this file may be used under the terms of
+    either the GNU General Public License Version 2 or later (the "GPL"), or
+    the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+    in which case the provisions of the GPL or the LGPL are applicable instead
+    of those above. If you wish to allow use of your version of this file only
+    under the terms of either the GPL or the LGPL, and not to allow others to
+    use your version of this file under the terms of the MPL, indicate your
+    decision by deleting the provisions above and replace them with the notice
+    and other provisions required by the GPL or the LGPL. If you do not delete
+    the provisions above, a recipient may use your version of this file under
+    the terms of any one of the MPL, the GPL or the LGPL.

data/README.md

@@ -0,0 +1,53 @@
+FontRobot v0.1
+==========
+
+**Generate custom icon webfonts from the comfort of the command line.**
+
+This is a fork of Fontcustom, required so I could make changes and update the gem in a timely fashion. FontRobot extends Fontcustom, adding more control over how the @fontface declaration is created. See command-line options below for more details.
+
+[Fontcustom documentation](http://fontcustom.github.com/fontcustom/)
+
+
+Installation
+------------
+
+```sh
+# Requires FontForge
+brew install fontforge ttfautohint
+gem install fontrobot
+```
+
+
+Usage
+-----
+
+```sh
+fontrobot compile path/to/vectors  # Compile icons and css to path/to/fontrobot/*
+fontrobot watch path/to/vectors    # Watch for changes
+```
+
+**Note:** the **ENTIRE** contents of the output directory (default '/fontrobot') are **DELETED** when regenerating the font. So, don't put anything else in there.
+
+
+Command-line options
+-----
+
+```sh
+--output, -o      => Specify an output directory. Default: $DIR/fontrobot
+--name, -n        => Specify a font name. This will be used in the generated fonts and CSS. Default: fontrobot
+--font_path, -f   => Specify a path for fonts in css @font-face declaration. Default: none
+
+--order, -r       => Specify font order in css @font-face. Default: "eot,ttf,woff,svg"
+--inline, -i      => Include specified font fomats as data-uri in @font-face. Default: none. Format: "eot,ttf,woff,svg"
+
+--nohash          => (boolean) Disable filename hashes. Default: false
+--debug           => (boolean) Display debug messages. Default: false
+--html            => (boolean) Generate html page with icons. Default: false
+--scss            => (boolean) Output .scss files. Default: false
+```
+
+Need help?
+
+```sh
+fontrobot --help
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# require 'rake'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = t.libs + ['lib/fontrobot', 'spec', 'spec/fixtures']
+  t.test_files = FileList['spec/fontrobot/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/bin/fontrobot

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'fontrobot/cli'
+
+Fontrobot::CLI.start

data/fontcustom.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fontrobot/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "fontrobot"
+  gem.version       = Fontrobot::VERSION
+  gem.authors       = ["Tim Barkow"]
+  gem.email         = ["tim@robotloveskitten.com"]
+  gem.summary       = %q{Generate custom icon webfonts from the command line.}
+  gem.description   = %q{Transforms EPS and SVG vectors into icon webfonts. Generates Bootstrap compatible CSS for easy inclusion in your projects.}
+  gem.homepage      = "http://robotloveskitten.github.com/fontrobot/"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'json'
+  gem.add_dependency 'thor'
+  gem.add_dependency 'listen'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'fakefs'
+  gem.add_development_dependency 'spork'
+  gem.add_development_dependency 'guard-spork'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'
+end

data/lib/fontrobot/cli.rb

@@ -0,0 +1,32 @@
+require 'thor'
+require 'fontrobot'
+
+module Fontrobot
+  class CLI < Thor
+    # duplicated from Fontrobot::Generator so as to also appear under `fontrobot help` command
+    class_option :output,     :aliases => '-o', :desc => 'Specify an output directory. Default: $DIR/fontrobot'
+    class_option :name,       :aliases => '-n', :desc => 'Specify a font name. This will be used in the generated fonts and CSS. Default: fontrobot'
+    class_option :font_path,  :aliases => '-f', :desc => 'Specify a path for fonts in css @font-face declaration. Default: none'
+
+    class_option :order,      :aliases => '-r', :desc => 'Specify font order in css @font-face. Default: "eot,ttf,woff,svg"'
+    class_option :inline,     :aliases => '-i', :desc => 'Inline font as data-uri in @font-face. Default: none. Format: "eot,ttf,woff,svg"'
+
+    class_option :nohash,     :type => :boolean, :default => false, :desc => 'Disable filename hashes. Default: false'
+    class_option :debug,      :type => :boolean, :default => false, :desc => 'Display debug messages. Default: false'
+    class_option :html,       :type => :boolean, :default => false, :desc => 'Generate html page with icons'
+    class_option :scss,       :type => :boolean, :default => false, :desc => 'Output .scss files'
+
+    desc 'compile DIR [options]', 'Generates webfonts and CSS from *.svg and *.eps files in DIR.'
+    def compile(*args)
+      # workaround to pass arguments from one Thor class to another
+      ARGV.shift
+      Fontrobot.compile(*ARGV)
+    end
+
+    desc 'watch DIR [options]', 'Watches DIR for changes and regenerates webfonts and CSS automatically. Ctrl + C to stop.'
+    def watch(*args)
+      ARGV.shift
+      Fontrobot.watch(*ARGV)
+    end
+  end
+end

data/lib/fontrobot/generator.rb

@@ -0,0 +1,140 @@
+require 'json'
+require 'thor/group'
+require 'base64'
+
+module Fontrobot
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    desc 'Generates webfonts from given directory of vectors.'
+
+    argument :input, :type => :string
+    class_option :output, :aliases => '-o'
+    class_option :name, :aliases => '-n'
+    class_option :font_path, :aliases => '-f'
+
+    class_option :order,      :aliases => '-r' # 'Specify font order in css @font-face. Default: "eot,ttf,woff,svg"'
+    class_option :inline,     :aliases => '-i' # 'Inline font as data-uri in @font-face. Default: none. Format: "eot,ttf,woff,svg"'
+
+    class_option :nohash,     :type => :boolean, :default => false
+    class_option :debug,      :type => :boolean, :default => false
+    class_option :html,       :type => :boolean, :default => false
+    class_option :scss,       :type => :boolean, :default => false
+
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def verify_fontforge
+      if `which fontforge` == ''
+        raise Thor::Error, 'Please install fontforge first.'
+      end
+    end
+
+    def verify_input_dir
+      if ! File.directory?(input)
+        raise Thor::Error, "#{input} doesn't exist or isn't a directory."
+      elsif Dir[File.join(input, '*.{svg,eps}')].empty?
+        raise Thor::Error, "#{input} doesn't contain any vectors (*.svg or *.eps files)."
+      end
+    end
+
+    def verify_or_create_output_dir
+      @output = options.output.nil? ? File.join(File.dirname(input), 'fontrobot') : options.output
+      empty_directory(@output) unless File.directory?(@output)
+    end
+
+    def normalize_name
+      @name = if options.name
+        options.name.gsub(/\W/, '-').downcase
+      else
+        'fontrobot'
+      end
+    end
+
+    def cleanup_output_dir
+      # simpler: how about we just delete everything in the dir?
+      old_files = Dir[File.join(@output, '*')]
+      old_files.each {|file| remove_file file }
+    end
+
+
+    def generate
+      gem_file_path = File.expand_path(File.join(File.dirname(__FILE__)))
+      name = options.name ? ' --name ' + @name : ''
+      nohash = options.nohash ? ' --nohash' : ''
+
+      # suppress fontforge message
+      # TODO get font name and classes from script (without showing fontforge message)
+      cmd = "fontforge -script #{gem_file_path}/scripts/generate.py #{input} #{@output + name + nohash}"
+      unless options.debug
+        cmd += " > /dev/null 2>&1"
+      end
+      `#{cmd}`
+    end
+
+
+    def show_paths
+      file = Dir[File.join(@output, @name + '*.ttf')].first
+      @path = file.chomp('.ttf')
+
+      ['woff','ttf','eot','svg'].each do |type|
+        say_status(:create, @path + '.' + type)
+      end
+    end
+
+
+    def fontface_sources
+      order = (options.order) ? options.order.split(",") : ['eot','ttf','woff','svg']
+      inline = (options.inline) ? options.inline.split(",") : []
+      reorder = {}
+      longtype = {
+        'woff' => 'woff',
+        'ttf'   => 'truetype',
+        'eot' => 'embedded-opentype',
+        'svg' => 'svg'
+      }
+
+      if(!options.font_path.nil?)
+        font_path = (options.font_path) ? options.font_path : ''
+        @path = File.join(font_path, File.basename(@path))
+      else
+        @path = File.basename(@path)
+      end
+
+      @fontface = {
+        :eot  => "url(\"#{@path}.eot?#iefix\") format(\"embedded-opentype\")",
+        :woff => "url(\"#{@path}.woff\") format(\"woff\")",
+        :ttf  => "url(\"#{@path}.ttf\") format(\"truetype\")",
+        :svg  => "url(\"#{@path}.svg##{@name}\") format(\"svg\")"
+      }
+
+      # reorder the fontface hash
+      order.each do |type|
+        if(inline.include?(type))
+          fontpath = File.expand_path(File.join(@output, File.basename(@path)+"."+type))
+          contents = File.read(fontpath)
+          encoded_contents = Base64.encode64(contents).gsub(/\n/, '') # encode and remove newlines, 1.8.7 compat
+          fontstring = "url(data:application/x-font-#{type};charset=utf-8;base64," + encoded_contents +") format('#{longtype[type]}')"
+        else
+          fontstring = @fontface[type.to_sym]
+        end
+        reorder[type.to_sym] = fontstring
+      end
+      @fonturls = reorder.map{|k,v| v }.join(",\n");
+    end
+
+
+    def create_stylesheet
+      say_status(:create, 'creating stylesheet')
+      extension = (options.scss) ? '.scss' : '.css'
+      files = Dir[File.join(input, '*.{svg,eps}')]
+      @classes = files.map {|file| File.basename(file)[0..-5].gsub(/\W/, '-').downcase }
+
+      template('templates/fontrobot.css', File.join(@output, "fontrobot#{extension}"))
+      template('templates/fontrobot-ie7.css', File.join(@output, "fontrobot-ie7#{extension}"))
+      template('templates/test.html', File.join(@output, 'test.html')) if options.html
+    end
+  end
+end