teletype 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f113b33716079b6147b8511771b0112ec42044981ba543abaca849211563be1
-  data.tar.gz: 85ded73b628942847ef1f6553288afe6eff1cfc02b0ee152bbb2ac4bb3ba790a
+  metadata.gz: f3d17c040e59cad3900c7fd183a9458d640fc00e22d9e513f0cf2a6ad7420747
+  data.tar.gz: aae9d399a93ba481d3baee7090faade55d3285e4f6307cd62329760332b71d22
 SHA512:
-  metadata.gz: be9dad8e1a5edf3d2885b1c19527609d64684abdcdd3fdb4cbfde71641e9a0526282c8ce1b5e01c92b28506e38f41e60914c09138675c6bf52e7e17a84582ec2
-  data.tar.gz: 221045d24b990dd28cf91b9fc51880e8d99c06c13bd38dbea18db922b28ec54517d02ded848f7d934455e34ab3f63b1a6d0b7cdc3b1410a4a14de3fe40848fc5
+  metadata.gz: 55907ec80e180e4393de75b6a4d3f09bebf8f9d70517b13f3ff88d62fa62e177d9b97d551087b820b46930ffece9f1a96a476122f53db34decf0fb4221995d64
+  data.tar.gz: 94ffe5bbbdf66706350ca3d999e751a0e49681c7e4ededcf50852ffeff30bd6c4376cbf437a6fcca3760ac9dcc5a5905735e6bbe44513126016c3e1631efda47

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,31 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-puts "Please use version above 0.0.0"
+require_relative '../lib/teletype'
+
+exercises = File.join(File.dirname(__FILE__), '../', 'exercise')
+
+if ARGV.first == '--list'
+  Dir.glob(File.join(exercises, '**', '*.*')).each do |path|
+    puts path.sub(File.join(exercises, ''), '')
+  end
+  exit
+end
+
+text = ''
+paths = []
+paths << 'base' if ARGV.length.zero?
+
+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
+
+practice = Teletype::Practice.new(text)
+practice.start

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,103 @@
+# 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
+    end
+
+    def fetch
+      loop do
+        @line = @lines.shift
+        if @y
+          @y += 1
+        else
+          @y = 0
+        end
+        break if @line.nil? || @line.strip.length.positive?
+      end
+
+      @x = if (spaces = @line&.match(/\A\ +/))
+             spaces[0].length
+           else
+             0
+           end
+    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/pager.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Pager divides lines of text into proper screen size and provides page suggestion
+  # based on statistics of click accuracy.
+  class Pager
+    SUGGEST = 1
+
+    def initialize(lines, stats, height)
+      @lines = lines
+      @stats = stats
+      @height = height
+    end
+
+    def each
+      @lines.each_slice(@height).map do |lines|
+        yield lines
+
+        loop do
+          suggestions = @stats.suggestions
+          break if suggestions.empty?
+
+          yield pick(suggestions)
+        end
+      end
+    end
+
+    def pick(suggestions)
+      index = 0.0
+      @lines.sort_by { |line| suggestions.map { |keys| -line.scan(keys).count }.sum + (index += 0.0001) }.first(SUGGEST)
+    end
+  end
+end

data/lib/teletype/practice.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Initializes screen size and click stats, then start the practice page by page.
+  class Practice
+    def initialize(text, height: 5, width: 120)
+      @screen = Screen.new(height: height, width: width)
+      @stats = Stats.new
+
+      @lines = []
+      text.each_line do |line|
+        line.chars.each_slice(@screen.width) do |slice|
+          @lines << slice.join
+        end
+      end
+
+      @pager = Pager.new(@lines, @stats, @screen.height)
+    end
+
+    def start
+      at_exit { @stats.save }
+
+      @pager.each do |lines|
+        Page.new(lines, @screen, @stats).run
+      end
+    end
+  end
+end

data/lib/teletype/screen.rb

@@ -0,0 +1,64 @@
+# 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:)
+      @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)
+      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,99 @@
+# frozen_string_literal: true
+
+module Teletype
+  # Stats keep track of hit/miss rate for each key and suggests a key that needs more practice.
+  class Stats
+    def initialize
+      @previous = nil
+      @pairs = {}
+      load
+    end
+
+    def load
+      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))
+      end
+    end
+
+    def save
+      File.write(file, @pairs.map {|k, p| [k, p.hit, p.miss].join("\t")}.join("\n"))
+    end
+
+    def file
+      File.join(Dir.home, '.teletype-stats')
+    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(&:inefficient?).sort.map(&:keys)
+    end
+
+    def rankings
+      @pairs.values.sort.first(10).map(&:to_s).join(' ')
+    end
+
+    # It implements hit/miss rate for second keystroke.
+    # Sometimes a key tends be a miss only when preceded by a certain key.
+    class Pair
+      THRESHOLD = 0.8
+
+      # hit/miss is for the second key
+      attr_accessor :keys, :hit, :miss
+
+      def initialize(keys, hit: 0, miss: 0)
+        @keys = keys
+        @hit = hit
+        @miss = miss
+      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/pager'
+require_relative 'teletype/practice'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teletype
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.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-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,6 +43,13 @@ files:
 - README.md
 - Rakefile
 - bin/teletype
+- lib/teletype.rb
+- lib/teletype/key.rb
+- lib/teletype/page.rb
+- lib/teletype/pager.rb
+- lib/teletype/practice.rb
+- lib/teletype/screen.rb
+- lib/teletype/stats.rb
 homepage: https://github.com/ochko/teletype
 licenses:
 - MIT
@@ -62,7 +69,7 @@ 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.