blacksmith 0.0.1 → 0.1.0

data/.gitignore

@@ -17,4 +17,9 @@ test/tmp
 test/version_tmp
 tmp
 
-.DS_Store
+.DS_Store
+examples/*.ttf
+examples/*.svg
+examples/*.afm
+examples/*.eot
+examples/*.woff

data/README.md

@@ -15,6 +15,19 @@ And then execute:
 Or install it yourself as:
 
     $ gem install blacksmith
+    
+## Pitfalls
+
+### SVG Viewport
+
+Make sure that all your SVGs contain a `viewBox` definition. Otherwise, weird
+things might happen.
+
+### OS X and ttfautohint
+
+If you don't have `ttfautohint` installed and don't want to compile it from
+source, you can grab a precompiled version from
+[SourceForge](http://sourceforge.net/projects/freetype/files/ttfautohint/).
 
 ## Usage
 

data/examples/forging_fonts.rb

@@ -3,12 +3,8 @@ require 'blacksmith'
 
 Blacksmith.forge do
   
-  name "Blacksmith Medium"
   family "Blacksmith"
   
-  source File.expand_path('../src', __FILE__)
-  target File.expand_path('../blacksmith-medium.ttf', __FILE__)
-  
   glyph 'star', code: 0x0061
   
 end

data/examples/glyphs/star.svg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg x="0" y="0" width="128px" height="128px" viewBox="0 0 128 128" xmlns="http://www.w3.org/2000/svg" version="1.1">
+    <g fill="rgb(215,215,215)" id="Page 1">
+        <g fill="rgb(0,0,0)" id="Star 56"></g>
+        <path id="Star 56" d="M63,88 L26,115 L40,71 L3,44 L49,43 L64,0 L78,43 L124,44 L87,71 L101,115 L63,88 Z M63,88" fill="rgb(0,0,0)"></path>
+        <path id="Star 56 decoration" d="" fill="rgb(0,0,0)"></path>
+    </g>
+</svg>

data/lib/blacksmith.rb

@@ -1,58 +1,75 @@
 require 'smart_properties'
 require 'erb'
 require 'tempfile'
+require 'singleton'
 
-require 'blacksmith/font'
-require 'blacksmith/font_builder'
-require 'blacksmith/glyph'
-require 'blacksmith/version'
-
-module Blacksmith
+class Blacksmith
+  Point = Struct.new(:x, :y)
   
+  class Error < ::RuntimeError; end
+  class DependencyMissing < Error; end
+
   class << self
+
+    def forge(*args, &block)
+      new(*args, &block).forge
+    end
     
-    def forge(filename = nil, &block)
-      font = prepare_font(&block)
-      forge_font(font)
-    end
-    
-    private
-    
-      def prepare_font(&block)
-        FontBuilder.new(&block).build
-      end
-      
-      def forge_font(font)
-        path = create_forging_instructions(font)
-        create_font_from_instructions(path)
-        File.unlink(path)
-      end
-      
-      def create_forging_instructions(font)
-        script = Tempfile.new('fontforge-instructions')
-        
-        script << font.instance_exec(forging_template) do |template|
-          template.result(binding)
-        end
-        
-        script.close
-        script.path
-      end
-      
-      def forging_template
-        template = File.read(File.join(root_directory, 'support', 'build.py.erb'))
-        ERB.new(template, nil, '<>')
-      end
-      
-      def root_directory
-        File.expand_path('../..', __FILE__)
-      end
-      
-      def create_font_from_instructions(path)
-        `fontforge -lang=py -script #{path}`
-      end
+    def root_directory
+      File.expand_path('../..', __FILE__)
+    end
     
+    def support_directory
+      File.join(root_directory, 'support')
+    end
+
   end
   
+  def initialize(filename = nil, &block)
+    @font = build_font(&block)
+  end
   
+  def forge
+    check_environment
+    
+    forge_font
+    auto_hint_font
+    convert_font
+  end
+
+  protected
+    
+    attr_reader :font
+    
+    def build_font(&block)
+      FontBuilder.execute(&block)
+    end
+    
+    def check_environment
+      FontForge.check_dependency!
+      TTFAutoHint.check_dependency!
+    end
+    
+    def forge_font
+      FontForge.execute(font.to_fontforge_build_instructions)
+    end
+    
+    def auto_hint_font
+      TTFAutoHint.execute(font.ttf_path)
+    end
+    
+    def convert_font
+      FontForge.execute(font.to_fontforge_conversion_instructions)
+    end
+
 end
+
+require 'blacksmith/executable'
+require 'blacksmith/font_forge'
+require 'blacksmith/ttf_auto_hint'
+
+require 'blacksmith/font'
+require 'blacksmith/font_builder'
+require 'blacksmith/glyph'
+
+require 'blacksmith/version'

data/lib/blacksmith/executable.rb

@@ -0,0 +1,33 @@
+class Blacksmith::Executable
+  include Singleton
+  
+  class << self
+    
+    def method_missing(name, *args, &block)
+      instance.send(name, *args, &block)
+    end
+    
+  end
+  
+  def executable
+    raise NotImplementedError, "#{self.class} is expected to implement #executable"
+  end
+  
+  def installed?
+    @installed unless @installed.nil?
+    
+    paths      = ENV['PATH'].split(File::PATH_SEPARATOR)
+    extensions = ENV['PATHEXT'] ? ENV['PATHEXT'].split(File::PATH_SEPARATOR) : ['']
+    
+    @installed = !!paths.find do |path|
+      extensions.find do |ext|
+        File.executable?(File.join(path, "#{executable}#{ext}"))
+      end
+    end
+  end
+  
+  def check_dependency!
+    raise Blacksmith::DependencyMissing, "#{executable} not installed" unless installed?
+  end
+  
+end

data/lib/blacksmith/font.rb

@@ -1,52 +1,112 @@
-module Blacksmith
-  class Font
-    include SmartProperties
-    
-    property :name, :required => true,
+class Blacksmith::Font
+  include SmartProperties
+  
+  property :name, :converts => :to_s
+
+  property :family, :required => true,
                     :converts => :to_s
-    
-    property :family, :required => true,
-                      :converts => :to_s
-                      
-    property :copyright, :converts => :to_s
-    
-    property :ascent, :required => true,
-                      :converts => :to_i,
-                      :accepts => lambda { |number| number > 0 },
-                      :default => 800
-                      
-    property :descent, :required => true,
-                       :converts => :to_i,
-                       :accepts => lambda { |number| number > 0 },
-                       :default => 200
 
-    property :weight, :required => true,
-                      :default => 'Medium'
-                      
-    property :version, :required => true,
-                       :converts => :to_s,
-                       :accepts => lambda { |v| /\d+\.\d+(\.\d+)?/.match(v) },
-                       :default => '1.0'
+  property :weight, :required => true,
+                    :default => 'Regular'
+
+  property :copyright, :converts => :to_s
+  
+  property :ascent, :required => true,
+                    :converts => :to_i,
+                    :accepts => lambda { |number| number > 0 },
+                    :default => 800
+                    
+  property :descent, :required => true,
+                     :converts => :to_i,
+                     :accepts => lambda { |number| number > 0 },
+                     :default => 200
+
+  property :version, :required => true,
+                     :converts => :to_s,
+                     :accepts => lambda { |v| /\d+\.\d+(\.\d+)?/.match(v) },
+                     :default => '1.0'
+
+  property :baseline, :converts => :to_f,
+                      :accepts => lambda { |baseline| baseline > 0.0 }
+
+  property :scale, :converts => :to_f,
+                   :accepts => lambda { |scale| scale > 0.0 }
+
+  property :offset, :converts => :to_f,
+                    :accepts => lambda { |offset| offset <= 1.0 and offset >= -1.0 }
+  
+  property :source, :required => true,
+                    :converts => :to_s,
+                    :accepts => lambda { |path| File.directory?(path) },
+                    :default => 'glyphs'
+  
+  property :target, :required => true,
+                    :converts => :to_s,
+                    :accepts => lambda { |path| File.directory?(path) },
+                    :default => '.'
+  
+  [:ttf, :eot, :woff, :svg].each do |extension|
+    name = "#{extension}_path"
     
-    property :filename, :required => true,
-                        :converts => :to_s,
-                        :accepts => lambda { |target| 
-                          File.extname(target) == '.ttf' and 
-                          File.directory?(File.dirname(target)) 
-                        }
+    property name, :converts => :to_s,
+                   :accepts => lambda { |filename| 
+                     File.extname(filename) == ".#{extension}" and 
+                     File.directory?(File.dirname(filename)) 
+                   }
     
-    def identifier
-      name.gsub(/\W+/, '_')
+    define_method(name) do
+      super() || File.join(target, "#{basename}.#{extension}")
     end
     
-    def glyphs
-      (@glyphs || []).dup
+  end
+  
+  def name
+    super || [family, weight].join(' ')
+  end
+  
+  def identifier
+    name.gsub(/\W+/, '_').downcase
+  end
+  
+  def basename
+    [family.gsub(/\W+/, ''), weight.gsub(/\W+/, '')].join('-')
+  end
+  
+  def glyphs
+    (@glyphs || []).dup
+  end
+  
+  def <<(glyph)
+    @glyphs ||= []
+    @glyphs << glyph
+  end
+  
+  def baseline
+    super or (1.0 * descent) / (ascent + descent)
+  end
+  
+  def origin
+    Blacksmith::Point.new(0, (ascent + descent) * baseline - descent)
+  end
+  
+  def to_fontforge_build_instructions
+    fontforge_build_instructions_template.result(binding)
+  end
+  
+  def to_fontforge_conversion_instructions
+    fontforge_conversion_instructions_template.result(binding)
+  end
+  
+  private
+  
+    def fontforge_build_instructions_template
+      template = File.read(File.join(Blacksmith.support_directory, 'fontforge_build_instructions.py.erb'))
+      ERB.new(template)
     end
     
-    def <<(glyph)
-      @glyphs ||= []
-      @glyphs << glyph
+    def fontforge_conversion_instructions_template
+      template = File.read(File.join(Blacksmith.support_directory, 'fontforge_conversion_instructions.py.erb'))
+      ERB.new(template)
     end
-    
-  end
+  
 end

data/lib/blacksmith/font_builder.rb

@@ -1,55 +1,45 @@
-module Blacksmith
-  class FontBuilder
+class Blacksmith::FontBuilder
+  class << self
     
-    def initialize(&block)
-      @_instructions = block
-      @_attributes = {}
-      @_glyphs = {}
-      @_source = '.'
+    def execute(&block)
+      new(&block).execute
     end
     
-    def build
-      instance_eval(&@_instructions)
-      
-      font = Font.new(@_attributes)
-      
-      @_glyphs.each do |name, attrs| 
-        attrs[:outline] ||= File.join(@_source, "#{name}.svg")
-        font << Glyph.new(attrs)
-      end
-      
-      font
-    end
-    
-    def source(path = nil)
-      if path
-        raise ArgumentError, "Directory does not exist: #{path}" unless File.directory?(path)
-        @_source = path
-      else
-        @_source
-      end
-    end
+  end
+  
+  def initialize(&block)
+    @_instructions = block
+    @_attributes = {}
+    @_glyphs = {}
+    @_source = '.'
+  end
+  
+  def execute
+    instance_eval(&@_instructions)
     
-    def target(path = nil)
-      if path
-        raise ArgumentError, "Directory does not exist: #{path}" unless File.directory?(File.dirname(path))
-        @_attributes[:filename] = path
-      else
-        @_attributes[:filename]
-      end
-    end
+    font = Blacksmith::Font.new(@_attributes)
     
-    def glyph(name, attrs)
-      @_glyphs[name] = attrs
+    @_glyphs.each do |name, attrs|
+      attrs[:scale]   ||= font.scale
+      attrs[:offset]  ||= font.offset
+      attrs[:outline] ||= File.join(font.source, "#{name}.svg")
+      
+      font << Blacksmith::Glyph.new(attrs)
     end
     
-    def method_missing(name, *args)
-      if args.length == 1
-        @_attributes[name] = args[0]
-      else
-        super
-      end
+    font
+  end
+
+  def glyph(name, attrs)
+    @_glyphs[name] = attrs
+  end
+  
+  def method_missing(name, *args)
+    if args.length == 1
+      @_attributes[name] = args[0]
+    else
+      super
     end
-    
   end
+  
 end

data/lib/blacksmith/font_forge.rb

@@ -0,0 +1,40 @@
+class Blacksmith::FontForge < Blacksmith::Executable
+  
+  def executable
+    'fontforge'
+  end
+
+  def execute(file_or_instructions)
+    check_dependency!
+    
+    case file_or_instructions
+    when String
+      with_temporary_instuctions_file(file_or_instructions) do |path|
+        execute!(path)
+      end
+    when File
+      path = file_or_instructions.path
+      execute!(path)
+    else
+      raise ArgumentError, "FontForge#execute expects a File or String"
+    end
+  end
+
+  private
+
+    def execute!(path)
+      system(executable, '-lang=py', '-script', path)
+    end
+
+    def with_temporary_instuctions_file(instructions)
+      script = Tempfile.new('fontforge-instructions')
+      script.puts(instructions)
+      script.close
+
+      yield script.path
+    ensure
+      script.close unless script.closed?
+      script.unlink
+    end
+
+end

data/lib/blacksmith/glyph.rb

@@ -1,24 +1,28 @@
-module Blacksmith
-  class Glyph
-    include SmartProperties
-    
-    property :outline, :required => true,
-                       :converts => :to_s,
-                       :accepts => lambda { |filename| File.exist?(filename) }
-    
-    property :code, :required => true
-    
-    property :left_side_bearing, :required => true,
-                                 :converts => :to_i,
-                                 :default => 15
+class Blacksmith::Glyph
+  include SmartProperties
+  
+  property :outline, :required => true,
+                     :converts => :to_s,
+                     :accepts => lambda { |filename| File.exist?(filename) }
+  
+  property :code, :required => true
+  
+  property :left_side_bearing, :required => true,
+                               :converts => :to_i,
+                               :default => 15
 
-    property :right_side_bearing, :required => true,
-                                  :converts => :to_i,
-                                  :default => 15
-    
-    def name
-      File.basename(outline)
-    end
-    
+  property :right_side_bearing, :required => true,
+                                :converts => :to_i,
+                                :default => 15
+  
+  property :scale, :converts => :to_f,
+                   :accepts => lambda { |scale| scale > 0.0 }
+  
+  property :offset, :converts => :to_f,
+                    :accepts => lambda { |offset| offset <= 1.0 and offset >= -1.0 }
+  
+  def name
+    File.basename(outline)
   end
+  
 end

data/lib/blacksmith/ttf_auto_hint.rb

@@ -0,0 +1,37 @@
+class Blacksmith::TTFAutoHint < Blacksmith::Executable
+  
+  def executable
+    'ttfautohint'
+  end
+  
+  def execute(source)
+    check_dependency!
+    
+    target = begin
+      f = Tempfile.new(File.basename(source))
+      f.close
+      f.path
+    end 
+    
+    build_hinted_font(source, target)
+    replace_file(source, target)
+  end
+  
+  private
+    
+    def replace_file(source, target)
+      FileUtils.mv(target, source)
+    end
+    
+    def build_hinted_font(source, target)
+      args = %w{
+        --latin-fallback
+        --hinting-limit=200
+        --hinting-range-max=50
+        --symbol
+      }
+
+      system(executable, *args, source, target)
+    end
+  
+end

data/lib/blacksmith/version.rb

@@ -1,3 +1,3 @@
-module Blacksmith
-  VERSION = "0.0.1"
+class Blacksmith
+  VERSION = "0.1.0"
 end

data/support/fontforge_build_instructions.py.erb

@@ -0,0 +1,56 @@
+import fontforge
+import psMat
+
+# --------------------------------------------------------------------------
+# Helper functions
+# --------------------------------------------------------------------------
+
+def scale(char, origin, scale):
+    """Rescale glyph"""
+    # move scale origin point to (0, 0)
+    sx, sy = origin
+    translate_matrix = psMat.translate(-sx, -sy)
+    char.transform(translate_matrix)
+
+    # scale around (0, 0)
+    scale_matrix = psMat.scale(scale)
+    char.transform(scale_matrix)
+
+    # move scale origin point back to its old position
+    translate_matrix = psMat.translate(origin)
+    char.transform(translate_matrix)
+    
+def position(char, offset):
+    """Repositions the glyph"""
+    offset_matrix = psMat.translate(0, offset * <%= ascent + descent %>)
+    char.transform(offset_matrix)
+    
+# --------------------------------------------------------------------------
+# Forging instructions
+# --------------------------------------------------------------------------
+
+font = fontforge.font()
+
+font.encoding   = 'UnicodeFull'
+font.version    = "<%= version %>"
+font.fontname   = "<%= identifier %>"
+font.fullname   = "<%= name %>"
+font.familyname = "<%= family %>"
+font.copyright  = "<%= copyright %>"
+font.ascent     = <%= ascent %>
+font.descent    = <%= descent %>
+font.weight     = "<%= weight %>"
+
+<% for glyph in glyphs do %>
+# <%= glyph.name %>
+c = font.createChar(<%= glyph.code %>)
+c.importOutlines("<%= glyph.outline %>")
+c.left_side_bearing = <%= glyph.left_side_bearing %>
+c.right_side_bearing = <%= glyph.right_side_bearing %>
+c.simplify()
+c.round()
+<%= "scale(c, (#{origin.x}, #{origin.y}), #{glyph.scale})" if glyph.scale %>
+<%= "position(c, #{glyph.offset})" if glyph.offset %>
+<% end %>
+
+font.generate("<%= ttf_path %>")

data/support/fontforge_conversion_instructions.py.erb

@@ -0,0 +1,6 @@
+import fontforge
+
+font = fontforge.open("<%= ttf_path %>")
+font.generate("<%= svg_path %>")
+font.generate("<%= eot_path %>")
+font.generate("<%= woff_path %>")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacksmith
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 Z
+date: 2012-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_properties
@@ -41,13 +41,17 @@ files:
 - Rakefile
 - blacksmith.gemspec
 - examples/forging_fonts.rb
-- examples/src/star.svg
+- examples/glyphs/star.svg
 - lib/blacksmith.rb
+- lib/blacksmith/executable.rb
 - lib/blacksmith/font.rb
 - lib/blacksmith/font_builder.rb
+- lib/blacksmith/font_forge.rb
 - lib/blacksmith/glyph.rb
+- lib/blacksmith/ttf_auto_hint.rb
 - lib/blacksmith/version.rb
-- support/build.py.erb
+- support/fontforge_build_instructions.py.erb
+- support/fontforge_conversion_instructions.py.erb
 homepage: http://github.com/t6d/blacksmith
 licenses: []
 post_install_message: 

data/examples/src/star.svg

@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg width="128px" height="128px" xmlns="http://www.w3.org/2000/svg" version="1.1">
-    <title></title>
-    <description>Created with Sketch (http://www.bohemiancoding.com/sketch)</description>
-    <defs>
-        <linearGradient id="gradient-1" x1="50%" y1="0%" x2="50%" y2="100%">
-            <stop offset="0%" style="stop-color:rgb(255,255,255); stop-opacity:100"></stop>
-            <stop offset="100%" style="stop-color:rgb(0,0,0); stop-opacity:100"></stop>
-        </linearGradient>
-        <linearGradient id="gradient-2" x1="50%" y1="0%" x2="50%" y2="100%">
-            <stop offset="0%" style="stop-color:rgb(255,255,255); stop-opacity:100"></stop>
-            <stop offset="100%" style="stop-color:rgb(0,0,0); stop-opacity:100"></stop>
-        </linearGradient>
-        <linearGradient id="gradient-3" x1="50%" y1="0%" x2="50%" y2="100%">
-            <stop offset="0%" style="stop-color:rgb(255,255,255); stop-opacity:100"></stop>
-            <stop offset="100%" style="stop-color:rgb(0,0,0); stop-opacity:100"></stop>
-        </linearGradient>
-    </defs>
-    <g fill="rgb(215,215,215)" id="Page 1">
-        <g fill="rgb(0,0,0)" id="Star 55"></g>
-        <path id="Star 55" d="M65,90 L35,106 L41,72 L16,48 L50,43 L65,13 L80,43 L114,48 L89,72 L95,106 L65,90 Z M65,90" fill="rgb(0,0,0)"></path>
-        <path id="Star 55 decoration" d="" fill="rgb(0,0,0)"></path>
-    </g>
-</svg>

data/support/build.py.erb

@@ -1,25 +0,0 @@
-import fontforge
-
-font = fontforge.font()
-
-font.version    = "<%= version %>"
-font.fontname   = "<%= identifier %>"
-font.fullname   = "<%= name %>"
-font.familyname = "<%= family %>"
-font.copyright  = "<%= copyright %>"
-font.ascent     = <%= ascent %>
-font.descent    = <%= descent %>
-font.weight     = "<%= weight %>"
-
-<% for glyph in glyphs do %>
-# <%= glyph.name %>
-c = font.createChar(<%= glyph.code %>)
-c.importOutlines("<%= glyph.outline %>")
-c.left_side_bearing = <%= glyph.left_side_bearing %>
-c.right_side_bearing = <%= glyph.right_side_bearing %>
-c.simplify()
-c.round()
-
-<% end %>
-
-font.generate("<%= filename %>")