fontcustom 1.1.0.pre → 1.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d394a232cd9bca5b67961598fe0696c677241fdf
-  data.tar.gz: 33d86584a9255b4a937551c69342718bde7e7134
+  metadata.gz: 50485d013861fa91e2ae86ed2741630ad3b285ff
+  data.tar.gz: 5b30887bf48000f2faf726c1995fea6f2bcb9ba8
 SHA512:
-  metadata.gz: f96ad328c2b67b55eb1379bb362ee42c6e2240a7566976dae7abb615b737da7d6c36d8f1fc23a13d6cb644e65ad8dab5b2d60a5a988c5e5776cc99c37bd0b667
-  data.tar.gz: c1126c9542867c77421d60c04afacf87eaa9844747d833e5b6dc74c23a312212dcf846560ed2282efdc0e1ea015706ff1da5f2acbbcaab5fa8e154c05d6b3268
+  metadata.gz: ac4e3f33a7748d4884995e8bdd3725dfb71bc51c1642ebd4d57fd1c9a2ac695c6b1775c73d276aec5b973bbd4316c0bf2b304a5f5939ce3cc798b57dfb36af5e
+  data.tar.gz: a768dd51e28c43b2f3634ecb0b082edde1510a34f563c1598a4ee9add5e8708ab2141d867284c99759ee8628e8d47bff2190572932fcbe6e3d3611fbbc9f36e4

data/TODO.md

@@ -1,6 +1,21 @@
-## TODO
+# 1.1.0 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
+* Investigate initial update to .fontcustom-data
+* Verify all templates work
+
+* Include pull requests
+* Allow absolute paths
+* Abstract path expansion into Util
+* Improve paths in messages (wrap in ticks)
+* Improve error messages in Watcher and Fontcustom.rb
+
+# Maybe
+
+* Option to set icon canvas size (auto, string, or hash)
+* `fontcustom clean`
+
+* Have error messages `say_status` themselves?
+* Change outputed filenames to reflect font name
+* On install hook / message to remind about installing fontforge
+* --silent instead of (or alongside?) --verbose
+* Configure colors for thor say

data/lib/fontcustom.rb

@@ -1,21 +1,59 @@
 require "fontcustom/version"
-require "fontcustom/options"
 require "fontcustom/error"
+require "fontcustom/options"
 require "fontcustom/util"
-require "fontcustom/actions"
 require "fontcustom/generator/font"
 require "fontcustom/generator/template"
+require "thor/core_ext/hash_with_indifferent_access"
 
 module Fontcustom
   ##
   # Clean Ruby API to workaround Thor
   def compile(options)
-    opts = Fontcustom::Util.collect_options options
+    opts = Fontcustom::Options.new options
     Fontcustom::Generator::Font.start [opts]
     Fontcustom::Generator::Template.start [opts]
   rescue Fontcustom::Error => e
     puts "ERROR: #{e.message}"
   end
 
-  module_function :compile
+  def gem_lib
+    File.expand_path(File.join(File.dirname(__FILE__), "fontcustom"))
+  end
+
+  module_function :compile, :gem_lib
+
+  ##
+  # These are used in Thor CLI but overridden when the Options class is built
+  EXAMPLE_OPTIONS = {
+    :project_root => "`pwd`",
+    :output => "PROJECT_ROOT/FONT_NAME"
+  }
+
+  ##
+  # 
+  DEFAULT_OPTIONS = Thor::CoreExt::HashWithIndifferentAccess.new({
+    :project_root => Dir.pwd,
+    :input => nil,
+    :output => nil,
+    :config => nil,
+    :data_cache => nil,
+    :templates => %w|css preview|,
+    :font_name => "fontcustom",
+    :file_hash => true,
+    :css_prefix => "icon-",
+    :preprocessor_path => "",
+    :debug => false,
+    :verbose => true
+  })
+
+  DATA_MODEL = Thor::CoreExt::HashWithIndifferentAccess.new({
+    :fonts => [],
+    :templates => [],
+    :glyphs => [],
+    :paths => {
+      :css_to_fonts => "",
+      :preprocessor_to_fonts => ""
+    }
+  })
 end

