readspeed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f95daf752da04495606d7d4c02ea4369e676141a81f3e0a7f98354d7038bae0
+  data.tar.gz: 0c4850987a58001fb0bde547c8f71e4d99d0292101cb070b10e3154d9bd1a8be
+SHA512:
+  metadata.gz: 9d07400d78a798376686afa1a7a1b0307d0b4d810df7eac68b3b59916841fc17437570772e8810c39877003da782c50b2dbf20e8ecf344d64585ad19f77158cf
+  data.tar.gz: c7d9c66bcee8298366efa45ef2112ea0ce83a5b3f85b5908429021115f7d95fcca9424104b836d5e3e1e4c263caff6f515e660d7a44eae97f77a74aaebda1ecd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in readspeed.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    readspeed (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  readspeed!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Madis Nõmme
+
+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,26 @@
+# Readspeed
+
+Cli tool that records your reading speed and provides summary.
+
+![Example usage](docs/readspeed-usage.gif)
+
+## Installation
+
+1. Install with: `gem install readspeed`
+2. Then run `readspeed`
+
+## Usage
+
+After starting readspeed will start recording your page reading speed.
+When you finish reading page, press [ENTER] and timing of next page begins.
+Couple other commands are available as well. They can be seen during the app run by entering `help` or `h`.
+
+When you exit the application with `quit` or `q`, it will record your reading session into `yaml` file in the directory that you ran the `readspeed` command from.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/readspeed.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "readspeed"
+
+# 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/readspeed

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << './lib'
+require 'readspeed'
+
+if ARGV.length == 1
+  file_name = title = ARGV.first
+else
+  print "What are you reading?"
+  title = gets.chomp
+  file_name = nil
+end
+
+tracker = Readspeed::Tracker.new(title)
+tracker.file_name = file_name
+tracker.start

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/lib/readspeed.rb

@@ -0,0 +1,5 @@
+require "readspeed/version"
+require_relative 'readspeed/tracker'
+
+module Readspeed
+end

data/lib/readspeed/tracker.rb

@@ -0,0 +1,124 @@
+require 'yaml'
+
+module Readspeed
+  class Tracker
+    attr_accessor :file_name
+
+    def initialize(title)
+      @pages = 0
+      @times = []
+      @title = title
+      @input = nil
+    end
+
+    def start
+      puts "#{help_info}\n Starting recording. Press [ENTER] when you finish reading page."
+      while true do
+        start_time = Time.now
+        case read_command
+        when :quit
+          write_summary_to_file
+          break
+        when :pause
+          @paused = true
+        when :resume
+          @paused = false
+        when :help
+          print_help
+        else
+          record_next_page(start_time, Time.now)
+        end
+      end
+    end
+
+    private
+
+    COMMANDS = {
+      quit: %w(q quit),
+      pause: %w(p pause),
+      resume: %w(r resume),
+      help: %w(h help)
+    }
+
+    def expanded_commands
+      COMMANDS.reduce({}) do |sum, (command, inputs)|
+        inputs.each { |i| sum[i] = command }
+        sum
+      end
+    end
+
+    def read_command
+      status = @paused ? "(paused)" : "#{@pages}"
+      print "#{status}> "
+      input = STDIN.gets.chomp
+      if @paused && input == ''
+        @paused = false
+        selected_command = :resume
+      else
+        selected_command = expanded_commands[input]
+      end
+      selected_command
+    end
+
+    def record_next_page(start_time, end_time)
+      @pages += 1
+      @times << end_time - start_time
+      puts summary
+    end
+
+    def help_info
+      <<~EOS
+        Press [ENTER] without typing anything to start next page or one of the
+        following commands:
+
+        q, quit   - quit the application, write summary to file
+        p, pause  - record current page, pause
+        r, resume - resume from pause
+        h, help   - show help (this)
+      EOS
+    end
+
+    def write_summary_to_file
+      puts "Writing summary to #{file_name}"
+      if File.exist?(file_name)
+        reading_summary = YAML.load(File.read(file_name))
+      else
+        reading_summary = {
+          title: @title,
+          started_at: Time.now,
+          readings: []
+        }
+      end
+
+      reading = {
+        session_finished_at: Time.now,
+        pages: @pages,
+        times: @times,
+        summary: summary
+      }
+
+      reading_summary[:readings] << reading
+      File.open(file_name, 'w') { |f| f.write(reading_summary.to_yaml) }
+    end
+
+    def summary
+      "Finished page #{@pages}. Last: #{last} Average: #{average} Total: #{total}"
+    end
+
+    def last
+      @times.last.round(1)
+    end
+
+    def average
+      (total / @pages).round(1)
+    end
+
+    def total
+      @times.reduce(&:+).round(1)
+    end
+
+    def file_name
+      @file_name || @title.gsub(/( )/, '_').downcase + ".yaml"
+    end
+  end
+end

data/lib/readspeed/version.rb

@@ -0,0 +1,3 @@
+module Readspeed
+  VERSION = "0.1.0"
+end

data/readspeed.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "readspeed/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "readspeed"
+  spec.version       = Readspeed::VERSION
+  spec.authors       = ["Madis Nõmme"]
+  spec.email         = ["me@mad.is"]
+
+  spec.summary       = %q{Records your reading speed and provides summary}
+  spec.description   = %q{Small cli to track your reading speed to push yourself read more and faster}
+  spec.homepage      = "https://github.com/madis/readspeed"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: readspeed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Madis Nõmme
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Small cli to track your reading speed to push yourself read more and
+  faster
+email:
+- me@mad.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/readspeed
+- bin/setup
+- docs/readspeed-usage.gif
+- lib/readspeed.rb
+- lib/readspeed/tracker.rb
+- lib/readspeed/version.rb
+- readspeed.gemspec
+homepage: https://github.com/madis/readspeed
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Records your reading speed and provides summary
+test_files: []