simple_xml_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45afd6e422ed64eafb1230a18868283a63829269bb2832a3d593414bcf9c86c4
+  data.tar.gz: 309bd5a23cbb2548beba4d4665c2b6f5314efa9e504c22548c3d12ece5d8cb46
+SHA512:
+  metadata.gz: 94ebcd0970acbac78dab7eb6c7efaa89d7686013b6c03aace174f3c99f42ca3cefcabf6f870759ba6542c567c6dc50221b0bb2a1381e25cd2f9128706871bd5d
+  data.tar.gz: 654c05a9d1b30f6dd321c91915787ed747aa5e56b21959b96e61c9bac79e23e9244cc0903d6bc211c5f2c09d9ff0d4def20f757396beb36b64400f2f79cc8ce0

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,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### v0.1.0
+
+* Copied files from fide_xml_parser gem/repo and modified them.

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_xml_parser.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

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.md

@@ -0,0 +1,40 @@
+# SimpleXmlParser
+
+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/simple_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 'simple_xml_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_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]/simple_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/lib/simple_xml_parser.rb

@@ -0,0 +1,13 @@
+require "simple_xml_parser/version"
+
+module SimpleXmlParser
+
+  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/simple_xml_parser/fide_xml_parser.rb

@@ -0,0 +1,36 @@
+require_relative 'parser'
+
+module SimpleXmlParser
+
+# This class is provided as an example of how the Parser can be subclassed
+# to implement specialized behavior for your data file.
+#
+# It parses chess player/rating "combined" XML files provided at
+# https://ratings.fide.com/download_lists.phtml.
+class FideXmlParser < Parser
+
+    # These field names will work even if field_name_renames are provided, because
+    # they are accessed before the renaming is done.
+  INTEGER_FIELDS = %w[
+    birthday
+    k
+    blitz_k
+    rapid_k
+    rating
+    blitz_rating
+    rapid_rating
+    games
+    blitz_games
+    rapid_games
+  ].map(&:freeze)
+
+  def initialize(key_filter: nil, record_filter: nil, field_name_renames: nil)
+    super(array_name:         'playerslist',
+          record_name:        'player',
+          integer_fields:     INTEGER_FIELDS,
+          key_filter:         key_filter,
+          record_filter:      record_filter,
+          field_name_renames: field_name_renames)
+  end
+end
+end

data/lib/simple_xml_parser/json_writer.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+module SimpleXmlParser
+
+class JsonWriter
+
+  attr_reader :records
+
+  def initialize(records)
+    @records = records
+  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_mode, json_filespec: 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: 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)
+    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/simple_xml_parser/parser.rb

@@ -0,0 +1,142 @@
+require 'awesome_print'
+require 'nokogiri'
+
+module SimpleXmlParser
+
+# A field_name_renames hash can be provided.
+# Keys are the field names in the XML input, values are the names in the output JSON, e.g.:
+#   {
+#       'rating' => 'standard_rating',
+#       'games'  => 'standard_games'
+#   }
+
+# 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 }
+# If a field name has been changed via the field_name_renames hash, the new name should be used in the filter.
+
+class Parser < Nokogiri::XML::SAX::Document
+
+  attr_reader :start_time
+
+  # Constructor parameters:
+  attr_reader :array_name, :record_name, :integer_fields
+
+  # User-provided callbacks:
+  attr_accessor :key_filter, :record_filter, :field_name_renames
+
+  # For internal use:
+  attr_accessor :current_property_name, :record, :records, :input_record_count, :output_record_count
+
+  ANSI_GO_TO_LINE_START = "\e[1G"
+
+  def initialize(array_name:, record_name:, integer_fields: nil,
+                 key_filter: nil, record_filter: nil, field_name_renames: nil)
+    @array_name = array_name
+    @record_name = record_name
+    @integer_fields = integer_fields
+    @key_filter = key_filter
+    @record_filter = record_filter
+    @field_name_renames = field_name_renames
+    @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)
+    data_source = File.new(data_source) if data_source.is_a?(String)
+    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 ANSI_GO_TO_LINE_START
+    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 array_name
+      # ignore
+    when record_name
+      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 array_name  # end of data, write JSON file
+      finish
+    when record_name
+      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 output_field_name(input_field_name)
+    return input_field_name if field_name_renames.nil?
+    field_name_renames[input_field_name] || input_field_name
+  end
+
+
+  def maybe_convert_to_integer(field_name, value)
+    needs_conversion = integer_fields&.include?(field_name)
+    needs_conversion ? Integer(value) : value
+  end
+
+
+  def include_this_field?(field_name)
+    key_filter.nil? || key_filter.(field_name)
+  end
+
+
+  def characters(string)
+    if current_property_name && include_this_field?(current_property_name)
+      key = output_field_name(current_property_name)
+      value = maybe_convert_to_integer(current_property_name, string)
+      record[key] = value
+    end
+  end
+
+
+  def finish
+    output_status
+    puts
+  end
+end
+end

data/lib/simple_xml_parser/version.rb

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

data/simple_xml_parser.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/simple_xml_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_xml_parser"
+  spec.version       = SimpleXmlParser::VERSION
+  spec.authors       = ["Keith Bennett"]
+  spec.email         = ["keithrbennett@gmail.com"]
+
+  spec.summary       = %q{Parses simple (record array) XML text.}
+  spec.description   = %q{Parses XML containing an array of records into an array of Ruby hashes.}
+  spec.homepage      = "https://github.com/keithrbennett/simple_xml_parser"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.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"] = spec.homepage
+
+  # 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 "pry", "~> 0.12"
+  spec.add_dependency "awesome_print", "~> 1.8"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: simple_xml_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Bennett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-11 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: 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'
+description: Parses XML containing an array of records into an array of Ruby hashes.
+email:
+- keithrbennett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_xml_parser.rb
+- lib/simple_xml_parser/fide_xml_parser.rb
+- lib/simple_xml_parser/json_writer.rb
+- lib/simple_xml_parser/parser.rb
+- lib/simple_xml_parser/version.rb
+- simple_xml_parser.gemspec
+homepage: https://github.com/keithrbennett/simple_xml_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/keithrbennett/simple_xml_parser
+  source_code_uri: https://github.com/keithrbennett/simple_xml_parser
+  changelog_uri: https://github.com/keithrbennett/simple_xml_parser
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Parses simple (record array) XML text.
+test_files: []