fontcustom 1.3.0.beta → 1.3.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1abf5b322a257728ac1e293a8392f3592e9954b7
-  data.tar.gz: cb6b2ca5e590ae76878050e2317ab7de0cd74041
+  metadata.gz: a89156ba7ef7d8a12424e06e6768e0973270b6cf
+  data.tar.gz: 83bbb3c5f0aa93ab04b089e642f1b57e3f9bc04d
 SHA512:
-  metadata.gz: 0476cea6aef78118bf1fd85caa008d3de5b2ab465c92619a639eec104ec98178072d4f231a3d1ffee152031f28f9814ad3f2a51fc00c2c5a6a1f1312f2093be4
-  data.tar.gz: 40046d513e692b44bf504969844f48fe905b79b67f7cb9c5b5fe4f5b8ef3a32cc6bde44d83f6173a876956a402d1be5c9fc637b059f532aa6803055c46360155
+  metadata.gz: 576122be6d77bcdf8fc9f4b577fc124b84efabd8370121404b9f137263f1d315f69e1a48d975a90cb37a1bb2be19af0655250ced8fb52d14d9f38c303f531c36
+  data.tar.gz: d1f6317e39596082c8c9ffe884f227a62867590140eb548cade80bf3f50d4dcd966296a29a4a62bd0ef7c0fa3a10a9ffe310ee9199a20020abb13e03f85dace1

data/CHANGELOG.md

@@ -1,18 +1,18 @@
 ## 1.3.0.beta (11/25/2013)
 
-The big news: fixed glyph code points. Automatically assigned for now, but changing them by hand is just a matter of modifying the generated `.fontcustom-manifest.json`.
+**Delete your old `.fontcustom-manifest.json` and output directories before using this version.**
 
