cheapredwine 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0db300cc3cd1f51a506262396b30650345609de
-  data.tar.gz: d48412833b31a5bfbfceaca49fbdc39cd62e3d45
+  metadata.gz: 507b55232c7e11bb44fecba447aafb123c916a54
+  data.tar.gz: 71a1610253c44b2e813f5a35794403642e9741c9
 SHA512:
-  metadata.gz: 8d1f414e15102ad639243999c88d0b4db26949225fc94512e916bb88750dc1e13f18d153498197faaf8cf7b383e51e22b550e1d503e932c893282afae6856258
-  data.tar.gz: 8814e6f52930c0dd488c612a77a952cd67b260fb1cf41bd1375c005caddbbf86aeecc628e2b053e889b8b2c2e3e5f7722efd645a2f93057b8b3ce26f24e4fe7e
+  metadata.gz: 644ce9189ef137b71c6d4e09143a42f1113bcd35c1262b707e404b9bc117c139b0d3e266f2d0f5e3bf2a0124a734a81572374f8eaf0e8e6f2a54f99d743b5ef9
+  data.tar.gz: b4bc656a2f792e3b02bffbb0d5d87eab712aca3a02c9f604bd02f80dcd256207cdfe8fb5b1e042c325d5bc6ab5ae9592a00a21fefcdebd366ecfbdadbd9d7530

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -2,9 +2,3 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-
-before_script:
-  - echo 'yes' | sudo add-apt-repository ppa:olivier-berten/fonts
-  - sudo apt-get update
-  - sudo apt-get install libcairo
-  - sudo apt-get install harfbuzz

data/README.md

