typingtutor 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ab9a80145a0f7855887d17749ec81defb9cce5a
-  data.tar.gz: 37fe6ae44422bbbfaa276dab13fb0459f7ecab65
+  metadata.gz: 5696067963b2ee5de9aeeff804074fd4bebff0be
+  data.tar.gz: 89383a076e3b71244b0aa54b938ab576d3903047
 SHA512:
-  metadata.gz: 2391c93a3228ff876e1db97293b0d7807741518c1b83108bc1d715145612e8d021491de78744df3b9f45a1f68535e45fb3d842277e9d62b618f15e1d484558dd
-  data.tar.gz: 5220a4e3bfcaffaa71d7081288424350153d1eaf7b023b6dc49685c40321fb0566ac5e341236572223dfeb78d676bdec8c1dbd0ed9691f588e6a77c68b9eeec7
+  metadata.gz: f57820a556542fcb36e2630ce28490df28941d3d1b0dccdb9eb4e81af18d84af4ae6cbcd24a949105575ace1775e7919f099c537b096d39eadccf5a719468e6f
+  data.tar.gz: 4bef0c9629250f12214c91dac86dcd13aa11ad355c893e3439adc1850072ade7743b8b7b4c76b79192c64b5e0d04d8e479b9123362e3af7b81b347a8baeecdd8

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in powder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    typingtutor (1.0.3)
+      highline (= 1.7.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    highline (1.7.8)
+    rake (11.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  typingtutor!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Paolo
+
+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.

data/README.md

@@ -0,0 +1,20 @@
+# Typing Tutor
+Minimalist command line typing tutor written in ruby
+
+Installation:
+
+```
+$ gem install typingtutor
+```
+
+Show exercises available:
+
+```
+$ typingtutor 
+```
+
+Play a specific exercise, eg:
+
+```
+$ typingtutor lorem
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/exercises/fox.txt

@@ -0,0 +1 @@
+The quick brown fox jumps over the lazy dog

data/exercises/haikurb.txt

@@ -0,0 +1,3 @@
+"eyes".scan /the_darkness/
+catch( :in_the_wind ) { ?a.round; "breath"
+or "a".slice /of_moon/ }

data/exercises/lorem.txt

@@ -0,0 +1,7 @@
+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.

data/exercises/starwars.txt

@@ -0,0 +1,17 @@
+A long time ago, in a galaxy far, far away...
+It is a period of civil war. Rebel
+spaceships, striking from a hidden
+base, have won their first victory
+against the evil Galactic Empire.
+
+During the battle, Rebel spies managed
+to steal secret plans to the Empire's
+ultimate weapon, the Death Star, an
+armored space station with enough
+power to destroy an entire planet.
+
+Pursued by the Empire's sinister agents,
+Princess Leia races home aboard her
+starship, custodian of the stolen plans
+that can save her people and restore
+freedom to the galaxy....

data/lib/typingtutor.rb

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

data/lib/typingtutor/line.rb

@@ -38,7 +38,7 @@ module Typingtutor
     end
 
     def print_backspace
-      print "\b#{HighLine.color(expected_char, :plain)}\b"
+      print "\b#{HighLine.color(expected_char || " ", :plain)}\b"
     end
 
     def expected_char; @original[@position]; end

data/lib/typingtutor/runner.rb

@@ -3,7 +3,7 @@ module Typingtutor
     include HighLine::SystemExtensions
 
     def run(exercise_name)
-      exercise = exercises[exercise_name]
+      exercise = load_exercise(exercise_name)
       if exercise
         setup_color_scheme
         play_intro
@@ -11,9 +11,10 @@ module Typingtutor
         stats = exercise.map { |line| Line.new(line).play }
         print_stats(stats)
       else
+        puts "Typingtutor v#{Typingtutor::VERSION}"
         puts "usage: typingtutor <exercise>"
         puts "available:"
-        exercises.keys.each {|e| puts "- #{e}"}
+        exercises.each {|e| puts "- #{e}"}
       end
     end
 
@@ -34,23 +35,26 @@ module Typingtutor
       HighLine.color_scheme = cs
     end
 
+    def load_exercise(name)
+      file_name = File.join(File.dirname(__FILE__), '..', '..', "exercises", "#{name}.txt")
+
+      # load from exercise folder in the gem
+      lines = IO.read(file_name).lines if File.exists?(file_name)
+      return if lines.nil?
+
+      lines.each {|line| line.strip!}    # remove extra spaces
+      lines.reject! {|line| line.strip.to_s == ""} # remove empty lines
+      return lines
+    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/ }'
-        ]
-      }
+      files = Dir[File.join(File.dirname(__FILE__), '..', '..', "exercises", "*.txt")]
+      files.map! do |name|
+        name = name.split(File::SEPARATOR).last
+        name = name.gsub /\.txt/, ''
+        name
+      end
+      files
     end
 
     def print_stats(stats)

data/lib/typingtutor/version.rb

@@ -0,0 +1,3 @@
+module Typingtutor
+  VERSION = "1.0.3"
+end

data/typingtutor.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "typingtutor/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = 'typingtutor'
+  gem.version     = Typingtutor::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.summary     = "Command line typing tutor"
+  gem.authors     = ["Paolo Dona"]
+  gem.email       = ['paolo.dona@gmail.com']
+  gem.files       = `git ls-files`.split("\n")
+  gem.homepage    = 'https://github.com/paolodona/typingtutor'
+  gem.license     = 'MIT'
+  gem.executables = ['typingtutor']
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "highline", ['1.7.8']
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typingtutor
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Paolo Dona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -24,17 +24,44 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.7.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: paolo.dona@gmail.com
+email:
+- paolo.dona@gmail.com
 executables:
 - typingtutor
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
 - bin/typingtutor
+- exercises/fox.txt
+- exercises/haikurb.txt
+- exercises/lorem.txt
+- exercises/starwars.txt
 - lib/typingtutor.rb
 - lib/typingtutor/line.rb
 - lib/typingtutor/runner.rb
+- lib/typingtutor/version.rb
+- typingtutor.gemspec
 homepage: https://github.com/paolodona/typingtutor
 licenses:
 - MIT
@@ -55,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Command line typing tutor