data/lib/fontcustom/cli.rb

@@ -5,53 +5,93 @@ require "fontcustom/watcher"
 
 module Fontcustom
   class CLI < Thor
-    include Thor::Actions
-
-    # Actual defaults are stored in Fontcustom::DEFAULT_OPTIONS instead of Thor
-    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 :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 verbose messages. Default: true"
+    include Actions
+
+    default_task :show_help
+
+    class_option :project_root, :aliases => "-r", :type => :string,
+      :desc => "The root context for any relative paths (INPUT, OUTPUT, CONFIG).",
+      :default => EXAMPLE_OPTIONS[:project_root]
+
+    class_option :output, :aliases => "-o", :type => :string,
+      :desc => "Where generated files are saved. Can be fine-tuned if a configuration file is used.",
+      :default => EXAMPLE_OPTIONS[:output]
+
+    class_option :config, :aliases => "-c", :type => :string,
+      :desc => "Optional configuration file. PROJECT_ROOT/fontcustom.yml and PROJECT_ROOT/config/fontcustom.yml are loaded automatically."
+
+    class_option :data_cache, :aliases => "-d", :type => :string,
+      :desc => "Optional path to `.fontcustom-data`. Used for garbage collection."
+
+    class_option :templates, :aliases => "-t", :type => :array,
+      :desc => "Space-delinated array of templates to generate alongside fonts.",
+      :enum => %w|preview css scss scss-rails bootstrap bootstrap-scss bootstrap-ie7 bootstrap-ie7-scss|,
+      :default => DEFAULT_OPTIONS[:templates]
+
+    class_option :font_name, :aliases => "-f", :type => :string,
+      :desc => "Set the font's name.",
+      :default => DEFAULT_OPTIONS[:font_name]
+
+    class_option :css_prefix, :aliases => "-p", :type => :string,
+      :desc => "Prefix for each glyph's CSS class.",
+      :default => DEFAULT_OPTIONS[:css_prefix]
+
+    class_option :preprocessor_path, :aliases => "-s", :type => :string,
+      :desc => "Special path used in CSS proprocessor templates."
+
+    # TODO make this negative (no file hash)
+    class_option :file_hash, :type => :boolean,
+      :desc => "Option to generate font files with asset-busting hashes.",
+      :default => DEFAULT_OPTIONS[:file_hash]
+
+    class_option :debug, :type => :boolean,
+      :desc => "Display debug messages from fontforge.",
+      :default => DEFAULT_OPTIONS[:debug]
+
+    class_option :verbose, :type => :boolean,
+      :desc => "Display verbose messages.",
+      :default => DEFAULT_OPTIONS[:verbose]
 
     # Required for Thor::Actions#template
     def self.source_root
-      File.join Fontcustom::Util.gem_lib_path, "templates"
+      File.join Fontcustom.gem_lib, "templates"
     end
 
-    desc "compile [INPUT] [OPTIONS]", "Generates webfonts and CSS from *.svg and *.eps files in INPUT."
+    desc "compile [INPUT] [OPTIONS]", "Generates webfonts and templates from *.svg and *.eps files in INPUT. Default: `pwd`"
     def compile(input = nil)
       opts = options.merge :input => input
-      opts = Fontcustom::Util.collect_options opts
+      opts = Fontcustom::Options.new(opts)
       Fontcustom::Generator::Font.start [opts]
       Fontcustom::Generator::Template.start [opts]
     rescue Fontcustom::Error => e
-      puts "ERROR: #{e.message}"
+      say_status :error, e.message
     end
 
-    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"
+    desc "watch [INPUT] [OPTIONS]", "Watches INPUT for changes and regenerates files automatically. Ctrl + C to stop. Default: `pwd`"
+    method_option :skip_first, :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
+      opts = Fontcustom::Options.new(opts)
       Fontcustom::Watcher.new(opts).watch
     rescue Fontcustom::Error => e
