fontcustom 1.1.0.pre2 → 1.1.0

data/lib/fontcustom/generator/template.rb

@@ -21,13 +21,12 @@ module Fontcustom
 
       def get_data
         if File.exists? opts.data_cache
-          @data = JSON.parse(File.read(opts.data_cache), :symbolize_names => true)
+          @data = JSON.parse File.read(opts.data_cache), :symbolize_names => true
         else
-          raise Fontcustom::Error, "#{relative_to_root(opts.data_cache)} is required to generate templates, but I couldn't find it."
+          raise Fontcustom::Error, "`#{relative_to_root(opts.data_cache)}` is missing. This file is required to generate templates."
         end
-      rescue JSON::ParserError
-        # Catches both empty and and malformed files
-        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."
+      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
 
       def reset_output
@@ -51,33 +50,36 @@ module Fontcustom
         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_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
+        @font_path = File.join fonts.relative_path_from(css).to_s, name
+        @font_path_alt = opts.preprocessor_path.nil? ? @font_path : File.join(opts.preprocessor_path, name)
+        @font_path_preview = File.join fonts.relative_path_from(preview).to_s, name
       end
 
       def generate
         @glyphs = @data[:glyphs]
-        @font_path = @data[:paths][:css_to_fonts]
-        @font_path_pre = @data[:paths][:preprocessor_to_fonts]
+        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
-          created = []
           opts.templates.each do |source|
             name = File.basename source
             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
-                     elsif name == "fontcustom-preview.html"
-                       File.join opts.output[:preview], name
-                     else
-                       File.join opts.output[:fonts], name
-                     end
+            target = name.dup
+
+            if packaged.include?(name) && opts.font_name != DEFAULT_OPTIONS[:font_name]
+              target.sub! DEFAULT_OPTIONS[:font_name], opts.font_name
+            end
+
+            target = if opts.output.keys.include? name.to_sym
+              File.join opts.output[name.to_sym], target
+            elsif css_exts.include? ext
+              File.join opts.output[:css], target
+            elsif name == "fontcustom-preview.html"
+              File.join opts.output[:preview], target
+            else
+              File.join opts.output[:fonts], target
+            end
 
             template source, target, :verbose => false
             created << target

data/lib/fontcustom/options.rb

@@ -2,18 +2,17 @@ require "yaml"
 require "thor/shell"
 require "thor/shell/basic"
 require "thor/shell/color"
-require "thor/core_ext/hash_with_indifferent_access"
 require "fontcustom/util"
 
 module Fontcustom
   class Options
     include Util
 
-    attr_reader :project_root, :input, :output, :config, :data_cache, :templates,
-      :font_name, :file_hash, :css_prefix, :preprocessor_path, :skip_first, :debug, :verbose
+    attr_reader :project_root, :input, :output, :config, :templates, :font_name, :css_prefix, :data_cache, :preprocessor_path, :no_hash, :debug, :quiet, :skip_first 
 
     def initialize(options = {})
       check_fontforge
+      options = symbolize_hash(options)
 
       # Overwrite example defaults (used in Thor's help) with real defaults, if unchanged
       EXAMPLE_OPTIONS.keys.each do |key|
@@ -39,7 +38,7 @@ module Fontcustom
 
     def set_config_path
       @config = if @cli_options[:config]
-        path = File.expand_path File.join(@cli_options[:project_root], @cli_options[:config])
+        path = expand_path @cli_options[:config]
 
         # :config is the path to fontcustom.yml
         if File.exists?(path) && ! File.directory?(path)
@@ -50,7 +49,7 @@ module Fontcustom
           File.join path, "fontcustom.yml"
 
         else
-          raise Fontcustom::Error, "The configuration file was not found. Check #{relative_to_root(path)} and try again."
+          raise Fontcustom::Error, "The configuration file wasn't found. Check `#{relative_to_root(path)}` and try again."
         end
       else
         # fontcustom.yml is in the project_root
@@ -69,12 +68,20 @@ module Fontcustom
 
     def load_config
       @config_options = {}
