fontcustom 1.3.0.beta3 → 1.3.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a863f3b75e4669343c50c8f137aaae1c5c5df1fd
-  data.tar.gz: 4997708bd8b627e3ec060c32fa0c06a7a6de4835
+  metadata.gz: 83ae4b0585895308ea825062bedefd5f52e1601f
+  data.tar.gz: 94f1938fe393cd56761d7facc448c73f01131a9f
 SHA512:
-  metadata.gz: 3743b80862699178d2c6754a198af545c38358db18563d3ffe5110b777c7350e47a1e505720e14a8620b1ae03f048e34dc091ad60ec15f224b934b56ef2368f6
-  data.tar.gz: 8f977e595ebf6232b06d7e69b2aead55be38727c104092340fcf20617b3b691d1f6bdf6a31d6c3a1c37a6c3080467eceb4e2f7524509c5c35a4c9d3ba643950e
+  metadata.gz: a57e93b5b0b0fed46f13d4d246747de4e6a241d684f4736bb5ac25598e2cf1b8108d0ffc32e08731fa74e3e903567da4c9658dc4979f6507b23fd1d6967d4571
+  data.tar.gz: 94c7d261fabc35340808134ca63a422d986befff99fdc816a6067f1bca6f563606a6a969dbfde5ded65866d8c217960b18d6fcc03db5da8e2f723d8002672819

data/TODO.md

@@ -2,17 +2,19 @@
 
 ### 1.3.0
 
-* store relative paths in manifest (rebuild in generator/util)
-
+* update manifest content in spec_helper
+* fix failing travis-ci specs
 * reactivate watcher
-* Detect old manifest / show error message
-
-* Add more travis CLI rubies / thor versions?
-* documentation for template helpers
+* more helpful messages when running without INPUT
 * redirect fontcustom.com to github repo (use wiki for documentation)
 
 ### Future
 
+* Include fontcustom version in manifest / checksum
+* Error message if using the wrong version of ruby
+* Add more travis CLI rubies / thor versions?
+* Detect old manifest / show error message
+* Template helper that returns a hash of glyphs and pre-formatted codes
 * conserve code points: http://stackoverflow.com/questions/8794430/ruby-finding-lowest-free-id-in-an-id-array
 * strip /fill: rgba(...)/ from SVGs so that transparent SVGs don't fail
 * more flexible input/ouput hashes (regex or file extensions)
@@ -20,5 +22,3 @@
 * 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

@@ -17,22 +17,18 @@ module Fontcustom
   # 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",
