chess_openings 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89b8c112a3b10f18cd68aa2374b969be3387ff8b
-  data.tar.gz: 492ca8ad3ee08e1abe58eeb26d9b8e04a9d348ee
+  metadata.gz: 78417b3eddb5c39e879ca39404958b23aa2284ed
+  data.tar.gz: 3e83d4e26d315c9aaca05f1f67c86f01f6ff7d3e
 SHA512:
-  metadata.gz: e64af794c2b1e2ef2485bf9e818d2c47a7657fcb3b590c4a468165e134e19f6df714d502f88fa1987ba3914d10a3ecd13a7d3dd5da5cb37713a2df4b0e351899
-  data.tar.gz: e59132099dc7b7551c55fba4b7d7ec762c9f1c47fc0f0243a17fcb9f031614d0fbacdc2e43d59d0351c7e6d4c8d6f62e195026a9c78b9104f88db104310326bb
+  metadata.gz: 5472f322d4504f665088cf703aa66b22af932049130c605de3a42308f1e34f64d08cd3187c8e32e4768dbc889a21d2786d07c82169a25ef873cbf92604d9f4d8
+  data.tar.gz: b5b1f0e194ce3f92d04122b69e99afa204939c044aa3f58dea73fac198eb13787640b3719922a18244fea2260a1310b5dc4fa92f1a342cb3f4c23fe521593d16

data/.gitignore

@@ -1,2 +1,4 @@
 .DS_Store
-*.gem
+.tags
+.tags_sorted_by_file
+*.gem

data/.yardoc/checksums

@@ -0,0 +1,4 @@
+lib/chess_openings.rb 46752f37f62d27c9adc0c321f48ffc4f89cda525
+lib/chess_openings/opening.rb 47b8824624e83318b4855a0ebf10b44cd3208813
+lib/chess_openings/search_tree.rb f98ffb2f3089682a85ba6b4a129512d0d30c5b36
+lib/chess_openings/chess_openings_helper.rb 0f39c3cb6fbd142bb50a222a52ebfa90ef0b74a4

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'pgn', '0.0.6'
+gem 'nokogiri', '1.6.6.2'
+gem 'pgn', '0.1.1'
+gem 'pry'
 gem 'rspec', '~> 3.3.0'
-gem 'nokogiri', '1.6.6.2'

data/Gemfile.lock

@@ -1,12 +1,18 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.0)
     diff-lcs (1.2.5)
+    method_source (0.8.2)
     mini_portile (0.6.2)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
-    pgn (0.0.6)
+    pgn (0.1.1)
       whittle
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -20,6 +26,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    slop (3.6.0)
     whittle (0.0.8)
 
 PLATFORMS
@@ -27,5 +34,9 @@ PLATFORMS
 
 DEPENDENCIES
   nokogiri (= 1.6.6.2)
-  pgn (= 0.0.6)
+  pgn (= 0.1.1)
+  pry
   rspec (~> 3.3.0)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -1,23 +1,17 @@
 Chess Openings
 ==========================
-Future Ruby gem to calculate Chess Openings from a PGN file (and others)
-
-## TODOS:
-- Write documentation
-- Wrap everything up in a Ruby gem
-- Get opening from FEN
-- Make CLI to parse openings from website
+Ruby gem that where you can manipulate, search for and get information from chess openings.
 
 ## Features:
 - Get opening from PGN file
 - Get opening from PGN string
 - Get opening from array with moves
-- Get opening from FEN (maybe?)
+- Get opening from FEN
 - Search opening by name
 - Get all openings
 - Get all openings that start with some determined moves
 - Get PGN string from an opening
-- Get opening from FEN
+- Get FEN from an opening
 
 ## Installation
 