-      return unless @config
-      begin
-        config = YAML.load File.open(@config)
-        @config_options = config if config # empty file returns false
-      rescue Exception => e
-        raise Fontcustom::Error, "The configuration file failed to load. Message: #{e.message}"
+      if @config
+        say_message :status, "Loading configuration file at `#{relative_to_root(@config)}`."
+        begin
+          config = YAML.load File.open(@config)
+          if config # empty YAML returns false
+            @config_options = symbolize_hash(config)
+          else
+            say_message :status, "Configuration file was empty. Using defaults."
+          end
+        rescue Exception => e
+          raise Fontcustom::Error, "The configuration file failed to load. Message: #{e.message}"
+        end
+      else
+        say_message :status, "No configuration file set. Generate one with `fontcustom config` to save your settings."
       end
     end
 
@@ -83,73 +90,69 @@ module Fontcustom
 
       options = DEFAULT_OPTIONS.dup
       options = options.merge @config_options
-      options = options.merge @cli_options
+      options = options.merge symbolize_hash(@cli_options)
       remove_instance_variable :@config_options
       remove_instance_variable :@cli_options
 
       # :config is excluded since it's already been set
-      keys = %w|project_root input output data_cache templates font_name file_hash css_prefix preprocessor_path skip_first debug verbose|
-      keys.each { |key| instance_variable_set("@#{key}", options[key]) }
+      keys = %w|project_root input output data_cache templates font_name css_prefix preprocessor_path skip_first no_hash debug quiet|
+      keys.each { |key| instance_variable_set("@#{key}", options[key.to_sym]) }
 
-      @font_name = @font_name.strip.gsub(/\W/, '-')
+      @font_name = @font_name.strip.gsub(/\W/, "-")
     end
 
     def set_data_path
       @data_cache = if ! @data_cache.nil?
-        File.expand_path File.join(@project_root, @data_cache)
+        expand_path @data_cache
       elsif @config
-        File.join File.dirname(@config), '.fontcustom-data'
+        File.join File.dirname(@config), ".fontcustom-data"
       else
-        File.join @project_root, '.fontcustom-data'
+        File.join @project_root, ".fontcustom-data"
       end
     end
 
     def set_input_paths
       if @input.is_a? Hash
-        @input = Thor::CoreExt::HashWithIndifferentAccess.new @input
-
-        if @input.has_key? "vectors"
-          @input[:vectors] = File.expand_path File.join(@project_root, @input[:vectors])
-          unless File.directory? input[:vectors]
-            raise Fontcustom::Error, "INPUT[\"vectors\"] should be a directory. Check #{relative_to_root(input[:vectors])} and try again."
+        @input = symbolize_hash(@input)
+        if @input.has_key? :vectors
+          @input[:vectors] = expand_path @input[:vectors]
+          unless File.directory? @input[:vectors]
+            raise Fontcustom::Error, "INPUT[:vectors] should be a directory. Check `#{relative_to_root(@input[:vectors])}` and try again."
           end
         else
-          raise Fontcustom::Error, "INPUT (as a hash) should contain a \"vectors\" key."
+          raise Fontcustom::Error, "INPUT (as a hash) should contain a :vectors key."
         end
 
-        if @input.has_key? "templates"
-          @input[:templates] = File.expand_path File.join(@project_root, @input[:templates])
+        if @input.has_key? :templates
+          @input[:templates] = expand_path @input[:templates]
           unless File.directory? @input[:templates]
-            raise Fontcustom::Error, "INPUT[\"templates\"] should be a directory. Check #{relative_to_root(input[:templates])} and try again."
+            raise Fontcustom::Error, "INPUT[:templates] should be a directory. Check `#{relative_to_root(@input[:templates])}` and try again."
           end
         else
           @input[:templates] = @input[:vectors]
         end
-      elsif @input.is_a? String
-        input = File.expand_path File.join(@project_root, @input)
+      else
+        input = @input ? expand_path(@input) : @project_root
         unless File.directory? input
-          raise Fontcustom::Error, "INPUT (as a string) should be a directory. Check #{relative_to_root(input)} and try again."
+          raise Fontcustom::Error, "INPUT (as a string) should be a directory. Check `#{relative_to_root(input)}` and try again."
         end
-        @input = Thor::CoreExt::HashWithIndifferentAccess.new({
-          :vectors => input,
-          :templates => input
-        })
+        @input = { :vectors => input, :templates => input }
       end
 
       if Dir[File.join(@input[:vectors], "*.{svg,eps}")].empty?
