fontcustom 1.1.0.pre2 → 1.1.0

data/lib/fontcustom/templates/fontcustom.css

@@ -1,4 +1,4 @@
-/* 
+/*
   Icon Font: <%= @opts.font_name %>
 */
 
@@ -13,6 +13,9 @@
   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.yml

@@ -1,30 +1,30 @@
 # ---------------------------------------------------------------------------- #
 # Project Info
-#   Learn more about these options by running `fontcustom help` or visit
-#   <http://fontcustom.com>.
+#   Default values shown. Learn more about these options by running
+#   `fontcustom help` or visit <http://fontcustom.com>.
 # ---------------------------------------------------------------------------- #
 
-#font_name: My Custom Font
-#file_hash: false
-#css_prefix: glyph-
-#preprocessor_path: fonts/fontcustom
-#debug: true
-#verbose: false
+#font_name: fontcustom
+#css_prefix: icon-
+#preprocessor_path: ""
+#no_hash: false
+#debug: false
+#quiet: false
 
 
 # ---------------------------------------------------------------------------- #
 # Project Paths
-#   All paths are relative to PROJECT_ROOT (default: working directory).
-#   PROJECT_ROOT can be configured (absolute path recommended).
-#   For finer control, assign INPUT and OUTPUT as hashes instead of a strings.
+#   Relative paths are expanded from PROJECT_ROOT (default: working directory).
+#   INPUT and OUTPUT can be assigned as hashes instead of a strings.
 #   The OUPUT hash can route custom templates according to their filename.
 # ---------------------------------------------------------------------------- #
 
 #project_root: some/other/place
+#data_cache: tmp/fontcustom
 
 #input:
-#  vectors: app/assets/fontcustom/vectors
-#  templates: app/assets/fontcustom/templates
+#  vectors: app/assets/fonts/fontcustom/vectors
+#  templates: app/assets/fonts/fontcustom/templates
 
 #output:
 #  fonts: app/assets/fonts
@@ -36,7 +36,7 @@
 # ---------------------------------------------------------------------------- #
 # Templates
 #   Included in Font Custom:
-#     preview, css, scss, bootstrap, bootstrap-scss, bootstrap-ie7,
+#     preview, css, scss, scss-rails, bootstrap, bootstrap-scss, bootstrap-ie7,
 #     bootstrap-ie7-scss
 #   Custom templates should be saved in the INPUT[:templates] directory.
 # ---------------------------------------------------------------------------- #

data/lib/fontcustom/util.rb

@@ -1,35 +1,45 @@
 ##
-# Needs access to @shell and an Options instance 
+# Needs access to @shell and an Options instance
 # (@opts in thor, @cli_options or self in Options)
 module Fontcustom
   module Util
     def check_fontforge
       fontforge = `which fontforge`
       if fontforge == "" || fontforge == "fontforge not found"
-        raise Fontcustom::Error, "Please install fontforge. Visit http://fontcustom.com for instructions."
+        raise Fontcustom::Error, "Please install fontforge. Visit <http://fontcustom.com> for instructions."
       end
     end
 
     def say_changed(status, changed)
-      return unless base(:verbose)
+      return if base(:quiet)
       message = changed.map { |file| relative_to_root(file) }
-      @shell.say_status status, message.join(" ")
+      @shell.say_status status, message.join("\n#{" " * 14}"), :green # magic number
     end
 
-    def say_message(status, message)
-      return unless base(:verbose)
-      @shell.say_status status, message
+    def say_message(status, message, color = :yellow)
+      return if base(:quiet) && status != :error
+      @shell.say_status status, message, color
+    end
+
+    def expand_path(path)
+      return path if path[0] == "/"
+      File.expand_path File.join(base(:project_root), path)
     end
 
     def relative_to_root(path)
       path = path.sub(base(:project_root), "")
       path = path[1..-1] if path[0] == "/"
+      path = "." if path.empty?
       path
     end
 
     def overwrite_file(file, content = "")
       File.open(file, "w") { |f| f.write(content) }
-      say_changed :update, [ file ]
+      # say_changed :update, [ file ]
+    end
+
+    def symbolize_hash(hash)
+      hash.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
     end
 
     private

data/lib/fontcustom/version.rb

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

