teletype 0.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f113b33716079b6147b8511771b0112ec42044981ba543abaca849211563be1
-  data.tar.gz: 85ded73b628942847ef1f6553288afe6eff1cfc02b0ee152bbb2ac4bb3ba790a
+  metadata.gz: 40a3e0c38deacc68555c1440a9fe679afc623e93decc137836a3066aa6710521
+  data.tar.gz: 640e87ce91e95e40b37e5f768e70ae0e355f68f810c51b1862e2fcdf6dd1ddd5
 SHA512:
-  metadata.gz: be9dad8e1a5edf3d2885b1c19527609d64684abdcdd3fdb4cbfde71641e9a0526282c8ce1b5e01c92b28506e38f41e60914c09138675c6bf52e7e17a84582ec2
-  data.tar.gz: 221045d24b990dd28cf91b9fc51880e8d99c06c13bd38dbea18db922b28ec54517d02ded848f7d934455e34ab3f63b1a6d0b7cdc3b1410a4a14de3fe40848fc5
+  metadata.gz: 0b885502503555e6d5874eeb897928d37db231e72d6467438ebbeba43d810b3a0e8ad7415c98eb7330017e38fe48465732a495f96ad1f2e3ca521e8184117453
+  data.tar.gz: 5146ce812b50f336daa87cbaa256c1227c49481e32921e9235cc026bc7238dd8e7712cb8ddd5d869b0db64b2cef233d6291cddc9b51d1178926e4d995d7a213e

data/README.md

@@ -12,7 +12,15 @@
 ### Usage
 
 Practice numeric keys:
-`teletype number`
+`teletype base/number.txt`
+
+Practice basic keys(numeric and letters):
+`teletype base`
 
 Practice with ruby code:
 `teletype ruby`
+
+### Custom text
+
+You can copy text files to **exercise/custom** directory and practice with:
+`teletype custom` or `teletype custom/poem.txt`

data/Rakefile

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
 end
 
-desc "Run tests"
-task :default => :test
-
+desc 'Run tests'
+task default: :test
 
-desc "Testing usage for fast iteration"
+desc 'Testing usage for fast iteration'
 task :usage do
   puts 'gem uninstall teletype -x'
   puts `gem uninstall teletype -x`

data/bin/teletype

