fontcustom 1.0.1 → 1.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efd1bb1c3cf2ffcac93eb4eae10d08a7c21043b5
-  data.tar.gz: 23dd672e77766afbbbf86c6956dc1b186a773c4a
+  metadata.gz: d394a232cd9bca5b67961598fe0696c677241fdf
+  data.tar.gz: 33d86584a9255b4a937551c69342718bde7e7134
 SHA512:
-  metadata.gz: 616614a6418bf68ed0f8c82290244ac0753612d843be5f7f1d3e986805f8e4eba96672c85288349d1b78cbf8cc74529f2b89e19c31a446171c23a80ee813ea55
-  data.tar.gz: 0d96d2ac5ad266f077e201420a77992a635e04229353b4f786e106f93d880199f2b0dd02486136dc7d774d7ea1bd8cb4d6e34fc4327ac29f55592fc8580511a6
+  metadata.gz: f96ad328c2b67b55eb1379bb362ee42c6e2240a7566976dae7abb615b737da7d6c36d8f1fc23a13d6cb644e65ad8dab5b2d60a5a988c5e5776cc99c37bd0b667
+  data.tar.gz: c1126c9542867c77421d60c04afacf87eaa9844747d833e5b6dc74c23a312212dcf846560ed2282efdc0e1ea015706ff1da5f2acbbcaab5fa8e154c05d6b3268

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.1 (7/21/2013)
+
+Various bugfixes.
+
+* Set glyph widths automatically ([#95](https://github.com/FontCustom/fontcustom/issues/95))
+* Fixes Ruby 1.8.7 syntax error ([#94](https://github.com/FontCustom/fontcustom/issues/94))
+* More robust fontforge error handling ([#99](https://github.com/FontCustom/fontcustom/issues/99))
+
 ## 1.0.0 (4/18/2013)
 
 Big changes, more flexibility, better workflow. Be sure to check out the [docs](http://fontcustom.com) to see how it all ties together.

data/README.md

@@ -1,4 +1,4 @@
-# FontCustom v1.0.0
+# FontCustom v1.0.1
 
 **Generate custom icon webfonts from the comfort of the command line.**
 

data/TODO.md

@@ -0,0 +1,6 @@
+## TODO
+
+* `clear_file` and `append_to_file` can probably be combined
+* Handle error through Fontcustom::Actions
+* Messages for improper config, default settings, etc.
+* Colors for thor :say

data/lib/fontcustom.rb

@@ -2,11 +2,11 @@ require "fontcustom/version"
 require "fontcustom/options"
 require "fontcustom/error"
 require "fontcustom/util"
+require "fontcustom/actions"
 require "fontcustom/generator/font"
 require "fontcustom/generator/template"
 
 module Fontcustom
-
   ##
   # Clean Ruby API to workaround Thor
   def compile(options)

data/lib/fontcustom/actions.rb

@@ -0,0 +1,28 @@
+require "thor/actions"
+require "thor/shell"
+require "thor/shell/basic"
+require "thor/shell/color"
+
+module Fontcustom
+  module Actions
+    def self.included(base)
+      base.send :include, Thor::Actions
+    end
+
+    # TODO Currently not sure how Thor classes inherit `say_status` from Thor::Shell.
+    # Using the instance variable as a workaround.
+    def say_changed(status, changed)
+      return unless opts[:verbose]
+      message = changed.map do |file| 
+        file.gsub!(opts[:project_root], "")
+        file = file[1..-1] if file[0] == "/"
+        file
+      end
+      @shell.say_status status, message.join(" ") 
+    end
+
+    def clear_file(file)
+      File.open(file, "w") {}
+    end
+  end
+end

data/lib/fontcustom/cli.rb

@@ -8,23 +8,24 @@ module Fontcustom
     include Thor::Actions
 
     # 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 'preview css scss bootstrap bootstrap-scss bootstrap-ie7 bootstrap-ie7-scss' 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 :project_root, :aliases => "-r", :desc => "The base directory that all inputs and outputs are relative to. Default: working directory"
+    class_option :output, :aliases => "-o", :desc => "The output directory (will be created if it doesn't exist). Default: PROJECT_ROOT/FONT_NAME/"
+    class_option :config, :aliases => "-c", :desc => "Path to an optional configuration file. Files at PROJECT_ROOT/fontcustom.yml and PROJECT_ROOT/config/fontcustom.yml are loaded automatically." 
+    class_option :templates, :aliases => "-t", :type => :array, :desc => "List of templates to compile alongside fonts. Accepts 'preview css scss bootstrap bootstrap-scss bootstrap-ie7 bootstrap-ie7-scss' or custom templates (advanced, run `fontcustom config` and read the example for more details). Default: 'css preview'"
+    class_option :font_name, :aliases => "-n", :desc => "The font name used in your templates. Also determines the default OUTPUT directory name. Default: 'fontcustom'"
+    class_option :file_hash, :aliases => "-h", :type => :boolean, :desc => "Option to 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 :font_face_path, :alias => "-f", :desc => "The http path used in @font-face declarations. Only used in .scss partials. Default: none"
+    class_option :preprocessor_font_path, :alias => "-s", :desc => "The font path passed to CSS preprocessors (used instead of normal paths in preprocessed CSS templates). Default: none"
     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"
+    class_option :verbose, :aliases => "-v", :type => :boolean, :desc => "Display verbose 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)
+    desc "compile [INPUT] [OPTIONS]", "Generates webfonts and CSS from *.svg and *.eps files in INPUT."
+    def compile(input = nil)
       opts = options.merge :input => input
       opts = Fontcustom::Util.collect_options opts
       Fontcustom::Generator::Font.start [opts]
@@ -33,9 +34,9 @@ module Fontcustom
       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)
+    desc "watch [INPUT] [OPTIONS]", "Watches INPUT for changes and regenerates files automatically. Ctrl + C to stop."
+    method_option :skip_first, :aliases => "-s", :type => :boolean, :desc => "Skip the initial compile upon watching. Default: false"
+    def watch(input = nil)
       opts = options.merge :input => input, :skip_first => !! options[:skip_first]
       opts = Fontcustom::Util.collect_options opts
       Fontcustom::Watcher.new(opts).watch
@@ -43,9 +44,9 @@ module Fontcustom
       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")
+    desc "config [DIR]", "Adds an annotated fontcustom.yml to DIR. Default: working directory"
+    def config(dir = Dir.pwd)
+      template "fontcustom.yml", File.join(dir, "fontcustom.yml")
     end
 
     desc "version", "Shows the version information."

data/lib/fontcustom/generator/font.rb

@@ -1,59 +1,56 @@
 require "json"
 require "thor"
 require "thor/group"
-require "thor/actions"
+require "thor/core_ext/hash_with_indifferent_access"
 
 module Fontcustom
   module Generator
     class Font < Thor::Group
-      include Thor::Actions
+      include 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)."
+      def prepare_output_dirs
+        dirs = opts[:output].values.uniq
+        dirs.each do |dir|
+          unless File.directory? dir
+            empty_directory dir, :verbose => opts[:verbose]
+          end
         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."
+      def get_data
+        datafile = File.join opts[:project_root], ".fontcustom-data"
+        if File.exists? datafile
+          begin
+            data = File.read datafile
+            data = JSON.parse(data, :symbolize_names => true) unless data.empty?
+            @data = data.is_a?(Hash) ? Thor::CoreExt::HashWithIndifferentAccess.new(data) : Fontcustom::DATA_MODEL.dup
+          rescue JSON::ParserError
+            raise Fontcustom::Error, "The .fontcustom-data file at #{datafile} is corrupted. Fix the JSON or delete the file to start from scratch."
+          end
         else
-          # creates opts[:output] as well
-          add_file File.join(opts[:output], ".fontcustom-data"), :verbose => opts[:verbose]
+          @data = Fontcustom::DATA_MODEL.dup
         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]
+            remove_file file, :verbose => false
             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
+          file = File.join(opts[:project_root], ".fontcustom-data")
+          clear_file(file)
+          append_to_file file, json, :verbose => false
+          say_changed :removed, deleted
         end
       end
       
@@ -62,7 +59,7 @@ module Fontcustom
         # 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"
+        cmd = "fontforge -script #{Fontcustom::Util.gem_lib_path}/scripts/generate.py #{opts[:input][:vectors]} #{opts[:output][:fonts] + name + hash} 2>&1"
 
         output = `#{cmd}`.split("\n")
         @json = output[3] # JSON
@@ -87,20 +84,19 @@ module Fontcustom
       def collect_data
         @json = JSON.parse(@json, :symbolize_names => true)
         @data.merge! @json
-        @data[:glyphs].map! { |glyph| glyph.gsub(/\W/, "-").downcase }
+        @data[:glyphs].map! { |glyph| glyph.gsub(/\W/, "-") }
+        @data[:fonts].map! { |font| File.join(@opts[:output][:fonts], font) }
       end
 
       def announce_files
-        if opts[:verbose]
-          @data[:fonts].each { |file| shell.say_status(:create, File.join(opts[:output], file)) }
-        end
+        say_changed :created, @data[:fonts]
       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]
+        file = File.join(opts[:project_root], ".fontcustom-data")
+        clear_file(file)
+        append_to_file file, json, :verbose => false
       end
     end
   end

data/lib/fontcustom/generator/template.rb

@@ -1,16 +1,16 @@
 require "json"
+require "pathname"
 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. 
+      include 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 
+      argument :opts
 
       # Required for Thor::Actions#template
       def self.source_root
@@ -18,61 +18,76 @@ module Fontcustom
       end
 
       def get_data
-        data = File.join(opts[:output], ".fontcustom-data")
+        data = File.join(opts[:project_root], ".fontcustom-data")
         if File.exists? data
-          @data = JSON.parse(File.read(data), :symbolize_names => true) 
+          @data = JSON.parse(File.read(data), :symbolize_names => true)
         else
-          raise Fontcustom::Error, "There's no .fontcustom-data file in #{opts[:output]}. Try again?"
+          raise Fontcustom::Error, "There's no .fontcustom-data file in #{opts[:project_root]}. Try again?"
         end
-      rescue JSON::ParserError 
+      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)
+        raise Fontcustom::Error, "The .fontcustom-data file in #{opts[:project_root]} is empty or corrupted. Try deleting the file and running Fontcustom::Generator::Font again to regenerate .fontcustom-data."
       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]
+          @data[:templates].each do |file|
+            remove_file file, :verbose => false
             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
+          file = File.join(opts[:project_root], ".fontcustom-data")
+          clear_file(file)
+          append_to_file file, json, :verbose => false
+          say_changed :removed, deleted
+        end
+      end
+
+      def make_relative_paths
+        name = File.basename @data[:fonts].first, File.extname(@data[:fonts].first)
+        fonts = Pathname.new opts[:output][:fonts]
+        css = Pathname.new opts[:output][:css]
+        preview = Pathname.new opts[:output][:preview]
+        @data[:paths][:css_to_fonts] = File.join fonts.relative_path_from(css).to_s, name
+        @data[:paths][:preview_to_css] = File.join css.relative_path_from(preview).to_s, "fontcustom.css"
+        @data[:paths][:preprocessor_to_fonts] = if opts[:preprocessor_font_path] != ""
+          File.join opts[:preprocessor_font_path], name
+        else 
+          @data[:paths][:css_to_fonts]
         end
       end
 
       def generate
         @opts = opts # make available to templates
-        begin 
+        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
+            ext = File.extname name
+            target = if opts[:output].keys.include? name
+                       File.join opts[:output][name], name
+                     elsif %w|.css .scss .sass .less .stylus|.include? ext
+                       File.join opts[:output][:css], name
+                     elsif name == "fontcustom-preview.html"
+                       File.join opts[:output][:preview], name
+                     else
+                       File.join opts[:output][:fonts], name
+                     end
+
+            template source, target, :verbose => false
+            created << target
           end
         ensure
-          @data[:templates] = (@data[:templates] + created).uniq # TODO better way of cleaning up templates
+          @data[:templates] = (@data[:templates] + created).uniq
           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]
