threesmodel 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 957115b434fa33462e405bee92fa5d888674a0ca
+  data.tar.gz: 5b7a6860503769c440c8218678f4324bb793a033
+SHA512:
+  metadata.gz: fe6510bb2b3bb1336fdb24e9d1e7e36e1cc71e522ffc6aec469ecf9d276c12f41a825e428346a3c92d2ab68ae2ba940b391b8330eef7dcf176707360bf09d9bd
+  data.tar.gz: 231be835a76ee3e4ba4e8c091f556ade7611abeccab1db1216970bcf1920d797e084d5d24643b756bdd28ea859f20f5080082752a8893e08f9d5836a4d541f3a

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in threesmodel.gemspec
+gemspec
+
+gem 'rspec'
+gem 'rspec-mocks'
+gem 'cucumber'
+gem 'fivemat'
+gem 'fuubar'
+gem 'histogram'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Måns Sandström
+
+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,51 @@
+# Threesmodel
+
+This is an attempt at emulating the game model of the excellent game "Threes".
+It is implemented in Ruby and specified with Gehrkin and rspec examples.
+The gem is not indended to be a game in it self, but with relative ease one
+could use it as the game engine for a command line or a web version of the game.
+It supports playing multiple games simultaneously.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'threesmodel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install threesmodel
+
+## Usage
+
+Creating and playing a basic game works like this:
+
+require 'threesmodel'
+game_controller = Threesmodel::GameController.new
+game_state = game_controller.start_new_game
+
+The game state object is a hash with the keys :id (the identifier of the game),
+:game the layout of the current game board (as an instance of a Matrix class),
+:game_over (boolean that denotes whether the game is over or not),
+:next_number states the number to be added after the next fold and
+:score that states the current score.
+
+Play by issuing fold calls to the game controller identifying the game with the id like this:
+
+game_state = game_controller.fold_left(game_state[:id])
+game_state = game_controller.fold_right(game_state[:id])
+game_state = game_controller.fold_up(game_state[:id])
+game_state = game_controller.fold_down(game_state[:id])
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+
+  #t.cucumber_opts = '--format Fivemat'
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = '--format Fivemat'
+end
+
+RSpec::Core::RakeTask.new(:htmlspec) do |t|
+  t.rspec_opts = '--format html --out reports/rspec_results.html'
+end
+
+task :default => :spec
+
+task :test => [:cucumber, :spec]
+
+namespace :rspec_report do
+  desc 'Run all specs, generate RSpec report and open it in the browser'
+  task :browser do
+    Rake::Task[:htmlspec].invoke
+    `open reports/rspec_results.html` # This only works if running OS X.
+  end
+end

data/features/basic_folding.feature

@@ -0,0 +1,66 @@
+Feature: The start situation is playable and 1's fold into 2's to create 3's.
+Scenario: I have just started a game. The board is full of small numbers and empty cells.
+
+  Given a gameboard
+  |0|1|2|0|
+  |0|1|2|0|
+  |0|1|2|0|
+  |0|1|2|0|
+  When the game is folded right to left
+  Then the gameboard looks like
+  |1|2|0|0|
+  |1|2|0|0|
+  |1|2|0|0|
+  |1|2|0|0|
+
+Scenario: I am folding ones and twos in a fairly empty board
+  Given a gameboard
+  |1|2|0|0|
+  |1|2|0|0|
+  |1|2|0|0|
+  |1|2|0|0|
+  When the game is folded right to left
+  Then the gameboard looks like
+  |3|0|0|0|
+  |3|0|0|0|
+  |3|0|0|0|
+  |3|0|0|0|
+
+Scenario: I am folding right over zeros
+  Given a gameboard
+  |1|2|0|0|
+  |1|2|0|0|
+  |1|2|0|0|
+  |1|2|0|0|
+  When the game is folded left to right
+  Then the gameboard looks like
+  |0|1|2|0|
+  |0|1|2|0|
+  |0|1|2|0|
+  |0|1|2|0|
+
+Scenario: I am folding up over zeros
+  Given a gameboard
+  |0|0|0|0|
+  |2|2|2|2|
+  |1|1|1|1|
+  |0|0|0|0|
+  When the game is folded upwards
+  Then the gameboard looks like
+  |2|2|2|2|
+  |1|1|1|1|
+  |0|0|0|0|
+  |0|0|0|0|
+
+Scenario: I am folding down over zeros
+  Given a gameboard
+  |0|0|0|0|
+  |2|2|2|2|
+  |1|1|1|1|
+  |0|0|0|0|
+  When the game is folded downwards
+  Then the gameboard looks like
+  |0|0|0|0|
+  |0|0|0|0|
+  |2|2|2|2|
+  |1|1|1|1|