@@ -37,7 +31,127 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First things first, you need to create a new ChessOpenings object:
+
+```ruby
+chess_openings = ChessOpenings.new
+```
+
+From here you can use several functions:
+
+####.from_pgn
+Get opening from PGN file
+
+```ruby
+chess_openings = ChessOpenings.new
+opening = chess_openings.from_pgn('path_to/pgn_game.pgn')
+#=> #<Opening:0x007fda6237b510 @name="English, Sicilian reversed", @eco_code="A25", @moves=[:c4, :e5, :Nc3, :Nc6]>
+```
+
+
+####.from_string
+Get opening from a string, formated like a PGN file
+
+```ruby
+chess_openings = ChessOpenings.new
+opening = chess_openings.from_string("1.e4 e5 2.Nf3 Nc6 3.Bb5 a6 4.Bxc6")
+#=> #<Opening:0x007f820961bf60 @name="Ruy Lopez, exchange variation", @eco_code="C68", @moves=[:e4, :e5, :Nf3, :Nc6, :Bb5, :a6, :Bxc6]>
+```
+
+
+####.from_moves
+Get opening from an array with moves (as symbols or strings)
+
+```ruby
+chess_openings = ChessOpenings.new
+opening = chess_openings.from_moves [:e4, :c6, :d4, :d5]
+#=> #<Opening:0x007f8209d9c910 @name="Caro-Kann defence", @eco_code="B12", @moves=[:e4, :c6, :d4, :d5]>
+```
+
+####.with_name
+Search openings by name
+
+```ruby
+chess_openings = ChessOpenings.new
+openings = chess_openings.with_name "alekhine defence"
+=begin
+[
+  [ 0] #<Opening:0x007f8209de8a18 @name="Alekhine's defence", @eco_code="B02", @moves=[:e4, :Nf6]>,
+  [ 1] #<Opening:0x007f8209de8950 @name="Alekhine's defence, Scandinavian variation", @eco_code="B02", @moves=[:e4, :Nf6, :Nc3, :d5]>,
+  [ 2] #<Opening:0x007f8209de87e8 @name="Alekhine's defence, Spielmann variation", @eco_code="B02", @moves=[:e4, :Nf6, :Nc3, :d5, :e5, :Nfd7, :e6]>,
+  ...
+]
+=end
+```
+
+####.get_all
+Get all existing openings as an array
+
+```ruby
+chess_openings = ChessOpenings.new
+all_openings = chess_openings.get_all
+=begin
+[
+  [0] #<Opening:0x007f8209dd4b30 @name="Polish (Sokolsky) opening", @eco_code="A00", @moves=[:b4]>,
+  [1] #<Opening:0x007f8209dd4a90 @name="Polish, Tuebingen variation", @eco_code="A00", @moves=[:b4, :Nh6]>,
+  [2] #<Opening:0x007f8209dd49c8 @name="Polish, Outflank variation", @eco_code="A00", @moves=[:b4, :c6]>,
+  ...
+]
+=end
+```
+
+####.that_start_with
+Get all possible openings that start with determined moves
+
+```ruby
+chess_openings = ChessOpenings.new
+e4_e5_openings = chess_openings.that_start_with [:e4, :e5]
+
+=begin
+[
+  [0] #<Opening:0x007ff69c858258 @name="King's pawn game", @eco_code="C20", @moves=[:e4, :e5]>,
+  [1] #<Opening:0x007ff69c858190 @name="KP, Indian opening", @eco_code="C20", @moves=[:e4, :e5, :d3]>,
+  [2] #<Opening:0x007ff69c8580a0 @name="KP, Mengarini's opening", @eco_code="C20", @moves=[:e4, :e5, :a3]>,
+  [3] #<Opening:0x007ff69a1a3dd8 @name="KP, King's head opening", @eco_code="C20", @moves=[:e4, :e5, :f3]>,
+  [4] #<Opening:0x007ff69a1a3248 @name="KP, Patzer opening", @eco_code="C20", @moves=[:e4, :e5, :Qh5]>
+  ...
+]
+=end
+```
+
+####.from_fen
+Get opening from FEN string
+
+```ruby
+opening_from_fen = chess_openings.from_fen 'rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq e6 0 2'
+#=> #<Opening:0x007ff69c858258 @name="King's pawn game", @eco_code="C20", @moves=[:e4, :e5]>
+```
+
+
+
+
+
+When you have a opening you can invoke these methods on it:
+
+####.to_pgn
+Get PGN string from an opening
+
+```ruby
+opening = chess_openings.from_moves [:e4, :e5, :Nf3, :Nc6, :Bb5, :a6, :Bxc6]
+#=> #<Opening:0x007f820961bf60 @name="Ruy Lopez, exchange variation", @eco_code="C68", @moves=[:e4, :e5, :Nf3, :Nc6, :Bb5, :a6, :Bxc6]>
+opening.to_pgn
+#=> "1.e4 e5 2.Nf3 Nc6 3.Bb5 a6 4.Bxc6"
+```
+
+####.to_fen
+Get FEN string of the opening
+
+```ruby
+opening = chess_openings.from_moves [:e4, :e5]
+#=> #<Opening:0x007ff69c858258 @name="King's pawn game", @eco_code="C20", @moves=[:e4, :e5]>
+opening.to_fen
+#=> 'rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq e6 0 2'
+```
 
 ## Development
 

data/{openings_parser.rb → bin/openings_parser}