@@ -1,10 +1,9 @@
-# CheapRedWine 
+# Cheapredwine 
 
 [![Code Climate](https://codeclimate.com/github/hugobast/cheapredwine.png)](https://codeclimate.com/github/hugobast/cheapredwine)
+[![Build Status](https://travis-ci.org/hugobast/cheapredwine.png?branch=master)](https://travis-ci.org/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.
+Makes text images. Introspecs (in a limited way thus far) a font file to get to it's metadata. Supports OTF/TTF font features the likes of ligatures, old style numbers, stylistic alternatives, etc. Cheapredwine uses of Harfbuzz' hb-view utility to generate images.
 
 ## Installation
 
@@ -14,7 +13,7 @@ Make sure the dependencies are satisfied
 
 ## Dependencies
 
-It assumes the following is installed and in the case where it applies, accessible from the $PATH env variable.
+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/)
@@ -23,28 +22,24 @@ It assumes the following is installed and in the case where it applies, accessib
 
 #### Getting a font object from a simple ttf or otf file:
 
-    font = CheapRedWine.new font_file
-    font.name # => "Font Name"
-    font.family # => "Font Family"
+    font = Cheapredwine.new font_file
+    font.font_name # => "Font Name"
+    font.family_name # => "Font Family"
     font.style # => "Bold Italic"
     font.features # => ["liga", "onum", "dlig", … "salt"]
     
 #### Generating images with text for the font:
 
-    image = font.image "some text", options
-    # ... do something with image ...
-    image.close
-    
-**Caveat:** `image` is an IO object that can then be use to write to disk. You are responsible to close that object.
-   
-##### 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
-    }
+    image = font.image do
+      append_text "Hello"                   # A regular piece of text
+      append_text "123456", with: ["onum"]  # A piece of text with 'onum' enable
+      turn_on_feature "dlig"                # Turns a feature on for the whole image
+      turn_off_feature "liga"               # Turns off a feature for the whole image
+      set_margin 0
+      set_font_size 32
+      set_background "#123456"
+      set_foreground "#654321"
+    end
 
 ## Contributing
 
@@ -56,4 +51,4 @@ It assumes the following is installed and in the case where it applies, accessib
 
 ## TODO
 
-1. Replace hb-view by something more appropriate (C Extension).
+1. Replace hb-view by something more appropriate (C Extension or pure Ruby implementation).

data/cheapredwine.gemspec

@@ -5,11 +5,11 @@ require 'cheapredwine/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "cheapredwine"
-  gem.version       = CheapRedWine::VERSION
+  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.description   = %q{I needed a way to test fonts on the web. I based this library on myfonts.com. Cheapredwine uses 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 uses 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      = "https://github.com/hugobast/cheapredwine"
 
   gem.files         = `git ls-files`.split($/)

data/lib/cheapredwine.rb

@@ -1,55 +1,34 @@
 require "cheapredwine/version"
-require "cheapredwine/info"
-require "cheapredwine/image"
+require "cheapredwine/command"
 
-class CheapRedWine
+class Cheapredwine
   extend Forwardable
-  attr_accessor :font
-  def_delegators :@font, :file, :name, :family, :style, :features
-
-  def initialize(file)
-    info = Info.new file
-    @font = Font.new do |font|
-      font.name = info.font_name
-      font.family = info.family_name
-      font.features = info.features
-      font.style = info.style
-      font.path = file
-      font
-    end
-  end
 
-  def image(text, options = {})
-    features = merge_features(font.features, options.fetch(:features) { [] })
-    
-    params = options.merge({ 
-      features: features,
-      font: font.file,
-      text: text
-    })
-
-    params = Image::Params.new(params)
-    Image::Writer.new(params).exec
+  attr_accessor :file
+  def_delegators :@attrs, :font_name, :family_name, :style, :features
+
+  def initialize file
+    @attrs = Parser.new file
+    @file = File.new file
   end
 
-  private
+  def image &block
+    create(&block).run!
+  end
 
-  def merge_features(all_features, selected_features)
-    all_features.map do |feature|
-      prefix = selected_features.include?(feature) ? '+' : '-'
-      prefix + feature
-    end
+  def create &block
+    builder.instance_eval &block
+    builder.font_file file.path
+    runner
   end
 
-  class Font
-    attr_accessor :name, :family, :features, :path, :style
+  private
 
-    def initialize
-      yield(self) if block_given?
-    end
+  def builder
+    @builder ||= Command::Builder.new
+  end
 
-    def file
-      File.new(path)
-    end
+  def runner
+    @runner ||= Command::Runner.new builder
   end
 end

data/lib/cheapredwine/command.rb

@@ -0,0 +1,2 @@
+require 'cheapredwine/command/builder'
+require 'cheapredwine/command/runner'

data/lib/cheapredwine/command/builder.rb

@@ -0,0 +1,69 @@
+require 'cheapredwine/command/nodes'
+
+class Cheapredwine
+  module Command
+    class Builder
+      attr_reader :features, :nodes
+
+      def initialize
+        @features = ["-liga"]
+        @nodes = Nodes.new
+        yield self if block_given?
+      end
+
+      def append_text text, options = {}
+        nodes.add text, options.fetch(:with, [])
+      end
+
+      def set_margin size
+        @margin = size
+      end
+
+      def set_font_size size
+        @font_size = size
+      end
+
+      def font_file file
+        @font_file = file
+      end
+
+      def set_foreground color
+        @foreground = color
+      end
+
+      def set_background color
+        @background = color
+      end
+
+      def turn_on_feature feature
+        features.push "+#{feature}"
+      end
+
+      def turn_off_feature feature
+        features.push "-#{feature}"
+      end
+
+      def to_params
+        {
+          features: "#{all_features.join(",")}",
+          text: "#{nodes.concat}",
+          font_file: @font_file,
+          font_size: @font_size,
+          foreground: @foreground,
+          background: @background,
+          margin: @margin
+        }.reject { |key, val| val.nil? }
+      end
+
+      private
+
+      def all_features
+        features + all_features_from_text
+      end
+
+      def all_features_from_text
+        nodes.all.map { |node| node.features }.flatten
+      end
+    end
+  end
+end

data/lib/cheapredwine/command/node.rb

@@ -0,0 +1,19 @@
+class Cheapredwine
+  module Command
+    class Node
+      attr_reader :text, :starts_at
+
+      def initialize text, features, starts_at
+        @text = text
+        @features = features
+        @starts_at = starts_at
+      end
+
+      def features
+        @features.map do |feature|
+          "#{feature}[#{starts_at}:#{starts_at + text.length}]"
+        end
+      end
+    end
+  end
+end

data/lib/cheapredwine/command/nodes.rb

@@ -0,0 +1,29 @@
+require 'cheapredwine/command/node'
+
+class Cheapredwine
+  module Command
+    class Nodes
+      attr_reader :nodes
+
+      def initialize
+        @nodes = []
+      end
+
+      def add text, features
+        nodes << Node.new(text, features, length)
+      end
+
+      def all
+        nodes
+      end
+
+      def concat
+        nodes.map { |node| node.text }.join
+      end
+
+      def length
+        concat.length
+      end
+    end
+  end
+end

data/lib/cheapredwine/command/runner.rb

@@ -0,0 +1,29 @@
+class Cheapredwine
+  module Command
+    class Runner
+      attr_reader :builder
+
+      def initialize builder
+        @builder = builder
+      end
+
+      def run!
+        IO.popen params.unshift "hb-view"
+      end
+
+      def params
+        builder.to_params.map { |k, v| parameterize_pair k, v }
+      end
+
+      private
+
+      def parameterize_pair key, val
+        "--#{parameterize key}=#{val}"
+      end
+
+      def parameterize key
+        key.to_s.gsub(/_/, "-")
+      end
+    end
+  end
+end

data/lib/cheapredwine/{info.rb → parser.rb}

@@ -1,9 +1,9 @@
 require 'tipo'
 
-class CheapRedWine
-  class Info
-    def initialize file
-      @info = Tipo.info file
+class Cheapredwine
+  class Parser
+    def initialize file, parser = Tipo
+      @info = parser.info file
     end
 
     def font_name

data/lib/cheapredwine/version.rb

@@ -1,3 +1,3 @@
-class CheapRedWine
-  VERSION = "0.3.1"
+class Cheapredwine
+  VERSION = "0.4.0"
 end

data/spec/cheapredwine/command/builder_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'cheapredwine/command/builder'
+
+describe Cheapredwine::Command::Builder do
+  let(:builder) { Cheapredwine::Command::Builder.new }
+
+  it "sets liga to off by default" do
+    expect(builder.features).to eq ["-liga"]
+  end
+
+  it "transforms it's data to params" do
+    builder.append_text "hello"
+    builder.append_text " world"
+
+    expect(builder.to_params).to eq features: "-liga", text: "hello world"
+  end
+
+  it "transforms it's data to params along with features" do
+    builder.append_text "ffi", with: ["liga"]
+    builder.append_text "stffi"
+    builder.append_text "st", with: ["dlig"]
+
+    expect(builder.to_params).to eq features: "-liga,liga[0:3],dlig[8:10]", text: "ffistffist"
+  end
+
+  context "with features" do
+    let(:builder) { Cheapredwine::Command::Builder.new }
+
+    it "can turn on a features" do
+      builder.turn_on_feature "liga"
+      expect(builder.features).to eq ["-liga", "+liga"]
+    end
+
+    it "can turn off a feature" do
+      builder.turn_off_feature "onum"
+      expect(builder.features).to eq ["-liga", "-onum"]
+    end
+  end
+end

data/spec/cheapredwine/command/runner_spec.rb

@@ -0,0 +1,36 @@
+require 'cheapredwine/command/runner'
+require 'cheapredwine/command/builder'
+
+describe Cheapredwine::Command::Runner do
+  let(:builder) {
+    Cheapredwine::Command::Builder.new do |builder|
+      builder.append_text "Lorem ipsum dolor"
+      builder.turn_on_feature "aalt"
+      builder.set_font_size 15
+      builder.font_file "/path/to/font.otf"
+    end
+  }
+
+  let(:runner) { Cheapredwine::Command::Runner.new builder }
+
+  it "assembles params from a builder" do
+    expect(runner.params).to eq [
+      "--features=-liga,+aalt",
+      "--text=Lorem ipsum dolor",
+      "--font-file=/path/to/font.otf",
+      "--font-size=15"
+    ]
+  end
+
+  it "executes the command" do
+    expect(IO).to receive(:popen).with([
+      "hb-view",
+      "--features=-liga,+aalt",
+      "--text=Lorem ipsum dolor",
+      "--font-file=/path/to/font.otf",
+      "--font-size=15"
+    ])
+
+    runner.run!
+  end
+end