minesweeper-core 2.0.0

data/lib/minesweeper/core/minefield_solved_error.rb

@@ -0,0 +1,7 @@
+module Minesweeper
+  module Core
+    class MinefieldSolvedError < StandardError
+    end
+  end
+end
+

data/lib/minesweeper/core/version.rb

@@ -0,0 +1,6 @@
+module Minesweeper
+  module Core
+    VERSION = "2.0.0"
+  end
+end
+

data/minesweeper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minesweeper/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minesweeper-core"
+  spec.version       = Minesweeper::Core::VERSION
+  spec.authors       = ["Sebastien Varlet"]
+  spec.email         = ["sebastien.varlet@gmail.com"]
+  spec.summary       = %q{Core model of the minesweeper game.}
+  spec.description   = %q{This gem defines the core classes of a minesweeper game such as Minefield, Cell, and Mine.}
+  spec.homepage      = "https://github.com/svarlet/minesweeper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-test"
+end

data/test/minesweeper/core/elements/cell_state_spy.rb

@@ -0,0 +1,35 @@
+require 'minesweeper/core/elements/cell_state'
+
+module Minesweeper
+  module Core
+    module Elements
+      class CellStateSpy
+        attr_reader :flag_called, :reveal_called, :unflag_called, :to_s_called
+
+        def initialize
+          @flag_called = false
+          @reveal_called = false
+          @unflag_called = false
+          @to_s_called = false
+        end
+
+        def flag(cell)
+          @flag_called = true
+        end
+
+        def reveal(cell)
+          @reveal_called = true
+        end
+
+        def unflag(cell)
+          @unflag_called = true
+        end
+
+        def to_s
+          @to_s_called = true
+        end
+      end
+    end
+  end
+end
+

data/test/minesweeper/core/elements/cell_test.rb

@@ -0,0 +1,82 @@
+require_relative '../../../test_helper.rb'
+require 'minesweeper/core/elements/cell'
+require 'minesweeper/core/elements/hidden_state'
+require 'minesweeper/core/explosives/null_mine'
+require_relative '../elements/cell_state_spy'
+require_relative '../explosives/mine_spy'
+
+module Minesweeper
+  module Core
+    module Elements
+      class CellTest < Test::Unit::TestCase
+        def setup
+          @cell = Cell.new(Explosives::MineSpy.new)
+          @state_spy = CellStateSpy.new
+          @cell.current_state = @state_spy
+        end
+
+        def test_initialize_should_set_current_state_to_hidden
+          assert_equal(CellState::HIDDEN_STATE, Cell.new(Minesweeper::Core::Explosives::MineSpy.new).current_state)
+        end
+
+        def test_flag_should_call_the_flag_method_of_the_current_state
+          @cell.flag
+          assert @state_spy.flag_called
+        end
+
+        def test_reveal_should_call_the_reveal_method_of_the_current_state
+          @cell.reveal
+          assert @state_spy.reveal_called
+        end
+
+        def test_unflag_should_call_the_unflag_method_of_the_current_state
+          @cell.unflag
+          assert @state_spy.unflag_called
+        end
+
+        def test_to_s_should_delegate_to_state
+          @cell.to_s
+          assert @state_spy.to_s_called
+        end
+
+        def test_trigger_should_delegate_to_underlying_mine
+          a_mine_spy = Explosives::MineSpy.new
+          @cell = Cell.new(a_mine_spy)
+          @cell.trigger
+          assert(a_mine_spy.trigger_called)
+        end
+
+        def test_given_a_cell_with_no_mines_when_revealed_then_to_s_returns_mines_around
+          safe_cell = Cell.new(Explosives::NullMine.new, 1)
+          safe_cell.reveal
+          assert_equal('1', safe_cell.to_s)
+        end
+
+        def test_when_a_cell_is_revealed_then_revealed_should_be_true
+          cell = Cell.new(Explosives::NullMine.new, 0)
+          cell.reveal
+          assert_true(cell.revealed?)
+        end
+
+        def test_flagged_is_false_until_cell_is_flagged
+          cell = Cell.new(Explosives::NullMine.new, 0)
+          assert_false(cell.flagged?)
+        end
+
+        def test_flagged_is_false_after_cell_is_unflagged
+          cell = Cell.new(Explosives::NullMine.new, 0)
+          cell.flag
+          cell.unflag
+          assert_false(cell.flagged?)
+        end
+
+        def test_flagged_is_true_after_cell_is_flagged
+          cell = Cell.new(Explosives::NullMine.new, 0)
+          cell.flag
+          assert_true(cell.flagged?)
+        end
+      end
+    end
+  end
+end
+

