reversi 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0595624ced91db908b4f67fa83459a6f31e1f9ec
-  data.tar.gz: b32155cc37fa7816d0eceb7b2b97102934568ebc
+  metadata.gz: cb57c511c13a037077ba6d8f0ab1caa8cd8cc577
+  data.tar.gz: ba9e86d039af5cf0b84131abc34b840391a870cb
 SHA512:
-  metadata.gz: 3eee7c4c79aad77ba5bcc665786498f7fc62c2fac0484d6c3537e52c7520a7dfc1072f5141aad1665f52e63b9a4fa5ed2211c4e06b6eda77dec948590ef78d4d
-  data.tar.gz: 535dcd06b6426edab71f8f74597e38a4ae84e24915a2a32b0377d281704bdadc1aac42b17a125165fd4b7dd0b8bdb46a0b922eb83988b6b1f4564bb7aa2d1f21
+  metadata.gz: c8750708addcd46a68728174747d20dd86190b121bcb49860e9a157aaf7c70e9403c1723f1901ff45e90fa020c0b9f42b0cf2db8f23bdccf043a41daf01cb061
+  data.tar.gz: c5173b9bead22a20bf952fc0f79c7e15b54b9572821d4bd3a331bebc5d52d33c3b01248ae06a6e77f348249daccfcf81bcfc2118ac36a7600f3e204e993f4d14

data/README.md

@@ -45,17 +45,16 @@ puts "white #{game.board.status[:white].size}"
 
 Use `Reversi.configure` to configure setting for a reversi game.  
 
-`name` description... (default value)  
-
-* `player_b` A player having the first move uses this class object. ( Reversi::Player::RandomAI )
-* `player_w` A player having the passive move uses this class object. ( Reversi::Player::RandomAI )
-* `disk_b` A string of the black disks. ( 'b' )
-* `disk_w` A string of the black disks. ( 'w' )
-* `disk_color_b` A color of the black disks. ( 0 )
-* `disk_color_w` A color of the black disks. ( 0 )
-* `initial_position` The initial positions of each disk on the board.
-* `progress` Whether or not the progress of the game is displayed. ( false )
-* `stack_limit` The upper limit number of times of use repeatedly `Reversi::Board#undo!` . ( 3 )
+| name | description | default |
+|:----:|:----:|:----:|
+| player_b     | A player having the first move uses this class object. | `Reversi::Player::RandomAI` |
+| player_w     | A player having the passive move uses this class object. | `Reversi::Player::RandomAI` |
+| disk_b       | A string of the black disks. | 'b' |
+| disk_w       | A string of the white disks. | 'w' |
+| disk_color_b | A color of the black disks. | 'white' |
+| disk_color_w | A color of the white disks. | 'white' |
+| progress     | Whether or not the progress of the game is displayed. | `false` |
+| stack_limit  | The upper limit number of times of use repeatedly `Reversi::Board#undo!` | 3 |
 
 A string and a color of the disks are reflected on `game.board.to_s` .  
 You can choose from 9 colors, black, red, green, yellow, blue, magenda, cyan, white and gray.  

data/ext/reversi/bit_board_functions.c

@@ -1,9 +1,15 @@
 #include "bit_board_functions.h"
 
+/*
+ * Convert coordinate data to a bitboard.
+ */
 unsigned long XY2BB(int x, int y) {
   return (unsigned long)1 << ((8-x) + (8-y) * 8);
 }
 
