eco-classifier 0.5

data/eco-classifier.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'eco_classifier/version'
+
+Gem::Specification.new do |s|
+  s.name = "eco-classifier"
+  s.version = EcoClassifier::VERSION
+  s.authors = ["Linmiao Xu"]
+  s.email = ["lin@robotmoon.com"]
+  s.homepage = "https://github.com/linrock/eco-classifier"
+
+  s.summary = "Classifies chess openings from a list of opening moves"
+  s.description = "Classifies chess openings from a list of opening moves using the SCID ECO data file"
+  s.license = "MIT"
+
+  s.files = `git ls-files -z`.split("\0")
+
+  s.add_development_dependency "rake",     "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "pry",      "~> 0.10"
+end

data/lib/eco_classifier.rb

@@ -0,0 +1,20 @@
+require "eco_classifier/eco_data_file_parser"
+require "eco_classifier/opening_tree"
+require "eco_classifier/version"
+
+module EcoClassifier
+  def self.opening_tree
+    return @@opening_tree if defined? @@opening_tree
+    @@opening_tree = OpeningTree.new
+    @@opening_tree.generate!
+    @@opening_tree
+  end
+
+  def self.classify_moves(moves)
+    opening_tree.get_opening moves
+  end
+
+  def self.classify_pgn(pgn)
+    opening_tree.get_opening_from_pgn pgn
+  end
+end

data/lib/eco_classifier/eco_data_file_parser.rb

@@ -0,0 +1,22 @@
+# Parses the scid.eco data file into openings
+#
+class EcoDataFileParser
+  ROW_SCANNER = /\A(?<eco>[A-E]\d{2}[a-z]?)\s+"(?<name>.*)"\s+(?<pgn>.*)\z/
+
+  attr_accessor :openings
+
+  def initialize(eco_file)
+    @text = open(eco_file, 'r').read.strip
+    @text = @text.gsub(/\n  /, ' ')
+    @openings = []
+  end
+
+  def scan_into_openings
+    @text.split(/\n/).each do |row|
+      match = row.match(ROW_SCANNER)
+      next unless match
+      @openings << Opening.new(match)
+    end
+    @openings
+  end
+end

data/lib/eco_classifier/opening.rb

@@ -0,0 +1,54 @@
+# Represents an opening as parsed from scid.eco
+#
+class Opening
+
+  attr_accessor :eco, :name, :pgn
+
+  def initialize(options)
+    self.eco   = options[:eco]
+    self.name  = options[:name]
+    self.pgn   = options[:pgn]
+  end
+
+  def base_eco
+    self.eco[/\A([A-E]\d{2})/, 1]
+  end
+
+  def base_name
+    self.name.split(":").first
+  end
+
+  def variation
+    return @variation if defined?(@variation)
+    match = self.name[/:(.*)/, 1]
+    return unless match
+    @variation = match.strip
+  end
+
+  def variation_name
+    return unless variation
+    return @variation_name if defined?(@variation_name)
+    @variation_name =
+      variation.split(",").map(&:strip).select {|str| str[0] !~ /\d/ }.join(", ")
+  end
+
+  def variation_line
+    return unless variation
+    return @variation_line if defined?(@variation_line)
+    @variation_line =
+      variation.split(",").map(&:strip).select {|str| str[0] =~ /\d/ }.join(", ")
+  end
+
+  def move_list
+    pgn.gsub(/\d+\./, '').gsub(/\*/, '').strip.split(/\s+/)
+  end
+
+  def as_json(options = {})
+    {
+      eco: base_eco,
+      name: base_name,
+      variation: variation,
+      full_name: self.name
+    }
+  end
+end

data/lib/eco_classifier/opening_tree.rb

