vault_coh 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 763f4d0ebdbd58cd93d40ea506dc1f3d5ec176b152639127fa63dce0f144b50b
-  data.tar.gz: 58a846515ed9a32da75e3bc0c7f29c1585207ed1635d11dffe1c16a0af6c5bf7
+  metadata.gz: efcd317fb3639ebb84a7fcb11f7d3b513422211d1c2b87f3e564ce4ddbf78f74
+  data.tar.gz: c52abcfeceab7cafcb94f15e93dad181afb600bc8bbbb29e0ebf8ea0ebe61c33
 SHA512:
-  metadata.gz: 905aa7c2464b935e14fd7196af6012c1afefb52adad173602e7b0b77ccb43f0e62fe964509d99e743e924649909dd4f8b744ad179b32eecf3d407e976ea5f02c
-  data.tar.gz: ca9bae0ee2fb8c2e16b01e09c2edf0a0aa444b6c536f9cb5bf3b0499c35d64ecec8938509aed78af95795ab4d4d71442c0fdc8b971547fdb623cc3f7f3d270c5
+  metadata.gz: 866f6b1d80b16c5a006d0f3878202225c26b08138e088c24b31990e71a698a137e5f04bc58992dd038826939dacc75f356409566c0b358a637315ebe3309e789
+  data.tar.gz: a5d2d75254cbeb6bdc05b23fb0adec01d9df3c379d8b862be8b4e8568f56d56eb349255b1cf4b49bd68ff76202366b7ccd22eb445abf65576cabacb2126a1a55

data/.ruby-version

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

data/Cargo.lock

@@ -362,9 +362,9 @@ checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
 
 [[package]]
 name = "vault"
-version = "6.0.0"
+version = "7.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "56d2f7e8331af1c81e0e894ae95960807789cfe849dcc95e828382f9f41b2959"
+checksum = "c883ce2ee65509850bbf77b935dac0d6876392de077138650de1f5d109381bd8"
 dependencies = [
  "byteorder",
  "magnus",

data/Gemfile

@@ -12,4 +12,4 @@ gem 'rb_sys'
 
 gem 'rspec', '~> 3.0'
 
-gem 'rubocop', '~> 1.57'
+gem 'rubocop', '~> 1.59'

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    vault_coh (3.0.0)
+    vault_coh (4.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
-    json (2.6.3)
+    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.3)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
@@ -19,8 +19,8 @@ GEM
     rake (13.1.0)
     rake-compiler (1.2.5)
       rake
-    rb_sys (0.9.83)
-    regexp_parser (2.8.2)
+    rb_sys (0.9.86)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -35,7 +35,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.57.2)
+    rubocop (1.59.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -43,7 +43,7 @@ GEM
       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)
@@ -60,7 +60,7 @@ DEPENDENCIES
   rake-compiler
   rb_sys
   rspec (~> 3.0)
-  rubocop (~> 1.57)
+  rubocop (~> 1.59)
   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/v4.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/v4.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 = "7", features = ["magnus", "serde"] }

data/ext/vault_coh/src/lib.rs

@@ -42,6 +42,7 @@ fn init() -> Result<(), Error> {
 
     let player = module.define_class("Player", class::object())?;
     player.define_method("name", method!(Player::name, 0))?;
+    player.define_method("human?", method!(Player::human, 0))?;
     player.define_method("faction", method!(Player::faction, 0))?;
     player.define_method("team", method!(Player::team, 0))?;
     player.define_method("battlegroup", method!(Player::battlegroup, 0))?;

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/player.rb

@@ -13,6 +13,11 @@ 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]
@@ -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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VaultCoh
-  VERSION = '3.0.0'
+  VERSION = '4.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: 4.0.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-01-21 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