@@ -1,7 +1,11 @@
+#!/usr/bin/env ruby
+
 require 'nokogiri'
 require 'open-uri'
 require 'json'
-load 'opening.rb'
+require_relative '../lib/chess_openings/opening'
+
+puts 'working'
 
 def get_eco_code(name)
   name.split(' ').first
@@ -11,33 +15,30 @@ def remove_eco_code(name)
   name.split(' ').drop(1).join(' ')
 end
 
-def has_more_than_1_code?(name)
+def more_than_1_code?(name)
   get_eco_code(name).size > 3
 end
 
 def convert_line_to_array(moves)
-  moves.split(' ').select{ |move| !move.include?('.') }
+  moves.split(' ').select { |move| !move.include?('.') }
 end
 
-initial_page = "http://www.365chess.com/eco.php"
+initial_page = 'http://www.365chess.com/eco.php'
 
 openings = []
 pages_to_scrap = [initial_page]
 
 # Scrap pages in pages_to_scrap array and dump Opening objects to openings array
 pages_to_scrap.each do |link|
-  
-  page = Nokogiri::HTML(open(link))   
+  page = Nokogiri::HTML(open(link))
   page.css('ul#tree li.closed div.line').each do |line|
-
-    if has_more_than_1_code?(line.css('div.opname a').text)
-    
-      pages_to_scrap << line.css('div.opname a').first["href"]
+    if more_than_1_code?(line.css('div.opname a').text)
+      pages_to_scrap << line.css('div.opname a').first['href']
     else
       name = remove_eco_code(line.css('div.opname a').text)
       eco = get_eco_code(line.css('div.opname a').text)
-      moves = convert_line_to_array(line.css('div.fright').text.empty? ? line.css('div.opmoves').text : line.css('div.fright').text)
-
+      class_name = line.css('div.fright').text.empty? ? 'opmoves' : 'fright'
+      moves = convert_line_to_array(line.css("div.#{class_name}").text)
       openings << Opening.new(name, eco, moves)
     end
   end
@@ -59,27 +60,27 @@ end
 if invalid_openings.empty?
 
   # Convert array elements to hashes
-  openings.map! { |op| op.to_h }
+  openings.map!(&:to_h)
 
   # Write to JSON
-  File.delete("openings.json") if File.exists?("openings.json")
-  File.open("openings.json", "a+") do |file|
+  json_file = 'openings.json'
+  File.delete(json_file) if File.exist?(json_file)
+  File.open(json_file, 'a+') do |file|
     file.write("{\n")
     file.write("\"openings\": [\n")
-    
+
     openings.each_with_index do |op, index|
-      result = openings.size == index + 1 ? "" : ", "
+      result = openings.size == index + 1 ? '' : ', '
       file.write("#{JSON.generate(op)}#{result}\n")
     end
-    
-    file.write("]")
-    file.write("}")
 
-    puts "openings.json was successfully created!"
+    file.write(']')
+    file.write('}')
+
+    puts 'openings.json was successfully created!'
   end
 
 else
-  puts "There were some invalid openings detected:"
+  puts 'There were some invalid openings detected:'
   puts invalid_openings
 end
-

data/chess_openings.gemspec

@@ -3,26 +3,28 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "chess_openings"
-  spec.version       = "0.0.3"
-  spec.authors       = ["Simão Neves"]
-  spec.email         = ["simaocostaneves@gmail.com"]
+  spec.name          = 'chess_openings'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Simão Neves']
+  spec.email         = ['simaocostaneves@gmail.com']
 
   if spec.respond_to?(:metadata)
   end
 
-  spec.summary       = "Gem that allows you to calculate which opening was used in a chess game"
-  spec.description   = "Gem that allows you to know what chess opening was used in a chess game, find chess openings by name or get all openings that start with certain moves"
-  spec.homepage      = "http://www.github.com/simaoneves/chess_openings"
-  spec.license       = "MIT"
+  spec.summary       = 'Gem that allows you to calculate which opening was used in a chess game'
+  spec.description   = 'Gem that allows you to know what chess opening was used in a chess game, find chess openings by name or get all openings that start with certain moves'
+  spec.homepage      = 'http://www.github.com/simaoneves/chess_openings'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.executables << 'openings_parser'
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "pgn", '0.0.6'
+  spec.add_dependency 'pgn', '0.1.1'
   spec.add_dependency 'nokogiri', '1.6.6.2'
-  spec.add_development_dependency "bundler", '~> 1.8'
-  spec.add_development_dependency "rspec", '~> 3.3.0'
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'pry'
 end