fide_xml_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67692b8c9fd3d78f38dd2dd37f3fa2de2586bfe70ba71f6be08fd0db0654383b
+  data.tar.gz: e55d84d2b2b6df2680dc646a9a873d969f909fc96c9b9d0526e979cddaebaec8
+SHA512:
+  metadata.gz: ad8ac8524c1d89227b084df75ad505b98863e404af7d6f853ee29641cdda37e97be655ec68687c46e601f825b52ad8656e2c6fa0a13f9487cc56e61e62b752da
+  data.tar.gz: 92bf11de84011190588baef367d8512585b5b8a04e68c209a86b827d20aa3ddd0c6401e715e2b88473aa368bae9ce4b7a0f690eb49019444e8924ceaacbf345d

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.0
+
+First release.
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Keith Bennett
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README-from-old-repo.md

@@ -0,0 +1,64 @@
+# FIDE Chess Player Rating Information XML to JSON Converter & Data Analyzer
+
+This repo contains two scripts:
+ 
+* [fide_xml_to_json.rb](fide_xml_to_json.rb) - generates a JSON file from an XML file downloaded from [https://ratings.fide.com/download_lists.phtml](https://ratings.fide.com/download_lists.phtml) or [https://ratings.fide.com/download.phtml](https://ratings.fide.com/download.phtml).
+* [analyze_fide_data.rb](analyze_fide_data.rb) - generates a JSON file containing statistics from a JSON file produced by fide_xml_to_json.rb. This file may not necessarily include information useful to you, but is an example of how the data can be manipulated. Sample output files are in the [samples](./samples) directory.
+
+
+## Installation Instructions
+
+Download or clone this repository.
+
+These scripts are Ruby scripts. They uses Ruby gems (libraries). Install the gems by running `bundle` in the project directory. (Ruby and these gems work best in Mac OS or Linux. Windows should work but may present challenges.)
+
+If you are running on Mac OS or Linux, you can `chmod +x *.rb` so that you can invoke the scripts without preceding their filespecs with `ruby`.
+
+
+## Operating Instructions
+
+The scripts output the JSON in "pretty" format that is more human-readable than compact JSON. If you need to, you can use compact mode instead by changing the calls from `JSON.pretty_generate(records)` to `records.to_json`.
+
+### fide_xml_to_json.rb
+
+[fide_xml_to_json.rb](fide_xml_to_json.rb) syntax is:
+
+`ruby fide_xml_to_json.rb my_file.xml`
+
+It will show its progress, and when it is finished parsing all the XML records will write the JSON representation of the parsed data to a file whose name is the same as the XML file, but with `.xml` changed to `.json`.
+
+### analyze_fide_data.rb
+
+[analyze_fide_data.rb](./analyze_fide_data.rb) syntax is:
+
+`ruby analyze_fide_data.rb my_file.json`
+
+It will read and parse the JSON file, analyze the data, and then output it (in pretty JSON format) to a file whose name is the same as the input file's, but with a `-stats` inserted before the `.json`.
+
+
+## Adding Your Own Functionality
+
+Assuming one can write even simple Ruby code, manipulating the data is easy.
+ 
+You can write a script that includes:
+
+```ruby
+require 'json'
+records = JSON.parse(File.read('my_file.json'))
+```
+
+...and then use Ruby's excellent [Enumerable support](https://ruby-doc.org/core-2.7.0/Enumerable.html) to analyze or manipulate the `records` array.
+ 
+As examples, the following can easily be done:
+
+* _field filtering_ - exclude some fields from the JSON output
+* _record filtering_ - exclude records meeting specified criteria
+* _statistical analysis_ - analysis of the parsed data
+* _data validation_ - to look for data errors and ambiguities
+
+You could also insert the following to get an interactive Ruby shell where `self` is the records array. (You may need to `gem install pry` if it hasn't already been installed.):
+
+```ruby
+require 'pry'
+records.pry
+```

data/README.md

@@ -0,0 +1,42 @@
+# FideXmlParser
+
+#### Sorry, the README is not yet written. Below is the boilerplate text:
+
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fide_xml_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fide_xml_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fide_xml_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fide_xml_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/fide_xml_parser.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fide_xml_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fide_xml_parser"
+  spec.version       = FideXmlParser::VERSION
+  spec.authors       = ["Keith Bennett"]
+  spec.email         = ["keithrbennett@gmail.com"]
+
+  spec.summary       = %q{Parses XML files downloaded from fide.com and writes JSON files.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/keithrbennett/fide-xml-parser"
+  spec.license       = "Apache-2.0"
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = '' # "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|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 "nokogiri", "~>1.10"
+  spec.add_dependency "tty-cursor", "~> 0.7"
+  spec.add_dependency "pry", "~> 0.12"
+  spec.add_dependency "awesome_print", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fide_xml_parser.rb

@@ -0,0 +1,11 @@
+module FideXmlParser
+
+lib_dir = File.dirname(__FILE__)
+file_mask = File.join(lib_dir, '**', '*.rb')
+Dir[file_mask].each do |ruby_file|
+  require ruby_file
+end
+
+class Error < StandardError; end
+
+end

data/lib/fide_xml_parser/json_writer.rb

@@ -0,0 +1,71 @@
+require 'json'
+
+module FideXmlParser
+
+class JsonWriter
+
+  attr_reader :parser
+  attr_accessor :key_filter, :record_filter
+
+
+  def initialize
+    @key_filter = nil
+    @record_filter = nil
+  end
+
+
+  # Checks all input filespecs before processing the first one.
+  # Verifies not nil, ends in ".xml" (case insensitive), and exists as a file.
+  def validate_input_filespecs(filespecs)
+    filespecs = Array(filespecs)
+    bad_filespecs = filespecs.select do |filespec|
+      filespec.nil? || (! /\.xml$/.match(filespec)) || (! File.file?(filespec))
+    end
+    if bad_filespecs.any?
+      raise "The following filespecs were not valid XML filespecs: #{bad_filespecs.join(', ')}"
+    end
+  end
+
+
+  # Public entry point to write JSON file(s) from XML.
+  # To write a single file, pass the filespec as the `input_filespecs` parameter.
+  # To write multiple files, pass an array of filespecs as the `input_filespecs` parameter
+  # json_mode: :pretty for human readable JSON, :compact for compact JSON
+  # Default json_filespec will be constructed from the input file, just replacing 'xml' with 'json'.
+  def write(input_filespec, json_mode = :pretty, json_filespec = nil)
+    if input_filespec.is_a?(Array)
+      raise Error.new("This method is used only for single files, use write_multiple for multiple files.")
+    end
+
+    validate_input_filespecs(Array[input_filespec])
+    write_private(input_filespec, json_mode, json_filespec)
+  end
+
+
+  # Public entry point to write multiple files.
+  # json_mode: :pretty for human readable JSON, :compact for compact JSON
+  def write_multiple(input_filespecs, json_mode = :pretty)
+    validate_input_filespecs(input_filespecs)
+    input_filespecs.each do |input_filespec|
+      write_private(input_filespec, json_mode)
+    end
+  end
+
+
+  # Implementation for writing a single file.
+  # Separated from the public `write` method in order to validate filespecs only once.
+  # Default json_filespec will be constructed from the input file, just replacing 'xml' with 'json'.
+  private
+  def write_private(input_filespec, json_mode = :pretty, json_filespec = nil)
+    @parser = FideXmlParser::Processor.new
+    parser.key_filter = key_filter
+    parser.record_filter = record_filter
+    records = parser.parse(File.new(input_filespec))
+
+    json_text = (json_mode == :pretty) ? JSON.pretty_generate(records) : records.to_json
+    json_filespec ||= input_filespec.sub(/\.xml$/, '.json')
+    File.write(json_filespec, json_text)
+    puts "#{records.size} records processed, #{input_filespec} --> #{json_filespec}"
+  end
+end
+end

data/lib/fide_xml_parser/processor.rb

@@ -0,0 +1,118 @@
+require 'awesome_print'
+require 'nokogiri'
+require 'tty-cursor'
+
+module FideXmlParser
+
+# Recommended entry point is Processor.parse, which creates an instance of the class, initiates the parse,
+# and returns the parsed data.
+#
+# Supports key and record filters.
+
+# For key filter, pass a lambda that takes a key name as a parameter
+# and returns true to include it, false to exclude it,
+# e.g. to exclude 'foo' and 'bar', do this:
+# processor.key_filter = ->(key) { ! %w(foo bar).include?(key) }
+
+# For record filter, pass a lambda that takes a record as a parameter,
+# and returns true to include it or false to exclude it,
+# e.g. to include only records with a "title", do this:
+# processor.record_filter = ->(rec) { rec.title }
+class Processor < Nokogiri::XML::SAX::Document
+
+  attr_reader :start_time
+  attr_accessor :current_property_name, :record, :records, :key_filter, :record_filter,
+                :input_record_count, :output_record_count
+
+  NUMERIC_FIELDS = %w[
+    k
+    blitz_k
+    rapid_k
+    rating
+    blitz_rating
+    rapid_rating
+    games
+    blitz_games
+    rapid_games
+  ]
+
+  def initialize
+    @key_filter = nil
+    @record_filter = nil
+    @current_property_name = nil
+    @record = {}
+    @records = []
+    @start_time = current_time
+    @keys_to_exclude = []
+    @input_record_count = 0
+    @output_record_count = 0
+  end
+
+
+  def parse(data_source)
+    parser = Nokogiri::XML::SAX::Parser.new(self)
+    parser.parse(data_source)
+    records
+  end
+
+
+  def current_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+
+
+  def output_status
+    print TTY::Cursor.column(1)
+    print "Records processed: %9d   kept: %9d    Seconds elapsed: %11.2f" % [
+        input_record_count,
+        output_record_count,
+        current_time - start_time
+    ]
+  end
+
+
+  def start_element(name, _attrs)
+    case name
+    when 'playerslist'
+      # ignore
+    when 'player'
+      self.input_record_count += 1
+      output_status if input_record_count % 1000 == 0
+    else # this is a field in the players record; process it as such
+      self.current_property_name = name
+    end
+  end
+
+
+  def end_element(name)
+    case name
+    when 'playerslist'  # end of data, write JSON file
+      finish
+    when 'player'
+      if record_filter.nil? || record_filter.(record)
+        self.output_record_count += 1
+        records << record
+      end
+      self.record = {}
+    else
+      self.current_property_name = nil
+    end
+  end
+
+
+  def characters(string)
+    if current_property_name
+      if key_filter.nil? || key_filter.(current_property_name)
+        value = NUMERIC_FIELDS.include?(current_property_name) ? Integer(string) : string
+        record[current_property_name] = value
+      end
+    end
+  end
+
+
+  def finish
+    output_status
+    puts
+  end
+end
+end

data/lib/fide_xml_parser/version.rb

@@ -0,0 +1,3 @@
+module FideXmlParser
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: fide_xml_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Bennett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Parses XML files downloaded from fide.com and writes JSON files.
+email:
+- keithrbennett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README-from-old-repo.md
+- README.md
+- Rakefile
+- fide_xml_parser.gemspec
+- lib/fide_xml_parser.rb
+- lib/fide_xml_parser/json_writer.rb
+- lib/fide_xml_parser/processor.rb
+- lib/fide_xml_parser/version.rb
+homepage: https://github.com/keithrbennett/fide-xml-parser
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/keithrbennett/fide-xml-parser
+  source_code_uri: https://github.com/keithrbennett/fide-xml-parser
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Parses XML files downloaded from fide.com and writes JSON files.
+test_files: []