game_board 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in game_board.gemspec
+gemspec
+gem 'rspec', :require => 'spec'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthew Powers, Elliot Shiu
+
+MIT License
+
+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 @@
+## GameBoard
+
+This class helps calculate the rows, columns, diagonals, and diagonals of a coordinate for nested array data structures.  It is useful for games like Tic-Tac-Toe, Connect Four, Battleship, etc.
+
+## Getting Started
+
+You can add GameBoard to your Gemfile with:
+
+```ruby
+gem 'game_board'
+```
+  
+Run the bundle command afterwards to install the gem.
+
+## Usage
+
+Create a new 4x3 game board:
+
+```ruby
+board = GameBoard.new(4,3)
+```
+
+Populate the game board with numbers:
+
+```ruby
+cells = [[1, 2, 3], [4, 5, 6], [7, 8, 9], [10, 11, 12]]
+board.set_grid(cells)
+```
+
+Get or set a value at a coordinate (row_index, column_index):
+
+```ruby
+board.get_cell(0,0) => 1
+board.set_cell(0,0, 'X')
+board.get_cell(0,0) => X 
+```
+
+Get the two diagonals at a coordinate:
+
+```ruby
+board.coordinate_diagonals(2, 2) => [[1, 5, 9], [9, 11]]
+```
+
+Get all diagonals in the grid:
+
+```ruby
+board.diagonals
+```
+
+Get a row or column:
+
+```ruby
+board.row(1) => [4, 5, 6]
+board.column(2) => [3, 6, 9, 12]
+```
+
+Get all rows or columns:
+
+```ruby
+board.rows
+board.columns
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/game_board.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/game_board/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matthew Powers", "Elliot Shiu"]
+  gem.email         = ["matthewkevinpowers@gmail.com", "elliot@sandbochs.com"]
+  gem.description   = %q{This is a GameBoard class with methods to help analyze the grid.}
+  gem.summary       = %q{A class to represent game boards}
+  gem.homepage      = "https://github.com/MrPowers/GameBoard"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "game_board"
+  gem.require_paths = ["lib"]
+  gem.version       = GameBoard::VERSION
+end

data/lib/game_board/version.rb

@@ -0,0 +1,3 @@
+class GameBoard
+  VERSION = "0.0.1"
+end

data/lib/game_board.rb

@@ -0,0 +1,89 @@
+require 'game_board/version'
+
+class GameBoard
+  attr_reader :grid, :number_of_rows, :number_of_columns
+
+  def initialize(number_of_rows, number_of_columns)
+    @grid = Array.new(number_of_rows) { Array.new(number_of_columns) }
+    @number_of_rows = number_of_rows
+    @number_of_columns = number_of_columns
+  end
+
+  def set_grid(new_grid)
+    grid.replace(new_grid)
+  end
+
+  def get_cell(row_index, column_index)
+    grid[row_index][column_index]
+  end
+
+  def set_cell(row_index, column_index, value)
+    grid[row_index][column_index] = value
+  end
+
+  def row(row_index)
+    grid[row_index]
+  end
+
+  def rows
+    grid
+  end
+
+  def column(column_index)
+    columns[column_index]
+  end
+
+  def columns
+    grid.transpose
+  end
+
+  # returns the two diagonals from one coordinate
+  def coordinate_diagonals(row_index, column_index)
+    [diagonal_from_coordinate(row_index, column_index, grid),
+     diagonal_from_coordinate(row_index, column_index_reflected_about_y_axis(column_index), grid_reflected_about_y_axis)]
+  end
+  # returns all possible diagonals from the grid
+  def diagonals
+    down_right_diagonals(grid) + down_right_diagonals(grid_reflected_about_x_axis)
+  end
+
+  def to_s
+    grid.collect{ |row| row.to_s }.join("\n")
+  end
+
+  private
+
+  # returns the down-right diagonal from a coordinate
+  def diagonal_from_coordinate(row_index, column_index, grid_array)
+    row_index < column_index ? lower = row_index : lower = column_index
+    down_right_diagonal(row_index - lower, column_index - lower, grid_array)
+  end
+
+  def column_index_reflected_about_y_axis(column_index)
+    number_of_columns - column_index - 1
+  end
+
+  def down_right_diagonal(row_index, column_index, grid_array)
+    diag = []
+    while (row_index < number_of_rows) && (column_index < number_of_columns)
+      diag << grid_array[row_index][column_index]
+      row_index += 1
+      column_index += 1
+    end
+    diag
+  end
+
+  def down_right_diagonals(grid_array)
+    number_of_rows.times.map { |row_index| down_right_diagonal(row_index, 0, grid_array) } +
+    number_of_columns.times.map { |column_index| down_right_diagonal(1, column_index, grid_array)}
+  end
+
+  def grid_reflected_about_y_axis
+    grid.map { |row| row.reverse }
+  end
+
+  def grid_reflected_about_x_axis
+    grid.reverse
+  end
+
+end

data/spec/game_board_spec.rb

@@ -0,0 +1,62 @@
+require_relative '../lib/game_board'
+
+describe GameBoard do
+  
+  let(:board) { GameBoard.new(4, 3) }
+  let(:grid) { [[1, 2, 3], 
+                [4, 5, 6], 
+                [7, 8, 9], 
+                [10, 11, 12]] }
+  before do 
+    board.set_grid(grid)
+  end
+
+  context "#set_grid" do
+    it "sets a new grid for the game board" do
+      new_grid = [[1, 1, 1],[2, 2, 2],[3, 3, 3],[4, 4, 4]]
+      expect { board.set_grid(new_grid) }.to change { board.grid }.from([[1, 2, 3],[4, 5, 6], [7, 8, 9], [10, 11, 12]]).to([[1, 1, 1],[2, 2, 2],[3, 3, 3],[4, 4, 4]])
+    end
+  end
+
+  context "#get_cell" do
+    it { board.get_cell(0, 2).should eq 3 }
+  end
+
+  context "#set_cell" do
+    it "sets a cell at a coordinate" do
+      expect { board.set_cell(1, 1, "BOB")}.to change { board.get_cell(1, 1) }.from(5).to("BOB")
+    end
+  end
+
+  context '#row' do
+    it { board.row(1).should eq [4, 5, 6] }
+  end
+
+  context '#rows' do
+    it { board.rows.should eq [[1, 2, 3], [4, 5, 6], [7, 8, 9], [10, 11, 12]] }
+  end
+
+  context '#column' do
+    it { board.column(2).should eq [3, 6, 9, 12] }
+  end
+
+  context '#columns' do
+    it "calculate all columns" do
+      board.columns === ([[1, 2, 7, 10], [2, 5, 8, 11], [3, 6, 9, 12]])
+    end
+  end
+
+  context "#coordinate_diagonals" do
+    it { board.coordinate_diagonals(0, 0).should eq [[1, 5, 9], [1]] }
+    it { board.coordinate_diagonals(1, 1).should eq [[1, 5, 9], [3, 5, 7]] }
+    it { board.coordinate_diagonals(2, 2).should eq [[1, 5, 9], [9, 11]] }  
+  end
+
+  context '#diagonals' do
+    it 'calculates all diagonals' do 
+      board.diagonals ===  [[10], [7, 11], [4, 8, 12], [1, 5, 9], [2, 6], [3], 
+                  [1], [4, 2], [7, 5, 3], [10, 8, 6], [11, 9], [12]]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: game_board
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Powers
+- Elliot Shiu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies: []
+description: This is a GameBoard class with methods to help analyze the grid.
+email:
+- matthewkevinpowers@gmail.com
+- elliot@sandbochs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- game_board.gemspec
+- lib/game_board.rb
+- lib/game_board/version.rb
+- spec/game_board_spec.rb
+homepage: https://github.com/MrPowers/GameBoard
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A class to represent game boards
+test_files:
+- spec/game_board_spec.rb