+          file = File.join(opts[:project_root], ".fontcustom-data")
+          clear_file(file)
+          append_to_file file, json, :verbose => false
+          say_changed :created, created
         end
       end
     end

data/lib/fontcustom/options.rb

@@ -1,21 +1,27 @@
+require "thor/core_ext/hash_with_indifferent_access"
+
 module Fontcustom
-  DEFAULT_OPTIONS = {
-    :input => Dir.pwd,
-    :output => false, # used to assign default, if necessary 
-    :config => false,
-    :templates => %w|css preview|, 
+  # :output and :config are build from arguments
+  DEFAULT_OPTIONS = Thor::CoreExt::HashWithIndifferentAccess.new({
+    :project_root => Dir.pwd,
+    :input => "",
+    :templates => %w|css preview|,
     :font_name => "fontcustom",
     :file_hash => true,
     :css_prefix => "icon-",
-    :font_face_path => false,
+    :preprocessor_font_path => "",
     :debug => false,
     :verbose => true
-  }
+  })
 
-  DATA_MODEL = {
+  DATA_MODEL = Thor::CoreExt::HashWithIndifferentAccess.new({
     :fonts => [],
     :templates => [],
-    :file_name => "",
-    :glyphs => []
-  }
+    :glyphs => [],
+    :paths => {
+      :css_to_fonts => "",
+      :preprocessor_to_fonts => "",
+      :preview_to_css => ""
+    }
+  })
 end

