fontcustom 0.1.4 → 1.0.0.pre

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.0.0-RC1 (4/4/2013)
+
+* Improved preview html to show glyphs at various sizes
+* Added support for fontcustom.yml config file ([#49](https://github.com/FontCustom/fontcustom/issues/49))
+* Added support for .fontcustom-data file ([#55](https://github.com/FontCustom/fontcustom/pull/55))
+* Added support for custom templates ([#39](https://github.com/FontCustom/fontcustom/pull/39), [#48](https://github.com/FontCustom/fontcustom/issues/48))
+* Added support for custom CSS selector namespaces ([#32](https://github.com/FontCustom/fontcustom/issues/32))
+* Added support for --verbose=false ([#54](https://github.com/FontCustom/fontcustom/pull/54))
+* Improved ascent/decent heights ([#33](https://github.com/FontCustom/fontcustom/issues/33))
+* Fixed bug where watcher could fall into an infinite loop
+* Added error messages for faulty input
+* Refactored gem internals to reflect saner usage of Thor
+* Refactored tests
+
 ## 0.1.4 (2/19/2013)
 
 * Instructions for stopping watcher ([#46](https://github.com/FontCustom/fontcustom/issues/46))

data/CONTRIBUTING.md

@@ -1,11 +1,18 @@
-# FontCustom Contributing Checklist
+# FontCustom Contributing Guidelines
 
-First, thanks for your interest in making FontCustom better! This project was born out of an over-heard conversation between two devs in a coffee shop — it's come a long ways thanks to the support of kind folks like you.
+Thanks for helping make FontCustom better! This project was born out of an over-heard conversation between two devs in a coffee shop — it's come a long ways thanks to the support of folks like you.
 
-## A short list to help you get started:
+## Conventions
 
-* 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!
+We try to follow the [Github ruby styleguide](https://github.com/styleguide/ruby) as much as possible. 
+
+If you catch a typo or a particularly unsightly piece of code — please _do_ let us know. No such thing as too small of an improvement.
+
+## Process
+
+* Visit [issues](https://github.com/FontCustom/fontcustom/issues) for ideas.
+* Fork the repo if you haven't done so already.
+* Create a topic branch. `git checkout -b my_sweet_feature`
+* Add tests. Run tests with `rake`.
+* Develop your feature.
+* Once all tests are passing, submit a pull request!

data/Rakefile

@@ -1,10 +1,8 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
-  t.libs = t.libs + ['lib/fontcustom', 'spec', 'spec/fixtures']
-  t.test_files = FileList['spec/fontcustom/*_spec.rb']
-  t.verbose = true
+RSpec::Core::RakeTask.new 'spec' do |s|
+  s.rspec_opts = '--color --format documentation'
 end
 
-task :default => :test
+task :default => :spec

data/bin/fontcustom

@@ -2,4 +2,4 @@
 
 require 'fontcustom/cli'
 
-Fontcustom::CLI.start
+Fontcustom::CLI.start(ARGV)

data/fontcustom.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Yifei Zhang", "Joshua Gross"]
   gem.email         = ["yz@yifei.co", "joshua@gross.is"]
   gem.summary       = %q{Generate custom icon webfonts from the comfort of 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://endtwist.github.com/fontcustom/"
+  gem.description   = %q{Transforms EPS and SVG vectors into icon webfonts. Generates CSS (or your preferred alternative) for easy inclusion in your projects.}
+  gem.homepage      = "http://fontcustom.com"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -24,9 +24,4 @@ Gem::Specification.new do |gem|
   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/fontcustom.rb

@@ -1,21 +1,6 @@
-require 'fontcustom/version'
-require 'fontcustom/generator'
-require 'fontcustom/watcher'
-
-module Fontcustom
-  # Usage:
-  # Fontcustom.compile 'path/to/vectors', '-o', 'path/to/output'
-  def compile(*args)
-    Fontcustom::Generator.start(args) # as array
-  end
-
-  def watch(*args)
-    Fontcustom::Watcher.watch(*args)
-  end
-
-  def stop
-    Fontcustom::Watcher.stop
-  end
-
-  module_function :compile, :watch, :stop
-end
+require "fontcustom/version"
+require "fontcustom/options"
+require "fontcustom/error"
+require "fontcustom/util"
+require "fontcustom/generator/font"
+require "fontcustom/generator/template"

data/lib/fontcustom/cli.rb

@@ -1,27 +1,55 @@
-require 'thor'
-require 'fontcustom'
+require "thor"
+require "thor/actions"
+require "fontcustom"
+require "fontcustom/watcher"
 
 module Fontcustom
   class CLI < Thor
-    # duplicated from Fontcustom::Generator so as to also appear under `fontcustom help` command
-    class_option :output, :aliases => '-o', :desc => 'Specify an output directory. Default: $DIR/fontcustom'
-    class_option :name, :aliases => '-n', :desc => 'Specify a font name. This will be used in the generated fonts and CSS. Default: fontcustom'
-    class_option :font_path, :aliases => '-f', :desc => 'Specify a path for fonts in css @font-face declaration. Default: none'
-    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'
+    include Thor::Actions
 
-    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
-      Fontcustom.compile(*ARGV)
+    # Actual defaults are stored in Fontcustom::DEFAULT_OPTIONS instead of Thor
+    class_option :output, :aliases => "-o", :desc => "The output directory (will be created if it doesn't exist). Default: INPUT/fontcustom/"
+    class_option :config, :aliases => "-c", :desc => "Path to or containing directory of the config file. Default: INPUT/fontcustom.yml" 
+    class_option :templates, :aliases => "-t", :type => :array, :desc => "List of templates to compile alongside fonts. Accepts 'css', 'css-ie7', 'scss', 'preview' or arbitrary paths (relative to INPUT or PWD). Default: 'css preview'"
+    class_option :font_name, :aliases => "-n", :desc => "The font name used in your templates (automatically normalized to lowercase spinal case). Default: 'fontcustom'"
+    class_option :file_hash, :aliases => "-h", :type => :boolean, :desc => "Generate font files with asset-busting hashes. Default: true"
+    class_option :css_prefix, :aliases => "-p", :desc => "The prefix for each glyph's CSS class. Default: 'icon-'"
+    class_option :debug, :aliases => "-d", :type => :boolean, :desc => "Display debug messages from fontforge. Default: false"
+    class_option :verbose, :aliases => "-v", :type => :boolean, :desc => "Display output messages. Default: true"
+
+    # Required for Thor::Actions#template
+    def self.source_root
+      File.join Fontcustom::Util.gem_lib_path, "templates"
+    end
+
+    desc "compile [INPUT]", "Generates webfonts and CSS from *.svg and *.eps files in INPUT."
+    def compile(input)
+      opts = options.merge :input => input
+      opts = Fontcustom::Util.collect_options opts
+      Fontcustom::Generator::Font.start [opts]
+      Fontcustom::Generator::Template.start [opts]
+    rescue Fontcustom::Error => e
+      puts "ERROR: #{e.message}"
+    end
+
+    desc "watch [INPUT]", "Watches INPUT for changes and regenerates webfonts and CSS automatically. Ctrl + C to stop."
+    method_option :skip_first, :aliases => "-s", :type => :boolean, :desc => "Compile immediately upon watching. Default: false"
+    def watch(input)
+      opts = options.merge :input => input, :skip_first => !! options[:skip_first]
+      opts = Fontcustom::Util.collect_options opts
+      Fontcustom::Watcher.new(opts).watch
+    rescue Fontcustom::Error => e
+      puts "ERROR: #{e.message}"
+    end
+
+    desc "config [INPUT]", "Adds an annotated fontcustom.yml to INPUT (created if it doesn't exists)."
+    def config(input)
+      template "fontcustom.yml", File.join(input, "fontcustom.yml")
     end
 
-    desc 'watch DIR [options]', 'Watches DIR for changes and regenerates webfonts and CSS automatically. Ctrl + C to stop.'
-    def watch(*args)
-      ARGV.shift
-      Fontcustom.watch(*ARGV)
+    desc "version", "Shows the version information."
+    def version
+      puts "fontcustom-#{Fontcustom::VERSION}"
     end
   end
 end

data/lib/fontcustom/error.rb

@@ -0,0 +1,4 @@
+module Fontcustom
+  class Error < StandardError
+  end
+end

data/lib/fontcustom/generator/font.rb

@@ -0,0 +1,101 @@
+require "json"
+require "thor"
+require "thor/group"
+require "thor/actions"
+
+module Fontcustom
+  module Generator
+    class Font < Thor::Group
+      include Thor::Actions
+
+      # Instead of passing each option individually we're passing the entire options hash as an argument. 
+      # This is DRYier, easier to maintain.
+      argument :opts 
+
+      def check_input
+        if ! File.directory? opts[:input]
+          raise Fontcustom::Error, "#{opts[:input]} doesn't exist or isn't a directory."
+        elsif Dir[File.join(opts[:input], "*.{svg,eps}")].empty?
+          raise Fontcustom::Error, "#{opts[:input]} doesn't contain any vectors (*.svg or *.eps files)."
+        end
+      end
+
+      def check_output
+        if File.exists? File.join(opts[:output], ".fontcustom-data")
+          # Skip ahead, everything is in order
+        elsif File.exists?(opts[:output]) && ! File.directory?(opts[:output])
+          raise Fontcustom::Error, "#{opts[:output]} already exists but isn't a directory."
+        else
+          # creates opts[:output] as well
+          add_file File.join(opts[:output], ".fontcustom-data"), :verbose => opts[:verbose]
+        end
+      end
+
+      def get_data
+        # file has already been verified/created
+        data = File.read File.join(opts[:output], ".fontcustom-data") 
+        data = JSON.parse(data, :symbolize_names => true) unless data.empty?
+        @data = data.is_a?(Hash) ? data : Fontcustom::DATA_MODEL.dup
+      rescue JSON::ParserError
+        raise Fontcustom::Error, "The .fontcustom-data file in #{opts[:output]} is corrupted. Fix the JSON or delete the file to start from scratch."
+      end
+
+      def reset_output
+        return if @data[:fonts].empty?
+        begin
+          deleted = []
+          @data[:fonts].each do |file| 
+            remove_file File.join(opts[:output], file), :verbose => opts[:verbose]
+            deleted << file
+          end
+        ensure
+          @data[:fonts] = @data[:fonts] - deleted
+          json = JSON.pretty_generate @data
+          file = File.join(opts[:output], ".fontcustom-data")
+          Fontcustom::Util.clear_file(file)
+          append_to_file file, json, :verbose => false # clear data file silently
+        end
+      end
+      
+      def generate
+        # TODO align option naming conventions with python script
+        # TODO remove name arg if default is already set in python (or rm from python)
+        name = opts[:font_name] ? " --name " + opts[:font_name] : ""
+        hash = opts[:file_hash] ? "" : " --nohash"
+        cmd = "fontforge -script #{Fontcustom::Util.gem_lib_path}/scripts/generate.py #{opts[:input]} #{opts[:output] + name + hash} 2>&1"
+
+        output = `#{cmd}`.split("\n")
+        @json = output[3] # JSON
+        output = output[4..-1] # Strip fontforge message
+
+        if opts[:debug]
+          shell.say "DEBUG: (raw output from fontforge)"
+          shell.say output
+        end
+
+        unless output.empty? # correct output should be []
+          raise Fontcustom::Error, "Compilation failed unexpectedly. Check your options and try again with --debug get more details."
+        end
+      end
+
+      def collect_data
+        @json = JSON.parse(@json, :symbolize_names => true)
+        @data.merge! @json
+        @data[:glyphs].map! { |glyph| glyph.gsub(/\W/, "-").downcase }
+      end
+
+      def announce_files
+        if opts[:verbose]
+          @data[:fonts].each { |file| shell.say_status(:create, File.join(opts[:output], file)) }
+        end
+      end
+
+      def save_data
+        json = JSON.pretty_generate @data
+        file = File.join(opts[:output], ".fontcustom-data")
+        Fontcustom::Util.clear_file(file)
+        append_to_file file, json, :verbose => opts[:verbose]
+      end
+    end
+  end
+end

data/lib/fontcustom/generator/template.rb

@@ -0,0 +1,80 @@
+require "json"
+require "thor"
+require "thor/group"
+require "thor/actions"
+
+module Fontcustom
+  module Generator
+    class Template < Thor::Group
+      include Thor::Actions
+      
+      # Instead of passing each option individually we're passing the entire options hash as an argument. 
+      # This is DRYier, easier to maintain.
+      argument :opts 
+
+      # Required for Thor::Actions#template
+      def self.source_root
+        File.join Fontcustom::Util.gem_lib_path, "templates"
+      end
+
+      def get_data
+        data = File.join(opts[:output], ".fontcustom-data")
+        if File.exists? data
+          @data = JSON.parse(File.read(data), :symbolize_names => true) 
+        else
+          raise Fontcustom::Error, "There's no .fontcustom-data file in #{opts[:output]}. Try again?"
+        end
+      rescue JSON::ParserError 
+        # Catches both empty and and malformed files
+        raise Fontcustom::Error, "The .fontcustom-data file in #{opts[:output]} is empty or corrupted. Try deleting the file and running Fontcustom::Generator::Font again to regenerate .fontcustom-data."
+      end
+
+      def check_templates
+        if opts[:templates].empty?
+          raise Fontcustom::Error, "No templates were specified. Check your options and try again?"
+        end
+      end
+
+      def update_source_paths
+        source_paths # assigns @source_paths
+        @source_paths.unshift(opts[:input], Dir.pwd)
+      end
+
+      def reset_output
+        return if @data[:templates].empty?
+        begin
+          deleted = []
+          @data[:templates].each do |file| 
+            remove_file File.join(opts[:output], file), :verbose => opts[:verbose]
+            deleted << file
+          end
+        ensure
+          @data[:templates] = @data[:templates] - deleted
+          json = JSON.pretty_generate @data
+          file = File.join(opts[:output], ".fontcustom-data")
+          Fontcustom::Util.clear_file(file)
+          append_to_file file, json, :verbose => false # clear data file silently
+        end
+      end
+
+      def generate
+        @opts = opts # make available to templates
+        begin 
+          created = []
+          opts[:templates].each do |source|
+            name = File.basename source
+            destination = File.join opts[:output], name
+            template source, destination, :verbose => opts[:verbose]
+            created << name
+          end
+        ensure
+          @data[:templates] = (@data[:templates] + created).uniq # TODO better way of cleaning up templates
+          json = JSON.pretty_generate @data
+          file = File.join(opts[:output], ".fontcustom-data")
+          Fontcustom::Util.clear_file(file)
+          append_to_file file, json, :verbose => opts[:verbose]
+        end
+      end
+    end
+  end
+end

data/lib/fontcustom/options.rb

@@ -0,0 +1,20 @@
+module Fontcustom
+  DEFAULT_OPTIONS = {
+    :input => Dir.pwd,
+    :output => false, # used to assign default, if necessary 
+    :config => false,
+    :templates => %w|css preview|, 
+    :font_name => "fontcustom",
+    :file_hash => true,
+    :css_prefix => "icon-",
+    :debug => false,
+    :verbose => true
+  }
+
+  DATA_MODEL = {
+    :fonts => [],
+    :templates => [],
+    :file_name => "",
+    :glyphs => []
+  }
+end

data/lib/fontcustom/scripts/generate.py

@@ -1,8 +1,9 @@
 import fontforge
 import os
 import md5
-import json
 import subprocess
+import tempfile
+import json
 
 try:
 	import argparse
@@ -27,6 +28,10 @@ except ImportError:
 
 f = fontforge.font()
 f.encoding = 'UnicodeFull'
+f.design_size = 16
+f.em = 512
+f.ascent = 448
+f.descent = 64
 
 m = md5.new()
 cp = 0xf100
@@ -44,6 +49,7 @@ for dirname, dirnames, filenames in os.walk(indir):
 			if ext in ['.svg']:
 				# hack removal of <switch> </switch> tags
 				svgfile = open(filePath, 'r+')
+				tmpsvgfile = tempfile.NamedTemporaryFile(suffix=ext, delete=False)
 				svgtext = svgfile.read()
 				svgfile.seek(0)
 
@@ -51,19 +57,25 @@ for dirname, dirnames, filenames in os.walk(indir):
 				svgtext = svgtext.replace('<switch>', '')
 				svgtext = svgtext.replace('</switch>', '')
 			
-				# remove all contents of file so that we can write out the new contents
-				svgfile.truncate()			
-				svgfile.write(svgtext)
+				tmpsvgfile.file.write(svgtext)
 
 				svgfile.close()
+				tmpsvgfile.file.close()
+
+				filePath = tmpsvgfile.name
 				# end hack
 				
 			m.update(filename + str(size) + ';')
 			glyph = f.createChar(cp)
 			glyph.importOutlines(filePath)
 
-			glyph.left_side_bearing = KERNING
-			glyph.right_side_bearing = KERNING
+			# if we created a temporary file, let's clean it up
+			if tmpsvgfile:
+				os.unlink(tmpsvgfile.name)
+
+			# glyph.left_side_bearing = KERNING
+			# glyph.right_side_bearing = KERNING
+			glyph.width = 512
 
 			# possible optimization?
 			# glyph.simplify()
@@ -107,3 +119,7 @@ subprocess.call('mv ' + fontfile + '.eotlite ' + fontfile + '.eot', shell=True)
 
 # Hint the TTF file
 subprocess.call('ttfautohint -s -n ' + fontfile + '.ttf ' + fontfile + '-hinted.ttf > /dev/null 2>&1 && mv ' + fontfile + '-hinted.ttf ' + fontfile + '.ttf', shell=True)
+
+# Describe output in JSON
+outname = os.path.basename(fontfile)
+print json.dumps({'fonts': [outname + '.ttf', outname + '.woff', outname + '.eot', outname + '.svg'], 'glyphs': files, 'file_name': outname})