vault_coh 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 763f4d0ebdbd58cd93d40ea506dc1f3d5ec176b152639127fa63dce0f144b50b
-  data.tar.gz: 58a846515ed9a32da75e3bc0c7f29c1585207ed1635d11dffe1c16a0af6c5bf7
+  metadata.gz: 7c619172a3ef03297101f59e93f97fabc3fe657c4fc4901626440997dd63f5de
+  data.tar.gz: 2ec4cf367060108ba2ef4f2602b3216fc7dd7bf2aa50c0060cfee0d915734692
 SHA512:
-  metadata.gz: 905aa7c2464b935e14fd7196af6012c1afefb52adad173602e7b0b77ccb43f0e62fe964509d99e743e924649909dd4f8b744ad179b32eecf3d407e976ea5f02c
-  data.tar.gz: ca9bae0ee2fb8c2e16b01e09c2edf0a0aa444b6c536f9cb5bf3b0499c35d64ecec8938509aed78af95795ab4d4d71442c0fdc8b971547fdb623cc3f7f3d270c5
+  metadata.gz: 12794b3709c6897ae31912f8c8c9e510f181354393c65f6d3e94ef38a1243e167c9ccd2b7c8deb5400f68c6138cfc05766a02dcf7440744af828675c08092305
+  data.tar.gz: 0406cfd5802162ce6f3cd90c2ad2fc2fd65ec1abef19d91d20413d2f12a527ae1438e5f9c73e86dd1da44ef5a429d688a84786c4fad77d59ae6627fa5a25470e

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Cargo.lock

@@ -322,9 +322,9 @@ checksum = "24188a676b6ae68c3b2cb3a01be17fbf7240ce009799bb56d5b1409051e78fde"
 
 [[package]]
 name = "shlex"
-version = "1.2.0"
+version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a7cee0529a6d40f580e7a5e6c495c8fbfe21b7b52795ed4bb5e62cdf92bc6380"
+checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "syn"
@@ -360,11 +360,20 @@ version = "1.0.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
 
+[[package]]
+name = "uuid"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f00cc9702ca12d3c81455259621e676d0f7251cec66a21e98fe2e9a37db93b2a"
+dependencies = [
+ "serde",
+]
+
 [[package]]
 name = "vault"
