supcom2_replay_parser 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bfda5dd83e97db2ea6db211fc1d2e86293337d0bc3697859e9ce1478e23ae9c
+  data.tar.gz: a6273fb8f51c069e4bd0a7ab1712cc83c98b30628bf02b018d3cd7d74c227d83
+SHA512:
+  metadata.gz: fa55ef1a2247f29b9250e5fd667a6a047d041e21557c6e52adfe55cb83eb27c238237193ee3755e4f9676a83004782105523647a568da6a082e25ff8af169b6b
+  data.tar.gz: 4276c6dc862ebef33abe1288c2ab94a7d90c82b6fcfdd5872204e3d908008528aa38e76eddf39c75800b0649714ea167d66b1a720e04462b330d43803eaf3417

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/Gemfile.lock
+/InstalledFiles
+/*.gem
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+ruby ['>= 2.4.0', '<= 2.7.1'] # 2.7.1 is latest ruby on 2020-04-07
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 SupDex
+
+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,46 @@
+# Supcom2ReplayParser
+
+Gem for parsing replays of Supreme Commander 2. It returns all info about players, map and game options from replay
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'supcom2_replay_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supcom2_replay_parser
+
+## Usage
+
+```
+require 'pp'
+replay_info = SupCom2ReplayParser.call(file_path)
+pp replay_info
+
+###
+{:game_version=>"Supreme Commander v1.26",
+ :replay_version=>"Replay v1.9",
+ :players_info=>
+  [{:nickname=>"lvl0 <| m.o.b", :color=>:orange, :faction=>:cybran, :team=>1},
+   {:nickname=>"HUECTRUM", :color=>:white, :faction=>:uef, :team=>2}],
+ :game_options=>
+  {"FogOfWar"=>"explored",
+   "NoRushOption"=>"Off",
+   "AllowObservers"=>"",
+   "TeamSpawn"=>"fixed",
+   "Victory"=>"demoralization",
+   "map"=>"[2] Spring Duel"}}
+###
+```
+
+## License
+
+[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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "supcom2_replay_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/supcom2_replay_parser

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'supcom2_replay_parser'
+
+puts SupCom2ReplayParser.call(ARGV[0].to_s)

data/lib/supcom2_replay_parser/data.rb

@@ -0,0 +1,33 @@
+module SupCom2ReplayParser
+  module Data
+    FACTIONS = {
+      "@@"           => :illuminate,
+      "\u0000@"      => :cybran,
+      "\u0080?"      => :uef
+    }.freeze
+
+    COLORS = {
+      "@@"           => :purple,
+      "\u0000@"      => :red,
+      "\u00A0@"      => :white,
+      "\u0080?"      => :green,
+      "\u0000\u0000" => :blue,
+      "\u0010A"      => :orange,
+      "\u0000A"      => :yellow,
+      "\u00E0@"      => :turquoise,
+      "\u00C0@"      => :khaki,
+      "\u0080@"      => :brown
+    }.freeze
+
+    TEAMS = {
+      "\u0000@"      => 1,
+      "@@"           => 2,
+      "\u0080@"      => 3,
+      "\u00A0@"      => 4,
+      "\u00C0@"      => 5,
+      "\u00E0@"      => 6,
+      "\u0000A"      => 7,
+      "\u0010A"      => 8
+    }
+  end
+end

data/lib/supcom2_replay_parser/game_options.rb

@@ -0,0 +1,17 @@
+module SupCom2ReplayParser
+  module GameOptions
+    FIELDS = %w[
+      FogOfWar
+      NoRushOption
+      AllowObservers
+      TeamSpawn
+      Victory
+    ].freeze
+
+    def self.call(line)
+      options = Hash[line.scan(/(#{FIELDS.join('|')})+\0{1}\u{ 3 }{0,1}\u{ 1 }{1}([^[[:cntrl:]]]{0,})[[:cntrl:]]{1}/)]
+
+      options.merge!('map' => line.scan(/name+[[:cntrl:]]{2}<{1}[^[[:cntrl:]]]+>{1}([^[[:cntrl:]]]+)[[:cntrl:]]{1}/).to_a.dig(-1, 0))
+    end
+  end
+end

data/lib/supcom2_replay_parser/players_info.rb

@@ -0,0 +1,40 @@
+module SupCom2ReplayParser
+  module PlayersInfo
+    extend self
+
+    PLAYERS_FIELDS = %w[
+      PlayerName
+      PlayerColor
+      Faction
+      Team
+    ].freeze
+
+    def call(line)
+      prepare_data(line.scan(/(?:#{PLAYERS_FIELDS.join('|')})+[[:cntrl:]]{2}[^[[:cntrl:]]]{0,}[^\u{ 1 }]+/))
+    end
+
+    private
+
+    def prepare_data(data)
+      data = data.each_slice(PLAYERS_FIELDS.size).to_a
+
+      data.each_with_object([]) do |elements, acum|
+        player = {}
+
+        elements.each do |element|
+          if element.start_with?('PlayerName')
+            player[:nickname] = element.encode('iso-8859-1').force_encoding('utf-8').gsub(/[[:cntrl:]]|PlayerName/, '')
+          elsif element.start_with?('PlayerColor')
+            player[:color] = Data::COLORS[element[-2..-1]]
+          elsif element.start_with?('Faction')
+            player[:faction] = Data::FACTIONS[element[-2..-1]]
+          elsif element.start_with?('Team')
+            player[:team] = Data::TEAMS[element[-2..-1]]
+          end
+        end
+
+        acum << player
+      end
+    end
+  end
+end

data/lib/supcom2_replay_parser/version.rb

@@ -0,0 +1,3 @@
+module Supcom2ReplayParser
+  VERSION = "0.3.1"
+end

data/lib/supcom2_replay_parser.rb

@@ -0,0 +1,57 @@
+require 'supcom2_replay_parser/version'
+require 'supcom2_replay_parser/data'
+require 'supcom2_replay_parser/game_options'
+require 'supcom2_replay_parser/players_info'
+
+module SupCom2ReplayParser
+  extend self
+
+  ALLOWED_EXTENSION = '.SC2ReplayDLC'
+
+  def call(filepath)
+    raise Exception, "Allowed only files with extension #{ALLOWED_EXTENSION}" unless allow_file_extension?(filepath)
+
+    replay_info = {}
+
+    file_lines = File.new(filepath, encoding: 'ISO-8859-1:UTF-8')
+
+    file_lines.each do |line|
+      current_line = file_lines.lineno
+
+      if current_line == 1
+        replay_info[:game_version] = line.sub(/[[:cntrl:]]/, '').chomp
+      end
+
+      if current_line == 2
+        replay_info[:replay_version] = line.sub(/[[:cntrl:]]/, '').chomp
+      end
+
+      if current_line == 4 || current_line == 5
+        next if !has_line_full_needed_data?(line) && current_line == 4
+
+        raise Exception, 'Replay is broken' unless has_line_full_needed_data?(line)
+
+        replay_info.merge!({
+          players_info: PlayersInfo.call(line),
+          game_options: GameOptions.call(line)
+        })
+
+        break
+      end
+    end
+
+    raise Exception, 'Replay is broken' if replay_info.empty?
+
+    replay_info
+  end
+
+  private
+
+  def has_line_full_needed_data?(line)
+    line.match?(/(#{GameOptions::FIELDS.join('|')})/)
+  end
+
+  def allow_file_extension?(file)
+    File.extname(file) == ALLOWED_EXTENSION
+  end
+end

data/supcom2_replay_parser.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "supcom2_replay_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'supcom2_replay_parser'
+  spec.version       = Supcom2ReplayParser::VERSION
+  spec.author       = 'SupDex'
+  spec.email         = 'symeton@gmail.com'
+
+  spec.summary       = 'SupCom2ReplayParser - Gem for parsing replays of game Supreme Commander 2'
+  spec.homepage      = 'https://github.com/Symeton/supcom2_replay_parser'
+  spec.license       = 'MIT'
+
+  # 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{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.9"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: supcom2_replay_parser
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- SupDex
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: 
+email: symeton@gmail.com
+executables:
+- supcom2_replay_parser
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- exe/supcom2_replay_parser
+- lib/supcom2_replay_parser.rb
+- lib/supcom2_replay_parser/data.rb
+- lib/supcom2_replay_parser/game_options.rb
+- lib/supcom2_replay_parser/players_info.rb
+- lib/supcom2_replay_parser/version.rb
+- supcom2_replay_parser.gemspec
+homepage: https://github.com/Symeton/supcom2_replay_parser
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: SupCom2ReplayParser - Gem for parsing replays of game Supreme Commander 2
+test_files: []