basher-basher 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f7643a1d5341d906390a12466992ecbcd7d9e8e
+  data.tar.gz: 4b0a87dd94139d10934e4ba9dc10827f9ebceee7
+SHA512:
+  metadata.gz: 6913dfa636e802e50daea0bcc31aa0939c0b4a6bbff54bd367d45246d13962969166a9eb0e3e21335f67b038f83d101c79970cd24063821da546c2f968bdad2f
+  data.tar.gz: 99c6d8205450f186cd32a018c671c5d4d97b1c3657c5c1db76543bcdf6eff74895ff6e647f34b94752e51b9b205c106e7dec0fcb60fca791b0d336bd7313b8a6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sublime*
+
+/experiments

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stefan Rotariu
+
+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,37 @@
+# Basher
+
+Basher is a small CLI game that tests your typing speed.
+
+[![asciicast](https://asciinema.org/a/36151.png)](https://asciinema.org/a/36151)
+
+## Installation
+
+```shell
+$ gem install basher-basher
+```
+
+## Requirements
+
+ * Ruby 2.3
+
+## Usage
+
+```shell
+$ basher -h
+```
+
+## 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/shuriu/basher.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/basher.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "basher-basher"
+  spec.version       = Basher::VERSION
+  spec.authors       = ["shuriu"]
+  spec.email         = ["stefan.rotariu@gmail.com"]
+
+  spec.summary       = %q{Small CLI text game that tests your typing speed.}
+  spec.homepage      = "https://github.com/shuriu/basher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["basher"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "binding_of_caller"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_dependency "curtis", "~> 0.1.3"
+  spec.add_dependency "artii", "~> 2.1.1"
+end

data/bin/basher

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+require 'bundler/setup'
+require 'basher'
+
+options = {
+  debug: false
+}
+
+OptionParser.new do |o|
+  o.on('-d', '--debug', 'Show small debug bar at the top (kinda useless)') do
+    require 'pry'
+    require 'binding_of_caller'
+
+    options[:debug] = true
+  end
+
+  o.on('-v', '--version', 'Print current version') do
+    puts Basher::VERSION
+    exit
+  end
+
+  o.on('-h', '--help', 'Show this message') do
+    puts o
+    exit
+  end
+end.parse!
+
+trap('INT') { exit }
+Basher.start(options)

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "basher"
+
+# 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.
+
+require "pry"
+Pry.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/basher.rb

@@ -0,0 +1,21 @@
+require 'curtis'
+require 'basher/refinements/string'
+require 'basher/version'
+require 'basher/ui'
+require 'basher/game'
+
+module Basher
+  module_function
+
+  def start(**options)
+    Curtis.show do |screen|
+      game = Basher::Game.new(screen, options)
+
+      Curtis::Input.get do |key|
+        result = game.handle(key)
+        break if result == :quit
+        game.render
+      end
+    end
+  end
+end

data/lib/basher/cursor.rb

@@ -0,0 +1,59 @@
+module Basher
+  # Helper class that allows storing movement state inside a collection.
+  class Cursor
+    # Frozen reference of the word.
+    attr_reader :collection
+    # Position of the cursor inside #collection. Default is 0.
+    attr_reader :index
+
+    # Returns a Cursor instance for the given collection. The cursor's
+    # index is defaulted to 0.
+    def initialize(collection)
+      @collection = collection
+      @index      = 0
+    end
+
+    # Gets the item at the cursor.
+    def item
+      collection[index]
+    end
+
+    # Gets the items before the cursor.
+    def previous
+      collection[0...index]
+    end
+
+    # Gets remaining items, including item at the cursor.
+    def remaining
+      collection[index..-1]
+    end
+
+    # Advance the cursor one step.
+    def advance!
+      @index += 1 unless finished?
+      item
+    end
+
+    # Rewind the cursor back to start, and return the item.
+    def rewind!
+      @index = start
+      item
+    end
+
+    # Returns true if the cursor is at the last index,
+    # or false otherwise.
+    def finished?
+      index == finish
+    end
+
+    private
+
+    def start
+      0
+    end
+
+    def finish
+      collection.size
+    end
+  end
+end

data/lib/basher/dictionary.rb

@@ -0,0 +1,50 @@
+module Basher
+  # Gives samples of random words as single instances or in batches.
+  # TODO: Extract constants to global configuration values.
+  # TODO: Allow words_list to be a global config option / value.
+  module Dictionary
+    module_function
+
+    # Where is the words list path on the system. It is also assumed
+    # that there is only one word per line.
+    WORDS_LIST_PATH = '/usr/share/dict/words'.freeze
+
+    # Filter out words with fewer characters.
+    MIN_SIZE = 3
+    # Filter out words with more characters.
+    MAX_SIZE = 15
+
+    # Small utility function that preloads the words_list.
+    def preload
+      !words_list.empty?
+    end
+
+    # Returns a random word from the words file.
+    # The size argument must be greater than MIN_SIZE.
+    #
+    # +size+ - the size of the returned word.
+    def random_word(size = MIN_SIZE)
+      # Return any word from the list if we supply size: nil
+      return words_list.sample unless size
+
+      grouped_words_list.fetch(size) do
+        fail "Size must be in #{MIN_SIZE}..#{MAX_SIZE}"
+      end.sample
+    end
+
+    # Group words in the list by size.
+    def grouped_words_list
+      @grouped_words_list ||= words_list.group_by(&:size)
+    end
+
+    # Returns an array of words, read from a file. Also caches the list.
+    def words_list
+      @words_list ||= File.open(WORDS_LIST_PATH, 'r') do |file|
+        file.each_line.lazy
+          .map    { |word| word.chomp.downcase }
+          .select { |word| word =~ /\A[a-z]{#{MIN_SIZE},#{MAX_SIZE}}\z/ }
+          .to_a
+      end
+    end
+  end
+end

data/lib/basher/game.rb

@@ -0,0 +1,234 @@
+require 'basher/timer'
+require 'basher/state'
+require 'basher/handler'
+require 'basher/dictionary'
+require 'basher/cursor'
+require 'basher/word'
+require 'basher/level'
+
+module Basher
+  class Game
+    include UI
+
+    attr_reader :base_view
+    attr_reader :timer
+    attr_reader :handler
+    attr_reader :state
+    attr_reader :debug
+
+    attr_reader :difficulty
+    attr_reader :level
+    attr_reader :misses
+    attr_reader :characters
+    attr_reader :words
+
+    private def setup_default_bindings
+      Handler.bind :resize do
+        resize_and_reposition
+      end
+
+      Handler.bind 'q' do
+        case state.current
+        when :paused  then back_to_menu
+        when :menu    then :quit
+        when :score   then back_to_menu
+        end
+      end
+
+      Handler.bind :escape do
+        case state.current
+        when :in_game
+          pause_game
+        when :paused
+          back_to_game
+        when :score
+          back_to_menu
+        end
+      end
+
+      Handler.bind :enter do
+        case state.current
+        when :score
+          back_to_menu
+        end
+      end
+
+      Handler.bind 's' do
+        case state.current
+        when :menu
+          start_game
+        end
+      end
+    end
+
+    def initialize(base_view, state: :menu, debug: false, bindings: {})
+      @debug = debug
+
+      @base_view = base_view
+      base_view.refresh
+
+      @state = State.new(state)
+
+      setup_default_bindings
+      @handler = Handler.new(bindings)
+
+      transition_to @state.current
+      @timer = Timer.new
+    end
+
+    def handle(input)
+      debug_view.last_input = input if debugging?
+
+      if state.in_game? && handler.letter?(input)
+        execute_logic input
+      end
+
+      handler.invoke(input)
+    end
+
+    def execute_logic(char)
+      if char == word.char
+        next_letter!
+      else
+        @misses += 1
+        level.timer.advance(200)
+      end
+    end
+
+    def word
+      level.word
+    end
+
+    def next_letter!
+      @characters += 1
+      word.advance!
+
+      next_word! if word.finished?
+    end
+
+    def next_word!
+      @words += 1
+      level.advance!
+
+      next_level! if level.finished?
+    end
+
+    def next_level!
+      @difficulty += 1
+      level.finish if level
+
+      @level = Level.start(difficulty) do
+        stop_game
+      end
+    end
+
+    def accuracy
+      return 0 if total_presses.zero?
+      value = (total_presses - misses).to_f / total_presses * 100
+      value.round(2)
+    end
+
+    def words_per_minute
+      words * 60 / timer.total_elapsed_in_seconds
+    end
+    alias_method :wpm, :words_per_minute
+
+    def chars_per_minute
+      total_presses * 60 / timer.total_elapsed_in_seconds
+    end
+    alias_method :cpm, :chars_per_minute
+
+    def total_presses
+      characters + misses
+    end
+
+    def render
+      base_view.render
+      current_views.each(&:render)
+    end
+
+    def clear
+      base_view.clear
+      current_views.each(&:clear)
+    end
+
+    def refresh
+      base_view.refresh
+      current_views.each(&:refresh)
+    end
+
+    def resize_and_reposition
+      clear
+      views.each(&:will_resize!)
+      current_views.each(&:resize_and_reposition)
+      render
+    end
+
+    def transition_to(new_state)
+      before_transition
+      state.transition_to(new_state)
+      after_transition
+    end
+
+    private
+
+    def debugging?
+      @debug
+    end
+
+    def playing?
+      state.playing? && input.letter?
+    end
+
+    def before_transition
+      clear
+      refresh
+    end
+
+    def after_transition
+      views.each do |view|
+        view.resize_and_reposition if view.should_redraw
+      end
+
+      render
+    end
+
+    def pause_game
+      timer.stop
+      level.timer.stop
+      transition_to(:paused)
+    end
+
+    def back_to_menu
+      timer.reset
+      transition_to(:menu)
+    end
+
+    def back_to_game
+      timer.start
+      level.timer.start
+      transition_to(:in_game)
+    end
+
+    def start_game
+      transition_to(:loading)
+      Basher::Dictionary.preload
+      setup_game
+      transition_to(:in_game)
+      timer.start
+    end
+
+    def stop_game
+      timer.stop
+      transition_to(:score)
+    end
+
+    def setup_game
+      @difficulty = 0
+      @characters = 0
+      @misses     = 0
+      @words      = 0
+      next_level!
+    end
+  end
+end