chess 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 144e0056d416422439a212c961f1a20f97899732
-  data.tar.gz: 8863ebc0662c3e8a9358df006302a41e2f4a1782
+SHA256:
+  metadata.gz: 6c0769e70cd986cfb2f23d8f8eb2551cd72745e35dc5cde6832bbab0d35015d5
+  data.tar.gz: 9dd9e4fa0b620f8905e46d33ed6969a09a896e07018d3857dec3926e6da2571b
 SHA512:
-  metadata.gz: 859d042dbca0d119161bd0361dc9940dadc0e9de3b60e863ec9609425f6b8487f70bbd5821de98d67096c96cf46d6ada82ce59dba7a8e3963aba47fb3c0d29f0
-  data.tar.gz: 7466a2c6711067f3e90efb80ec5a7a64ca3c323cdd4d2ba087959ef93f04a54778fcd36d4cec537f962b9fc4d80aa726593febf857cf8588c791088ead57775c
+  metadata.gz: d6bb94f4bc3a86cfb593c0e2c233bf75887c1c10be1f968d9dcc4e169e5add14dd18624c9d2932284e6f4fcacdf43fabb65457575fa29a7d308f7366d6f6d227
+  data.tar.gz: e68c4d62784204158e9829c85265fb354357b30af59cfdc790eeea498fb93e88c136712e6b61979017488a0a14836a2a07ac7c90dc091ad2bf5dcc739c9d5845

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+# ko_fi: # Replace with a single Ko-fi username
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
+# otechie: # Replace with a single Otechie username
+custom: https://www.paypal.me/epilotto

data/.github/workflows/ruby.yml

@@ -0,0 +1,58 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Compile extension
+        working-directory: ./ext
+        run: |
+          ruby extconf.rb
+          make
+      - name: Run tests
+        run: bundle exec rake test
+        env:
+          CODECOV: true
+      # - name: Upload coverage report to Codecov
+      #   uses: codecov/codecov-action@v1
+      #   with:
+      #     file: ./coverage/.resultset.json
+
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run Rubocop
+        run: bundle exec rubocop

data/.gitignore

@@ -1,11 +1,11 @@
 *.gem
 .bundle
+.byebug_history
 .yardoc/
