fontcustom 1.3.0.beta2 → 1.3.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a89156ba7ef7d8a12424e06e6768e0973270b6cf
-  data.tar.gz: 83bbb3c5f0aa93ab04b089e642f1b57e3f9bc04d
+  metadata.gz: a863f3b75e4669343c50c8f137aaae1c5c5df1fd
+  data.tar.gz: 4997708bd8b627e3ec060c32fa0c06a7a6de4835
 SHA512:
-  metadata.gz: 576122be6d77bcdf8fc9f4b577fc124b84efabd8370121404b9f137263f1d315f69e1a48d975a90cb37a1bb2be19af0655250ced8fb52d14d9f38c303f531c36
-  data.tar.gz: d1f6317e39596082c8c9ffe884f227a62867590140eb548cade80bf3f50d4dcd966296a29a4a62bd0ef7c0fa3a10a9ffe310ee9199a20020abb13e03f85dace1
+  metadata.gz: 3743b80862699178d2c6754a198af545c38358db18563d3ffe5110b777c7350e47a1e505720e14a8620b1ae03f048e34dc091ad60ec15f224b934b56ef2368f6
+  data.tar.gz: 8f977e595ebf6232b06d7e69b2aead55be38727c104092340fcf20617b3b691d1f6bdf6a31d6c3a1c37a6c3080467eceb4e2f7524509c5c35a4c9d3ba643950e

data/README.md

@@ -42,31 +42,22 @@ fontcustom help                     # See all options
 ### Configuration
 
 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. Most of the following can also be used as
-command line flags (`--css-selector`, etc.).
+`fontcustom config`. This should live in the directory where you run
+all `fontcustom` commands. Each of the following has its own command 
+line flag (`--css-selector`, etc.). Defaults values are shown.
+
+**Basics**
 
 ```yml
-# (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
 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
-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 messages except errors
 
-# For more control over file locations,
-# set input and output as Yaml hashes
+# For more control over file locations, set
+# input and output as hashes instead of strings
 input:
   vectors: path/to/vectors            # required
   templates: path/to/templates
@@ -75,9 +66,39 @@ output:
   fonts: app/assets/fonts             # required
   css: app/assets/stylesheets
   preview: app/views/styleguide
-  6
 ```
 
+**Fonts**
+
+```yml
+font_name: fontcustom                 # Also sets the default output directory and
+                                      # the name of generated stock templates
+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
+```
+
+**Templates**
+
+```yml
+templates: [ css, preview ]           # List of templates to generate alongside fonts
+                                      # Possible values: preview, css, scss, scss-rails
+css_selector: .icon-{{glyph}}         # CSS selector format (`{{glyph}}` is replaced)
+preprocessor_path: ""                 # Font path used in CSS proprocessor templates
+
+# Custom templates should live in the `input` 
+# or `input[:templates]` directory and be added
+# to `templates` as their basename:
+templates: [ preview, VectorIcons.less ]
+```
+
+Custom templates have access to `@options`, `@manifest`, and the following ERB helpers:
+
+* `font_name` 
+* `font_face`: FontSpring's [Bulletproof @font-face syntax](http://www.fontspring.com/blog/further-hardening-of-the-bulletproof-syntax)
+* `glyph_selectors`: comma-separated list of all selectors
+* `glyphs`: all selectors and their codepoint assignments (`.icon-example:before { content: "\f103"; }`)
+
 ### SVG Guidelines
 
 * All colors will be rendered identically — including white fills.

data/TODO.md

@@ -2,11 +2,10 @@
 
 ### 1.3.0
 
-* tests, error messages, and docs for template generator
 * store relative paths in manifest (rebuild in generator/util)
 
+* reactivate watcher
 * 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

data/lib/fontcustom/generator/font.rb

@@ -49,6 +49,9 @@ module Fontcustom
           name = File.basename file, ".svg"
           name = name.strip.gsub(/\W/, "-")
           glyphs[name.to_sym] = { :source => file }
+          if File.read(file).include? "rgba"
+            say_message :warn, "`#{relative_path(file)}` contains transparency and will be skipped."
+          end
         end
 
         # Dir.glob returns a different order depending on ruby
@@ -73,13 +76,10 @@ 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}"
+          messages = stderr.split("\n") + stdout
+          say_message :debug, messages.join(line_break)
           debug_msg = ""
         end
 

data/lib/fontcustom/generator/template.rb

@@ -42,30 +42,14 @@ module Fontcustom
       def create_files
         @glyphs = @manifest[:glyphs]
         created = []
-        packaged = %w|fontcustom-bootstrap-ie7.css fontcustom.css _fontcustom-bootstrap-ie7.scss _fontcustom-rails.scss
-                   fontcustom-bootstrap.css fontcustom-preview.html _fontcustom-bootstrap.scss _fontcustom.scss|
-        css_exts = %w|.css .scss .sass .less .stylus|
         begin
           @options[:templates].each do |source|
