teletype 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 667cfea43d9fa584b9dab342618c78d850953eddcf78268527d78e471f322b9f
-  data.tar.gz: 83581a95089f771bb038022c6c91d03f734d5c5712b5d8dfa2fb568047272ec9
+  metadata.gz: 40a3e0c38deacc68555c1440a9fe679afc623e93decc137836a3066aa6710521
+  data.tar.gz: 640e87ce91e95e40b37e5f768e70ae0e355f68f810c51b1862e2fcdf6dd1ddd5
 SHA512:
-  metadata.gz: 14f1e845ee7667b54bf32b11238a3542477161d35d8717d20349c189b1c92cbcb95c6fd071bfcd6d9d05a109f07410f1343e21ba20089b0c03ea54251f8cbe67
-  data.tar.gz: a863e8fc6da18cca16ad62941f4cbe78e66e5534979a46d59709a133edbe07688fbfd22d88f18db5727f32e815289580be59154abf30860776fb16c4f044c333
+  metadata.gz: 0b885502503555e6d5874eeb897928d37db231e72d6467438ebbeba43d810b3a0e8ad7415c98eb7330017e38fe48465732a495f96ad1f2e3ca521e8184117453
+  data.tar.gz: 5146ce812b50f336daa87cbaa256c1227c49481e32921e9235cc026bc7238dd8e7712cb8ddd5d869b0db64b2cef233d6291cddc9b51d1178926e4d995d7a213e

data/README.md

@@ -19,3 +19,8 @@ Practice basic keys(numeric and letters):
 
 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/bin/teletype

@@ -1,16 +1,54 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'optparse'
 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, ''), '')
+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
-  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?
@@ -28,5 +66,18 @@ paths.each do |path|
   end
 end
 
-practice = Teletype::Practice.new(text)
-practice.start
+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/page.rb

@@ -7,24 +7,18 @@ module Teletype
       @lines = lines.map { |line| line.gsub("\t", '⇥') }
       @screen = screen
       @stats = stats
+      @y = -1
     end
 
     def fetch
       loop do
         @line = @lines.shift
-        if @y
-          @y += 1
-        else
-          @y = 0
-        end
+        @y += 1
         break if @line.nil? || @line.strip.length.positive?
       end
 
-      @x = if (spaces = @line&.match(/\A\ +/))
-             spaces[0].length
-           else
-             0
-           end
+      # skip white spaces at the beginning of a line
+      @x = @line&.match(/[[:graph:]]/)&.pre_match&.length || 0
     end
 
     def run

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

@@ -3,26 +3,25 @@
 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(text)
-
-      @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)
+    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 { @stats.save }
-
-      @pager.each do |lines|
-        Page.new(lines, @screen, @stats).run
+      at_exit do
+        @stats.save
+        @paginator.save
       end
+
+      @paginator.run
     end
   end
 end

data/lib/teletype/screen.rb

@@ -5,7 +5,8 @@ module Teletype
   class Screen
     attr_accessor :height, :width, :top, :left
 
-    def initialize(height:, width:)
+    def initialize(height, width, verbose: false)
+      @verbose = verbose
       @maxh, @maxw = $stdout.winsize
 
       if @maxh > height
@@ -43,6 +44,8 @@ module Teletype
     end
 
     def log(*lines)
+      return unless @verbose
+
       original = $stdin.cursor
       invisible do
         lines.each_with_index do |line, index|

data/lib/teletype/stats.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
 module Teletype
-  # Stats keep track of hit/miss rate for each key and suggests a key that needs more practice.
+  # 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(text)
+    def initialize(profile, text)
+      @file = File.join(profile, 'stats')
       @previous = nil
       @pairs = {}
       load(text)
     end
 
     def load(text)
-      return unless File.exist?(file)
+      return unless File.exist?(@file)
 
-      File.readlines(file).each do |line|
+      File.readlines(@file).each do |line|
         keys, hit, miss = line.split("\t")
         @pairs[keys] = Pair.new(keys,
                                 hit: Integer(hit),
@@ -22,11 +24,7 @@ module Teletype
     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')
+      File.write(@file, @pairs.map { |k, p| [k, p.hit, p.miss].join("\t") }.join("\n"))
     end
 
     def hit!(key)
@@ -46,7 +44,7 @@ module Teletype
       @pairs[keys] ||= Pair.new(keys)
     end
 
-    def suggestions(_lines)
+    def suggestions
       @pairs.values.select(&:available).select(&:inefficient?).sort.map(&:keys)
     end
 

data/lib/teletype.rb

@@ -4,5 +4,5 @@ require_relative 'teletype/key'
 require_relative 'teletype/screen'
 require_relative 'teletype/stats'
 require_relative 'teletype/page'
-require_relative 'teletype/pager'
+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: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ochirkhuyag.L
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-18 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
@@ -45,7 +59,7 @@ files:
 - lib/teletype.rb
 - lib/teletype/key.rb
 - lib/teletype/page.rb
-- lib/teletype/pager.rb
+- lib/teletype/paginator.rb
 - lib/teletype/practice.rb
 - lib/teletype/screen.rb
 - lib/teletype/stats.rb
@@ -71,5 +85,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Typing practice on command line.
+summary: Typing practice on terminal.
 test_files: []

data/lib/teletype/pager.rb

@@ -1,33 +0,0 @@
-# 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 = 3
-
-    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(@lines)
-          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