-      puts "ERROR: #{e.message}"
+      say_status :error, e.message
     end
 
-    desc "config [DIR]", "Adds an annotated fontcustom.yml to DIR. Default: working directory"
+    desc "config [DIR]", "Generates an annotated configuration file (fontcustom.yml) in DIR. Default: `pwd`"
     def config(dir = Dir.pwd)
       template "fontcustom.yml", File.join(dir, "fontcustom.yml")
     end
 
-    desc "version", "Shows the version information."
-    def version
-      puts "fontcustom-#{Fontcustom::VERSION}"
+    desc "hidden", "hidden", :hide => true
+    method_option :version, :aliases => "-v", :type => :boolean, :default => false
+    def show_help
+      if options[:version]
+        puts "fontcustom-#{Fontcustom::VERSION}"
+      else
+        help
+      end
     end
   end
 end

data/lib/fontcustom/generator/font.rb

@@ -1,35 +1,36 @@
 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 Actions
+      include Util
+      include Thor::Actions
 
-      # Instead of passing each option individually we're passing the entire options hash as an argument. 
+      # 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
 
       def prepare_output_dirs
-        dirs = opts[:output].values.uniq
+        dirs = opts.output.values.uniq
         dirs.each do |dir|
           unless File.directory? dir
-            empty_directory dir, :verbose => opts[:verbose]
+            empty_directory dir, :verbose => opts.verbose
           end
         end
       end
 
       def get_data
-        datafile = File.join opts[:project_root], ".fontcustom-data"
-        if File.exists? datafile
+        if File.exists? opts.data_cache
           begin
-            data = File.read datafile
+            data = File.read opts.data_cache
             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."
+            raise Fontcustom::Error, "#{opts.data_cache} is corrupted. Fix the JSON or delete the file to start from scratch."
           end
         else
           @data = Fontcustom::DATA_MODEL.dup
@@ -40,38 +41,39 @@ module Fontcustom
         return if @data[:fonts].empty?
         begin
           deleted = []
-          @data[:fonts].each do |file| 
+          @data[:fonts].each do |file|
             remove_file file, :verbose => false
             deleted << file
           end
         ensure
           @data[:fonts] = @data[:fonts] - deleted
           json = JSON.pretty_generate @data
-          file = File.join(opts[:project_root], ".fontcustom-data")
-          clear_file(file)
-          append_to_file file, json, :verbose => false
-          say_changed :removed, deleted
+          overwrite_file opts.data_cache, json
+          say_changed :delete, deleted
         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][:vectors]} #{opts[:output][:fonts] + name + hash} 2>&1"
+        name = opts.font_name ? " --name " + opts.font_name : ""
+        hash = opts.file_hash ? "" : " --nohash"
+        cmd = "fontforge -script #{Fontcustom.gem_lib}/scripts/generate.py #{opts.input[:vectors]} #{opts.output[:fonts] + name + hash} 2>&1"
 
         output = `#{cmd}`.split("\n")
         @json = output[3] # JSON
+
+        # fontforge wrongly returns the following error message if only a single glyph.
+        # We can strip it out and ignore it.
         if @json == 'Warning: Font contained no glyphs'
           @json = output[4]
-          output = output[5..-1] # Strip fontforge message
+          output = output[5..-1]
         else
           @json = output[3]
-          output = output[4..-1] # Strip fontforge message
+          output = output[4..-1]
         end
 
-        if opts[:debug]
+        if opts.debug
           shell.say "DEBUG: (raw output from fontforge)"
           shell.say output
         end
@@ -85,18 +87,16 @@ module Fontcustom
         @json = JSON.parse(@json, :symbolize_names => true)
         @data.merge! @json
         @data[:glyphs].map! { |glyph| glyph.gsub(/\W/, "-") }
