phew 0.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# The gem's dependencies are specified in the gemspec
+gemspec
+
+gem 'pry', '~> 0.10.0', type: :development

data/README.md

@@ -0,0 +1,43 @@
+# Phew
+
+Phew will be a font viewer.
+
+## Goals
+
+The primary use case that prompted the development of this program was
+needing to figure out which of the installed fonts provided characters
+for writing Japanese.
+
+As a user, in order to determine which fonts to keep, I want to know
+which fonts provide characters for a particular script, and compare them
+using a sample text.
+
+Many fonts provide characters for the latin script in addition to their
+primary focus on some other scripts. For example, many CJK fonts also
+provide latin letters, often of a lesser quality than fonts designed
+specifically for latin. Therefore, I want to be able to exclude such
+fonts when comparing latin fonts.
+
+As a user, in order to determine which font to use for a particular
+document, I want to know which fonts cover the characters I want to use,
+and compare them. I should be able to manipulate the initial selection
+by adding and removing fonts.
+
+Tentatively, there would be a filtering system, and we would have two
+lists of fonts that satisfy the filters, namely those that have been
+selected (the default state), and those that have been rejected.
+
+## License
+
+Copyright (c) 2012, 2015 Matijs van Zuijlen
+
+Phew is free software; you can redistribute it and/or modify it under the terms
+of the GNU General Public License as published by the Free Software Foundation,
+either version 3 of the License, or (at your option) any later version.
+
+This application is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this application. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake/clean'
+require 'bundler/gem_helper'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/unit/*_test.rb']
+    t.warning = true
+  end
+
+  Rake::TestTask.new(:end_to_end) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/end_to_end/*_test.rb']
+    t.warning = true
+  end
+
+  task all: [:unit, :end_to_end]
+end
+
+task test: 'test:all'
+
+task default: 'test'

data/bin/phew

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+require 'phew'
+
+Gtk.init
+
+module Phew
+  # Drop-down list of available scripts.
+  class ScriptList < Gtk::ComboBoxText
+    # FIXME: Should be able to fill inside #initialize
+    def fill
+      Pango::Script::Enum.symbols.
+        map(&:to_s).
+        each { |str| append str, str }
+    end
+  end
+
+  # Main Phew window
+  class Window < Gtk::Window
+    # Set up generic signal handlers for the window:
+    # - Closing the window ends the application
+    # - Pressing Ctrl-Q closes the window.
+    def connect_signals
+      signal_connect('destroy') { on_destroy_event }
+      signal_connect('key-press-event') { |_, evt, _| on_key_press_event evt }
+    end
+
+    def on_destroy_event
+      Gtk.main_quit
+      false
+    end
+
+    def on_key_press_event evt
+      destroy if evt.state == :control_mask && evt.keyval == 'q'.ord
+      false
+    end
+  end
+
+  # Main Phew application.
+  class Application
+    def combo
+      @combo ||= ScriptList.new.tap(&:fill)
+    end
+
+    def textview
+      @textview ||= Gtk::TextView.new
+    end
+
+    def build_vbox
+      vbox = Gtk::VBox.new false, 0
+
+      vbox.pack_start combo, false, false, 0
+      vbox.pack_start textview, false, false, 0
+      vbox.pack_start script_list_scroller, true, true, 0
+      vbox
+    end
+
+    def vbox
+      @vbox ||= build_vbox
+    end
+
+    def script_list_scroller
+      @script_list_scroller ||= Gtk::ScrolledWindow.new(nil, nil).tap do |scr|
+        lst = script_list
+        scr.add lst
+        lst.hadjustment = scr.hadjustment
+        lst.vadjustment = scr.vadjustment
+      end
+    end
+
+    def script_list
+      @script_list ||= Gtk::TreeView.new_with_model(scriptmodel).tap do |view|
+        renderer = Gtk::CellRendererText.new
+        col = Gtk::TreeViewColumn.new
+        col.set_title 'Font Name'
+        col.pack_start renderer, true
+        col.add_attribute renderer, 'text', 0
+        view.append_column col
+      end
+    end
+
+    def scriptmodel
+      @scriptmodel ||= Gtk::ListStore.new [GObject::TYPE_STRING]
+    end
+
+    def build_win
+      win = Window.new :toplevel
+      win.add vbox
+      win
+    end
+
+    def win
+      @win ||= build_win
+    end
+
+    # Set up all signal handlers
+    def connect_signals
+      win.connect_signals
+      combo.signal_connect('changed') { on_combo_changed_signal }
+    end
+
+    def on_combo_changed_signal
+      script = Script.new combo.active_text.to_sym
+      textview.buffer.text = script.sample_string
+      fill_font_list script
+    end
+
+    def initialize
+      @context = Gdk.pango_context_get
+      @font_repository = FontRepository.new @context
+      connect_signals
+      win.show_all
+    end
+
+    def fill_font_list script
+      scriptmodel.clear
+
+      fontmap = @context.get_font_map
+
+      fontmap.list_families.each do |fam|
+        font = @font_repository.get_font fam.name
+
+        sample_cov = font.coverage_summary script.sample_string
+        mostly = [:none, :fallback, :approximate, :exact].max_by { |i| sample_cov[i] }
+
+        if mostly == :exact
+          row = scriptmodel.append
+          scriptmodel.set_value row, 0, fam.name
+        end
+      end
+    end
+
+    def run
+      Gtk.main
+    end
+  end
+end
+
+Phew::Application.new.run

data/doc/prior-art.md

@@ -0,0 +1,40 @@
+# Prior Art
+
+## Font Viewer
+
+[Website](http://fontviewer.net/)
+
+![FontViewer screen shot](fontviewer.gif)
+
+Pleasantly sparse interface with obnoxious branding.
+
+The grid display of different font weights is a nice touch. 
+
+## GFontView
+
+[Website](http://gfontview.sourceforge.net/)
+
+![GFontView screen shot](gfontview.png)
+
+Based on files rather than installed fonts.
+
+Only shows one font at a time.
+
+## Gnome Specimen
+
+![Specimen screen shot](gnome_specimen.png)
+
+Clean interface. Does not allow filtering by desired script or text.
+
+
+## Waterfall
+
+![Waterfall screen shot](waterfall.png)
+
+Allows easy switching between different parts of the character set.
+
+## Character Map
+
+![Character map screen shot](character_map.png)
+
+A different way of selecting scripts. Nice balanced UI.

data/lib/phew/font.rb

@@ -0,0 +1,27 @@
+module Phew
+  # Font family. Handles coverage, among other things.
+  class Font
+    # Initialize the font from a text description. The text description should be
+    # in the format accepted by Pango::FontDescription.from_string.
+    #
+    # @param [Pango::Context] context Pango context to retrieve font from.
+    # @param [String] text_description Description of the font to create.
+    def initialize context, text_description
+      fd = Pango::FontDescription.from_string text_description
+      fontmap = context.get_font_map
+      @font = fontmap.load_font context, fd
+    end
+
+    # Summarize coverage of the given text by the glyphs in the font.
+    #
+    # @return A hash with keys :none, :fallback, :approximate, :exact, and values
+    #   indicating the number of characters in the text that have that coverage.
+    def coverage_summary text
+      lang = Pango::Language.new
+      cov = @font.get_coverage lang
+      text_cov = text.each_codepoint.map { |cp| cov.get cp }
+      Hash[
+        Pango::CoverageLevel::Enum.symbols.map { |lvl| [lvl, text_cov.count(lvl)] }]
+    end
+  end
+end

data/lib/phew/font_repository.rb

@@ -0,0 +1,17 @@
+module Phew
+  # Cache for font information retrieved from a Pango context
+  class FontRepository
+    # @param [Pango::Context] context Pango context to retrieve fonts from.
+    def initialize context
+      @store = {}
+      @context = context
+    end
+    # Retrieve a font based on the given text description. The text description
+    # should be in the format accepted by Font#new.
+    #
+    # @param [String] text_description Description of the font to retrieve.
+    def get_font text_description
+      @store[text_description] ||= Font.new @context, text_description
+    end
+  end
+end

data/lib/phew/script.rb

@@ -0,0 +1,18 @@
+module Phew
+  # A script.
+  class Script
+    def initialize name
+      symbol = name.to_sym
+      @symbol = symbol
+      @lang = Pango.script_get_sample_language symbol
+    end
+
+    def sample_string
+      if @lang.nil?
+        'No sample available'
+      else
+        @lang.get_sample_string
+      end
+    end
+  end
+end

data/lib/phew.rb

@@ -0,0 +1,6 @@
+require 'gir_ffi-gtk3'
+require 'gir_ffi-pango'
+
+require 'phew/script'
+require 'phew/font'
+require 'phew/font_repository'

data/test/end_to_end/basic_run_test.rb

@@ -0,0 +1,159 @@
+require File.expand_path('../test_helper.rb', File.dirname(__FILE__))
+
+require 'gir_ffi'
+
+GirFFI.setup :Atspi
+Atspi.load_class :Accessible
+
+module Atspi
+  # Utility monkey-patches for the Atspi::Accessible class
+  class Accessible
+    def each_child
+      child_count.times do |i|
+        yield get_child_at_index i
+      end
+    end
+
+    def find_role role, regex = //
+      return self if role == self.role && name =~ regex
+      each_child do |child|
+        result = child.find_role role, regex
+        return result if result
+      end
+      nil
+    end
+
+    def inspect_recursive level = 0, maxlevel = 4
+      each_child do |child|
+        puts "#{'  ' * level} > name: #{child.name}; role: #{child.role}"
+        child.inspect_recursive(level + 1) unless level >= maxlevel
+      end
+    end
+  end
+end
+
+def find_app name
+  desktop = Atspi.get_desktop(0)
+  desktop.each_child do |child|
+    next if child.nil?
+    return child if child.name == name
+  end
+  nil
+end
+
+def try_repeatedly
+  100.times.each do |num|
+    result = yield
+    return result if result
+    sleep_time = 0.01 * (num + 1)
+    sleep sleep_time
+  end
+  yield
+end
+
+def press_ctrl_q
+  Atspi.generate_keyboard_event(37, nil, :press)
+  Atspi.generate_keyboard_event(24, nil, :pressrelease)
+  Atspi.generate_keyboard_event(37, nil, :release)
+end
+
+# Test driver for the Phew application. Takes care of boot and shutdown, and
+# provides a handle on the GUI's main UI frame.
+class PhewDriver
+  def initialize
+    @app_file = File.expand_path('../../bin/phew', File.dirname(__FILE__))
+    @lib_dir = File.expand_path('../../lib', File.dirname(__FILE__))
+    @pid = nil
+    @killed = false
+  end
+
+  def boot timeout = 10
+    raise 'Already booted' if @pid
+    @pid = Process.spawn "ruby -I#{@lib_dir} #{@app_file}"
+
+    @killed = false
+    @cleanup = false
+
+    Thread.new do
+      ((timeout - 1) * 10).times do
+        break if @cleanup
+        sleep 0.1
+      end
+
+      10.times do
+        break unless @pid
+        sleep 0.1
+      end
+
+      if @pid
+        warn "About to kill child process #{@pid}"
+        @killed = true
+        Process.kill 'KILL', @pid
+      end
+    end
+  end
+
+  def cleanup
+    return unless @pid
+    @cleanup = true
+    _, status = Process.wait2 @pid
+    @pid = nil
+    status
+  end
+
+  def find_and_focus_frame
+    acc = try_repeatedly { find_app 'phew' }
+    acc.wont_be_nil
+
+    frame = acc.get_child_at_index 0
+    frame.role.must_equal :frame
+    frame.grab_focus
+    sleep 0.1
+
+    frame
+  end
+end
+
+describe 'The Phew application' do
+  before do
+    @driver = PhewDriver.new
+    @driver.boot
+  end
+
+  it 'starts and can be quit with Ctrl-q' do
+    @driver.find_and_focus_frame
+
+    press_ctrl_q
+
+    status = @driver.cleanup
+    status.exitstatus.must_equal 0
+  end
+
+  it 'shows a dropdown list of scripts' do
+    frame = @driver.find_and_focus_frame
+
+    box = frame.find_role :combo_box
+
+    latin = box.find_role :menu_item, /latin/
+    latin.wont_be_nil
+
+    textbox = frame.find_role :text
+    textbox.wont_be_nil
+    textbox.get_text(0, 100).must_equal ''
+
+    box.get_action_name(0).must_equal 'press'
+    box.do_action 0
+    latin.get_action_name(0).must_equal 'click'
+    latin.do_action 0
+
+    textbox.get_text(0, 100).must_equal 'The quick brown fox jumps over the lazy dog.'
+
+    press_ctrl_q
+    status = @driver.cleanup
+    status.exitstatus.must_equal 0
+  end
+
+  after do
+    @driver.cleanup
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+
+require 'phew'
+
+# Gtk must be initialized for all the font retrieval methods to work.
+Gtk.init

data/test/unit/font_repository_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../test_helper.rb', File.dirname(__FILE__))
+
+describe Phew::FontRepository do
+  describe '#get_font' do
+    it 'returns an instance of Phew::Font' do
+      ctx = Gdk.pango_context_get
+      repo = Phew::FontRepository.new ctx
+      font = repo.get_font 'Sans'
+      font.must_be_instance_of Phew::Font
+    end
+
+    it 'returns the same object if called again with the same description' do
+      ctx = Gdk.pango_context_get
+      repo = Phew::FontRepository.new ctx
+      font = repo.get_font 'Sans'
+      font_again = repo.get_font 'Sans'
+      font_again.must_be_same_as font
+    end
+  end
+end

data/test/unit/font_test.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../test_helper.rb', File.dirname(__FILE__))
+
+require 'gir_ffi-pango'
+
+describe Phew::Font do
+  describe '#coverage_summary' do
+    it 'returns summarized coverage information for the given string' do
+      ctx = Gdk.pango_context_get
+
+      pfont = Phew::Font.new ctx, 'Sans'
+
+      test_string = 'This is a test'
+      sum = pfont.coverage_summary test_string
+
+      sum.keys.sort.must_equal [:none, :fallback, :approximate, :exact].sort
+      sum.values.inject(:+).must_equal test_string.size
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: phew
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matijs van Zuijlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gir_ffi-gtk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: gir_ffi-pango
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: List and compare installed fonts on GNOME
+email:
+- matijs@matijs.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- Gemfile
+- README.md
+- Rakefile
+- bin/phew
+- doc/character_map.png
+- doc/fontviewer.gif
+- doc/gfontview.png
+- doc/gnome_specimen.png
+- doc/prior-art.md
+- doc/waterfall.png
+- lib/phew.rb
+- lib/phew/font.rb
+- lib/phew/font_repository.rb
+- lib/phew/script.rb
+- test/end_to_end/basic_run_test.rb
+- test/test_helper.rb
+- test/unit/font_repository_test.rb
+- test/unit/font_test.rb
+homepage: http://www.github.com/mvz/phew-font-viewer
+licenses:
+- GPL-3
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A GNOME Font Viewer
+test_files: []