-version = "6.0.0"
+version = "8.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "56d2f7e8331af1c81e0e894ae95960807789cfe849dcc95e828382f9f41b2959"
+checksum = "401c25d59ac1ca36a13d384627e8e86b425524f08f69d9eace9b4aa45ddcd88a"
 dependencies = [
  "byteorder",
  "magnus",
@@ -372,6 +381,7 @@ dependencies = [
  "nom-tracable",
  "nom_locate",
  "serde",
+ "uuid",
 ]
 
 [[package]]

data/Gemfile

@@ -10,6 +10,6 @@ gem 'rake', '~> 13.0'
 gem 'rake-compiler'
 gem 'rb_sys'
 
-gem 'rspec', '~> 3.0'
+gem 'rspec', '~> 3.13'
 
-gem 'rubocop', '~> 1.57'
+gem 'rubocop', '~> 1.60'

data/Gemfile.lock

@@ -1,49 +1,49 @@
 PATH
   remote: .
   specs:
-    vault_coh (3.0.0)
+    vault_coh (5.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    diff-lcs (1.5.0)
-    json (2.6.3)
+    diff-lcs (1.5.1)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
-    rake-compiler (1.2.5)
+    rake-compiler (1.2.7)
       rake
-    rb_sys (0.9.83)
-    regexp_parser (2.8.2)
+    rb_sys (0.9.87)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.57.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
@@ -59,8 +59,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rake-compiler
   rb_sys
-  rspec (~> 3.0)
-  rubocop (~> 1.57)
+  rspec (~> 3.13)
+  rubocop (~> 1.60)
   vault_coh!
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,6 @@
 # Vault
 
-[![Gem Version](https://badge.fury.io/rb/vault_coh.svg)](https://badge.fury.io/rb/vault_coh) [![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/vault-rb/v3.0.0)
+[![Gem Version](https://badge.fury.io/rb/vault_coh.svg)](https://badge.fury.io/rb/vault_coh) [![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/vault-rb/v5.0.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.
 
@@ -24,7 +24,7 @@ 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/v3.0.0).
+All information available from parsing can be found in the [documentation](https://rubydoc.info/github/ryantaylor/vault-rb/v5.0.0).
 
 ## Contributing
 

data/ext/vault_coh/Cargo.toml

@@ -12,4 +12,4 @@ crate-type = ["cdylib"]
 [dependencies]
 magnus = { version = "0.6" }
 serde_magnus = { version = "0.8" }
-vault = { version = "6", features = ["magnus", "serde"] }
+vault = { version = "8", features = ["magnus", "serde"] }

data/ext/vault_coh/src/lib.rs

@@ -6,7 +6,7 @@ use vault::commands::{
     BuildGlobalUpgrade, BuildSquad, SelectBattlegroup, SelectBattlegroupAbility, Unknown,
     UseBattlegroupAbility,
 };
-use vault::{Command, Faction, Map, Message, Player, Replay, Team};
+use vault::{Command, Map, Message, Player, Replay};
 
 #[magnus::init]
 fn init() -> Result<(), Error> {
@@ -16,7 +16,9 @@ fn init() -> Result<(), Error> {
     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("game_type", method!(game_type_string, 0))?;
     replay.define_method("matchhistory_id", method!(Replay::matchhistory_id, 0))?;
+    replay.define_method("mod_uuid", method!(mod_uuid_string, 0))?;
     replay.define_method("map", method!(Replay::map, 0))?;
     replay.define_method("map_filename", method!(Replay::map_filename, 0))?;
     replay.define_method(
@@ -42,8 +44,9 @@ fn init() -> Result<(), Error> {
 
     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("human?", method!(Player::human, 0))?;
+    player.define_method("faction", method!(faction_string, 0))?;
+    player.define_method("team", method!(team_value, 0))?;
     player.define_method("battlegroup", method!(Player::battlegroup, 0))?;
     player.define_method("steam_id", method!(Player::steam_id, 0))?;
     player.define_method("profile_id", method!(Player::profile_id, 0))?;
@@ -61,12 +64,6 @@ fn init() -> Result<(), Error> {
     message.define_method("message", method!(Message::message, 0))?;
     message.define_method("to_h", method!(Message::to_h, 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))?;
-
     let command = module.define_class("Command", class::object())?;
     command.define_method("to_h", method!(Command::to_h, 0))?;
 
@@ -143,3 +140,19 @@ fn from_bytes(input: Vec<u8>) -> Result<Replay, Error> {
     Replay::from_bytes(&input)
         .map_err(|err| Error::new(exception::runtime_error(), err.to_string()))
 }
+
+fn mod_uuid_string(rb_self: &Replay) -> String {
+    rb_self.mod_uuid().to_string()
+}
+
+fn game_type_string(rb_self: &Replay) -> String {
+    rb_self.game_type().to_string()
+}
+
+fn faction_string(rb_self: &Player) -> String {
+    rb_self.faction().to_string()
+}
+
+fn team_value(rb_self: &Player) -> usize {
+    rb_self.team().value()
+}

data/lib/vault_coh/command.rb

@@ -6,7 +6,8 @@ module VaultCoh
     # Data object that contains information specific to the
     # type of command it represents.
     #
-    # @return [Commands::BuildSquad |
+    # @return [Commands::BuildGlobalUpgrade |
+    #          Commands::BuildSquad |
     #          Commands::SelectBattlegroup |
     #          Commands::SelectBattlegroupAbility |
     #          Commands::UseBattlegroupAbility |

data/lib/vault_coh/commands/build_global_upgrade.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Data object representing information parsed from an
+    # upgrade construction command.
+    class BuildGlobalUpgrade
+      # This value is the tick at which the command was
+      # found while parsing the replay, which represents
+      # the time in the replay at which it was executed.
+      # 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 command was executed.
+      #
+      # @return [Integer] unsigned, 32 bits
+      def tick; end
+
+      # Internal ID that uniquely identifies the upgrade being
+      # built. This value can be matched to CoH3 attribute
+      # files in order to determine the upgrade being built.
+      # Note that, while rare, it is possible that this value
+      # may change between patches for the same upgrade.
+      #
+      # @return [Integer] unsigned, 32 bits
+      def pbgid; end
+
+      # Returns a hash representation of the object.
+      #
+      # @return [Hash]
+      def to_h; end
+    end
+  end
+end

data/lib/vault_coh/commands/build_global_upgrade_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Wrapper for an upgrade construction command.
+    class BuildGlobalUpgradeCommand < Command
+    end
+  end
+end

data/lib/vault_coh/faction.rb

@@ -3,16 +3,9 @@
 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
+    AMERICANS = 'americans'
+    BRITISH = 'british_africa'
+    WEHRMACHT = 'germans'
+    AFRIKAKORPS = 'afrika_korps'
   end
 end

data/lib/vault_coh/game_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Identifiers for the Company of Heroes 3 game types.
+  class GameType
+    SKIRMISH = 'skirmish'
+    MULTIPLAYER = 'multiplayer'
+    AUTOMATCH = 'automatch'
+    CUSTOM = 'custom'
+  end
+end

data/lib/vault_coh/player.rb

@@ -13,15 +13,20 @@ module VaultCoh
     # @return [String]
     def name; end
 
+    # Whether or not the player was a human or an AI/CPU player.
+    #
+    # @return [Boolean]
+    def human?; end
+
     # The faction selected by the player in this match.
     #
-    # @return [Faction]
+    # @return [Faction::AMERICANS|Faction::WEHRMACHT|Faction::BRITISH|Faction::AFRIKAKORPS]
     def faction; end
 
     # The team the player was assigned to. Currently only head-to-head
     # matchups are supported (max two teams).
     #
-    # @return [Team]
+    # @return [Team::FIRST|Team::SECOND]
     def team; end
 
     # The pbgid of the battlegroup the player selected, or +nil+ if no
@@ -31,19 +36,19 @@ module VaultCoh
     # @return [Integer|NilClass]
     def battlegroup; 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.
+    # The Steam ID of the player, or +nil+ if the player is AI. This ID
+    # can be used to uniquely identify a player between replays, and
+    # connect them to their Steam profile.
     #
-    # @return [Integer] unsigned, 64 bits
+    # @return [Integer|NilClass] 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.
+    # The Relic profile ID of the player, or +nil+ if the player is AI.
+    # 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
+    # @return [Integer|NilClass] unsigned, 64 bits
     def profile_id; end
 
     # A list of all messages sent by the player in the match. Sorted
@@ -60,9 +65,9 @@ module VaultCoh
 
     # A list of only build-related commands executed by the player in
     # the match. A build command is any that enqueues the construction
-    # of a new unit. Sorted chronologically from first to last.
+    # of a new unit or upgrade. Sorted chronologically from first to last.
     #
-    # @return [Array<Commands::BuildSquad>]
+    # @return [Array<Command>]
     def build_commands; end
 
     # A list of only battlegroup-related commands executed by the player

data/lib/vault_coh/replay.rb

@@ -40,14 +40,34 @@ module VaultCoh
     # @return [String]
     def timestamp; end
 
+    # The type of game this replay represents. Note that this information
+    # is parsed on a best-effort basis and therefore may not always be
+    # correct. Also note that it's currently not known if there's a way to
+    # differentiate between automatch and custom games for replays recorded
+    # before the replay system release in patch 1.4.0. Games played before
+    # that patch will be marked as either +skirmish+ (for local AI games) or
+    # +multiplayer+ (for networked custom or automatch games). Games recorded
+    # on or after patch 1.4.0 will properly differentiate between +custom+
+    # and +automatch+ games.
+    #
+    # @return [GameType::SKIRMISH|GameType::MULTIPLAYER|GameType::AUTOMATCH|GameType::CUSTOM]
+    def game_type; 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.
+    # statistical information for a match. When the game type is +skirmish+,
+    # there is no ID assigned by Relic, so this will be +nil+.
     #
-    # @return [Integer] unsigned, 64 bits
+    # @return [Integer|NilClass] unsigned, 64 bits
     def matchhistory_id; end
 
+    # The UUID of the base game mod this replay ran on. If no mod was used,
+    # this will be a nil UUID (all zeroes).
+    #
+    # @return [String]
+    def mod_uuid; end
+
     # Map information for this match.
     #
     # @return [Map]

data/lib/vault_coh/team.rb

@@ -5,12 +5,5 @@ module VaultCoh
   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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vault_coh
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies: []
 description: Company of Heroes replay parsing in Ruby using the vault parsing library
   via a Rust native extension.
@@ -21,6 +21,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Cargo.lock
 - Cargo.toml
@@ -36,6 +37,8 @@ files:
 - lib/vault_coh.rb
 - lib/vault_coh/command.rb
 - lib/vault_coh/commands.rb
+- lib/vault_coh/commands/build_global_upgrade.rb
+- lib/vault_coh/commands/build_global_upgrade_command.rb
 - lib/vault_coh/commands/build_squad.rb
 - lib/vault_coh/commands/build_squad_command.rb
 - lib/vault_coh/commands/select_battlegroup.rb
@@ -47,6 +50,7 @@ files:
 - lib/vault_coh/commands/use_battlegroup_ability.rb
 - lib/vault_coh/commands/use_battlegroup_ability_command.rb
 - lib/vault_coh/faction.rb
+- lib/vault_coh/game_type.rb
 - lib/vault_coh/map.rb
 - lib/vault_coh/message.rb
 - lib/vault_coh/player.rb