gkh-fontcustom 1.3.7

data/gemfiles/Gemfile.listen_1

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in fontcustom.gemspec
+gemspec :path => ".."
+
+gem "listen", "~>1.0"

data/lib/fontcustom.rb

@@ -0,0 +1,43 @@
+require "fontcustom/version"
+require "fontcustom/error"
+require "fontcustom/utility"
+require "fontcustom/base"
+require "fontcustom/manifest"
+require "fontcustom/options"
+require "fontcustom/generator/font"
+require "fontcustom/generator/template"
+
+module Fontcustom
+  def gem_lib
+    File.expand_path(File.join(File.dirname(__FILE__), "fontcustom"))
+  end
+  module_function :gem_lib
+
+  ##
+  # Hack to get Thor to show more helpful defaults in `fontcustom help`. These
+  # are overwritten in Fontcustom::Options.
+  EXAMPLE_OPTIONS = {
+    :output => "./FONT_NAME",
+    :config => "./fontcustom.yml -or- ./config/fontcustom.yml",
+    :templates => "css preview"
+  }
+
+  DEFAULT_OPTIONS = {
+    :input => nil,
+    :output => nil,
+    :config => nil,
+    :templates => %w|css preview|,
+    :font_name => "fontcustom",
+    :font_design_size => 16,
+    :font_em => 512,
+    :font_ascent => 448,
+    :font_descent => 64,
+    :css_selector => ".icon-{{glyph}}",
+    :preprocessor_path => nil,
+    :autowidth => false,
+    :no_hash => false,
+    :debug => false,
+    :force => false,
+    :quiet => false
+  }
+end

data/lib/fontcustom/base.rb

@@ -0,0 +1,54 @@
+require "digest/sha2"
+
+module Fontcustom
+  class Base
+    include Utility
+
+    def initialize(raw_options)
+      check_fontforge
+      manifest = ".fontcustom-manifest.json"
+      raw_options[:manifest] = manifest
+      @options = Fontcustom::Options.new(raw_options).options
+      @manifest = Fontcustom::Manifest.new(manifest, @options)
+    end
+
+    def compile
+      current = checksum
+      previous = @manifest.get(:checksum)[:previous]
+
+      say_message :status, "Forcing compile." if @options[:force]
+      if @options[:force] || current != previous
+        @manifest.set :checksum, {:previous => previous, :current => current}
+        start_generators
+        @manifest.reload
+        @manifest.set :checksum, {:previous => current, :current => current}
+      else
+        say_message :status, "No changes detected. Skipping compile."
+      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
+
+    # Calculates a hash of vectors, options, and templates (content and filenames)
+    def checksum
+      files = Dir.glob(File.join(@options[:input][:vectors], "*.svg")).select { |fn| File.file?(fn) }
+      files += Dir.glob(File.join(@options[:input][:templates], "*")).select { |fn| File.file?(fn) }
+      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(@manifest.manifest).generate
+      Fontcustom::Generator::Template.new(@manifest.manifest).generate
+    end
+  end
+end

data/lib/fontcustom/cli.rb

