fontcustom 0.1.4 → 1.0.0.pre

data/spec/fontcustom/util_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Fontcustom::Util do
+  def util
+    Fontcustom::Util
+  end
+
+  context ".check_fontforge" do
+    it "should raise error if fontforge isn't installed" do
+      util.stub(:"`").and_return("")
+      expect { util.check_fontforge }.to raise_error Fontcustom::Error, /install fontforge/
+    end
+  end
+
+  context ".collect_options" do
+    it "should return defaults when called without arguments" do
+      options = util.collect_options
+      defaults = Fontcustom::DEFAULT_OPTIONS.dup
+
+      # ignore :templates and :output since they're generated
+      options.delete(:templates)
+      defaults.delete(:templates)
+      options.delete(:output)
+      defaults.delete(:output)
+
+      options.should == defaults
+    end
+
+    it "should overwrite defaults with config file" do
+      options = util.collect_options :config => fixture("fontcustom.yml")
+      options[:font_name].should == "custom-name-from-config"
+    end
+
+    it "should overwrite config file and defaults with CLI options" do
+      options = util.collect_options :config => fixture("fontcustom.yml"), :font_name => "custom-name-from-cli"
+      options[:font_name].should == "custom-name-from-cli"
+    end
+
+    it "should normalize file name" do
+      options = util.collect_options :font_name => " A_stR4nG3 nAm3  "
+      options[:font_name].should == "a_str4ng3-nam3"
+    end
+  end
+
+  context ".get_config_path" do
+    it "should search for fontcustom.yml if options[:config] is a dir" do
+      options = { :config => fixture("") }
+      util.get_config_path(options).should == fixture("fontcustom.yml")
+    end
+
+    it "should search use options[:config] if it's a file" do
+      options = { :config => fixture("fontcustom.yml") }
+      util.get_config_path(options).should == fixture("fontcustom.yml")
+    end
+
+    it "should search in input dir if no options[:config] is given" do
+      options = { :input => fixture("") }
+      util.get_config_path(options).should == fixture("fontcustom.yml")
+    end
+
+    it "should return false if neither exist" do
+      options = { :input => fixture("vectors") }
+      util.get_config_path(options).should be_false
+    end
+  end
+
+  context ".get_template_paths" do
+    it "should ensure that 'css' is included with 'preview'" do
+      lib = util.gem_lib_path
+      options = { :input => fixture("vectors"), :templates => %W|preview| }
+      templates = util.get_template_paths options
+      templates.should =~ [
+        File.join(lib, "templates", "fontcustom.css"), 
+        File.join(lib, "templates", "fontcustom.html")
+      ]
+    end
+
+    it "should expand shorthand for packaged templates" do
+      lib = util.gem_lib_path
+      options = { :input => fixture("vectors"), :templates => %W|css scss preview| }
+      templates = util.get_template_paths options
+      templates.should =~ [
+        File.join(lib, "templates", "fontcustom.css"), 
+        File.join(lib, "templates", "_fontcustom.scss"),
+        File.join(lib, "templates", "fontcustom.html")
+      ]
+    end
+
+    it "should search in Dir.pwd first" do
+      Dir.chdir fixture("")
+      options = { :templates => %W|not-a-dir| }
+      templates = util.get_template_paths options
+      templates.should =~ ["not-a-dir"]
+    end
+
+    it "should search in options[:input] second" do
+      options = { :input => fixture("empty"), :templates => %W|no_vectors_here.txt| }
+      templates = util.get_template_paths options
+      templates.should =~ [fixture("empty/no_vectors_here.txt")]
+    end
+
+    it "should raise an error if a template does not exist" do
+      options = { :input => fixture("vectors"), :templates => %W|css #{fixture("fake-template")}| }
+      expect { util.get_template_paths options }.to raise_error(
+        Fontcustom::Error, /couldn't find.+#{fixture("fake-template")}/
+      )
+    end
+  end
+end

data/spec/fontcustom/watcher_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require "fileutils"
+require "fontcustom/watcher"
+
+describe Fontcustom::Watcher do
+  def watcher(options)
+    Fontcustom::Generator::Font.stub :start
+    Fontcustom::Generator::Template.stub :start
+    opts = Fontcustom::Util.collect_options options
+    opts[:blocking] = false # undocumented — non-blocking use of watcher
+    Fontcustom::Watcher.new opts
+  end
+
+  context "#watch" do
+    it "should call generators on init" do
+      Fontcustom::Generator::Font.should_receive(:start).once
+      Fontcustom::Generator::Template.should_receive(:start).once
+      w = watcher :input => fixture("vectors"), :output => fixture("watcher-test")
+      # silence output
+      capture(:stdout) do
+        w.watch
+        w.stop
+      end
+    end
+
+    it "should not call generators on init if options[:skip_first] is passed" do
+      Fontcustom::Generator::Font.should_not_receive(:start)
+      Fontcustom::Generator::Template.should_not_receive(:start)
+      w = watcher :input => fixture("vectors"), :output => fixture("watcher-test"), :skip_first => true
+      capture(:stdout) do
+        w.watch
+        w.stop
+      end
+    end
+
+    it "should call generators when vectors change" do
+      Fontcustom::Generator::Font.should_receive(:start).once
+      Fontcustom::Generator::Template.should_receive(:start).once
+      w = watcher :input => fixture("vectors"), :output => fixture("watcher-test"), :skip_first => true
+      capture(:stdout) do
+        begin
+          w.watch
+          FileUtils.cp fixture("vectors/C.svg"), fixture("vectors/test.svg")
+        ensure
+          w.stop
+          new = fixture("vectors/test.svg")
+          FileUtils.rm(new) if File.exists?(new)
+        end
+      end
+    end
+
+    it "should do nothing when non-vectors change" do
+      Fontcustom::Generator::Font.should_not_receive(:start)
+      Fontcustom::Generator::Template.should_not_receive(:start)
+      w = watcher :input => fixture("vectors"), :output => fixture("watcher-test"), :skip_first => true
+      capture(:stdout) do
+        begin
+          w.watch
+          FileUtils.touch fixture("vectors/non-vector-file")
+        ensure
+          w.stop
+          new = fixture("vectors/non-vector-file")
+          FileUtils.rm(new) if File.exists?(new)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,29 +1,39 @@
-require 'spork'
+require 'rspec'
+require 'json'
+require File.expand_path('../../lib/fontcustom.rb', __FILE__)
 
-Spork.prefork do
-  require 'rspec'
-  require 'fileutils'
+RSpec.configure do |c|
+  def fixture(path)
+    File.join(File.expand_path('../fixtures', __FILE__), path)
+  end
 
-  RSpec.configure do |c|
-    def cleanup(dir)
-      FileUtils.rm_r(dir, :verbose => true) if File.exists?(dir)
-    end
+  def data_file_contents
+    {
+      :fonts => %w|
+        fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.woff
+        fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.ttf
+        fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.eot
+        fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.svg
+      |,
+      :templates => %w|fontcustom.css|,
+      :file_name => "fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e", 
+      :glyphs => %w|a_r3ally-exotic-f1le-name c d|
+    }
+  end
 
-    def capture(stream)
-      begin
-        stream = stream.to_s
-        eval "$#{stream} = StringIO.new"
-        yield
-        result = eval("$#{stream}").string
-      ensure
-        eval("$#{stream} = #{stream.upcase}")
-      end
+  def fontforge_output
+    "Copyright (c) 2000-2012 by George Williams.\n Executable based on sources from 14:57 GMT 31-Jul-2012-D.\n Library based on sources from 14:57 GMT 31-Jul-2012.\n#{data_file_contents.to_json}"
+  end
 
-      result
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
     end
+    result
   end
 end
-
-Spork.each_run do
-  require File.expand_path('../../lib/fontcustom.rb', __FILE__)
-end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: fontcustom
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 1.0.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Yifei Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-19 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -108,88 +108,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: spork
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-spork
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.1
-description: Transforms EPS and SVG vectors into icon webfonts. Generates Bootstrap
-  compatible CSS for easy inclusion in your projects.
+description: Transforms EPS and SVG vectors into icon webfonts. Generates CSS (or
+  your preferred alternative) for easy inclusion in your projects.
 email:
 - yz@yifei.co
 - joshua@gross.is
@@ -210,24 +130,42 @@ files:
 - fontcustom.gemspec
 - lib/fontcustom.rb
 - lib/fontcustom/cli.rb
-- lib/fontcustom/generator.rb
+- lib/fontcustom/error.rb
+- lib/fontcustom/generator/font.rb
+- lib/fontcustom/generator/template.rb
+- lib/fontcustom/options.rb
 - lib/fontcustom/scripts/eotlitetool.py
 - lib/fontcustom/scripts/generate.py
 - lib/fontcustom/scripts/sfnt2woff
+- lib/fontcustom/templates/_fontcustom.scss
 - lib/fontcustom/templates/fontcustom-ie7.css
 - lib/fontcustom/templates/fontcustom.css
-- lib/fontcustom/templates/test.html
+- lib/fontcustom/templates/fontcustom.html
+- lib/fontcustom/templates/fontcustom.yml
+- lib/fontcustom/util.rb
 - lib/fontcustom/version.rb
 - lib/fontcustom/watcher.rb
+- spec/fixtures/empty-data/.fontcustom-data
 - spec/fixtures/empty/no_vectors_here.txt
+- spec/fixtures/fontcustom.yml
+- spec/fixtures/mixed-output/.fontcustom-data
+- spec/fixtures/mixed-output/another-font.ttf
+- spec/fixtures/mixed-output/dont-delete-me.bro
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.eot
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.svg
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.ttf
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.woff
+- spec/fixtures/mixed-output/fontcustom.css
+- spec/fixtures/not-a-dir
 - spec/fixtures/vectors/C.svg
 - spec/fixtures/vectors/D.svg
 - spec/fixtures/vectors/a_R3ally-eXotic f1Le Name.svg
-- spec/fontcustom/fontcustom_spec.rb
-- spec/fontcustom/generator_spec.rb
-- spec/fontcustom/watcher_spec.rb.off
+- spec/fontcustom/generator/font_spec.rb
+- spec/fontcustom/generator/template_spec.rb
+- spec/fontcustom/util_spec.rb
+- spec/fontcustom/watcher_spec.rb
 - spec/spec_helper.rb
-homepage: http://endtwist.github.com/fontcustom/
+homepage: http://fontcustom.com
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -241,16 +179,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2717137854162198806
+      hash: -3519366396623315767
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 2717137854162198806
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -258,11 +193,23 @@ signing_key:
 specification_version: 3
 summary: Generate custom icon webfonts from the comfort of the command line.
 test_files:
+- spec/fixtures/empty-data/.fontcustom-data
 - spec/fixtures/empty/no_vectors_here.txt
+- spec/fixtures/fontcustom.yml
+- spec/fixtures/mixed-output/.fontcustom-data
+- spec/fixtures/mixed-output/another-font.ttf
+- spec/fixtures/mixed-output/dont-delete-me.bro
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.eot
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.svg
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.ttf
+- spec/fixtures/mixed-output/fontcustom-cc5ce52f2ae4f9ce2e7ee8131bbfee1e.woff
+- spec/fixtures/mixed-output/fontcustom.css
+- spec/fixtures/not-a-dir
 - spec/fixtures/vectors/C.svg
 - spec/fixtures/vectors/D.svg
 - spec/fixtures/vectors/a_R3ally-eXotic f1Le Name.svg
-- spec/fontcustom/fontcustom_spec.rb
-- spec/fontcustom/generator_spec.rb
-- spec/fontcustom/watcher_spec.rb.off
+- spec/fontcustom/generator/font_spec.rb
+- spec/fontcustom/generator/template_spec.rb
+- spec/fontcustom/util_spec.rb
+- spec/fontcustom/watcher_spec.rb
 - spec/spec_helper.rb

data/lib/fontcustom/generator.rb

@@ -1,105 +0,0 @@
-require 'json'
-require 'thor/group'
-
-module Fontcustom
-  class Generator < Thor::Group
-    include Thor::Actions
-
-    desc 'Generates webfonts from given directory of vectors.'
-
-    argument :input, :type => :string
-    class_option :output, :aliases => '-o'
-    class_option :name, :aliases => '-n'
-    class_option :font_path, :aliases => '-f'
-    class_option :nohash, :type => :boolean, :default => false
-    class_option :debug, :type => :boolean, :default => false
-    class_option :html, :type => :boolean, :default => false
-
-    def self.source_root
-      File.dirname(__FILE__)
-    end
-
-    def verify_fontforge
-      if `which fontforge` == ''
-        raise Thor::Error, 'Please install fontforge first.'
-      end
-    end
-
-    def verify_input_dir
-      if ! File.directory?(input)
-        raise Thor::Error, "#{input} doesn't exist or isn't a directory."
-      elsif Dir[File.join(input, '*.{svg,eps}')].empty?
-        raise Thor::Error, "#{input} doesn't contain any vectors (*.svg or *.eps files)."
-      end
-    end
-
-    def verify_or_create_output_dir
-      @output = options.output.nil? ? File.join(File.dirname(input), 'fontcustom') : options.output
-      empty_directory(@output) unless File.directory?(@output)
-    end
-
-    def normalize_name
-      @name = if options.name
-        options.name.gsub(/\W/, '-').downcase
-      else
-        'fontcustom'
-      end
-    end
-
-    def cleanup_output_dir
-      css = File.join(@output, 'fontcustom.css')
-      css_ie7   = File.join(@output, 'fontcustom-ie7.css')
-      test_html = File.join(@output, 'test.html')
-      old_name = if File.exists? css
-                   line = IO.readlines(css)[5]                           # font-family: "Example Font";
-                   line.scan(/".+"/)[0][1..-2].gsub(/\W/, '-').downcase  # => 'example-font'
-                 else
-                   'fontcustom'
-                 end
-
-      old_files = Dir[File.join(@output, old_name + '-*.{woff,ttf,eot,svg}')]
-      old_files << css if File.exists?(css)
-      old_files << css_ie7 if File.exists?(css_ie7)
-      old_files << test_html if File.exists?(test_html)
-      old_files.each {|file| remove_file file }
-    end
-
-    def generate
-      gem_file_path = File.expand_path(File.join(File.dirname(__FILE__)))
-      name = options.name ? ' --name ' + @name : ''
-      nohash = options.nohash ? ' --nohash' : ''
-
-      # suppress fontforge message
-      # TODO get font name and classes from script (without showing fontforge message)
-      cmd = "fontforge -script #{gem_file_path}/scripts/generate.py #{input} #{@output + name + nohash}"
-      unless options.debug
-        cmd += " > /dev/null 2>&1"
-      end
-      `#{cmd}`
-    end
-
-    def show_paths
-      file = Dir[File.join(@output, @name + '*.ttf')].first
-      @path = file.chomp('.ttf')
-
-      ['woff','ttf','eot','svg'].each do |type|
-        say_status(:create, @path + '.' + type)
-      end
-    end
-
-    def create_stylesheet
-      files = Dir[File.join(input, '*.{svg,eps}')]
-      @classes = files.map {|file| File.basename(file)[0..-5].gsub(/\W/, '-').downcase }
-      if(!options.font_path.nil?)
-        font_path = (options.font_path) ? options.font_path : ''
-        @path = File.join(font_path, File.basename(@path))
-      else
-        @path = File.basename(@path)
-      end
-
-      template('templates/fontcustom.css', File.join(@output, 'fontcustom.css'))
-      template('templates/fontcustom-ie7.css', File.join(@output, 'fontcustom-ie7.css'))
-      template('templates/test.html', File.join(@output, 'test.html')) if options.html
-    end
-  end
-end