data/features/basic_summing.feature

@@ -0,0 +1,82 @@
+Feature: The start situation is playable and equal numbers fold to create new, double numbers.
+Scenario: Threes will fold into sixes.
+  Given a gameboard
+  |0| 0|0|0|
+  |0| 0|0|0|
+  |3| 6|0|0|
+  |3|12|2|0|
+  When the game is folded downwards
+  Then the gameboard looks like
+  |0| 0|0|0|
+  |0| 0|0|0|
+  |0| 6|0|0|
+  |6|12|2|0|
+
+Scenario: Equal numbers in several lines
+  Given a gameboard
+  |1|2| 0| 0|
+  |1|2| 0| 0|
+  |3|6|12|24|
+  |3|6|12|24|
+  When the game is folded downwards
+  Then the gameboard looks like
+  |0| 0| 0| 0|
+  |1| 2| 0| 0|
+  |1| 2| 0| 0|
+  |6|12|24|48|
+
+Scenario: Equal numbers in the middle of the line
+  Given a gameboard
+  |6|2| 3| 0|
+  |6|3|12|24|
+  |6|3|12|24|
+  |3|6| 3| 3|
+  When the game is folded downwards
+  Then the gameboard looks like
+  | 0|0| 0| 0|
+  | 6|2| 3| 0|
+  |12|6|24|48|
+  | 3|6| 3| 3|
+
+Scenario: Fold an unanimous matrix completely
+  Given a gameboard
+  |12|12|12|12|
+  |12|12|12|12|
+  |12|12|12|12|
+  |12|12|12|12|
+  When the game is folded downwards
+  Then the gameboard looks like
+  | 0| 0| 0| 0|
+  |12|12|12|12|
+  |12|12|12|12|
+  |24|24|24|24|
+  When the game is folded downwards
+  Then the gameboard looks like
+  | 0| 0| 0| 0|
+  | 0| 0| 0| 0|
+  |24|24|24|24|
+  |24|24|24|24|
+  When the game is folded downwards
+  Then the gameboard looks like
+  | 0| 0| 0| 0|
+  | 0| 0| 0| 0|
+  | 0| 0| 0| 0|
+  |48|48|48|48|
+  When the game is folded right
+  Then the gameboard looks like
+  |0| 0| 0| 0|
+  |0| 0| 0| 0|
+  |0| 0| 0| 0|
+  |0|48|48|96|
+  When the game is folded right
+  Then the gameboard looks like
+  |0|0| 0| 0|
+  |0|0| 0| 0|
+  |0|0| 0| 0|
+  |0|0|96|96|
+  When the game is folded right
+  Then the gameboard looks like
+  |0|0|0|  0|
+  |0|0|0|  0|
+  |0|0|0|  0|
+  |0|0|0|192|

data/features/game_over.feature

@@ -0,0 +1,18 @@
+Feature: A game ends when there is no foldable line.
+Scenario: An unfoldable game board means that the game is over.
+  Given an unfoldable game board
+  Then the game is over
+
+Scenario: A foldable game board means that the game continues.
+  Given a foldable game board
+  Then the game continues
+
+Scenario: A game board that folds in only one direction means that the game continues.
+  Given a game board that only folds left and up
+  Then the game continues
+  Given a game board that only folds left and down
+  Then the game continues
+  Given a game board that only folds right and up
+  Then the game continues
+  Given a game board that only folds right and down
+  Then the game continues

data/features/scoring.feature

