marmot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d63183e8ca618db1c3f5535b9694aecf03817ca
+  data.tar.gz: ef58b0b863574c9c726464e5d956d26d695fe4f6
+SHA512:
+  metadata.gz: aa524f16170c0bb2d8bf02e23176c6a2be79bbb30eed21d1583e256c2baa52f173ba0a56b0cef7f6970be7bac1633b136d9e7638dc18df0b6df3e73ef5289c66
+  data.tar.gz: 97de6003b10518817cf24ef71cae79e5cb0bc07806e962bbd3308c7c7b92fb72bee37965cdac0934ef9649bc74cf9cec3503413d0202888fa42209529e6a1f4c

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+._DS_Store
+*.gem
+bin/marmot-local
+.yardoc
+sandbox

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2013 Dmitry Filimonov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,97 @@
+# Marmot — Unofficial [FontSquirrel Webfont Generator](https://github.com/petethepig/) Client 
+
+Marmot automates font-face generation, making it easier and faster:
+
+    marmot Averia-Regular.ttf         # ls .   =>   webfontkit.zip
+
+Marmot supports FontSquirrel configuration files:
+
+    marmot  -c generator-config.txt  font.otf
+
+It is especially useful when it comes to your own icon fonts:
+
+    marmot  -c config.txt  my-icon-font.otf  my-icon-font.zip
+
+###Great, how do I install Marmot?
+
+Marmot is a ruby gem:
+
+    gem install marmot
+
+###Okay, how do I configure it?
+
+FontSquirrel Webfont Generator has **a lot of** options and by default Marmot will use default ones.
+
+Every FontSquirrel webfont kit comes with a text file called **generator_config.txt**. Marmot can read it:
+
+    marmot  -c generator-config.txt  font.otf
+
+Since the config is actually just a JSON file, you can write your own configs. I use this one for my icons:
+```json
+{
+  "formats":["ttf", "woff", "svg"],
+  "fallback":"none",
+  "subset_custom_range":"E000-F8FF",
+  "emsquare":"1000"
+}
+```
+
+You can do the same thing from the command line:
+
+    marmot  --no-add-hyphens  --formats=ttf,woff  font.otf
+
+Here is a full list of options:
+
+```bash
+                         --mode <s>
+                      --formats <s> 
+                --tt-instructor <s> 
+             --fix-vertical-metrics
+                         --fix-gasp
+                   --remove-kerning
+                       --add-spaces
+                      --add-hyphens
+                     --fallback <s>
+              --fallback-custom <i>
+                          --webonly
+               --options-subset <s>
+                 --subset-range <s>
+                --subset-custom <s>
+          --subset-custom-range <s>
+                           --base64
+                       --style-link
+               --css-stylesheet <s>
+                  --ot-features <s>
+              --filename-suffix <s>
+                     --emsquare <i>
+           --spacing-adjustment <i>
+                        --agreement
+```
+
+###Oh, this is great, but what is "tt-instuctor" or "subset-custom"?
+
+Some option names can be confusing. Go to [generator's page](http://www.fontsquirrel.com/tools/webfont-generator) and run this in the console:
+
+```js
+  $("input[value='expert'], input[value='advanced']").click();
+  $("table input").each(function(){
+    $(this).after($("<div style='color:red;'>"+$(this).attr("name")+" : "+$(this).attr("value")+"</div>"));
+  });
+```
+
+###What else?
+Since Marmot is a ruby gem, you can use it in your ruby projects:
+```ruby
+require 'marmot'
+
+client = Marmot::Client.new
+client.convert File.new("font.ttf"), { 
+  formats: ["ttf", "woff"] 
+}
+```
+
+###I found a lousy bug, what do I do?
+
+Marmot is only a couple days old, so this can happen. Please, report on the [Issues page](https://github.com/petethepig/marmot/issues).
+
+Or [contact me on Twitter](https://twitter.com/dmi3f)

data/bin/marmot

@@ -0,0 +1,120 @@
+require 'forwardable'
+require 'trollop'
+require 'marmot'
+
+#Delegator pattern
+class CustomLogger < Logger
+  extend Forwardable
+  attr_accessor :stderr_logger
+  def_delegators :@stderr_logger, :fatal, :error
+
+  def initialize logdev, shift_age = 0, shift_size = 1048576
+    super logdev, shift_age, shift_size
+    @stderr_logger = Logger.new STDERR, shift_age, shift_size
+    @stderr_logger.formatter = self.formatter = proc do |severity, datetime, progname, msg|
+      "#{msg}\n"
+    end
+  end
+end
+
+
+class Marmot::CLI
+
+  BANNER = <<-EOF
+Usage: marmot [options] input [output]
+
+Description:
+  Convert font files to a webfont kit using FontSquirrel Webfont Generator
+
+Example:
+  marmot -v font.ttf
+  marmot font.ttf archive.zip
+  marmot -c config.txt font.ttf
+  marmot --formats=ttf,woff font.ttf
+  marmot --add-spaces --no-add-hyphens font.ttf
+
+Options:
+EOF
+
+  MAPPING = {
+    :array    => :string,
+    :radio    => :string,
+    :string   => :string,
+    :number   => :int,
+    :checkbox => :flag
+  }
+
+  def bail str=""
+    Trollop::die str.to_s
+    exit
+  end
+
+  def start
+    options = Trollop::options do
+      version "Marmot #{Marmot::VERSION} (c) 2013 Dmitry Filimonov https://github.com/petethepig/marmot"
+      banner BANNER
+      opt :verbose, 'Enable verbose mode',  short: 'v',    type: :flag
+      opt :debug,   'Enable debug mode',    short: 'd',    type: :flag
+      opt :config,  'Config file',          short: 'c',    type: :io
+      opt :output,  'Output file',          short: 'o',    type: :io
+
+      Marmot::OptionsSanitizer::OPTIONS.each_pair do |key, value|
+        type = MAPPING[value[0]]
+        opt key, key.to_s, type: type, short: :none unless key==:id
+      end
+    end.to_h
+
+    options.delete_if do |k,v|
+      !options["#{k}_given".to_sym]
+    end
+
+    #logger
+    logger = CustomLogger.new(STDOUT)
+    logger.sev_threshold = if options[:debug]
+      Logger::DEBUG
+    elsif options[:verbose]
+      Logger::INFO
+    else
+      Logger::ERROR
+    end
+
+    logger.debug "Command line options:\n#{options.collect{|k,v| "#{k}: #{v.inspect}" }.join("\n")}"
+
+    #files
+    input_file_path  = ARGV.first
+    output_file_path = options.delete(:output)
+    output_file_path ||= ARGV.last if ARGV.first != ARGV.last
+    config_file_path = options.delete :config
+
+    if !input_file_path
+      bail "Error: option 'input' is missing."
+    end
+
+    begin
+      input_file  = File.new(input_file_path)  
+      output_file = File.new(output_file_path,"wb") if output_file_path
+      config_file = File.new(config_file_path) if config_file_path
+    rescue StandardError => e
+      bail e.message
+    end
+
+
+    if(config_file)
+      options = JSON.parse(config_file.read.gsub /^#.*$/, '').merge options
+    end
+    if(output_file)
+      options[:output_io] = output_file
+    end
+
+    #finally, convert the font
+    begin
+      client = Marmot::Client.new
+      client.logger = logger
+      client.convert input_file, options
+    rescue Marmot::MarmotError => e
+      bail e.message
+    end
+  end
+end
+
+Marmot::CLI.new.start

data/doc/js-snippet.js

@@ -0,0 +1,5 @@
+$("input[value='expert']").click();
+$("input[value='advanced']").click();
+$("table input").each(function(){
+  $(this).after($("<div style='color:red;'>"+$(this).attr("name")+" : "+$(this).attr("value")+"</div>"));
+});

data/lib/marmot/client.rb

@@ -0,0 +1,230 @@
+require 'json'
+require 'httmultiparty'
+require 'logger'
+
+module Marmot
+  class Client
+    include HTTMultiParty
+
+    base_uri 'www.fontsquirrel.com'
+    attr_accessor :logger
+    attr_reader   :params
+    @@headers_set = false
+
+    def initialize
+      logger = Logger.new("/dev/null")
+      logger.close
+    end
+
+    # Convert a font file to a webfont kit
+    #
+    # @param [String] input_io Input IO. Examples: File.new("font.ttf"), STDOUT
+    #
+    # @param [Hash] options Options
+    #
+    # @option options 
+    #   [String]   :output_io          
+    #   Output IO
+    #   Default is a File with the name like "webfontkit-20130312-200144.zip"
+    #
+    # @option options 
+    #   [IO]       :output_stream        
+    #   Custom output stream, like STDOUT
+    #
+    # @option options 
+    #   [Hash]     :custom_options        
+    #   Options that will bypass sanitization. Make sure you know what you do before trying it out.
+    #
+    # @option options [Array or String]  :formats              
+    #   Allowed values are: "ttf", "woff", "svg", "eotz", "eot". Default is ["ttf","woff","svg","eotz"]
+    #
+    # @option options 
+    #   [String]   :mode                 
+    #   Generator mode: "optimal", "basic", "expert". Default is "optimal"
+    #
+    # @option options 
+    #   [String]   :tt_instructor        
+    #   Truetype hinting: "default", "keep"
+    #
+    # @option options 
+    #   [Boolean]  :fix_vertical_metrics 
+    #   Rendering option. Fix Vertical Metrics (Normalize across browsers). Default is true
+    #
+    # @option options 
+    #   [Boolean]  :fix_gasp       
+    #   Rendering option. Fix GASP Table (Better DirectWrite Rendering). Default is true
+    #
+    # @option options 
+    #   [Boolean]  :remove_kerning  
+    #   Rendering option. Remove Kerning (Strip kerning data). Default is false
+    #
+    # @option options 
+    #   [Boolean]  :add_spaces       
+    #   Fix missing glyphs option. Fix spaces. Default is true
+    #
+    # @option options 
+    #   [Boolean]  :add_hyphens    
+    #   Fix missing glyphs option. Fix hyphens. Default is true
+    #
+    # @option options 
+    #   [String]   :fallback             
+    #   X-height matching: "none", "arial", "verdana", "trebuchet", "georgia", "times", "courier", "custom"
+    #
+    # @option options 
+    #   [String]   :fallback_custom      
+    #   Custom x-height matching, in percents. Default is "100%". Only applies when :fallback is "custom"
+    #
+    # @option options 
+    #   [Boolean]  :webonly    
+    #   Disable desktop use. Default is false
+    #    
+    # @option options 
+    #   [String]   :options_subset       
+    #   Subsetting options: "basic", "advanced", "none". Default is "basic"
+    #
+    # @option options 
+    #   [Array]    :subset_range        
+    #   Custom subsetting options. Only applies when :options_subset is "advanced". 
+    #   Allowed values are: "macroman", "lowercase", "uppercase", "numbers", "punctuation", "currency", 
+    #   "typographics", "math", "altpunctuation", "accentedlower", "accentedupper", "diacriticals", 
+    #   "albanian", "bosnian", "catalan", "croatian", "cyrillic", "czech", "danish", "dutch", "english", 
+    #   "esperanto", "estonian", "faroese", "french", "german", "greek", "hebrew", "hungarian", "icelandic", 
+    #   "italian", "latvian", "lithuanian", "malagasy", "maltese", "norwegian", "polish", "portuguese", 
+    #   "romanian", "serbian", "slovak", "slovenian", "spanish", "swedish", "turkish", "ubasic", "ulatin1", 
+    #   "ucurrency", "upunctuation", "ulatina", "ulatinb", "ulatinaddl"
+    #
+    # @option options 
+    #   [String]   :subset_custom        
+    #   Single characters. Only applies when :options_subset is "advanced". Default is ""
+    #
+    # @option options 
+    #   [String]   :subset_custom_range  
+    #   Unicode Ranges. Only applies when :options_subset is "advanced". 
+    #   Comma separated values. Can be single hex values and/or ranges separated with hyphens. 
+    #   Example: "0021-007E,00E7,00EB,00C7,00CB"
+    #
+    # @option options 
+    #   [Boolean]  :base64               
+    #   CSS option. Base64 encode (Embed font in CSS). Default is false
+    #
+    # @option options 
+    #   [Boolean]  :style_link           
+    #   CSS option. Style link (Family support in CSS). Default is false
+    #
+    # @option options 
+    #   [String]   :css_stylesheet       
+    #   CSS Filename. Default is "stylesheet.css"
+    #
+    # @option options 
+    #   [String]   :ot_features         
+    #   OpenType Options. If the features are available, the generator will fold them into the font.
+    #   Allowed values: "onum", "lnum", "tnum", "pnum", "zero", "ss01", "ss02", "ss03", "ss04", "ss05"
+    #
+    # @option options 
+    #   [String]   :filename_suffix      
+    #   Filename suffix. Default is "-webfont"
+    #
+    # @option options 
+    #   [String]   :emsquare   
+    #   Em Square Value. In units of the em square. Default is 2048
+    #
+    # @option options 
+    #   [String]   :spacing_adjustment   
+    #   Adjust Glyph Spacing. In units of the em square. Default is 0
+    #
+    # @option options 
+    #   [Boolean]  :agreement            
+    #   Agreement option. The fonts You're uploading are legally eligible for web embedding. Default is true.
+    #
+    # @see http://www.fontsquirrel.com/tools/webfont-generator more info about parameters @ www.fontsquirrel.com
+    # @return [String]  
+    def convert input_io, options={}
+      @exception = nil
+      #1
+      iam "Retrieving cookies... ", false do
+        response = self.class.get '/tools/webfont-generator'
+        @cookies = (response.headers.get_fields("Set-Cookie") || []).join(";")
+        fail "Failed to retrieve cookies" if @cookies.empty? 
+        self.class.headers({"Cookie" => @cookies})
+        @@headers_set = true
+        response
+      end unless @@headers_set
+
+      #2
+      iam "Uploading font... " do
+        response = self.class.post '/uploadify/fontfacegen_uploadify.php', :query => {
+          "Filedata"    => File.new(input_io)
+        }
+        @path_data = response.body
+        @id, @original_filename = @path_data.split("|")
+        fail "Failed to upload the file. Is it a valid font?" if @id.nil? || @original_filename.nil?
+        response
+      end
+
+      #3
+      iam "Confirming upload... " do
+        response = self.class.post "/tools/insert", :query => {
+          "original_filename"  => @original_filename,
+          "path_data"          => @path_data
+        }
+        json = JSON.parse response.body
+        fail (json["message"] || "Failed to confirm the upload. Is it a valid font?") if !json["name"] || !json["id"]
+        response
+      end
+
+      #4
+      iam "Generating webfont... " do
+        custom_options = options.delete :custom_options
+        options[:id] = @id
+        @params = OptionsSanitizer.sanitize(options, custom_options)
+        logger.debug "HTTP Params:\n#{@params.collect{|k,v| "#{k}: #{v.inspect}" }.join("\n")}"
+        response = self.class.post "/tools/generate", :query => @params
+        fail "Failed to generate webfont kit" if !response.body.empty?
+        response
+      end
+
+      #5
+      counter = 0
+      while response = self.class.get("/tools/progress/#{@id}") do 
+        p = JSON.parse(response.body)["progress"].to_i
+        logger.info "Progress: #{p} "
+        if p == 100
+          break
+        elsif p == 0
+          fail "Progress timeout" if (counter += 1) > 10
+        end
+        sleep 2        
+      end
+
+      #6
+      iam "Downloading fonts... ", false do
+        response = self.class.post "/tools/download", :query => @params
+      end
+
+      #7
+      if !options[:output_io]
+        filename = response.headers["Content-Disposition"].gsub(/attachment; filename=\"(.*)\"/,'\1')
+        options[:output_io] = File.new(filename, "wb")
+      end
+      options[:output_io] << response.response.body
+
+    end
+
+    protected
+
+    def iam desc, log_body=true
+      logger.info desc
+      response = yield
+      logger.info response.message
+      logger.debug "Response body: #{response.body}" if log_body 
+      if @exception
+        raise @exception
+      end
+    end
+
+    def fail str
+      @exception = MarmotError.new str
+    end
+
+  end
+end

data/lib/marmot/options_sanitizer.rb

@@ -0,0 +1,97 @@
+module Marmot
+  class OptionsSanitizer
+    OPTIONS = {
+      :id                   => [:string, ""],
+      :mode                 => [:radio, "optimal", "basic", "expert"],
+      :formats              => [:array, "ttf", "woff", "svg", "eotz", "eot"],
+      :tt_instructor        => [:radio, "default", "keep"],
+      :fix_vertical_metrics => [:checkbox, "Y"],
+      :fix_gasp             => [:checkbox, "xy"],
+      :remove_kerning       => [:checkbox, nil, "Y"],
+      :add_spaces           => [:checkbox, "Y"],
+      :add_hyphens          => [:checkbox, "Y"],
+      :fallback             => [:radio, "none", "arial", "verdana", "trebuchet", "georgia", "times", "courier", "custom"],
+      :fallback_custom      => [:number, 100],
+      :webonly              => [:checkbox, nil, "Y"],
+      :options_subset       => [:radio, "basic", "advanced", "none"],
+      :subset_range         => [:array, "macroman", "lowercase", "uppercase", "numbers", "punctuation", "currency",
+                                        "typographics", "math", "altpunctuation", "accentedlower", "accentedupper",
+                                        "diacriticals", "albanian", "bosnian", "catalan", "croatian", "cyrillic",
+                                        "czech", "danish", "dutch", "english", "esperanto", "estonian", "faroese",
+                                        "french", "german", "greek", "hebrew", "hungarian", "icelandic", "italian",
+                                        "latvian", "lithuanian", "malagasy", "maltese", "norwegian", "polish",
+                                        "portuguese", "romanian", "serbian", "slovak", "slovenian", "spanish",
+                                        "swedish", "turkish", "ubasic", "ulatin1", "ucurrency", "upunctuation",
+                                        "ulatina", "ulatinb", "ulatinaddl"],
+      :subset_custom        => [:string, ""],
+      :subset_custom_range  => [:string, ""],
+      :base64               => [:checkbox, nil, "Y"],
+      :style_link           => [:checkbox, nil, "Y"],
+      :css_stylesheet       => [:string, "stylesheet.css"],
+      :ot_features          => [:array, "onum", "lnum", "tnum", "pnum", "zero", "ss01", "ss02", "ss03", "ss04", "ss05"],
+      :filename_suffix      => [:string, "-webfont"],
+      :emsquare             => [:number, 2048],
+      :spacing_adjustment   => [:number, 0],
+      :agreement            => [:checkbox, "Y"]
+    }
+
+    NON_EXPERT_OPTIONS = [:id, :agreement, :mode]
+    SUBSET_OPTIONS = [:subset_range, :subset_custom, :subset_custom_range]
+
+    # Sanitize options 
+    def self.sanitize options, custom_options={}
+      options = options.clone
+      custom_options ||= {}
+      result = {}
+      OPTIONS.each_pair do |key,array|
+        type = array[0]
+        allowed_values = array[1..999]
+        user_value = options[key].nil? ? options[key.to_s] : options[key]
+        user_value = user_value.to_s unless user_value.nil?
+        
+        if !user_value.nil? && OPTIONS.has_key?(key) && !NON_EXPERT_OPTIONS.include?(key)
+          options[:mode] = result[:mode] = "expert" if options[:mode].nil?
+        end
+
+
+        if !user_value.nil? && OPTIONS.has_key?(key) && SUBSET_OPTIONS.include?(key)
+          options[:options_subset] = result[:options_subset] = "advanced" if options[:options_subset].nil?
+        end
+
+        case type
+        when :array
+          if !user_value.kind_of?(Array)
+            if user_value.kind_of?(String)
+              user_value = user_value.split(",").map{|v| v.strip}
+            else
+              user_value = [user_value]
+            end
+          end
+
+          user_value = user_value.delete_if {|val| !allowed_values.include? val }
+
+          result[key] = user_value unless user_value.empty?
+        when :number
+          result[key] = (user_value || allowed_values[0]).to_i
+        when :string
+          result[key] = user_value || allowed_values[0]
+        when :checkbox
+          if user_value == true
+            result[key] = allowed_values.last
+          elsif user_value == "false"
+            #nil
+          else
+            result[key] = allowed_values.include?(user_value) ? (user_value) : (allowed_values[0])
+          end
+        when :radio
+          result[key] = allowed_values.include?(user_value) ? (user_value) : (allowed_values[0])
+        end
+      end
+
+      result[:formats] = ["ttf", "woff", "svg", "eotz"] if result[:formats].nil?
+      result[:dirname] = [result[:id]]
+      result.merge!(custom_options).delete_if { |k, v| v.nil? }
+    end
+
+  end
+end

data/lib/marmot/version.rb

@@ -0,0 +1,3 @@
+module Marmot
+  VERSION = "0.0.1".freeze
+end

data/lib/marmot.rb

@@ -0,0 +1,7 @@
+module Marmot
+  class MarmotError < StandardError ; end
+end
+
+require 'marmot/version'
+require 'marmot/options_sanitizer'
+require 'marmot/client'

data/marmot.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "marmot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "marmot"
+  s.version     = Marmot::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dmitry Filimonov"]
+  s.email       = ["me@dfilimonov.com"]
+  s.homepage    = "http://github.com/petethepig/marmot"
+  s.summary     = %q{Unofficial Font Squirrel webfont generator client}
+  s.description = %q{Unofficial Font Squirrel webfont generator client}
+  s.license     = "MIT"
+
+  s.add_dependency 'trollop'
+  s.add_dependency 'httmultiparty'
+  s.add_dependency 'json'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/client_spec.rb

@@ -0,0 +1,31 @@
+
+require_relative "../lib/marmot"
+
+
+describe Marmot::Client do
+  
+  before do 
+    @client = Marmot::Client.new 
+    @client.logger = Logger.new(STDOUT)
+  end
+
+  it "successfully performs conversion" do
+    file = @client.convert File.expand_path("../test-files/Averia/Averia-Regular.ttf", __FILE__)
+    File.exist?(file).should == true
+    File.delete(file)
+  end
+  
+  it "raises exception because there is no such file" do
+    expect { 
+      @client.convert File.expand_path("../test-files/Averia/Averia-ExtraBold.ttf", __FILE__)
+    }.to raise_error
+  end
+
+  it "raises exception because file is not a font" do
+    expect { 
+      @client.convert File.expand_path("../test-files/Averia/FONTLOG.txt", __FILE__)
+    }.to raise_error
+  end
+
+end
+