fontcustom 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.1.0 (12/2/2012)
+
+* Changed API to use Thor `class_option`s
+* Added option to change the name of the font and generated files ([#6](https://github.com/endtwist/fontcustom/issues/6))
+* Added option to disable the file name hash ([#13](https://github.com/endtwist/fontcustom/issues/13))
+* `fontcustom watch` compiles automatically on the first run
+* Better help messages
+
+## 0.0.2 (11/26/2012)
+
+* Fixed gemspec dependency bug ([#2](https://github.com/endtwist/fontcustom/pull/2))
+* Fixed Windows Chrome PUA bug ([#1](https://github.com/endtwist/fontcustom/issues/1))

data/README.md

@@ -1,4 +1,4 @@
-FontCustom v0.0.1
+FontCustom v0.0.2
 ==========
 
 **Generate custom icon webfonts from the comfort of the command line.**

data/Rakefile

@@ -2,8 +2,8 @@ require "bundler/gem_tasks"
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << 'lib/fontcustom'
-  t.test_files = FileList['test/lib/fontcustom/*_test.rb']
+  t.libs = t.libs + ['lib/fontcustom', 'spec', 'spec/fixtures']
+  t.test_files = FileList['spec/fontcustom/*_spec.rb']
   t.verbose = true
 end
 

data/lib/fontcustom.rb

@@ -3,14 +3,10 @@ require 'fontcustom/generator'
 require 'fontcustom/watcher'
 
 module Fontcustom
-  # Both .compile and .watch take the following arguments:
-  #
-  # @param [String] the input dir
-  # @param [String] the output dir (optional, defaults to fontcustom/ adjacent to the input dir)
-  # @param [Hash] options for Thor (not working)
+  # Usage:
+  # Fontcustom.compile 'path/to/vectors', '-o', 'path/to/output'
   def compile(*args)
-    config = args.last.is_a?(::Hash) ? args.pop : {}
-    Fontcustom::Generator.start(args, config)
+    Fontcustom::Generator.start(args) # as array
   end
 
   def watch(*args)

data/lib/fontcustom/cli.rb

@@ -3,14 +3,22 @@ require 'fontcustom'
 
 module Fontcustom
   class CLI < Thor
-    desc 'compile INPUT_DIR [OUTPUT_DIR]', 'Generates icon webfonts and a corresponding CSS file from a collection of vector images.'
-    def compile(input, output = nil)
-      Fontcustom.compile(input, output)
+    # duplicated from Fontcustom::Generator so as to also appear under `fontcustom help` command
+    class_option :output, :aliases => '-o', :desc => 'Specify an output directory. Default: $DIR/fontcustom'
+    class_option :name, :aliases => '-n', :desc => 'Specify a font name. This will be used in the generated fonts and CSS. Default: fontcustom'
+    class_option :nohash, :type => :boolean, :default => false, :desc => 'Disable filename hashes. Default: false'
+
+    desc 'compile DIR [options]', 'Generates webfonts and CSS from *.svg and *.eps files in DIR.'
+    def compile(*args)
+      # workaround to pass arguments from one Thor class to another
+      ARGV.shift
+      Fontcustom.compile(*ARGV)
     end
 
-    desc 'watch INPUT_DIR [OUTPUT_DIR]', 'Watches a directory of vector images for changes and regenerates icon webfonts and CSS when there are.'
-    def watch(input, output = nil)
-      Fontcustom.watch(input, output)
+    desc 'watch DIR [options]', 'Watches DIR for changes and regenerates webfonts and CSS automatically.'
+    def watch(*args)
+      ARGV.shift
+      Fontcustom.watch(*ARGV)
     end
   end
 end

data/lib/fontcustom/generator.rb

@@ -8,12 +8,20 @@ module Fontcustom
     desc 'Generates webfonts from given directory of vectors.'
 
     argument :input, :type => :string
-    argument :output, :type => :string, :optional => true
+    class_option :output, :aliases => '-o'
+    class_option :name, :aliases => '-n'
+    class_option :nohash, :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."
@@ -23,32 +31,56 @@ module Fontcustom
     end
 
     def verify_or_create_output_dir
-      @output = output.nil? ? File.join(File.dirname(input), 'fontcustom') : output
+      @output = options.output.nil? ? File.join(File.dirname(input), 'fontcustom') : options.output
       empty_directory(@output) unless File.directory?(@output)
     end
 
-    def cleanup_output_dir
-      originals = Dir[File.join(@output, 'fontcustom*.{css,woff,ttf,eot,svg}')]
-      originals.each do |file|
-        remove_file file
+    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')
+      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.each {|file| remove_file file }
+    end
+
     def generate
       gem_file_path = File.expand_path(File.join(File.dirname(__FILE__)))
-      @font = %x| fontforge -script #{gem_file_path}/scripts/generate.py #{input} #{@output} 2>&1 /dev/null |
-      @font = JSON.parse(@font.split("\n").last)
+      name = options.name ? ' --name ' + @name : ''
+      nohash = options.nohash ? ' --nohash' : ''
+
+      # suppress fontforge message
+      # TODO get font name and classes from script (without showing fontforge message)
+      `fontforge -script #{gem_file_path}/scripts/generate.py #{input} #{@output + name + nohash} > /dev/null 2>&1`
     end
 
     def show_paths
-      path = @font['file']
+      file = Dir[File.join(@output, @name + '*.ttf')].first
+      @path = file.chomp('.ttf')
+
       ['woff','ttf','eot','svg'].each do |type|
-        say_status(:create, path + '.' + type)
+        say_status(:create, @path + '.' + type)
       end
     end
 
     def create_stylesheet
-      @font['file'] = File.basename(@font['file'])
+      files = Dir[File.join(input, '*.{svg,eps}')]
+      @classes = files.map {|file| File.basename(file)[0..-5].gsub(/\W/, '-').downcase }
+      @path = File.basename(@path)
+
       template('templates/fontcustom.css', File.join(@output, 'fontcustom.css'))
     end
   end

data/lib/fontcustom/scripts/generate.py

@@ -6,7 +6,9 @@ import json
 from subprocess import call
 
 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='+', help='directory of vector files')
+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('--nohash', '-n', action='store_true', help='disable hash fingerprinting of font files')
 args = parser.parse_args()
 
 f = fontforge.font()
@@ -39,10 +41,15 @@ for dirname, dirnames, filenames in os.walk(args.dir[0]):
 			files.append(name)
 			cp += 1
 
-hashStr = m.hexdigest()
-fontfile = args.dir[1] + '/fontcustom-' + hashStr
+if args.nohash:
+	fontfile = args.dir[1] + '/' + args.name
+else:
+	hashStr = m.hexdigest()
+	fontfile = args.dir[1] + '/' + args.name + '-' + hashStr
 
-f.fontname = 'fontcustom'
+f.fontname = args.name
+f.familyname = args.name
+f.fullname = args.name
 f.generate(fontfile + '.ttf')
 f.generate(fontfile + '.svg')
 
@@ -59,5 +66,3 @@ call(scriptPath + '/ttf2eot ' + fontfile + '.ttf > ' + fontfile + '.eot', shell=
 
 # Hint the TTF file
 call(scriptPath + '/ttfautohint -s -n ' + fontfile + '.ttf ' + fontfile + '-hinted.ttf && mv ' + fontfile + '-hinted.ttf ' + fontfile + '.ttf', shell=True)
-
-print json.dumps({'file': fontfile, 'names': files})

data/lib/fontcustom/templates/fontcustom.css

@@ -1,23 +1,23 @@
 /*
-Font Custom - icon webfonts made simple
+  Font Custom - icon webfonts made simple
 */
 
 @font-face {
-  font-family: "fontcustom";
-  src: url("<%= @font['file'] %>.eot?#iefix") format("embedded-opentype"),
-       url("<%= @font['file'] %>.woff") format("woff"),
-       url("<%= @font['file'] %>.ttf") format("truetype"),
-       url("<%= @font['file'] %>.svg#fontcustom") format("svg");
+  font-family: "<%= @name %>";
+  src: url("<%= @path %>.eot?#iefix") format("embedded-opentype"),
+       url("<%= @path %>.woff") format("woff"),
+       url("<%= @path %>.ttf") format("truetype"),
+       url("<%= @path %>.svg#<%= @name %>") format("svg");
   font-weight: normal;
   font-style: normal;
 }
 
 /*
-Bootstrap Overrides
+  Bootstrap Overrides
 */
 
 [class^="icon-"]:before, [class*=" icon-"]:before {
-  font-family: "fontcustom";
+  font-family: "<%= @name %>";
   font-weight: normal;
   font-style: normal;
   display: inline-block;
@@ -66,7 +66,7 @@ li[class^="icon-"].icon-large:before, li[class*=" icon-"].icon-large:before {
 }
 
 /*
-Icon Classes
+  Icon Classes
 */
-<% @font['names'].each_with_index do |name, index| %>
-.icon-<%= name.downcase %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>
+<% @classes.each_with_index do |name, index| %>
+.icon-<%= name %>:before { content: "\<%= (61696+index).to_s(16) %>"; }<% end %>

data/lib/fontcustom/version.rb

@@ -1,3 +1,3 @@
 module Fontcustom
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/fontcustom/watcher.rb

@@ -17,6 +17,7 @@ module Fontcustom
 
       begin
         puts "Fontcustom is watching your icons at " + dir
+        Fontcustom.compile(*args)
         @listener.start()
 
       # Catches Cmd/Ctrl + C

data/spec/fontcustom/fontcustom_spec.rb

@@ -8,17 +8,19 @@ describe Fontcustom do
   context 'when ouput_dir already contains files' do
     # Compile, add non-fontcustom file, change input vectors, recompile
     before(:all) do
-      Fontcustom.compile(input_dir, output_dir)
+      # originals
+      Fontcustom.compile(input_dir, '-o', output_dir, '-n', 'Original Font')
       FileUtils.touch(fake_file, :verbose => true)
       @original_fonts = Dir[output_dir + '/fontcustom-*.{woff,eot,ttf,svg}']
       @original_css = File.read(output_dir + '/fontcustom.css')
-      FileUtils.mv(input_dir + '/B.svg', input_dir + '/E.svg', :verbose => true)
-      Fontcustom.compile(input_dir, output_dir)
+
+      FileUtils.mv(input_dir + '/C.svg', input_dir + '/E.svg', :verbose => true)
+      Fontcustom.compile(input_dir, '-o', output_dir)
     end
 
     after(:all) do
       cleanup(output_dir)
-      FileUtils.mv(input_dir + '/E.svg', input_dir + '/B.svg', :verbose => true)
+      FileUtils.mv(input_dir + '/E.svg', input_dir + '/C.svg', :verbose => true)
     end
 
     it 'should delete previous fontcustom generated files' do

data/spec/fontcustom/generator_spec.rb

@@ -5,7 +5,7 @@ describe Fontcustom::Generator do
   let(:output_dir) { 'tmp' }
 
   context 'normally' do
-    before(:all) { Fontcustom::Generator.start([input_dir, output_dir]) }
+    before(:all) { Fontcustom::Generator.start([input_dir, '-o', output_dir]) }
     after(:all) { cleanup(output_dir) }
 
     it 'should create webfonts' do
@@ -27,7 +27,7 @@ describe Fontcustom::Generator do
 
     it 'should print icon-* CSS classes in fontcustom.css' do
       stylesheet = File.read(output_dir + '/fontcustom.css')
-      icon_names = Dir[input_dir + '/*'].map { |file| File.basename(file, '.svg').downcase }
+      icon_names = Dir[input_dir + '/*'].map { |file| File.basename(file)[0..-5].gsub(/\W/, '-').downcase }
 
       icon_names.each do |name|
         stylesheet.should include('.icon-' + name)
@@ -39,7 +39,7 @@ describe Fontcustom::Generator do
     let(:fake_input_dir) { 'does/not/exist' }
 
     it 'should raise an error' do
-      results = capture(:stderr) { Fontcustom::Generator.start([fake_input_dir, output_dir]) }
+      results = capture(:stderr) { Fontcustom::Generator.start([fake_input_dir, '-o', output_dir]) }
       results.should =~ /doesn't exist or isn't a directory/
     end
   end
@@ -52,4 +52,24 @@ describe Fontcustom::Generator do
       results.should =~ /doesn't contain any vectors/
     end
   end
+
+  context 'when flags are passed' do
+    it 'should save output files with a custom name' do
+      Fontcustom::Generator.start([input_dir, '-o', output_dir, '-n', 'customname'])
+
+      file = Dir[File.join(output_dir, 'customname-*.ttf')].first
+      File.exists?(file).should be_true
+
+      cleanup(output_dir)
+    end
+
+    it 'should exclude the filename hash' do
+      Fontcustom::Generator.start([input_dir, '-o', output_dir, '--nohash'])
+
+      file = File.join(output_dir, 'fontcustom.ttf')
+      File.exists?(file).should be_true
+
+      cleanup(output_dir)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fontcustom
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -199,6 +199,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSES.txt
@@ -217,9 +218,9 @@ files:
 - lib/fontcustom/version.rb
 - lib/fontcustom/watcher.rb
 - spec/fixtures/empty/no_vectors_here.txt
-- spec/fixtures/vectors/B.svg
 - 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
@@ -238,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2573476005248431582
+      hash: 4274866861207866495
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -247,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2573476005248431582
+      hash: 4274866861207866495
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -256,9 +257,9 @@ specification_version: 3
 summary: Generate custom icon webfonts from the comfort of the command line.
 test_files:
 - spec/fixtures/empty/no_vectors_here.txt
-- spec/fixtures/vectors/B.svg
 - 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