-            name = File.basename source
-            ext = File.extname source
-            target = name.dup
-
-            if packaged.include?(name) && @options[:font_name] != DEFAULT_OPTIONS[:font_name]
-              target.sub! DEFAULT_OPTIONS[:font_name], @options[:font_name]
-            end
-
-            target = if @options[:output].keys.include? name.to_sym
-              File.join @options[:output][name.to_sym], target
-            elsif css_exts.include? ext
-              File.join @options[:output][:css], target
-            elsif name == "fontcustom-preview.html"
-              File.join @options[:output][:preview], target
-            else
-              File.join @options[:output][:fonts], target
+            begin
+              target = template_target source
+              template source, target, :verbose => false, :force => true
+            rescue => e
+              raise Fontcustom::Error, "Could not generate template `#{relative_path(source)}`:#{line_break + e.message}" 
             end
-
-            template source, target, :verbose => false, :force => true
             created << target
           end
         ensure
@@ -75,6 +59,28 @@ module Fontcustom
         end
       end
 
+      def template_target(source)
+        packaged = %w|fontcustom.css _fontcustom.scss _fontcustom-rails.scss fontcustom-preview.html|
+        css_exts = %w|.css .scss .sass .less .stylus|
+        name = File.basename source
+        ext = File.extname source
+        target = name.dup
+
+        if packaged.include?(name) && @options[:font_name] != DEFAULT_OPTIONS[:font_name]
+          target.sub! DEFAULT_OPTIONS[:font_name], @options[:font_name]
+        end
+
+        if @options[:output].keys.include? name.to_sym
+          File.join @options[:output][name.to_sym], target
+        elsif css_exts.include? ext
+          File.join @options[:output][:css], target
+        elsif name == "fontcustom-preview.html"
+          File.join @options[:output][:preview], target
+        else
+          File.join @options[:output][:fonts], target
+        end
+      end
+
       #
       # Template Helpers
       #

data/lib/fontcustom/options.rb

@@ -50,7 +50,7 @@ module Fontcustom
           File.join path, "fontcustom.yml"
 
         else
-          raise Fontcustom::Error, "No configuration file found at `#{relative_to_root(path)}`."
+          raise Fontcustom::Error, "No configuration file found at `#{relative_path(path)}`."
         end
       else
         # fontcustom.yml is in the project_root
@@ -70,16 +70,16 @@ module Fontcustom
     def load_config
       @config_options = {}
       if @cli_options[:config]
-        say_message :debug, "Using settings from `#{relative_to_root(@cli_options[:config])}`." if @cli_options[:debug]
+        say_message :debug, "Using settings from `#{relative_path(@cli_options[:config])}`." if @cli_options[:debug]
         begin
           config = YAML.load File.open(@cli_options[:config])
           if config # empty YAML returns false
             @config_options = symbolize_hash(config)
           else
-            say_message :warn, "`#{relative_to_root(@cli_options[:config])}` was empty. Using defaults."
+            say_message :warn, "`#{relative_path(@cli_options[:config])}` was empty. Using defaults."
           end
         rescue Exception => e
-          raise Fontcustom::Error, "Error parsing `#{relative_to_root(@cli_options[:config])}`:\n#{e.message}"
+          raise Fontcustom::Error, "Error parsing `#{relative_path(@cli_options[:config])}`:\n#{e.message}"
         end
       end
     end
@@ -98,7 +98,7 @@ module Fontcustom
         raise Fontcustom::Error,
           "CSS selector `#{@options[:css_selector]}` should contain the \"{{glyph}}\" placeholder."
       end