-        raise Fontcustom::Error, "#{relative_to_root(@input[:vectors])} doesn't contain any vectors (*.svg or *.eps files)."
+        raise Fontcustom::Error, "`#{relative_to_root(@input[:vectors])}` doesn't contain any vectors (*.svg or *.eps files)."
       end
     end
 
     def set_output_paths
       if @output.is_a? Hash
-        @output = Thor::CoreExt::HashWithIndifferentAccess.new @output
-        raise Fontcustom::Error, "OUTPUT (as a hash) should contain a \"fonts\" key." unless @output.has_key? "fonts"
+        @output = symbolize_hash(@output)
+        raise Fontcustom::Error, "OUTPUT (as a hash) should contain a :fonts key." unless @output.has_key? :fonts
 
         @output.each do |key, val|
-          @output[key] = File.expand_path File.join(@project_root, val)
+          @output[key] = expand_path val
           if File.exists?(val) && ! File.directory?(val)
-            raise Fontcustom::Error, "OUTPUT[\"#{key}\"] should be a directory, not a file. Check #{relative_to_root(val)} and try again."
+            raise Fontcustom::Error, "OUTPUT[:#{key.to_s}] should be a directory, not a file. Check `#{relative_to_root(val)}` and try again."
           end
         end
 
@@ -157,20 +160,20 @@ module Fontcustom
         @output[:preview] ||= @output[:fonts]
       else
         if @output.is_a? String
-          output = File.expand_path File.join(@project_root, @output)
+          output = expand_path @output
           if File.exists?(output) && ! File.directory?(output)
-            raise Fontcustom::Error, "OUTPUT should be a directory, not a file. Check #{relative_to_root(output)} and try again."
+            raise Fontcustom::Error, "OUTPUT should be a directory, not a file. Check `#{relative_to_root(output)}` and try again."
           end
         else
           output = File.join @project_root, @font_name
-          say_message :status, "All generated files will be added into `#{relative_to_root(output)}/` by default."
+          say_message :status, "All generated files will be saved to `#{relative_to_root(output)}/`."
         end
 
-        @output = Thor::CoreExt::HashWithIndifferentAccess.new({
+        @output = {
           :fonts => output,
           :css => output,
           :preview => output
-        })
+        }
       end
     end
 
@@ -201,9 +204,9 @@ module Fontcustom
         when "bootstrap-ie7-scss"
           File.join template_path, "_fontcustom-bootstrap-ie7.scss"
         else
-          path = File.expand_path File.join(@input[:templates], template)
-          raise Fontcustom::Error, "The custom template at #{relative_to_root(path)} does not exist." unless File.exists? path
-          path
+          template = File.expand_path File.join(@input[:templates], template) unless template[0] == "/"
+          raise Fontcustom::Error, "The custom template at `#{relative_to_root(template)}` does not exist." unless File.exists? template
+          template
         end
       end
     end

data/lib/fontcustom/scripts/generate.py

@@ -9,7 +9,7 @@ try:
 	import argparse
 	parser = argparse.ArgumentParser(description='Convert a directory of svg and eps files into a unified font file.')
 	parser.add_argument('dir', metavar='directory', type=unicode, nargs=2, help='directory of vector files')
-	parser.add_argument('--name', metavar='fontname', type=unicode, nargs='?', default='fontcustom', help='reference name of the font (no spaces)')
+	parser.add_argument('--name', metavar='fontname', type=unicode, nargs='?', help='reference name of the font (no spaces)')
 	parser.add_argument('--nohash', '-n', action='store_true', help='disable hash fingerprinting of font files')
 	parser.add_argument('--debug', '-d', action='store_true', help='display debug messages')
 	args = parser.parse_args()
@@ -19,7 +19,7 @@ except ImportError:
 	# Older Pythons don't have argparse, so we use optparse instead
 	import optparse
 	parser = optparse.OptionParser(description='Convert a directory of svg and eps files into a unified font file.')
-	parser.add_option('--name', metavar='fontname', type='string', nargs='?', default='fontcustom', help='reference name of the font (no spaces)')
+	parser.add_option('--name', metavar='fontname', type='string', nargs='?', help='reference name of the font (no spaces)')
 	parser.add_option('--nohash', '-n', action='store_true', help='disable hash fingerprinting of font files')
 	parser.add_argument('--debug', '-d', action='store_true', help='display debug messages')
 	(args, posargs) = parser.parse_args()

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