-    :templates => "css preview",
-    :manifest => "CONFIG_DIR/.fontcustom-manifest.json -or- PROJECT_ROOT/.fontcustom-manifest.json"
+    :output => "./FONT_NAME",
+    :config => "./fontcustom.yml -or- ./config/fontcustom.yml",
+    :templates => "css preview"
   }
 
   DEFAULT_OPTIONS = {
-    :project_root => nil,
     :input => nil,
     :output => nil,
     :config => nil,
     :templates => %w|css preview|,
     :font_name => "fontcustom",
     :css_selector => ".icon-{{glyph}}",
-    :manifest => nil,
     :preprocessor_path => nil,
     :autowidth => false,
     :no_hash => false,

data/lib/fontcustom/base.rb

@@ -4,20 +4,22 @@ module Fontcustom
   class Base
     include Utility
 
-    def initialize(cli_options)
-      @cli_options = cli_options
+    def initialize(raw_options)
       check_fontforge
-      init_manifest
+      manifest = ".fontcustom-manifest.json"
+      raw_options[:manifest] = manifest
+      @options = Fontcustom::Options.new(raw_options).options
+      @manifest = Fontcustom::Manifest.new(manifest, @options)
     end
 
     def compile
-      @manifest[:checksum][:current] = checksum
-      if @options[:force] || @manifest[:checksum][:current] != @manifest[:checksum][:previous]
-        save_manifest
+      current = checksum
+      previous = @manifest.get(:checksum)[:previous]
+      if @options[:force] || current != previous
+        @manifest.set :checksum, {:previous => previous, :current => current}
         start_generators
-        @manifest = get_manifest
-        @manifest[:checksum][:previous] = @manifest[:checksum][:current]
-        save_manifest
+        @manifest.reload
+        @manifest.set :checksum, {:previous => current, :current => current}
       else
         say_message :status, "No changes detected. Skipping compilation."
       end
@@ -32,12 +34,6 @@ module Fontcustom
       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")
@@ -49,8 +45,8 @@ module Fontcustom
     end
 
     def start_generators
-      Fontcustom::Generator::Font.new(@options[:manifest]).generate
-      Fontcustom::Generator::Template.new(@options[:manifest]).generate
+      Fontcustom::Generator::Font.new(@manifest.manifest).generate
+      Fontcustom::Generator::Template.new(@manifest.manifest).generate
     end
   end
 end

data/lib/fontcustom/cli.rb

@@ -9,10 +9,6 @@ module Fontcustom
 
     default_task :show_help
 
-    class_option :project_root, :aliases => "-r", :type => :string,
-      :desc => "The root context for relative paths (INPUT, OUTPUT, CONFIG).",
-      :default => EXAMPLE_OPTIONS[:project_root]
-
     class_option :output, :aliases => "-o", :type => :string,
       :desc => "Where generated files are saved. Set different locations for different file types via a configuration file.",
       :default => EXAMPLE_OPTIONS[:output]
@@ -34,10 +30,6 @@ module Fontcustom
       :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.",
-      :default => EXAMPLE_OPTIONS[:manifest]
-
     class_option :preprocessor_path, :aliases => "-p", :type => :string,
       :desc => "Optional font path for CSS proprocessor templates."
 

data/lib/fontcustom/generator/font.rb

@@ -9,8 +9,8 @@ module Fontcustom
       attr_reader :manifest, :options
 
       def initialize(manifest)
-        @manifest = get_manifest(manifest)
-        @options = @manifest[:options]
+        @manifest = Fontcustom::Manifest.new manifest
+        @options = @manifest.get :options
       end
 
       def generate
@@ -26,20 +26,24 @@ module Fontcustom
         dirs = @options[:output].values.uniq
         dirs.each do |dir|
           unless File.directory? dir
-            empty_directory dir, :verbose => ! @options[:quiet]
+            empty_directory dir, :verbose => false
+            say_message :create, dir
           end
         end
       end
 
       def delete_old_fonts
-        delete_from_manifest(:fonts)
+        @manifest.delete :fonts
       end
 
       def set_glyph_info
-        codepoint = if ! @manifest[:glyphs].empty?
-          codepoints = @manifest[:glyphs].values.map { |data| data[:codepoint] }
+        manifest_glyphs = @manifest.get :glyphs
+        codepoint = if ! manifest_glyphs.empty?
+          codepoints = manifest_glyphs.values.map { |data| data[:codepoint] }
           codepoints.max + 1
         else
+          # Offset to work around Chrome Windows bug
+          # https://github.com/FontCustom/fontcustom/issues/1
           0xf100
         end
 
@@ -50,7 +54,7 @@ module Fontcustom
           name = name.strip.gsub(/\W/, "-")
           glyphs[name.to_sym] = { :source => file }
           if File.read(file).include? "rgba"
-            say_message :warn, "`#{relative_path(file)}` contains transparency and will be skipped."
+            say_message :warn, "`#{file}` contains transparency and will be skipped."
           end
         end
 
@@ -58,20 +62,18 @@ module Fontcustom
         # 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]
+          if manifest_glyphs.has_key? name
+           data[:codepoint] = manifest_glyphs[name][:codepoint]
           else
             data[:codepoint] = codepoint
             codepoint = codepoint + 1
           end
         end
-
-        @manifest[:glyphs] = glyphs
-        save_manifest
+        @manifest.set :glyphs, glyphs
       end
 
       def create_fonts
-        cmd = "fontforge -script #{Fontcustom.gem_lib}/scripts/generate.py #{@options[:manifest]}"
+        cmd = "fontforge -script #{Fontcustom.gem_lib}/scripts/generate.py #{@manifest.manifest}"
         stdout, stderr, status = Open3::capture3(cmd)
         stdout = stdout.split("\n")
         stdout = stdout[1..-1] if stdout[0] == "CreateAllPyModules()"
@@ -84,8 +86,8 @@ module Fontcustom
         end
 
         if status.success?
-          @manifest = get_manifest
-          say_changed :create, @manifest[:fonts]
+          @manifest.reload
+          say_changed :create, @manifest.get(:fonts)
         else
           raise Fontcustom::Error, "`fontforge` compilation failed.#{debug_msg}"
         end

data/lib/fontcustom/generator/template.rb

@@ -9,12 +9,12 @@ module Fontcustom
       attr_reader :manifest, :options
 
       def initialize(manifest)
-        @manifest = get_manifest(manifest)
-        @options = @manifest[:options]
+        @manifest = Fontcustom::Manifest.new manifest
+        @options = @manifest.get :options
       end
 
       def generate
-        if ! @manifest[:fonts].empty?
+        if ! @manifest.get(:fonts).empty?
           delete_old_templates
           set_relative_paths
           create_files
@@ -26,59 +26,77 @@ module Fontcustom
       private
 
       def delete_old_templates
-        delete_from_manifest(:templates)
+        @manifest.delete :templates
       end
 
       def set_relative_paths
-        name = File.basename @manifest[:fonts].first, File.extname(@manifest[:fonts].first)
-        fonts = Pathname.new @options[:output][:fonts]
-        css = Pathname.new @options[:output][:css]
-        preview = Pathname.new @options[:output][:preview]
-        @font_path = File.join fonts.relative_path_from(css).to_s, name
+        fonts = @manifest.get :fonts
+        name = File.basename fonts.first, File.extname(fonts.first)
+        fonts_path = Pathname.new @options[:output][:fonts]
+        css_path = Pathname.new @options[:output][:css]
+        preview_path = Pathname.new @options[:output][:preview]
+        @font_path = File.join fonts_path.relative_path_from(css_path).to_s, name
         @font_path_alt = @options[:preprocessor_path].nil? ? @font_path : File.join(@options[:preprocessor_path], name)
-        @font_path_preview = File.join fonts.relative_path_from(preview).to_s, name
+        @font_path_preview = File.join fonts_path.relative_path_from(preview_path).to_s, name
       end
 
       def create_files
-        @glyphs = @manifest[:glyphs]
+        @glyphs = @manifest.get :glyphs
+        existing = @manifest.get :templates
         created = []
         begin
           @options[:templates].each do |source|
             begin
-              target = template_target source
+              source = get_source_path(source)
+              target = get_target_path(source)
               template source, target, :verbose => false, :force => true
-            rescue => e
-              raise Fontcustom::Error, "Could not generate template `#{relative_path(source)}`:#{line_break + e.message}" 
             end
             created << target
           end
         ensure
           say_changed :create, created
-          @manifest[:templates] = (@manifest[:templates] + created).uniq
-          save_manifest
+          @manifest.set :templates, (existing + created).uniq
         end
       end
 
-      def template_target(source)
-        packaged = %w|fontcustom.css _fontcustom.scss _fontcustom-rails.scss fontcustom-preview.html|
-        css_exts = %w|.css .scss .sass .less .stylus|
-        name = File.basename source
+      def get_source_path(template)
+        template_path = File.join Fontcustom.gem_lib, "templates"
+
+        case template
+        when "preview"
+          File.join template_path, "fontcustom-preview.html"
+        when "css"
+          File.join template_path, "fontcustom.css"
+        when "scss"
+          File.join template_path, "_fontcustom.scss"
+        when "scss-rails"
+          File.join template_path, "_fontcustom-rails.scss"
+        else
+          File.join @options[:input][:templates], template
+        end
+      end
+
+      def get_target_path(source)
         ext = File.extname source
-        target = name.dup
+        base = File.basename source
+        css_exts = %w|.css .scss .sass .less .stylus|
+        packaged = %w|fontcustom-preview.html fontcustom.css _fontcustom.scss _fontcustom-rails.scss|
+
+        target = if @options[:output].keys.include? base.to_sym
+          File.join @options[:output][base.to_sym], source
+        elsif ext && css_exts.include?(ext)
+          File.join @options[:output][:css], base
+        elsif source.match(/fontcustom-preview\.html/)
+          File.join @options[:output][:preview], base
+        else
+          File.join @options[:output][:fonts], base
+        end
 
-        if packaged.include?(name) && @options[:font_name] != DEFAULT_OPTIONS[:font_name]
+        if packaged.include?(base) && @options[:font_name] != DEFAULT_OPTIONS[:font_name]
           target.sub! DEFAULT_OPTIONS[:font_name], @options[:font_name]
         end
 
-        if @options[:output].keys.include? name.to_sym
-          File.join @options[:output][name.to_sym], target
-        elsif css_exts.include? ext
-          File.join @options[:output][:css], target
-        elsif name == "fontcustom-preview.html"
-          File.join @options[:output][:preview], target
-        else
-          File.join @options[:output][:fonts], target
-        end
+        target
       end
 
       #
@@ -122,7 +140,7 @@ module Fontcustom
 
       def glyphs
         output = @glyphs.map do |name, value|
-          %Q|#{@options[:css_selector].sub('{{glyph}}', name.to_s)}:before { content: "\\#{value[:codepoint].to_s(16)}\" }|
+          %Q|#{@options[:css_selector].sub('{{glyph}}', name.to_s)}:before { content: "\\#{value[:codepoint].to_s(16)}"; }|
         end
         output.join "\n"
       end

data/lib/fontcustom/manifest.rb

@@ -2,41 +2,74 @@ module Fontcustom
   class Manifest
     include Utility
 
-    attr_accessor :manifest
+    attr_reader :manifest
 
-    def initialize(options)
-      @options = options
-      update_or_create_manifest
+    def initialize(manifest, cli_options = {})
+      @manifest = manifest
+      @cli_options = symbolize_hash cli_options
+      if File.exists? @manifest
+        reload
+        if ! @cli_options.empty? && get(:options) != @cli_options
+          set :options, @cli_options
+        end
+      else
+        create_manifest @cli_options
+      end
     end
 
-    def update_or_create_manifest
-      if File.exists? @options[:manifest]
-        update_manifest
+    # TODO convert paths to absolute
+    def get(key)
+      @data[key]
+    end
+
+    # TODO convert paths to relative
+    def set(key, value, status = nil)
+      if key == :all
+        @data = value
       else
-        create_manifest
+        @data[key] = value
       end
+      json = JSON.pretty_generate @data
+      write_file @manifest, json, status
     end
 
-    private
+    def reload
+      begin
+        json = File.read @manifest
+        @data = JSON.parse json, :symbolize_names => true
+      rescue JSON::ParserError
+        raise Fontcustom::Error,
+          "Couldn't parse `#{@manifest}`. Fix any invalid "\
+          "JSON or delete the file to start from scratch."
+      end
+    end
 
-    def update_manifest
-      @manifest = get_manifest
-      if @manifest[:options] != @options
-        @manifest[:options] = @options
-        save_manifest
+    def delete(key)
+      files = get(key)
+      return if files.empty?
+      begin
+        deleted = []
+        files.each do |file|
+          remove_file file, :verbose => false
+          deleted << file
+        end
+      ensure
+        set key, files - deleted
+        say_changed :delete, deleted
       end
     end
 
-    def create_manifest
-      @manifest = {
+    private
+
+    def create_manifest(options)
+      defaults = {
         :checksum => { :current => "", :previous => "" },
         :fonts => [],
         :glyphs => {},
-        :options => @options,
+        :options => options,
         :templates => []
       }
-      json = JSON.pretty_generate @manifest
-      write_file @options[:manifest], json, :create
+      set :all, defaults, :create
     end
   end
 end