just_checkers 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd7a80ff97dc8a7dd9864f66f6c2433cb8b0d662
-  data.tar.gz: 751f933d40e7bbc0bd2c22c4448434f8e968a8d5
+  metadata.gz: 8e631bf4123ccf99a1c93a0e06eb3b8a46c79682
+  data.tar.gz: 6c872f95204b1afa6912fac02c34141466efedc2
 SHA512:
-  metadata.gz: 957dc61a18c7b28d959a142e2a111acc1b8b0554630e4a1252409fbb0aa6f35df5ff9c0a040e397c2cb888fff53099e21a56569d8e278ef84d85db850322c0e4
-  data.tar.gz: 840fc894b1276b8ef9708296c6841c655ce0e432cfcb7c18acaa8b41681b85b38c2673f79f6376b021036c5e1eb3d1b60a1df4c755d490ab4fac91975b45873c
+  metadata.gz: 8e7c12394334a4765f76de167165038745e22f6ed64c82c78818ac1a6abadc583613572ed427906e36076c5dbb21a560229952cecf15bab6442b3e6faf8e0bbb
+  data.tar.gz: 8e723f660f4a4c72b922262265de30a470012a0f8ce81b8458c9b6f995e1d78c5b9252a923b6c5ebedc569d8c3b84178944b2c21f94cb31fba83764fb9960471

data/README.md

@@ -51,8 +51,6 @@ Also, the game can be serialized into a hash.
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mrlhumphreys/just_checkers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/just_checkers/direction.rb

@@ -7,8 +7,11 @@ module JustCheckers
 
     # New objects can be instantiated with
     #
-    # * +x+ - x magnitude
-    # * +y+ - y magnitude
+    # @param [Fixnum] x
+    #   the x magnitude.
+    #
+    # @param [Fixnum] y
+    #   the y magnitude.
     #
     # ==== Example:
     #   # Instantiates a new Direction
@@ -20,9 +23,18 @@ module JustCheckers
       @x, @y = x, y
     end
 
-    attr_reader :x, :y
+    # @return [Fixnum] the x magnitude.
+    attr_reader :x
+    
+    # @return [Fixnum] the y magnitude.
+    attr_reader :y
 
-    # check if directions are equal by seeing if their magnitudes are equal.
+    # Check if directions are equal by seeing if their magnitudes are equal.
+    #
+    # @param [Direction] other
+    #   the other direction to compare to.
+    #
+    # @return [Boolean]
     def ==(other)
       self.x == other.x && self.y == other.y
     end

data/lib/just_checkers/game_state.rb

@@ -7,10 +7,16 @@ module JustCheckers
   # Represents a game of Checkers in progress.
   class GameState
 
-    # New objects can be instantiated by passing in a hash with
+    # New objects can be instantiated.
     #
-    # * +current_player_number+ - Who's turn it is, 1 or 2
-    # * +squares+ - An array of squares, each with x and y co-ordinates and a piece.
+    # @param [Hash] args
+    #   The data needed for a game
+    #
+    # @option args [Fixnum] :current_player_number
+    #   Who's turn it is, 1 or 2
+    #
+    # @option args [Array<Square>] :squares
+    #   An array of squares, each with x and y co-ordinates and a piece.
     #
     # ==== Example:
     #   # Instantiates a new Game of Checkers
@@ -22,11 +28,22 @@ module JustCheckers
     #   })
     def initialize(args = {})
       @current_player_number = args[:current_player_number]
-      @squares = SquareSet.new(squares: args[:squares])
+      @squares = SquareSet.new(squares: args[:squares] || [])
       @messages = []
     end
+    
+    # @return [Fixnum] who's turn it is.
+    attr_reader :current_player_number
+    
+    # @return [Array<Square>] the board state.
+    attr_reader :squares
+    
+    # @return [Array<String>] useful messages if any.
+    attr_reader :messages
 
     # Instantiates a new GameState object in the starting position
