v0.0.5 Major (15-20x) performance improvements

Looking at performance for the first time since hacking out these
scripts, found major improvements in reach effort.

Author: bak

CHANGES

@@ -0,0 +1,15 @@
+# Changes
+
+## v0.0.5
+
+* Ridiculous (15-20x) speed improvements.
+* Fixed "--bundled" option
+
+## v0.0.2 - 0.0.4
+
+* Gemified
+* minor changes and improvements
+
+## v0.0.1
+
+* Just a hacked-out bundle of scripts.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keyboard_battle (0.0.1)
+    keyboard_battle (0.0.5)
 
 GEM
   remote: https://rubygems.org/

keyboard_battle-0.0.5.gem

@@ -2,10 +2,11 @@ module KeyboardBattle
   class CommandDispatcher
 
     def initialize(args)
+
       if opt = args.first
         case opt
         when '--bundled'
-          self.run(Dir.glob('texts/*.txt'))
+          self.run(Dir.glob("#{File.expand_path('../../..', __FILE__)}/texts/*.txt"))
         else
           self.run(args)
         end

lib/keyboard_battle/command_dispatcher.rb

@@ -1,18 +1,16 @@
 module KeyboardBattle
   class Exercise
 
-    attr_accessor :results, :filename
+    attr_accessor :results, :filename, :keyboards
 
-    def initialize(filename, keyboards)
-      @filename  = filename
-      @keyboards = keyboards
+    def initialize(f, k)
+      @filename  = f
+      @keyboards = k
       @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.
@@ -26,23 +24,24 @@ def run
         open_and_process(filename,'r') do |file|
           while line = file.gets
             line.each_char do |char|
-              if keyboard.combined.include?(char)
+              if effort = keyboard::MAP[char]
 
                 # measure alternation efficiency
-                hand = keyboard.left.include?(char) ? 'l' : 'r'
+                hand = keyboard::LEFT_KEYS.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)]
+                reach_effort += effort
               end
+
             end
           end
         end
 
-        results[keyboard.name.to_sym] = {
+        results[keyboard::NAME.to_sym] = {
           :alternation_effort => alternation_effort,
           :reach_effort => reach_effort,
           :raw_score => (alternation_effort + reach_effort)
@@ -57,10 +56,5 @@ def open_and_process(*args)
       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
 end

lib/keyboard_battle/exercise.rb

@@ -1,60 +1,45 @@
 module KeyboardBattle
   class Keyboard
 
-    class Qwerty < self
-      def name
-        "qwerty"
-      end
+    class << self
 
-      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)
+      def all
+        [ 
+          KeyboardBattle::Keyboard::Qwerty,
+          KeyboardBattle::Keyboard::Dvorak,
+          KeyboardBattle::Keyboard::Colemak
+        ]
       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
+    LEFT_EFFORT = %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).collect { |el| el.to_i }
+    RIGHT_EFFORT = %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 }
+    COMBINED_EFFORT = LEFT_EFFORT + RIGHT_EFFORT
 
-      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
+    class Qwerty < Keyboard
+      NAME = "qwerty"
+      LEFT_KEYS = %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)
+      RIGHT_KEYS = %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 < > ?)
+      COMBINED_KEYS = LEFT_KEYS + RIGHT_KEYS
+      MAP = Hash[COMBINED_KEYS.zip(Keyboard::COMBINED_EFFORT)]
     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
+    class Dvorak < Keyboard
+      NAME = "dvorak"
+      LEFT_KEYS = %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)
+      RIGHT_KEYS = %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)
+      COMBINED_KEYS = LEFT_KEYS + RIGHT_KEYS
+      MAP = Hash[COMBINED_KEYS.zip(Keyboard::COMBINED_EFFORT)]
     end
 
-    attr_accessor :left, :right, :name
-
-    def combined
-      left + right
+    class Colemak < Keyboard
+      NAME = "colemak"
+      LEFT_KEYS = %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)
+      RIGHT_KEYS = %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 < > ?)
+      COMBINED_KEYS = LEFT_KEYS + RIGHT_KEYS
+      MAP = Hash[COMBINED_KEYS.zip(Keyboard::COMBINED_EFFORT)]
     end
 
-    def self.all
-      [ 
-        KeyboardBattle::Keyboard::Qwerty.new,
-        KeyboardBattle::Keyboard::Dvorak.new,
-        KeyboardBattle::Keyboard::Colemak.new
-      ]
-    end
   end
 end

lib/keyboard_battle/keyboard.rb

@@ -1,3 +1,3 @@
 module KeyboardBattle
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

lib/keyboard_battle/version.rb

@@ -6,7 +6,7 @@
     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))
+      expect(exercise.send(:keyboards).map {|k| k::NAME}).to eq(%w(qwerty dvorak colemak))
     end
 
     describe "when processing texts" do