@@ -0,0 +1,110 @@
+require "thor"
+require "thor/actions"
+require "fontcustom"
+require "fontcustom/watcher"
+
+module Fontcustom
+  class CLI < Thor
+    include Utility
+
+    default_task :show_help
+
+    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]
+
+    class_option :config, :aliases => "-c", :type => :string,
+      :desc => "Optional path to a configuration file.",
+      :default => EXAMPLE_OPTIONS[:config]
+
+    class_option :templates, :aliases => "-t", :type => :array,
+      :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 => %w|--name -n|, :type => :string,
+      :desc => "The font's name. Also determines the file names of generated templates.",
+      :default => DEFAULT_OPTIONS[:font_name]
+    
+    class_option :font_design_size, :aliases => %s|--size -s|, :type => :numeric,
+      :desc => "Size (in pica points) for which this font is designed.",
+      :default => DEFAULT_OPTIONS[:font_design_size]
+
+    class_option :font_em, :aliases => %w|--em -e|, :type => :numeric,
+      :desc => "The em size. Setting this will scale the entire font to the given size.",
+      :default => DEFAULT_OPTIONS[:font_em]
+
+    class_option :font_ascent, :aliases => %w|--ascent -a|, :type => :numeric,
+      :desc => "The font's ascent. Used to calculate the baseline.",
+      :default => DEFAULT_OPTIONS[:font_ascent]
+
+    class_option :font_descent, :aliases => %w|--descent -d|, :type => :numeric,
+      :desc => "The font's descent. Used to calculate the baseline.",
+      :default => DEFAULT_OPTIONS[:font_descent]
+
+    class_option :css_selector, :aliases => %w|--selector -S|, :type => :string,
+      :desc => "Format of CSS selectors. \"{{glyph}}\" is substituted for the glyph name.",
+      :default => DEFAULT_OPTIONS[:css_selector]
+
+    class_option :preprocessor_path, :aliases => %w|--prepath -p|, :type => :string,
+      :desc => "For Rails and Compass templates, set this as the relative path from your compiled CSS to your font output directory."
+
+    class_option :autowidth, :aliases => "-A", :type => :boolean,
+      :desc => "Horizontally fit glyphs to their individual vector widths."
+
+    class_option :no_hash, :aliases => "-h", :type => :boolean,
+      :desc => "Generate fonts without asset-busting hashes."
+
+    class_option :base64, :aliases => "-b", :type => :boolean,
+      :desc => "Encode WOFF fonts into the generated CSS."
+
+    class_option :debug, :aliases => "-D", :type => :boolean,
+      :desc => "Display (possibly useful) 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."
+
+    # Required for Thor::Actions#template
+    def self.source_root
+      File.join Fontcustom.gem_lib, "templates"
+    end
+
+    desc "compile [INPUT] [OPTIONS]", "Generates webfonts and templates from *.svg files in INPUT. Default: `pwd`"
+    def compile(input = nil)
+      Base.new(options.merge(:input => input)).compile
+    rescue Fontcustom::Error => e
+      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`"
+    method_option :skip_first, :type => :boolean,
+      :desc => "Skip the initial compile upon watching.",
+      :default => false
+    def watch(input = nil)
+      say "Font Custom is watching your icons. Press Ctrl + C to stop.", :yellow unless options[:quiet]
+      opts = options.merge :input => input, :skip_first => !! options[:skip_first]
+      Watcher.new(opts).watch
+    rescue Fontcustom::Error => e
+      say_status :error, e.message, :red
+    end
+
+    desc "config [DIR]", "Generates a starter configuration file (fontcustom.yml) in DIR. Default: `pwd`"
+    def config(dir = Dir.pwd)
+      template "fontcustom.yml", File.join(dir, "fontcustom.yml")
+    end
+
+    desc "hidden", "hidden", :hide => true
+    method_option :version, :aliases => "-v", :type => :boolean, :default => false
+    def show_help
+      if options[:version]
+        puts "fontcustom-#{VERSION}"
+      else
+        help
+      end
+    end
+  end
+end

data/lib/fontcustom/error.rb

@@ -0,0 +1,4 @@
+module Fontcustom
+  class Error < StandardError
+  end
+end

data/lib/fontcustom/generator/font.rb

@@ -0,0 +1,109 @@
+require "json"
+require "open3"
+
+module Fontcustom
+  module Generator
+    class Font
+      include Utility
+
+      attr_reader :manifest
+
+      def initialize(manifest)
+        @manifest = Fontcustom::Manifest.new manifest
+        @options = @manifest.get :options
+      end
+
+      def generate
+        create_output_dirs
+        delete_old_fonts
+        set_glyph_info
+        create_fonts
+      end
+
+      private
+
+      def create_output_dirs
+        dirs = @options[:output].values.uniq
+        dirs.each do |dir|
+          unless File.directory? dir
+            empty_directory dir, :verbose => false
+            say_message :create, dir
+          end
+        end
+      end
+
+      def delete_old_fonts
+        @manifest.delete :fonts
+      end
+
+      def set_glyph_info
+        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
+
+        files = Dir.glob File.join(@options[:input][:vectors], "*.svg")
+        glyphs = {}
+        files.each do |file|
+          next if File.symlink?(file)
+          name = File.basename file, ".svg"
+          name = name.strip.gsub(/\W/, "-")
+          glyphs[name.to_sym] = { :source => file }
+          if File.read(file).include? "rgba"
+            say_message :warn, "`#{file}` contains transparency and will be skipped."
+          end
+        end
+
+        files.each do |file|
+          next unless File.symlink?(file)
+          linked_name = File.readlink(file)
+          linked_name = File.basename linked_name, ".svg"
+          linked_name = linked_name.strip.gsub(/\W/, "-")
+          glyphs[linked_name.to_sym][:aliases] ||= []
+          alias_name = File.basename file, ".svg"
+          alias_name = alias_name.strip.gsub(/\W/, "-")
+          glyphs[linked_name.to_sym][:aliases] << alias_name
+        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
+        @manifest.set :glyphs, glyphs
+      end
+
+      def create_fonts
+        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()"
+
+        debug_msg = " Try again with --debug for more details."
+        if @options[:debug]
+          messages = stderr.split("\n") + stdout
+          say_message :debug, messages.join(line_break)
+          debug_msg = ""
+        end
+
+        if status.success?
+          @manifest.reload
+          say_changed :create, @manifest.get(:fonts)
+        else
+          raise Fontcustom::Error, "`fontforge` compilation failed.#{debug_msg}"
+        end
+      end
+    end
+  end
+end