+    #
+    # @return [GameState]
     def self.default
       new({
         current_player_number: 1,
@@ -74,19 +91,23 @@ module JustCheckers
       })
     end
 
-    attr_reader :current_player_number, :squares, :messages
-
-    # Returns a hash serialized representation of the game state
+    # A hashed serialized representation of the game state
+    #
+    # @return [Hash]
     def as_json
       { current_player_number: current_player_number, squares: squares.as_json, winner: winner }
     end
 
     # Returns the json serialized representation of the game state.
+    #
+    # @return String
     def to_json
       as_json.to_json
     end
 
-    # Returns the player number of the winner. It returns nil if there is no winner
+    # The player number of the winner. It returns nil if there is no winner.
+    #
+    # @return [Fixnum,NilClass]
     def winner
       if squares.occupied_by(1).none? { |s| s.possible_jumps(s.piece, squares).any? || s.possible_moves(s.piece, squares).any? }
         2
@@ -99,16 +120,23 @@ module JustCheckers
 
     # Moves a piece owned by the player, from one square, to another
     #
-    # * +player_number+ - the player number, 1 or 2
-    # * +from+ - A hash containing x and y co-ordinates.
-    # * +to+ - An array of hashes containing x and y co-ordinates.
-    #
     # It moves the piece and returns true if the move is valid and it's the player's turn.
     # It returns false otherwise.
     #
     # ==== Example:
     #   # Moves a piece from a square to perform a double jump
     #   game_state.move!(1, {x: 0, y: 1}, [{x: 1, y: 2}, {x: 3, y: 4}])
+    #
+    # @param [Fixnum] player_number
+    #   the player number, 1 or 2.
+    #
+    # @param [Hash] from
+    #   where the moving piece currently is.
+    #
+    # @param [Array<Hash>] to
+    #   each place the piece is going to move to.
+    #
+    # @return [Boolean]
     def move!(player_number, from, to)
       @messages = []
       from_square = squares.find_by_x_and_y(from[:x].to_i, from[:y].to_i)

data/lib/just_checkers/piece.rb

@@ -6,9 +6,17 @@ module JustCheckers
 
     # New objects can be instantiated by passing in a hash with
     #
-    # * +player_number+ - The player who owns the piece, 1 or 2
-    # * +direction+ - The direction forward on the board, 1 for moving down, -1 for moving up.
-    # * +king+ - Set to true if the piece has been crowned
+    # @param [Hash] args
+    #   The data needed for a piece
+    #
+    # @option args [Fixnum] player_number
+    #   the owner of the piece.
+    #
+    # @option args [Fixnum] direction
+    #   the direction forward on the board, 1 for moving down, -1 for moving up.
+    #
+    # @option args [Boolean] king
+    #   set to true if the piece has been crowned.
     #
     # ==== Example:
     #   # Instantiates a new Piece
@@ -23,15 +31,27 @@ module JustCheckers
       @king = args[:king]
     end
 
-    attr_reader :player_number, :direction, :king
+    # @return [Fixnum] the owner of the piece.
+    attr_reader :player_number
+    
+    # @return [Fixnum] the direction forward on the board, 1 for moving down, -1 for moving up.
+    attr_reader :direction
+    
+    # @return [Boolean] set to true if the piece has been crowned.
+    attr_reader :king
+    
     alias_method :king?, :king
 
     # promotes the piece by setting the +king+ attribute to true.
+    #
+    # @return [TrueClass]
     def promote!
       @king = true
     end
 
     # returns a serialized piece as a hash
+    #
+    # @return [Hash]
     def as_json
       { player_number: player_number, direction: direction, king: king }
     end

data/lib/just_checkers/point.rb

@@ -7,8 +7,11 @@ module JustCheckers
 
     # New objects can be instantiated with
     #