@@ -0,0 +1,90 @@
+# Used for fast opening lookups, given a move list
+#
+require 'eco_classifier/opening'
+
+class OpeningTree
+  DATA_FILE = File.join(File.dirname(__FILE__), '../../data/scid.eco')
+
+  # children -> maps move names to more nodes
+  #
+  class Node
+    attr_accessor :opening, :children
+
+    def initialize
+      @children = {}
+    end
+
+    def set_opening(opening)
+      @opening = opening
+    end
+
+    def is_leaf?
+      @children.size == 0
+    end
+
+    def inspect
+      if @opening
+        %(
+          <Node @eco="#{@opening.eco}"
+                @name="#{@opening.name}"
+                @n_children=#{@children.size}>
+        ).gsub(/\s+/, ' ')
+      else
+        %(<Node @n_children=#{@children.size}>)
+      end
+    end
+  end
+
+  attr_accessor :root, :size
+
+  def initialize
+    @root = Node.new
+    @size = 0
+  end
+
+  def build_tree(openings)
+    openings.each do |opening|
+      current = @root
+      moves = opening.move_list
+      while (move = moves.shift)
+        if !current.children[move]
+          current.children[move] = Node.new
+        end
+        current = current.children[move]
+      end
+      current.set_opening opening
+      @size += 1
+    end
+  end
+
+  def generate!
+    openings = EcoDataFileParser.new(DATA_FILE).scan_into_openings
+    build_tree(openings)
+  end
+
+  def search_for_opening(move_list)
+    current = @root
+    last_opening = nil
+    while (move = move_list.shift)
+      break unless current.children[move]
+      current = current.children[move]
+      last_opening = current.opening if current.opening
+    end
+    {
+      opening:     last_opening,
+      search_done: current.is_leaf? || move_list.length > 0
+    }
+  end
+
+  def get_opening(move_list)
+    search_for_opening(move_list)[:opening]
+  end
+
+  def get_opening_from_pgn(pgn)
+    get_opening pgn.gsub(/\d+\./, '').gsub(/\*/, '').strip.split(/\s+/)
+  end
+
+  def inspect
+    %(<OpeningTree @size=#{@size}>)
+  end
+end

data/lib/eco_classifier/version.rb

@@ -0,0 +1,3 @@
+module EcoClassifier
+  VERSION = "0.5"
+end

data/test/eco_classifier_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class EcoClassifierTest < Minitest::Test
+
+  def setup
+		@klass = EcoClassifier
+  end
+
+  def test_classifier_detects_queens_pawn_game
+    opening = @klass.classify_moves %w( d4 d5 )
+    assert opening.name == "Queen's Pawn Game"
+  end
+
+  def test_classifier_detects_kings_gambit
+    opening = @klass.classify_moves %w( e4 e5 f4)
+    assert opening.name == "King's Gambit"
+  end
+
+  def test_classifier_detects_queens_gambit
+    opening = @klass.classify_moves %w( d4 d5 c4)
+    assert opening.name == "Queen's Gambit"
+  end
+
+  def test_classifier_detects_ruy_lopez
+    opening = @klass.classify_moves %w( e4 e5 Nf3 Nc6 Bb5 )
+    assert opening.name == "Spanish (Ruy Lopez)"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+gem 'minitest'
+require 'minitest/autorun'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'eco_classifier'
+
+def read_fixture(path)
+  open("#{File.dirname(__FILE__)}/fixtures/#{path}").read
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: eco-classifier
+version: !ruby/object:Gem::Version
+  version: '0.5'
+platform: ruby
+authors:
+- Linmiao Xu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Classifies chess openings from a list of opening moves using the SCID
+  ECO data file
+email:
+- lin@robotmoon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- data/scid.eco
+- eco-classifier.gemspec
+- lib/eco_classifier.rb
+- lib/eco_classifier/eco_data_file_parser.rb
+- lib/eco_classifier/opening.rb
+- lib/eco_classifier/opening_tree.rb
+- lib/eco_classifier/version.rb
+- test/eco_classifier_test.rb
+- test/test_helper.rb
+homepage: https://github.com/linrock/eco-classifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Classifies chess openings from a list of opening moves
+test_files: []