data/lib/fontcustom/generator/template.rb

@@ -0,0 +1,222 @@
+require "json"
+require "pathname"
+require "base64"
+
+module Fontcustom
+  module Generator
+    class Template
+      include Utility
+
+      attr_reader :manifest
+
+      def initialize(manifest)
+        @manifest = Fontcustom::Manifest.new manifest
+        @options = @manifest.get :options
+      end
+
+      def generate
+        if ! @manifest.get(:fonts).empty?
+          delete_old_templates
+          set_relative_paths
+          create_files
+        else
+          raise Fontcustom::Error, "No generated fonts were detected - aborting template generation."
+        end
+      end
+
+      private
+
+      def delete_old_templates
+        @manifest.delete :templates
+      end
+
+      def set_relative_paths
+        fonts = @manifest.get :fonts
+        name = File.basename fonts.first, File.extname(fonts.first)
+        fonts_path = Pathname.new(@options[:output][:fonts]).realdirpath
+        css_path = Pathname.new(@options[:output][:css]).realdirpath
+        preview_path = Pathname.new(@options[:output][:preview]).realdirpath
+        @font_path = File.join fonts_path.relative_path_from(css_path).to_s, name
+        @font_path_alt = if @options[:preprocessor_path].nil?
+          @font_path
+        elsif ! @options[:preprocessor_path] || @options[:preprocessor_path].empty?
+          name
+        else
+          File.join(@options[:preprocessor_path], name)
+        end
+        @font_path_preview = File.join fonts_path.relative_path_from(preview_path).to_s, name
+      end
+
+      def create_files
+        @glyphs = @manifest.get :glyphs
+        existing = @manifest.get :templates
+        created = []
+        begin
+          @options[:templates].each do |template_name|
+            begin
+              source = get_source_path(template_name)
+              target = get_target_path(source)
+              template source, target, :verbose => false, :force => true
+            end
+            created << target
+          end
+        ensure
+          say_changed :create, created
+          @manifest.set :templates, (existing + created).uniq
+        end
+      end
+
+      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
+        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], base
+        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?(base) && @options[:font_name] != DEFAULT_OPTIONS[:font_name]
+          target.sub! DEFAULT_OPTIONS[:font_name], @options[:font_name]
+        end
+
+        target
+      end
+
+      #
+      # Template Helpers
+      #
+
+      def font_name
+        @options[:font_name]
+      end
+
+      def font_face(style = {})
+        if style.is_a?(Symbol)
+          if style == :preprocessor
+            url = "font-url"
+            path = @font_path_alt
+          elsif style == :preview
+            url = "url"
+            path = @font_path_preview
+          else
+            url = "url"
+            path = @font_path
+          end
+          say_message :warn, "`font_face(:#{style})` is deprecated. Use `font_face(url:'url', path:'path')` instead."
+        else
+          style = {:url => "url", :path => @font_path}.merge(style)
+          url = style[:url]
+          path = style[:path]
+        end
+
+        # Bulletproof @Font-Face <http://www.fontspring.com/blog/the-new-bulletproof-font-face-syntax>
+        # With and without Base64
+        if @options[:base64]
+          string = %Q|@font-face {
+  font-family: "#{font_name}";
+  src: #{url}("#{path}.eot?") format("embedded-opentype");
+  font-weight: normal;
+  font-style: normal;
+}
+
+@font-face {
+  font-family: "#{font_name}";
+  src: url("data:application/x-font-woff;charset=utf-8;base64,#{woff_base64}") format("woff"),
+       #{url}("#{path}.ttf") format("truetype"),
+       #{url}("#{path}.svg##{font_name}") format("svg");
+  font-weight: normal;
+  font-style: normal;
+}|
+        else
+        string = %Q|@font-face {
+  font-family: "#{font_name}";
+  src: #{url}("#{path}.eot");
+  src: #{url}("#{path}.eot?#iefix") format("embedded-opentype"),
+       #{url}("#{path}.woff") format("woff"),
+       #{url}("#{path}.ttf") format("truetype"),
+       #{url}("#{path}.svg##{font_name}") format("svg");
+  font-weight: normal;
+  font-style: normal;
+}|
+        end
+
+        # For Windows/Chrome <http://stackoverflow.com/a/19247378/1202445>
+        string << %Q|
+
+@media screen and (-webkit-min-device-pixel-ratio:0) {
+  @font-face {
+    font-family: "#{font_name}";
+    src: #{url}("#{path}.svg##{font_name}") format("svg");
+  }
+}|
+        string
+      end
+
+      def woff_base64
+        woff_path = File.join(@options[:output][:fonts], "#{@font_path}.woff")
+        Base64.encode64(File.binread(File.join(woff_path))).gsub("\n", "")
+      end
+
+      def glyph_selectors
+        output = @glyphs.map do |name, value|
+          aliases = []
+          aliases = @glyphs[name][:aliases].map do |alias_name|
+            @options[:css_selector].sub("{{glyph}}", alias_name.to_s) + ":before,\n"
+          end if @glyphs[name][:aliases]
+          aliases.join + @options[:css_selector].sub("{{glyph}}", name.to_s) + ":before"
+        end
+        output.join ",\n"
+      end
+
+      def glyph_properties
+%Q|  display: inline-block;
+  font-family: "#{font_name}";
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  line-height: 1;
+  text-decoration: inherit;
+  text-rendering: optimizeLegibility;
+  text-transform: none;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-font-smoothing: antialiased;
+  font-smoothing: antialiased;|
+      end
+
+      def glyphs
+        output = @glyphs.map do |name, value|
+          aliases = []
+          aliases = @glyphs[name][:aliases].map do |alias_name|
+            %Q|#{@options[:css_selector].sub('{{glyph}}', alias_name.to_s)}:before, |
+          end if @glyphs[name][:aliases]
+          aliases.join + %Q|#{@options[:css_selector].sub('{{glyph}}', name.to_s)}:before { content: "\\#{value[:codepoint].to_s(16)}"; }|
+        end
+        output.join "\n"
+      end
+    end
+  end
+end