@@ -1,3 +1,83 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-puts "Please use version above 0.0.0"
+require 'optparse'
+require_relative '../lib/teletype'
+
+exercises = File.join(File.dirname(__FILE__), '../', 'exercise')
+
+profile = nil
+height = 5
+width = 120
+suggest = 3
+verbose = false
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: teletype [options] [exercise]'
+
+  opts.on('--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+
+  opts.on('-l', '--list', 'List exercise files') do |_v|
+    Dir.glob(File.join(exercises, '**', '*.*')).each do |path|
+      puts path.sub(File.join(exercises, ''), '')
+    end
+    exit
+  end
+
+  opts.on('-p', '--profile [DIR]', 'Specify profile dir. Defaults to ~/.teletype') do |f|
+    profile = f
+  end
+
+  opts.on('-s', '--suggest [LINES]', Integer,
+          "Suggested practice lines that needs attention. Defaults to #{suggest}") do |s|
+    suggest = s
+  end
+
+  opts.on('-h', '--height [HEIGHT]', Integer, "Height of practice window. Defaults to #{height}") do |h|
+    height = h
+  end
+  opts.on('-w', '--width [WIDTH]', Integer, "Width of practice window. Defaults to #{width}") do |w|
+    width = w
+  end
+  opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+    verbose = v
+  end
+end.parse!
+
+profile ||= File.join(Dir.home, '.teletype')
+Dir.mkdir(profile) unless File.exist?(profile)
+
+paths = ARGV
+paths << 'base' if paths.length.zero?
+
+text = ''
+paths.each do |path|
+  path = File.join(exercises, path)
+
+  if File.directory?(path)
+    Dir.glob(File.join(path, '*.*')).each do |file|
+      text += File.read(file)
+    end
+  elsif File.exist?(path)
+    text += File.read(path)
+  end
+end
+
+screen = Teletype::Screen.new(height, width, verbose: verbose)
+stats = Teletype::Stats.new(profile, text)
+paginator = Teletype::Paginator.new(
+  profile, text,
+  suggest: suggest,
+  screen: screen,
+  stats: stats
+)
+
+at_exit do
+  stats.save
+  paginator.save
+end
+
+paginator.run

data/lib/teletype/key.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'io/wait'
+require 'io/console'
+
+module Teletype
+  # Key implements console reading for multibyte inputs and translates to unicode
+  # characters. The unicode characters will be useful when displaying the inputs back
+  # to console.
+  class Key
+    DICTIONARY = {
+      "\e" => '␛',
+      "\e[1;5A" => '↥', # ctrl-up
+      "\e[1;5B" => '↧', # ctrl-down
+      "\e[1;5C" => '↦', # ctrl-right
+      "\e[1;5D" => '↤', # ctrl-left
+
+      "\e[1~" => '⌂', # home
+      "\e[2~" => '⎀', # insert
+      "\e[3~" => '⌦', # delete
+      "\e[3;2~" => '↱', # shift+delete
+      "\e[3;5~" => '↪', # ctrl+delete
+      "\e[4~" => '↘', # end
+      "\e[5~" => '⇞', # page up
+      "\e[6~" => '⇟', # page down
+      "\e[7~" => '⌂', # home
+      "\e[8~" => '↘', # end
+
+      "\e[A" => '↑',
+      "\e[B" => '↓',
+      "\e[C" => '→',
+      "\e[D" => '←',
+      "\e[E" => '⇲', # clear
+      "\e[H" => '⌂', # home
+      "\e[F" => '↘', # end
+      "\e[Z" => '⇤', # backtab(shift + tab)
+
+      "\u0003" => '⏻',
+      "\u007F" => '⌫', # backspace
+      "\r" => "\n",
+      "\t" => '⇥'
+    }.freeze
+
+    def self.read
+      blocking = true
+      chars = []
+      $stdin.raw do
+        $stdin.noecho do
+          loop do
+            if blocking
+              chars << $stdin.getc
+              blocking = false
+            elsif $stdin.ready?
+              chars << $stdin.getc
+            else
+              key = chars.join
+              return DICTIONARY[key] || key
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/teletype/page.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Prints lines of text to screen and handles key strokes.
+  class Page
+    def initialize(lines, screen, stats)
+      @lines = lines.map { |line| line.gsub("\t", '⇥') }
+      @screen = screen
+      @stats = stats
+      @y = -1
+    end
+
+    def fetch
+      loop do
+        @line = @lines.shift
+        @y += 1
+        break if @line.nil? || @line.strip.length.positive?
+      end
+
+      # skip white spaces at the beginning of a line
+      @x = @line&.match(/[[:graph:]]/)&.pre_match&.length || 0
+    end
+
+    def run
+      @screen.fill(@lines.map { |line| default(line) })
+
+      fetch
+      to(@x, @y)
+
+      loop do
+        break if @lines.empty? && @line.nil?
+
+        char = Key.read
+
+        case char
+        when '⏻'
+          exit
+        when '⌫'
+          erase
+        else
+          advance(char)
+        end
+
+        @screen.log(@stats.rankings)
+      end
+    end
+
+    def advance(char)
+      at = @line[@x]
+      if char == at
+        @stats.hit!(at)
+        print(correct(char))
+      else
+        @stats.miss!(at)
+        print(wrong(visible(char)))
+      end
+      @x += 1
+      fetch if @x == @line.length
+      to(@x, @y)
+    end
+
+    def erase
+      return unless @x.positive?
+
+      @x -= 1
+      to(@x, @y)
+      print default(@line[@x])
+      to(@x, @y)
+    end
+
+    def to(x, y)
+      @screen.to(x, y)
+    end
+
+    def visible(char)
+      case char
+      when ' ' then '␣'
+      when "\n" then '↵'
+      when ("\u0001".."\u001A") then '⌃' # Ctrl[a-z]
+      when /^\e/ then '�'
+      else; char
+      end
+    end
+
+    def default(str)
+      "\e[94m#{str}\e[0m"
+    end
+
+    def correct(str)
+      "\e[2;32m#{str}\e[0m"
+    end
+
+    def wrong(str)
+      "\e[91m#{str}\e[0m"
+    end
+  end
+end

data/lib/teletype/paginator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Teletype
+  # Pager divides lines of text into proper screen size and provides page suggestion
+  # based on statistics of click accuracy.
+  class Paginator
+    def initialize(profile, text, suggest:, screen:, stats:)
+      @screen = screen
+      @stats = stats
+      @suggest = suggest
+
+      @lines = split(text, @screen.width)
+
+      @linenum = 0
+      @pagefile = File.join(profile, "page-#{Digest::MD5.hexdigest(text)}")
+    end
+
+    def save
+      File.write(@pagefile, @linenum) if @linenum.positive?
+    end
+
+    def run
+      prev = File.exist?(@pagefile) ? Integer(File.read(@pagefile).strip) : 0
+      @lines.each_slice(@screen.height) do |lines|
+        @linenum += @screen.height
+        next if @linenum < prev
+
+        Page.new(lines, @screen, @stats).run
+
+        loop do
+          suggestions = @stats.suggestions
+          break if suggestions.empty?
+
+          Page.new(pick(suggestions), @screen, @stats).run
+        end
+      end
+    end
+
+    def pick(suggestions)
+      index = 0.0 # preserve the original order
+      matches = ->(line) { suggestions.map { |keys| line.scan(keys).count }.sum - (index += 0.0001) }
+      @lines.sort_by { |line| matches.call(line) }.last(@suggest)
+    end
+
+    def split(text, length)
+      lines = []
+      text.each_line do |line|
+        line.chars.each_slice(length) do |slice|
+          lines << slice.join
+        end
+      end
+      lines
+    end
+  end
+end

data/lib/teletype/practice.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Initializes screen size and click stats, then start the practice page by page.
+  class Practice
+    def initialize(profile, text:, height:, width:, suggest:, verbose:)
+      @stats = Stats.new(profile, text)
+      @paginator = Paginator.new(
+        profile, text,
+        height: height,
+        width: width,
+        suggest: suggest,
+        verbose: verbose,
+        stats: @stats
+      )
+    end
+
+    def start
+      at_exit do
+        @stats.save
+        @paginator.save
+      end
+
+      @paginator.run
+    end
+  end
+end

data/lib/teletype/screen.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Screen abstracts console printing, moving to specific row and column.
+  class Screen
+    attr_accessor :height, :width, :top, :left
+
+    def initialize(height, width, verbose: false)
+      @verbose = verbose
+      @maxh, @maxw = $stdout.winsize
+
+      if @maxh > height
+        @height = height
+        @top = (@maxh - height) / 2
+      else
+        @height = @maxh
+        @top = 0
+      end
+
+      if @maxw > width
+        @width = width
+        @left = (@maxw - width) / 2
+      else
+        @width = @maxw
+        @left = 0
+      end
+
+      at_exit { $stdout.clear_screen }
+    end
+
+    def to(x, y)
+      $stdout.goto(@top + y, @left + x)
+    end
+
+    def fill(lines)
+      invisible do
+        $stdout.clear_screen
+
+        lines.each_with_index do |line, index|
+          $stdout.goto(@top + index, @left)
+          $stdout.puts line
+        end
+      end
+    end
+
+    def log(*lines)
+      return unless @verbose
+
+      original = $stdin.cursor
+      invisible do
+        lines.each_with_index do |line, index|
+          $stdout.goto(@top + @height + 5 + index, @left)
+          $stdout.print "\e[90;104m#{line}\e[0m"
+          $stdout.erase_line(0)
+        end
+      end
+      $stdout.cursor = original if original
+    end
+
+    def invisible
+      $stdout.print "\e[?25l"
+      yield
+    ensure
+      $stdout.print "\e[?25h"
+    end
+  end
+end

data/lib/teletype/stats.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Stats keep track of hit/miss rate for pair of keys.
+  # It also has suggestions for keys that need more practice.
+  class Stats
+    def initialize(profile, text)
+      @file = File.join(profile, 'stats')
+      @previous = nil
+      @pairs = {}
+      load(text)
+    end
+
+    def load(text)
+      return unless File.exist?(@file)
+
+      File.readlines(@file).each do |line|
+        keys, hit, miss = line.split("\t")
+        @pairs[keys] = Pair.new(keys,
+                                hit: Integer(hit),
+                                miss: Integer(miss),
+                                available: text.scan(keys).count.positive?)
+      end
+    end
+
+    def save
+      File.write(@file, @pairs.map { |k, p| [k, p.hit, p.miss].join("\t") }.join("\n"))
+    end
+
+    def hit!(key)
+      lookup(key)&.hit!
+    end
+
+    def miss!(key)
+      lookup(key)&.miss!
+    end
+
+    def lookup(key)
+      current = key.downcase
+      keys = "#{@previous}#{current}"
+      @previous = current
+      return if keys.strip.length < 2
+
+      @pairs[keys] ||= Pair.new(keys)
+    end
+
+    def suggestions
+      @pairs.values.select(&:available).select(&:inefficient?).sort.map(&:keys)
+    end
+
+    def rankings
+      @pairs.values.select(&:available).sort.first(10).map(&:to_s).join(' ')
+    end
+
+    # It implements hit/miss rate for second keystroke.
+    # Key miss tends occur when preceded by a certain key.
+    class Pair
+      THRESHOLD = 0.7
+
+      # hit/miss is for the second key
+      attr_accessor :keys, :hit, :miss, :available
+
+      def initialize(keys, hit: 0, miss: 0, available: true)
+        @keys = keys
+        @hit = hit
+        @miss = miss
+        @available = available
+      end
+
+      def inefficient?
+        rate < THRESHOLD
+      end
+
+      def hit!
+        @hit += 1
+      end
+
+      def miss!
+        @miss += 1
+      end
+
+      def rate
+        return 0 if total.zero?
+
+        hit / total.to_f
+      end
+
+      def total
+        hit + miss
+      end
+
+      def <=>(other)
+        [rate, keys] <=> [other.rate, other.keys]
+      end
+
+      def to_s
+        keys.gsub(/[\n\r]/, '↵').gsub(' ', '␣')
+      end
+    end
+  end
+end

data/lib/teletype.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'teletype/key'
+require_relative 'teletype/screen'
+require_relative 'teletype/stats'
+require_relative 'teletype/page'
+require_relative 'teletype/paginator'
+require_relative 'teletype/practice'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: teletype
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Ochirkhuyag Lkhagva
+- Ochirkhuyag.L
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,10 +53,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/teletype
+- lib/teletype.rb
+- lib/teletype/key.rb
+- lib/teletype/page.rb
+- lib/teletype/paginator.rb
+- lib/teletype/practice.rb
+- lib/teletype/screen.rb
+- lib/teletype/stats.rb
 homepage: https://github.com/ochko/teletype
 licenses:
 - MIT
@@ -62,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Typing practice on command line.
+summary: Typing practice on terminal.
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Ochirkhuyag Lkhagva
-
-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.