egd 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08654fa684c9a1a58f3683757a327c67abad2656'
-  data.tar.gz: 903d018099474b94ac8e93e92dbb7e402d7a4282
+  metadata.gz: c8576046875ff0741a150a8c58b4725466673c13
+  data.tar.gz: ffb66447b0494066c44bf56b1d7a9705139a6213
 SHA512:
-  metadata.gz: '093c40611777d951fb712dc79b3f5d1a98a1822c832831dc045c69cd2ebd8103c332b36a89b716da31536e5c02becfde47a4cf54144d9fbb94e0065ef217a26e'
-  data.tar.gz: 4e6f7baab0cf159afadfe3376e5dc62249c32c2622a3cf200d00c89a151d1802be5e2661596876315ddb04dd60d59263966c01f29ae29454a65a75ddf6c80bf8
+  metadata.gz: c1edfe986366a4820c939fd9b646362e7865df89a5ad7c764997ca38fb365d8e513b8701adeee9218ebcef8905f91435ccf3e0199347565f43d71fd7e1d96297
+  data.tar.gz: 615f253803aaf603f13b6dd5db52b7bde8d6646df75b5aacff40c1ff6e443f3f431a98b4ca18c00f53d08935869364c7b78b441def5abe9e325a8fbf31b38252

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    egd (1.0.0)
+    egd (1.0.1)
       pgn (~> 0.2.0)
 
 GEM

data/README.md

