typingtutor 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 172e5e72904ce07bf6295b7491915a254519987e
+  data.tar.gz: 3753eb0249be11a5daae7cdf66133f4306a14552
+SHA512:
+  metadata.gz: 6de199dba40c1dc4a9e165428564a7a4ab65681bd1b7c4f9d9a39761c9cb0a2072ac6d58f64fbca58b5539976d74efc5424483323eb6b1a9b2f23a7ed13150b2
+  data.tar.gz: 78d4829b31028c505bd303f3ffa2c4bbc8487c26066ad6e06e4f8fa7d26b63e5f4946eb554929d0a725620ceb073ea3799b9fb2c3564061b75f2fedff1b85a74

data/bin/typingtutor

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'typingtutor'
+Typingtutor::Runner.new.run(ARGV[0])

data/lib/typingtutor/line.rb

@@ -0,0 +1,57 @@
+module Typingtutor
+  class Line
+    def initialize(string)
+      @original = string
+      @actual   = ""
+      @position = 0
+      @keystrokes = 0
+    end
+
+    def play
+      print "\n#{@original.ljust(80)}\r"
+
+      while(true) do
+        char = STDIN.getch
+        case char.ord
+        when 3 then exit(1) # CTRL-C
+        when 13 then break # enter
+        when 127 # backspace
+          @actual.chop!
+          @position = [@position - 1, 0].max
+          print_backspace
+        else
+          @actual += char
+          print_char
+          @position += 1
+          @keystrokes +=1
+        end
+      end
+      return stats
+    end
+
+    def print_char
+      if actual_char
+        print HighLine.color(actual_char, ok? ? :correct : :error)
+      else
+        print HighLine.color(expected_char, :plain)
+      end
+    end
+
+    def print_backspace
+      print "\b#{HighLine.color(expected_char, :plain)}\b"
+    end
+
+    def expected_char; @original[@position]; end
+    def actual_char;   @actual[@position];   end
+    def ok?; expected_char == actual_char; end
+
+    def stats
+      { total_chars: @original.length,
+        correct_chars: @original.length.times.select {|i| @original[i] == @actual[i] }.size,
+        keystrokes: @keystrokes,
+        total_words: @original.split(' ').size
+      }
+    end
+
+  end # Line
+end # Typingtutor

data/lib/typingtutor/runner.rb

@@ -0,0 +1,76 @@
+module Typingtutor
+  class Runner
+    include HighLine::SystemExtensions
+
+    def run(exercise_name)
+      exercise = exercises[exercise_name]
+      if exercise
+        setup_color_scheme
+        play_intro
+        @start = Time.now
+        stats = exercise.map { |line| Line.new(line).play }
+        print_stats(stats)
+      else
+        puts "usage: typingtutor <exercise>"
+        puts "available:"
+        exercises.keys.each {|e| puts "- #{e}"}
+      end
+    end
+
+    protected
+
+    def play_intro
+      puts "Typingtutor: Touch Typing Training"; sleep 0.5;
+      3.downto(1) {|n| print "#{n}"; sleep 0.5; print '.'; sleep 0.5}
+      print "GO!\n"
+    end
+
+    def setup_color_scheme
+      cs = HighLine::ColorScheme.new do |cs|
+         cs[:plain]   = [:white]
+         cs[:correct] = [:green]
+         cs[:error]   = [:red, :bold]
+      end
+      HighLine.color_scheme = cs
+    end
+
+    def exercises
+      {
+        "lorem" => [
+          'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', 'Nam nulla lacus, pharetra nec sollicitudin nec, faucibus non est. Nunc a erat in ante aliquet dapibus.',
+          'Quisque congue libero vel mattis sodales.', 'Sed pellentesque, nunc nec gravida molestie, tellus mauris semper tellus, ac suscipit nisl est sit amet augue.',
+          'Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.', 'Sed vehicula risus risus, a lobortis velit ultricies ut. Nullam porttitor leo eu leo congue, id porta elit vestibulum.',
+          'Suspendisse facilisis ut diam nec molestie. Donec consequat elementum volutpat.' ],
+        "test" => [
+          'paolo is a nice guy', 'but he cannot type fast', 'that is a shame.'
+        ],
+        "fox" => ["The quick brown fox jumps over the lazy dog"],
+        "haikurb" => [
+          '"eyes".scan /the_darkness/',
+          'catch( :in_the_wind ) { ?a.round; "breath"',
+          'or "a".slice /of_moon/ }'
+        ]
+      }
+    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.rb

@@ -0,0 +1,4 @@
+require "highline"
+require 'io/console'
+require 'typingtutor/line'
+require 'typingtutor/runner'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: typingtutor
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Paolo Dona
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+description: 
+email: paolo.dona@gmail.com
+executables:
+- typingtutor
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/typingtutor
+- lib/typingtutor.rb
+- lib/typingtutor/line.rb
+- lib/typingtutor/runner.rb
+homepage: https://github.com/paolodona/typingtutor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Command line typing tutor
+test_files: []