-    # * +x+ - x co-ordinate
-    # * +y+ - y co-ordinate
+    # @param [Fixnum] x
+    #   the x co-ordinate.
+    #
+    # @param [Fixnum] y
+    #   the y co-ordinate.
     #
     # ==== Example:
     #   # Instantiates a new Point
@@ -20,14 +23,28 @@ module JustCheckers
       @x, @y = x, y
     end
 
-    attr_reader :x, :y
+    # @return [Fixnum] the x co-ordinate.
+    attr_reader :x
+    
+    # @return [Fixnum] the y co-ordinate.
+    attr_reader :y
 
-    # add a point to another point by adding their co-ordinates and returning a new point.
+    # Add a point to another point by adding their co-ordinates and returning a new point.
+    #
+    # @param [Point] other
+    #   the other point to add.
+    #
+    # @return [Point]
     def +(other)
       self.class.new(self.x + other.x, self.y + other.y)
     end
 
-    # check if points are equal by seeing if their co-ordinates are equal.
+    # Check if popints are equal by seeing if their co-ordinates are equal.
+    #
+    # @param [Point] other
+    #   the other point to compare to.
+    #
+    # @return [TrueClass, FalseClass]
     def ==(other)
       self.x == other.x && self.y == other.y
     end

data/lib/just_checkers/square.rb

@@ -10,9 +10,17 @@ module JustCheckers
 
     # New objects can be instantiated by passing in a hash with
     #
-    # * +x+ - The x co-ordinate of the square.
-    # * +y+ - The y co-ordinate of the square.
-    # * +piece+ - The piece on the square, can be a piece object or hash or nil.
+    # @param [Hash] args
+    #   The data needed for a square
+    #
+    # @option args [Fixnum] x
+    #   the x co-ordinate of the square.
+    #
+    # @option args [Fixnum] y
+    #   the y co-ordinate of the square.
+    #
+    # @option args [Piece,Hash,NilClass] piece
+    #   The piece on the square, can be a piece object or hash or nil.
     #
     # ==== Example:
     #   # Instantiates a new Square
@@ -31,13 +39,22 @@ module JustCheckers
       end
     end
 
-    attr_reader :x, :y
+    # @return [Fixnum] the x co-ordinate of the square.
+    attr_reader :x 
+    
+    # @return [Fixnum] the y co-ordinate of the square.
+    attr_reader :y
+    
+    # @return [Piece,NilClass] The piece on the square if any.
     attr_accessor :piece
 
     # checks if the square matches the attributes passed.
     #
-    # * +attribute+ - a symbol for the squares attribute
-    # * +value+ - a value to match on. Can be a hash of attribute/value pairs for deep matching
+    # @param [Symbol] attribute
+    #   the square's attribute.
+    #
+    # @param [Object,Hash] value
+    #   a value to match on. Can be a hash of attribute/value pairs for deep matching
     #
     # ==== Example:
     #   # Check if square has a piece owned by player 1
@@ -55,29 +72,51 @@ module JustCheckers
       hash_obj_matcher.call(self, attribute, value)
     end
 
-    # returns true if the square has no piece on it.
+    # Is the square unoccupied by a piece?
+    #
+    # @return [Boolean]
     def unoccupied?
       piece.nil?
     end
 
-    # returns a point object with the square's co-ordinates.
+    # A point object with the square's co-ordinates.
+    #
+    # @return [Point]
     def point
       Point.new(x, y)
     end
 
-    # returns all squares that a piece on this square could jump to, given the board.
+    # All squares that a piece on this square could jump to, given the board.
+    #
+    # @param [Piece] piece
+    #   the piece on this square
+    #
+    # @param [SquareSet] squares
+    #   the board
+    #
+    # @return [SquareSet]
     def possible_jumps(piece, squares)
       squares.two_squares_away_from(self).in_direction_of(piece, self).unoccupied.select do |s|
         squares.between(self, s).occupied_by_opponent_of(piece.player_number).any?
       end
     end
 
-    # returns all squares that a piece on this square could jump to, given the board.
+    # All squares that a piece on this square could move to, given the board.
+    #
+    # @param [Piece] piece
+    #   the piece on this square
+    #
+    # @param [SquareSet] squares
+    #   the board
+    #
+    # @return [SquareSet]
     def possible_moves(piece, squares)
       squares.one_square_away_from(self).in_direction_of(piece, self).unoccupied
     end
 
-    # returns a serialized version of the square as a hash
+    # A serialized version of the square as a hash
+    #
+    # @return [Hash]
     def as_json
       { x: x, y: y, piece: piece && piece.as_json }
     end

data/lib/just_checkers/square_set.rb

@@ -13,7 +13,11 @@ module JustCheckers
     # New objects can be instantiated by passing in a hash with squares.
     # They can be square objects or hashes.
     #
-    # * +squares+ - An array of squares, each with x and y co-ordinates and a piece.
+    # @param [Hash] args
+    #   The data needed for the squares
+    #
+    # @option args [Array<Square,Hash>] squares
+    #   An array of squares, each with x and y co-ordinates and a piece.
     #
     # ==== Example:
     #   # Instantiates a new Square Set
@@ -30,6 +34,7 @@ module JustCheckers
       end
     end
 
+    # @return [Array<Square>] The squares in the set.
     attr_reader :squares
 
     def_delegator :squares, :first
@@ -40,18 +45,27 @@ module JustCheckers
     def_delegator :squares, :empty?
 
     # Iterate over the squares with a block and behaves like Enumerable#each.
+    #
+    # @return [Enumerable]
     def each(&block)
       squares.each(&block)
     end
 
     # Filter the squares with a block and behaves like Enumerable#select.
     # It returns a SquareSet with the filtered squares.
+    #
+    # @return [SquareSet]
     def select(&block)
       self.class.new(squares: squares.select(&block))
     end
 
     # Filter the squares with a hash of attribute and matching values.
     #
+    # @param [Hash] hash
+    #   attributes to query for.
+    #
+    # @return [SquareSet]
+    #
     # ==== Example:
     #   # Find all squares where piece is nil
     #   square_set.where(piece: nil)
@@ -64,6 +78,13 @@ module JustCheckers
 
     # Find the square with the matching x and y co-ordinates
     #
+    # @param [Fixnum] x
+    #   the x co-ordinate.
+    #
+    # @param [Fixnum] y
+    #   the y co-ordinate.
+    #
+    # @return [Square]
     # ==== Example:
     #   # Find the square at 4,2
     #   square_set.find_by_x_and_y(4, 2)
@@ -72,19 +93,37 @@ module JustCheckers
     end
 
     # Return all squares that are one square away from the passed square.
+    #
+    # @param [Square] square
+    #   the square in question.
+    #
+    # @return [SquareSet]
     def one_square_away_from(square)
       select { |s| Vector.new(square, s).magnitude == 1 }
     end
 
     # Return all squares that are two squares away from the passed square.
+    #
+    # @param [Square] square
+    #   the square in question.
+    #
+    # @return [SquareSet]
     def two_squares_away_from(square)
       select { |s| Vector.new(square, s).magnitude == 2 }
     end
 
-    # Returns squares in the direction of the piece from the square
+    # Find squares in the direction of the piece from the square
     # If the piece is normal, it returns squares in front of it.
     # If the piece is king, it returns all squares.
     #
+    # @param [Piece] piece
+    #   the piece in question.
+    #
+    # @param [Square] square
+    #   the square the piece is on.
+    #
+    # @return [SquareSet]
+    #
     # ==== Example:
     #   # Get all squares in the direction of the piece.
     #   square_set.in_direction_of(piece, square)
@@ -94,7 +133,9 @@ module JustCheckers
       end
     end
 
-    # Returns all squares without pieces on them.
+    # Find all squares without pieces on them.
+    #
+    # @return [SquareSet]
     def unoccupied
       select { |s| s.piece.nil? }
     end
