minesweeper-cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d710c1e40315619906f82b3bebbc4f1308f90419
+  data.tar.gz: 32cb01b79aac187fc8f87841fd1cc6e490e8dab1
+SHA512:
+  metadata.gz: cb1541c26f02d2d359f2b3176cf92a65f21df84fdf0af035ab24a02fcc0ab99531a19d796460791d56cbcb2e7c8b845092b1c926c1795c140e3dd38c31413814
+  data.tar.gz: ac3e40e003347843b8ee3690a5921b15d0120939d104ae6228505f3bec948f8ff20c88dafb5ec190f5433696cbc4a6fe322020b538c4a80c54fbc97d9f86881d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+*orig
+*.gem
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daniel Cruz Horts
+
+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,43 @@
+A minimalistic Ruby implementation for the classic minesweeper [game](https://en.wikipedia.org/wiki/Minesweeper_(video_game)).
+
+In case you don't know, the objective is to reveal the content of all the squares without a mine.
+
+# Installation
+
+It comes conveniently packaged as a gem:
+
+`gem install minesweeper-cli`
+
+
+# How to launch the game
+
+From the command line:
+
+`./minesweeper`
+
+To get some help and options:
+
+`./minesweeper -h`
+
+By default it's a 10x5 grid, with 3 hidden mines.
+
+# How to play
+
+Enter the position of the square you want to reveal, by typing the coordinates Y and X. Eg:
+
+`2,3`
+
+…and press enter.
+
+The origin `0, 0` is at the leftmost top corner, marked in the diagram below as `O`.
+And `2, 3` would be the square marked as `X`:
+
+```
+O....
+.....
+...X.
+.....
+```
+
+The game ends either once you reveal all the squares, or hit a mine.
+In any case, the program ends and you'll be notified in [Engrish](http://knowyourmeme.com/memes/a-winner-is-you).

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/minesweeper

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'minesweeper'
+
+options = {
+  display_set: :emoji,
+  mine_number: 3,
+  rows:        5,
+  cols:        10,
+}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = 'Usage: minesweeper [OPTIONS]'
+  opt.separator ''
+  opt.separator 'Options'
+
+  opt.on('-d', '--display_set SET', 'display the playfield using text or emoji (default)') do |display_set|
+    options[:display_set] = display_set.to_sym
+  end
+
+  opt.on('-m', '--mine_number NUMBER', 'number of mines') do |mine_number|
+    options[:mine_number] = mine_number.to_i
+  end
+
+  opt.on('-r', '--rows NUMBER', 'number of rows') do |rows|
+    options[:rows] = rows.to_i
+  end
+
+  opt.on('-c', '--cols NUMBER', 'number of columns') do |cols|
+    options[:cols] = cols.to_i
+  end
+
+  opt.on('-h', '--help', 'this message') do |environment|
+    puts opt_parser
+    exit
+  end
+end
+opt_parser.parse!
+
+Minesweeper::Game.new(options).play

data/lib/minesweeper.rb

@@ -0,0 +1,2 @@
+require 'minesweeper/version'
+require 'minesweeper/game'

data/lib/minesweeper/game.rb

@@ -0,0 +1,37 @@
+require_relative 'playfield'
+
+module Minesweeper
+  class Game
+    def initialize(options)
+      @playfield = Playfield.new(**options)
+    end
+
+    def play
+      @playfield.display
+
+      loop do
+        puts "Enter position to reveal as: y, x"
+        input = STDIN.gets.strip
+
+        if input.include? ','
+          y, x = input.split(',').map &:to_i
+
+          puts
+          if @playfield.has_mine?(y, x)
+            @playfield.display_with_mines
+            puts "\n\nLose!"
+            exit 1
+          end
+          @playfield.reveal_square(y, x)
+
+          if @playfield.all_squares_revealed?
+            @playfield.display_with_mines
+            puts "\n\nThe winner is you!"
+            exit
+          end
+          @playfield.display
+        end
+      end
+    end
+  end
+end

data/lib/minesweeper/playfield.rb

@@ -0,0 +1,90 @@
+require 'set'
+require_relative 'square'
+
+module Minesweeper
+  class Playfield
+
+    def initialize(display_set:, mine_number:, rows:, cols:)
+      @display_set = display_set
+      @mine_number = mine_number
+      @rows = rows
+      @cols = cols
+
+      @revealed_squares = Set.new
+      @mines = Set.new
+      @playfield = Array.new(rows) { Array.new(cols) }
+
+      until mine_number.zero?
+        mine_position = [rand(rows), rand(cols)]
+        unless @mines.include?(mine_position)
+          @mines << mine_position
+          mine_number -= 1
+        end
+      end
+    end
+
+    def display
+      @playfield.each do |row|
+        puts row.map { |content| Square.new(@display_set).display(content) }.join
+      end
+    end
+
+    def display_with_mines
+      @mines.each do |mine|
+        y, x = mine
+        @playfield[y][x] = true
+      end
+      display
+    end
+
+    def has_mine?(y, x)
+      @mines.include?([y, x])
+    end
+
+    def mines_around(y, x)
+      count = 0
+      (-1).upto(1).each do |dx|
+        (-1).upto(1).each do |dy|
+          next if dx.zero? && dy.zero?
+          next if x + dx < 0
+          next if y + dy < 0
+          next if x + dx >= @cols
+          next if y + dy >= @rows
+
+          if has_mine?(y + dy, x + dx)
+            count += 1
+          end
+        end
+      end
+
+      count
+    end
+
+    def all_squares_revealed?
+      @playfield.flatten.select(&:nil?).size == @mine_number
+    end
+
+    def reveal_adjacent(y, x)
+      (-1).upto(1).each do |dx|
+        (-1).upto(1).each do |dy|
+          next if dx.zero? && dy.zero?
+          next if x + dx < 0
+          next if y + dy < 0
+          next if x + dx >= @cols
+          next if y + dy >= @rows
+
+          reveal_square(y + dy, x + dx)
+        end
+      end
+    end
+
+    def reveal_square(y, x)
+      number_mines_around = mines_around(y, x)
+      @playfield[y][x] = number_mines_around
+      if number_mines_around.zero? && !@revealed_squares.include?([y, x])
+        @revealed_squares << [y, x]
+        reveal_adjacent(y, x)
+      end
+    end
+  end
+end

data/lib/minesweeper/square.rb

@@ -0,0 +1,44 @@
+module Minesweeper
+  class Square
+    TEXT_SET = {
+      nil => '.',
+      0   => '0',
+      1   => '1',
+      2   => '2',
+      3   => '3',
+      4   => '4',
+      5   => '5',
+      6   => '6',
+      7   => '7',
+      8   => '8',
+      true => 'X',
+    }
+
+    EMOJI_SET = {
+      nil => ' ✴️',
+      0   => ' ✅',
+      1   => ' 1️⃣',
+      2   => ' 2️⃣',
+      3   => ' 3️⃣',
+      4   => ' 4️⃣',
+      5   => ' 5️⃣',
+      6   => ' 6️⃣',
+      7   => ' 7️⃣',
+      8   => ' 8️⃣',
+      true => ' 💣',
+    }
+
+    CHARACTER_SETS = {
+      emoji: EMOJI_SET,
+      text:  TEXT_SET,
+    }
+
+    def initialize(set = :emoji)
+      @character_set = CHARACTER_SETS[set]
+    end
+
+    def display(content)
+      @character_set[content]
+    end
+  end
+end

data/lib/minesweeper/version.rb

@@ -0,0 +1,3 @@
+module Minesweeper
+  VERSION = '1.0.0'
+end

data/minesweeper-cli.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minesweeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minesweeper-cli'
+  spec.version       = Minesweeper::VERSION
+  spec.authors       = ['Daniel Cruz Horts']
+  spec.summary       = %q{A command line, text/emoji minesweeper implementation in Ruby!}
+  spec.homepage      = 'https://github.com/dncrht/minesweeper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: minesweeper-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Cruz Horts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 
+email: 
+executables:
+- minesweeper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/minesweeper
+- lib/minesweeper.rb
+- lib/minesweeper/game.rb
+- lib/minesweeper/playfield.rb
+- lib/minesweeper/square.rb
+- lib/minesweeper/version.rb
+- minesweeper-cli.gemspec
+homepage: https://github.com/dncrht/minesweeper
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A command line, text/emoji minesweeper implementation in Ruby!
+test_files: []
+has_rdoc: