fide_xml_parser 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 706820b647cf190a5e17304d1cb22c7af1921b8e84f4310cc1dee6061de51f57
-  data.tar.gz: d64a2a33a80963bd30a7881393333f6464e1bee3b622e3e48a5831e7e0450b4f
+  metadata.gz: 16cf18729c304b19bc521574841ad100b5aed0b9bd95dedb93e7e6474b83d251
+  data.tar.gz: 10b3e2bce46890eaee461199ccda229a0cec85e11b03a1d373f361c37b47fe24
 SHA512:
-  metadata.gz: 4515194fdf260fac89050ad6216069cdeb26a3516f5e6837e597d2af24fcad89bb6829a4a6602d02ddb9f12bb90a7d67b50c61ee35afbc5b6841654e81154f58
-  data.tar.gz: 667235af5570310f71120607ae937102162121a0e4bd2075d86b1cb731b0c6622f6d36c76ce721735164f2e0488a17748c7386352ea5aab26e5d928836c886fe
+  metadata.gz: 66f43b7384936aff168df5275af752bf050a3ab9205c1dec927e410df187f904cb6e58efdb0a2456cb5f9ad27b1b765084b252e3644c7b8a7ea92a9db49e9524
+  data.tar.gz: '08ceb66194d7b95ee64cc6cc54759f7662aac2555ff6c00742c37142c91fccc0e54abc87c37c4c8e1d2eacf0e189436bd005c5bc1c19322fc610c62e95b64cc8'

data/CHANGELOG.md

@@ -4,4 +4,10 @@ First release.
 
 ### 0.2.0
 
-* API change: change last 2 write method arguments to keyword arguments.
+* API change: change last 2 write method arguments to keyword arguments.
+
+### 0.3.0
+
+* Parser can now be configured with array name, record name, and numeric field list.
+* Interface has changed, must instantiate FideParser for FIDE files.
+* Field name renames (renaming) can now be done.

data/fide_xml_parser.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   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."
+  spec.metadata["changelog_uri"] = 'https://github.com/keithrbennett/fide-xml-parser/blob/master/CHANGELOG.md'
 
   # 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.
@@ -29,11 +29,10 @@ Gem::Specification.new do |spec|
   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 "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/fide_xml_parser/fide_processor.rb

@@ -0,0 +1,23 @@
+require_relative 'processor'
+
+module FideXmlParser
+
+  class FideProcessor < Processor
+
+    NUMERIC_FIELDS = %w[
+        k
+        blitz_k
+        rapid_k
+        rating
+        blitz_rating
+        rapid_rating
+        games
+        blitz_games
+        rapid_games
+    ].map(&:freeze)
+
+    def initialize
+      super('playerslist', 'player', NUMERIC_FIELDS)
+    end
+  end
+end

data/lib/fide_xml_parser/json_writer.rb

@@ -5,12 +5,13 @@ module FideXmlParser
 class JsonWriter
 
   attr_reader :parser
-  attr_accessor :key_filter, :record_filter
+  attr_accessor :key_filter, :record_filter, :field_name_renames
 
 
   def initialize
     @key_filter = nil
     @record_filter = nil
+    @field_name_renames = nil
   end
 
 
@@ -57,9 +58,10 @@ class JsonWriter
   # 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 = FideXmlParser::FideProcessor.new
     parser.key_filter = key_filter
     parser.record_filter = record_filter
+    parser.field_name_renames = field_name_renames
     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')

data/lib/fide_xml_parser/processor.rb

@@ -1,6 +1,5 @@
 require 'awesome_print'
 require 'nokogiri'
-require 'tty-cursor'
 
 module FideXmlParser
 
@@ -18,27 +17,38 @@ module FideXmlParser
 # 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.
+
+# 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'
+#   }
+
+
 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
+
+  # Constructor parameters:
+  attr_accessor :numeric_fields, :array_name, :record_name
+
+  # 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 = "\033[1G"
+
+  def initialize(array_name, record_name, numeric_fields)
+    @array_name = array_name
+    @record_name = record_name
+    @numeric_fields = numeric_fields
     @key_filter = nil
     @record_filter = nil
+    @field_name_renames = nil
     @current_property_name = nil
     @record = {}
     @records = []
@@ -62,7 +72,7 @@ class Processor < Nokogiri::XML::SAX::Document
 
 
   def output_status
-    print TTY::Cursor.column(1)
+    print ANSI_GO_TO_LINE_START
     print "Records processed: %9d   kept: %9d    Seconds elapsed: %11.2f" % [
         input_record_count,
         output_record_count,
@@ -73,9 +83,9 @@ class Processor < Nokogiri::XML::SAX::Document
 
   def start_element(name, _attrs)
     case name
-    when 'playerslist'
+    when array_name
       # ignore
-    when 'player'
+    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
@@ -86,9 +96,9 @@ class Processor < Nokogiri::XML::SAX::Document
 
   def end_element(name)
     case name
-    when 'playerslist'  # end of data, write JSON file
+    when array_name  # end of data, write JSON file
       finish
-    when 'player'
+    when record_name
       if record_filter.nil? || record_filter.(record)
         self.output_record_count += 1
         records << record
@@ -103,8 +113,15 @@ class Processor < Nokogiri::XML::SAX::Document
   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
+        value = numeric_fields.include?(current_property_name) ? Integer(string) : string
+        key = current_property_name
+        if field_name_renames
+          new_field_name = field_name_renames[key]
+          if new_field_name
+            key = new_field_name
+          end
+        end
+        record[key] = value
       end
     end
   end

data/lib/fide_xml_parser/rating_combiner.rb

@@ -0,0 +1,9 @@
+# Combines a standard, blitz, and rapid data set into a combined data set.
+
+class RatingCombiner
+
+  def initialize
+
+  end
+
+end

data/lib/fide_xml_parser/version.rb

@@ -1,3 +1,3 @@
 module FideXmlParser
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fide_xml_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !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
@@ -84,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -126,8 +112,10 @@ files:
 - Rakefile
 - fide_xml_parser.gemspec
 - lib/fide_xml_parser.rb
+- lib/fide_xml_parser/fide_processor.rb
 - lib/fide_xml_parser/json_writer.rb
 - lib/fide_xml_parser/processor.rb
+- lib/fide_xml_parser/rating_combiner.rb
 - lib/fide_xml_parser/version.rb
 homepage: https://github.com/keithrbennett/fide-xml-parser
 licenses:
@@ -136,6 +124,7 @@ 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
+  changelog_uri: https://github.com/keithrbennett/fide-xml-parser/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: