typingtutor 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5d378a4ed8de85efdbc0276001fe4edd6f8fd3b
-  data.tar.gz: 68642a509f9af1459d1da7881a95c36d4bf6b9d7
+  metadata.gz: bff0c5f22219fd895592101fcbd84132de5d1886
+  data.tar.gz: e3d3fae0c2971d3220866cfddd4d842337a707d7
 SHA512:
-  metadata.gz: d3baab8ffbbcdb1ce77db8346c90a51f32820551f087263828fc4b2b5f647ddc13ee643efc0e98554981141eec21f926de3f9b21786473f7cfc328a0965802b8
-  data.tar.gz: 9a51a1b17155a8bfff441d58a9cf53d8ec85e7943517599295c065ea805bd35509c144719bf6e2b8242bacbbdafdd1099077cef234635d8b167d1187ab14a121
+  metadata.gz: 59e91a49e45ed199c9ac7ed9d1096701ed9ffda2d910462f486b8d23fbe0fdeea92c01c43c456bf7dbf62f5d0e5eb236bdabb1d38e73254f19622a4a7909dec1
+  data.tar.gz: 5b4b6558abd1da914f24035e103de878ef64f8b5c029f93c41035e1e34da07f237ba78b3a75b992df2ff682c21314dc42e2ace95149418dad50626ca38a99e63

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+* 1.0.6: Added 'improve' exercise and overall stats
+* 1.0.5: Added 'training' exercise based on random dictionary words
+* 1.0.4: Added 'biglebowski' exercise
+* 1.0.3: First version with gem executable working properly
+* 1.0.0/1/2: Test publish gem

data/README.md

