vault_coh 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58b4566c6a716ad6a4bd8e5cf6cc34d5463f41cabebdd73fb700754306e2f755
-  data.tar.gz: a1c6cba1f9612d76d9ff6f4ada79881cd7df6eaa05f48834c325e3c2eaa49fbb
+  metadata.gz: d592cf204ea2ac142d3a8a3451fc5c6f2af2b2b1667c63182c31a968104b80ff
+  data.tar.gz: 3b3d78276b036144d13321007080a4c4b207549c3181728d0c71d36d13128182
 SHA512:
-  metadata.gz: 0bd7b66a16fbe5800643311bc98b0c8e68ac2a913a0a045e371819b715837cddae36dea7b1081c6ab40216604fca4a29efa3c4fb306b54a96ddaf6ae22df5b04
-  data.tar.gz: 2f62b79798c457b68fba088de8426345a8f256c38653f06d96dce5d5e3491f00b9dad5bd68e0ab08fd3c8e5accecea6e191fb7db833b0d5a4367c993cb864123
+  metadata.gz: 5e652ab1d2dd9df9cfab540012512a9d099955498d1d69951c222e15e4717676db8a5c3d47c74163b543de277d61091dd531ad792fa1cfb6de730357476fea63
+  data.tar.gz: 606019499e3af6298b8ff1b07004740f0dff1a2339601f61ab1b3c74debca39d67e5bc91e2837e87b5bab6f38c013d834e4e4a2611265481981ecf949babc4fb

data/Cargo.lock

@@ -28,7 +28,7 @@ dependencies = [
  "regex",
  "rustc-hash",
  "shlex",
- "syn 2.0.38",
+ "syn 2.0.39",
 ]
 
 [[package]]
@@ -95,9 +95,9 @@ checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55"
 
 [[package]]
 name = "libc"
-version = "0.2.149"
+version = "0.2.150"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a08173bc88b7955d1b3145aa561539096c421ac8debde8cbc3612ec635fee29b"
+checksum = "89d92a4743f9a61002fae18374ed11e7973f530cb3a3255fb354818118b2203c"
 
 [[package]]
 name = "libloading"
@@ -129,7 +129,7 @@ checksum = "5968c820e2960565f647819f5928a42d6e874551cab9d88d75e3e0660d7f71e3"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.38",
+ "syn 2.0.39",
 ]
 
 [[package]]
@@ -231,7 +231,7 @@ dependencies = [
  "quote",
  "regex",
  "shell-words",
- "syn 2.0.38",
+ "syn 2.0.39",
 ]
 
 [[package]]
@@ -339,9 +339,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "2.0.38"
+version = "2.0.39"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e96b79aaa137db8f61e26363a0c9b47d8b4ec75da28b7d1d614c2303e232408b"
+checksum = "23e78b90f2fcf45d3e842032ce32e3f2d1545ba6636271dcbf24fa306d87be7a"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -362,9 +362,9 @@ checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
 
 [[package]]
 name = "vault"