@@ -149,6 +149,7 @@ EGD tries to provide the maximum of meta-information about a move a programmed s
 Currently outputted keys are:
 ```rb
 "move" => {
+  "player"=>"w", # w for White and b for Black
   "san" => "exd6", # the Short Algebraic Notation from provided PGN
   "lran" => "e5xd6", # EGDs semi-custom Long Reversible Algebraic Notation
   "from_square" => "e5",

data/egd.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.license       = "BSD"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match?(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/egd/builder.rb

@@ -0,0 +1,82 @@
+module Egd
+  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

data/lib/egd/fen_builder.rb

@@ -1,23 +1,24 @@
+module Egd
+  class FenBuilder
+    # This service takes in a FEN string and a chess move in algebraic notation.
+    # Outputs the FEN of the resulting position
 
-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
 
-  attr_reader :start_fen, :move
+    NULL_FEN = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1".freeze
 
-  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
 
-  # 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
-    )
+    def call
+      @fen ||= (
+        move != "" ?
+          PGN::FEN.new(start_fen).to_position.move(move).to_fen.to_s :
+          @start_fen
+      )
+    end
   end
 end

data/lib/egd/fen_difference_discerner.rb

@@ -1,204 +1,206 @@
-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
+module Egd
+  class 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
 
-  # Theoretically a start and end fen would suffice, but having move in SAN,
-  # which we do, allows skipping some hard procesing parts.
+      # entering long processing of regular moves
 
-  attr_reader :start_fen, :move, :end_fen
+      changes = {
+        "lran" => lran, # FEN
+        "from_square" => from_square, # FEN # b2
+        "to_square" => to_square, # move b3
+        "piece" => piece, # move p
+        "move_type" => move_type,
+      }
 
-  # 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
+      changes.merge!("captured_piece" => captured_piece) if captured_piece
+      changes.merge!("promotion" => promotion) if promotion
 
-  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
+      changes
     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
+    private
 
-    def special_case_ep_capture
-      return @ep_capture if defined?(@ep_capture)
+      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
+        return @ep_capture = false if Egd::Procedures.parse_fen(start_fen)[:ep_square] != to_square
 
-      from = move[0] + (move[-1] == "6" ? "5" : "4")
+        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
+        @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_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 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 board1
+        @board1 ||= Egd::FenToBoard.new(start_fen)
+      end
 
-    def board2
-      @board2 ||= Egd::FenToBoard.new(end_fen)
-    end
+      def board2
+        @board2 ||= Egd::FenToBoard.new(end_fen)
+      end
 
-    def changed_squares
-      return @changed_squares if defined?(@changed_squares)
+      def changed_squares
+        return @changed_squares if defined?(@changed_squares)
 
-      @changed_squares = []
+        @changed_squares = []
 
-      (1..64).to_a.each do |fen_index|
-        i = fen_index - 1
+        (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)
+          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]
-          }
+            @changed_squares << {
+              square: square, from: board1.boardline[i], to: board2.boardline[i]
+            }
+          end
         end
-      end
 
-      @changed_squares
-    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 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 to_square
+        @to_square ||= move.match(%r'\A(?<basemove>.*\d)(?<drek>.*)?\z')[:basemove][-2..-1]
+      end
 
-    def piece
-      return @piece if defined?(@piece)
+      def piece
+        return @piece if defined?(@piece)
 
-      possible_piece = move[0]
+        possible_piece = move[0]
 
-      @piece = (Egd::SAN_CHESS_PIECES.include?(possible_piece) ? possible_piece : "p" )
+        @piece = (Egd::SAN_CHESS_PIECES.include?(possible_piece) ? possible_piece : "p" )
 
-      @piece << bishop_color(to_square) if @piece == "B"
+        @piece << bishop_color(to_square) if @piece == "B"
 
-      @piece
-    end
+        @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 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
+      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.downcase! if captured_piece[%r'p'i]
 
-          captured_piece << bishop_color(to_square) if captured_piece == "B"
+            captured_piece << bishop_color(to_square) if captured_piece == "B"
 
-          captured_piece
-        else
-          nil
-        end
-    end
+            captured_piece
+          else
+            nil
+          end
+      end
 
-    def promotion
-      @promotion ||=
-        if move_type[%r'promotion']
-          promoted_to = move.match(%r'=(?<promo>.)\z')[:promo]
+      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 << bishop_color(to_square) if promoted_to == "B"
 
-          promoted_to
-        else
-          nil
-        end
-    end
+            promoted_to
+          else
+            nil
+          end
+      end
 
-    def lran
-      return @lran if defined?(@lran)
+      def lran
+        return @lran if defined?(@lran)
 
-      @lran = "#{piece_in_lran(piece)}#{from_square}"
+        @lran = "#{piece_in_lran(piece)}#{from_square}"
 
-      @lran << (
-        captured_piece ?
-          "x#{piece_in_lran(captured_piece)}#{to_square}" :
-          "-#{to_square}"
-      )
+        @lran << (
+          captured_piece ?
+            "x#{piece_in_lran(captured_piece)}#{to_square}" :
+            "-#{to_square}"
+        )
 
-      @lran << "=#{promotion[0]}" if promotion
+        @lran << "=#{promotion[0]}" if promotion
 
-      @lran
-    end
+        @lran
+      end
 
-    def piece_in_lran(pc)
-      pc == "p" ? "" : pc[0]
-    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
+      def bishop_color(on_square)
+        Egd::Procedures.square_color(on_square) == "w" ? "l" : "d"
+      end
 
+  end
 end

data/lib/egd/fen_to_board.rb

@@ -1,45 +1,47 @@
-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
+module Egd
+  class 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
+    attr_reader :fen
 
-  LETTER_VALUES = %w|_ a b c d e f g h|.freeze
+    LETTER_VALUES = %w|_ a b c d e f g h|.freeze
 
 
-  # Egd::FenToBoard.new(fen_string)["b2"]
-  def initialize(fen)
-    @fen = fen
-  end
+    # Egd::FenToBoard.new(fen_string)["b2"]
+    def initialize(fen)
+      @fen = fen
+    end
 
-  def [](square)
-    board_hash[square]
-  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...."
+    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
+    private
+      def parsed_fen
+        @parsed_fen ||= Egd::Procedures.parse_fen(fen)
+      end
 
-    def board_hash
-      return @board_hash if defined?(@board_hash)
+      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
-        ]
-      }
+        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
+        @board_hash = Hash.new(&look_up_square_behavior)
+      end
 
+  end
 end

data/lib/egd/pgn_parser.rb

@@ -1,177 +1,178 @@
 # Thanks to https://github.com/jedld/pgn_parser
+module Egd
+  class 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
 
-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
+    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
-      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
+        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
-    end
 
-    @movelist = simple_parse_moves
+      @movelist = simple_parse_moves
 
-    hash = {moves: @movelist}
-    hash.merge!(game_tags: @game_attributes) if @game_attributes.any?
-    hash
-  end
+      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
+    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
-    end
 
-    {type: event_type, value: event_value}
-  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
+    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 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 "$n"-like annotations
+      move_line.gsub!(%r'\$\d+ ', " ")
 
-    # strip out ?! -like annotations
-    move_line.gsub!(%r'[?!]+ ', " ")
+      # strip out ?! -like annotations
+      move_line.gsub!(%r'[?!]+ ', " ")
 
-    # 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,}', " ")
+      # 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
+      # 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 = []
+      moves = []
 
-    while move_line.match?(%r'\d+\.')
-      parsed_moves = move_line.match(%r'\A
-        (?<move_number>\d+)\.(?<move_chunk>.*?)(?:(?<remainder>\d+\..*\z)|\z)
-      'x)
+      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
+        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
+        # a good place to DEBUG
 
-      next if !move_chunk
+        next if !move_chunk
 
-      move_chunk = move_chunk.to_s.gsub(%r'\.{2}\s?', ".. ") # formats Black move ".."
-      move_line = move_line.to_s.strip
+        move_chunk = move_chunk.to_s.gsub(%r'\.{2}\s?', ".. ") # formats Black move ".."
+        move_line = move_line.to_s.strip
 
-      number_var = "@_#{move_number}"
+        number_var = "@_#{move_number}"
 
-      w = move_chunk.strip.split(" ")[0]
-      b = move_chunk.strip.split(" ")[1]
+        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
+        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)
-      )
+        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
+        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]
+      # offload last to moves since there may not have been a black move
+      moves << @last if !@last[:b]
 
-    moves
+      moves
+    end
   end
 end

data/lib/egd/position_feature_discerner.rb

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

data/lib/egd/procedures.rb

@@ -1,53 +1,55 @@
-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
+module Egd
+  module 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]
+    # 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
+      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
+    # 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_index = index - ((Egd::COLUMN_HEIGHT - row) * Egd::ROW_LENGTH)
 
-    column = Egd::FenToBoard::LETTER_VALUES[column_index] # => "c"
+      column = Egd::FenToBoard::LETTER_VALUES[column_index] # => "c"
 
-    "#{column}#{row}"
-  end # 1 -> "a8", 64 -> "h1"
+      "#{column}#{row}"
+    end # 1 -> "a8", 64 -> "h1"
 
-  # Egd::Procedures.square_color("a7")
-  def square_color(square)
-    column = square[0] #=> a
-    row = square[1] #=> 8
+    # 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"
+      if %w|a c e g|.include?(column)
+        row.to_i.even? ? "w" : "b"
+      else
+        row.to_i.odd? ? "w" : "b"
+      end
     end
-  end
 
+  end
 end

data/lib/egd/version.rb

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

data/lib/egd.rb

@@ -7,6 +7,7 @@ require "egd/fen_to_board"
 require "egd/fen_difference_discerner"
 require "egd/position_feature_discerner"
 require "egd/pgn_parser"
+require "egd/builder"
 require "egd/version"
 
 module Egd
@@ -17,85 +18,4 @@ module Egd
   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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: egd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Epigene
@@ -129,6 +129,7 @@ files:
 - bin/setup
 - egd.gemspec
 - lib/egd.rb
+- lib/egd/builder.rb
 - lib/egd/fen_builder.rb
 - lib/egd/fen_difference_discerner.rb
 - lib/egd/fen_to_board.rb