data/lib/fontcustom/scripts/generate.py

@@ -126,4 +126,4 @@ subprocess.call('ttfautohint -s -n ' + fontfile + '.ttf ' + fontfile + '-hinted.
 
 # 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})
+print json.dumps({'fonts': [outname + '.ttf', outname + '.woff', outname + '.eot', outname + '.svg'], 'glyphs': files})

data/lib/fontcustom/templates/_fontcustom-bootstrap-ie7.scss

@@ -1,6 +1,7 @@
-/* 
- * Font Custom: Bootstrap CSS for IE7
- */
+//
+// Icon Font: <%= @opts[:font_name] %>
+// Bootstrap IE7 Enabler
+//
 
 [class^="<%= @opts[:css_prefix] %>"],
 [class*=" <%= @opts[:css_prefix] %>"] {

data/lib/fontcustom/templates/_fontcustom-bootstrap.scss

@@ -1,20 +1,15 @@
-<%
-file_name = if @opts[:font_face_path]
-  File.join @opts[:font_face_path], @data[:file_name]
-else
-  @data[:file_name]
-end
-%>/*
- * Font Custom: Bootstrap CSS
- */
+//
+// Icon Font: <%= @opts[:font_name] %>
+// Bootstrap Override
+//
 
 @font-face {
   font-family: "<%= @opts[:font_name] %>";
-  src: url("<%= file_name %>.eot");
-  src: url("<%= file_name %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= file_name %>.woff") format("woff"),
-       url("<%= file_name %>.ttf") format("truetype"),
-       url("<%= file_name %>.svg#<%= @opts[:font_name] %>") format("svg");
+  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot");
+  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @data[:paths][:preprocessor_to_fonts] %>.woff") format("woff"),
+       url("<%= @data[:paths][:preprocessor_to_fonts] %>.ttf") format("truetype"),
+       url("<%= @data[:paths][:preprocessor_to_fonts] %>.svg#<%= @opts[:font_name] %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }