keyboard_battle 0.0.2 → 0.0.3

data/lib/keyboard_battle/command_dispatcher.rb

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

data/lib/keyboard_battle/exercise.rb

@@ -1,64 +1,66 @@
-class KeyboardBattle::Exercise
+module KeyboardBattle
+  class Exercise
 
-  attr_accessor :results, :filename
+    attr_accessor :results, :filename
 
-  def initialize(filename, keyboards)
-    @filename  = filename
-    @keyboards = keyboards
-    @results   = run
-  end
+    def initialize(filename, keyboards)
+      @filename  = filename
+      @keyboards = keyboards
+      @results   = run
+    end
 
-  private
+    private
 
-  attr_accessor :keyboards
+    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)
+    # 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 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)]
+                # measure reach efficiency
+                reach_effort += EFFORT[keyboard.combined.find_index(char)]
+              end
             end
           end
         end
-      end
 
-      results[keyboard.name.to_sym] = {
-        :alternation_effort => alternation_effort,
-        :reach_effort => reach_effort,
-        :raw_score => (alternation_effort + reach_effort)
-      }
+        results[keyboard.name.to_sym] = {
+          :alternation_effort => alternation_effort,
+          :reach_effort => reach_effort,
+          :raw_score => (alternation_effort + reach_effort)
+        }
+      end
+      results
     end
-    results
-  end
 
-  def open_and_process(*args)
-    f = File.open(*args)
-    yield f
-    f.close()
-  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 }
+    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

data/lib/keyboard_battle/keyboard.rb

@@ -1,58 +1,60 @@
-class KeyboardBattle::Keyboard
+module KeyboardBattle
+  class Keyboard
 
-  class Qwerty < self
-    def name
-      "qwerty"
-    end
+    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 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 < > ?)
+      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
-  end
 
-  class Dvorak < self
-    def name
-      "dvorak"
-    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 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)
+      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
-  end
 
-  class Colemak < self
-    def name
-      "colemak"
-    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 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 < > ?)
+      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
-  end
 
-  attr_accessor :left, :right, :name
+    attr_accessor :left, :right, :name
 
-  def combined
-    left + right
-  end
+    def combined
+      left + right
+    end
 
-  def self.all
-    [ 
-      KeyboardBattle::Keyboard::Qwerty.new,
-      KeyboardBattle::Keyboard::Dvorak.new,
-      KeyboardBattle::Keyboard::Colemak.new
-    ]
+    def self.all
+      [ 
+        KeyboardBattle::Keyboard::Qwerty.new,
+        KeyboardBattle::Keyboard::Dvorak.new,
+        KeyboardBattle::Keyboard::Colemak.new
+      ]
+    end
   end
 end

data/lib/keyboard_battle/report.rb

@@ -1,20 +1,22 @@
-class KeyboardBattle::Report
+module KeyboardBattle
+  class Report
 
-  def initialize(filename, results)
-    @filename = filename
-    @results = results
-  end
+    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"
+    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
-    out << "\n"
-  end
 
+  end
 end

data/lib/keyboard_battle/version.rb

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

data/lib/keyboard_battle.rb

@@ -2,3 +2,6 @@ require "keyboard_battle/command_dispatcher"
 require "keyboard_battle/exercise"
 require "keyboard_battle/keyboard"
 require "keyboard_battle/report"
+
+module KeyboardBattle
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keyboard_battle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: