openra 2.3.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb765723f864f95b995b8fd38c8590c7ed916ed9dcbeaa16212eedf0ee32d1b5
-  data.tar.gz: ad408fb02eb733dc1eaec9b9a7cdc1ab039f265f72d87f28ef6ff20e7e470738
+  metadata.gz: 2f08aa3006104ee390f946d7ee77972682fe47d771d384b47bff2244d1b9c65d
+  data.tar.gz: 14d912561d616f58da10f1fd4d25cd355fed9fcb5dba1eca6a48d409693a0096
 SHA512:
-  metadata.gz: 4c53d05f0d0e9d5d5b6b424b1c96994f3c05f91cab405537c6ab9e0a2a81dd373a4bc9442520866af37ce95faa024d4727e4511797c9d7475674cef3a239077e
-  data.tar.gz: 61ceaa4c5025b5fc5203084692f24b71c93207fedcd8efae883a05b038fd8cf966dd018ad94115c2020944286b5ed26b2d8cbd180cd7ab964350a916e3b51993
+  metadata.gz: e5ec9afc0028c3f8c51446c0f105fa04c990074ea8ce32e5a3abf5baf0adc75357dd387825ba3ec227f2a053b0f67d7a4c8b2db68ca16d0adc13637c9aacee32
+  data.tar.gz: 6d787e65bc015eef273afa360c456efa76ada52539eb01ece86d737323a65625f4d7c4671ebb9afa67aad6c710e67dec60de586d741c26ea388a20d6f548e934

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## Unreleased
 
