keyboard_battle 0.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    keyboard_battle (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  keyboard_battle!
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Cullen-Kerney
+
+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,29 @@
+# KeyboardBattle
+
+KeyboardBattle is a simple program that compares the performance of keyboard layouts according to two metrics, reach effort (travel from the home row being increasingly effortful) and alternation effort (typing consecutive keys with a single hand being more effortful). For both, a lower value means less effort.
+
+The program comes with the QWERTY, Dvorak, and Colemak layouts. The format for a keyboard layout description file can be discerned from `lib/keyboards/*.txt`.
+
+## Installation
+
+    $ gem install keyboard_battle
+
+## Usage
+
+E.g., `keyboard_battle my_text.txt`, or try `keyboard_battle --bundled`
+
+## Limitations and shortcomings
+
+Only ASCII characters will be counted (though any character may appear in the source text).
+
+## Bundled texts
+
+Except for "the quick brown fox," bundled texts are sourced from archive.org.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/keyboard_battle

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'keyboard_battle'
+
+KeyboardBattle::CommandDispatcher.new(ARGF.argv)

data/keyboard_battle.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/keyboard_battle/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Cullen-Kerney"]
+  gem.email         = ["ben@beancuke.com"]
+  gem.description   = %q{Keyboard Battle compares the performance of keyboard layouts according to reach effort and alternation effort.}
+  gem.summary       =<<SUMMARY
+KeyboardBattle is a simple program that compares the performance of keyboard layouts according to two metrics, reach effort (travel from the home row being increasingly effortful) and alternation effort (typing consecutive keys with a single hand being more effortful). For both, a lower value means less effort.
+  
+  The program comes with the QWERTY, Dvorak, and Colemak layouts. The format for a keyboard layout description file can be discerned from lib/keyboards/*.txt.
+SUMMARY
+  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.name          = "keyboard_battle"
+  gem.require_paths = ["lib"]
+  gem.version       = KeyboardBattle::VERSION
+
+  gem.add_development_dependency "rspec"
+end

data/lib/keyboard_battle/command_dispatcher.rb

@@ -0,0 +1,45 @@
+class KeyboardBattle::CommandDispatcher
+
+  def initialize(args)
+    if opt = args.first
+      case opt
+      when '--bundled'
+        self.run(Dir.glob('texts/*.txt'))
+      else
+        self.run(args)
+      end
+    else
+      help
+    end
+  end
+
+  def run(filenames)
+    filenames.each do |filename|
+      exercise = KeyboardBattle::Exercise.new(filename, keyboards)
+      print report(exercise)
+    end
+  end
+
+  def help
+    print <<HELP
+
+What text(s) would you like to battle upon?
+You can specify file(s) to exercise, e.g.:
+
+    $ keyboard_battle mytext1.txt mytext2.txt
+
+Or, use --bundled to try it out with a few bundled texts:
+
+    $ keyboard_battle --bundled
+
+HELP
+  end
+
+  def report(exercise)
+    KeyboardBattle::Report.new(exercise.filename, exercise.results).to_s
+  end
+
+  def keyboards
+    KeyboardBattle::Keyboard.all
+  end
+end

data/lib/keyboard_battle/exercise.rb

@@ -0,0 +1,64 @@
+class KeyboardBattle::Exercise
+
+  attr_accessor :results, :filename
+
+  def initialize(filename, keyboards)
+    @filename  = filename
+    @keyboards = keyboards
+    @results   = run
+  end
+
+  private
+
+  attr_accessor :keyboards
+
+  # tests a passage of text for reach effort expended (zero for home row, 
+  # increasing for reach), and hand alternation effort. In both values,
+  # lower is better.
+  def run
+    results = { }
+    keyboards.each do |keyboard|
+      # set up container vars
+      prev_hand = nil
+      alternation_effort = 0
+      reach_effort = 0
+      open_and_process(filename,'r') do |file|
+        while line = file.gets
+          line.each_char do |char|
+            if keyboard.combined.include?(char)
+
+              # measure alternation efficiency
+              hand = keyboard.left.include?(char) ? 'l' : 'r'
+              if prev_hand
+                alternation_effort += (hand == prev_hand) ? 1 : 0
+              end
+              prev_hand = hand
+
+              # measure reach efficiency
+              reach_effort += EFFORT[keyboard.combined.find_index(char)]
+            end
+          end
+        end
+      end
+
+      results[keyboard.name.to_sym] = {
+        :alternation_effort => alternation_effort,
+        :reach_effort => reach_effort,
+        :raw_score => (alternation_effort + reach_effort)
+      }
+    end
+    results
+  end
+
+  def open_and_process(*args)
+    f = File.open(*args)
+    yield f
+    f.close()
+  end
+
+  EFFORT = ( # left hand + right hand effort values
+    %w(3 2 2 2 2 2 2 1 1 1 1 1 0 0 0 0 1 1 1 1 1 2 3 2 2 2 2 2 2 1 1 1 1 1 0 0 0 0 1 1 1 1 1 2) +
+    %w(2 2 2 2 2 2 1 1 1 1 1 1 2 3 1 0 0 0 0 1 1 1 1 1 1 2 2 2 2 2 2 1 1 1 1 1 1 2 3 1 0 0 0 0 1 1 1 1 1 1)
+  ).collect { |el| el.to_i }
+
+end

data/lib/keyboard_battle/keyboard.rb

@@ -0,0 +1,58 @@
+class KeyboardBattle::Keyboard
+
+  class Qwerty < self
+    def name
+      "qwerty"
+    end
+
+    def left
+      %w(` 1 2 3 4 5 6 q w e r t a s  d f g z x c v b ~ ! @ # $ % ^ Q W E R T A S D F G Z X C V B)
+    end
+
+    def right
+      %w(7 8 9 0 - = y u i o p [ ] \\ h j k l ; ' n m , . / & * ( ) _ + Y U I O P { } | H J K L : " N M < > ?)
+    end
+  end
+
+  class Dvorak < self
+    def name
+      "dvorak"
+    end
+
+    def left
+      %w(` 1 2 3 4 5 6 ' , . p y a o  e u i ; q j k x ~ ! @ # $ % ^ " < > P Y A O E U I : Q J K X)
+    end
+
+    def right
+      %w(7 8 9 0 [ ] f g c r l / = \\ d h t n s - b m w v z & * ( ) { } F G C R L ? + | D H T N S _ B M W V Z)
+    end
+  end
+
+  class Colemak < self
+    def name
+      "colemak"
+    end
+
+    def left
+      %w(` 1 2 3 4 5 6 q w f p g a r  s t d z x c v b ~ ! @ # $ % ^ Q W F P G A R S T D Z X C V B)
+    end
+
+    def right
+      %w(7 8 9 0 - = j l u y : [ ] \\ h n e i o ' k m , . / & * ( ) _ + J L U Y ; { } | H N E I O " K M < > ?)
+    end
+  end
+
+  attr_accessor :left, :right, :name
+
+  def combined
+    left + right
+  end
+
+  def self.all
+    [ 
+      KeyboardBattle::Keyboard::Qwerty.new,
+      KeyboardBattle::Keyboard::Dvorak.new,
+      KeyboardBattle::Keyboard::Colemak.new
+    ]
+  end
+end

data/lib/keyboard_battle/report.rb

@@ -0,0 +1,20 @@
+class KeyboardBattle::Report
+
+  def initialize(filename, results)
+    @filename = filename
+    @results = results
+  end
+
+  def to_s
+    out = "\n"
+    out << "#{@filename}:\n"
+    @results.each do |keyboard, performance|
+      out << "  #{keyboard}:\n"
+      performance.each do |metric, result|
+        out << "    #{metric}: #{result}\n"
+      end
+    end
+    out << "\n"
+  end
+
+end

data/lib/keyboard_battle/version.rb

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

data/lib/keyboard_battle.rb

@@ -0,0 +1,4 @@
+require "keyboard_battle/command_dispatcher"
+require "keyboard_battle/exercise"
+require "keyboard_battle/keyboard"
+require "keyboard_battle/report"

data/spec/keyboard_battle/command_dispatcher_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe KeyboardBattle::CommandDispatcher do
+
+  describe 'an instance with file args' do
+    it 'runs the specified files' do
+      KeyboardBattle::CommandDispatcher.any_instance.should_receive(:run).with(["texts/qbf.txt"])
+      KeyboardBattle::CommandDispatcher.new(["texts/qbf.txt"])
+    end
+  end
+
+  describe 'an instance with --bundled' do
+    it 'runs all bundled files' do
+      KeyboardBattle::CommandDispatcher.any_instance.should_receive(:run).with(Dir.glob("texts/*.txt"))
+      KeyboardBattle::CommandDispatcher.new(["--bundled"])
+    end
+  end
+
+  describe 'an instance without args' do
+    it 'prints the help' do
+      KeyboardBattle::CommandDispatcher.any_instance.should_receive(:help)
+      KeyboardBattle::CommandDispatcher.new([])
+    end
+  end
+end

data/spec/keyboard_battle/exercise_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe KeyboardBattle::Exercise do
+  
+  describe 'an instance' do
+    let(:exercise) { KeyboardBattle::Exercise.new('texts/qbf.txt', KeyboardBattle::Keyboard.all) }
+
+    it "loads the keyboards" do
+      expect(exercise.send(:keyboards).map {|k| k.name}).to eq(%w(qwerty dvorak colemak))
+    end
+
+    describe "when processing texts" do
+      describe "with qwerty" do
+        it "calculates reach effort" do
+          expect(exercise.results[:qwerty][:reach_effort]).to eq(30)
+        end
+
+        it "calculates alternation effort" do
+          expect(exercise.results[:qwerty][:alternation_effort]).to eq(11)
+        end
+
+        it "calculates raw score" do
+          expect(exercise.results[:qwerty][:raw_score]).to eq(41)
+        end
+      end
+
+      describe "with dvorak" do
+        it "calculates reach effort" do
+          expect(exercise.results[:dvorak][:reach_effort]).to eq(21)
+        end
+
+        it "calculates alternation effort" do
+          expect(exercise.results[:dvorak][:alternation_effort]).to eq(13)
+        end
+
+        it "calculates raw score" do
+          expect(exercise.results[:dvorak][:raw_score]).to eq(34)
+        end
+      end
+
+      describe "with colemak" do
+        it "calculates reach effort" do
+          expect(exercise.results[:colemak][:reach_effort]).to eq(22)
+        end
+
+        it "calculates alternation effort" do
+          expect(exercise.results[:colemak][:alternation_effort]).to eq(9)
+        end
+
+        it "calculates raw score" do
+          expect(exercise.results[:colemak][:raw_score]).to eq(31)
+        end
+      end
+    end
+  end
+end

data/spec/keyboard_battle/keyboard_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe KeyboardBattle::Keyboard do
+
+  # Keyboards are fully exercised by Exercise
+  # See spec/keyboard_battle/exercise_spec.rb
+
+end

data/spec/keyboard_battle/report_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe KeyboardBattle::Report do
+
+  describe 'an instance' do
+    let(:battle) { 
+      KeyboardBattle::Report.new('foo.txt', { dvorak: { a: 1, b: 2, c: 3 }}) 
+    }
+
+    it "should have an informative to_s" do
+      [
+        /foo(.*)dvorak(.*)a(.*)1/m,
+        /foo(.*)dvorak(.*)b(.*)2/m,
+        /foo(.*)dvorak(.*)c(.*)3/m,
+      ].each { |m|
+        battle.to_s.should match(m)
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'keyboard_battle'