-doc/
+coverage/
 ext/chess
 ext/Makefile
 ext/*.bundle
 ext/*.o
-Gemfile.lock
 main.rb
 pkg/*

data/.rubocop.yml

@@ -0,0 +1,51 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Enabled: false
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  Max: 1000
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in chess.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    chess (0.3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    codecov (0.4.2)
+      simplecov (>= 0.15, < 0.22)
+    docile (1.3.5)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.3)
+      rubocop (>= 0.87, < 2.0)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-18
+  x86_64-darwin-19
+
+DEPENDENCIES
+  bundler (~> 2)
+  byebug (~> 11)
+  chess!
+  codecov (~> 0.4)
+  minitest (~> 5)
+  rake (~> 13)
+  rubocop (~> 1)
+  rubocop-minitest (~> 0.10)
+  rubocop-performance (~> 1)
+  rubocop-rake (~> 0.5)
+  simplecov (~> 0.21)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.7

data/README.md

@@ -1,12 +1,13 @@
 # Chess
 
-A fast Ruby library to play chess with Ruby. This library is quite fast
-because rappresent the game situations with bitboards. In addition, the move
-generator is written in C as a Ruby extension.
+![build](https://github.com/pioz/chess/workflows/Ruby/badge.svg)
+[![codecov](https://codecov.io/gh/pioz/chess/branch/master/graph/badge.svg?token=bsSUOW6wWa)](https://codecov.io/gh/pioz/chess)
+
+A fast Ruby gem to play chess with Ruby. This library is quite fast because manage game situations with [bitboards](https://en.wikipedia.org/wiki/Bitboard). Also, the move generator is written in C as a Ruby extension.
 
 ## Requirements
 
-*   Ruby 1.9 or higher
+- Ruby 2.5 or higher
 
 ## Installation
 
@@ -14,23 +15,26 @@ generator is written in C as a Ruby extension.
 
 ## Usage
 
-    require 'chess'
-    g = Chess::Game.new
-    until g.over?
-      begin
-        print "Give me a #{g.active_player} move: "
-        input = gets.chop
-        break if input == 'quit'
-        g << input
-        puts g
-        puts g.moves.last
-      rescue Chess::IllegalMoveError => e
-        puts 'Illegal move!'
-      end
-    end
-    puts g.status
-
-**Documentation** is available [here](http://pioz.github.com/chess).
+```ruby
+require 'chess'
+
+g = Chess::Game.new
+until g.over?
+  begin
+    print "Give me a #{g.active_player} move: "
+    input = gets.chop
+    break if input == 'quit'
+    g << input
+    puts g
+    puts g.moves.last
+  rescue Chess::IllegalMoveError => e
+    puts 'Illegal move!'
+  end
+end
+puts g.status
+```
+
+**Documentation** is available **[here](http://pioz.github.com/chess)**.
 
 ## Questions or problems?
 
@@ -40,5 +44,5 @@ pull request.
 
 ## Copyright
 
-Copyright (c) 2017 [Enrico Pilotto (@pioz)](https://github.com/pioz). See
+Copyright (c) 2021 [Enrico Pilotto (@pioz)](https://github.com/pioz). See
 [LICENSE](https://github.com/pioz/chess/blob/master/LICENSE) for details.

data/Rakefile

@@ -2,10 +2,11 @@ require 'bundler/gem_tasks'
 
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
- t.files = ['lib/**/*.rb', 'ext/*.c']
- t.options << '-rREADME.md'
- t.options << '--title=Chess'
- t.options << '-mmarkdown'
+  t.files = ['lib/**/*.rb', 'ext/*.c']
+  t.options << '-rREADME.md'
+  t.options << '--title=Chess'
+  t.options << '-mmarkdown'
+  t.options << '--output-dir=docs'
 end
 
 require 'rake/testtask'

data/chess.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'chess/version'
 
 Gem::Specification.new do |s|
@@ -8,21 +7,26 @@ Gem::Specification.new do |s|
   s.authors     = ['Enrico Pilotto']
   s.email       = ['epilotto@gmx.com']
   s.homepage    = 'https://github.com/pioz/chess'
-  s.summary     = %q{A fast chess library to play chess with Ruby.}
-  s.description = %q{A fast chess library that use bitboards to play chess with Ruby.}
+  s.summary     = 'A fast chess library to play chess with Ruby.'
+  s.description = 'A fast chess library that use bitboards to play chess with Ruby.'
   s.license     = 'LGPLv3'
 
-  s.rubyforge_project = 'chess'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.extensions    = ['ext/extconf.rb']
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 1.9'
-  s.add_development_dependency 'bundler', '~> 1.14'
-  s.add_development_dependency 'rake', '~> 12.0'
-  s.add_development_dependency 'minitest', '~> 5.10'
+  s.required_ruby_version = '>= 2.5'
+  s.add_development_dependency 'bundler', '~> 2'
+  s.add_development_dependency 'byebug', '~> 11'
+  s.add_development_dependency 'codecov', '~> 0.4'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'rake', '~> 13'
+  s.add_development_dependency 'rubocop', '~> 1'
+  s.add_development_dependency 'rubocop-minitest', '~> 0.10'
+  s.add_development_dependency 'rubocop-performance', '~> 1'
+  s.add_development_dependency 'rubocop-rake', '~> 0.5'
+  s.add_development_dependency 'simplecov', '~> 0.21'
   s.add_development_dependency 'yard', '~> 0.9'
 end

data/docs/Chess.html

@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Chess
+  
+    &mdash; Chess
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Chess";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (C)</a> &raquo;
+    
+    
+    <span class="title">Chess</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: Chess
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/chess/version.rb<span class="defines">,<br />
+  lib/chess/pgn.rb,<br /> lib/chess/game.rb,<br /> lib/chess/gnuchess.rb,<br /> lib/chess/exceptions.rb,<br /> lib/chess/utf8_notation.rb,<br /> ext/chess.c</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>The Chess library module.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Chess/Gnuchess.html" title="Chess::Gnuchess (module)">Gnuchess</a></span>, <span class='object_link'><a href="Chess/UTF8Notation.html" title="Chess::UTF8Notation (module)">UTF8Notation</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Chess/BadNotationError.html" title="Chess::BadNotationError (class)">BadNotationError</a></span>, <span class='object_link'><a href="Chess/Board.html" title="Chess::Board (class)">Board</a></span>, <span class='object_link'><a href="Chess/CGame.html" title="Chess::CGame (class)">CGame</a></span>, <span class='object_link'><a href="Chess/Game.html" title="Chess::Game (class)">Game</a></span>, <span class='object_link'><a href="Chess/IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>, <span class='object_link'><a href="Chess/InvalidFenFormatError.html" title="Chess::InvalidFenFormatError (class)">InvalidFenFormatError</a></span>, <span class='object_link'><a href="Chess/InvalidPgnFormatError.html" title="Chess::InvalidPgnFormatError (class)">InvalidPgnFormatError</a></span>, <span class='object_link'><a href="Chess/Pgn.html" title="Chess::Pgn (class)">Pgn</a></span>
+    
+  
+</p>
+
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          <div class="docstring">
+  <div class="discussion">
+    
+<p>The library version.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.3.1</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jan 28 17:31:40 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-2.6.1).
+</div>
+
+    </div>
+  </body>
+</html>