data/lib/fontcustom/watcher.rb

@@ -3,6 +3,8 @@ require "listen"
 
 module Fontcustom
   class Watcher
+    include Util
+
     def initialize(opts)
       @opts = opts
       @vector_listener = Listen.to(@opts.input[:vectors]).relative_paths(true).filter(/\.(eps|svg)$/).change(&callback)
@@ -27,56 +29,56 @@ module Fontcustom
     end
 
     def watch
-      puts "Font Custom is watching your icons at #{@opts.input[:vectors]}. Press Ctrl + C to stop."
       compile unless @opts.skip_first
+      start
+    rescue SignalException # Catches Ctrl + C
+      stop
+    end
 
-      # Non-blocking if test
-      if @is_test
+    private
+
+    def start
+      if @is_test # Non-blocking listener
         @vector_listener.start
         @template_listener.start if @template_listener
       else
         @vector_listener.start!
         @template_listener.start! if @template_listener
       end
-
-    rescue Fontcustom::Error => e
-      show_error e
-
-    # Catches Ctrl + C
-    rescue SignalException
-      stop
     end
 
     def stop
       @vector_listener.stop
       @template_listener.stop if @template_listener
-      puts "\nFont Custom is signing off. Good night and good luck."
+      say "\nFont Custom is signing off. Good night and good luck.", :yellow
     end
 
-    private
-
     def callback
       Proc.new do |modified, added, removed|
         begin
-          puts "  >> Changed: " + modified.join(", ") unless modified.empty?
-          puts "  >> Added: " + added.join(", ") unless added.empty?
-          puts "  >> Removed: " + removed.join(", ") unless removed.empty?
-
+          say_message :changed, modified.join(", ") unless modified.empty?
+          say_message :added, added.join(", ") unless added.empty?
+          say_message :removed, removed.join(", ") unless removed.empty?
           changed = modified + added + removed
           compile unless changed.empty?
         rescue Fontcustom::Error => e
-          show_error e
+          say_message :error, e.message, :red
         end
       end
     end
 
     def compile
-      Fontcustom::Generator::Font.start [@opts]
-      Fontcustom::Generator::Template.start [@opts]
+      Generator::Font.start [@opts]
+      Generator::Template.start [@opts]
+    end
+
+    def say(*args)
+      return if @opts.quiet
+      @opts.instance_variable_get(:@shell).say *args
     end
 
-    def show_error(err)
-      puts "ERROR: #{err.message}"
+    def say_message(*args)
+      @opts.say_message *args
     end
   end
 end

data/spec/fixtures/shared/templates/custom.css

@@ -1 +1,7 @@
+/*
+<%= @glyphs.inspect %>
+*/
 .foo { color: black; }
+
+.bar { color: red; }
+.bar { color: red; }

data/spec/fixtures/shared/templates/regular.css

@@ -1 +1,4 @@
+/*
+<%= @glyphs.inspect %>
+*/
 .foo { color: blue; }

data/spec/fontcustom/generator/font_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Fontcustom::Generator::Font do
-  # Silence messages without passing :verbose => false to everything
+  # Silence messages without passing :quiet => true to everything
   before(:each) do
     Fontcustom::Options.any_instance.stub :say_message
   end
@@ -45,7 +45,7 @@ describe Fontcustom::Generator::Font do
       options = {
         :project_root => fixture,
         :input => "shared/vectors",
-        :verbose => false
+        :quiet => true
       }
       gen = generator options
       gen.get_data
@@ -59,7 +59,7 @@ describe Fontcustom::Generator::Font do
         :config => "generators",
         :input => "shared/vectors",
         :output => "mixed-output",
-        :verbose => false
+        :quiet => true
       }
       gen = generator options
       gen.get_data
@@ -74,7 +74,7 @@ describe Fontcustom::Generator::Font do
         :data_cache => "generators/.fontcustom-data-corrupted",
         :input => "shared/vectors",
         :output => "mixed-output",
-        :verbose => false
+        :quiet => true
       }
       gen = generator options
       expect { gen.get_data }.to raise_error Fontcustom::Error, /corrupted/
@@ -87,7 +87,7 @@ describe Fontcustom::Generator::Font do
         :project_root => fixture,
         :input => "shared/vectors",
         :output => "mixed-output",
