bchess 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46328051cb5767623ccfc2b65865008bfd3cab4a
+  data.tar.gz: 0d53222053172c2c710a343d19f0738470b8dac0
+SHA512:
+  metadata.gz: 89624bd2c2b9b8860d3f45cae48264f85010496081a7d8becf9bce98491004912734c582e4f87ee737e4c54ec2de81ce6d8ec8e7464240bb7a6c751ffeeddd95
+  data.tar.gz: 401035c5490e48d066b15871db2e082b4336e93d56df9bcaa523f6de1a1bd9c3985f4a44aa92d3261adcf70460a563121c61424acaa4263011a1c41ba2f26e6d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at s.zawadzki@visuality.pl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bchess.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    bchess (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    polyglot (0.3.5)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    treetop (1.6.10)
+      polyglot (~> 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bchess!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  treetop (~> 1.6)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Staszek Zawadzki
+
+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,65 @@
+# Bchess
+
+Why bchess? Becasue BChess love chess :)
+
+## Installation
+
+Standard instalation. Add this line to your application's Gemfile:
+
+```ruby
+gem 'bchess'
+```
+And then execute:
+    $ bundle
+
+Or install it yourself as:
+    $ gem install bchess
+
+## Usage
+
+### Reading chess game from the file
+
+Parsing a game file
+```ruby
+file = Bchess::PGN::PGNFile.new('./games_to_read.pgn')
+parser = Bchess::PGN::Parser.new(file)
+parsed_games = parser.parse
+```
+
+If the file is invalid you will get an error. Otherwise you'll receive an array of games containing games headers and moves in proper order.
+
+Validating game on the board
+
+```ruby
+parsed_game = parser.parse.first
+Bchess::PGN::Game.new(parsed_game)
+
+## Getting moves
+game.convert_body_to_moves
+
+## Accessing headers
+game.header.player_white
+
+```
+
+### Testing
+Due to the nature of the gem I tested it on a large amount of games to make sure it covers all or almost all edgecases. Full tests take a lot of time, so you can run a basic test with test.sh script. If you want to run the full suite the run full_test.sh or just rspec spec. 
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/visualitypl/bchess. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bchess project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bchess/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bchess.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bchess/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bchess"
+  spec.version       = Bchess::VERSION
+  spec.authors       = ["Staszek Zawadzki"]
+  spec.email         = ["s.zawadzki@visuality.pl"]
+
+  spec.summary       = %q{Parsing chess PGN games.}
+  spec.description   = %q{Parsing and validating a chess games and returning as chess game objects}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "treetop", "~> 1.6"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bchess"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/full_test.sh

@@ -0,0 +1 @@
+rspec spec/

data/lib/bchess.rb

@@ -0,0 +1,33 @@
+require "bchess/helpers/board_helpers"
+require "bchess/helpers/fen_helpers"
+require "bchess/helpers/board_helpers"
+require "bchess/helpers/castle_helpers"
+require "bchess/helpers/validations"
+require "bchess/helpers/en_passant_helpers"
+require "bchess/helpers/field_between_helpers"
+
+require "bchess/version"
+require "bchess/piece"
+require "bchess/king"
+require "bchess/rook"
+require "bchess/bishop"
+require "bchess/queen"
+require "bchess/knight"
+require "bchess/pawn"
+require "bchess/board"
+
+require "pgn/parser"
+require "pgn/pgn_file"
+require "pgn/pgn_nodes"
+require "pgn/game"
+require "pgn/game_header"
+require "pgn/game_body"
+require "pgn/move_info_parser"
+
+module Bchess
+  class InvalidMoveException < StandardError; end
+
+  WHITE = 'w'
+  BLACK = 'b'
+  START_FEN = 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1'
+end

data/lib/bchess/bishop.rb

@@ -0,0 +1,17 @@
+module Bchess
+  class Bishop < Piece
+    BISHOP_REACH = 7
+
+    def initiialize(*args)
+      super(args)
+    end
+
+    def name
+      'B'
+    end
+
+    def can_move_to_field?(dcolumn, drow)
+      super && by_diagonal(dcolumn, drow, BISHOP_REACH)
+    end
+  end
+end

data/lib/bchess/board.rb

@@ -0,0 +1,131 @@
+module Bchess
+  class Board
+    include BoardHelpers
+    include FenHelpers
+    include CastleHelpers
+    include EnPassantHelpers
+    include Validations
+
+    attr_accessor :fen, :to_move, :pieces, :castles, :en_passant, :halfmove_clock, :move_number
+
+    def initialize(fen = Bchess::START_FEN, to_move = Bchess::WHITE)
+      @fen = fen
+      @to_move = to_move
+      @move_number = 0
+      @halfmove_clock = 0
+      @pieces = []
+      @en_passant = '-'
+      @castles = '-'
+    end
+
+    def move(piece, column, row, promoted_piece = nil)
+      return false if invalid_data?(piece, column, row)
+      @en_passant = '-' unless en_passant_detected?(piece, column, row)
+
+      if castle_detected?(piece, column)
+        castle(piece, column, row)
+      elsif promotion_detected?(piece, row)
+        execute_promotion(piece, column, row, promoted_piece)
+      elsif en_passant_detected?(piece, column, row)
+        validate_en_passant(piece, column, row) && execute_en_passant(piece, column, row)
+      elsif pawn_long_move_detected?(piece, row)
+        long_pawn_move(piece, column, row)
+      elsif piece.can_move_to_field?(column,row)
+        piece.move(column, row)
+      elsif piece.can_take_on_field?(column,row)
+        piece.move(column, row)
+      else
+        return false
+      end
+
+      update_info(piece, column, row)
+      validate_move
+    rescue RuntimeError
+      false
+    end
+
+    def get_possible_pieces(info)
+      @pieces.select{|p| p.can_make_move?(info, self)}
+    end
+
+    def update_info(piece, column, row)
+      update_castles_after_move(piece) if piece.moved
+      change_halfmove_clock(piece)
+      change_to_move
+      change_move_number if piece.color == Bchess::BLACK
+      remove_old_piece(column, row, piece.color) if !!at(column, row)
+    end
+
+    def execute_promotion(piece, column, row, promoted_piece)
+      raise RuntimeError.new("Promotion Not Specified") if promoted_piece.nil? || !(promoted_piece < Bchess::Piece)
+      pieces.delete(piece)
+      promoted = promoted_piece.new(piece.color, column, row)
+      promoted.moved = true if promoted_piece == Bchess::Rook
+      pieces << promoted
+    end
+
+    def transform_field(field)
+      [field.chars.first.ord - 97, field.chars.last.to_i - 1]
+    end
+
+    def at(column, row)
+      pieces.select{|p| p.row == row && p.column == column}.first
+    end
+
+    def read_fen
+      fen_pieces, fen_colors, fen_castles, fen_en_passant, fen_halfmove_clock, fen_move_number = fen.strip.split(" ")
+      set_pieces(fen_pieces)
+      set_to_move(fen_colors)
+      set_castles(fen_castles)
+      set_en_passant(fen_en_passant)
+      set_halfmove_clock(fen_halfmove_clock)
+      set_move_number(fen_move_number)
+    end
+
+    def print
+      puts 'Pieces WHITE: '
+      puts _pieces(Bchess::WHITE).map{|p| p.to_s }.join(', ')
+      puts 'Pieces BLACK: '
+      puts _pieces(Bchess::BLACK).map{|p| p.to_s }.join(', ')
+    end
+
+    def king(color)
+      @pieces.select{ |p| p.class == Bchess::King && p.color == color }.first
+    end
+
+    def change_to_move
+      @to_move = to_move == Bchess::WHITE ? Bchess::BLACK : Bchess::WHITE
+    end
+
+    private
+
+    def remove_old_piece(column, row, color)
+      taken_piece = _other_pieces(color).select{|p| p.row == row && p.column == column}.first
+      pieces.delete(taken_piece)
+    end
+
+    def just_moved
+      to_move == Bchess::WHITE ? Bchess::BLACK : Bchess::WHITE
+    end
+
+    def king_attacked(color)
+      _king = king(color)
+      _pieces = _other_pieces(color)
+
+      _pieces.any?{|p| attacks?(p, _king)}
+    end
+
+    def attacks?(piece, king)
+      piece.can_take_on_field?(king.column, king.row) &&
+        piece.fields_between(king.column, king.row).none?{|f| at(*f)}
+    end
+
+    def _pieces(color)
+      @pieces.select{ |p| p.color == color }
+    end
+
+    def _other_pieces(color)
+      @pieces.select{ |p| p.color != color }
+    end
+  end
+end