@@ -20,3 +20,43 @@ $ typingtutor biglebowski
 ```
 
 ![screenshot](https://dl.dropboxusercontent.com/u/28778231/typingtutor/demo.gif)
+
+Generic training, generates 250 random english words
+
+```
+$ typingtutor training 
+```
+
+Improve on letters you struggle the most:
+
+```
+$ typingtutor improve
+```
+
+See overall stats about your typing:
+
+```
+$ typingtutor stats
+ccuracy per letter:
+6: 67%
+7: 75%
+9: 83%
+m: 89%
+b: 91%
+w: 92%
+j: 92%
+y: 92%
+h: 92%
+n: 92%
+...
+
+Exercises:
+- fox: 7 runs, 56 wpm
+- improve: 3 runs, 36 wpm
+
+Exercises played : 10
+Time played: 17m 25s
+Avg speed: 36 wpm
+Max speed: 68 wpm
+
+```

data/lib/typingtutor.rb

@@ -1,6 +1,9 @@
 require "highline"
 require 'io/console'
+require 'yaml'
 require 'typingtutor/version'
+require 'typingtutor/stats'
 require 'typingtutor/dictionary'
 require 'typingtutor/line'
+require 'typingtutor/exercise'
 require 'typingtutor/runner'

data/lib/typingtutor/dictionary.rb

@@ -26,6 +26,7 @@ module Typingtutor
     end
 
     def pick_word_with_letter(letter)
+      return nil if @letters[letter].nil?
       @letters[letter][rand(@letters[letter].size)]
     end
 
@@ -36,7 +37,7 @@ module Typingtutor
     def training_exercise
       lines = []
       line = ""
-      500.times do
+      250.times do
         line << (pick_word+" ")
         if line.size > 70
           lines << line.strip

data/lib/typingtutor/exercise.rb

@@ -0,0 +1,106 @@
+module Typingtutor
+  class Exercise
+    attr_accessor :name, :body, :stats, :start, :time
+    attr_accessor :chars, :correct_chars, :words, :keystrokes, :typing_accuracy, :word_accuracy, :gross_wpm
+
+    # class methods
+
+    def self.load(name:, stats:)
+      return nil if name.nil?
+      body = load_body(name:name, stats:stats)
+      return body.nil? ? nil : Exercise.new(name:name, body:body, stats:stats)
+    end
+
+    def self.load_body(name:, stats:)
+      gem_file_name = File.join(File.dirname(__FILE__), '..', '..', "exercises", "#{name}.txt")
+
+      lines ||= dictionary.training_exercise if name == 'training'
+      lines ||= improve_exercise(stats) if name == 'improve'
+      # load from exercise folder in the gem
+      lines ||= IO.read(name).lines if File.exists?(name)
+      lines ||= IO.read("#{name}.txt").lines if File.exists?("#{name}.txt")
+      lines ||= IO.read(gem_file_name).lines if File.exists?(gem_file_name)
+
+      return if lines.nil?
+
+      lines.each {|line| line.strip!}    # remove extra spaces
+      lines.reject! {|line| line.strip.to_s == ""} # remove empty lines
+      return lines
+    end
+
+    def self.available_exercises
+      files = Dir[File.join(File.dirname(__FILE__), '..', '..', "exercises", "*.txt")]
+      files.map! do |name|
+        name = name.split(File::SEPARATOR).last
+        name = name.gsub /\.txt/, ''
+        name
+      end
+      files
+    end
+
+    def self.improve_exercise(stats)
+      lines = []
+      index = 0
+      stats.worst_letters.to_h.each do |letter, accuracy|
+        next if dictionary.pick_word_with_letter(letter).nil? # no samples to use
+        lines << "You have a #{accuracy}% accuracy on letter #{letter}, let's work on that:"
+        2.times do
+          lines << 8.times.map {|i| dictionary.pick_word_with_letter(letter)}.join(" #{letter * (rand(2)+1)} ").strip
+        end
+        index += 1
+        break if index > 5
+      end
+      lines
+    end
+
+    def self.dictionary
+      @dictionary ||= Dictionary.new
+    end
+
+    # instance methods
+
+    def initialize(name:, body:, stats:)
+      self.name  = name
+      self.body  = body
+      self.stats = stats
+    end
+
+    def play
+      @start = Time.now
+      results = body.map { |line| Line.new(line:line, stats:stats).play unless line == ""}
+      self.time = Time.now - @start
+      self.chars = results.map {|s| s[:chars] }.inject(:+)
+      self.correct_chars = results.map {|s| s[:correct_chars] }.inject(:+)
+      self.words = results.map {|s| s[:words] }.inject(:+)
+      self.keystrokes  = results.map {|s| s[:keystrokes] }.inject(:+)
+      self.typing_accuracy = (correct_chars.to_f / keystrokes.to_f * 100).to_i
+      self.word_accuracy   = (correct_chars.to_f / chars.to_f * 100).to_i # TODO
+      self.gross_wpm = words / (time / 60)
+      stats.record_exercise(self)
+      return results
+    end
+
+    def results
+      {
+        time: time,
+        chars: chars,
+        correct_chars: correct_chars,
+        words: words,
+        keystrokes: keystrokes,
+        typing_accuracy: typing_accuracy,
+        word_accuracy: word_accuracy,
+        gross_wpm: gross_wpm
+      }
+    end
+
+    def print
+      puts
+      puts "------------------------"
+      puts "Time: #{time.round.divmod(60).join('m ')}s (#{words} words)"
+      puts "Speed: #{gross_wpm.round} wpm"
+      # puts "Word accuracy: #{word_accuracy}%"
+      puts "Typing accuracy: #{typing_accuracy}%"
+    end
+
+  end
+end

data/lib/typingtutor/line.rb

@@ -1,10 +1,11 @@
 module Typingtutor
   class Line
-    def initialize(string)
-      @original = string
+    def initialize(line:, stats:)
+      @original = line
       @actual   = ""
       @position = 0
       @keystrokes = 0
+      @stats = stats
     end
 
     def play
@@ -28,7 +29,7 @@ module Typingtutor
           @keystrokes +=1
         end
       end
-      return stats
+      return results
     end
 
     def print_char
@@ -37,6 +38,7 @@ module Typingtutor
       else
         print HighLine.color(expected_char, :plain)
       end
+      @stats.record_letter(expected_char, ok?)
     end
 
     def print_backspace
@@ -47,11 +49,11 @@ module Typingtutor
     def actual_char;   @actual[@position];   end
     def ok?; expected_char == actual_char; end
 
-    def stats
-      { total_chars: @original.length,
+    def results
+      { chars: @original.length,
         correct_chars: @original.length.times.select {|i| @original[i] == @actual[i] }.size,
         keystrokes: @keystrokes,
-        total_words: @actual.split(' ').size
+        words: @actual.split(' ').size
       }
     end
 

data/lib/typingtutor/runner.rb

@@ -3,13 +3,19 @@ module Typingtutor
     include HighLine::SystemExtensions
 
     def run(exercise_name)
-      exercise = load_exercise(exercise_name) unless exercise_name.nil?
+      if exercise_name == 'stats'
+        stats.print_full
+        exit(0)
+      end
+
+      exercise = Exercise.load(name:exercise_name, stats:stats)
       if exercise
         setup_color_scheme
         play_intro
-        @start = Time.now
-        stats = exercise.map { |line| Line.new(line).play }
-        print_stats(stats)
+        exercise.play
+        exercise.print
+        stats.print
+        stats.save
       else
         puts "Typingtutor v#{Typingtutor::VERSION}"
         puts
@@ -17,8 +23,9 @@ module Typingtutor
         puts "$ typingtutor path/to/localfile.txt"
         puts
         puts "built in exercises:"
-        puts "- training (dynamically generated)"
-        exercises.each {|e| puts "- #{e}"}
+        puts "- training (250 random english words)"
+        puts "- improve  (focus on letters you miss the most)"
+        Exercise.available_exercises.each {|e| puts "- #{e}"}
         puts
         puts "eg: typingtutor biglebowski"
       end
@@ -41,54 +48,9 @@ module Typingtutor
       HighLine.color_scheme = cs
     end
 
-    def load_exercise(name)
-      gem_file_name = File.join(File.dirname(__FILE__), '..', '..', "exercises", "#{name}.txt")
-
-      lines ||= dictionary.training_exercise if name == 'training'
-      # load from exercise folder in the gem
-      lines ||= IO.read(name).lines if File.exists?(name)
-      lines ||= IO.read("#{name}.txt").lines if File.exists?("#{name}.txt")
-      lines ||= IO.read(gem_file_name).lines if File.exists?(gem_file_name)
-
-      return if lines.nil?
-
-      lines.each {|line| line.strip!}    # remove extra spaces
-      lines.reject! {|line| line.strip.to_s == ""} # remove empty lines
-      return lines
-    end
-
-    def exercises
-      files = Dir[File.join(File.dirname(__FILE__), '..', '..', "exercises", "*.txt")]
-      files.map! do |name|
-        name = name.split(File::SEPARATOR).last
-        name = name.gsub /\.txt/, ''
-        name
-      end
-      files
-    end
-
-    def dictionary
-      @dictionary ||= Dictionary.new
+    def stats
+      @stats ||= Stats.new
     end
 
-    def print_stats(stats)
-      time = Time.now - @start
-      total_chars   = stats.map {|s| s[:total_chars] }.inject(:+)
-      correct_chars = stats.map {|s| s[:correct_chars] }.inject(:+)
-      total_words   = stats.map {|s| s[:total_words] }.inject(:+)
-      keystrokes    = stats.map {|s| s[:keystrokes] }.inject(:+)
-
-      typing_accuracy = (correct_chars.to_f / keystrokes.to_f * 100).to_i
-      word_accuracy   = (correct_chars.to_f / total_chars.to_f * 100).to_i # TODO
-
-      gross_wpm = total_words / (time / 60)
-
-      puts
-      puts "------------------------"
-      puts "Time: #{time.round(1)}s (#{total_words} words)"
-      puts "Speed: #{gross_wpm.round} wpm"
-      puts "Word accuracy: #{word_accuracy}%"
-      puts "Typing accuracy: #{typing_accuracy}%"
-    end
   end # Runner
 end # Typingtutor

data/lib/typingtutor/stats.rb

@@ -0,0 +1,88 @@
+module Typingtutor
+  class Stats
+    FILE = File.expand_path('~/.typingtutor')
+
+    def initialize
+      @stats = {}
+      @stats.merge!(YAML.load(IO.read(FILE))) if File.exists?(FILE)
+      @stats[:created_at] ||= Time.now
+      @stats[:total] ||= {}
+      @stats[:exercises]  ||= {}
+      @stats[:words] ||= {}
+      @stats[:letters] ||= {}
+    end
+
+    def save
+      @stats[:updated_at] = Time.now
+      IO.write(FILE, YAML.dump(@stats))
+    end
+
+    def record_exercise(exercise)
+      @stats[:exercises][exercise.name] ||= {}
+      @stats[:exercises][exercise.name][:runs] ||= 0
+      @stats[:exercises][exercise.name][:runs] += 1
+      @stats[:exercises][exercise.name][:last_run] = Time.now
+      @stats[:exercises][exercise.name][:last_run_results] = exercise.results
+
+      # update totals
+      @stats[:total][:runs] ||= 0
+      @stats[:total][:runs] += 1
+
+      [:time, :chars, :correct_chars, :words, :keystrokes].each do |metric|
+        @stats[:total][metric] ||= 0
+        @stats[:total][metric] += exercise.results[metric]
+      end
+
+      @stats[:total][:max_wpm] ||= 0
+      @stats[:total][:max_wpm] = [@stats[:total][:max_wpm], exercise.results[:gross_wpm]].max
+      @stats[:total][:avg_wpm] = @stats[:total][:words] / (@stats[:total][:time] / 60)
+    end
+
+    def record_word(word)
+      # TODO
+    end
+
+    def record_letter(letter, ok)
+      return if letter == ' '
+      @stats[:letters][letter] ||= {}
+      @stats[:letters][letter][:total] ||= {}
+      @stats[:letters][letter][:total][:count] ||= 0
+      @stats[:letters][letter][:total][:count] += 1
+      @stats[:letters][letter][:total][:correct] ||= 0
+      @stats[:letters][letter][:total][:correct] += 1 if ok
+      @stats[:letters][letter][:total][:accuracy] = (@stats[:letters][letter][:total][:correct].to_f / @stats[:letters][letter][:total][:count].to_f * 100).round
+    end
+
+    def print
+      puts "------------------------"
+      puts "Your avg speed: #{@stats[:total][:avg_wpm].round} wpm"
+      puts "Your max speed: #{@stats[:total][:max_wpm].round} wpm"
+    end
+
+    def print_full
+      puts "Accuracy per letter:"
+      worst_letters.each {|letter, accuracy| puts "#{letter}: #{accuracy.round}%"}
+
+      if @stats[:exercises].size > 0
+        puts
+        puts "Exercises:"
+        @stats[:exercises].each do |name, data|
+          puts "- #{name}: #{data[:runs]} runs, #{data[:last_run_results][:gross_wpm].round} wpm"
+        end
+      end
+      puts
+      puts "Exercises played: #{@stats[:total][:runs] || 0}"
+      puts "Time played: #{(@stats[:total][:time] || 0).round.divmod(60).join('m ')}s"
+      puts "Avg speed: #{(@stats[:total][:avg_wpm] || 0).round} wpm"
+      puts "Max speed: #{(@stats[:total][:max_wpm] || 0).round} wpm"
+    end
+
+    def worst_letters
+      accuracy = @stats[:letters].map {|letter, data| [letter, data[:total][:accuracy]]}.to_h # { "a" => 100, "b" => 98 }
+      accuracy.reject! {|key, value| value == 100}
+      accuracy.reject! {|key, value| key !~ /\w/ }
+      accuracy = accuracy.sort_by {|key, value| value }.to_h
+      accuracy
+    end
+  end
+end

data/lib/typingtutor/version.rb

@@ -1,3 +1,3 @@
 module Typingtutor
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typingtutor
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Paolo Dona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -48,6 +48,7 @@ extra_rdoc_files: []
 files:
 - ".DS_Store"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -210,8 +211,10 @@ files:
 - exercises/starwars.txt
 - lib/typingtutor.rb
 - lib/typingtutor/dictionary.rb
+- lib/typingtutor/exercise.rb
 - lib/typingtutor/line.rb
 - lib/typingtutor/runner.rb
+- lib/typingtutor/stats.rb
 - lib/typingtutor/version.rb
 - typingtutor.gemspec
 homepage: https://github.com/paolodona/typingtutor