@@ -0,0 +1,112 @@
+Feature: For every game state there is a score.
+Scenario: Ones and twos give zero points.
+  Given a gameboard
+  |0|0|0|1|
+  |0|1|2|0|
+  |2|1|0|2|
+  |1|2|1|0|
+  Then score is:"0"
+
+Scenario: A three gives 3 points
+  Given a gameboard
+  |0|0|0|1|
+  |0|1|2|0|
+  |2|1|0|2|
+  |1|2|1|3|
+  Then score is:"3"
+
+Scenario: A six gives 9 points
+  Given a gameboard
+  |0|0|0|1|
+  |0|1|2|0|
+  |2|1|0|2|
+  |1|2|1|6|
+  Then score is:"9"
+
+Scenario: A 12 gives 27 points
+  Given a gameboard
+  |0|0|0| 1|
+  |0|1|2| 0|
+  |2|1|0| 2|
+  |1|2|1|12|
+  Then score is:"27"
+
+Scenario: A 24 gives 81 points
+  Given a gameboard
+  |0|0|0| 1|
+  |0|1|2| 0|
+  |2|1|0| 2|
+  |1|2|1|24|
+  Then score is:"81"
+
+Scenario: A 48 gives 243 points
+  Given a gameboard
+  |0|0|0| 1|
+  |0|1|2| 0|
+  |2|1|0| 2|
+  |1|2|1|48|
+  Then score is:"243"
+
+Scenario: A 96 gives 729 points
+  Given a gameboard
+  |0|0|0| 1|
+  |0|1|2| 0|
+  |2|1|0| 2|
+  |1|2|1|96|
+  Then score is:"729"
+
+Scenario: A 192 gives 2187 points
+  Given a gameboard
+  |0|0|0|  1|
+  |0|1|2|  0|
+  |2|1|0|  2|
+  |1|2|1|192|
+  Then score is:"2187"
+
+Scenario: A 384 gives 6561 points
+  Given a gameboard
+  |0|0|0|  1|
+  |0|1|2|  0|
+  |2|1|0|  2|
+  |1|2|1|384|
+  Then score is:"6561"
+
+Scenario: A 768 gives 19683 points
+  Given a gameboard
+  |0|0|0|  1|
+  |0|1|2|  0|
+  |2|1|0|  2|
+  |1|2|1|768|
+  Then score is:"19683"
+
+Scenario: A 1536 gives 59049 points
+  Given a gameboard
+  |0|0|0|   1|
+  |0|1|2|   0|
+  |2|1|0|   2|
+  |1|2|1|1536|
+  Then score is:"59049"
+
+Scenario: A 3072 gives 177147 points
+  Given a gameboard
+  |0|0|0|   1|
+  |0|1|2|   0|
+  |2|1|0|   2|
+  |1|2|1|3072|
+  Then score is:"177147"
+
+Scenario: A 6144 gives 531441 points
+  Given a gameboard
+  |0|0|0|   1|
+  |0|1|2|   0|
+  |2|1|0|   2|
+  |1|2|1|6144|
+  Then score is:"531441"
+
+Scenario: All points are summed up
+  Given a gameboard
+  |   1|   2|  3|   6|
+  |  12|  24| 48|  96|
+  | 192| 384|768|1536|
+  |3072|6144|  0|   0|
+  Then score is:"797160"

data/features/start_game.feature

@@ -0,0 +1,14 @@
+Feature: Start a new game.
+Scenario: A newly created game is not over before first fold.
+  Given a new game is started
+  Then the game is not over
+
+Scenario: A newly created game is identified by an id.
+  Given a new game is started
+  Then an id is attached to the game
+
+Scenario: A newly created game returns a game board with nine cells filled.
+  Given a new game is started
+  Then the game board has 9 cells filled
+  And the board contains no other but the following numbers:
+  |0|1|2|3|

data/features/steps/basic_steps.rb

@@ -0,0 +1,41 @@
+require 'Matrix'
+require_relative '../../lib/game_board_folder'
+require_relative '../../lib/score_calculator'
+
+Given(/^a gameboard$/) do |table|
+  @game_board = GameBoardFolder.new
+  matrix = table.raw
+  matrix = matrix.map{|l| l.map{|cell| cell.strip.to_i}}
+  @state = Matrix.rows(matrix)
+end
+
+When(/^the game is folded right to left$/) do
+  @state = @game_board.fold_left @state
+end
+
+When(/^the game is folded left to right$/) do
+  @state = @game_board.fold_right @state
+end
+
+When(/^the game is folded upwards$/) do
+  @state = @game_board.fold_up @state
+end
+
+When(/^the game is folded downwards$/) do
+  @state = @game_board.fold_down @state
+end
+
+When(/^the game is folded right$/) do
+  @state = @game_board.fold_right @state
+end
+
+Then(/^the gameboard looks like$/) do |table|
+  matrix = table.raw
+  matrix = matrix.map{|l| l.map{|cell| cell.strip.to_i}}
+  expect(@state).to eq(Matrix.rows(matrix))
+end
+
+Then(/^score is:"(.*?)"$/) do |score|
+  actual_score = ScoreCalculator.score_for(@state)
+  expect(actual_score).to eq(score.to_i)
+end

data/features/steps/game_over_steps.rb

