boardgame 0.0.1 → 0.0.2

data/lib/boardgame.rb

@@ -0,0 +1,5 @@
+module BoardGame
+end
+require_relative 'boardgame/piece'
+require_relative 'boardgame/tile'
+require_relative 'boardgame/map'

data/lib/{map.rb → boardgame/map.rb}

@@ -4,7 +4,7 @@
 #| 1..#.   | with a piece
 #| Y       | placed in (2, 1)
 #`---------'
-class Map
+class BoardGame::Map
 
   attr_reader :tiles, :height, :width
 
@@ -22,7 +22,7 @@ class Map
   # Sets a tile for a given X/Y coord.
   def []=(x, y, tile)
     validate_coords(x, y)
-    raise 'needs to be a tile' unless tile.is_a? Tile
+    raise 'needs to be a tile' unless tile.is_a? BoardGame::Tile
     @tiles[x][y] = tile.move_to(x, y, self)
   end
 
@@ -49,7 +49,7 @@ private
     0.upto(max_x) do |wd|
       @tiles[wd] = {}
       0.upto(max_y) do |ht|
-        self[wd, ht] = Tile.new({})
+        self[wd, ht] = BoardGame::Tile.new({})
       end
     end
   end

data/lib/{piece.rb → boardgame/piece.rb}

@@ -1,9 +1,9 @@
 # A piece on the board.
-class Piece
+class BoardGame::Piece
   attr_accessor :tile
 
   def move_to(new_tile)
-    raise 'that isnt a tile' unless new_tile.is_a? Tile
+    raise 'that isnt a tile' unless new_tile.is_a? BoardGame::Tile
     @tile.remove self if @tile
     @tile = new_tile
     @tile << self

data/lib/{tile.rb → boardgame/tile.rb}

@@ -1,5 +1,5 @@
 # A single tile on the map/board.
-class Tile
+class BoardGame::Tile
 
   attr_accessor :content, :x, :y, :map
 

data/readme.md

@@ -0,0 +1,36 @@
+# Ruby 'boardgame' Gem
+
+This library provides three classes for controlling logic in board games.
+
+ * Create, move and track game pieces across tiles on a board
+ * Automatic validation and boundary checking
+
+# Installation
+
+ 1. `gem install boardgame`
+ 2. `require 'boardgame'`
+ 3. See usage instructions below
+
+##Creating boards, pieces and tiles
+
+```ruby
+require 'boardgame'
+# Create a 5x5 map.
+map    = BoardGame::Map.new(5, 5)
+
+# Get tiles
+home_tile = map[2, 2]
+# => #<BoardGame::Tile 0x123>
+
+# Make a game piece
+knight = BoardGame::Piece.new
+
+#Put a piece on the board
+home_tile << knight
+
+#Move the game piece
+knight.move_to map[0, 0]
+
+#remove from the board
+home_tile.remove(knight)
+```

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require "simplecov"
 SimpleCov.start
+require_relative '../lib/boardgame'
 require 'minitest/autorun'
-require_relative '../lib/game'
 require 'pry'

data/test/test_map.rb

@@ -1,9 +1,9 @@
-require "test_helper"
+require_relative "test_helper"
 
 class TestMap < Minitest::Test
 
   def map
-    @map ||= Map.new(4, 4)
+    @map ||= BoardGame::Map.new(4, 4)
   end
 
   def test_new
@@ -25,34 +25,34 @@ class TestMap < Minitest::Test
   end
 
   def test_set_tile
-    map[1, 2] = Tile.new()
-    assert map[1,2].is_a?(Tile),
+    map[1, 2] = BoardGame::Tile.new()
+    assert map[1,2].is_a?(BoardGame::Tile),
       "Could not set tile on map."
     assert_raises RuntimeError do
       map[1, 2] = "Not a tile"
     end
     assert_raises RuntimeError do
-      map[11, 4] = Tile.new
+      map[11, 4] = BoardGame::Tile.new
     end
     assert_raises RuntimeError do
-      map[4, 11] = Tile.new
+      map[4, 11] = BoardGame::Tile.new
     end
   end
 
   def test_get_tile
-    assert map[0, 1].is_a?(Tile),
+    assert map[0, 1].is_a?(BoardGame::Tile),
       "Lookups of tiles should return Tile."
-    map[1, 2] = Tile.new
-    assert map[1,2].is_a?(Tile),
+    map[1, 2] = BoardGame::Tile.new
+    assert map[1,2].is_a?(BoardGame::Tile),
       "Could not set tile on map."
     assert_equal map[0,0].map, map,
       "Tile did not know where that it was owned by map `map`."
   end
 
   def test_inspect
