teletype 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3d17c040e59cad3900c7fd183a9458d640fc00e22d9e513f0cf2a6ad7420747
-  data.tar.gz: aae9d399a93ba481d3baee7090faade55d3285e4f6307cd62329760332b71d22
+  metadata.gz: 667cfea43d9fa584b9dab342618c78d850953eddcf78268527d78e471f322b9f
+  data.tar.gz: 83581a95089f771bb038022c6c91d03f734d5c5712b5d8dfa2fb568047272ec9
 SHA512:
-  metadata.gz: 55907ec80e180e4393de75b6a4d3f09bebf8f9d70517b13f3ff88d62fa62e177d9b97d551087b820b46930ffece9f1a96a476122f53db34decf0fb4221995d64
-  data.tar.gz: 94ffe5bbbdf66706350ca3d999e751a0e49681c7e4ededcf50852ffeff30bd6c4376cbf437a6fcca3760ac9dcc5a5905735e6bbe44513126016c3e1631efda47
+  metadata.gz: 14f1e845ee7667b54bf32b11238a3542477161d35d8717d20349c189b1c92cbcb95c6fd071bfcd6d9d05a109f07410f1343e21ba20089b0c03ea54251f8cbe67
+  data.tar.gz: a863e8fc6da18cca16ad62941f4cbe78e66e5534979a46d59709a133edbe07688fbfd22d88f18db5727f32e815289580be59154abf30860776fb16c4f044c333

data/README.md

@@ -12,7 +12,10 @@
 ### Usage
 
 Practice numeric keys:
-`teletype number`
+`teletype base/number.txt`
+
+Practice basic keys(numeric and letters):
+`teletype base`
 
 Practice with ruby code:
 `teletype ruby`

data/bin/teletype

@@ -12,12 +12,13 @@ if ARGV.first == '--list'
   exit
 end
 
-text = ''
-paths = []
-paths << 'base' if ARGV.length.zero?
+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)

data/lib/teletype/pager.rb

@@ -4,7 +4,7 @@ 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
+    SUGGEST = 3
 
     def initialize(lines, stats, height)
       @lines = lines
@@ -17,7 +17,7 @@ module Teletype
         yield lines
 
         loop do
-          suggestions = @stats.suggestions
+          suggestions = @stats.suggestions(@lines)
           break if suggestions.empty?
 
           yield pick(suggestions)

data/lib/teletype/practice.rb

@@ -5,7 +5,7 @@ module Teletype
   class Practice
     def initialize(text, height: 5, width: 120)
       @screen = Screen.new(height: height, width: width)
-      @stats = Stats.new
+      @stats = Stats.new(text)
 
       @lines = []
       text.each_line do |line|

data/lib/teletype/stats.rb

@@ -3,23 +3,26 @@
 module Teletype
   # Stats keep track of hit/miss rate for each key and suggests a key that needs more practice.
   class Stats
-    def initialize
+    def initialize(text)
       @previous = nil
       @pairs = {}
-      load
+      load(text)
     end
 
-    def load
+    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))
+        @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"))
+      File.write(file, @pairs.map { |k, p| [k, p.hit, p.miss].join("\t") }.join("\n"))
     end
 
     def file
@@ -43,26 +46,27 @@ module Teletype
       @pairs[keys] ||= Pair.new(keys)
     end
 
-    def suggestions
-      @pairs.values.select(&:inefficient?).sort.map(&:keys)
+    def suggestions(_lines)
+      @pairs.values.select(&:available).select(&:inefficient?).sort.map(&:keys)
     end
 
     def rankings
-      @pairs.values.sort.first(10).map(&:to_s).join(' ')
+      @pairs.values.select(&:available).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.
+    # Key miss tends occur when preceded by a certain key.
     class Pair
-      THRESHOLD = 0.8
+      THRESHOLD = 0.7
 
       # hit/miss is for the second key
-      attr_accessor :keys, :hit, :miss
+      attr_accessor :keys, :hit, :miss, :available
 
-      def initialize(keys, hit: 0, miss: 0)
+      def initialize(keys, hit: 0, miss: 0, available: true)
         @keys = keys
         @hit = hit
         @miss = miss
+        @available = available
       end
 
       def inefficient?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teletype
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ochirkhuyag.L
@@ -39,7 +39,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/teletype

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.