@@ -102,6 +143,14 @@ module JustCheckers
     # Returns squares between a and b.
     # Only squares that are in the same diagonal will return squares.
     #
+    # @param [Square] a
+    #   a square.
+    #
+    # @param [Square] b
+    #   another square.
+    #
+    # @return [SquareSet]
+    #
     # ==== Example:
     #   # Get all squares between square_a and square_b
     #   square_set.between(square_a, square_b)
@@ -125,12 +174,22 @@ module JustCheckers
       self.class.new(squares: squares)
     end
 
-    # takes a player number and returns all squares occupied by the opponent of the player
+    # Takes a player number and returns all squares occupied by the opponent of the player
+    #
+    # @param [Fixnum] player_number
+    #   the player's number.
+    #
+    # @return [SquareSet]
     def occupied_by_opponent_of(player_number)
       select { |s| s.piece && s.piece.player_number != player_number }
     end
 
-    # takes a player number and returns all squares occupied by the player
+    # Takes a player number and returns all squares occupied by the player
+    #
+    # @param [Fixnum] player_number
+    #   the player's number.
+    #
+    # @return [SquareSet]
     def occupied_by(player_number)
       select { |s| s.piece && s.piece.player_number == player_number }
     end
@@ -138,6 +197,8 @@ module JustCheckers
     attr_reader :squares
 
     # serializes the squares as a hash
+    #
+    # @return [Hash]
     def as_json
       squares.map(&:as_json)
     end

data/lib/just_checkers/vector.rb

@@ -9,8 +9,11 @@ module JustCheckers
 
     # New objects can be instantiated by passing in a two points with x and y co-ordinates
     #
-    # * +a+ - A point with an x and y co-ordinates.
-    # * +b+ - A point with an x and y co-ordinates.
+    # @param [Point] a
+    #   the start point.
+    #
+    # @param [Point] b
+    #   the end point.
     #
     # ==== Example:
     #   # Instantiates a new Vector
@@ -22,9 +25,15 @@ module JustCheckers
       @a, @b = a, b
     end
 
-    attr_reader :a, :b
+    # @return [Point] the start point.
+    attr_reader :a
+    
+    # @return [Point] the end point.
+    attr_reader :b
 
-    # returns how big the vector is if it's diagonal, otherwise, nil.
+    # How big the vector is if it's diagonal, otherwise, nil.
+    #
+    # @return [Fixnum,NilClass]
     def magnitude
       if diagonal
         dx.abs
@@ -33,12 +42,16 @@ module JustCheckers
       end
     end
 
-    # returns a direction of the vector as a object
+    # The direction of the vector as a object
+    #
+    # @return [Direction]
     def direction
       Direction.new(direction_x, direction_y)
     end
 
-    # returns the x component of the direction, 1 if moving down, -1 if moving up, 0 otherwise
+    # The x component of the direction, 1 if moving down, -1 if moving up, 0 otherwise
+    #
+    # @return [Fixnum]
     def direction_x
       if dx > 0
         1
@@ -49,7 +62,9 @@ module JustCheckers
       end
     end
 
-    # returns the y component of the direction, 1 if moving right, -1 if moving left, 0 otherwise
+    # The y component of the direction, 1 if moving right, -1 if moving left, 0 otherwise
+    #
+    # @return [Fixnum]
     def direction_y
       if dy > 0
         1
@@ -60,7 +75,9 @@ module JustCheckers
       end
     end
 
-    # returns true if the vector is diagonal.
+    # Is the vector diagonal?
+    #
+    # @return [Boolean]
     def diagonal
       dx.abs == dy.abs
     end

data/lib/just_checkers/version.rb

@@ -1,3 +1,3 @@
 module JustCheckers
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_checkers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,3 +103,4 @@ signing_key:
 specification_version: 4
 summary: A checkers engine written in ruby
 test_files: []
+has_rdoc: