vault_coh 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e398c4277d3f495c8d75bd7a878fbba0a92c4f509caab4b782afeae21707ac30
-  data.tar.gz: 0d8a47ac15efb8513b5e71f52c3ba34b782ff75fba9cbccecc6f72095ab2a618
+  metadata.gz: 95461c3147428ac051ee0003a88304da0fe3bd82a3d62fb333b82efadfc54a69
+  data.tar.gz: ba0b1420bdadb6b0143f19d2b071060d600113fb5b8ecc44862e3bb9459b45f1
 SHA512:
-  metadata.gz: d7a5a45c518ba83d4ba6e911f6c251eee18f8606baab1b30b893657a50f859e2abda98c641cc8d6c7d29d500cb4cd1f5766aeea5bf184d48c2a0a37215984c58
-  data.tar.gz: 726566f51cd8a59df7f44952899862c68482bbbe7f8ae3516ecf161d1791e092a29f169b30db0e82609fbe3f09330722482475831e2e60e507262db7e161ac57
+  metadata.gz: 3c73ae3273b3a66ec94dec001ec9a971888a33f53c1e6a3389cf9bec5f9e716f19a049ac0a25ea9c6a0900edb3958b4c0d25b4f083a9e3db299d0ea381de8d12
+  data.tar.gz: 18ef4b4dd7ba45c938b092dda340e0406bc396676d7d022126b7298a2d70bb52e9f3f094bf73a86ffab69cee0f88fa5c4b02dc79d87a2fb93b5f02987e2ec2d0

data/Cargo.lock

@@ -292,9 +292,9 @@ checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4"
 
 [[package]]
 name = "vault"
-version = "3.0.0"
+version = "4.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f10e953cb5ef5a80d7bc904867faf0ba8ed5e5253093fb159818dc55a8f4ff46"
+checksum = "fbc584e1c893f783e5eb795b849c5a512992b3d0f39c0b2c124e8d17584f9b82"
 dependencies = [
  "byteorder",
  "magnus",

data/Gemfile

@@ -12,4 +12,4 @@ gem 'rb_sys'
 
 gem 'rspec', '~> 3.0'
 
-gem 'rubocop', '~> 1.21'
+gem 'rubocop', '~> 1.55'

data/Gemfile.lock

@@ -9,53 +9,58 @@ GEM
     ast (2.4.2)
     diff-lcs (1.5.0)
     json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rake-compiler (1.2.1)
+    rake-compiler (1.2.5)
       rake
-    rb_sys (0.9.65)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    rb_sys (0.9.81)
+    regexp_parser (2.8.1)
+    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.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.46.0)
+    rspec-support (3.12.1)
+    rubocop (1.55.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       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)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)
   rake-compiler
   rb_sys
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.55)
   vault_coh!
 
 BUNDLED WITH

data/README.md

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

data/ext/vault_coh/Cargo.toml

@@ -11,4 +11,4 @@ crate-type = ["cdylib"]
 
 [dependencies]
 magnus = { version = "0.5" }
-vault = { version = "3", features = ["magnus"] }
+vault = { version = "4", features = ["magnus"] }

data/ext/vault_coh/src/lib.rs

@@ -1,5 +1,6 @@
 use magnus::{class, define_module, exception, function, method, prelude::*, Error};
-use vault::{Faction, Map, Message, Player, Replay, Team};
+use vault::commands::{BuildSquad, SelectBattlegroup, Unknown};
+use vault::{Command, Faction, Map, Message, Player, Replay, Team};
 
 #[magnus::init]
 fn init() -> Result<(), Error> {
@@ -35,9 +36,12 @@ fn init() -> Result<(), Error> {
     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("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))?;
     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))?;
 
     let message = module.define_class("Message", class::object())?;
     message.define_method("tick", method!(Message::tick, 0))?;
@@ -49,6 +53,33 @@ fn init() -> Result<(), Error> {
     let team = module.define_class("Team", class::object())?;
     team.define_method("value", method!(Team::value, 0))?;
 
+    let command = module.define_class("Command", class::object())?;
+
+    let commands_module = module.define_module("Commands")?;
+
+    let build_squad_command = commands_module.define_class("BuildSquadCommand", command)?;
+    build_squad_command.define_method("value", method!(Command::extract_build_squad, 0))?;
+
+    let build_squad = commands_module.define_class("BuildSquad", class::object())?;
+    build_squad.define_method("tick", method!(BuildSquad::tick, 0))?;
+    build_squad.define_method("pbgid", method!(BuildSquad::pbgid, 0))?;
+
+    let select_battlegroup_command =
+        commands_module.define_class("SelectBattlegroupCommand", command)?;
+    select_battlegroup_command
+        .define_method("value", method!(Command::extract_select_battlegroup, 0))?;
+
+    let select_battlegroup = commands_module.define_class("SelectBattlegroup", class::object())?;
+    select_battlegroup.define_method("tick", method!(SelectBattlegroup::tick, 0))?;
+    select_battlegroup.define_method("pbgid", method!(SelectBattlegroup::pbgid, 0))?;
+
+    let unknown_command = commands_module.define_class("UnknownCommand", command)?;
+    unknown_command.define_method("value", method!(Command::extract_unknown, 0))?;
+
+    let unknown = commands_module.define_class("Unknown", class::object())?;
+    unknown.define_method("tick", method!(Unknown::tick, 0))?;
+    unknown.define_method("action_type", method!(Unknown::action_type, 0))?;
+
     Ok(())
 }
 

data/lib/vault_coh/command.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Base class that all command wrappers extend.
+  class Command
+    # Data object that contains information specific to the
+    # type of command it represents.
+    #
+    # @return [Commands::BuildSquad|Commands::SelectBattlegroup|Commands::Unknown]
+    def value; end
+  end
+end

data/lib/vault_coh/commands/build_squad.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Data object representing information parsed from a
+    # unit construction command.
+    class BuildSquad
+      # 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 unit being
+      # built. This value can be matched to CoH3 attribute
+      # files in order to determine the unit being built.
+      # Note that, while rare, it is possible that this value
+      # may change between patches for the same unit.
+      #
+      # @return [Integer] unsigned, 32 bits
+      def pbgid; end
+    end
+  end
+end

data/lib/vault_coh/commands/build_squad_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Wrapper for a unit construction command.
+    class BuildSquadCommand < Command
+    end
+  end
+end

data/lib/vault_coh/commands/select_battlegroup.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Data object representing information parsed from a
+    # battlegroup selection command.
+    class SelectBattlegroup
+      # 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
+      # selected. This value can be matched to CoH3 attribute
+      # files in order to determine the battlegroup 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
+    end
+  end
+end

data/lib/vault_coh/commands/select_battlegroup_command.rb

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

data/lib/vault_coh/commands/unknown.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Data object representing an unknown (i.e. not yet
+    # handled) command.
+    class Unknown
+      # 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
+
+      # This value identifies the type of the command
+      # (build, move, stop, etc.). Commands with similar
+      # functionality can be grouped by this value.
+      #
+      # @return [Integer] unsigned, 8 bits
+      def action_type; end
+    end
+  end
+end

data/lib/vault_coh/commands/unknown_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  module Commands
+    # Wrapper for an unknown (i.e. not yet handled) command.
+    class UnknownCommand < Command
+    end
+  end
+end

data/lib/vault_coh/commands.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Various classes responsible for handling command data.
+  module Commands
+  end
+end

data/lib/vault_coh/player.rb

@@ -24,6 +24,13 @@ module VaultCoh
     # @return [Team]
     def team; end
 
+    # The pbgid of the battlegroup the player selected, or +nil+ if no
+    # battlegroup was selected. For details on what this ID represents
+    # please see {Commands::SelectBattlegroup#pbgid}.
+    #
+    # @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.
@@ -44,5 +51,18 @@ module VaultCoh
     #
     # @return [Array<Message>]
     def messages; end
+
+    # A list of all commands executed by the player in the match.
+    # Sorted chronologically from first to last.
+    #
+    # @return [Array<Command>]
+    def commands; end
+
+    # 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.
+    #
+    # @return [Array<Commands::BuildSquad>]
+    def build_commands; end
   end
 end

data/lib/vault_coh/version.rb

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

data/vault_coh.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   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.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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vault_coh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies: []
 description: Company of Heroes replay parsing in Ruby using the vault parsing library
   via a Rust native extension.
@@ -33,6 +33,14 @@ files:
 - ext/vault_coh/extconf.rb
 - ext/vault_coh/src/lib.rs
 - lib/vault_coh.rb
+- lib/vault_coh/command.rb
+- lib/vault_coh/commands.rb
+- 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_command.rb
+- lib/vault_coh/commands/unknown.rb
+- lib/vault_coh/commands/unknown_command.rb
 - lib/vault_coh/faction.rb
 - lib/vault_coh/map.rb
 - lib/vault_coh/message.rb