-    map[0, 0]   = Tile.new
-    map[3, 3]   = Tile.new
-    map[2, 1] << Piece.new
+    map[0, 0]   = BoardGame::Tile.new
+    map[3, 3]   = BoardGame::Tile.new
+    map[2, 1]  << BoardGame::Piece.new
     expectation = "\n"\
                   "□□□□\n"\
                   "□□+□\n"\
@@ -61,4 +61,10 @@ class TestMap < Minitest::Test
     assert_equal map.inspect, expectation,
       "Maps dont look right in console."
   end
+
+  def test_validate_height
+    assert_raises RuntimeError do
+      BoardGame::Map.new "1", 1
+    end 
+  end
 end

data/test/test_piece.rb

@@ -0,0 +1,24 @@
+require_relative "test_helper"
+
+class TestPiece < Minitest::Test
+  def setup
+    @map   = BoardGame::Map.new(5, 5)
+    @piece = BoardGame::Piece.new
+  end
+
+  def test_inspect
+    assert @piece.inspect == "+"
+  end
+
+  def test_move_to
+    assert_raises RuntimeError do
+      @piece.move_to [2, 2]
+    end
+    result = @piece.move_to @map[2,2]
+    assert @piece.tile == @map[2, 2]
+    assert @map[2,2].content.first == @piece
+    assert result == @piece
+    @piece.move_to @map[2,2]
+    assert @piece.tile == @map[2,2]
+  end
+end

data/test/test_tile.rb

@@ -1,16 +1,57 @@
-require "test_helper"
+require_relative "test_helper"
 
 class TestTile < Minitest::Test
   def test_new
-    assert Tile.new.is_a?(Tile),
+    assert BoardGame::Tile.new.is_a?(BoardGame::Tile),
       "Expected new tile to be."
   end
 
   def test_insertion
-    tile  = Tile.new
-    piece = Piece.new
+    tile  = BoardGame::Tile.new
+    piece = BoardGame::Piece.new
     tile << piece
     assert tile.content.first == piece,
       "Did not put piece on tile."
   end
+
+  def test_removal
+    tile  = BoardGame::Tile.new
+    piece = BoardGame::Piece.new
+    tile << piece
+    assert tile.content.first == piece,
+      "Did not put piece on tile."
+    tile.remove(piece)
+    assert tile.content.length == 0,
+      "Unable to remove pieces from tiles."
+  end
+
+  def test_inspect
+    tile  = BoardGame::Tile.new
+    assert tile.inspect == "□",
+      "Expected empty tile to show □"
+    piece = BoardGame::Piece.new
+    tile << piece
+    assert tile.inspect == piece.inspect,
+      "Expected occupied tiles to show top piece when inspected."
+  end
+
+  def test_move_to
+    map   = BoardGame::Map.new(2, 2)
+    tile  = map[0, 0]
+    piece = BoardGame::Piece.new
+    tile << piece
+    assert piece.tile == tile
+    assert tile.x == 0
+    assert tile.y == 0
+    assert tile.map == map
+    new_map = BoardGame::Map.new(2, 2)
+    tile.move_to(1, 1, new_map)
+    assert piece.tile == tile
+    assert tile.x == 1
+    assert tile.y == 1
+    assert tile.map == new_map
+    assert_raises RuntimeError do
+      tile.move_to(2, 2)
+    end 
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boardgame
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rick Carlino
@@ -17,7 +17,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .DS_Store
+- .gitignore
 - Rakefile
+- boardgame.gemspec
 - coverage/.last_run.json
 - coverage/.resultset.json
 - coverage/assets/0.8.0/application.css
@@ -45,13 +47,14 @@ files:
 - coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png
 - coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png
 - coverage/index.html
-- lib/game.rb
-- lib/map.rb
-- lib/piece.rb
-- lib/tile.rb
+- lib/boardgame.rb
+- lib/boardgame/map.rb
+- lib/boardgame/piece.rb
+- lib/boardgame/tile.rb
 - readme.md
 - test/test_helper.rb
 - test/test_map.rb
+- test/test_piece.rb
 - test/test_tile.rb
 homepage: http://github.com/rickcarlino/shiny-octo-nemesis
 licenses:
@@ -76,8 +79,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Generate a Rails app using debatable best practices.
+summary: Control logic for board and tile based games using Ruby.
 test_files:
 - test/test_helper.rb
 - test/test_map.rb
+- test/test_piece.rb
 - test/test_tile.rb

data/lib/game.rb

@@ -1,3 +0,0 @@
-require_relative 'piece'
-require_relative 'tile'
-require_relative 'map'