fontcustom 1.2.0 → 1.3.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1abf5b322a257728ac1e293a8392f3592e9954b7
+  data.tar.gz: cb6b2ca5e590ae76878050e2317ab7de0cd74041
+SHA512:
+  metadata.gz: 0476cea6aef78118bf1fd85caa008d3de5b2ab465c92619a639eec104ec98178072d4f231a3d1ffee152031f28f9814ad3f2a51fc00c2c5a6a1f1312f2093be4
+  data.tar.gz: 40046d513e692b44bf504969844f48fe905b79b67f7cb9c5b5fe4f5b8ef3a32cc6bde44d83f6173a876956a402d1be5c9fc637b059f532aa6803055c46360155

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.3.0.beta (11/25/2013)
+
+The big news: fixed glyph code points. Automatically assigned for now, but changing them by hand is just a matter of modifying the generated `.fontcustom-manifest.json`.
+
+Lots of internal changes / streamlining on this one. A few breaking changes (`css_prefix`, custom template syntax, possibly others). Error messages and docs are still a bit sparse — my apologies in advance.
+
+* Fixed glyph code points ([#56](https://github.com/FontCustom/fontcustom/issues/56))
+* Changes `css_prefix` to `css_selector` to allow greater flexibility ([#126](https://github.com/FontCustom/fontcustom/pull/126))
+* Skips compilation if inputs have not changed (and `force` option to bypass checks)
+* Adds CSS template helpers for convenience and DRYness
+* Drops bootstrap templates (maintaince overhead, unsure if anyone was using them)
+
+Next up:
+
+* Storing relative paths in the manifest for collaborative editing ([#149](https://github.com/FontCustom/fontcustom/pull/149))
+
 ## 1.2.0 (11/2/2013)
 
 * Preparation for fixed glyph code points.

data/CONTRIBUTING.md

@@ -1,31 +1,51 @@
 ## Help make Font Custom better!
 
 This project was born out of an overheard conversation between two devs in a
-NYC coffee shop — it's come a long ways thanks to your support.
+NYC coffee shop — it's come a long ways thanks to your support. Here's what's
+on the menu:
 
-### Wishlist / Roadmap
-
-* Ruby on Rails integration
-* Compass integration
+* **Ruby on Rails integration**
+* **Compass integration**
 * Base 64 encode fonts into CSS
 * Templates for LESS, stylus, etc.
 * Ligature support
 * Windows support
 * Make better use of Thor
 
-### Conventions
+Just [file an issue](https://github.com/FontCustom/fontcustom/issues) if you
+have an idea or would like to claim one.
 
-We try to follow the [Github ruby styleguide](https://github.com/styleguide/ruby) 
-as much as possible. 
+### Rules of Thumb
 
 If you catch a typo or a block of code that could be more elegant — please let
 us know. No such thing as too small of an improvement.
 
-### Process
+* Spaces instead of tabs, please.
+* Develop in a topic branch.
+* Include passing tests if applicable.
+* Follow the [Github ruby styleguide](https://github.com/styleguide/ruby) as
+  much as possible.
+
+### Getting Started
+
+You'll need:
+
+* Fontforge with Python scripting (easiest via [Homebrew](http://brew.sh/) on Mac)
+* Ruby 1.9.2+ (via [rbenv](https://github.com/sstephenson/rbenv), [RVM](https://rvm.io/), etc.)
+* Rubygems
+  * Bundler
+  * Rake
+  * Rspec
+
+Some helpful links:
+
+* http://createdbypete.com/articles/ruby-on-rails-development-with-mac-os-x-mountain-lion/
+* http://guides.rubygems.org/make-your-own-gem/
+
+---
+
+That's all there is to it. Thanks again, and please don't hesitate to reach out:
 
-* Visit [issues](https://github.com/FontCustom/fontcustom/issues) for ideas.
-* Fork the repo.
-* Create a topic branch. `git checkout -b my_sweet_feature`
-* Add your tests. Run tests with `rake`.
-* Develop your feature.
-* Once all tests are passing, submit a pull request!
+[Github Issues](https://github.com/FontCustom/fontcustom/issues)<br>
+[@ezYZ](https://twitter.com/ezYZ)<br>
+[@endtwist](https://twitter.com/endtwist)

data/TODO.md

@@ -0,0 +1,20 @@
+## TODO
+
+### 1.3.0
+
+* tests, error messages, and docs for generate.py / SVG bugs
+* tests, error messages, and docs for template generator
+* store relative paths in manifest (rebuild in generator/util)
+* documentation for template helpers
+* redirect fontcustom.com to github repo (use wiki for documentation)
+
+### Low Priority
+
+* conserve code points: http://stackoverflow.com/questions/8794430/ruby-finding-lowest-free-id-in-an-id-array
+* more flexible input/ouput hashes (regex or file extensions)
+* sass template with variables
+* less template with variables
+* more robust fontforge check than `which`
+* remove redundant requires
+* rename options for succintness (e.g. :project_root => :root)
+* trim options specs down

data/lib/fontcustom.rb

@@ -1,56 +1,43 @@
 require "fontcustom/version"
 require "fontcustom/error"
-require "fontcustom/util"
+require "fontcustom/utility"
+require "fontcustom/base"
+require "fontcustom/manifest"
 require "fontcustom/options"
 require "fontcustom/generator/font"
 require "fontcustom/generator/template"
 
 module Fontcustom
-  ##
-  # Clean Ruby API to workaround Thor
-  def compile(options)
-    opts = Options.new options
-    Generator::Font.start [opts]
-    Generator::Template.start [opts]
-  rescue Fontcustom::Error => e
-    opts.say_message :error, e.message, :red
-  end
-
   def gem_lib
     File.expand_path(File.join(File.dirname(__FILE__), "fontcustom"))
   end
-
-  module_function :compile, :gem_lib
+  module_function :gem_lib
 
   ##
-  # These are used in Thor CLI but overridden when the Options class is built
+  # Hack to get Thor to show more helpful defaults in `fontcustom help`. These
+  # are overwritten in Fontcustom::Options.
   EXAMPLE_OPTIONS = {
     :project_root => "`pwd`",
     :output => "PROJECT_ROOT/FONT_NAME",
-    :config => "PROJECT_ROOT/fontcustom.yml OR PROJECT_ROOT/config/fontcustom.yml",
+    :config => "PROJECT_ROOT/fontcustom.yml -or- PROJECT_ROOT/config/fontcustom.yml",
     :templates => "css preview",
-    :manifest => "CONFIG_DIR/.fontcustom-manifest.json OR PROJECT_ROOT/.fontcustom-manifest.json"
+    :manifest => "CONFIG_DIR/.fontcustom-manifest.json -or- PROJECT_ROOT/.fontcustom-manifest.json"
   }
 
   DEFAULT_OPTIONS = {
-    :project_root => Dir.pwd,
+    :project_root => nil,
     :input => nil,
     :output => nil,
     :config => nil,
     :templates => %w|css preview|,
     :font_name => "fontcustom",
-    :css_prefix => "icon-",
+    :css_selector => ".icon-{{glyph}}",
     :manifest => nil,
     :preprocessor_path => nil,
     :autowidth => false,
     :no_hash => false,
     :debug => false,
+    :force => false,
     :quiet => false
   }
-
-  DATA_MODEL = {
-    :fonts => [],
-    :templates => [],
-    :glyphs => []
-  }
 end

data/lib/fontcustom/base.rb

@@ -0,0 +1,56 @@
+require "digest/sha2"
+
+module Fontcustom
+  class Base
+    include Utility
+
+    def initialize(cli_options)
+      @cli_options = cli_options
+      check_fontforge
+      init_manifest
+    end
+
+    def compile
+      @manifest[:checksum][:current] = checksum
+      if @options[:force] || @manifest[:checksum][:current] != @manifest[:checksum][:previous]
+        save_manifest
+        start_generators
+        @manifest = get_manifest
+        @manifest[:checksum][:previous] = @manifest[:checksum][:current]
+        save_manifest
+      else
+        say_message :status, "No changes detected. Skipping compilation."
+      end
+    end
+
+    private
+
+    def check_fontforge
+      fontforge = `which fontforge`
+      if fontforge == "" || fontforge == "fontforge not found"
+        raise Fontcustom::Error, "Please install fontforge first. Visit <http://fontcustom.com> for instructions."
+      end
+    end
+
+    def init_manifest
+      file = @cli_options[:manifest] || File.join(Dir.pwd, ".fontcustom-manifest.json")
+      @options = Fontcustom::Options.new(@cli_options).options
+      @manifest = Fontcustom::Manifest.new(@options).manifest
+    end
+
+    # Calculates a hash of vectors, options, and templates (content and filenames)
+    def checksum
+      files = Dir.glob File.join(@options[:input][:vectors], "*.svg")
+      files += Dir.glob File.join(@options[:input][:templates], "*")
+      content = files.map { |file| File.read(file) }.join
+      content << files.join
+      content << @options.flatten(2).join
+      Digest::SHA2.hexdigest(content).to_s
+    end
+
+    def start_generators
+      Fontcustom::Generator::Font.new(@options[:manifest]).generate
+      Fontcustom::Generator::Template.new(@options[:manifest]).generate
+    end
+  end
+end

data/lib/fontcustom/cli.rb

@@ -5,7 +5,7 @@ require "fontcustom/watcher"
 
 module Fontcustom
   class CLI < Thor
-    include Thor::Actions
+    include Utility
 
     default_task :show_help
 
@@ -22,17 +22,17 @@ module Fontcustom
       :default => EXAMPLE_OPTIONS[:config]
 
     class_option :templates, :aliases => "-t", :type => :array,
-      :desc => "Space-delinated list of templates to generate alongside fonts.",
-      :enum => %w|preview css scss scss-rails bootstrap bootstrap-scss bootstrap-ie7 bootstrap-ie7-scss|,
+      :desc => "Space-delinated list of files to generate alongside fonts. Use stock templates or choose your own.",
+      :enum => %w|preview css scss scss-rails|,
       :default => EXAMPLE_OPTIONS[:templates]
 
     class_option :font_name, :aliases => "-f", :type => :string,
       :desc => "The font's name. Also determines the file names of generated templates.",
       :default => DEFAULT_OPTIONS[:font_name]
 
-    class_option :css_prefix, :aliases => "-p", :type => :string,
-      :desc => "Prefix for each glyph's CSS class.",
-      :default => DEFAULT_OPTIONS[:css_prefix]
+    class_option :css_selector, :aliases => "-s", :type => :string,
+      :desc => "Format of generated CSS selector. \"{{glyph}}\" is substituted for the glyph name.",
+      :default => DEFAULT_OPTIONS[:css_selector]
 
     class_option :manifest, :aliases => "-m", :type => :string,
       :desc => "Path to a manifest of generated files. Used for garbage collection.",
@@ -50,6 +50,9 @@ module Fontcustom
     class_option :debug, :aliases => "-d", :type => :boolean,
       :desc => "Display debugging messages."
 
+    class_option :force, :aliases => "-F", :type => :boolean,
+      :desc => "Forces compilation, even if inputs have not changed."
+
     class_option :quiet, :aliases => "-q", :type => :boolean,
       :desc => "Hide status messages."
 
@@ -60,12 +63,10 @@ module Fontcustom
 
     desc "compile [INPUT] [OPTIONS]", "Generates webfonts and templates from *.svg and *.eps files in INPUT. Default: `pwd`"
     def compile(input = nil)
-      opts = options.merge :input => input
-      opts = Options.new(opts)
-      Generator::Font.start [opts]
-      Generator::Template.start [opts]
+      Base.new(options.merge(:input => input)).compile
     rescue Fontcustom::Error => e
-      opts.say_message :error, e.message, :red
+      say_status :error, e.message, :red
+      puts e.backtrace.join("\n") if options[:debug]
     end
 
     desc "watch [INPUT] [OPTIONS]", "Watches INPUT for changes and regenerates files automatically. Ctrl + C to stop. Default: `pwd`"
@@ -78,7 +79,7 @@ module Fontcustom
       opts = Options.new(opts)
       Watcher.new(opts).watch
     rescue Fontcustom::Error => e
-      opts.say_message :error, e.message, :red
+      say_status :error, e.message, :red
     end
 
     desc "config [DIR]", "Generates an annotated configuration file (fontcustom.yml) in DIR. Default: `pwd`"

data/lib/fontcustom/generator/font.rb

@@ -1,92 +1,90 @@
 require "json"
 require "open3"
-require "thor"
-require "thor/group"
-require "thor/actions"
 
 module Fontcustom
   module Generator
-    class Font < Thor::Group
-      include Util
-      include Thor::Actions
+    class Font
+      include Utility
 
-      # Instead of passing each option individually we're passing the entire options hash as an argument.
-      # This is DRYier, easier to maintain.
-      argument :opts
+      attr_reader :manifest, :options
 
-      def prepare_output_dirs
-        dirs = opts.output.values.uniq
-        dirs.each do |dir|
-          unless File.directory? dir
-            empty_directory dir, :verbose => ! opts.quiet
-          end
-        end
+      def initialize(manifest)
+        @manifest = get_manifest(manifest)
+        @options = @manifest[:options]
       end
 
-      def get_manifest
-        if File.exists? opts.manifest
-          begin
-            data = File.read opts.manifest
-            data = JSON.parse(data, :symbolize_names => true) unless data.empty?
-            @data = data.is_a?(Hash) ? symbolize_hash(data) : Fontcustom::DATA_MODEL.dup
-          rescue
-            raise Fontcustom::Error, "Couldn't parse `#{relative_to_root(opts.manifest)}`. Delete it to start from scratch. Any previously generated files will need to be deleted manually."
-          end
-        else
-          @data = Fontcustom::DATA_MODEL.dup
-        end
+      def generate
+        create_output_dirs
+        delete_old_fonts
+        set_glyph_info
+        create_fonts
       end
 
-      def reset_output
-        return if @data[:fonts].empty?
-        begin
-          deleted = []
-          @data[:fonts].each do |file|
-            remove_file file, :verbose => false
-            deleted << file
+      private
+
+      def create_output_dirs
+        dirs = @options[:output].values.uniq
+        dirs.each do |dir|
+          unless File.directory? dir
+            empty_directory dir, :verbose => ! @options[:quiet]
           end
-        ensure
-          @data[:fonts] = @data[:fonts] - deleted
-          json = JSON.pretty_generate @data
-          overwrite_file opts.manifest, json
-          say_changed :delete, deleted
         end
       end
 
-      def generate
-        cmd = "fontforge -script #{Fontcustom.gem_lib}/scripts/generate.py #{opts.input[:vectors]} #{opts.output[:fonts]} --name #{opts.font_name}"
-        cmd += " --autowidth" if opts.autowidth
-        cmd += " --nohash" if opts.no_hash
-        cmd += " --debug" if opts.debug
-        output, err, status = execute_and_clean(cmd)
-        @json = output.delete_at(0)
-        say_status :debug, "#{err}\n#{' ' * 14}#{output}", :red if opts.debug
-        raise Fontcustom::Error, "`fontforge` compilation failed. Try again with --debug for more details." unless status.success?
+      def delete_old_fonts
+        delete_from_manifest(:fonts)
       end
 
-      def collect_data
-        json = JSON.parse(@json, :symbolize_names => true)
-        @data.merge! json
-        @data[:glyphs].map! { |glyph| glyph.gsub(/\W/, "-") }
-        @data[:fonts].map! { |font| File.join(opts.output[:fonts], font) }
-      end
+      def set_glyph_info
+        codepoint = if ! @manifest[:glyphs].empty?
+          codepoints = @manifest[:glyphs].values.map { |data| data[:codepoint] }
+          codepoints.max + 1
+        else
+          0xf100
+        end
 
-      def announce_files
-        say_changed :create, @data[:fonts]
-      end
+        files = Dir.glob File.join(@options[:input][:vectors], "*.svg")
+        glyphs = {}
+        files.each do |file|
+          name = File.basename file, ".svg"
+          name = name.strip.gsub(/\W/, "-").downcase
+          glyphs[name.to_sym] = { :source => file }
+        end
 
-      def save_data
-        json = JSON.pretty_generate @data
-        overwrite_file opts.manifest, json
-      end
+        # Dir.glob returns a different order depending on ruby
+        # version/platform, so we have to sort it first
+        glyphs = Hash[glyphs.sort_by { |key, val| key.to_s }]
+        glyphs.each do |name, data|
+          if @manifest[:glyphs].has_key? name
+           data[:codepoint] = @manifest[:glyphs][name][:codepoint]
+          else
+            data[:codepoint] = codepoint
+            codepoint = codepoint + 1
+          end
+        end
 
-      private
+        @manifest[:glyphs] = glyphs
+        save_manifest
+      end
 
-      def execute_and_clean(cmd)
+      def create_fonts
+        cmd = "fontforge -script #{Fontcustom.gem_lib}/scripts/generate.py #{@options[:manifest]}"
         stdout, stderr, status = Open3::capture3(cmd)
         stdout = stdout.split("\n")
         stdout = stdout[1..-1] if stdout[0] == "CreateAllPyModules()"
-        [stdout, stderr, status]
+
+        debug_msg = " Try again with --debug for more details."
+        if @options[:debug]
+          say_message :debug, "#{stderr}\n#{' ' * 14}#{stdout}", :red
+          debug_msg = ""
+        end
+
+        if status.success?
+          @manifest = get_manifest
+          say_changed :create, @manifest[:fonts]
+        else
+          raise Fontcustom::Error, "`fontforge` compilation failed.#{debug_msg}"
+        end
       end
     end
   end