vault_coh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e398c4277d3f495c8d75bd7a878fbba0a92c4f509caab4b782afeae21707ac30
+  data.tar.gz: 0d8a47ac15efb8513b5e71f52c3ba34b782ff75fba9cbccecc6f72095ab2a618
+SHA512:
+  metadata.gz: d7a5a45c518ba83d4ba6e911f6c251eee18f8606baab1b30b893657a50f859e2abda98c641cc8d6c7d29d500cb4cd1f5766aeea5bf184d48c2a0a37215984c58
+  data.tar.gz: 726566f51cd8a59df7f44952899862c68482bbbe7f8ae3516ecf161d1791e092a29f169b30db0e82609fbe3f09330722482475831e2e60e507262db7e161ac57

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-28
+
+- Initial release

data/Cargo.lock

@@ -0,0 +1,334 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "aho-corasick"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67fc08ce920c31afb70f013dcce1bfc3a3195de6a228474e45e1f145b36f8d04"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "bindgen"
+version = "0.60.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "062dddbc1ba4aca46de6338e2bf87771414c335f7b2f2036e8f3e9befebf88e6"
+dependencies = [
+ "bitflags",
+ "cexpr",
+ "clang-sys",
+ "lazy_static",
+ "lazycell",
+ "peeking_take_while",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "rustc-hash",
+ "shlex",
+]
+
+[[package]]
+name = "bitflags"
+version = "1.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
+name = "bytecount"
+version = "0.6.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2c676a478f63e9fa2dd5368a42f28bba0d6c560b775f38583c8bbaa7fcd67c9c"
+
+[[package]]
+name = "byteorder"
+version = "1.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "14c189c53d098945499cdfa7ecc63567cf3886b3332b312a5b4585d8d3a6a610"
+
+[[package]]
+name = "cexpr"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6fac387a98bb7c37292057cffc56d62ecb629900026402633ae9160df93a8766"
+dependencies = [
+ "nom",
+]
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "clang-sys"
+version = "1.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c688fc74432808e3eb684cae8830a86be1d66a2bd58e1f248ed0960a590baf6f"
+dependencies = [
+ "glob",
+ "libc",
+ "libloading",
+]
+
+[[package]]
+name = "glob"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"
+
+[[package]]
+name = "lazy_static"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+
+[[package]]
+name = "lazycell"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55"
+
+[[package]]
+name = "libc"
+version = "0.2.143"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "edc207893e85c5d6be840e969b496b53d94cec8be2d501b214f50daa97fa8024"
+
+[[package]]
+name = "libloading"
+version = "0.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b67380fd3b2fbe7527a606e18729d21c6f3951633d0500574c4dc22d2d638b9f"
+dependencies = [
+ "cfg-if",
+ "winapi",
+]
+
+[[package]]
+name = "magnus"
+version = "0.5.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c8dc14463c2552e753ef562961f486ca76f17a857c121db40e9f3ade3f35ab81"
+dependencies = [
+ "magnus-macros",
+ "rb-sys",
+ "rb-sys-env",
+]
+
+[[package]]
+name = "magnus-macros"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6cc17af1d45442c011aa579d727ec6cff8a69aea8a6bbad26736e7112d749bfb"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "memchr"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d"
+
+[[package]]
+name = "minimal-lexical"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
+
+[[package]]
+name = "nom"
+version = "7.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d273983c5a657a70a3e8f2a01329822f3b8c8172b73826411a55751e404a0a4a"
+dependencies = [
+ "memchr",
+ "minimal-lexical",
+]
+
+[[package]]
+name = "nom-tracable"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "160767ce1eed2cdadc2256015a6dc51d9632226ea02e0f0ce4590b904e1d80e2"
+dependencies = [
+ "nom",
+ "nom-tracable-macros",
+ "nom_locate",
+]
+
+[[package]]
+name = "nom-tracable-macros"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7ac681ea0c3d468b003bdebe3a65d1632e340302452f95c3ffadf515704c48d"
+dependencies = [
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "nom_locate"
+version = "4.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b1e299bf5ea7b212e811e71174c5d1a5d065c4c0ad0c8691ecb1f97e3e66025e"
+dependencies = [
+ "bytecount",
+ "memchr",
+ "nom",
+]
+
+[[package]]
+name = "peeking_take_while"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "19b17cddbe7ec3f8bc800887bab5e717348c95ea2ca0b1bf0837fb964dc67099"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.56"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b63bdb0cd06f1f4dedf69b254734f9b45af66e4a031e42a7480257d9898b435"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.26"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4424af4bf778aae2051a77b60283332f386554255d722233d09fbfc7e30da2fc"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rb-sys"
+version = "0.9.75"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32ffbc5146796cb118f5a68196fabf1bccfff94c4830dea18aac0690cb29bb87"
+dependencies = [
+ "rb-sys-build",
+]
+
+[[package]]
+name = "rb-sys-build"
+version = "0.9.75"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "55edd49608668f9d45b7b1d619e6dab24ce8e591bcb912975936314aad94be40"
+dependencies = [
+ "bindgen",
+ "lazy_static",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "shell-words",
+ "syn",
+]
+
+[[package]]
+name = "rb-sys-env"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a35802679f07360454b418a5d1735c89716bde01d35b1560fc953c1415a0b3bb"
+
+[[package]]
+name = "regex"
+version = "1.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "af83e617f331cc6ae2da5443c602dfa5af81e517212d9d611a5b3ba1777b5370"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.7.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a5996294f19bd3aae0453a862ad728f60e6600695733dd5df01da90c54363a3c"
+
+[[package]]
+name = "rustc-hash"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+
+[[package]]
+name = "shell-words"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24188a676b6ae68c3b2cb3a01be17fbf7240ce009799bb56d5b1409051e78fde"
+
+[[package]]
+name = "shlex"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "43b2853a4d09f215c24cc5489c992ce46052d359b5109343cbafbf26bc62f8a3"
+
+[[package]]
+name = "syn"
+version = "1.0.109"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4"
+
+[[package]]
+name = "vault"
+version = "3.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f10e953cb5ef5a80d7bc904867faf0ba8ed5e5253093fb159818dc55a8f4ff46"
+dependencies = [
+ "byteorder",
+ "magnus",
+ "nom",
+ "nom-tracable",
+ "nom_locate",
+]
+
+[[package]]
+name = "vault_coh"
+version = "1.0.0"
+dependencies = [
+ "magnus",
+ "vault",
+]
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["ext/vault_coh"]
+resolver = "2"

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vault_coh.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rake-compiler'
+gem 'rb_sys'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    vault_coh (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rake-compiler (1.2.1)
+      rake
+    rb_sys (0.9.65)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.46.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rake-compiler
+  rb_sys
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  vault_coh!
+
+BUNDLED WITH
+   2.4.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 ryantaylor
+
+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,37 @@
+# Vault
+
+[![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/vault-rb/v0.1.0)
+
+A native Ruby client wrapper for the [vault](https://github.com/ryantaylor/vault) Company of Heroes replay parser, integrated via a Rust native extension.
+
+## Installation
+
+First, make sure you have a relatively recent version of the Rust toolchain installed (minimum supported Rust version for `vault` is 1.61.0). You can install Rust easily using [rustup](https://rustup.rs/).
+
+Then you can add to Gemfile:
+```
+gem 'vault_coh'
+```
+And run `bundle install`.
+
+## Usage
+
+Currently `vault` accepts a byte array and parses it as a Company of Heroes 3 replay file, returning a parsed object when successful or an error on failure:
+```ruby
+require 'vault_coh'
+
+bytes = File.read('/path/to/replay.rec').unpack('C*')
+replay = VaultCoh::Replay.from_bytes(bytes)
+puts replay.version
+```
+All information available from parsing can be found in the [documentation](https://rubydoc.info/github/ryantaylor/vault-rb/v0.1.0).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryantaylor/vault-rb.
+
+If you need to make changes to the Rust code, you can compile the extension by running `rake compile` or run tests with `cargo test`.
+
+## 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,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+require 'rake/extensiontask'
+
+task build: :compile
+
+Rake::ExtensionTask.new('vault_coh') do |ext|
+  ext.lib_dir = 'lib/vault_coh'
+end
+
+task default: %i[compile spec rubocop]

data/ext/vault_coh/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "vault_coh"
+version = "1.0.0"
+edition = "2021"
+authors = ["ryantaylor <2320507+ryantaylor@users.noreply.github.com>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+magnus = { version = "0.5" }
+vault = { version = "3", features = ["magnus"] }

data/ext/vault_coh/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+require 'rb_sys/mkmf'
+
+create_rust_makefile('vault_coh/vault_coh')

data/ext/vault_coh/src/lib.rs

@@ -0,0 +1,58 @@
+use magnus::{class, define_module, exception, function, method, prelude::*, Error};
+use vault::{Faction, Map, Message, Player, Replay, Team};
+
+#[magnus::init]
+fn init() -> Result<(), Error> {
+    let module = define_module("VaultCoh")?;
+
+    let replay = module.define_class("Replay", class::object())?;
+    replay.define_singleton_method("from_bytes", function!(from_bytes, 1))?;
+    replay.define_method("version", method!(Replay::version, 0))?;
+    replay.define_method("timestamp", method!(Replay::timestamp, 0))?;
+    replay.define_method("matchhistory_id", method!(Replay::matchhistory_id, 0))?;
+    replay.define_method("map", method!(Replay::map, 0))?;
+    replay.define_method("map_filename", method!(Replay::map_filename, 0))?;
+    replay.define_method(
+        "map_localized_name_id",
+        method!(Replay::map_localized_name_id, 0),
+    )?;
+    replay.define_method(
+        "map_localized_description_id",
+        method!(Replay::map_localized_description_id, 0),
+    )?;
+    replay.define_method("players", method!(Replay::players, 0))?;
+    replay.define_method("length", method!(Replay::length, 0))?;
+
+    let map = module.define_class("Map", class::object())?;
+    map.define_method("filename", method!(Map::filename, 0))?;
+    map.define_method("localized_name_id", method!(Map::localized_name_id, 0))?;
+    map.define_method(
+        "localized_description_id",
+        method!(Map::localized_description_id, 0),
+    )?;
+
+    let player = module.define_class("Player", class::object())?;
+    player.define_method("name", method!(Player::name, 0))?;
+    player.define_method("faction", method!(Player::faction, 0))?;
+    player.define_method("team", method!(Player::team, 0))?;
+    player.define_method("steam_id", method!(Player::steam_id, 0))?;
+    player.define_method("profile_id", method!(Player::profile_id, 0))?;
+    player.define_method("messages", method!(Player::messages, 0))?;
+
+    let message = module.define_class("Message", class::object())?;
+    message.define_method("tick", method!(Message::tick, 0))?;
+    message.define_method("message", method!(Message::message, 0))?;
+
+    let faction = module.define_class("Faction", class::object())?;
+    faction.define_method("value", method!(Faction::to_string, 0))?;
+
+    let team = module.define_class("Team", class::object())?;
+    team.define_method("value", method!(Team::value, 0))?;
+
+    Ok(())
+}
+
+fn from_bytes(input: Vec<u8>) -> Result<Replay, Error> {
+    Replay::from_bytes(&input)
+        .map_err(|err| Error::new(exception::runtime_error(), err.to_string()))
+}

data/lib/vault_coh/faction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Identifiers for the Company of Heroes 3 factions.
+  class Faction
+    AMERICANS = 'Americans'
+    BRITISH = 'British'
+    WEHRMACHT = 'Wehrmacht'
+    AFRIKAKORPS = 'AfrikaKorps'
+
+    # String identifier of the given faction.
+    #
+    # @see https://docs.rs/vault/3.0.0/vault/enum.Faction.html
+    #
+    # @return [AMERICANS|BRITISH|WEHRMACHT|AFRIKAKORPS]
+    def value; end
+  end
+end

data/lib/vault_coh/map.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Representation of all map-related information that can be parsed
+  # from a Company of Heroes 3 replay.
+  class Map
+    # This is a “filename” in the sense that its structure resembles
+    # one, but it doesn’t actually point to any file on the file
+    # system. The final “token” in this string (if you split by slash)
+    # generally corresponds to the map name returned by the CoH3 stats
+    # API. The string is UTF-8 encoded.
+    #
+    # @return [String]
+    def filename; end
+
+    # Entity ID that corresponds to a localization string that
+    # represents the localized name of the map. Conventionally these
+    # IDs do not change between patches, but that isn’t guaranteed.
+    # The string is UTF-16 encoded.
+    #
+    # @return [String]
+    def localized_name_id; end
+
+    # Entity ID that corresponds to a localization string that
+    # represents the localized description of the map. Conventionally
+    # these IDs do not change between patches, but that isn’t
+    # guaranteed. The string is UTF-16 encoded.
+    #
+    # @return [String]
+    def localized_description_id; end
+  end
+end

data/lib/vault_coh/message.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Representation of a user-sent chat message in a Company of Heroes
+  # 3 replay. Messages are collected during command parsing and then
+  # associated with the {Player} instance that sent them. To access,
+  # see {Player#messages}.
+  class Message
+    # This value is the tick at which the message was found while
+    # parsing the replay, which represents the time in the replay at
+    # which it was sent. Because CoH3’s engine runs at 8 ticks per
+    # second, you can divide this value by 8 to get the number of
+    # seconds since the replay began, which will tell you when this
+    # message was sent.
+    #
+    # @return [Integer] unsigned, 32 bits
+    def tick; end
+
+    # UTF-16 encoded representation of the message sent by the player.
+    #
+    # @return [String]
+    def message; end
+  end
+end

data/lib/vault_coh/player.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Game-specific player representation. Includes generally immutable
+  # information alongside data specific to the replay being parsed.
+  class Player
+    # Name of the player at the time the replay was recorded. Note
+    # that the player may have changed their name since time of
+    # recording. If attempting to uniquely identify players across
+    # replay files, look at {#steam_id} and {#profile_id} instead.
+    # The string is UTF-16 encoded.
+    #
+    # @return [String]
+    def name; end
+
+    # The faction selected by the player in this match.
+    #
+    # @return [Faction]
+    def faction; end
+
+    # The team the player was assigned to. Currently only head-to-head
+    # matchups are supported (max two teams).
+    #
+    # @return [Team]
+    def team; end
+
+    # The Steam ID of the player. This ID can be used to uniquely
+    # identify a player between replays, and connect them to their
+    # Steam profile.
+    #
+    # @return [Integer] unsigned, 64 bits
+    def steam_id; end
+
+    # The Relic profile ID of the player. This ID can be used to
+    # uniquely identify a player between replays, and can be used to
+    # query statistical information about the player from Relic’s
+    # stats API.
+    #
+    # @return [Integer] unsigned, 64 bits
+    def profile_id; end
+
+    # A list of all messages sent by the player in the match. Sorted
+    # chronologically from first to last.
+    #
+    # @return [Array<Message>]
+    def messages; end
+  end
+end

data/lib/vault_coh/replay.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # A complete representation of all information able to be parsed from a
+  # Company of Heroes 3 replay. Note that parsing is not yet exhaustive,
+  # and iterative improvements will be made to pull more information from
+  # replay files over time.
+  class Replay
+    # Takes a byte slice, parses it as a CoH3 replay, and returns a
+    # representation of the parsed information. Any failures during parsing
+    # or conversion will return an error.
+    #
+    # @param bytes [Array<Byte>] Byte array representation of a CoH3 replay file (required).
+    #
+    # @return [Replay]
+    #
+    # @example
+    #   require 'vault_coh'
+    #
+    #   bytes = File.read('/path/to/replay.rec').unpack('C*')
+    #   replay = VaultCoh::Replay.from_bytes(bytes)
+    #   puts replay.version
+    def self.from_bytes(bytes); end
+
+    # The Company of Heroes 3 game version this replay was recorded on.
+    # Note that this is probably more accurately described as the build
+    # version, and represents the final segment of digits you see in the
+    # game version on the game’s main menu. Every time the game is patched,
+    # this version will change, and replays are generally only viewable on
+    # the same game version they were recorded on.
+    #
+    # @return [Integer] unsigned, 16 bits
+    def version; end
+
+    # A UTF-16 representation of the recording user’s local time when the
+    # replay was recorded. Note that value may contain non-standard
+    # characters and is not guaranteed to be parsable into an accurate
+    # date/time format.
+    #
+    # @return [String]
+    def timestamp; end
+
+    # The ID used by Relic to track this match on their internal servers.
+    # This ID can be matched with an ID of the same name returned by
+    # Relic’s CoH3 stats API, enabling linkage between replay files and
+    # statistical information for a match.
+    #
+    # @return [Integer] unsigned, 64 bits
+    def matchhistory_id; end
+
+    # Map information for this match.
+    #
+    # @return [Map]
+    def map; end
+
+    # Filename of the map this match was played on. See {Map#filename}
+    # for more information.
+    #
+    # @return [String]
+    def map_filename; end
+
+    # Localization ID of the map’s name. See {Map#localized_name_id}
+    # for more information.
+    #
+    # @return [String]
+    def map_localized_name_id; end
+
+    # Localization ID of the map’s description. See
+    # {Map#localized_description_id} for more information.
+    #
+    # @return [String]
+    def map_localized_description_id; end
+
+    # A list of all players who participated in this match.
+    #
+    # @return [Array<Player>]
+    def players; end
+
+    # A simple count of the number of ticks that were executed in this
+    # match. Because CoH3’s engine runs at 8 ticks per second, you can
+    # divide this value by 8 to get the duration of the match in seconds.
+    #
+    # @return [Integer]
+    def length; end
+  end
+end

data/lib/vault_coh/team.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Identifiers for a player's team membership.
+  class Team
+    FIRST = 0
+    SECOND = 1
+
+    # Integer representation of the assigned team.
+    #
+    # @see https://docs.rs/vault/3.0.0/vault/enum.Team.html
+    #
+    # @return [FIRST|SECOND]
+    def value; end
+  end
+end

data/lib/vault_coh/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  VERSION = '0.1.0'
+end

data/lib/vault_coh.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'vault_coh/version'
+require_relative 'vault_coh/vault_coh'
+
+# Company of Heroes 3 replay parsing powered by
+# {https://github.com/ryantaylor/vault vault}. For usage details
+# see {Replay.from_bytes}.
+module VaultCoh
+end

data/vault_coh.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/vault_coh/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'vault_coh'
+  spec.version = VaultCoh::VERSION
+  spec.authors = ['ryantaylor']
+  spec.email = ['2320507+ryantaylor@users.noreply.github.com']
+
+  spec.summary = 'CoH3 replay parsing in Ruby with Rust'
+  spec.description = 'Company of Heroes replay parsing in Ruby using the vault parsing library via a Rust native extension.'
+  spec.homepage = 'https://github.com/ryantaylor/vault-rb'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_rubygems_version = '>= 3.3.11'
+
+  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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions = ['ext/vault_coh/Cargo.toml']
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: vault_coh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryantaylor
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies: []
+description: Company of Heroes replay parsing in Ruby using the vault parsing library
+  via a Rust native extension.
+email:
+- 2320507+ryantaylor@users.noreply.github.com
+executables: []
+extensions:
+- ext/vault_coh/Cargo.toml
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Cargo.lock
+- Cargo.toml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/vault_coh/Cargo.toml
+- ext/vault_coh/extconf.rb
+- ext/vault_coh/src/lib.rs
+- lib/vault_coh.rb
+- lib/vault_coh/faction.rb
+- lib/vault_coh/map.rb
+- lib/vault_coh/message.rb
+- lib/vault_coh/player.rb
+- lib/vault_coh/replay.rb
+- lib/vault_coh/team.rb
+- lib/vault_coh/version.rb
+- vault_coh.gemspec
+homepage: https://github.com/ryantaylor/vault-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ryantaylor/vault-rb
+  source_code_uri: https://github.com/ryantaylor/vault-rb
+  changelog_uri: https://github.com/ryantaylor/vault-rb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: CoH3 replay parsing in Ruby with Rust
+test_files: []