wpm 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea5ea6d5cbf2eb692ea13f5304b555eef40caa289e27df5a179c9ae2fd1b624
-  data.tar.gz: 21374c4ef47a836da034c3460ee1aabd313f313eff9c8a9b54b7291ee27ddd00
+  metadata.gz: b316a32799f878d70826fa2425e120e2ca6dda8a9f0f4ece99e4e9e403e091d5
+  data.tar.gz: 0df7ec245d5b61be73c9fdfcd72360f6d266aa7c63187257400740b47ae1e00d
 SHA512:
-  metadata.gz: 5b43385d0fb20f0a4315ac180886038f878d19c1be2859c7b0fc69acfdc8eedf3c3134d605e570aad71190223167d434de2e7baff04e97be2bf1b9aca9212443
-  data.tar.gz: 361132347b94f368992217f031089a31b1c7e8adae90b2c08891b7ca3c0bbbd19344f37eeff3d4f5a31d12e98bbf6b78fc2df0cb296818e499273feb9802af7b
+  metadata.gz: db8125deaaff7af54b8c03f3be4b6eb0056dab3a78636f8ac67b373c998e534cb928f2bdb4d15bced22e747d611db1c83856fb7a9b5cdabc31e7d23376696b42
+  data.tar.gz: 65cae662a78a69d876cd355c1dcdbd1665872baefd71b3995f14570406368837d797121142652acb6ca80b8e679d3d75e08036ce1ea17d998a8f6365c1bc315b

data/.gitignore