@@ -0,0 +1,44 @@
+require 'Matrix'
+require_relative '../../lib/game_over_checker'
+
+Before do
+  @game_over_checker = GameOverChecker.new
+end
+
+Given(/^an unfoldable game board$/) do
+  matrix = [[3,6,3,6],[6,3,6,3],[3,6,3,6],[6,3,6,3]]
+  @state = Matrix.rows(matrix)
+end
+
+Given(/^a game board that only folds left and up$/) do
+  matrix = [[0,6,3,6],[6,3,6,3],[3,6,3,6],[6,3,6,3]]
+  @state = Matrix.rows(matrix)
+end
+
+Given(/^a game board that only folds left and down$/) do
+  matrix = [[3,6,3,6],[6,3,6,3],[3,6,3,6],[0,3,6,3]]
+  @state = Matrix.rows(matrix)
+end
+
+Given(/^a game board that only folds right and up$/) do
+  matrix = [[3,6,3,0],[6,3,6,3],[3,6,3,6],[6,3,6,3]]
+  @state = Matrix.rows(matrix)
+end
+
+Given(/^a game board that only folds right and down$/) do
+  matrix = [[3,6,3,6],[6,3,6,3],[3,6,3,6],[6,3,6,0]]
+  @state = Matrix.rows(matrix)
+end
+
+Then(/^the game is over$/) do
+  expect(@game_over_checker.game_over?(@state)).to eq(true)
+end
+
+Given(/^a foldable game board$/) do
+  matrix = [[3,3,3,3],[3,3,3,3],[3,3,3,3],[3,3,3,3]]
+  @state = Matrix.rows(matrix)
+end
+
+Then(/^the game continues$/) do
+  expect(@game_over_checker.game_over?(@state)).to eq(false)
+end

data/features/steps/game_play_steps.rb

@@ -0,0 +1,39 @@
+require_relative '../../lib/threesmodel'
+
+Before do
+end
+
+Given(/^a new game is started$/) do
+   @game_controller = Threesmodel::GameController.new
+   @game_state = @game_controller.start_new_game
+end
+
+Then(/^an id is attached to the game$/) do
+  expect(@game_state[:id]).to_not eq(nil)
+end
+
+Then(/^the game is not over$/) do
+  expect(@game_state[:game_over]).to eq(false)
+end
+
+Then(/^the game board has (\d+) cells filled$/) do |filled_cells|
+  c = []
+  values = @game_state[:game].row_vectors.each{|row|
+    c << row.to_a
+  }
+  c.flatten!
+  d = c.find_all{|item| item > 0}
+  expect(d.size).to eq(9)
+end
+
+Then(/^the board contains no other but the following numbers:$/) do |table|
+  data = table.raw[0]
+  c = []
+  values = @game_state[:game].row_vectors.each{|row|
+    c << row.to_a
+  }
+  c.flatten!.uniq!
+  data.each{|value|
+    expect(c.include?(value.to_i)).to eq(true)
+  }
+end

data/lib/candidate_extractor.rb

@@ -0,0 +1,47 @@
+require 'line_folder'
+class CandidateExtractor
+
+  def initialize(line_folder = LineFolder.new)
+    @line_folder = line_folder
+  end
+
+  def fold_left_candidates(state)
+    candidates = []
+    state.row_vectors.each_index {|i|
+      add_candidate(candidates, i, state.row_vectors[i].to_a)
+    }
+    candidates
+  end
+
+  def fold_right_candidates(state)
+    candidates = []
+    state.row_vectors.each_index {|i|
+      add_candidate(candidates, i, state.row_vectors[i].to_a.reverse)
+    }
+    candidates
+  end
+
+  def fold_up_candidates(state)
+    candidates = []
+    state.column_vectors.each_index {|i|
+      add_candidate(candidates, i, state.column_vectors[i].to_a)
+    }
+    candidates
+  end
+
+  def fold_down_candidates(state)
+    candidates = []
+    state.column_vectors.each_index {|i|
+      add_candidate(candidates, i, state.column_vectors[i].to_a.reverse)
+    }
+    candidates
+  end
+
+  def add_candidate(candidates, index, values)
+    if (@line_folder.can_fold?(values)) then
+      candidates << [index, 3]
+    end
+  end
+
+
+end

data/lib/candidate_translator.rb

@@ -0,0 +1,26 @@
+class CandidateTranslator
+
+  def translate_left_fold(candidates)
+    candidates
+  end
+
+  def translate_right_fold(candidates)
+    translate(candidates, {[0,3] => [3,0], [1,3] => [2,0], [2,3] => [1,0], [3,3] => [0,0]})
+  end
+
+  def translate_down_fold(candidates)
+    translate(candidates, {[0,3] => [0,0], [1,3] => [0,1], [2,3] => [0,2], [3,3] => [0,3]})
+  end
+
+  def translate_up_fold(candidates)
+    translate(candidates, {[0,3] => [3,3], [1,3] => [3,2], [2,3] => [3,1], [3,3] => [3,0]})
+  end
+
+  def translate(candidates, translation)
+    result = []
+    for candidate in candidates do
+      result << translation[candidate]
+    end
+    result
+  end
+end