-version = "5.0.0"
+version = "5.1.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c67502a964c8ac4301dcd55e042f7b581fb4bce681dc4236b3c75f5971a219ce"
+checksum = "6254a954458cb9965b33572de19287e36c6b32c7803d1bec0f2889d8eb9d3e3c"
 dependencies = [
  "byteorder",
  "magnus",

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vault_coh (2.1.0)
+    vault_coh (2.2.0)
 
 GEM
   remote: https://rubygems.org/

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/v2.1.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/v2.2.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/v2.1.0).
+All information available from parsing can be found in the [documentation](https://rubydoc.info/github/ryantaylor/vault-rb/v2.2.0).
 
 ## Contributing
 

data/ext/vault_coh/src/hash.rs

@@ -1,5 +1,7 @@
 use magnus::Value;
-use vault::commands::{BuildSquad, SelectBattlegroup, Unknown};
+use vault::commands::{
+    BuildSquad, SelectBattlegroup, SelectBattlegroupAbility, Unknown, UseBattlegroupAbility,
+};
 use vault::{Command, Map, Message, Player, Replay};
 
 pub trait HashExt {
@@ -48,6 +50,18 @@ impl HashExt for SelectBattlegroup {
     }
 }
 
+impl HashExt for SelectBattlegroupAbility {
+    fn to_h(&self) -> Value {
+        serde_magnus::serialize(self).unwrap()
+    }
+}
+
+impl HashExt for UseBattlegroupAbility {
+    fn to_h(&self) -> Value {
+        serde_magnus::serialize(self).unwrap()
+    }
+}
+
 impl HashExt for Unknown {
     fn to_h(&self) -> Value {
         serde_magnus::serialize(self).unwrap()

data/ext/vault_coh/src/lib.rs

@@ -2,7 +2,9 @@ mod hash;
 
 use crate::hash::HashExt;
 use magnus::{class, define_module, exception, function, method, prelude::*, Error};
-use vault::commands::{BuildSquad, SelectBattlegroup, Unknown};
+use vault::commands::{
+    BuildSquad, SelectBattlegroup, SelectBattlegroupAbility, Unknown, UseBattlegroupAbility,
+};
 use vault::{Command, Faction, Map, Message, Player, Replay, Team};
 
 #[magnus::init]
@@ -47,6 +49,10 @@ fn init() -> Result<(), Error> {
     player.define_method("messages", method!(Player::messages, 0))?;
     player.define_method("commands", method!(Player::commands, 0))?;
     player.define_method("build_commands", method!(Player::build_commands, 0))?;
+    player.define_method(
+        "battlegroup_commands",
+        method!(Player::battlegroup_commands, 0),
+    )?;
     player.define_method("to_h", method!(Player::to_h, 0))?;
 
     let message = module.define_class("Message", class::object())?;
@@ -83,6 +89,33 @@ fn init() -> Result<(), Error> {
     select_battlegroup.define_method("pbgid", method!(SelectBattlegroup::pbgid, 0))?;
     select_battlegroup.define_method("to_h", method!(SelectBattlegroup::to_h, 0))?;
 
+    let select_battlegroup_ability_command =
+        commands_module.define_class("SelectBattlegroupAbilityCommand", command)?;
+    select_battlegroup_ability_command.define_method(
+        "value",
+        method!(Command::extract_select_battlegroup_ability, 0),
+    )?;
+
+    let select_battlegroup_ability =
+        commands_module.define_class("SelectBattlegroupAbility", class::object())?;
+    select_battlegroup_ability.define_method("tick", method!(SelectBattlegroupAbility::tick, 0))?;
+    select_battlegroup_ability
+        .define_method("pbgid", method!(SelectBattlegroupAbility::pbgid, 0))?;
+    select_battlegroup_ability.define_method("to_h", method!(SelectBattlegroupAbility::to_h, 0))?;
+
+    let use_battlegroup_ability_command =
+        commands_module.define_class("UseBattlegroupAbilityCommand", command)?;
+    use_battlegroup_ability_command.define_method(
+        "value",
+        method!(Command::extract_use_battlegroup_ability, 0),
+    )?;
+
+    let use_battlegroup_ability =
+        commands_module.define_class("UseBattlegroupAbility", class::object())?;
+    use_battlegroup_ability.define_method("tick", method!(UseBattlegroupAbility::tick, 0))?;
+    use_battlegroup_ability.define_method("pbgid", method!(UseBattlegroupAbility::pbgid, 0))?;
+    use_battlegroup_ability.define_method("to_h", method!(UseBattlegroupAbility::to_h, 0))?;
+
     let unknown_command = commands_module.define_class("UnknownCommand", command)?;
     unknown_command.define_method("value", method!(Command::extract_unknown, 0))?;
 

data/lib/vault_coh/command.rb

@@ -6,7 +6,11 @@ module VaultCoh
     # Data object that contains information specific to the
     # type of command it represents.
     #
-    # @return [Commands::BuildSquad|Commands::SelectBattlegroup|Commands::Unknown]
+    # @return [Commands::BuildSquad |
+    #          Commands::SelectBattlegroup |
+    #          Commands::SelectBattlegroupAbility |
+    #          Commands::UseBattlegroupAbility |
+    #          Commands::Unknown]
     def value; end
 
     # Returns a hash representation of the object.

data/lib/vault_coh/commands/select_battlegroup_ability.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Data object representing information parsed from a
+    # battlegroup ability selection command.
+    class SelectBattlegroupAbility
+      # 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 battlegroup
+      # ability selected. This value can be matched to CoH3
+      # attribute files in order to determine the battlegroup
+      # ability being selected. Note that, while rare, it is
+      # possible that this value may change between patches
+      # for the same battlegroup.
+      #
+      # @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/select_battlegroup_ability_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Wrapper for a battlegroup ability selection command.
+    class SelectBattlegroupAbilityCommand < Command
+    end
+  end
+end

data/lib/vault_coh/commands/use_battlegroup_ability.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Data object representing information parsed from a
+    # battlegroup ability usage command.
+    class UseBattlegroupAbility
+      # 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 battlegroup
+      # ability used. This value can be matched to CoH3
+      # attribute files in order to determine the battlegroup
+      # ability being used. Note that, while rare, it is
+      # possible that this value may change between patches
+      # for the same battlegroup.
+      #
+      # @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/use_battlegroup_ability_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Wrapper for a battlegroup ability usage command.
+    class UseBattlegroupAbilityCommand < Command
+    end
+  end
+end

data/lib/vault_coh/player.rb

@@ -65,6 +65,16 @@ module VaultCoh
     # @return [Array<Commands::BuildSquad>]
     def build_commands; end
 
+    # A list of only battlegroup-related commands executed by the player
+    # in the match. A battlegroup command is any that involves the select
+    # or use of battlegroups and their abilities. Sorted chronologically
+    # from first to last.
+    #
+    # @return [Array<Commands::SelectBattlegroupCommand |
+    #                Commands::SelectBattlegroupAbilityCommand |
+    #                Commands::UseBattlegroupAbilityCommand>]
+    def battlegroup_commands; end
+
     # Returns a hash representation of the object.
     #
     # @return [Hash]

data/lib/vault_coh/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vault_coh
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies: []
 description: Company of Heroes replay parsing in Ruby using the vault parsing library
   via a Rust native extension.
@@ -39,9 +39,13 @@ files:
 - lib/vault_coh/commands/build_squad.rb
 - lib/vault_coh/commands/build_squad_command.rb
 - lib/vault_coh/commands/select_battlegroup.rb
+- lib/vault_coh/commands/select_battlegroup_ability.rb
+- lib/vault_coh/commands/select_battlegroup_ability_command.rb
 - lib/vault_coh/commands/select_battlegroup_command.rb
 - lib/vault_coh/commands/unknown.rb
 - lib/vault_coh/commands/unknown_command.rb
+- 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/map.rb
 - lib/vault_coh/message.rb