data/test/minesweeper/core/elements/flagged_state_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../test_helper.rb'
+require 'minesweeper/core/elements/cell'
+require_relative '../explosives/mine_spy'
+
+module Minesweeper
+  module Core
+    module Elements
+      class FlaggedStateTest < Test::Unit::TestCase
+        def setup
+          @mine_spy = Minesweeper::Core::Explosives::MineSpy.new
+          @cell = Cell.new(@mine_spy)
+          @cell.flag
+          @state = CellState::FLAGGED_STATE
+        end
+
+        def test_flag_should_raise_NoMethodError
+          assert_raise(NoMethodError) { @state.flag(@cell) }
+        end
+
+        def test_unflag_should_change_state_of_cell_to_hidden
+          @state.unflag(@cell)
+          assert_equal(CellState::HIDDEN_STATE, @cell.current_state)
+        end
+
+        def test_reveal_should_change_state_of_cell_to_revealed
+          @state.reveal(@cell)
+          assert_equal(CellState::REVEALED_STATE, @cell.current_state)
+        end
+
+        def test_reveal_should_trigger_the_underlying_mine
+          @state.reveal(@cell)
+          assert(@mine_spy.trigger_called)
+        end
+
+        def test_to_s_should_return_F
+          assert_equal("F", @state.to_s)
+        end
+      end
+    end
+  end
+end
+

data/test/minesweeper/core/elements/hidden_state_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../test_helper.rb'
+require 'minesweeper/core/elements/cell'
+require_relative '../explosives/mine_spy'
+
+module Minesweeper
+  module Core
+    module Elements
+      class HiddenStateTest < Test::Unit::TestCase
+        def setup
+          @state = CellState::HIDDEN_STATE
+          @mine_spy = Minesweeper::Core::Explosives::MineSpy.new
+          @cell = Cell.new(@mine_spy)
+        end
+
+        def test_unflag_should_raise_NoMethodError
+          assert_raise(NoMethodError) { @state.unflag(@cell) }
+        end
+
+        def test_flag_should_change_state_of_cell_to_flagged
+          @state.flag(@cell)
+          assert_equal(CellState::FLAGGED_STATE, @cell.current_state)
+        end
+
+        def test_reveal_should_change_state_of_cell_to_revealed
+          @state.reveal(@cell)
+          assert_equal(CellState::REVEALED_STATE, @cell.current_state)
+        end
+
+        def test_reveal_should_trigger_the_underlying_mine
+          @state.reveal(@cell)
+          assert(@mine_spy.trigger_called)
+        end
+
+        def test_to_s_should_return_H
+          assert_equal("H", @state.to_s)
+        end
+      end
+    end
+  end
+end
+

data/test/minesweeper/core/elements/revealed_state_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../../test_helper.rb'
+require 'minesweeper/core/elements/cell'
+require_relative '../explosives/mine_spy'
+
+module Minesweeper
+  module Core
+    module Elements
+      class RevealedStateTest < Test::Unit::TestCase
+        def setup
+          @cell = Cell.new(Minesweeper::Core::Explosives::MineSpy.new)
+          @cell.reveal
+          @state = CellState::REVEALED_STATE
+        end
+
+        def test_flag_should_raise_NoMethodError
+          assert_raise(NoMethodError) { @state.flag(@cell) }
+        end
+
+        def test_reveal_should_raise_cell_state_error
+          assert_raise(NoMethodError) { @state.reveal(@cell) }
+        end
+
+        def test_unflag_should_raise_cell_state_error
+          assert_raise(NoMethodError) { @state.unflag(@cell) }
+        end
+
+        def test_to_s_should_return_R
+          assert_equal("R", @state.to_s)
+        end
+      end
+    end
+  end
+end
+

data/test/minesweeper/core/explosives/mine_coordinates_factory_test.rb

@@ -0,0 +1,57 @@
+require_relative '../../../test_helper'
+require 'minesweeper/core/explosives/mine_coordinates_factory'
+require 'minesweeper/core/explosives/mine_coordinates'
+
+module Minesweeper
+  module Core
+    module Explosives
+      class MineCoordinatesFactoryTest < Test::Unit::TestCase
+        def test_create_should_return_a_pair_of_mine_coordinates
+          sut = MineCoordinatesFactory.new(Random.new)
+          mc = sut.create(1)
+          assert_instance_of(MineCoordinates, mc)
+        end
+
+        def test_create_should_use_the_random_number_generator_to_produce_the_coordinates
+          spy = RandomNumberGeneratorSpy.new
+          sut = MineCoordinatesFactory.new(spy)
+          upper_bound = 20
+
+          mc = sut.create(upper_bound)
+
+          assert_equal(upper_bound, spy.generated_numbers[0].max)
+          assert_equal(mc.row_index, spy.generated_numbers[0].value)
+
+          assert_equal(upper_bound, spy.generated_numbers[1].max)
+          assert_equal(mc.col_index, spy.generated_numbers[1].value)
+        end
+      end
+
+      class RandomNumberGeneratorSpy
+        attr_reader :generated_numbers
+
+        def initialize
+          @generated_numbers = []
+          @random_number_generator = Random.new
+        end
+
+        def rand(max)
+          a_generated_number = RandomNumber.new(max, @random_number_generator.rand(max))
+          @generated_numbers << a_generated_number
+          a_generated_number.value
+        end
+      end
+
+      class RandomNumber
+        attr_reader :max, :value
+
+        def initialize(max, value)
+          @max = max
+          @value = value
+        end
+      end
+    end
+  end
+
+end
+

data/test/minesweeper/core/explosives/mine_coordinates_test.rb

