cheapredwine 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cheapredwine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hugo Bastien
+
+MIT License
+
+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,61 @@
+# CheapRedWine 
+
+[![Code Climate](https://codeclimate.com/github/hugobast/cheapredwine.png)](https://codeclimate.com/github/hugobast/cheapredwine)
+
+
+
+I needed a way to test fonts on the web. I based this library on myfonts.com. CheapRedWine makes use to Harfbuzz' hb-view utility to generate images from fonts with a slew of different parameters. It also uses fontTools' ttx utility for font introspection.
+
+## Installation
+
+Make sure the dependencies are satisfied
+
+    $ gem install cheapredwine
+
+## Dependencies
+
+It assumes the following is installed and in the case where it applies, accessible from the $PATH env variable.
+
+* [cairo](http://www.cairographics.org/releases/)
+* [harfbuzz](http://www.freedesktop.org/software/harfbuzz/release/)
+* [ttx](git@github.com:mcolyer/fonttools.git)
+
+## Usage
+
+#### Getting a font object from a simple ttf or otf file:
+
+    font = CheapRedWine.font(font_file)
+    font.name # => "Font Name"
+    font.features # => ["liga", "onum", "dlig", … "salt"]
+    
+#### Generating images with text for the font:
+
+    image = CheapRedWine.image(font, "some text", options)
+    
+`image` is an IO object that can then be use to write to disk
+
+    
+##### Options
+
+    options = {
+      margin: 5, 				# margin around the text
+      size: 40, 				# size of the text eq to px
+      color: red, 				# the text color
+      features: [liga, salt]	# list of otf features to be applied
+    }
+
+##### Configuration
+
+CheapRedWine needs to know where to put ttx files
+
+    CheapRedWine::TTX.configure do |config|
+      config.output_folder = '/path/to/folder'
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cheapredwine.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cheapredwine/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cheapredwine"
+  gem.version       = CheapRedWine::VERSION
+  gem.authors       = ["Hugo Bastien"]
+  gem.email         = ["hugo@hbastien.com"]
+  gem.description   = %q{I needed a way to test fonts on the web. I based this library on myfonts.com. CheapRedWine makes use to Harfbuzz' hb-view utility to generate images from fonts with a slew of different parameters. It also uses fontTools' ttx utility for font introspection.}
+  gem.summary       = %q{I needed a way to test fonts on the web. I based this library on myfonts.com. CheapRedWine makes use to Harfbuzz' hb-view utility to generate images from fonts with a slew of different parameters. It also uses fontTools' ttx utility for font introspection.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+
+  gem.add_dependency 'nokogiri'
+end

data/lib/cheapredwine/image/params.rb

@@ -0,0 +1,16 @@
+module CheapRedWine
+  module Image
+    class Params
+      attr_reader :font, :color, :text, :features, :size, :margin
+
+      def initialize(options = {})
+        @font = options.fetch(:font) 
+        @color = options.fetch(:color) { 'black' }
+        @text = options.fetch(:text) { '' }
+        @features = options.fetch(:features) { [] }
+        @size = options.fetch(:size) { 20 }
+        @margin = options.fetch(:margin) { 5 }
+      end 
+    end
+  end
+end

data/lib/cheapredwine/image/writer.rb

@@ -0,0 +1,44 @@
+module CheapRedWine
+  module Image
+    class Writer 
+      def initialize(image, utility = 'hb-view')
+        @utility = utility
+        @image = image
+      end
+
+      def args
+        [font_file, text, margin, foreground, features, size]
+      end
+
+      def exec
+        IO.popen(args.unshift(@utility))
+      end
+
+      private
+
+      def font_file
+        "--font-file=#{@image.font.path}"
+      end
+
+      def text
+        "--text=#{@image.text}"
+      end
+
+      def size
+        "--font-size=#{@image.size}"
+      end
+
+      def foreground 
+        "--foreground=#{@image.color}"
+      end 
+
+      def margin
+        "--margin=#{@image.margin}"
+      end
+
+      def features
+        "--features=#{@image.features.join(",")}"
+      end
+    end
+  end
+end

data/lib/cheapredwine/image.rb

@@ -0,0 +1,2 @@
+require 'cheapredwine/image/params'
+require 'cheapredwine/image/writer'

data/lib/cheapredwine/ttx/extractor.rb

@@ -0,0 +1,23 @@
+module CheapRedWine
+  module TTX
+    class Extractor
+      def initialize(font_file, folder)
+        path = File.join(folder, filename(font_file)) 
+        unless File.exists?("#{path}.ttx")
+          IO.popen(['ttx', "-d#{folder}", "#{font_file.path}"]).read
+        end
+        @file = File.new("#{path}.ttx")
+      end
+
+      def ttx_file
+        @file
+      end
+
+      private
+
+      def filename(file)
+        File.basename(file, File.extname(file))
+      end
+    end
+  end
+end

data/lib/cheapredwine/ttx/parser.rb

@@ -0,0 +1,37 @@
+require 'nokogiri'
+
+module CheapRedWine
+  class NokogiriParser
+    @@parser = Nokogiri::XML::Document
+
+    def self.parse(file)
+      @@parser.parse(file)
+    end
+  end
+
+  module TTX
+    class Parser
+      def initialize(file, xml_parser = NokogiriParser)
+        @document = xml_parser.parse(file)
+      end
+
+      def features
+        @document.css('FeatureTag').map do |feature| 
+          feature.attr('value') 
+        end.uniq
+      end
+
+      def font_name 
+        namerecord(4).first.text.strip
+      end
+
+      def family_name
+        namerecord(1).first.text.strip
+      end
+
+      def namerecord(id)
+        @document.xpath("//namerecord[@nameID=#{id}]")
+      end
+    end
+  end
+end

data/lib/cheapredwine/ttx.rb

@@ -0,0 +1,27 @@
+require 'cheapredwine/ttx/parser'
+require 'cheapredwine/ttx/extractor'
+
+module CheapRedWine
+  module TTX
+    class Configuration
+      attr_accessor :output_folder
+
+      def initialize
+        @output_folder = 'ttx'
+      end
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration) if block_given?
+    end 
+
+    def self.for_font(font)
+      extractor = Extractor.new(font, configuration.output_folder)
+      parser = Parser.new(extractor.ttx_file)
+    end
+  end
+end

data/lib/cheapredwine/version.rb

@@ -0,0 +1,3 @@
+module CheapRedWine
+  VERSION = "0.0.2"
+end

data/lib/cheapredwine.rb

@@ -0,0 +1,51 @@
+require "cheapredwine/version"
+require "cheapredwine/ttx"
+require "cheapredwine/image"
+
+CheapRedWine::TTX.configure do |config|
+  config.output_folder = 'spec/fixtures'
+end
+
+module CheapRedWine
+  class Font
+    attr_accessor :name, :family, :features, :path
+
+    def initialize
+      yield(self) if block_given?
+    end
+
+    def file
+      File.new(path)
+    end
+  end
+
+  def self.font(file)
+    parser = TTX.for_font(file)
+    Font.new do |font|
+      font.name = parser.font_name
+      font.family = parser.family_name
+      font.features = parser.features
+      font.path = file
+    end
+  end
+
+  def self.image(font, text, options = {})
+    features = merge_features(font.features, options.fetch(:features) { [] })
+    options.merge!({ 
+      features: features,
+      font: font.file,
+      text: text
+    })
+    params = Image::Params.new(options)
+    Image::Writer.new(params).exec
+  end
+
+  private
+
+  def self.merge_features(all_features, selected_features)
+    all_features.map do |feature|
+      prefix = selected_features.include?(feature) ? '+' : '-'
+      prefix + feature
+    end
+  end
+end

data/spec/cheapredwine_spec.rb

@@ -0,0 +1,23 @@
+require 'cheapredwine'
+require 'tempfile'
+
+describe CheapRedWine do
+  let(:file) { File.new('spec/fixtures/hobo.otf') }
+  let(:font) { CheapRedWine.font(file) }
+
+  it "creates a Font object from a font file" do
+    font.name.should eq "Hobo Std Medium"
+    font.file.path.should match file.path
+  end
+
+  it "can create images from text" do
+    options = { size: 26, features: ['liga', 'frac'] }
+    image = CheapRedWine.image(font, 'ffi 1/2', options)
+    tempfile = Tempfile.new('image')
+    tempfile.write(image.read)
+    tempfile.close
+    mimetype = IO.popen(["file", "--brief", "--mime-type", tempfile.path]).
+      read.chomp
+    mimetype.should eq "image/png"
+  end
+end