-        :verbose => false
+        :quiet => true
       }
       gen = generator options
       gen.stub :remove_file
@@ -131,19 +131,19 @@ describe Fontcustom::Generator::Font do
         :project_root => fixture,
         :input => "shared/vectors",
         :output => "mixed-output",
-        :verbose => false
+        :quiet => true
       )
-      gen.stub(:"`").and_return fontforge_output
+      gen.stub(:execute_and_clean).and_return [fontforge_stdout.split("\n"), fontforge_stderr, double(:status, :success? => true)]
       gen
     end
 
     it "should call fontforge" do
-      subject.should_receive(:"`").with(/fontforge -script/)
+      subject.should_receive(:execute_and_clean).with(/fontforge -script/)
       subject.generate
     end
 
     it "should pass options to fontforge" do
-      subject.should_receive(:"`").with(/#{fixture("shared/vectors")}.+#{fixture("mixed-output")}/)
+      subject.should_receive(:execute_and_clean).with(/#{fixture("shared/vectors")}.+#{fixture("mixed-output")}/)
       subject.generate
     end
 
@@ -160,7 +160,7 @@ describe Fontcustom::Generator::Font do
         :output => "fake-dir-should-cause-failure",
         :debug => true
       )
-      expect { capture(:stdout) { gen.generate } }.to raise_error Fontcustom::Error, /failed unexpectedly/
+      expect { capture(:stdout) { gen.generate } }.to raise_error Fontcustom::Error, /failed/
     end
   end
 
@@ -197,12 +197,12 @@ describe Fontcustom::Generator::Font do
       stdout.should =~ /create.+\.(woff|ttf|eot|svg)/
     end
 
-    it "should print nothing if verbose is false" do
+    it "should print nothing if :quiet is set" do
       gen = generator(
         :project_root => fixture,
         :input => "shared/vectors",
         :output => "output",
-        :verbose => false
+        :quiet => true
       )
       gen.instance_variable_set :@data, data_file_contents
       stdout = capture(:stdout) { gen.announce_files }
@@ -228,12 +228,12 @@ describe Fontcustom::Generator::Font do
       gen.save_data
     end
 
-    it "should be silent if verbose is false" do
+    it "should be silent if :quiet is set" do
       gen = generator(
         :project_root => fixture,
         :input => "shared/vectors",
         :output => "output",
-        :verbose => false
+        :quiet => true
       )
       gen.stub :overwrite_file
       gen.instance_variable_set(:@data, data_file_contents)

data/spec/fontcustom/generator/template_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Fontcustom::Generator::Template do
-  # Silence messages without passing :verbose => false to everything
+  # Silence messages without passing :quiet => true to everything
   before(:each) do
     Fontcustom::Options.any_instance.stub :say_message
   end
@@ -16,17 +16,16 @@ describe Fontcustom::Generator::Template do
       gen = generator(
         :project_root => fixture,
         :input => "shared/vectors",
-        :verbose => false
+        :quiet => true
       )
-      expect { gen.get_data }.to raise_error Fontcustom::Error, /\.fontcustom-data is required/
+      expect { gen.get_data }.to raise_error Fontcustom::Error, /\.fontcustom-data/
     end
 
-    # TODO ensure data file is correct
     it "should assign @data from data file" do
       gen = generator(
         :project_root => fixture("generators"),
         :input => "../shared/vectors",
-        :verbose => false
+        :quiet => true
       )
       gen.get_data
       gen.instance_variable_get(:@data)[:templates].should =~ data_file_contents[:templates]
@@ -39,7 +38,7 @@ describe Fontcustom::Generator::Template do
         :project_root => fixture("generators"),
         :input => "../shared/vectors",
         :output => "mixed-output",
-        :verbose => false
+        :quiet => true
       )
       gen.stub :remove_file
       gen.stub :overwrite_file
@@ -77,21 +76,20 @@ describe Fontcustom::Generator::Template do
   end
 
   context "#make_relative_paths" do
-    it "should assign :css_to_fonts, :preview_to_fonts, and :preprocessor_to_fonts" do
+    it "should assign @font_path, @font_path_alt, and @font_path_preview" do
       gen = generator(
         :project_root => fixture,
         :input => "shared/vectors",
         :output => {:fonts => "foo/fonts", :css => "output/css", :preview => "views/"}
       )