@@ -0,0 +1,53 @@
+*
+!/**/
+!?*.*
+
+# directories
+.bundle/
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+vendor/
+
+# files
+*.dump
+*.log
+*.mod
+*.o
+*.swp
+*~
+.DS_Store
+.idea
+.project
+.rake*
+.rake*
+.ruby-*
+.rvmrc
+.secret
+.yardoc
+TODO.md
+core.*
+cscope.out
+secrets.yml
+tags
+
+# don't ignore
+!.gitignore
+!Capfile
+!Cheffile
+!Gemfile
+![MR]akefile
+!bin/**/*
+!exe/**/*
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Layout/CommentIndentation:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceAfterComma:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wpm.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    wpm (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    benchmark-ips (2.7.2)
+    builder (3.2.4)
+    byebug (11.0.1)
+    minitest (5.14.0)
+    minitest-reporters (1.3.8)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler (~> 2.0)
+  byebug (~> 11.0.1)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3.8)
+  rake (~> 13.0.1)
+  wpm!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 sergioro
+
+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,40 @@
+# Wpm
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wpm`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wpm'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wpm
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wpm.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rake/clean'
+require 'fileutils'
+
+CLEAN.include ['**/.*.sw?', '**/*.gem', 'test/test.log']
+
+task default: %i[test package]
+task package: :clean
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wpm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/wpm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "wpm"
+
+WPM.race(ARGV)

data/lib/wpm.rb

@@ -0,0 +1,163 @@
+require 'io/console'
+require 'wpm/version'
+require 'yaml'
+
+class WPMError < StandardError; end
+
+class Array
+  def average
+    (reduce(:+).to_f/size).round(2)
+  end
+end
+
+module WPM
+  extend self
+
+  def race(args)
+    help if !(args & %w[-h --help]).empty?
+
+    parse_options(args) unless args.empty?
+
+    @max_length||=4000
+
+    @eot=0x03
+    @eof=0x04
+
+    if quotes.empty?
+      puts "No quotes with less than #{@max_length} characters found"
+      exit
+    end
+
+    @color="\e[4;32m"
+    @no_color="\e[m"
+
+    @lines=quotes[rand(quotes.size)].chars.each_slice(term_width).map(&:join)
+    @line=0
+    @pos=0
+
+    # average length of English words
+    @word_length=5
+
+    @start_time=time
+    print_text
+
+    loop do
+      update_text
+      break if @line==@lines.size-1 and pos==@lines.last.size
+    end
+
+    save_wpm
+    puts "\nWPM: #{wpm}"
+  end
+
+  def help
+    puts <<~eof
+    Usage: wpm [options]
+
+    Options:
+      -h              show this message
+      -s              print stats
+      -l [length]     maximum string length
+      -q              print quotes.yml path
+    eof
+    exit
+  end
+
+  def parse_options(args)
+    if args.first=='-s'
+      stats
+      exit
+    end
+
+    if args.first=='-q'
+      puts quotes_file
+      exit
+    end
+
+    if args.shift=='-l' and args.first.to_i > 0
+      @max_length=args.first.to_i
+      return
+    end
+
+    puts "Unknown option"
+    bye
+  rescue => e
+    "Bad options. For help: `wpm -h`"
+    exit
+  end
+
+  def stats
+    str=File.open(wpm_file).read
+    scores=str.split(" ").map(&:to_i).select.with_index{|e,i| i.odd?}
+    printf "%-20s %s", "Number of races:", "#{str.count("\n")}\n"
+    printf "%-20s %s", "Average speed (WPM):", "#{scores.average}\n"
+  end
+
+  def time
+    Time.now.to_i
+  end
+
+  def wpm
+    @lines.join(' ').size*60/((time-@start_time)*@word_length)
+  end
+
+  def wpm_file
+    "#{ENV['HOME']}/.wpm_history"
+  end
+
+  def save_wpm
+    open(wpm_file,'a') do |f|
+      f.puts "#{Time.now.strftime("%Y-%m-%d")} #{wpm}"
+    end
+  end
+
+  def quotes
+    YAML.load(open(quotes_file))
+        .sort_by(&:length)
+        .select {|e| e.size<@max_length}
+  rescue => e
+    "Error while reading #{quotes_file}"
+  end
+
+  def quotes_file
+    "#{__dir__}/wpm/quotes.yml"
+  end
+
+  def print_text
+    print "\r"+text.sub(/(.{#{pos}})/,"#{@color}\\1#{@no_color}")+"\r"
+  end
+
+  # width of the terminal
+  def term_width
+    IO.console.winsize.last
+  end
+
+  def update_text
+    system('stty raw -echo')
+    c=STDIN.getc
+    bye if c==@eof.chr or c==@eot.chr
+    carriage_return if @pos>=term_width-1
+    @pos+=1 if c==text[pos]
+  ensure
+    system('stty -raw echo')
+    print_text
+  end
+
+  def carriage_return
+    @pos=0
+    @line+=1
+  end
+
+  def text
+    @lines[@line]
+  end
+
+  def pos
+    @pos
+  end
+
+  def bye
+    puts "\nBye"
+    exit
+  end
+end

data/lib/wpm/quotes.yml

@@ -0,0 +1,6 @@
+- "Do nothing out of selfish ambition or vain conceit, but in humility consider others better than yourselves"
+- "It's a funny thing, but people mostly have it backward. They think they live by what they want. But really, what guides them is what they're afraid of. What they don't want"
+- "Roses are red, violets are blue"
+- "The best way to learn programming is by reading open source code"
+- "Emacs is a nice operating system, but I prefer UNIX"
+- "Real programmers can write assembly code in any language"

data/lib/wpm/version.rb

@@ -0,0 +1,3 @@
+module WPM
+  VERSION = "0.2.0"
+end

data/wpm.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/wpm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wpm"
+  spec.version       = WPM::VERSION
+  spec.authors       = ["sergioro"]
+  spec.email         = ["yo@sergioro.com"]
+
+  spec.summary       = %q{Increase your typing speed}
+  spec.description   = %q{Increase typing speed and keep track of WPM history}
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0.1"
+  spec.add_development_dependency "benchmark-ips", ">= 0"
+  spec.add_development_dependency "byebug", "~> 11.0.1"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3.8"
+
+  #spec.add_runtime_dependency "SOME_GEM", "~> VERSION"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wpm
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - sergioro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,10 +97,26 @@ dependencies:
 description: Increase typing speed and keep track of WPM history
 email:
 - yo@sergioro.com
-executables: []
+executables:
+- wpm
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/wpm
+- lib/wpm.rb
+- lib/wpm/quotes.yml
+- lib/wpm/version.rb
+- wpm.gemspec
 homepage: 
 licenses:
 - MIT
@@ -120,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Increase your typing speed