-[Compare v2.3.1...HEAD](https://github.com/AMHOL/openra-ruby/compare/v2.3.0...HEAD)
+[Compare v3.0.0...HEAD](https://github.com/AMHOL/openra-ruby/compare/v3.0.0...HEAD)
+
+## v3.0.0
+
+* [replay-metadata] Rename metadata command to replay-metadata ([AMHOL](https://github.com/AMHOL))
+
+[Compare v2.3.1...v3.0.0](https://github.com/AMHOL/openra-ruby/compare/v2.3.0...v3.0.0)
 
 ## v2.3.1
 

data/README.md

@@ -25,7 +25,7 @@ gem update openra
 
 ```sh
 openra replay-data /path/to/replay.orarep [--format json|pretty-json|yaml]
-openra metadata /path/to/replay.orarep [--format json|pretty-json|yaml]
+openra replay-metadata /path/to/replay.orarep [--format json|pretty-json|yaml]
 ```
 
 ### Other tools

data/lib/openra/cli.rb

@@ -7,10 +7,10 @@ require 'dry/cli'
 require 'openra/version'
 require 'openra/constants'
 require 'openra/replays'
-require 'openra/cli/utils'
+require 'openra/commands'
 require 'openra/cli/formatters'
-require 'openra/cli/commands/metadata'
 require 'openra/cli/commands/replay_data'
+require 'openra/cli/commands/replay_metadata'
 require 'openra/cli/commands/version'
 require 'openra/cli/command_registry'
 

data/lib/openra/cli/command_registry.rb

@@ -5,8 +5,8 @@ module Openra
     class CommandRegistry
       extend Dry::CLI::Registry
 
-      register 'metadata', Commands::Metadata
       register 'replay-data', Commands::ReplayData
+      register 'replay-metadata', Commands::ReplayMetadata
       register 'version', Commands::Version
     end
   end

data/lib/openra/cli/commands/replay_data.rb

@@ -4,155 +4,13 @@ module Openra
   class CLI
     module Commands
       class ReplayData < Dry::CLI::Command
-        include CLI::Utils
-
         desc 'Output replay data to stdout'
 
         argument :replay, required: true, desc: 'Path of the replay file to read data from'
         option :format, default: 'json', values: %w(json pretty-json yaml), desc: 'Output format'
 
         def call(replay:, **options)
-          replay = Openra::Replays::Replay.new(replay)
-          support_powers = SUPPORT_POWERS.fetch(replay.metadata.mod, {})
-
-          data = {
-            mod: replay.metadata.mod,
-            version: replay.metadata.version,
-            server_name: nil,
-            map: {
-              name: utf8(replay.metadata.map_name),
-              hash: replay.metadata.map_hash
-            },
-            game: {
-              type: replay.players.each_with_object(Hash.new(0)) { |player, hash|
-                if player.team.nil?
-                  hash[SecureRandom.uuid] += 1
-                else
-                  hash[player.team] += 1
-                end
-              }.values.join('v'),
-              start_time: replay.metadata.start_time.iso8601,
-              end_time: replay.metadata.end_time.iso8601,
-              duration: time((replay.metadata.end_time - replay.metadata.start_time) * 1000),
-              options: nil
-            },
-            clients: [],
-            chat: []
-          }
-
-          current_sync_clients = []
-          current_sync_info = nil
-
-          replay.each_order do |order|
-            client = current_sync_clients.find do |candidate|
-              candidate.index == order.client_index.to_s
-            end
-
-            case order.command
-            when 'StartGame'
-              data[:clients] = current_sync_info.clients.map do |client|
-                player = replay.player(client.index)
-                player_index = replay.players.index(player) + FIRST_PLAYER_INDEX if player
-
-                {
-                  index: client.index,
-                  player_index: player_index,
-                  name: utf8(client.name),
-                  fingerprint: client.fingerprint,
-                  preferred_color: client.preferred_color,
-                  color: client.color,
-                  spawn: {
-                    random: player&.is_random_spawn,
-                    point: client.spawn_point
-                  },
-                  faction: {
-                    random: player&.is_random_faction,
-                    chosen: client.faction_name.downcase,
-                    actual: player&.faction_id
-                  },
-                  ip: client.ip,
-                  team: player&.team,
-                  is_bot: player&.is_bot || false,
-                  is_admin: client.is_admin,
-                  is_player: !player.nil?,
-                  is_winner: player&.outcome == 'Won',
-                  outcome_time: player&.outcome_time&.iso8601,
-                  build: [],
-                  support_powers: []
-                }
-              end
-
-              data[:game][:options] = {
-                explored_map: current_sync_info.global_settings.game_options.explored_map_enabled.value,
-                speed: current_sync_info.global_settings.game_options.game_speed.value,
-                starting_cash: current_sync_info.global_settings.game_options.starting_cash.value,
-                starting_units: current_sync_info.global_settings.game_options.starting_units.value,
-                fog_enabled: current_sync_info.global_settings.game_options.fog_enabled.value,
-                cheats_enabled: current_sync_info.global_settings.game_options.cheats_enabled.value,
-                kill_bounty_enabled: current_sync_info.global_settings.game_options.bounties_enabled.value,
-                allow_undeploy: current_sync_info.global_settings.game_options.conyard_undeploy_enabled.value,
-                crates_enabled: current_sync_info.global_settings.game_options.crates_enabled.value,
-                build_off_allies: current_sync_info.global_settings.game_options.build_off_allies_enabled.value,
-                restrict_build_radius: current_sync_info.global_settings.game_options.restricted_build_radius_enabled.value,
-                short_game: current_sync_info.global_settings.game_options.short_game_enabled.value,
-                techlevel: current_sync_info.global_settings.game_options.tech_level.value
-              }
-            when 'SyncInfo'
-              current_sync_info = Openra::Struct::SyncInfo.new(
-                Openra::MiniYAML.load(order.target)
-              )
-              current_sync_clients = current_sync_info.clients
-            when 'SyncLobbyClients'
-              current_sync_clients = Openra::Struct::SyncLobbyClients.new(
-                Openra::MiniYAML.load(order.target)
-              ).clients
-            when *support_powers.keys
-              key = support_powers.fetch(utf8(order.command))
-              client_hash = data[:clients].find do |candidate|
-                candidate[:index] == order.client_index.to_s
-              end
-
-              client_hash[:support_powers] << {
-                type: key,
-                game_time: time(order.frame.pred * current_sync_info.global_settings.frametime_multiplier),
-                placement: cell(order.target_cell.to_i),
-                extra_placement: cell(order.extra_cell.to_i),
-              }
-            when 'PlaceBuilding'
-              # subject_id stores the player index here
-              # as bot commands are issued by the host client
-              client_hash = data[:clients].find do |candidate|
-                candidate[:player_index] == order.subject_id
-              end
-
-              client_hash[:build] << {
-                structure: utf8(order.target),
-                game_time: time(order.frame.pred * current_sync_info.global_settings.frametime_multiplier),
-                placement: cell(order.target_cell.to_i)
-              }
-            when 'Message'
-              data[:chat] << {
-                channel: 'server',
-                name: nil,
-                message: utf8(order.target)
-              }
-            when 'Chat'
-              data[:chat] << {
-                channel: 'global',
-                name: utf8(client.name),
-                message: utf8(order.target)
-              }
-            when 'TeamChat'
-              data[:chat] << {
-                channel: client.team,
-                name: utf8(client.name),
-                message: utf8(order.target)
-              }
-            end
-          end
-
-          data[:server_name] = utf8(current_sync_info.global_settings.server_name)
-
+          data = Openra::Commands::Replays::ExtractData.new.call(replay)
           puts FORMATTERS.fetch(options[:format]).call(data)
         end
       end

data/lib/openra/cli/commands/replay_metadata.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# frozen_string_literal: true
+
+module Openra
+  class CLI
+    module Commands
+      class ReplayMetadata < Dry::CLI::Command
+        desc 'Output replay metadata to stdout'
+
+        argument :replay, required: true, desc: 'Path of the replay file to read data from'
+        option :format, default: 'json', values: %w(json pretty-json yaml), desc: 'Output format'
+
+        def call(replay:, **options)
+          data = Openra::Commands::Replays::ExtractMetadata.new.call(replay)
+          puts FORMATTERS.fetch(options[:format]).call(data)
+        end
+      end
+    end
+  end
+end

data/lib/openra/commands.rb

@@ -0,0 +1,3 @@
+require 'openra/commands/utils'
+require 'openra/commands/replays/extract_metadata'
+require 'openra/commands/replays/extract_data'

data/lib/openra/commands/replays/extract_data.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Openra
+  module Commands
+    module Replays
+      class ExtractData
+        include Utils
+
+        def call(filepath)
+          replay = Openra::Replays::Replay.new(filepath)
+          support_powers = SUPPORT_POWERS.fetch(replay.metadata.mod, {})
+
+          data = {
+            mod: replay.metadata.mod,
+            version: replay.metadata.version,
+            server_name: nil,
+            map: {
+              name: utf8(replay.metadata.map_name),
+              hash: replay.metadata.map_hash
+            },
+            game: {
+              type: replay.players.each_with_object(Hash.new(0)) { |player, hash|
+                if player.team.nil?
+                  hash[SecureRandom.uuid] += 1
+                else
+                  hash[player.team] += 1
+                end
+              }.values.join('v'),
+              start_time: replay.metadata.start_time.iso8601,
+              end_time: replay.metadata.end_time.iso8601,
+              duration: time((replay.metadata.end_time - replay.metadata.start_time) * 1000),
+              options: nil
+            },
+            clients: [],
+            chat: []
+          }
+
+          current_sync_clients = []
+          current_sync_info = nil
+
+          replay.each_order do |order|
+            client = current_sync_clients.find do |candidate|
+              candidate.index == order.client_index.to_s
+            end
+
+            case order.command
+            when 'StartGame'
+              data[:clients] = current_sync_info.clients.map do |client|
+                player = replay.player(client.index)
+                player_index = replay.players.index(player) + FIRST_PLAYER_INDEX if player
+
+                {
+                  index: client.index,
+                  player_index: player_index,
+                  name: utf8(client.name),
+                  fingerprint: client.fingerprint,
+                  preferred_color: client.preferred_color,
+                  color: client.color,
+                  spawn: {
+                    random: player&.is_random_spawn,
+                    point: client.spawn_point
+                  },
+                  faction: {
+                    random: player&.is_random_faction,
+                    chosen: client.faction_name.downcase,
+                    actual: player&.faction_id
+                  },
+                  ip: client.ip,
+                  team: player&.team,
+                  is_bot: player&.is_bot || false,
+                  is_admin: client.is_admin,
+                  is_player: !player.nil?,
+                  is_winner: player&.outcome == 'Won',
+                  outcome_time: player&.outcome_time&.iso8601,
+                  build: [],
+                  support_powers: []
+                }
+              end
+
+              data[:game][:options] = {
+                explored_map: current_sync_info.global_settings.game_options.explored_map_enabled.value,
+                speed: current_sync_info.global_settings.game_options.game_speed.value,
+                starting_cash: current_sync_info.global_settings.game_options.starting_cash.value,
+                starting_units: current_sync_info.global_settings.game_options.starting_units.value,
+                fog_enabled: current_sync_info.global_settings.game_options.fog_enabled.value,
+                cheats_enabled: current_sync_info.global_settings.game_options.cheats_enabled.value,
+                kill_bounty_enabled: current_sync_info.global_settings.game_options.bounties_enabled.value,
+                allow_undeploy: current_sync_info.global_settings.game_options.conyard_undeploy_enabled.value,
+                crates_enabled: current_sync_info.global_settings.game_options.crates_enabled.value,
+                build_off_allies: current_sync_info.global_settings.game_options.build_off_allies_enabled.value,
+                restrict_build_radius: current_sync_info.global_settings.game_options.restricted_build_radius_enabled.value,
+                short_game: current_sync_info.global_settings.game_options.short_game_enabled.value,
+                techlevel: current_sync_info.global_settings.game_options.tech_level.value
+              }
+            when 'SyncInfo'
+              current_sync_info = Openra::Struct::SyncInfo.new(
+                Openra::MiniYAML.load(order.target)
+              )
+              current_sync_clients = current_sync_info.clients
+            when 'SyncLobbyClients'
+              current_sync_clients = Openra::Struct::SyncLobbyClients.new(
+                Openra::MiniYAML.load(order.target)
+              ).clients
+            when *support_powers.keys
+              key = support_powers.fetch(utf8(order.command))
+              client_hash = data[:clients].find do |candidate|
+                candidate[:index] == order.client_index.to_s
+              end
+
+              client_hash[:support_powers] << {
+                type: key,
+                game_time: time(order.frame.pred * current_sync_info.global_settings.frametime_multiplier),
+                placement: cell(order.target_cell.to_i),
+                extra_placement: cell(order.extra_cell.to_i),
+              }
+            when 'PlaceBuilding'
+              # subject_id stores the player index here
+              # as bot commands are issued by the host client
+              client_hash = data[:clients].find do |candidate|
+                candidate[:player_index] == order.subject_id
+              end
+
+              client_hash[:build] << {
+                structure: utf8(order.target),
+                game_time: time(order.frame.pred * current_sync_info.global_settings.frametime_multiplier),
+                placement: cell(order.target_cell.to_i)
+              }
+            when 'Message'
+              data[:chat] << {
+                channel: 'server',
+                name: nil,
+                message: utf8(order.target)
+              }
+            when 'Chat'
+              data[:chat] << {
+                channel: 'global',
+                name: utf8(client.name),
+                message: utf8(order.target)
+              }
+            when 'TeamChat'
+              data[:chat] << {
+                channel: client.team,
+                name: utf8(client.name),
+                message: utf8(order.target)
+              }
+            end
+          end
+
+          data[:server_name] = utf8(current_sync_info.global_settings.server_name)
+
+          data
+        end
+      end
+    end
+  end
+end

data/lib/openra/{cli/commands/metadata.rb → commands/replays/extract_metadata.rb}

@@ -1,20 +1,15 @@
 # frozen_string_literal: true
 
 module Openra
-  class CLI
-    module Commands
-      class Metadata < Dry::CLI::Command
-        include CLI::Utils
+  module Commands
+    module Replays
+      class ExtractMetadata
+        include Utils
 
-        desc 'Output replay metadata to stdout'
+        def call(filepath)
+          replay = Openra::Replays::Replay.new(filepath)
 
-        argument :replay, required: true, desc: 'Path of the replay file to read data from'
-        option :format, default: 'json', values: %w(json pretty-json yaml), desc: 'Output format'
-
-        def call(replay:, **options)
-          replay = Openra::Replays::Replay.new(replay)
-
-          data = {
+          {
             mod: replay.metadata.mod,
             version: replay.metadata.version,
             map: {
@@ -55,8 +50,6 @@ module Openra
               }
             }
           }
-
-          puts FORMATTERS.fetch(options[:format]).call(data)
         end
       end
     end

data/lib/openra/{cli → commands}/utils.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Openra
-  class CLI
+  module Commands
     module Utils
       def utf8(string)
         string.force_encoding('UTF-8')

data/lib/openra/struct.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'dry/transformer/all'
-require 'dry-struct'
 require 'openra/types'
+require 'dry-struct'
 require 'openra/struct/functions'
 require 'openra/struct/pre_processor'
 

data/lib/openra/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openra
-  VERSION = '2.3.1'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openra
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,11 +158,14 @@ files:
 - lib/openra.rb
 - lib/openra/cli.rb
 - lib/openra/cli/command_registry.rb
-- lib/openra/cli/commands/metadata.rb
 - lib/openra/cli/commands/replay_data.rb
+- lib/openra/cli/commands/replay_metadata.rb
 - lib/openra/cli/commands/version.rb
 - lib/openra/cli/formatters.rb
-- lib/openra/cli/utils.rb
+- lib/openra/commands.rb
+- lib/openra/commands/replays/extract_data.rb
+- lib/openra/commands/replays/extract_metadata.rb
+- lib/openra/commands/utils.rb
 - lib/openra/constants.rb
 - lib/openra/mini_yaml.rb
 - lib/openra/replays.rb