egd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '08654fa684c9a1a58f3683757a327c67abad2656'
+  data.tar.gz: 903d018099474b94ac8e93e92dbb7e402d7a4282
+SHA512:
+  metadata.gz: '093c40611777d951fb712dc79b3f5d1a98a1822c832831dc045c69cd2ebd8103c332b36a89b716da31536e5c02becfde47a4cf54144d9fbb94e0065ef217a26e'
+  data.tar.gz: 4e6f7baab0cf159afadfe3376e5dc62249c32c2622a3cf200d00c89a151d1802be5e2661596876315ddb04dd60d59263966c01f29ae29454a65a75ddf6c80bf8

data/.circleci/config.yml

@@ -0,0 +1,32 @@
+version: 2
+jobs:
+  build:
+    docker:
+      # ruby:2.4.3      
+      - image: circleci/ruby@sha256:9dff2778b666bb81be98cc362e93d07c26b4491399ab6e9d152a716c754a5a47
+
+    working_directory: ~/egd
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }} 
+     
+      - run:         
+          command: |            
+            bundle exec rspec    

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.4.2
+before_install: gem install bundler -v 1.16.0

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 augusts.bautra@gmail.com. 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 egd.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    egd (1.0.0)
+      pgn (~> 0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    multi_json (1.13.1)
+    pgn (0.2.0)
+      whittle
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    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.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.2)
+    whittle (0.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coveralls (~> 0.7.2)
+  egd!
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  simplecov (~> 0.15.1)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,25 @@
+The BSD license.
+Copyright (c) 2017, Augusts Bautra
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+  * Neither the name of the EGD project nor the
+    names of its contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,200 @@
+[![Version](https://badge.fury.io/rb/egd.svg)](https://badge.fury.io/rb/egd)
+[![Build](https://circleci.com/gh/Epigene/egd/tree/master.svg?style=shield)](https://circleci.com/gh/Epigene/egd/tree/master)
+[![Coverage](https://coveralls.io/repos/github/Epigene/egd/badge.svg?branch=master)](https://coveralls.io/github/Epigene/egd?branch=master)
+
+# Extended Game Description
+This gem implements conversion functionality between standart PGN and EGD (Extended Game Description).
+EGD is a new chess game description format that is based on FEN and Extended Position Description (EPD).  
+
+## Installation
+
+```
+gem install 'egd'
+```
+
+## Use
+
+```
+require "egd"
+Egd::Builder.new(File.read("path/to/chess.pgn")).to_json #=> JSON string
+```
+
+## What is this??
+
+It's all about computer analysis of chess games.  
+If we want answers to insight questions like "do I do well when I trade queens?",
+or "what losing positions do I repeatedly find myself in?", simple PGNs are not enough.  
+
+PGN is what is called "normalized" game data - it holds all the information needed to
+gain insight, but it would take a lot of time even for a computer to go through thousands of games
+to get the data needed to answer these questions.
+
+What we need for expedience is a way to de-"normalize" the data in PGN, to expand the details of moves and positions.  
+
+This is what EGD does. It is a denormalized way to represent a game of chess.
+
+Please note that currently EGD supports regular chess only and assumes the standart starting position.
+
+Denormalize the PGNs of your games, store them in a PostgreSQL database and do powerful queries on the data,
+like [Chess Sense](https://github.com/Epigene/chess_sense) does.
+
+### Position equality
+Currently EGD satisfies itself with using [Forsyth–Edwards Notation (FEN)](https://en.wikipedia.org/wiki/Forsyth%E2%80%93Edwards_Notation) __diagrams__ as representations of position, since they encode the three crucial pieces of information:
+
+1. What pieces are on which squares,
+2. Castling rights of both players,
+2. En-passant capture square (irrespective of any legal possibility to execute such a capture).
+
+However, a high-level competetive analysis may require the additional tracking of:
+1. Threefold repetition counter,
+3. Fifty-move rule counter,
+4. 75-move rule counter.
+
+## EGD details
+EGD is inspired by [Extended Position Description (EPD)](https://chessprogramming.wikispaces.com/Extended+Position+Description)
+but goes further than just tracking positions and adds meta-information to moves as well, specifically, it uses a combination of Long algebraic and Reversible algebraic [chess notations](https://en.wikipedia.org/wiki/Chess_notation) to specify, without ambiguity, what was moved to where and what capture or promotion took place.  
+
+The general form of EGD is a (JSON) hash of game headers and moves:
+
+```rb
+some_egd.to_h =>
+
+{
+  # PGN game headers, in the future may contain additional meta-information
+  # about the game as a whole
+  "game_tags" => { 
+    "Event"=>"Eurotel Trophy",
+    "Key" => "value"
+  },
+
+  # the moveset, each move is identified by order number and which side is moving
+  "moves" => {
+    # 1st move, by white
+    "1w"=>{ 
+      # what was the starting position
+      "start_position"=>{
+        # FEN diagram of the starting position
+        "fen"=>"rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
+        # details about the position, see "Position features" chapter
+        "features"=>{}
+      },
+      # details about the move
+      "move"=>{
+        "player"=>"w", "san"=>"e4", "lran"=>"e2-e4", "from_square"=>"e2",
+        "to_square"=>"e4", "piece"=>"p", "move_type"=>"move"
+      },
+      # what was the resulting position
+      "end_position"=>{
+        # FEN diagram of the resulting position
+        "fen"=>"rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1",
+        "features"=>{}
+      }
+    }
+  }
+}
+```
+
+A (very short) game that can be represented in algebraic notation as `1. e4 e5`
+
+
+```rb
+egd = Egd::Builder.new("1. e4 e5").to_json
+
+egd.to_h #=>
+# {
+#   "game_tags" => {},
+#   "moves" => {
+#     "1w"=>{
+#       "start_position"=>{
+#         "fen"=>"rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
+#         "features"=>{}
+#       },
+#       "move"=>{
+#         "player"=>"w", "san"=>"e4", "lran"=>"e2-e4", "from_square"=>"e2",
+#         "to_square"=>"e4", "piece"=>"p", "move_type"=>"move"
+#       },
+#       "end_position"=>{
+#         "fen"=>"rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1",
+#         "features"=>{}
+#       }
+#     },
+#     "1b"=>{
+#       "start_position"=>{
+#         "fen"=>"rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1",
+#         "features"=>{}
+#       },
+#       "move"=>{
+#         "player"=>"b", "san"=>"e5", "lran"=>"e7-e5",
+#         "from_square"=>"e7", "to_square"=>"e5", "piece"=>"p",
+#         "move_type"=>"move"
+#       },
+#       "end_position"=>{
+#         "fen"=>"rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq e6 0 2",
+#         "features"=>{}
+#       }
+#     }
+#   }
+# }
+
+egd.to_json
+#=> "{\"game_tags\":{},\"moves\":{\"1w\":{\"start_position\": ... \"features\":{}}}}}"
+```
+
+Take a look at `spec/egd_spec.rb` `"when initialized with the 02 PGN, a real immortal game"`
+test for the structure you get when parsing PGNs you might get from chess.com.  
+
+### Move specifics
+EGD tries to provide the maximum of meta-information about a move a programmed system can.
+
+Currently outputted keys are:
+```rb
+"move" => {
+  "san" => "exd6", # the Short Algebraic Notation from provided PGN
+  "lran" => "e5xd6", # EGDs semi-custom Long Reversible Algebraic Notation
+  "from_square" => "e5",
+  "to_square" => "d6",
+  "piece" => "p", # moved piece. Piece codes are [p, R, N, Bl, Bd, Q, K] Bl is for (L)ight square Bishop and Bd is for (D)ark square bishop.
+  "move_type" => "ep_capture", # currently distinguished types are: [move, capture, ep_capture, promotion_capture, short_castle, long_castle, promotion]
+  "captured_piece" => "p", # only shows up if a capture occured
+  "promotion" => "Q", # only shows up if promotion occured
+}
+```
+
+Please note that, unlike PGN representation, EGD does not treat check(+) and checkmate(#)
+as part of a move, instead, they are treated as part of a position.
+
+### Position specifics
+Currently positions are very minimalist - a FEN string and a "features" hash that currently can only have two keys - "check" and "checkmate".
+
+Please note that since the treatment of checkmate event is not uniform across online PGN generators (Lichess represents checkmate as "+", whereas chess.com as "#"), a checkmate event denoted by "#" also adds the "check" => true feature tag.
+
+Example position hash:
+
+```rb
+"end_position"=>{
+  "fen"=>"rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq e6 0 2",
+  "features"=>{
+    "check" => true,
+    "checkmate" => true
+  }
+}
+```
+
+## Future Ideas
+1. Expose the move's :meta key to [annotations](https://en.wikipedia.org/wiki/Chess_annotation_symbols) like "!!", "+/-", and "$1"
+
+## Development
+
+1. Fork and clone the repo
+2. install ruby and bundler, bundle
+3. run `rspec` to see if tests pass
+4. work on feature, test it, make a PR
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Epigene/egd. 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 uses the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause),
+you may use the gem in your own work, provided you reproduce the LICENSE.txt in it.  

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "egd"
+
+# 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/egd.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "egd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "egd"
+  spec.version       = Egd::VERSION
+  spec.required_ruby_version = '>= 2.4.2'
+  spec.authors       = ["Epigene"]
+  spec.email         = ["augusts.bautra@gmail.com"]
+
+  spec.summary       = %q|Extended Game Description|
+  spec.description   = %q|Convert chess PGNs into Extended Game Description JSON|
+  spec.homepage      = "https://github.com/Epigene/egd"
+  spec.license       = "BSD"
+
+  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_dependency "pgn", "~> 0.2.0" # for FEN handling
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "simplecov", "~> 0.15.1"
+  spec.add_development_dependency "coveralls", "~> 0.7.2"
+end

data/lib/egd/fen_builder.rb

@@ -0,0 +1,23 @@
+
+class Egd::FenBuilder
+  # This service takes in a FEN string and a chess move in algebraic notation.
+  # Outputs the FEN of the resulting position
+
+  attr_reader :start_fen, :move
+
+  NULL_FEN = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1".freeze
+
+  # Egd::FenBuilder.new(start_fen: nil, move:).call
+  def initialize(start_fen: nil, move: nil)
+    @start_fen = start_fen || NULL_FEN
+    @move = move.to_s.gsub(%r'\A\d+\.\s*\.*\s*', "")
+  end
+
+  def call
+    @fen ||= (
+      move != "" ?
+        PGN::FEN.new(start_fen).to_position.move(move).to_fen.to_s :
+        @start_fen
+    )
+  end
+end

data/lib/egd/fen_difference_discerner.rb

@@ -0,0 +1,204 @@
+class Egd::FenDifferenceDiscerner
+  # This service takes in a start and an end FEN string,
+  # and the move in SAN,
+  # and a tells you what kind of move occured, in more detail than SAN
+
+  # Theoretically a start and end fen would suffice, but having move in SAN,
+  # which we do, allows skipping some hard procesing parts.
+
+  attr_reader :start_fen, :move, :end_fen
+
+  # Egd::FenDifferenceDiscerner.new(start_fen:, end_fen:).call
+  def initialize(start_fen: nil, move:, end_fen:)
+    @start_fen = start_fen || Egd::FenBuilder::NULL_FEN
+    @move = move
+    @end_fen = end_fen
+  end
+
+  def call
+    # quickreturn with possible special cases
+    case move
+    when "O-O"
+      return special_case_short_castle(Egd::Procedures.parse_fen(start_fen)[:to_move])
+    when "O-O-O"
+      return special_case_long_castle(Egd::Procedures.parse_fen(start_fen)[:to_move])
+    when %r'\A[a-h]x[a-h]\d' # pawn x pawn, possible en-passant
+      return special_case_ep_capture if special_case_ep_capture
+    end
+
+    # entering long processing of regular moves
+
+    changes = {
+      "lran" => lran, # FEN
+      "from_square" => from_square, # FEN # b2
+      "to_square" => to_square, # move b3
+      "piece" => piece, # move p
+      "move_type" => move_type,
+    }
+
+    changes.merge!("captured_piece" => captured_piece) if captured_piece
+    changes.merge!("promotion" => promotion) if promotion
+
+    changes
+  end
+
+  private
+
+    def special_case_ep_capture
+      return @ep_capture if defined?(@ep_capture)
+
+      return @ep_capture = false if Egd::Procedures.parse_fen(start_fen)[:ep_square] != to_square
+
+      from = move[0] + (move[-1] == "6" ? "5" : "4")
+
+      @ep_capture = {
+        "lran" => "#{from}x#{to_square}", # FEN
+        "from_square" => from, # FEN
+        "to_square" => to_square, # move
+        "piece" => "p", # move
+        "move_type" => "ep_capture", # FEN
+        "captured_piece" => "p", # move
+      }
+    end
+
+    def special_case_short_castle(player)
+      {
+        "lran" => "O-O", # FEN
+        "from_square" => (player == "w" ? "e1" : "e8"), # FEN
+        "to_square" => (player == "w" ? "g1" : "g8"), # move
+        "piece" => "K", # move
+        "move_type" => "short_castle", # FEN
+      }
+    end
+
+    def special_case_long_castle(player)
+      {
+        "lran" => "O-O-O", # FEN
+        "from_square" => (player == "w" ? "e1" : "e8"), # FEN
+        "to_square" => (player == "w" ? "c1" : "c8"), # move
+        "piece" => "K", # move
+        "move_type" => "long_castle", # FEN
+      }
+    end
+
+    def board1
+      @board1 ||= Egd::FenToBoard.new(start_fen)
+    end
+
+    def board2
+      @board2 ||= Egd::FenToBoard.new(end_fen)
+    end
+
+    def changed_squares
+      return @changed_squares if defined?(@changed_squares)
+
+      @changed_squares = []
+
+      (1..64).to_a.each do |fen_index|
+        i = fen_index - 1
+
+        if board1.boardline[i] != board2.boardline[i]
+          square = Egd::Procedures.fen_index_to_square(fen_index)
+
+          @changed_squares << {
+            square: square, from: board1.boardline[i], to: board2.boardline[i]
+          }
+        end
+      end
+
+      @changed_squares
+    end
+
+    def from_square
+      @from_square ||= changed_squares.reject do |hash|
+        hash[:square] == to_square
+      end.detect do |hash|
+        hash[:to] == "-"
+      end[:square]
+    end
+
+    def to_square
+      @to_square ||= move.match(%r'\A(?<basemove>.*\d)(?<drek>.*)?\z')[:basemove][-2..-1]
+    end
+
+    def piece
+      return @piece if defined?(@piece)
+
+      possible_piece = move[0]
+
+      @piece = (Egd::SAN_CHESS_PIECES.include?(possible_piece) ? possible_piece : "p" )
+
+      @piece << bishop_color(to_square) if @piece == "B"
+
+      @piece
+    end
+
+    def move_type
+      @move_type ||=
+        case move
+        when %r'x.*='i
+          "promotion_capture"
+        when %r'x'i
+          "capture"
+        when %r'='i
+          "promotion"
+        else
+          "move"
+        end
+    end
+
+    def captured_piece
+      @captured_piece ||=
+        if move_type[%r'capture']
+          captured_piece = changed_squares.detect do |hash|
+            hash[:square] == to_square
+          end[:from].upcase
+
+          captured_piece.downcase! if captured_piece[%r'p'i]
+
+          captured_piece << bishop_color(to_square) if captured_piece == "B"
+
+          captured_piece
+        else
+          nil
+        end
+    end
+
+    def promotion
+      @promotion ||=
+        if move_type[%r'promotion']
+          promoted_to = move.match(%r'=(?<promo>.)\z')[:promo]
+
+          promoted_to << bishop_color(to_square) if promoted_to == "B"
+
+          promoted_to
+        else
+          nil
+        end
+    end
+
+    def lran
+      return @lran if defined?(@lran)
+
+      @lran = "#{piece_in_lran(piece)}#{from_square}"
+
+      @lran << (
+        captured_piece ?
+          "x#{piece_in_lran(captured_piece)}#{to_square}" :
+          "-#{to_square}"
+      )
+
+      @lran << "=#{promotion[0]}" if promotion
+
+      @lran
+    end
+
+    def piece_in_lran(pc)
+      pc == "p" ? "" : pc[0]
+    end
+
+    def bishop_color(on_square)
+      Egd::Procedures.square_color(on_square) == "w" ? "l" : "d"
+    end
+
+end

data/lib/egd/fen_to_board.rb

@@ -0,0 +1,45 @@
+class Egd::FenToBoard
+  # this service parses a FEN string into a hash-representation of a chess board and pieces
+  # So you can do
+  # board = Egd::FenToBoard.new(fen_string)
+  # board["b3"] #=> "P" # as in white pawn
+
+  attr_reader :fen
+
+  LETTER_VALUES = %w|_ a b c d e f g h|.freeze
+
+
+  # Egd::FenToBoard.new(fen_string)["b2"]
+  def initialize(fen)
+    @fen = fen
+  end
+
+  def [](square)
+    board_hash[square]
+  end
+
+  def boardline
+    # this replaces numbers with corresponding amount of dashes
+    @boardline ||= parsed_fen[:board].gsub(%r'\d') do |match|
+      "-" * match.to_i
+    end.gsub("/", "")
+  end #=> "rnbqkbnrpppp...."
+
+  private
+    def parsed_fen
+      @parsed_fen ||= Egd::Procedures.parse_fen(fen)
+    end
+
+    def board_hash
+      return @board_hash if defined?(@board_hash)
+
+      look_up_square_behavior = ->(hash, key) {
+        hash[key] = boardline[
+          Egd::Procedures.square_to_fen_index(key) - 1
+        ]
+      }
+
+      @board_hash = Hash.new(&look_up_square_behavior)
+    end
+
+end

data/lib/egd/pgn_parser.rb

@@ -0,0 +1,177 @@
+# Thanks to https://github.com/jedld/pgn_parser
+
+class Egd::PgnParser
+  # This service takes in a PGN string and parses it
+  # Returns the game tags (headers of the PGN file) and
+  # the *actual* moves made in SAN
+
+  attr_reader :headers, :pgn_content
+
+  def initialize(pgn_content)
+    @pgn_content = pgn_content
+    @headers = []
+    @movelist = []
+    @game_attributes = {}
+  end
+
+  def call
+    current_index = 0
+    state = :initial
+    buffer = ''
+
+    while (current_index < @pgn_content.size)
+      current_char = @pgn_content[current_index]
+      current_index += 1
+
+      if state == :initial
+        if current_char == '['
+          state = :start_parse_header
+          next
+        elsif (current_char == ' ' || current_char == "\n" || current_char == "\r")
+          next
+        else
+          break
+        end
+      end
+
+      if state == :start_parse_header
+        if current_char == ']'
+          state = :initial
+          hd = parse_header(buffer)
+          @headers << hd
+          @game_attributes[hd[:type]] = hd[:value]
+          buffer = ''
+          next
+        else
+          buffer << current_char
+          next
+        end
+      end
+    end
+
+    @movelist = simple_parse_moves
+
+    hash = {moves: @movelist}
+    hash.merge!(game_tags: @game_attributes) if @game_attributes.any?
+    hash
+  end
+
+  private
+
+  def parse_header(header)
+    event_type = ""
+    event_value = ""
+    state = :parse_type
+    current_index = 0
+    buffer = ''
+
+    while (current_index < header.size)
+      current_char = header[current_index]
+      current_index += 1
+
+      if state == :parse_type
+        if current_char == ' '
+          event_type = buffer.dup
+          buffer = ''
+          state = :start_parse_value
+          next
+        else
+          buffer << current_char
+          next
+        end
+      elsif state == :start_parse_value
+        if current_char == '"'
+          state = :parse_value
+          next
+        else
+          next
+        end
+      elsif state == :parse_value
+        if current_char=='"'
+          event_value = buffer.dup
+          buffer = ''
+        else
+          buffer << current_char
+        end
+      end
+    end
+
+    {type: event_type, value: event_value}
+  end
+
+  def simple_parse_moves
+    move_line =
+      pgn_content.split("\n").map do |line|
+        line unless line.strip[0] == "["
+      end.compact.join(" ").
+      gsub(%r'((1\-0)|(0\-1)|(1/2\-1/2)|(\*))\s*\z', "") # cut away game termination
+
+    # strip out comments and alternatives
+    while move_line.gsub!(%r'\{[^{}]*\}', ""); end
+    while move_line.gsub!(%r'\([^()]*\)', ""); end
+
+    # strip out "$n"-like annotations
+    move_line.gsub!(%r'\$\d+ ', " ")
+
+    # strip out ?! -like annotations
+    move_line.gsub!(%r'[?!]+ ', " ")
+
+    # strip out +/- like annotations
+    move_line.gsub!(%r'(./.)|(= )|(\+\−)|(\-\+)|(\∞)', "")
+
+    # squish whitespace
+    move_line = move_line.strip.gsub(%r'\s{2,}', " ")
+
+    # check if move line consists of legit chars only
+    if !move_line.match?(%r'\A(?:[[:alnum:]]|[=\-+.#\* ])+\z')
+      raise(
+        "The PGN move portion has weird characters even after cleaning it.\n"\
+        "Is the PGN valid?\n"\
+        "The moves after cleaning came out as:\n#{move_line}"
+      )
+    end
+
+    moves = []
+
+    while move_line.match?(%r'\d+\.')
+      parsed_moves = move_line.match(%r'\A
+        (?<move_number>\d+)\.(?<move_chunk>.*?)(?:(?<remainder>\d+\..*\z)|\z)
+      'x)
+
+      move_number = parsed_moves[:move_number]
+      move_chunk = parsed_moves[:move_chunk] #=> " e4 c5 "
+      move_line = parsed_moves[:remainder].to_s.strip
+
+      # a good place to DEBUG
+
+      next if !move_chunk
+
+      move_chunk = move_chunk.to_s.gsub(%r'\.{2}\s?', ".. ") # formats Black move ".."
+      move_line = move_line.to_s.strip
+
+      number_var = "@_#{move_number}"
+
+      w = move_chunk.strip.split(" ")[0]
+      b = move_chunk.strip.split(" ")[1]
+
+      options = {}
+      options.merge!(:w=>w) unless w.match?(%r'\.{2}')
+      options.merge!(:b=>b) if b
+
+      instance_variable_set(
+        "@_#{move_number}",
+        instance_variable_get("@_#{move_number}") ?
+        instance_variable_get("@_#{move_number}").merge(options) :
+        {:num=>move_number.to_i}.merge(options)
+      )
+
+      moves << instance_variable_get("@_#{move_number}") if instance_variable_get("@_#{move_number}")[:b]
+      @last = instance_variable_get("@_#{move_number}")
+    end
+
+    # offload last to moves since there may not have been a black move
+    moves << @last if !@last[:b]
+
+    moves
+  end
+end

data/lib/egd/position_feature_discerner.rb

@@ -0,0 +1,25 @@
+class Egd::PositionFeatureDiscerner
+  # This service takes in a move and the resulting FEN string
+  # and outputs a hash of features of the resulting position
+
+  # Currently minimal function,
+  # Only looks at supplied move and tells whether the position is a check or checkmate.
+
+  attr_reader :move, :end_fen
+
+  def initialize(move:, end_fen:)
+    @move = move
+    @end_fen = end_fen
+  end
+
+  def call
+    return @features if defined?(@features)
+
+    @features = {}
+
+    @features.merge!("check" => true, "checkmate" => true) if move[%r'#\z']
+    @features.merge!("check" => true) if move[%r'\+\z']
+
+    @features
+  end
+end

data/lib/egd/procedures.rb

@@ -0,0 +1,53 @@
+module Egd::Procedures
+  # This module has global methods for ease of working with chess data
+
+  extend self
+
+  # Egd::Procedures.parse_fen(fen)
+  def parse_fen(fen)
+    match = fen.split(%r'\s+') # FEN lines are delimited with whitespace, splitting on that
+
+    {
+      board: match[0],
+      to_move: match[1],
+      castling: match[2],
+      ep_square: match[3],
+      halfmove: match[4],
+      fullmove: match[5]
+    }
+  end
+
+  # Egd::Procedures.square_to_fen_index("b2")
+  def square_to_fen_index(square)
+    column = square[0]
+    row = square[1]
+
+    row_value = Egd::COLUMN_HEIGHT - row.to_i
+    row_value * Egd::ROW_LENGTH + Egd::FenToBoard::LETTER_VALUES.index(column)
+  end # a8 -> 1, a7 -> 9, h1 -> 64
+
+  # Egd::Procedures.fen_index_to_square(index)
+  def fen_index_to_square(index)
+    # 3 -> c8
+    row = Egd::COLUMN_HEIGHT - ((index - 1) / Egd::COLUMN_HEIGHT) # => 8
+
+    column_index = index - ((Egd::COLUMN_HEIGHT - row) * Egd::ROW_LENGTH)
+
+    column = Egd::FenToBoard::LETTER_VALUES[column_index] # => "c"
+
+    "#{column}#{row}"
+  end # 1 -> "a8", 64 -> "h1"
+
+  # Egd::Procedures.square_color("a7")
+  def square_color(square)
+    column = square[0] #=> a
+    row = square[1] #=> 8
+
+    if %w|a c e g|.include?(column)
+      row.to_i.even? ? "w" : "b"
+    else
+      row.to_i.odd? ? "w" : "b"
+    end
+  end
+
+end

data/lib/egd/version.rb

@@ -0,0 +1,3 @@
+module Egd
+  VERSION = "1.0.0"
+end

data/lib/egd.rb

@@ -0,0 +1,101 @@
+require "digest"
+require "pgn"
+
+require "egd/procedures"
+require "egd/fen_builder"
+require "egd/fen_to_board"
+require "egd/fen_difference_discerner"
+require "egd/position_feature_discerner"
+require "egd/pgn_parser"
+require "egd/version"
+
+module Egd
+  ROW_LENGTH = 8.freeze
+  COLUMN_HEIGHT = 8.freeze
+  SAN_CHESS_PIECES = %w|R N B Q K|.freeze
+
+  def self.root
+    Pathname.new(File.expand_path('../..', __FILE__))
+  end
+
+  class Builder
+    # This is the real deal
+    # Takes in a PGN string and returns a Ruby or JSON hash representation of the game in EGD
+
+    attr_reader :pgn
+
+    def initialize(pgn)
+      @pgn = pgn
+    end
+
+    def to_h
+      return @to_h if defined?(@to_h)
+
+      @to_h = {}
+      @to_h["game_tags"] = game_tags
+      @to_h["moves"] = {}
+
+      @previous_fen = Egd::FenBuilder::NULL_FEN
+
+      moves.each_with_object(@to_h) do |move, mem|
+        transition_key = "#{move[%r'\A\d+']}#{move.match?(%r'\.\.') ? "b" : "w"}" #=> "1w"
+
+        san = move.match(%r'\A(?:\d+\.(?:\s*\.\.)?\s+)(?<san>\S+)\z')[:san] #=> "e4"
+        end_fen = Egd::FenBuilder.new(start_fen: @previous_fen, move: move).call
+
+        current_transition = {
+          "start_position" => {
+            "fen" => @previous_fen,
+            "features" => {}, # TODO, no features can be discerned before the move yet
+          },
+          "move" => {
+            "player" => transition_key[%r'\D\z'], #=> "w"
+            "san" => san,
+          }.merge(
+            Egd::FenDifferenceDiscerner.new(
+              start_fen: @previous_fen, move: san, end_fen: end_fen
+            ).call
+          ),
+          "end_position" => {
+            "fen" => end_fen,
+            "features" => Egd::PositionFeatureDiscerner.new(
+              move: move, end_fen: end_fen
+            ).call
+          }
+        }
+
+        # leave this breadcrumb for next run through loop
+        @previous_fen = current_transition.dig("end_position", "fen")
+
+        mem["moves"][transition_key] = current_transition
+      end
+    end
+
+    def to_json
+      @to_json ||= to_h.to_json
+    end
+
+    private
+      def game_tags
+        @game_tags ||= parsed_pgn[:game_tags] || {}
+      end
+
+      def moves
+        return @moves if defined?(@moves)
+
+        @moves = []
+
+        parsed_pgn[:moves].each do |move_row|
+          @moves << "#{move_row[:num]}. #{move_row[:w]}"
+          @moves << "#{move_row[:num]}. .. #{move_row[:b]}" if move_row[:b]
+        end
+
+        @moves
+      end
+
+      def parsed_pgn
+        @parsed_pgn ||= Egd::PgnParser.new(pgn).call
+      end
+
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: egd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Epigene
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pgn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+description: Convert chess PGNs into Extended Game Description JSON
+email:
+- augusts.bautra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- egd.gemspec
+- lib/egd.rb
+- lib/egd/fen_builder.rb
+- lib/egd/fen_difference_discerner.rb
+- lib/egd/fen_to_board.rb
+- lib/egd/pgn_parser.rb
+- lib/egd/position_feature_discerner.rb
+- lib/egd/procedures.rb
+- lib/egd/version.rb
+homepage: https://github.com/Epigene/egd
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Extended Game Description
+test_files: []