RubyGems - fontcustom - Versions diffs - 1.0.1 → 1.1.0.pre - Mend

fontcustom 1.0.1 → 1.1.0.pre

Files changed (49) hide show

data/lib/fontcustom/templates/_fontcustom.scss CHANGED

@@ -1,20 +1,14 @@
-<%
-file_name = if @opts[:font_face_path]
-  File.join @opts[:font_face_path], @data[:file_name]
-else
-  @data[:file_name]
-end
-%>/*
- * Font Custom: bare CSS
- */
+//
+// Icon Font: <%= @opts[:font_name] %>
+//
 @font-face {
   font-family: "<%= @opts[:font_name] %>";
-  src: url("<%= file_name %>.eot");
-  src: url("<%= file_name %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= file_name %>.woff") format("woff"),
-       url("<%= file_name %>.ttf") format("truetype"),
-       url("<%= file_name %>.svg#<%= @opts[:font_name] %>") format("svg");
+  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot");
+  src: url("<%= @data[:paths][:preprocessor_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @data[:paths][:preprocessor_to_fonts] %>.woff") format("woff"),
+       url("<%= @data[:paths][:preprocessor_to_fonts] %>.ttf") format("truetype"),
+       url("<%= @data[:paths][:preprocessor_to_fonts] %>.svg#<%= @opts[:font_name] %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }

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

@@ -1,6 +1,7 @@
 /*
- * Font Custom: Bootstrap CSS for IE7
- */
+  Icon Font: <%= @opts[:font_name] %>
+  Bootstrap IE7 Enabler
+*/
 [class^="<%= @opts[:css_prefix] %>"],
 [class*=" <%= @opts[:css_prefix] %>"] {

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

@@ -1,14 +1,15 @@
-/*
- * Font Custom: Bootstrap CSS
- */
+/*
+  Icon Font: <%= @opts[:font_name] %>
+  Bootstrap Override
+*/
 @font-face {
   font-family: "<%= @opts[:font_name] %>";
-  src: url("<%= @data[:file_name] %>.eot");
-  src: url("<%= @data[:file_name] %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @data[:file_name] %>.woff") format("woff"),
-       url("<%= @data[:file_name] %>.ttf") format("truetype"),
-       url("<%= @data[:file_name] %>.svg#<%= @opts[:font_name] %>") format("svg");
+  src: url("<%= @data[:paths][:css_to_fonts] %>.eot");
+  src: url("<%= @data[:paths][:css_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @data[:paths][:css_to_fonts] %>.woff") format("woff"),
+       url("<%= @data[:paths][:css_to_fonts] %>.ttf") format("truetype"),
+       url("<%= @data[:paths][:css_to_fonts] %>.svg#<%= @opts[:font_name] %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }

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

@@ -1,9 +1,8 @@
-<% scale = %w|12 14 16 18 21 24 36 48 60 72| %>
-<!DOCTYPE html>
+<% scale = %w|12 14 16 18 21 24 36 48 60 72| %><!DOCTYPE html>
 <html>
   <head>
     <title><%= @opts[:font_name] %> glyphs preview</title>
-    <link rel="stylesheet" href="fontcustom.css" />
+    <link rel="stylesheet" href="<%= @data[:paths][:preview_to_css] %>" />
     <!--[if lte IE 7]><link rel="stylesheet" href="fontcustom-ie7.css" /><![endif]-->
     <style>

data/lib/fontcustom/templates/fontcustom.css CHANGED

@@ -1,14 +1,14 @@
 /*
- * Font Custom: bare CSS
- */
+  Icon Font: <%= @opts[:font_name] %>
+*/
 @font-face {
   font-family: "<%= @opts[:font_name] %>";
-  src: url("<%= @data[:file_name] %>.eot");
-  src: url("<%= @data[:file_name] %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @data[:file_name] %>.woff") format("woff"),
-       url("<%= @data[:file_name] %>.ttf") format("truetype"),
-       url("<%= @data[:file_name] %>.svg#<%= @opts[:font_name] %>") format("svg");
+  src: url("<%= @data[:paths][:css_to_fonts] %>.eot");
+  src: url("<%= @data[:paths][:css_to_fonts] %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @data[:paths][:css_to_fonts] %>.woff") format("woff"),
+       url("<%= @data[:paths][:css_to_fonts] %>.ttf") format("truetype"),
+       url("<%= @data[:paths][:css_to_fonts] %>.svg#<%= @opts[:font_name] %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }

data/lib/fontcustom/templates/fontcustom.yml CHANGED

@@ -1,80 +1,39 @@
-##
-# FONTCUSTOM CONFIG
-#
-# This file will automatically be loaded if located inside your vector dir.
-# Otherwise, pass it to `compile` or `watch` with:
-#
-#   --config=path/to/config.yml
-#   -c path/to/containing/dir/
-##
 # ---------------------------------------------------------------------------- #
-# Output Directory
-# absolute path OR relative path from `pwd`
-#
-# default: INPUT/fontcustom
-#output: path/to/output
+# Project Info
+#   Learn more about these options with `fontcustom help`.
 # ---------------------------------------------------------------------------- #
-# Templates
-# array of templates to generate alongside fonts
-# accepts shortcuts or paths (absolute, relative to INPUT, or relative to `pwd`)
-#
-# shortcuts:
-#   preview
-#   css, scss
-#   bootstrap, bootstrap-scss
-#   bootstrap-ie7, bootstrap-ie7-scss
-#
-# default: [ css, preview ]
-#templates: [ scss, preview, path/from/INPUT ]
+#font_name: My Custom Font
+#file_hash: false
+#css_prefix: glyph-
+#preprocessor_font_path: fonts/fontcustom
+#debug: true
+#verbose: false
-# ---------------------------------------------------------------------------- #
-# Font Name
-# automatically normalized to lower-spinal-case
-#
-# default: fontcustom
-#font_name: my-font
 # ---------------------------------------------------------------------------- #
-# Font Hash
-# option to attach a cache-breaking fingerprint to each font file
-#
-# default: true
-#file_hash: false
+# Project Directories
+#   All paths are relative to PROJECT_ROOT (default: working directory).
+#   When assigned a hash, individual components can have their own paths.
+#   When assigned a string, all components share the same path.
 # ---------------------------------------------------------------------------- #
-# CSS Class Prefix
-#
-# default: icon-
-  #css_prefix: glyph-
+#input:
+#  vectors: app/assets/fontcustom/vectors
+#  templates: app/assets/fontcustom/templates
-# ---------------------------------------------------------------------------- #
-# @Font-face Path
-# font path used in @font-face declarations
-# only affects SCSS shortcut templates and custom templates
-#
-# default: none
+#output:
+#  fonts: app/assets/fonts
+#  css: app/assets/stylesheets
+#  preview: app/views/styleguide
-#font_face_path: assets/fonts/fontcustom
 # ---------------------------------------------------------------------------- #
-# Debug
-# show raw output from Font Forge
-#
-# default: false
-#debug: true
+# Templates
+#   Shortcuts:
+#     preview, css, scss, bootstrap, bootstrap-scss, bootstrap-ie7,
+#     bootstrap-ie7-scss
+#   Custom templates should be saved in the INPUT[:templates] directory.
 # ---------------------------------------------------------------------------- #
-# Verbose
-# print out all file operations
-#
-# default: true
-#verbose: false
+#templates: [ scss, preview, my-custom-template.yml ]

data/lib/fontcustom/util.rb CHANGED

@@ -1,8 +1,9 @@
 require "yaml"
+require "thor/core_ext/hash_with_indifferent_access"
 module Fontcustom
   class Util
-    class << self
+    class << self
       def check_fontforge
         fontforge = `which fontforge`
         if fontforge == "" || fontforge == "fontforge not found"
@@ -14,38 +15,120 @@ module Fontcustom
       # Priority: Passed args > config file > default
       def collect_options(args = {})
         options = Fontcustom::DEFAULT_OPTIONS.clone
-        args = args.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+        options[:project_root] = args[:project_root] if args[:project_root]
-        options[:input] = args[:input] if args[:input]
-        options[:config] = args[:config] if args[:config]
-        args.delete :config # don't overwrite the return value of #get_config_path
+        # Parse fontcustom.yml if it exists
+        # Deletes :config so that it can't overwrite the output of .get_config_path
+        options[:config] = args.delete(:config) if args[:config]
         options[:config] = get_config_path options
         if options[:config]
-          config = YAML.load File.open(options[:config])
-          if config.is_a? Hash
-            config = config.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+          begin
+            config = YAML.load File.open(options[:config])
             options.merge! config
+          rescue
+            raise Fontcustom::Error, "I couldn't read your configuration file. Please check #{options[:config]} and try again."
           end
         end
+        # Override with passed arguments
+        args.delete(:input) unless args[:input] # allows nil input from CLI
         options.merge! args
-        options[:output] ||= File.join(options[:input], "fontcustom")
-        options[:templates] = get_template_paths options
-        options[:font_name] = options[:font_name].strip.downcase.gsub(/\W/, '-')
+        options[:font_name] = options[:font_name].strip.gsub(/\W/, '-')
+        options[:input] = get_input_paths options
+        options[:output] = get_output_paths options
+        options[:templates] = get_templates options
         options
       end
-      # passed path > input
       def get_config_path(options)
-        if options[:config] && File.directory?(options[:config]) && File.exists?(File.join(options[:config], "fontcustom.yml"))
-          File.join options[:config], "fontcustom.yml"
-        elsif options[:config] && File.exists?(options[:config])
-          options[:config]
-        elsif File.exists? File.join(options[:input], "fontcustom.yml")
-          File.join options[:input], "fontcustom.yml"
+        if options[:config]
+          config = File.expand_path File.join(options[:project_root], options[:config])
+          # :config is the path to fontcustom.yml
+          if File.exists?(config) && ! File.directory?(config)
+            config
+          # :config is a dir containing fontcustom.yml
+          elsif File.exists? File.join(config, "fontcustom.yml")
+            File.join config, "fontcustom.yml"
+          else
+            raise Fontcustom::Error, "I couldn't find your configuration file. Check #{config} and try again."
+          end
         else
-          false
+          # fontcustom.yml is in the project_root
+          if File.exists? File.join(options[:project_root], "fontcustom.yml")
+            File.join options[:project_root], "fontcustom.yml"
+          # config/fontcustom.yml is in the project_root
+          elsif File.exists? File.join(options[:project_root], "config", "fontcustom.yml")
+            File.join options[:project_root], "config", "fontcustom.yml"
+          else
+            # TODO helpful warning that no config was found
+            false
+          end
+        end
+      end
+      def get_input_paths(options)
+        paths = if options[:input].is_a? Hash
+          input = Thor::CoreExt::HashWithIndifferentAccess.new options[:input]
+          raise Fontcustom::Error, "INPUT should be a string or a hash containing a \"vectors\" key." unless input[:vectors]
+          input[:vectors] = File.expand_path File.join(options[:project_root], input[:vectors])
+          raise Fontcustom::Error, "INPUT[\"vectors\"] should be a directory. Check #{input[:vectors]} and try again." unless File.directory? input[:vectors]
+          if input[:templates]
+            input[:templates] = File.expand_path File.join(options[:project_root], input[:templates])
+            raise Fontcustom::Error, "INPUT[\"templates\"] should be a directory. Check #{input[:templates]} and try again." unless File.directory? input[:templates]
+          else
+            input[:templates] = input[:vectors]
+          end
+          input
+        elsif options[:input].is_a? String
+          input = File.join options[:project_root], options[:input]
+          raise Fontcustom::Error, "INPUT should be a directory. Check #{input} and try again." unless File.directory? input
+          Thor::CoreExt::HashWithIndifferentAccess.new({
+            :vectors => input,
+            :templates => input
+          })
+        end
+        if Dir[File.join(paths[:vectors], "*.{svg,eps}")].empty?
+          raise Fontcustom::Error, "#{paths[:vectors]} doesn't contain any vectors (*.svg or *.eps files)."
+        end
+        paths
+      end
+      def get_output_paths(options)
+        if options[:output].is_a? Hash
+          output = Thor::CoreExt::HashWithIndifferentAccess.new options[:output]
+          raise Fontcustom::Error, "OUTPUT should be a string or a hash containing a \"fonts\" key." unless output[:fonts]
+          output.each do |key, val|
+            output[key] = File.expand_path File.join(options[:project_root], val)
+          end
+          output[:css] ||= output[:fonts]
+          output[:preview] ||= output[:fonts]
+          output
+        else
+          if options[:output].is_a? String
+            output = File.expand_path File.join(options[:project_root], options[:output])
+            raise Fontcustom::Error, "OUTPUT should be a directory, not a file. Check #{output} and try again." if File.exists?(output) && ! File.directory?(output)
+          else
+            # TODO friendly warning that we're defaulting to pwd/:font_name
+            output = File.join options[:project_root], options[:font_name]
+          end
+          Thor::CoreExt::HashWithIndifferentAccess.new({
+            :fonts => output,
+            :css => output,
+            :preview => output
+          })
         end
       end
@@ -54,8 +137,10 @@ module Fontcustom
       #
       # Could arguably belong in Generator::Template, however, it's nice to
       # be able to catch template errors before any generator runs.
-      def get_template_paths(options)
+      def get_templates(options)
+        # ensure that preview has plain stylesheet to reference
         options[:templates] << "css" if options[:templates].include?("preview") && ! options[:templates].include?("css")
         options[:templates].map do |template|
           case template
           when "preview"
@@ -73,21 +158,13 @@ module Fontcustom
           when "bootstrap-ie7-scss"
             File.join gem_lib_path, "templates", "_fontcustom-bootstrap-ie7.scss"
           else
-            if File.exists?(template)
-              template
-            elsif File.exists?(File.join(options[:input], template))
-              File.join options[:input], template
-            else
-              raise Fontcustom::Error, "We couldn't find your custom template #{template}. Double check and try again?"
-            end
+            path = File.join options[:input][:templates], template
+            raise Fontcustom::Error, "We couldn't find your custom template at #{path}. Double check and try again?" unless File.exists? path
+            path
           end
         end
       end
-      def clear_file(file)
-        File.open(file, "w") {}
-      end
       def gem_lib_path
         File.expand_path(File.join(File.dirname(__FILE__)))
       end

data/lib/fontcustom/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Fontcustom
-  VERSION = "1.0.1"
+  VERSION = "1.1.0.pre"
 end

data/lib/fontcustom/watcher.rb CHANGED

@@ -5,34 +5,50 @@ module Fontcustom
   class Watcher
     def initialize(opts)
       @opts = opts
-      @listener = Listen.to(@opts[:input]).relative_paths(true).filter(/\.(eps|svg)$/).change(&callback)
+      @vector_listener = Listen.to(@opts[:input][:vectors]).relative_paths(true).filter(/\.(eps|svg)$/).change(&callback)
+      templates = @opts[:templates].dup
+      templates.delete_if do |template|
+        template.match Util.gem_lib_path
+      end
+      unless templates.empty?
+        templates = templates.map do |template|
+          File.basename template
+        end
+        @template_listener = Listen.to(@opts[:input][:templates]).relative_paths(true).filter(/(#{templates.join("|")})/).change(&callback)
+      end
       @opts[:blocking] = @opts[:blocking] == false ? false : true
-      @listener = @listener.polling_fallback_message(false) unless @opts[:blocking]
+      unless @opts[:blocking]
+        @vector_listener = @vector_listener.polling_fallback_message(false)
+        @template_listener = @template_listener.polling_fallback_message(false) if @template_listener
+      end
     end
     def watch
-      puts "Font Custom is watching your icons at #{@opts[:input]}. Press Ctrl + C to stop."
+      puts "Font Custom is watching your icons at #{@opts[:input][:vectors]}. Press Ctrl + C to stop."
       compile unless @opts[:skip_first]
       if @opts[:blocking]
-        @listener.start!
+        @vector_listener.start!
+        @template_listener.start! if @template_listener
       else
-        @listener.start
+        @vector_listener.start
+        @template_listener.start if @template_listener
       end
     rescue Fontcustom::Error => e
       show_error e
     # Catches Ctrl + C
-    # TODO Does the listen gem have a better way of handling this?
     rescue SignalException
       stop
     end
     def stop
-      # Adding a newline so message is not prepended with ^C on SIGTERM
+      @vector_listener.stop
+      @template_listener.stop if @template_listener
       puts "\nFont Custom is signing off. Good night and good luck."
-      @listener.stop
     end
     private