@@ -0,0 +1,37 @@
+require 'minesweeper/core/explosives/mine_coordinates'
+require_relative '../../../test_helper'
+
+module Minesweeper
+  module Core
+    module Explosives
+      class MineCoordinatesTest < Test::Unit::TestCase
+        def test_is_initializable
+          assert_nothing_raised { MineCoordinates.new(0,0) }
+        end
+
+        def test_properties_are_initialized_by_the_constructor
+          mc = MineCoordinates.new(12, 17)
+          assert_equal(12, mc.row_index)
+          assert_equal(17, mc.col_index)
+        end
+
+        def test_immutability
+          mc = MineCoordinates.new(0, 0)
+          assert_raise(NoMethodError) { mc.row_index = 1 }
+          assert_equal(0, mc.row_index)
+          assert_raise(NoMethodError) { mc.col_index = 1 }
+          assert_equal(0, mc.col_index)
+        end
+
+        def test_2_different_objects_with_same_properties_are_equal
+          a = MineCoordinates.new(0, 0)
+          b = MineCoordinates.new(0, 0)
+          assert_equal(a, b)
+          assert_true(a == b)
+        end
+      end
+    end
+  end
+
+end
+

data/test/minesweeper/core/explosives/mine_layer_test.rb

@@ -0,0 +1,109 @@
+require_relative '../../../test_helper'
+require 'minesweeper/core/explosives/mine_layer'
+require 'minesweeper/core/minefield'
+require 'minesweeper/core/explosives/mine_coordinates_factory'
+
+module Minesweeper
+  module Core
+    module Explosives
+      class MineLayerTest < Test::Unit::TestCase
+        MINEFIELD_SIZE = 19
+
+        def setup
+          @minefield = MinefieldSpy.new(MINEFIELD_SIZE)
+          @mine_generator = MineGeneratorSpy.new
+          @sut = MineLayer.new(@minefield, @mine_generator)
+        end
+
+        def test_initialize_requires_a_minefield_and_a_mine_factory
+          assert_raise(ArgumentError) { MineLayer.new(Object.new, nil)}
+          assert_raise(ArgumentError) { MineLayer.new(nil, Object.new)}
+          assert_raise(ArgumentError) { MineLayer.new(nil, nil)}
+          assert_nothing_raised { MineLayer.new(@minefield, MineCoordinatesFactory.new(Random.new)) }
+        end
+
+        def test_lay_1_should_generate_1_mine_within_the_minefield_bounds
+          @sut.lay 1
+          assert_equal(MINEFIELD_SIZE, @mine_generator.create_call_params.pop)
+        end
+
+        def test_lay_2_should_generate_2_mines_within_the_minefield_bounds
+          @sut.lay 2
+          2.times { assert_equal(MINEFIELD_SIZE, @mine_generator.create_call_params.pop) }
+        end
+
+        def test_lay_1_should_lay_a_single_mine_at_random_coordinates
+          @sut.lay 1
+          assert_generated_mines_were_laid(1)
+        end
+
+        def assert_generated_mines_were_laid(quantity)
+          assert_equal(quantity, @mine_generator.generated_mines.length)
+          assert_equal(quantity, @minefield.mines_laid.length)
+          quantity.times { assert_equal(@mine_generator.generated_mines.pop, @minefield.mines_laid.pop) }
+        end
+
+        def test_lay_2_mines_should_lay_exactly_2_mines_at_random_coordinates
+          @sut.lay 2
+          assert_generated_mines_were_laid(2)
+        end
+
+        def test_lay_should_never_lay_2_mine_at_the_same_coordinates
+          a_mine = MineCoordinates.new(1, 1)
+          same_mine = MineCoordinates.new(1, 1)
+          different_mine = MineCoordinates.new(1, 2)
+          dummy_mine_generator = DummyMineGenerator.new([a_mine, same_mine, different_mine])
+          sut = MineLayer.new(@minefield, dummy_mine_generator)
+
+          sut.lay(2)
+
+          assert_equal(@minefield.mines_laid, [a_mine, different_mine])
+        end
+      end
+
+      class MinefieldSpy
+        attr_reader :mines_laid
+        attr_reader :row_count
+
+        def initialize(row_count)
+          @mines_laid = []
+          @row_count = row_count
+        end
+
+        def hide_mine_at(x, y)
+          @mines_laid << MineCoordinates.new(x, y)
+        end
+      end
+
+      class MineGeneratorSpy < MineCoordinatesFactory
+        attr_reader :generated_mines
+        attr_reader :create_call_params
+
+        def initialize
+          super Random.new
+          @generated_mines = []
+          @create_call_params = []
+        end
+
+        def create(max)
+          @create_call_params << max
+          a_mine = super(max)
+          @generated_mines << a_mine
+          a_mine
+        end
+      end
+
+      class DummyMineGenerator < MineCoordinatesFactory
+        def initialize(preconstructed_mines)
+          @preconstructed_mines = preconstructed_mines
+        end
+
+        def create(max)
+          @preconstructed_mines.shift
+        end
+      end
+    end
+  end
+
+end
+