-        @data[:fonts].map! { |font| File.join(@opts[:output][:fonts], font) }
+        @data[:fonts].map! { |font| File.join(opts.output[:fonts], font) }
       end
 
       def announce_files
-        say_changed :created, @data[:fonts]
+        say_changed :create, @data[:fonts]
       end
 
       def save_data
         json = JSON.pretty_generate @data
-        file = File.join(opts[:project_root], ".fontcustom-data")
-        clear_file(file)
-        append_to_file file, json, :verbose => false
+        overwrite_file opts.data_cache, json
       end
     end
   end

data/lib/fontcustom/generator/template.rb

@@ -2,11 +2,13 @@ require "json"
 require "pathname"
 require "thor"
 require "thor/group"
+require "thor/actions"
 
 module Fontcustom
   module Generator
     class Template < Thor::Group
-      include Actions
+      include Util
+      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.
@@ -14,19 +16,18 @@ module Fontcustom
 
       # Required for Thor::Actions#template
       def self.source_root
-        File.join Fontcustom::Util.gem_lib_path, "templates"
+        File.join Fontcustom.gem_lib, "templates"
       end
 
       def get_data
-        data = File.join(opts[:project_root], ".fontcustom-data")
-        if File.exists? data
-          @data = JSON.parse(File.read(data), :symbolize_names => true)
+        if File.exists? opts.data_cache
+          @data = JSON.parse(File.read(opts.data_cache), :symbolize_names => true)
         else
-          raise Fontcustom::Error, "There's no .fontcustom-data file in #{opts[:project_root]}. Try again?"
+          raise Fontcustom::Error, "#{relative_to_root(opts.data_cache)} is required to generate templates, but I couldn't find it."
         end
       rescue JSON::ParserError
         # Catches both empty and and malformed files
-        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."
+        raise Fontcustom::Error, "#{relative_to_root(opts.data_cache)} is empty or corrupted. Try deleting the file and running Fontcustom::Generator::Font again to regenerate the data file. Old generated files may need to be deleted manually."
       end
 
       def reset_output
@@ -40,54 +41,52 @@ module Fontcustom
         ensure
           @data[:templates] = @data[:templates] - deleted
           json = JSON.pretty_generate @data
-          file = File.join(opts[:project_root], ".fontcustom-data")
-          clear_file(file)
-          append_to_file file, json, :verbose => false
-          say_changed :removed, deleted
+          overwrite_file opts.data_cache, json
+          say_changed :delete, 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]
+        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][:preview_to_fonts] = File.join fonts.relative_path_from(preview).to_s, name
+        @data[:paths][:preprocessor_to_fonts] = if opts.preprocessor_path != ""
+          File.join opts.preprocessor_path, name
+        else
           @data[:paths][:css_to_fonts]
         end
       end
 
       def generate
-        @opts = opts # make available to templates
+        @glyphs = @data[:glyphs]
+        @font_path = @data[:paths][:css_to_fonts]
+        @font_path_pre = @data[:paths][:preprocessor_to_fonts]
         begin
           created = []
-          opts[:templates].each do |source|
+          opts.templates.each do |source|
             name = File.basename source
-            ext = File.extname name
-            target = if opts[:output].keys.include? name
-                       File.join opts[:output][name], name
+            ext = File.extname source
+            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
+                       File.join opts.output[:css], name
                      elsif name == "fontcustom-preview.html"
-                       File.join opts[:output][:preview], name
+                       File.join opts.output[:preview], name
                      else
-                       File.join opts[:output][:fonts], name
+                       File.join opts.output[:fonts], name
                      end
 
             template source, target, :verbose => false
             created << target
           end
         ensure
+          say_changed :create, created
           @data[:templates] = (@data[:templates] + created).uniq
           json = JSON.pretty_generate @data
-          file = File.join(opts[:project_root], ".fontcustom-data")
-          clear_file(file)
-          append_to_file file, json, :verbose => false
-          say_changed :created, created
+          overwrite_file opts.data_cache, json
         end
       end
     end