minesweeprb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0a927b6f66d1e8859c03abc54b13a0cbbc493d6f49363ff64749e7492dca708
+  data.tar.gz: 19bcd6ea2b5eba19d15a130e801198380b7d75362bd7a30e4978ae9073eb92f7
+SHA512:
+  metadata.gz: 5dd06487cef1c41d3ace0c74f2faa9d1b221f677f61605dff72b1c4f2bfd298c28a09d26eec4f3bc7a516584c7cb77d863902c1b75813c9ddf80ae232f2e4e7c
+  data.tar.gz: 4bba0e734f6140c4ef5e147e713d38ce874ede0b9a3b2c5b2bb3462a7cddc41555ea4aaf3c93ccaf758729293868341ace2ce12f3f0e685abed30118d8bcf5ff

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require: rubocop-rspec
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe']
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minesweeprb.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    minesweeprb (0.1.0)
+      tty (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    equatable (0.6.1)
+    kramdown (1.16.2)
+    necromancer (0.5.1)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    rouge (3.15.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    strings (0.1.8)
+      strings-ansi (~> 0.1)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.1.0)
+    thor (0.20.3)
+    tty (0.10.0)
+      bundler (~> 1.16, < 2.0)
+      equatable (~> 0.5)
+      pastel (~> 0.7.2)
+      thor (~> 0.20.0)
+      tty-box (~> 0.4.1)
+      tty-color (~> 0.5)
+      tty-command (~> 0.9.0)
+      tty-config (~> 0.3.2)
+      tty-cursor (~> 0.7)
+      tty-editor (~> 0.5)
+      tty-file (~> 0.8.0)
+      tty-font (~> 0.4.0)
+      tty-logger (~> 0.2.0)
+      tty-markdown (~> 0.6.0)
+      tty-pager (~> 0.12)
+      tty-pie (~> 0.3.0)
+      tty-platform (~> 0.2)
+      tty-progressbar (~> 0.17)
+      tty-prompt (~> 0.19)
+      tty-screen (~> 0.7)
+      tty-spinner (~> 0.9)
+      tty-table (~> 0.11.0)
+      tty-tree (~> 0.3)
+      tty-which (~> 0.4)
+    tty-box (0.4.1)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.6)
+      tty-cursor (~> 0.7)
+    tty-color (0.5.1)
+    tty-command (0.9.0)
+      pastel (~> 0.7.0)
+    tty-config (0.3.2)
+    tty-cursor (0.7.1)
+    tty-editor (0.5.1)
+      tty-prompt (~> 0.19)
+      tty-which (~> 0.4)
+    tty-file (0.8.0)
+      diff-lcs (~> 1.3)
+      pastel (~> 0.7.2)
+      tty-prompt (~> 0.18)
+    tty-font (0.4.0)
+    tty-logger (0.2.0)
+      pastel (~> 0.7.0)
+    tty-markdown (0.6.0)
+      kramdown (~> 1.16.2)
+      pastel (~> 0.7.2)
+      rouge (~> 3.3)
+      strings (~> 0.1.4)
+      tty-color (~> 0.4)
+      tty-screen (~> 0.6)
+    tty-pager (0.12.1)
+      strings (~> 0.1.4)
+      tty-screen (~> 0.6)
+      tty-which (~> 0.4)
+    tty-pie (0.3.0)
+      pastel (~> 0.7.3)
+      tty-cursor (~> 0.7)
+    tty-platform (0.3.0)
+    tty-progressbar (0.17.0)
+      strings-ansi (~> 0.1.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      unicode-display_width (~> 1.6)
+    tty-prompt (0.20.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tty-table (0.11.0)
+      equatable (~> 0.6)
+      necromancer (~> 0.5)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.5)
+      tty-screen (~> 0.7)
+    tty-tree (0.4.0)
+    tty-which (0.4.2)
+    unicode-display_width (1.6.1)
+    unicode_utils (1.4.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minesweeprb!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 scudco
+
+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,62 @@
+# Minesweeper
+
+Use clues on the gameboard to deduce locations of mines. Correctly reveal all non-mine squares to win.
+
+## Rules
+A gameboard is composed of a number of squares laid out in a rectangle. 
+
+A square hold either a Clue or a Mine
+
+### Clue Square
+A Clue Square will contain a number representing the numbers of mines that border itself. If the Clue Square has no neighboring mines then it will be blank.
+
+For example, a Clue Square containing a "1" will have exactly one mine in one of the spaces that borders itself.
+There is a mine in exactly one of the ? squares.
+```
+◼ ◼ ◼
+◼ 1 ◼
+◼ ◼ ◼
+```
+
+There are no mines surrounding an empty square. Note: Revealing an empty square will reveal all neighboring Clue Squares automatically. For example revealing the square where '▣' is placed (B2) could result in the gameboard looking something like:
+```
+◼ ◼ ◼ ◼ ◼   ◻ ◻ 1 ◼ ◼
+◼ ▣ ◼ ◼ ◼   ◻ ◻ 1 ◼ ◼
+◼ ◼ ◼ ◼ ◼ → 1 2 2 ◼ ◼
+◼ ◼ ◼ ◼ ◼   ◼ ◼ ◼ ◼ ◼
+◼ ◼ ◼ ◼ ◼   ◼ ◼ ◼ ◼ ◼
+```
+where '◻' is an empty Clue Square.
+
+In the example below, there is a mine in exactly 3 of the ? squares. Because the "3" Clue Square only has three unrevealed spaces bordering itself, it is correct to assume that there is mine in each space.
+```
+3 ◼ ◼   3 ⚑ ◼
+◼ ◼ ◼ → ⚑ ⚑ ◼
+◼ ◼ ◼   ◼ ◼ ◼
+```
+
+### Mine Square
+Mine Squares should not be revealed. If you believe you have found the location of a Mine then you can mark that square to prevent accidentally revealing it.
+
+## Gameboard
+A gameboard contains a Width, Height, and Number of Mines.
+
+The first move is always safe which means a gameboard's Mines are not placed until the first square is revealed.
+
+Since the first is always safe, a gameboard is only valid if the number of mines is less than the total number of squares. A valid gameboard must have more than one square. (i.e., 0 < # of Mines < Width * Height)
+
+## How To Play
+Reveal squares you believe do not contain a Mine.
+
+Your first move will never reveal a Mine.
+
+If you reveal a square that contains a Mine, the game will end.
+
+## How To Win
+Reveal all Clue Squares without revealing a Mine.
+
+### ASCII Reference
+* Flags `⚑`
+* Squares `◻ ◼ ▣`
+* Numbers `➊ ➋ ➌ ➍ ➎ ➏ ➀ ➁ ➂ ➃ ➄ ➅`
+* Mines `☀ ☼ ✺`

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'minesweeprb'
+
+# 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/minesweeprb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'minesweeprb/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Minesweeprb::CLI.start
+rescue Minesweeprb::CLI::Error => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/lib/minesweeprb.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'minesweeprb/version'
+
+module Minesweeprb
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/minesweeprb/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Minesweeprb
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    default_command 'play'
+
+    desc 'version', 'minesweeprb version'
+    def version
+      require_relative 'version'
+      puts "v#{Minesweeprb::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    desc 'play', 'Play Minesweeper'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def play(*)
+      if options[:help]
+        invoke :help, ['play']
+      else
+        require_relative 'commands/play'
+        Minesweeprb::Commands::Play.new(options).execute
+      end
+    end
+  end
+end

data/lib/minesweeprb/command.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Minesweeprb
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+
+    def add_color(str, color)
+      return str if @options['no-color'] || color == :none
+
+      @pastel.decorate(str, color)
+    end
+  end
+end

data/lib/minesweeprb/commands/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/minesweeprb/commands/play.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'pastel'
+require 'tty-reader'
+require 'tty-screen'
+
+require_relative '../command'
+require_relative '../game'
+
+module Minesweeprb
+  module Commands
+    class Play < Minesweeprb::Command
+      VIM_MAPPING = {
+        'k' => :up,
+        'j' => :down,
+        'h' => :left,
+        'l' => :right,
+      }.freeze
+
+      attr_reader :game, :pastel
+
+      def initialize(options)
+        @options = options
+        @pastel = Pastel.new
+      end
+
+      def start_game(output)
+        height, width = 
+
+        sizes = Game::SIZES.map.with_index do |size, index|
+          too_big = size[:height] * 2 > TTY::Screen.height || size[:width] * 2 > TTY::Screen.width
+          disabled = '(screen too small)' if too_big
+          size.merge(
+            value: index,
+            disabled: disabled
+          )
+        end
+
+        size = prompt(interrupt: -> { exit 1 }).select('Size:', sizes, cycle: true)
+        output.print cursor.hide
+        output.print cursor.up(1)
+        output.print cursor.clear_screen_down
+        output.puts
+
+        @game = Minesweeprb::Game.new(size)
+
+        print_gameboard(output)
+      end
+
+      def how_to_play
+        instructions = []
+        instructions << '(←↓↑→ or hjkl) Move' unless game.over?
+        instructions << '(f or ␣)Flag/Mark' if game.started?
+        instructions << '(↵)Reveal' unless game.over?
+        instructions << '(r)Restart'
+        instructions << '(q)Quit'
+        instructions.join('  ')
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        start_game(output)
+
+        reader
+          .on(:keyescape) { exit }
+          .on(:keyalpha) do |event|
+            key = event.value.downcase
+            case key
+            when 'q' then exit
+            when 'r'
+              output.print cursor.clear_screen_down
+              start_game(output)
+            when 'f'
+              unless game.over?
+                game.cycle_flag
+                print_gameboard(output)
+              end
+            when 'j', 'k', 'h', 'l'
+              unless game.over?
+                game.move(VIM_MAPPING[key])
+                print_gameboard(output)
+              end
+            end
+
+          end.on(:keypress) do |event|
+            unless game.over?
+              case event.key.name
+              when :up, :down, :left, :right
+                game.move(event.key.name)
+              when :space
+                game.cycle_flag
+              when :return
+                game.reveal_active_square
+              end
+
+              print_gameboard(output)
+            end
+          end
+
+        loop { reader.read_keypress }
+      end
+
+      def reader
+        @reader ||= TTY::Reader.new
+      end
+
+      def print_gameboard(output)
+        total_height = game.height + game.header.lines.length + 1
+        output.print cursor.clear_lines(total_height, :down)
+        output.print cursor.up(total_height - 2)
+
+        game.header.each_line do |line|
+          chars = line.chars.map do |char|
+            case char
+            when Game::WON_FACE then pastel.bright_yellow(char)
+            when Game::LOST_FACE then pastel.bright_red(char)
+            when Game::PLAYING_FACE then pastel.bright_cyan(char)
+            when Game::MINE then pastel.bright_red(char)
+            when Game::CLOCK then pastel.bright_cyan(char)
+            else
+              char
+            end
+          end
+
+          center(output, chars.join)
+        end
+
+        game.squares.each.with_index do |row, y|
+          line = row.map.with_index do |char, x|
+            char = case char
+                   when Game::FLAG then pastel.bright_red(char)
+                   when Game::MINE
+                     if game.won?
+                       pastel.bright_green(char)
+                     elsif game.active_square == [x,y]
+                       pastel.black.on_bright_red(char)
+                     else
+                       pastel.bright_red(char)
+                     end
+                   when Game::MARK then pastel.bright_magenta(char)
+                   when Game::CLUES[0] then pastel.dim(char)
+                   when Game::CLUES[1] then pastel.blue(char)
+                   when Game::CLUES[2] then pastel.green(char)
+                   when Game::CLUES[3] then pastel.red(char)
+                   when Game::CLUES[4] then pastel.magenta(char)
+                   when Game::CLUES[5] then pastel.black(char)
+                   when Game::CLUES[6] then pastel.bright_red(char)
+                   when Game::CLUES[7] then pastel.bright_white(char)
+                   when Game::CLUES[8] then pastel.bright_cyan(char)
+                   else
+                     char
+                   end
+
+            !game.over? && game.active_square == [x,y] ? pastel.inverse(char): char
+          end.join(' ')
+
+          center(output, line)
+        end
+
+
+        output.print cursor.clear_screen_down
+        output.puts
+
+        if game.won?
+          center(output, pastel.bright_green.bold('☻ YOU WON ☻'))
+          output.puts
+          center(output, how_to_play)
+        elsif game.lost?
+          center(output, pastel.bright_magenta.bold('☹ GAME OVER ☹'))
+          output.puts
+          center(output, how_to_play)
+        else
+          center(output, how_to_play)
+          output.print cursor.up(total_height + 2)
+        end
+      end
+
+      def center(output, line)
+        width = TTY::Screen.width
+        padding = (width - (pastel.strip(line.chomp.strip).length)) / 2
+        output.print(' ' * [padding, 0].max)
+        output.puts line
+      end
+    end
+  end
+end

data/lib/minesweeprb/game.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+require 'pastel'
+
+module Minesweeprb
+  class Game
+    DEFAULT_SIZE = 'Tiny'
+    DEFAULT_MINE_COUNT = 1
+    FLAG = '⚑'
+    SQUARE = '◼'
+    ACTIVE_SQUARE = '▣'
+    MARK = '⍰'
+    CLUES = '◻➊➋➌➍➎➏➐➑'.chars.freeze
+    CLOCK = '◷'
+    MINE = '☀'
+    WON_FACE = '☻'
+    LOST_FACE = '☹'
+    PLAYING_FACE = '☺'
+    SIZES = [
+      {
+        name: 'Tiny',
+        width: 5,
+        height: 5,
+        mines: 3,
+      },
+      {
+        name: 'Small',
+        width: 9,
+        height: 9,
+        mines: 10,
+      },
+      {
+        name: 'Medium',
+        width: 13,
+        height: 13,
+        mines: 15,
+      },
+      {
+        name: 'Large',
+        width: 17,
+        height: 17,
+        mines: 20,
+      },
+      {
+        name: 'Huge',
+        width: 21,
+        height: 21,
+        mines: 25,
+      },
+    ].freeze
+
+    attr_reader :active_square,
+      :flagged_squares,
+      :marked_squares,
+      :mined_squares,
+      :pastel,
+      :revealed_squares,
+      :size,
+      :squares
+
+    def initialize(size)
+      @pastel = Pastel.new
+      @size = SIZES[size]
+      @active_square = center
+      @flagged_squares = []
+      @marked_squares = []
+      @mined_squares = []
+      @revealed_squares = {}
+    end
+
+    def mines
+      size[:mines] - flagged_squares.size
+    end
+
+    def width
+      size[:width]
+    end
+
+    def height
+      size[:height]
+    end
+
+    def center
+      [(width / 2).floor, (height / 2).floor]
+    end
+
+    def time
+      0
+    end
+
+    def move(direction)
+      return if over?
+
+      x, y = @active_square
+
+      case direction
+      when :up then y -= 1
+      when :down then y += 1
+      when :left then x -= 1
+      when :right then x += 1
+      end
+
+      x = x < 0 ? width - 1 : x
+      x = x > width - 1 ? 0 : x
+      y = y < 0 ? height - 1 : y
+      y = y > height - 1 ? 0 : y
+
+      @active_square = [x,y]
+    end
+
+    def face
+      if won?
+        WON_FACE
+      elsif lost?
+        LOST_FACE
+      else
+        PLAYING_FACE
+      end
+    end
+
+    def header
+      "#{MINE} #{mines.to_s.rjust(3, '0')}" \
+      "  #{face}  " \
+      "#{CLOCK} #{time.to_s.rjust(3, '0')}"
+    end
+
+    def cycle_flag
+      return if over? || @revealed_squares.empty? || @revealed_squares.include?(active_square)
+
+      if flagged_squares.include?(active_square)
+        @flagged_squares -= [active_square]
+        @marked_squares += [active_square]
+      elsif marked_squares.include?(active_square)
+        @marked_squares -= [active_square]
+      elsif flagged_squares.length < size[:mines]
+        @flagged_squares += [active_square]
+      end
+    end
+
+    def reveal_active_square
+      return if over? || flagged_squares.include?(active_square)
+
+      reveal_square(active_square)
+    end
+
+    def squares
+      height.times.map do |y|
+        width.times.map do |x|
+          pos = [x,y]
+
+          if mined_squares.include?(pos) && (revealed_squares[pos] || over?)
+            MINE
+          elsif flagged_squares.include?(pos)
+            FLAG
+          elsif marked_squares.include?(pos)
+            MARK
+          elsif revealed_squares[pos]
+            CLUES[revealed_squares[pos]]
+          else
+            SQUARE
+          end
+        end
+      end
+    end
+
+    def started?
+      !over? && revealed_squares.count > 0
+    end
+
+    def won?
+      !lost? && revealed_squares.count == width * height - size[:mines]
+    end
+
+    def lost?
+      (revealed_squares.keys & mined_squares).any?
+    end
+
+    def over?
+      won? || lost?
+    end
+
+    private
+
+    def place_mines
+      size[:mines].times do
+        pos = random_square
+        pos = random_square while pos == active_square || mined_squares.include?(pos)
+        @mined_squares << pos
+      end
+    end
+
+    def random_square
+      x = (1..width).to_a.sample - 1
+      y = (1..height).to_a.sample - 1
+      [x, y]
+    end
+
+    def reveal_square(square)
+      place_mines if revealed_squares.empty?
+      return if revealed_squares.keys.include?(square)
+      return lose! if mined_squares.include?(square)
+
+      value = square_value(square)
+      @revealed_squares[square] = value
+      neighbors(square).each { |neighbor| reveal_square(neighbor) } if value.zero?
+    end
+
+    def lose!
+      @mined_squares.each { |square| @revealed_squares[square] = -1 }
+    end
+
+    def square_value(square)
+      (neighbors(square) & mined_squares).size
+    end
+
+    def neighbors(square)
+      [
+        # top
+        [square[0] - 1, square[1] - 1],
+        [square[0] - 0, square[1] - 1],
+        [square[0] + 1, square[1] - 1],
+
+        # middle
+        [square[0] - 1, square[1] - 0],
+        [square[0] + 1, square[1] - 0],
+
+        # bottom
+        [square[0] - 1, square[1] + 1],
+        [square[0] - 0, square[1] + 1],
+        [square[0] + 1, square[1] + 1],
+      ].select do |x,y|
+        (0...width).include?(x) && (0...height).include?(y)
+      end
+    end
+  end
+end

data/lib/minesweeprb/templates/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/minesweeprb/templates/play/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/minesweeprb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Minesweeprb
+  VERSION = '0.1.0'
+end

data/minesweeprb.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/minesweeprb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minesweeprb'
+  spec.license       = 'MIT'
+  spec.version       = Minesweeprb::VERSION
+  spec.authors       = ['scudco']
+  spec.email         = ['3806+scudco@users.noreply.github.com']
+
+  spec.summary       = 'Terminal-based Minesweeper'
+  spec.homepage      = 'https://github.com/scudco/minesweeper'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'tty', '~> 0.10'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: minesweeprb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- scudco
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- 3806+scudco@users.noreply.github.com
+executables:
+- minesweeprb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/minesweeprb
+- lib/minesweeprb.rb
+- lib/minesweeprb/cli.rb
+- lib/minesweeprb/command.rb
+- lib/minesweeprb/commands/.gitkeep
+- lib/minesweeprb/commands/play.rb
+- lib/minesweeprb/game.rb
+- lib/minesweeprb/templates/.gitkeep
+- lib/minesweeprb/templates/play/.gitkeep
+- lib/minesweeprb/version.rb
+- minesweeprb.gemspec
+homepage: https://github.com/scudco/minesweeper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/scudco/minesweeper
+  source_code_uri: https://github.com/scudco/minesweeper
+  changelog_uri: https://github.com/scudco/minesweeper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Terminal-based Minesweeper
+test_files: []