need_for_type 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9d15376668b2067a3279a2f17c32f62e209cc6c
+  data.tar.gz: b9c778b6ced2d63ae6f7f233a494ac274630e644
+SHA512:
+  metadata.gz: 6f8cb2a5d6424054fcb74bbc0635b05c0616ae803dac320ee10313e222237350f5d7ed5602b09fabe04bf7a3dca0f9305ee2b796d772cfef3f13a8a21c103ce1
+  data.tar.gz: 9a4e563fcf77a6ca9ab0bb28956e8350413f95674a2bdf21d506c5273102bd2076d7a47e4c918b3b9b6236d8404ea634fbd5c5cabe713ce8b90d6ca88be9647a

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in need_for_type.gemspec
+gemspec
+
+gem 'curses'
+gem 'rubocop'

data/README.md

@@ -0,0 +1,48 @@
+# need-for-type 
+
+need-for-type is a terminal type racer inpired by [Nitro Type](https://www.nitrotype.com/).
+
+![screenshot](https://raw.githubusercontent.com/jbernardo95/need-for-type/master/assets/screenshot.png)
+
+## Installation
+
+Run the following command:
+
+```shell
+$ gem install 'need_for_type'
+```
+
+## Usage
+
+On a new terminal window run the following command:
+
+```shell
+$ need_for_type
+```
+
+## Development
+
+After checking out the repo, run `./bin/setup` to install dependencies.
+
+You can run `./bin/console` for an interactive prompt that will allow you to experiment.
+
+To install the development version of the 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/jbernardo95/need-for-type. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## Credits 
+
+Sample texts included in this library come from the following sources:
+
+- http://www.lipsum.com/
+- https://medium.com/@kristicoulter
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/assets/easy/1.txt

@@ -0,0 +1 @@
+There is. But it's broken. I mingle empty-handed for 15 minutes, fending off well-meaning offers to get me something from the bar. After the fifth, I realize I'm going to cry if one more person offers me alcohol. I leave and cry anyway. Later I order vanilla ice cream from room service to cheer myself up.

data/assets/hard/1.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam suscipit porttitor arcu, eget hendrerit est iaculis a. Aliquam faucibus libero et accumsan accumsan. Duis id tellus eu tellus finibus eleifend. Sed quis elit nec metus condimentum ultricies vitae in est. Proin sit amet scelerisque odio. Aenean luctus lorem non ante hendrerit luctus. Pellentesque et tellus id lectus ornare mattis. Aenean ac dolor vitae metus iaculis mollis eu vel arcu. Donec aliquet turpis diam, sit amet finibus enim vulputate mattis. Quisque laoreet feugiat nisi eget tempus. Duis varius dapibus nulla. Etiam at elit sapien. Pellentesque dui odio, ornare id nisl elementum, consectetur hendrerit turpis. Quisque convallis sapien orci. Mauris non enim sollicitudin, fringilla justo quis, congue massa. Etiam cursus, tellus interdum mattis lacinia, urna magna luctus mauris, at egestas ante tortor a urna.

data/assets/medium/1.txt

@@ -0,0 +1 @@
+That second summer, I meet my friend Mindy outside San Diego, where her adopted son is days from being born. Mindy’s dark alleys were different from mine, but she walked them all the same and walked herself out of them, too. Sometimes, talking about the recent past, we blink at each other like people struggling to readjust to sunlight after a long, bad movie. More and more it’s the new that gets our attention: my new job, her newish and happy marriage, the book I’m writing and the classes she’s taking. The things we are making happen, step by step.

data/bin/need_for_type

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'curses'
+require 'need_for_type'
+require 'need_for_type/typer'
+require 'need_for_type/window'
+
+Curses.init_screen
+Curses.noecho
+NeedForType::Window.init_colors
+
+begin
+  typer = NeedForType::Typer.new
+  typer.play
+ensure
+  Curses.close_screen
+end

data/lib/need_for_type.rb

@@ -0,0 +1,5 @@
+require 'curses'
+
+module NeedForType
+  GEM_ROOT = File.expand_path("../..", __FILE__)
+end

data/lib/need_for_type/display_window.rb

@@ -0,0 +1,81 @@
+require 'curses'
+require 'need_for_type/window'
+
+module NeedForType
+  class DisplayWindow < Window
+
+    def initialize
+      super(Curses.lines, Curses.cols, 0, 0)
+      Curses.curs_set(CURSOR_INVISIBLE)
+    end
+
+    def render_menu(selected_option)
+      self.render do
+        self.setpos(2, 4)
+        self.render_text("Need For Type", GREEN, NORMAL)
+
+        self.setpos(4, 4)
+        mode = standout_mode(0, selected_option)
+        self.render_text("1. Easy", WHITE, mode)
+
+        self.setpos(5, 4)
+        mode = standout_mode(1, selected_option)
+        self.render_text("2. Medium", WHITE, mode)
+
+        self.setpos(6, 4)
+        mode = standout_mode(2, selected_option)
+        self.render_text("3. Hard", WHITE, mode)
+
+        self.setpos(8, 4)
+        mode = standout_mode(3, selected_option)
+        self.render_text("Exit", WHITE, mode)
+      end
+    end
+
+    def standout_mode(option, selected_option)
+      selected_option == option ? STANDOUT : NORMAL
+    end
+
+    def render_game_text(text, chars_completed, failed = false)
+      current_color = failed ? RED : YELLOW
+      completed = text[0, chars_completed - 1]
+      tail = text[chars_completed + 1, text.length]
+
+      self.render do
+        self.setpos(2,4)
+        self.render_multiple_text(GREEN, NORMAL) { completed.each { |c| self.addstr(c) } }
+        self.render_text(c, color, NORMAL)
+        self.render_multiple_text(WHITE, NORMAL) { tail.each { |c| self.addstr(c) } }
+      end
+    end
+
+    def render_game_text(text, chars_completed, failed = false)
+      self.render do
+        self.setpos(2, 4)
+        text.each_with_index do |c, i|
+          if i < chars_completed
+            self.render_text(c, GREEN, NORMAL)
+          elsif i == chars_completed
+            color = failed ? RED : YELLOW
+            self.render_text(c, color, NORMAL)
+          else
+            self.render_text(c, WHITE, NORMAL)
+          end
+        end
+      end
+    end
+
+    def render_score(time, wpm, accuracy)
+      self.render do
+        self.setpos(2, 4)
+        self.render_text("Time: #{time.round(2)} sec", GREEN, NORMAL)
+
+        self.setpos(3, 4)
+        self.render_text("WPM: #{wpm.round}", GREEN, NORMAL)
+
+        self.setpos(4, 4)
+        self.render_text("Accuracy: #{accuracy.round(2)} %", GREEN, NORMAL)
+      end
+    end
+  end
+end

data/lib/need_for_type/file_manager.rb

@@ -0,0 +1,31 @@
+module NeedForType
+  class FileManager
+    attr_accessor :content
+
+    def initialize(difficulty)
+      @path = "#{NeedForType::GEM_ROOT}/assets/#{difficulty_to_s(difficulty)}/"
+    end
+
+    # Reads random file from difficulty folder
+    def get_random_text
+      directory = Dir[@path]
+      random_file = rand(1..directory.count)
+
+      # TODO: apply markov's chain's to the text
+      @content = File.read("#{@path}/#{random_file}.txt").strip
+    end
+
+    private
+
+    def difficulty_to_s(difficulty)
+      case difficulty
+      when 0
+        'easy'
+      when 1
+        'medium'
+      when 2
+        'hard'
+      end
+    end
+  end
+end

data/lib/need_for_type/states.rb

@@ -0,0 +1,9 @@
+require 'need_for_type/states/state'
+require 'need_for_type/states/menu'
+require 'need_for_type/states/game'
+require 'need_for_type/states/score'
+
+module NeedForType
+  module States
+  end
+end

data/lib/need_for_type/states/game.rb

@@ -0,0 +1,113 @@
+require 'curses'
+
+require 'need_for_type/states'
+require 'need_for_type/file_manager'
+
+module NeedForType::States
+  class Game < State
+
+    def initialize(display_window, difficulty)
+      super(display_window)
+
+      @difficulty = difficulty
+      @state = :init_game
+      @text = ''
+    end
+
+    # Takes action according to the current @state 
+    def update
+      case @state
+      when :init_game
+        handle_init_game
+      when :in_game_get_input
+        handle_in_game_get_input
+      when :in_game_valid_input
+        handle_in_game_valid_input
+      when :in_game_invalid_input
+        handle_in_game_invalid_input
+      when :end_game
+        handle_end_game
+      end
+    end
+
+    private
+
+    def handle_init_game
+      @chars_completed = 0
+      @word = ''
+
+      @total_taps = 0
+      @correct_taps = 0
+
+      file_manager = NeedForType::FileManager.new(@difficulty)
+      @text = file_manager.get_random_text
+      @split_text = @text.split('')
+      @display_window.render_game_text(@split_text, @chars_completed)
+
+      @start_time = Time.now
+
+      @state = :in_game_get_input
+
+      return self
+    end
+
+    # Gets input from user and compares it
+    def handle_in_game_get_input
+      input = @display_window.get_input
+      @total_taps += 1
+
+      if input == @text[@chars_completed]
+        @state = :in_game_valid_input
+      else
+        @state = :in_game_invalid_input
+      end
+
+      return self
+    end
+
+    # User input is correct
+    def handle_in_game_valid_input
+      @chars_completed += 1
+      @correct_taps += 1
+
+      if @chars_completed == @text.size
+        @state = :end_game
+        return self
+      end
+
+      if @text[@chars_completed] == ' '
+        @word = ''
+      else
+        @word += @text[@chars_completed]
+      end
+
+      # Render
+      @display_window.render_game_text(@split_text, @chars_completed)
+
+      @state = :in_game_get_input
+
+      return self
+    end
+
+    # User input is wrong 
+    def handle_in_game_invalid_input
+      Curses.beep
+
+      @display_window.render_game_text(@split_text, @chars_completed, true)
+
+      @state = :in_game_get_input
+
+      return self
+    end
+
+    def handle_end_game
+      @end_time = Time.now
+
+      total_time = @end_time - @start_time
+      wpm = (@text.split.size * 60) / total_time
+      accuracy = (@correct_taps.to_f / @total_taps.to_f) * 100
+      
+      return NeedForType::States::Score.new(@display_window, total_time, wpm, accuracy)
+    end
+  end
+end

data/lib/need_for_type/states/menu.rb

@@ -0,0 +1,31 @@
+require 'curses'
+
+require 'need_for_type/states'
+
+module NeedForType::States
+  class Menu < State
+
+    def initialize(display_window)
+      super(display_window)
+
+      @option = 0
+    end
+
+    def update
+      @display_window.render_menu(@option)
+
+      input = @display_window.get_input
+
+      if input == Curses::Key::UP
+        @option = (@option - 1) % 4
+      elsif input == Curses::Key::DOWN
+        @option = (@option + 1) % 4
+      elsif input == Curses::Key::ENTER || input == 10
+        exit if @option == 3
+        return NeedForType::States::Game.new(@display_window, @option) 
+      end
+
+      return self
+    end
+  end
+end

data/lib/need_for_type/states/score.rb

@@ -0,0 +1,27 @@
+require 'curses'
+
+require 'need_for_type/states'
+
+module NeedForType::States
+  class Score < State
+
+    def initialize(display_window, time, wpm, accuracy)
+      super(display_window)
+      @time = time
+      @wpm = wpm
+      @accuracy = accuracy 
+    end
+
+    def update
+      @display_window.render_score(@time, @wpm, @accuracy)
+
+      input = @display_window.get_input
+
+      if input == Curses::Key::ENTER || input == 10
+        return NeedForType::States::Menu.new(@display_window)
+      end
+
+      return self
+    end
+  end
+end

data/lib/need_for_type/states/state.rb

@@ -0,0 +1,9 @@
+module NeedForType::States
+  class State
+
+    def initialize(display_window)
+      @display_window = display_window
+    end
+
+  end
+end

data/lib/need_for_type/typer.rb

@@ -0,0 +1,23 @@
+require 'curses'
+
+require 'need_for_type/display_window'
+
+require 'need_for_type/states'
+
+module NeedForType
+  class Typer
+
+    def initialize
+      display_window = NeedForType::DisplayWindow.new
+
+      @state = NeedForType::States::Menu.new(display_window)
+    end
+
+    def play
+      while true
+        @state = @state.update
+      end
+    end
+
+  end
+end

data/lib/need_for_type/version.rb

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

data/lib/need_for_type/window.rb

@@ -0,0 +1,62 @@
+require 'curses'
+
+module NeedForType
+  class Window < Curses::Window
+    # Cursor visibility
+    CURSOR_VISIBLE = 1
+    CURSOR_INVISIBLE = 0
+
+    # Colors
+    WHITE = 1
+    GREEN = 2
+    YELLOW = 3
+    RED = 4
+
+    # Modes
+    NORMAL = Curses::A_NORMAL
+    STANDOUT = Curses::A_STANDOUT
+
+    def initialize(lines, cols, top, left)
+      super(lines, cols, top, left)
+
+      self.box('|', '-')
+      self.keypad = true 
+      self.refresh
+    end
+
+    def self.init_colors
+      Curses.start_color
+      Curses.init_pair(WHITE,  Curses::COLOR_WHITE,  Curses::COLOR_BLACK)
+      Curses.init_pair(GREEN,  Curses::COLOR_GREEN,  Curses::COLOR_BLACK)
+      Curses.init_pair(YELLOW, Curses::COLOR_YELLOW, Curses::COLOR_BLACK)
+      Curses.init_pair(RED,    Curses::COLOR_RED,    Curses::COLOR_BLACK)
+    end
+
+    def render(color = WHITE, mode = NORMAL)
+      self.attrset(Curses.color_pair(color) | mode)
+
+      self.clear
+      self.box('|', '-')
+
+      yield if block_given?
+
+      self.refresh
+    end
+
+    def render_text(text, color = WHITE, mode = NORMAL)
+      self.attron(Curses.color_pair(color) | mode)
+      self.addstr(text)
+      self.attroff(Curses.color_pair(color) | mode)
+    end
+
+    def render_multiple_text(color = WHITE, mode = NORMAL)
+      self.attron(Curses.color_pair(color) | mode)
+      yield
+      self.attroff(Curses.color_pair(color) | mode)
+    end
+
+    def get_input
+      self.getch
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: need_for_type
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tiagonbotelho
+- jbernardo95
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: need-for-type is a terminal type racer inpired by Nitro Type
+email:
+- tiagonbotelho@gmail.com
+- jbamaro95@gmail.com
+executables:
+- need_for_type
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- assets/easy/1.txt
+- assets/hard/1.txt
+- assets/medium/1.txt
+- bin/need_for_type
+- lib/need_for_type.rb
+- lib/need_for_type/display_window.rb
+- lib/need_for_type/file_manager.rb
+- lib/need_for_type/states.rb
+- lib/need_for_type/states/game.rb
+- lib/need_for_type/states/menu.rb
+- lib/need_for_type/states/score.rb
+- lib/need_for_type/states/state.rb
+- lib/need_for_type/typer.rb
+- lib/need_for_type/version.rb
+- lib/need_for_type/window.rb
+homepage: https://github.com/jbernardo95/need-for-type
+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.6.6
+signing_key: 
+specification_version: 4
+summary: A terminal typeracer
+test_files: []