-Lots of internal changes / streamlining on this one. A few breaking changes (`css_prefix`, custom template syntax, possibly others). Error messages and docs are still a bit sparse — my apologies in advance.
+The big news: fixed glyph code points. Automatically assigned for now, but changing them by hand is just a matter of modifying the generated `.fontcustom-manifest.json`. A few breaking changes (`css_prefix`, custom template syntax, possibly others). Error messages and docs are currently sparse — my apologies in advance.
 
 * Fixed glyph code points ([#56](https://github.com/FontCustom/fontcustom/issues/56))
 * Changes `css_prefix` to `css_selector` to allow greater flexibility ([#126](https://github.com/FontCustom/fontcustom/pull/126))
 * Skips compilation if inputs have not changed (and `force` option to bypass checks)
 * Adds CSS template helpers for convenience and DRYness
-* Drops bootstrap templates (maintaince overhead, unsure if anyone was using them)
+* Drops bootstrap templates (maintenance overhead, unsure if anyone was using them)
 
 Next up:
 
-* Storing relative paths in the manifest for collaborative editing ([#149](https://github.com/FontCustom/fontcustom/pull/149))
+* Storing relative paths for collaborative editing ([#149](https://github.com/FontCustom/fontcustom/pull/149))
 
 ## 1.2.0 (11/2/2013)
 

data/README.md

@@ -6,12 +6,10 @@
 
 **Icon fonts from the command line.**
 
-Generate cross-browser compatible icon fonts and supporting files (e.g.
-@font-face CSS) from a collection of SVGs.
+Generate cross-browser icon fonts and supporting files (@font-face CSS, etc.) from a collection of SVGs.
 
-[Documentation](http://fontcustom.com)<br/>
-[Changelog](https://github.com/FontCustom/fontcustom/blob/master/CHANGELOG.md)<br/>
-[Support](https://github.com/FontCustom/fontcustom/issues)<br/>
+[Changelog](https://github.com/FontCustom/fontcustom/blob/master/CHANGELOG.md)<br>
+[Bugs/Support](https://github.com/FontCustom/fontcustom/issues)<br>
 [Contribute!](https://github.com/FontCustom/fontcustom/blob/master/CONTRIBUTING.md)
 
 ### Installation
@@ -35,10 +33,8 @@ gem install fontcustom
 ```sh
 fontcustom compile path/to/vectors  # Compiles icons into `fontcustom/`
 fontcustom watch path/to/vectors    # Compiles when vectors are changed/added/removed
-
-fontcustom compile                  # Uses configuration options from `fontcustom.yml`
-fontcustom watch
-
+fontcustom compile                  # Uses configuration file at `fontcustom.yml`
+                                    # or `config/fontcustom.yml`
 fontcustom config                   # Generate a blank a configuration file
 fontcustom help                     # See all options
 ```
@@ -47,10 +43,11 @@ fontcustom help                     # See all options
 
 To preserve options between compiles, create a configuration file with
 `fontcustom config`. This should live in the directory where you plan on
-running `fontcustom` commands.
+running `fontcustom` commands. Most of the following can also be used as
+command line flags (`--css-selector`, etc.).
 
 ```yml
-# General Options (defaults shown)
+# (defaults shown)
 font_name: fontcustom                 # Names the font and sets the name and directory
                                       # of generated files
 project_root: (pwd)                   # Context for all relative paths
@@ -58,16 +55,15 @@ input: (project_root)                 # Where vectors and templates are located
 output: (project_root)/(font name)    # Where generated files will be saved
 config: (pwd)/fontcustom.yml          # Optional path to a configuration file
 templates: [ css, preview ]           # Templates to generate alongside fonts
-                                      # Possible values: preview, css, scss,
-                                      # scss-rails, bootstrap, bootstrap-scss,
-                                      # bootstrap-ie7, bootstrap-ie7-scss
-css_prefix: icon-                     # CSS class prefix
-no_hash: false                        # Don't add asset-busting hashes
-preprocessor_path: ""                 # Font path used in CSS proprocessor templates
+                                      # Possible values: preview, css, scss, scss-rails
+css_selector: .icon-{{glyph}}         # Template for CSS classes
+                                      6
+preprocessor_path: ""                 # Font path used in proprocessor templates (Sass, etc.)
+no_hash: false                        # Don't add asset-busting hashes to font files
 autowidth: false                      # Automatically size glyphs based on the width of
                                       # their individual vectors
 debug: false                          # Output raw messages from fontforge
-quiet: false                          # Silence all output messages
+quiet: false                          # Silence all messages except errors
 
 # For more control over file locations,
 # set input and output as Yaml hashes
@@ -79,21 +75,18 @@ output:
   fonts: app/assets/fonts             # required
   css: app/assets/stylesheets
   preview: app/views/styleguide
-  custom-template.yml: custom/path
+  6
 ```
 
-### SVG Recommendations
-
-All vectors are imported as a single layer with colors and strokes ignored. If
-you run into trouble, try combining your paths and ensuring that you don't have
-any white fills (which show up as colored).
-
-By default, Font Custom scales each vector to fit a 512x512 canvas with a
-baseline at 448. In practice, that means as long as your SVG `viewBox` is
-square, icons will look exactly like your SVGs.
+### SVG Guidelines
 
-If you set the `autowidth` option, Font Custom will trim the widths of each
-glyph to the vector width. Heights are unaffected.
+* All colors will be rendered identically — including white fills.
+* Make transparent colors solid. SVGs with transparency will be skipped.
+* For greater precision, prefer fills to strokes (especially if your icon includes curves).
+* Keep your icon within a square `viewBox`. Font Custom scales each SVG to fit
+  a 512x512 canvas with a baseline at 448.
+* Setting `autowidth` to true trims horizontal white space from each glyph. This can be much easier
+  than centering dozens of SVGs by hand.
 
 ---
 

data/TODO.md

@@ -2,15 +2,20 @@
 
 ### 1.3.0
 
-* tests, error messages, and docs for generate.py / SVG bugs
 * tests, error messages, and docs for template generator
 * store relative paths in manifest (rebuild in generator/util)
+
+* Detect old manifest / show error message
+* In template/fontcustom.yml, clarify that input/output can be hashes
+
+* Add more travis CLI rubies / thor versions?
 * documentation for template helpers
 * redirect fontcustom.com to github repo (use wiki for documentation)
 
-### Low Priority
+### Future
 
 * conserve code points: http://stackoverflow.com/questions/8794430/ruby-finding-lowest-free-id-in-an-id-array
+* strip /fill: rgba(...)/ from SVGs so that transparent SVGs don't fail
 * more flexible input/ouput hashes (regex or file extensions)
 * sass template with variables
 * less template with variables

data/lib/fontcustom/cli.rb

@@ -61,7 +61,7 @@ module Fontcustom
       File.join Fontcustom.gem_lib, "templates"
     end
 
-    desc "compile [INPUT] [OPTIONS]", "Generates webfonts and templates from *.svg and *.eps files in INPUT. Default: `pwd`"
+    desc "compile [INPUT] [OPTIONS]", "Generates webfonts and templates from *.svg files in INPUT. Default: `pwd`"
     def compile(input = nil)
       Base.new(options.merge(:input => input)).compile
     rescue Fontcustom::Error => e

data/lib/fontcustom/generator/font.rb

@@ -47,7 +47,7 @@ module Fontcustom
         glyphs = {}
         files.each do |file|
           name = File.basename file, ".svg"
-          name = name.strip.gsub(/\W/, "-").downcase
+          name = name.strip.gsub(/\W/, "-")
           glyphs[name.to_sym] = { :source => file }
         end
 
@@ -73,9 +73,13 @@ module Fontcustom
         stdout = stdout.split("\n")
         stdout = stdout[1..-1] if stdout[0] == "CreateAllPyModules()"
 
+        if stderr.include? "Failed to parse color rgba("
+          say_message :warn, "Transparent glyphs are not supported. Check your SVGs."
+        end
+
         debug_msg = " Try again with --debug for more details."
         if @options[:debug]
-          say_message :debug, "#{stderr}\n#{' ' * 14}#{stdout}", :red
+          say_message :debug, "#{stderr}\n#{' ' * 14}#{stdout}"
           debug_msg = ""
         end
 

data/lib/fontcustom/options.rb

@@ -19,6 +19,7 @@ module Fontcustom
       load_config
       merge_options
       clean_font_name
+      clean_css_selector
       set_manifest_path
       set_input_paths
       set_output_paths
@@ -92,6 +93,14 @@ module Fontcustom
       @options[:font_name] = @options[:font_name].strip.gsub(/\W/, "-")
     end
 
+    def clean_css_selector
+      unless @options[:css_selector].include? "{{glyph}}"
+        raise Fontcustom::Error,
+          "CSS selector `#{@options[:css_selector]}` should contain the \"{{glyph}}\" placeholder."
+      end
+      @options[:css_selector] = @options[:css_selector].strip.gsub(/[^\{\}\w]/, "-")
+    end
+
     def set_manifest_path
       @options[:manifest] = if ! @options[:manifest].nil?
         expand_path @options[:manifest]
@@ -107,35 +116,21 @@ module Fontcustom
         @options[:input] = symbolize_hash(@options[:input])
         if @options[:input].has_key? :vectors
           @options[:input][:vectors] = expand_path @options[:input][:vectors]
-          unless File.directory? @options[:input][:vectors]
-            raise Fontcustom::Error, 
-              "INPUT[:vectors] (`#{relative_to_root(@options[:input][:vectors])}`) should be "\
-              "a directory. Check `#{relative_to_root(@options[:config])}` or your CLI options."
-          end
+          check_input @options[:input][:vectors]
         else
-          raise Fontcustom::Error, 
-            "INPUT should have a :vectors key. Check `#{relative_to_root(@options[:config])}` "\
-            "or your CLI options."
+          raise Fontcustom::Error,
+            "Input paths (assigned as a hash) should have a :vectors key. Check your options."
         end
 
         if @options[:input].has_key? :templates
           @options[:input][:templates] = expand_path @options[:input][:templates]
-          unless File.directory? @options[:input][:templates]
-            raise Fontcustom::Error, 
-              "INPUT[:templates] (`#{relative_to_root(@options[:input][:templates])}`) "\
-              "should be a directory. Check `#{relative_to_root(@options[:config])}` or "\
-              "your CLI options."
-          end
+          check_input @options[:input][:templates]
         else
           @options[:input][:templates] = @options[:input][:vectors]
         end
       else
         input = @options[:input] ? expand_path(@options[:input]) : @options[:project_root]
-        unless File.directory? input
-          raise Fontcustom::Error, 
-            "INPUT (`#{relative_to_root(input)}`) should be a directory. Check "\
-            "`#{relative_to_root(@options[:config])}` or your CLI options."
-        end
+        check_input input 
         @options[:input] = { :vectors => input, :templates => input }
       end
 
@@ -148,17 +143,15 @@ module Fontcustom
       if @options[:output].is_a? Hash
         @options[:output] = symbolize_hash(@options[:output])
         unless @options[:output].has_key? :fonts
-          raise Fontcustom::Error, 
-            "OUTPUT should have a :fonts key. Check `#{relative_to_root(@options[:config])}` "\
-            "or your CLI options."
+          raise Fontcustom::Error,
+            "Output paths (assigned as a hash) should have a :fonts key. Check your options."
         end
 
         @options[:output].each do |key, val|
           @options[:output][key] = expand_path val
           if File.exists?(val) && ! File.directory?(val)
-            raise Fontcustom::Error, 
-              "OUTPUT[:#{key.to_s}] (`#{relative_to_root(@options[:output][key])}`) should be "\
-              "a directory. Check `#{relative_to_root(@options[:config])}` or your CLI options."
+            raise Fontcustom::Error,
+              "Output `#{relative_to_root(@options[:output][key])}` exists but isn't a directory. Check your options."
           end
         end
 
@@ -168,9 +161,8 @@ module Fontcustom
         if @options[:output].is_a? String
           output = expand_path @options[:output]
           if File.exists?(output) && ! File.directory?(output)
-            raise Fontcustom::Error, 
-              "OUTPUT (`#{relative_to_root(output)}`) should be a directory. Check "\
-              "`#{relative_to_root(@options[:config])}` or your CLI options."
+            raise Fontcustom::Error,
+              "Output `#{relative_to_root(output)}` exists but isn't a directory. Check your options."
           end
         else
           output = File.join @options[:project_root], @options[:font_name]
@@ -214,14 +206,22 @@ module Fontcustom
         else
           template = File.expand_path File.join(@options[:input][:templates], template) unless template[0] == "/"
           unless File.exists? template
-            config = @options[:config] ? " `#{relative_to_root(@options[:config])}` or" : ""
             raise Fontcustom::Error,
-              "Custom template `#{relative_to_root(template)}` doesn't exist. "\
-              "Check#{config} your CLI options."
+              "Custom template `#{relative_to_root(template)}` doesn't exist. Check your options."
           end
           template
         end
       end
     end
+
+    def check_input(dir)
+      if ! File.exists? dir
+        raise Fontcustom::Error,
+          "Input `#{relative_to_root(dir)}` doesn't exist. Check your options."
+      elsif ! File.directory? dir
+        raise Fontcustom::Error,
+          "Input `#{relative_to_root(dir)}` isn't a directory. Check your options."
+      end
+    end
   end
 end

data/lib/fontcustom/utility.rb

@@ -125,8 +125,9 @@ module Fontcustom
     # Messages
     #
 
-    def say_message(status, message, color = :yellow)
+    def say_message(status, message, color = nil)
       return if _options[:quiet] && status != :error
+      color = :red if [:error, :debug, :warn].include?(status)
       say_status status, message, color
     end
 

data/lib/fontcustom/version.rb

@@ -1,3 +1,3 @@
 module Fontcustom
-  VERSION = "1.3.0.beta"
+  VERSION = "1.3.0.beta2"
 end

data/lib/fontcustom/watcher.rb

@@ -62,7 +62,7 @@ module Fontcustom
           changed = modified + added + removed
           compile unless changed.empty?
         rescue Fontcustom::Error => e
-          say_message :error, e.message, :red
+          say_message :error, e.message
         end
       end
     end

data/spec/fontcustom/generator/font_spec.rb

@@ -13,7 +13,7 @@ describe Fontcustom::Generator::Font do
         gen = Fontcustom::Generator::Font.new manifest
         gen.stub :create_fonts
         gen.generate
-        File.read(manifest).should match(/"glyphs":.+"c":/m)
+        File.read(manifest).should match(/"glyphs":.+"C":/m)
       end
     end
 
@@ -50,22 +50,22 @@ describe Fontcustom::Generator::Font do
       gen.should_receive(:save_manifest)
       gen.send :set_glyph_info
       manifest = gen.instance_variable_get(:@manifest)
-      manifest[:glyphs][:"a_r3ally-exotic-f1le-name"].should include(:codepoint => 61696)
-      manifest[:glyphs][:c].should include(:codepoint => 61697)
-      manifest[:glyphs][:d].should include(:codepoint => 61698)
+      manifest[:glyphs][:C].should include(:codepoint => 61696)
+      manifest[:glyphs][:D].should include(:codepoint => 61697)
+      manifest[:glyphs][:"a_R3ally-eXotic-f1Le-Name"].should include(:codepoint => 61698)
     end
 
     it "should not change codepoints of existing glyphs" do
       gen = generator
       gen.instance_variable_set :@options, :input => {:vectors => fixture("shared/vectors")}
-      gen.instance_variable_set :@manifest, :glyphs => {:c => {:source => "foo", :codepoint => 61699}}
+      gen.instance_variable_set :@manifest, :glyphs => {:C => {:source => "foo", :codepoint => 61699}}
 
       gen.should_receive(:save_manifest)
       gen.send :set_glyph_info
       manifest = gen.instance_variable_get(:@manifest)
-      manifest[:glyphs][:"a_r3ally-exotic-f1le-name"].should include(:codepoint => 61700)
-      manifest[:glyphs][:c].should include(:codepoint => 61699)
-      manifest[:glyphs][:d].should include(:codepoint => 61701)
+      manifest[:glyphs][:C].should include(:codepoint => 61699)
+      manifest[:glyphs][:D].should include(:codepoint => 61700)
+      manifest[:glyphs][:"a_R3ally-eXotic-f1Le-Name"].should include(:codepoint => 61701)
     end
   end
 

data/spec/fontcustom/options_spec.rb

@@ -207,7 +207,7 @@ describe Fontcustom::Options do
           :config => "fontcustom.yml",
           :input => { :vectors => "shared/not-a-dir" }
         }
-        expect { o.send :set_input_paths }.to raise_error Fontcustom::Error, /should be a directory/
+        expect { o.send :set_input_paths }.to raise_error Fontcustom::Error, /isn't a directory/
       end
     end
 
@@ -240,7 +240,7 @@ describe Fontcustom::Options do
           :config => "fontcustom.yml",
           :input => "shared/not-a-dir"
         }
-        expect { o.send :set_input_paths }.to raise_error Fontcustom::Error, /should be a directory/
+        expect { o.send :set_input_paths }.to raise_error Fontcustom::Error, /isn't a directory/
       end
     end
   end
@@ -354,7 +354,7 @@ describe Fontcustom::Options do
           :config => "fontcustom.yml",
           :output => "shared/not-a-dir"
         }
-        expect { o.send :set_output_paths }.to raise_error Fontcustom::Error, /should be a directory/
+        expect { o.send :set_output_paths }.to raise_error Fontcustom::Error, /isn't a directory/
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fontcustom
 version: !ruby/object:Gem::Version
-  version: 1.3.0.beta
+  version: 1.3.0.beta2
 platform: ruby
 authors:
 - Kai Zau
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json