@@ -5,11 +5,11 @@
 
 @font-face {
   font-family: "<%= @opts.font_name %>";
-  src: url("<%= @font_path_pre %>.eot");
-  src: url("<%= @font_path_pre %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @font_path_pre %>.woff") format("woff"),
-       url("<%= @font_path_pre %>.ttf") format("truetype"),
-       url("<%= @font_path_pre %>.svg#<%= @opts.font_name %>") format("svg");
+  src: url("<%= @font_path_alt %>.eot");
+  src: url("<%= @font_path_alt %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @font_path_alt %>.woff") format("woff"),
+       url("<%= @font_path_alt %>.ttf") format("truetype"),
+       url("<%= @font_path_alt %>.svg#<%= @opts.font_name %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }

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

@@ -4,11 +4,11 @@
 
 @font-face {
   font-family: "<%= @opts.font_name %>";
-  src: font-url("<%= @font_path_pre %>.eot");
-  src: font-url("<%= @font_path_pre %>.eot?#iefix") format("embedded-opentype"),
-       font-url("<%= @font_path_pre %>.woff") format("woff"),
-       font-url("<%= @font_path_pre %>.ttf") format("truetype"),
-       font-url("<%= @font_path_pre %>.svg#<%= @opts.font_name %>") format("svg");
+  src: font-url("<%= @font_path_alt %>.eot");
+  src: font-url("<%= @font_path_alt %>.eot?#iefix") format("embedded-opentype"),
+       font-url("<%= @font_path_alt %>.woff") format("woff"),
+       font-url("<%= @font_path_alt %>.ttf") format("truetype"),
+       font-url("<%= @font_path_alt %>.svg#<%= @opts.font_name %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }

data/lib/fontcustom/templates/_fontcustom.scss

@@ -4,15 +4,18 @@
 
 @font-face {
   font-family: "<%= @opts.font_name %>";
-  src: url("<%= @font_path_pre %>.eot");
-  src: url("<%= @font_path_pre %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @font_path_pre %>.woff") format("woff"),
-       url("<%= @font_path_pre %>.ttf") format("truetype"),
-       url("<%= @font_path_pre %>.svg#<%= @opts.font_name %>") format("svg");
+  src: url("<%= @font_path_alt %>.eot");
+  src: url("<%= @font_path_alt %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @font_path_alt %>.woff") format("woff"),
+       url("<%= @font_path_alt %>.ttf") format("truetype"),
+       url("<%= @font_path_alt %>.svg#<%= @opts.font_name %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }
 
+[data-icon]:before { content: attr(data-icon); }
+
+[data-icon]:before,
 <%= @glyphs.map {|name| ".#{@opts.css_prefix + name}:before"}.join(",\n") %> {
   font-family: "<%= @opts.font_name %>";
   font-style: normal;

data/lib/fontcustom/templates/fontcustom-bootstrap-ie7.css

@@ -1,4 +1,4 @@
-/* 
+/*
   Icon Font: <%= @opts.font_name %>
   Bootstrap IE7 Enabler
 */

data/lib/fontcustom/templates/fontcustom-bootstrap.css

@@ -1,4 +1,4 @@
-/* 
+/*
   Icon Font: <%= @opts.font_name %>
   Bootstrap Override
 */

data/lib/fontcustom/templates/fontcustom-preview.html

@@ -20,28 +20,39 @@
         font: 16px/1.5 "Helvetica Neue", Helvetica, Arial, sans-serif;
       }
 
-      a, 
+      a,
       a:visited {
         color: #888;
         text-decoration: underline;
       }
-      a:hover, 
+      a:hover,
       a:focus { color: #000; }
 
-      h1 {
+      header {
         border-bottom: 2px solid #ddd;
+        margin-bottom: 20px;
+        overflow: hidden;
+        padding: 20px 0;
+      }
+
+      header h1 {
         color: #888;
+        float: left;
         font-size: 36px;
         font-weight: 300;
-        margin-bottom: 20px;
-        padding: 20px 0;
+      }
+
+      header a {
+        float: right;
+        font-size: 14px;
       }
 
       .container {
         margin: 0 auto;
-        min-width: 880px;
+        max-width: 1200px;
+        min-width: 960px;
         padding: 0 40px;
-        width: 80%;
+        width: 90%;
       }
 
       .glyph {
@@ -50,20 +61,41 @@
         margin-bottom: 20px;
       }
 
-      .preview-glyphs { vertical-align: bottom; } 
+      .preview-glyphs { vertical-align: bottom; }
 
-      .preview-scale { 
+      .preview-scale {
         color: #888;
-        font-size: 12px; 
+        font-size: 12px;
         margin-top: 5px;
       }
 
       .step {
         display: inline-block;
         line-height: 1;
+        position: relative;
         width: 10%;
       }
 
+      .step .letters,
+      .step i {
+        -webkit-transition: opacity .3s;
+        -moz-transition: opacity .3s;
+        -ms-transition: opacity .3s;
+        -o-transition: opacity .3s;
+        transition: opacity .3s;
+      }
+
+      .step:hover .letters { opacity: 1; }
+      .step:hover i { opacity: .3; }
+
+      .letters {
+        opacity: .3;
+        position: absolute;
+      }
+
+      .characters-off .letters { display: none; }
+      .characters-off .step:hover i { opacity: 1; }
+
       <% scale.each do |n| %>
       .size-<%= n %> { font-size: <%= n %>px; }
       <% end %>
@@ -81,7 +113,7 @@
 
       .usage .class { width: 250px; }
 
-      .footer {
+      footer {
         color: #888;
         font-size: 12px;
         padding: 20px 0;
@@ -91,15 +123,18 @@
 
       @font-face {
         font-family: "<%= @opts.font_name %>";
-        src: url("<%= @data[:paths][:preview_to_fonts] %>.eot");
-        src: url("<%= @data[:paths][:preview_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
-             url("<%= @data[:paths][:preview_to_fonts] %>.woff") format("woff"),
-             url("<%= @data[:paths][:preview_to_fonts] %>.ttf") format("truetype"),
-             url("<%= @data[:paths][:preview_to_fonts] %>.svg#<%= @opts.font_name %>") format("svg");
+        src: url("<%= @font_path_preview %>.eot");
+        src: url("<%= @font_path_preview %>.eot?#iefix") format("embedded-opentype"),
+             url("<%= @font_path_preview %>.woff") format("woff"),
+             url("<%= @font_path_preview %>.ttf") format("truetype"),
+             url("<%= @font_path_preview %>.svg#<%= @opts.font_name %>") format("svg");
         font-weight: normal;
         font-style: normal;
       }
 
+      [data-icon]:before { content: attr(data-icon); }
+
+      [data-icon]:before,
       <%= @glyphs.map {|name| ".#{@opts.css_prefix + name}:before"}.join(",\n") %> {
         font-family: "<%= @opts.font_name %>";
         font-style: normal;
@@ -116,19 +151,29 @@
     </style>
 
     <!--[if lte IE 8]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
+
+    <script>
+      function toggleCharacters() {
+        var body = document.getElementsByTagName('body')[0];
+        body.className = body.className === 'characters-off' ? '' : 'characters-off';
+      }
+    </script>
   </head>
 
   <body>
-    <div class="container">
-      <h1><%= @opts.font_name %> contains <%= @glyphs.length %> glyphs:</h1> 
+    <div id="page" class="container">
+      <header>
+        <h1><%= @opts.font_name %> contains <%= @glyphs.length %> glyphs:</h1>
+        <a onclick="toggleCharacters(); return false;" href="#">Toggle Preview Characters</a>
+      </header>
 
       <% @glyphs.each_with_index do |name, index| %>
       <div class="glyph">
         <div class="preview-glyphs">
-          <% scale.each do |n| %><i class="step <%= @opts.css_prefix + name %> size-<%= n %>"></i><% end %>
+          <% scale.each do |n| %><span class="step size-<%= n %>"><span class="letters">Pp</span><i class="<%= @opts.css_prefix + name %>"></i></span><% end %>
         </div>
         <div class="preview-scale">
-          <% scale.each do |n| %><span class="step"><%= n %></span><% end %> 
+          <% scale.each do |n| %><span class="step"><%= n %></span><% end %>
         </div>
         <div class="usage">
           <input class="class" type="text" readonly="readonly" onClick="this.select();" value=".<%= @opts.css_prefix + name %>" />
@@ -137,9 +182,9 @@
       </div>
       <% end %>
 
-      <div class="footer">
+      <footer>
         Made with love using <a href="http://fontcustom.com">Font Custom</a>.
-      </div>
+      </footer>
     </div>
   </body>
 </html>