-      @options[:css_selector] = @options[:css_selector].strip.gsub(/[^\{\}\w]/, "-")
+      @options[:css_selector] = @options[:css_selector].strip.gsub(/[^\.#\{\}\w]/, "-")
     end
 
     def set_manifest_path
@@ -135,7 +135,7 @@ module Fontcustom
       end
 
       if Dir[File.join(@options[:input][:vectors], "*.svg")].empty?
-        raise Fontcustom::Error, "`#{relative_to_root(@options[:input][:vectors])}` doesn't contain any SVGs."
+        raise Fontcustom::Error, "`#{relative_path(@options[:input][:vectors])}` doesn't contain any SVGs."
       end
     end
 
@@ -151,7 +151,7 @@ module Fontcustom
           @options[:output][key] = expand_path val
           if File.exists?(val) && ! File.directory?(val)
             raise Fontcustom::Error,
-              "Output `#{relative_to_root(@options[:output][key])}` exists but isn't a directory. Check your options."
+              "Output `#{relative_path(@options[:output][key])}` exists but isn't a directory. Check your options."
           end
         end
 
@@ -162,11 +162,11 @@ module Fontcustom
           output = expand_path @options[:output]
           if File.exists?(output) && ! File.directory?(output)
             raise Fontcustom::Error,
-              "Output `#{relative_to_root(output)}` exists but isn't a directory. Check your options."
+              "Output `#{relative_path(output)}` exists but isn't a directory. Check your options."
           end
         else
           output = File.join @options[:project_root], @options[:font_name]
-          say_message :debug, "Generated files will be saved to `#{relative_to_root(output)}/`." if @options[:debug]
+          say_message :debug, "Generated files will be saved to `#{relative_path(output)}/`." if @options[:debug]
         end
 
         @options[:output] = {
@@ -207,7 +207,7 @@ module Fontcustom
           template = File.expand_path File.join(@options[:input][:templates], template) unless template[0] == "/"
           unless File.exists? template
             raise Fontcustom::Error,
-              "Custom template `#{relative_to_root(template)}` doesn't exist. Check your options."
+              "Custom template `#{relative_path(template)}` doesn't exist. Check your options."
           end
           template
         end
@@ -217,10 +217,10 @@ module Fontcustom
     def check_input(dir)
       if ! File.exists? dir
         raise Fontcustom::Error,
-          "Input `#{relative_to_root(dir)}` doesn't exist. Check your options."
+          "Input `#{relative_path(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."
+          "Input `#{relative_path(dir)}` isn't a directory. Check your options."
       end
     end
   end

data/lib/fontcustom/templates/fontcustom.yml

@@ -1,6 +1,6 @@
 # --------------------------------------------------------------------------- #
 # Project Info
-#   Default values shown. Learn more about these options by running
+#   Defaults shown. Learn more about these options by running
 #   `fontcustom help` or visiting <http://fontcustom.com>.
 # --------------------------------------------------------------------------- #
 
@@ -15,20 +15,27 @@
 
 
 # --------------------------------------------------------------------------- #
-# Project Paths
-#   Relative paths are expanded from PROJECT_ROOT (defaults to the directory
-#   where the fontcustom command is run). INPUT and OUTPUT can be strings or
-#   hashes or file types / names.
+# Input Paths
 # --------------------------------------------------------------------------- #
 
-#project_root: some/other/place
-#manifest: tmp/fontcustom
+#input: assets/fonts/fontcustom/source                  # as a string
 
-#input:
+# OR
+
+#input:                                                 # as a hash
 #  vectors: app/assets/fonts/fontcustom/vectors         # required
 #  templates: app/assets/fonts/fontcustom/templates
 
-#output:
+
+# --------------------------------------------------------------------------- #
+# Output Paths
+# --------------------------------------------------------------------------- #
+
+#output: assets/fonts/fontcustom                        # as a string
+
+# OR
+
+#output:                                                # as a hash
 #  fonts: app/assets/fonts                              # required
 #  css: app/assets/stylesheets
 #  preview: app/views/styleguide
@@ -37,10 +44,12 @@
 
 # --------------------------------------------------------------------------- #
 # Templates
-#   Included in Font Custom:
-#     preview, css, scss, scss-rails
+#   Included in Font Custom: preview, css, scss, scss-rails
 #   Custom templates should be saved in the INPUT[:templates] directory and
-#   referenced by their base file name.
+#   referenced by their baserame.
 # --------------------------------------------------------------------------- #
 
-#templates: [ scss, preview, my-custom-template.yml ]
+#templates:
+# - scss
+# - preview
+# - my-custom-template.yml

data/lib/fontcustom/utility.rb

@@ -70,7 +70,7 @@ module Fontcustom
     end
 
     # TODO Is this robust enough?
-    def relative_to_root(path)
+    def relative_path(path)
       path = path.sub(_options[:project_root], "")
       path = path[1..-1] if path[0] == "/"
       path = "." if path.empty?
@@ -84,7 +84,7 @@ module Fontcustom
     def write_file(file, content = "", message = nil, message_body = nil)
       File.open(file, "w") { |f| f.write(content) }
       if message
-        body = message_body || relative_to_root(file)
+        body = message_body || relative_path(file)
         say_message message, body
       end
     end
@@ -95,7 +95,7 @@ module Fontcustom
         JSON.parse(json, :symbolize_names => true)
       rescue JSON::ParserError
         raise Fontcustom::Error, 
-          "Couldn't parse `#{relative_to_root file}`. Fix the invalid "\
+          "Couldn't parse `#{relative_path file}`. Fix the invalid "\
           "JSON or delete the file to start from scratch."
       end
     end
@@ -133,8 +133,13 @@ module Fontcustom
 
     def say_changed(status, changed)
       return if _options[:quiet]
-      message = changed.map { |file| relative_to_root(file) }
-      say_status status, message.join("\n#{" " * 14}"), :green # magic number
+      message = changed.map { |file| relative_path(file) }
+      say_status status, message.join(line_break)
+    end
+
+   # magic number for Thor say_status line breaks
+    def line_break
+      "\n#{" " * 14}"
     end
 
     private

data/lib/fontcustom/version.rb

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

data/spec/fontcustom/utility_spec.rb

@@ -118,16 +118,16 @@ describe Fontcustom::Utility do
     end
   end
 
-  context "#relative_to_root" do
+  context "#relative_path" do
     it "should trim project root from paths" do
       gen = Generator.new
-      path = gen.relative_to_root fixture "test/path"
+      path = gen.relative_path fixture "test/path"
       path.should == "test/path"
     end
 
     it "should trim beginning slash" do
       gen = Generator.new
-      path = gen.relative_to_root "/test/path"
+      path = gen.relative_path "/test/path"
       path.should == "test/path"
     end
   end

metadata

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