-      gen.instance_variable_set "@data", data_file_contents
+      gen.instance_variable_set :@data, data_file_contents
       gen.make_relative_paths
-      data = gen.instance_variable_get("@data")
-      data[:paths][:css_to_fonts].should match("../../foo/fonts")
-      data[:paths][:preview_to_fonts].should match("../foo/fonts")
-      data[:paths][:preprocessor_to_fonts].should eq(data[:paths][:css_to_fonts])
+      gen.instance_variable_get(:@font_path).should match("../../foo/fonts")
+      gen.instance_variable_get(:@font_path_alt).should match("../../foo/fonts")
+      gen.instance_variable_get(:@font_path_preview).should match("../foo/fonts")
     end
 
-    it "should assign :preprocessor_to_css if :preprocessor_font_path is set" do
+    it "should assign @font_path_alt if :preprocessor_font_path is set" do
       gen = generator(
         :project_root => fixture,
         :preprocessor_font_path => "fonts/fontcustom",
@@ -100,8 +98,7 @@ describe Fontcustom::Generator::Template do
       )
       gen.instance_variable_set "@data", data_file_contents
       gen.make_relative_paths
-      data = gen.instance_variable_get("@data")
-      data[:paths][:preprocessor_to_fonts].should match("fonts/fontcustom")
+      gen.instance_variable_get(:@font_path_alt).should match("fonts/fontcustom")
     end
 
     it "should assign '.' when paths are the same" do
@@ -112,8 +109,7 @@ describe Fontcustom::Generator::Template do
       )
       gen.instance_variable_set "@data", data_file_contents
       gen.make_relative_paths
-      data = gen.instance_variable_get("@data")
-      data[:paths][:css_to_fonts].should match("./")
+      gen.instance_variable_get(:@font_path).should match("./")
     end
   end
 
@@ -124,7 +120,7 @@ describe Fontcustom::Generator::Template do
         :input => {:vectors => "../shared/vectors", :templates => "../shared/templates"},
         :output => "mixed-output",
         :templates => %W|scss css custom.css|,
-        :verbose => false
+        :quiet => true
       )
       gen.instance_variable_set :@data, data_file_contents
       gen.stub :template
@@ -150,11 +146,28 @@ describe Fontcustom::Generator::Template do
       subject.generate
     end
 
-    it "should be silent if verbose is false" do
+    it "should be silent if :quiet is set" do
       stdout = capture(:stdout) { subject.generate }
       stdout.should == ""
     end
 
+    it "should rename stock templates according to opts.font_name" do
+      gen = generator(
+        :project_root => fixture("generators"),
+        :font_name => "Test Font",
+        :input => {:vectors => "../shared/vectors", :templates => "../shared/templates"},
+        :templates => %W|scss css|,
+        :quiet => true
+      )
+      gen.instance_variable_set :@data, data_file_contents
+      gen.stub :template
+      gen.stub :overwrite_file
+      gen.should_receive(:template).exactly(2).times do |*args|
+        args[1].should match(/(Test-Font\.css|_Test-Font\.scss)/)
+      end
+      gen.generate
+    end
+
     context "when various output locations are given" do
       subject do
         gen = generator(
@@ -162,7 +175,7 @@ describe Fontcustom::Generator::Template do
           :input => {:vectors => "shared/vectors", :templates => "shared/templates"},
           :output => {:fonts => "output/fonts", :css => "output/css", :preview => "output/views", "custom.css" => "output/custom"},
           :templates => %W|scss preview css custom.css regular.css|,
-          :verbose => false
+          :quiet => true
         )
         gen.instance_variable_set :@data, data_file_contents
         gen.stub :template
@@ -173,7 +186,7 @@ describe Fontcustom::Generator::Template do
       # 6 times because preview also includes preview-css
       it "should output custom templates to their matching :output paths" do
         subject.should_receive(:template).exactly(5).times do |*args|
-          if File.basename(args[0]) == "custom.css"
+          if File.basename(args[0]) == :"custom.css"
             args[1].should == fixture("output/custom/custom.css")
           end
         end