+/*
+ * Convert a bitboard to coordinate data.
+ */
 VALUE BB2XY(unsigned long bb) {
   VALUE xy = rb_ary_new();
 
@@ -83,6 +89,9 @@ VALUE BB2XY(unsigned long bb) {
   return xy;
 }
 
+/*
+ * Rotate a bitboard by 90 degrees to the right.
+ */
 unsigned long rotate_r90(unsigned long bb) {
   bb = ((bb <<  8) & 0xAA00AA00AA00AA00) |
        ((bb >>  8) & 0x0055005500550055) |
@@ -99,6 +108,9 @@ unsigned long rotate_r90(unsigned long bb) {
   return bb;
 }
 
+/*
+ * Rotate a bitboard by 90 degrees to the left.
+ */
 unsigned long rotate_l90(unsigned long bb) {
   bb = ((bb <<  1) & 0xAA00AA00AA00AA00) |
        ((bb >>  1) & 0x0055005500550055) |
@@ -115,6 +127,9 @@ unsigned long rotate_l90(unsigned long bb) {
   return bb;
 }
 
+/*
+ * Rotate a bitboard by 45 degrees to the right.
+ */
 unsigned long rotate_r45(unsigned long bb) {
   bb = (bb & 0x0101010101010101) |
        (((bb <<  8) | (bb >> 56)) & 0x0202020202020202) |
@@ -127,6 +142,9 @@ unsigned long rotate_r45(unsigned long bb) {
   return bb;
 }
 
+/*
+ * Rotate a bitboard by 45 degrees to the left.
+ */
 unsigned long rotate_l45(unsigned long bb) {
   bb = (bb & 0x0101010101010101) |
        (((bb >>  8) | (bb << 56)) & 0x0202020202020202) |

data/ext/reversi/board.c

@@ -176,6 +176,7 @@ VALUE count_disks(VALUE self, VALUE color) {
 
 /*
  * Returns an array of the next moves.
+ * This method is used in Reversi::Player::BasePlayer class.
  *
  * @param color [Integer]
  * @return [Array<Array<Integer, Integer>>]
@@ -202,6 +203,9 @@ VALUE next_moves(VALUE self, VALUE color) {
 
 /*
  * Places a supplied color's disk on specified position.
+ * This method is used in Reversi::Board.initialize method
+ * for putting the disks at the initial position,
+ * but not used in Reversi::Player::BasePlayer class.
  *
  * @param rb_x [Integer] the column number
  * @param rb_y [Integer] the row number
@@ -221,7 +225,9 @@ VALUE put_disk(VALUE self, VALUE rb_x, VALUE rb_y, VALUE color) {
 
 /*
  * Flips the opponent's disks between a new disk and another disk of my color.
- * The invalid move has no effect.
+ * This method is used in Reversi::Player::BasePlayer class.
+ * When the invalid move is supplied, a disk is put only the position
+ * and Reversi::MoveError is raised at Reversi::Game.check_move method.
  *
  * @param rb_x [Integer] the column number
  * @param rb_y [Integer] the row number

data/lib/reversi/board.rb

@@ -25,6 +25,7 @@ module Reversi
     # @see Reversi::Game
     # @see Reversi::Configration
     # @return [Reversi::Board]
+    # @raise [OptionError] Error is raised when the supplied option is invalid.
     def initialize(options = {})
       @options = options
       @stack = []
@@ -39,6 +40,10 @@ module Reversi
       @options[:initial_position].each do |color, positions|
         positions.each{ |position| put_disk(*position, DISK[color]) }
       end
+
+      if @options[:disk_b].size != 1 || @options[:disk_w].size != 1
+        raise OptionError, "The length of the disk string must be one."
+      end
     end
 
     # Returns a string of the game board in human-readable form.

data/lib/reversi/game.rb

@@ -74,6 +74,8 @@ module Reversi
     end
 
     # Checks a move to make sure it is valid.
+    #
+    # @raise [MoveError] Error is raised when a player make an invalid move.
     def check_move(color)
       blank_diff = @status[:none].size - @board.count_disks(Reversi::Board::DISK[:none])
 

data/lib/reversi/player/base_player.rb

@@ -18,7 +18,7 @@ module Reversi::Player
     # Places a supplied color's disk on specified position,
     # and flips the opponent's disks.
     #
-    # @param x [Symbol, Integer] the column number
+    # @param x [Integer] the column number
     # @param y [Integer] the row number
     # @param my_color [Boolean] my color or opponent's color
     def put_disk(x, y, my_color = true)
@@ -30,7 +30,7 @@ module Reversi::Player
     # Returns an array of the next moves.
     #
     # @param my_color [Boolean] my color or opponent's color
-    # @return [Hash] the next moves
+    # @return [Array<Array<Integer, Integer>>] the next moves
     def next_moves(my_color = true)
       color = my_color ? @my_color : @opponent_color
       @board.next_moves(color)
@@ -47,7 +47,7 @@ module Reversi::Player
 
     # Returns a hash containing the coordinates of each color.
     #
-    # @return [Hash{Symbol => Array<Symbol, Integer>}]
+    # @return [Hash{Symbol => Array<Integer, Integer>}]
     def status
       convert = {
         :black => @my_color == Reversi::Board::DISK[:black] ? :mine : :opponent,

data/lib/reversi/version.rb

@@ -1,3 +1,3 @@
 module Reversi
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/lib/reversi.rb

@@ -10,4 +10,5 @@ module Reversi
   extend Configuration
 
   class MoveError < StandardError; end
+  class OptionError < StandardError; end
 end

data/spec/board_spec.rb

@@ -6,8 +6,8 @@ describe Reversi::Board do
      :player_w => Reversi::Player::RandomAI,
      :disk_b => "b",
      :disk_w => "w",
-     :disk_color_b => disk_color_b,
-     :disk_color_w => disk_color_w,
+     :disk_color_b => 0,
+     :disk_color_w => 0,
      :initial_position => {:black => [[4, 5], [5, 4]],
                            :white => [[4, 4], [5, 5]]},
      :progress => false,
@@ -15,31 +15,78 @@ describe Reversi::Board do
   end
   let(:board) { Reversi::Board.new(options) }
 
+  describe "the options, disk_b, disk_w" do
+    after { Reversi.reset }
+
+    context "when disk_b is invalid" do
+      it "should raise Reversi::MoveError" do
+        Reversi.configure do |config|
+          config.disk_b = "hoge"
+          config.disk_w = "w"
+        end
+        message = "The length of the disk string must be one."
+        expect{ Reversi::Game.new.start }.to raise_error(Reversi::OptionError, message)
+      end
+    end
+
+    context "when both of the disks are invalid" do
+      it "should raise Reversi::MoveError" do
+        Reversi.configure do |config|
+          config.disk_b = "poyo"
+          config.disk_w = ""
+        end
+        message = "The length of the disk string must be one."
+        expect{ Reversi::Game.new.start }.to raise_error(Reversi::OptionError, message)
+      end
+    end
+
+    context "when both of the disks are valid" do
+      it "should not raise Reversi::MoveError" do
+        Reversi.configure do |config|
+          config.disk_b = "a"
+          config.disk_w = "b"
+        end
+        expect{ Reversi::Game.new.start }.not_to raise_error
+      end
+    end
+  end
+
   describe "sets each disk color" do
+    after { Reversi.reset }
+
     context "when a color name is valid" do
-      let(:disk_color_b) { "cyan" }
-      let(:disk_color_w) { :red }
       it "sets the valid color value" do
-        expect(board.options[:disk_color_b]).to eq 36
-        expect(board.options[:disk_color_w]).to eq 31
+        Reversi.configure do |config|
+          config.disk_color_b = "cyan"
+          config.disk_color_w = :red
+        end
+        game = Reversi::Game.new
+        expect(game.board.options[:disk_color_b]).to eq 36
+        expect(game.board.options[:disk_color_w]).to eq 31
       end
     end
 
     context "when a color name is invalid" do
-      let(:disk_color_b) { "hoge" }
-      let(:disk_color_w) { :hoge }
       it "sets 0" do
-        expect(board.options[:disk_color_b]).to eq 0
-        expect(board.options[:disk_color_w]).to eq 0
+        Reversi.configure do |config|
+          config.disk_color_b = "hoge"
+          config.disk_color_w = :hoge
+        end
+        game = Reversi::Game.new
+        expect(game.board.options[:disk_color_b]).to eq 0
+        expect(game.board.options[:disk_color_w]).to eq 0
       end
     end
   end
 
   describe "#to_s" do
-    let(:disk_color_b) { :black }
-    let(:disk_color_w) { 'white' }
+    after { Reversi.reset }
 
     it do
+      Reversi.configure do |config|
+        config.disk_color_b = :black
+        config.disk_color_w = 'white'
+      end
       str = <<-END.gsub(/ {6}/,"")
            a   b   c   d   e   f   g   h
          +---+---+---+---+---+---+---+---+
@@ -60,14 +107,12 @@ describe Reversi::Board do
        8 |   |   |   |   |   |   |   |   |
          +---+---+---+---+---+---+---+---+
       END
-      expect(board.to_s).to eq str
+      game = Reversi::Game.new
+      expect(game.board.to_s).to eq str
     end
   end
 
   describe "#push_stack" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
-
     it "the stack size limit is 3(default)" do
       4.times { board.push_stack }
       expect(board.stack.size).to eq 3
@@ -82,9 +127,6 @@ describe Reversi::Board do
   end
 
   describe "#undo!" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
-
     context "when the first argument is omitted" do
       it "the default value is 1" do
         3.times { board.push_stack }
@@ -94,8 +136,6 @@ describe Reversi::Board do
   end
 
   describe "#status" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
     it "returns a hash containing the coordinates of each color" do
       expect{ board.put_disk(1, 1, Reversi::Board::DISK[:black]) }
         .to change{ board.status[:black].size }.by(1)
@@ -105,8 +145,6 @@ describe Reversi::Board do
   end
 
   describe "#openness" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
     it "returns the openness of the coordinates" do
       expect(board.openness(1, 1)).to eq 3
       expect(board.openness(2, 2)).to eq 8
@@ -115,9 +153,6 @@ describe Reversi::Board do
   end
 
   describe "#at" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
-
     it do
       board.put_disk(3, 3, Reversi::Board::DISK[:white])
       expect(board.at(3, 3)).to eq :white
@@ -127,16 +162,12 @@ describe Reversi::Board do
   end
 
   describe "#count_disks" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
     it { expect(board.count_disks(Reversi::Board::DISK[:black])).to eq 2 }
     it { expect(board.count_disks(Reversi::Board::DISK[:white])).to eq 2 }
     it { expect(board.count_disks(Reversi::Board::DISK[:none])).to eq 60 }
   end
 
   describe "#next_moves" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
     it { expect(board.next_moves(Reversi::Board::DISK[:black]))
       .to eq [[5, 6], [6, 5], [3, 4], [4, 3]] }
     it { expect(board.next_moves(Reversi::Board::DISK[:white]))
@@ -144,8 +175,6 @@ describe Reversi::Board do
   end
 
   describe "#put_disk, #flip_disks" do
-    let(:disk_color_b) { 0 }
-    let(:disk_color_w) { 0 }
     it "flips the opponent's disks between a new disk and another disk of my color" do
       board.put_disk(4, 6, Reversi::Board::DISK[:white])
       board.put_disk(5, 3, Reversi::Board::DISK[:white])

data/spec/player_spec.rb

@@ -34,7 +34,7 @@ describe Reversi::Player do
       Reversi.configure do |config|
         config.player_b = ValidPlayer
       end
-      expect(game.start).to eq nil
+      expect{ game.start }.not_to raise_error
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reversi
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - seinosuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,7 +41,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- black
 - ext/reversi/bit_board_functions.c
 - ext/reversi/bit_board_functions.h
 - ext/reversi/board.c
@@ -68,7 +67,6 @@ files:
 - spec/game_spec.rb
 - spec/player_spec.rb
 - spec/spec_helper.rb
-- white
 homepage: https://github.com/seinosuke/reversi
 licenses:
 - MIT