fontcustom 1.1.0.pre2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50485d013861fa91e2ae86ed2741630ad3b285ff
-  data.tar.gz: 5b30887bf48000f2faf726c1995fea6f2bcb9ba8
+  metadata.gz: 3c910ad06fd6a63497415cf449da20e6c72f3471
+  data.tar.gz: 85b86e23d8aed1278bacede23d4f9c8980408df6
 SHA512:
-  metadata.gz: ac4e3f33a7748d4884995e8bdd3725dfb71bc51c1642ebd4d57fd1c9a2ac695c6b1775c73d276aec5b973bbd4316c0bf2b304a5f5939ce3cc798b57dfb36af5e
-  data.tar.gz: a768dd51e28c43b2f3634ecb0b082edde1510a34f563c1598a4ee9add5e8708ab2141d867284c99759ee8628e8d47bff2190572932fcbe6e3d3611fbbc9f36e4
+  metadata.gz: 4e82e218abb14391f1c9c3f95e4da315417052ca6675604dbdc50eae9bac0df27c1d543131023d796db1a53b892d135b5854ad7e0bcc4cadc6e3baf3e8f4e98f
+  data.tar.gz: 7b73f06d71838bdb39064a1f8fdc628db26a99056150e363e105e1d308fbca274c5c14add4ee9855ac51885d41508c0bd3689710298650d68673c05ba6691087

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.1.0 (9/22/2013)
+
+More customizable interface for vastly improved workflow.
+
+* Specify where input vectors/templates are stored ([#89](https://github.com/FontCustom/fontcustom/issues/89))
+* Specify where output fonts/templates are saved ([#89](https://github.com/FontCustom/fontcustom/issues/89))
+* Stock templates are saved as `#{font_name}.css` instead of `_fontcustom.css`
+* More robust path handling (relative paths, customizable `project_root`)
+* User-friendly variables for usage in custom templates
+* Rails-friendly template
+* Enable HTML data-attributes usage ([#118](https://github.com/FontCustom/fontcustom/pull/118))
+* Helper characters in preview ([#107](https://github.com/FontCustom/fontcustom/pull/107))
+* More robust execution of fontforge command ([#114](https://github.com/FontCustom/fontcustom/pull/114))
+* Allow captial letters in font names ([#92](https://github.com/FontCustom/fontcustom/issues/92))
+* More helpful, colorful messages
+* More intuitive flags (`--verbose=false` => `--quiet`, `--file-hash=false` => `--no-hash`)
+* More intuitive version (`fontcustom version` => `fontcustom --version`) ([#115](https://github.com/FontCustom/fontcustom/issues/115))
+
 ## 1.0.1 (7/21/2013)
 
 Various bugfixes.

data/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributor Guidelines
 
-Thanks for helping make Font Custom 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.
+Thanks for helping make Font Custom better. This project was born out of an overheard conversation between two devs in a NYC coffee shop — it's come a long ways thanks to the support of folks like you.
 
 ## Conventions
 
@@ -11,8 +11,7 @@ If you catch a typo or a particularly unsightly piece of code — please _do_ le
 ## Process
 
 * Visit [issues](https://github.com/FontCustom/fontcustom/issues) for ideas.
-* Fork the repo if you haven't done so already.
-* `master` == current stable release
+* Fork the repo.
 * Create a topic branch. `git checkout -b my_sweet_feature`
 * Add your tests. Run tests with `rake`.
 * Develop your feature.

data/README.md

@@ -1,6 +1,6 @@
-# FontCustom v1.0.1
+# FontCustom v1.1.0
 
-**Generate custom icon webfonts from the comfort of the command line.**
+**Generate icon webfonts from the comfort of the command line.**
 
 [Full documentation](http://fontcustom.com)<br/>
 [Changelog](https://github.com/FontCustom/fontcustom/blob/master/CHANGELOG.md)<br/>
@@ -17,21 +17,46 @@ gem install fontcustom
 ## Quick Start
 
 ```sh
-fontcustom compile path/to/vectors                  # Compiles into `fontcustom`
-fontcustom compile path/to/vectors -o assets/fonts  # Compiles into `assets/fonts`
-fontcustom watch path/to/vectors -t=scss preview    # Compiles when vectors are changed/added/deleted
-                                                    # and includes a scss partial and glyph preview
+fontcustom compile path/to/vectors  # Compiles icons into `fontcustom/`
+fontcustom watch path/to/vectors    # Compiles when vectors are changed/added/removed
 
-fontcustom help                                     # to see all options
+fontcustom compile                  # Uses configuration options from `fontcustom.yml`
+fontcustom watch                    # or `config/fontcustom.yml`
+
+fontcustom help                     # See all options
 ```
 
-## Config
+## Configuration
 
-To avoid finger-fatigue, include a fontcustom.yml configuration file with your vectors:
+To avoid finger-fatigue, create a configuration file with `fontcustom config`. Typically, this should live in the directory where you plan on running `fontcustom` commands.
 
-```sh
-fontcustom config path/to/vectors       # Creates annotated config file
-vim path/to/vectors/fontcustom.yml      # Edit your fontcustom options
+```yml
+# Available Options (defaults shown)
+font_name: fontcustom                 # Names the font (also sets name and directory of generated files)
+project_root: (working dir)           # Context for all relative paths
+input: (project_root)                 # Where vectors and templates are located
+output: (project_root)/(font name)    # Where generated files will be saved
+file_hash: true                       # Include an asset-busting hash
+css_prefix: icon-                     # CSS class prefix
+preprocessor_path: ""                 # Font path used in CSS proprocessor templates
+data_cache: (same as fontcustom.yml)  # Sets location of data file
+debug: false                          # Output raw messages from fontforge
+verbose: true                         # Set to false to silence
+templates: [ css, preview ]           # Templates to generate alongside fonts
+                                      # Possible values: preview, css, scss, scss-rails, bootstrap, 
+                                      # bootstrap-scss, bootstrap-ie7, bootstrap-ie7-scss
+
+# Advanced input/output
+#   Set input or output as a hash for more control
+input:
+  vectors: path/to/vectors            # required
+  templates: path/to/templates
+
+output:
+  fonts: app/assets/fonts             # required
+  css: app/assets/stylesheets
+  preview: app/views/styleguide
+  custom-template.yml: custom/path    # set paths of custom templates by referencing their file name
 ```
 
 ---

data/Rakefile

@@ -1,8 +1,8 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new 'spec' do |s|
-  s.rspec_opts = '--color --format documentation'
+RSpec::Core::RakeTask.new "spec" do |s|
+  s.rspec_opts = "--color --format documentation"
 end
 
 task :default => :spec

data/fontcustom.gemspec

@@ -1,27 +1,28 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fontcustom/version'
+require "fontcustom/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "fontcustom"
   gem.version       = Fontcustom::VERSION
   gem.authors       = ["Kai Zau", "Joshua Gross"]
   gem.email         = ["kai@kaizau.com", "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 CSS (or any custom template) for easy inclusion in your projects.}
+  gem.summary       = "Generate icon webfonts from the comfort of the command line."
+  gem.description   = "Transforms EPS and SVG vectors into icon webfonts. Generates CSS or other template files for your projects."
   gem.homepage      = "http://fontcustom.com"
+  gem.post_install_message = "  >> Thanks for installing Font Custom! Please ensure that fontforge is installed before compiling any icons."
 
   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', '~>1.8.0'
-  gem.add_dependency 'thor', '~>0.18.1'
-  gem.add_dependency 'listen', '~>1.2.2'
+  gem.add_dependency "json", "~>1.8.0"
+  gem.add_dependency "thor", "~>0.18.1"
+  gem.add_dependency "listen", "~>1.3.1"
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rspec"
 end

data/lib/fontcustom.rb

@@ -1,20 +1,19 @@
 require "fontcustom/version"
 require "fontcustom/error"
-require "fontcustom/options"
 require "fontcustom/util"
+require "fontcustom/options"
 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::Options.new options
-    Fontcustom::Generator::Font.start [opts]
-    Fontcustom::Generator::Template.start [opts]
+    opts = Options.new options
+    Generator::Font.start [opts]
+    Generator::Template.start [opts]
   rescue Fontcustom::Error => e
-    puts "ERROR: #{e.message}"
+    opts.say_message :error, e.message, :red
   end
 
   def gem_lib
@@ -27,33 +26,30 @@ module Fontcustom
   # These are used in Thor CLI but overridden when the Options class is built
   EXAMPLE_OPTIONS = {
     :project_root => "`pwd`",
-    :output => "PROJECT_ROOT/FONT_NAME"
+    :output => "PROJECT_ROOT/FONT_NAME",
+    :config => "PROJECT_ROOT/fontcustom.yml OR PROJECT_ROOT/config/fontcustom.yml",
+    :templates => "css preview",
+    :data_cache => "CONFIG_DIR/.fontcustom-data OR at PROJECT_ROOT/.fontcustom-data"
   }
 
-  ##
-  # 
-  DEFAULT_OPTIONS = Thor::CoreExt::HashWithIndifferentAccess.new({
+  DEFAULT_OPTIONS = {
     :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 => "",
+    :data_cache => nil,
+    :preprocessor_path => nil,
+    :no_hash => false,
     :debug => false,
-    :verbose => true
-  })
+    :quiet => false
+  }
 
-  DATA_MODEL = Thor::CoreExt::HashWithIndifferentAccess.new({
+  DATA_MODEL = {
     :fonts => [],
     :templates => [],
-    :glyphs => [],
-    :paths => {
-      :css_to_fonts => "",
-      :preprocessor_to_fonts => ""
-    }
-  })
+    :glyphs => []
+  }
 end

data/lib/fontcustom/cli.rb

@@ -5,52 +5,50 @@ require "fontcustom/watcher"
 
 module Fontcustom
   class CLI < Thor
-    include Actions
+    include Thor::Actions
 
     default_task :show_help
 
     class_option :project_root, :aliases => "-r", :type => :string,
-      :desc => "The root context for any relative paths (INPUT, OUTPUT, CONFIG).",
+      :desc => "The root context for 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.",
+      :desc => "Where generated files are saved. Set different locations for different file types via a configuration file.",
       :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."
+      :desc => "Optional path to a configuration file.",
+      :default => EXAMPLE_OPTIONS[:config]
 
     class_option :templates, :aliases => "-t", :type => :array,
-      :desc => "Space-delinated array of templates to generate alongside fonts.",
+      :desc => "Space-delinated list 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]
+      :default => EXAMPLE_OPTIONS[:templates]
 
     class_option :font_name, :aliases => "-f", :type => :string,
-      :desc => "Set the font's name.",
+      :desc => "The font's name. Also determines the file names of generated templates.",
       :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 :data_cache, :aliases => "-d", :type => :string,
+      :desc => "Path to a manifest of generated files. Used for garbage collection.",
+      :default => EXAMPLE_OPTIONS[:data_cache]
+
     class_option :preprocessor_path, :aliases => "-s", :type => :string,
-      :desc => "Special path used in CSS proprocessor templates."
+      :desc => "Optional font path for 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 :no_hash, :aliases => "-h", :type => :boolean,
+      :desc => "Generate fonts without asset-busting hashes."
 
-    class_option :debug, :type => :boolean,
-      :desc => "Display debug messages from fontforge.",
-      :default => DEFAULT_OPTIONS[:debug]
+    class_option :debug, :aliases => "-g", :type => :boolean,
+      :desc => "Display debugging messages."
 
-    class_option :verbose, :type => :boolean,
-      :desc => "Display verbose messages.",
-      :default => DEFAULT_OPTIONS[:verbose]
+    class_option :quiet, :aliases => "-q", :type => :boolean,
+      :desc => "Hide status messages."
 
     # Required for Thor::Actions#template
     def self.source_root
@@ -60,23 +58,24 @@ module Fontcustom
     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::Options.new(opts)
-      Fontcustom::Generator::Font.start [opts]
-      Fontcustom::Generator::Template.start [opts]
+      opts = Options.new(opts)
+      Generator::Font.start [opts]
+      Generator::Template.start [opts]
     rescue Fontcustom::Error => e
-      say_status :error, e.message
+      opts.say_message :error, e.message, :red
     end
 
     desc "watch [INPUT] [OPTIONS]", "Watches INPUT for changes and regenerates files automatically. Ctrl + C to stop. Default: `pwd`"
-    method_option :skip_first, :type => :boolean, 
+    method_option :skip_first, :type => :boolean,
       :desc => "Skip the initial compile upon watching.",
       :default => false
     def watch(input = nil)
+      say "Font Custom is watching your icons. Press Ctrl + C to stop.", :yellow unless options[:quiet]
       opts = options.merge :input => input, :skip_first => !! options[:skip_first]
-      opts = Fontcustom::Options.new(opts)
-      Fontcustom::Watcher.new(opts).watch
+      opts = Options.new(opts)
+      Watcher.new(opts).watch
     rescue Fontcustom::Error => e
-      say_status :error, e.message
+      opts.say_message :error, e.message, :red
     end
 
     desc "config [DIR]", "Generates an annotated configuration file (fontcustom.yml) in DIR. Default: `pwd`"
@@ -88,7 +87,7 @@ module Fontcustom
     method_option :version, :aliases => "-v", :type => :boolean, :default => false
     def show_help
       if options[:version]
-        puts "fontcustom-#{Fontcustom::VERSION}"
+        puts "fontcustom-#{VERSION}"
       else
         help
       end

data/lib/fontcustom/generator/font.rb

@@ -1,8 +1,8 @@
 require "json"
+require "open3"
 require "thor"
 require "thor/group"
 require "thor/actions"
-require "thor/core_ext/hash_with_indifferent_access"
 
 module Fontcustom
   module Generator
@@ -18,7 +18,7 @@ module Fontcustom
         dirs = opts.output.values.uniq
         dirs.each do |dir|
           unless File.directory? dir
-            empty_directory dir, :verbose => opts.verbose
+            empty_directory dir, :verbose => ! opts.quiet
           end
         end
       end
@@ -28,9 +28,9 @@ module Fontcustom
           begin
             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, "#{opts.data_cache} is corrupted. Fix the JSON or delete the file to start from scratch."
+            @data = data.is_a?(Hash) ? symbolize_hash(data) : Fontcustom::DATA_MODEL.dup
+          rescue
+            raise Fontcustom::Error, "Couldn't parse `#{relative_to_root(opts.data_cache)}`. Delete it to start from scratch. Any previously generated files will need to be deleted manually."
           end
         else
           @data = Fontcustom::DATA_MODEL.dup
@@ -54,38 +54,18 @@ module Fontcustom
       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.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]
-        else
-          @json = output[3]
-          output = output[4..-1]
-        end
-
-        if opts.debug
-          shell.say "DEBUG: (raw output from fontforge)"
-          shell.say output
-        end
-
-        unless $?.success?
-          raise Fontcustom::Error, "Compilation failed unexpectedly. Check your options and try again with --debug get more details."
-        end
+        cmd = "fontforge -script #{Fontcustom.gem_lib}/scripts/generate.py #{opts.input[:vectors]} #{opts.output[:fonts]} --name #{opts.font_name}" 
+        cmd += " --nohash" if opts.no_hash
+        cmd += " --debug" if opts.debug
+        output, err, status = execute_and_clean(cmd)
+        @json = output.delete_at(0)
+        say_status :debug, "#{err}\n#{' ' * 14}#{output}", :red if opts.debug
+        raise Fontcustom::Error, "`fontforge` compilation failed. Try again with --debug for more details." unless status.success?
       end
 
       def collect_data
-        @json = JSON.parse(@json, :symbolize_names => true)
-        @data.merge! @json
+        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) }
       end
@@ -98,6 +78,15 @@ module Fontcustom
         json = JSON.pretty_generate @data
         overwrite_file opts.data_cache, json
       end
+
+      private
+
+      def execute_and_clean cmd
+        stdout, stderr, status = Open3::capture3(cmd)
+        stdout = stdout.split("\n")
+        stdout = stdout[1..-1] if stdout[0] == "CreateAllPyModules()"
+        [stdout, stderr, status]
+      end
     end
   end
 end