modsvaskr 0.1.5 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 891a0a4201c62018b26798acd86da140eb757f5633665d29ab2aadbb39fdb8e3
-  data.tar.gz: e03c3b7816308b0a153d890f09f86cfadc892c0da1537770fedf4ecbdea5aca7
+  metadata.gz: 8d247b6d5b73f10426d5769b031213c408bc6ac8c390baea5e9f6a1b0af7495d
+  data.tar.gz: 97d98a1e6d93088e7a63f9a07ac31b01c3ed8e0aba4e4159a842fff9af8efaae
 SHA512:
-  metadata.gz: 34f1d6bf79e7301e8bfb12d8ab2dcb6372f62589bd4c6a7f508e4636d337dc2c72e90db41c06ce2a3a65f49f8ae308eb0b11910fd206906aa92c817ba6529932
-  data.tar.gz: 2035854e4ac51da63b9a6fc7006289b88a307acd92aa8213613dcb10306d787b49dcc40ec087740aaf932a1b56668820fbe3e595887d0df014eaba85b96da201
+  metadata.gz: d17a2422af5a5428266c5586887ab5210e0ad7026c8c07fced929b2731aafb07c97bad7c4c8be5886cac8d19ae7e51e1f3f386da6d00d64536e0032bde004e76
+  data.tar.gz: 775b864997420ad4e78af51e4511d0ad579a236781cbc30c1f1c577992ae3f486d3ab40f701acf4937d51b2bf4397d02fb54c409d37965a03596e0acc57ad799

data/lib/modsvaskr/encoding.rb

@@ -0,0 +1,29 @@
+module Modsvaskr
+
+  module Encoding
+
+    # Convert a string to UTF-8
+    #
+    # Parameters::
+    # * *str* (String): The string to convert
+    # Result::
+    # * String: The converted string
+    def self.to_utf8(str)
+      orig_encoding = str.encoding
+      encoding = nil
+      begin
+        encoding = %w[
+          UTF-8
+          Windows-1252
+          ISO-8859-1
+        ].find { |search_encoding| str.force_encoding(search_encoding).valid_encoding? }
+      ensure
+        str.force_encoding(orig_encoding)
+      end
+      raise "Unknown encoding for string #{str[0..127].inspect}" if encoding.nil?
+      str.encode('UTF-8', encoding)
+    end
+
+  end
+
+end

data/lib/modsvaskr/game.rb

@@ -174,6 +174,30 @@ module Modsvaskr
       end
     end
 
+    # Get the load order.
+    # Keep a cache of it.
+    #
+    # Result::
+    # * Array<String>: List of all active plugins, including masters
+    def get_load_order
+      @cache_load_order = load_order unless defined?(@cache_load_order)
+      @cache_load_order
+    end
+
+    # Get the mod and base id corresponding to a given form id.
+    # Uses load order to determine it.
+    #
+    # Parameters::
+    # * *form_id* (String or Integer): Form ID, either as hexadecimal string, or numercial value
+    # Result::
+    # * String: Plugin name
+    # * Integer: Base form id, independent from the load order
+    def decode_form_id(form_id)
+      form_id = form_id.to_i(16) if form_id.is_a?(String)
+      [get_load_order[form_id / 16_777_216], form_id % 16_777_216]
+    end
+
+
   end
 
 end

data/lib/modsvaskr/games/skyrim_se.rb

@@ -37,7 +37,9 @@ module Modsvaskr
         'SkyrimSE.exe'
       end
 
-      # List of default esps present in the game (the ones in the Data folder when 0 mod is being used)
+      # Ordered list of default esps present in the game (the ones in the Data folder when 0 mod is being used).
+      # The list is ordered according to the game's load order.
+      # [API] - This method is mandatory
       #
       # Result::
       # * Array<String>: List of esp/esm/esl base file names.
@@ -51,6 +53,18 @@ module Modsvaskr
         ]
       end
 
+      # Get the load order.
+      # [API] - This method is mandatory
+      #
+      # Result::
+      # * Array<String>: List of all active plugins, including masters
+      def load_order
+        game_esps +
+          File.read("#{ENV['USERPROFILE']}/AppData/Local/Skyrim Special Edition/plugins.txt").split("\n").map do |line|
+            line =~ /^\*(.+)$/ ? $1.downcase : nil
+          end.compact
+      end
+
       private
 
       # Install SKSE64 corresponding to our game

data/lib/modsvaskr/in_game_tests_runner.rb

@@ -211,21 +211,23 @@ module Modsvaskr
                 end
               end
               # We will start again. Leave some time to interrupt if we want.
-              unless @config.no_prompt
+              if @config.no_prompt
+                out 'Start again automatically as no_prompt has been set.'
+              else
                 # First, flush stdin of any pending character
                 $stdin.getc while !select([$stdin], nil, nil, 2).nil?
-              end
-              out "We are going to start again in #{@game.timeout_interrupt_tests_secs} seconds. Press Enter now to interrupt it."
-              key_pressed =
-                begin
-                  Timeout.timeout(@game.timeout_interrupt_tests_secs) { $stdin.gets }
-                rescue Timeout::Error
-                  nil
+                out "We are going to start again in #{@game.timeout_interrupt_tests_secs} seconds. Press Enter now to interrupt it."
+                key_pressed =
+                  begin
+                    Timeout.timeout(@game.timeout_interrupt_tests_secs) { $stdin.gets }
+                  rescue Timeout::Error
+                    nil
+                  end
+                if key_pressed
+                  log "[ In-game testing #{@game.name} ] - Run interrupted by user."
+                  # TODO: Remove AutoTest start on load: it has been interrupted by the user, so we should not keep it in case the user launches the game by itself.
+                  break
                 end
-              if key_pressed
-                log "[ In-game testing #{@game.name} ] - Run interrupted by user."
-                # TODO: Remove AutoTest start on load: it has been interrupted by the user, so we should not keep it in case the user launches the game by itself.
-                break
               end
             end
           end

data/lib/modsvaskr/in_game_tests_suite.rb

@@ -0,0 +1,39 @@
+module Modsvaskr
+
+  # Mixin adding methods to map directly a tests suite to an in-game tests suite
+  # Uses the following methods:
+  # * *in_game_tests_suite* -> Symbol: Name of the in-gamer tests suite on which we forward the tests run
+  module InGameTestsSuite
+
+    # Get the list of tests to be run in-game for a given list of test names.
+    # [API] - This method is mandatory for tests needing to be run in-game.
+    #
+    # Parameters::
+    # * *tests* (Array<String>): List of test names
+    # Result::
+    # * Hash<Symbol, Array<String> >: List of in-game test names, per in-game tests suite
+    def in_game_tests_for(tests)
+      { in_game_tests_suite => tests }
+    end
+
+    # Set statuses based on the result of AutoTest statuses.
+    # AutoTest names are case insensitive.
+    # [API] - This method is mandatory for tests needing to be run in-game.
+    #
+    # Parameters::
+    # * *tests* (Array<String>): List of test names
+    # * *auto_test_statuses* (Hash<Symbol, Hash<String, String> >): In-game test statuses, per in-game test name, per in-game tests suite
+    # Result::
+    # * Array<[String, String]>: Corresponding list of [test name, test status]
+    def parse_auto_tests_statuses_for(tests, auto_test_statuses)
+      in_game_test_statuses = auto_test_statuses[in_game_tests_suite] || {}
+      tests.map do |test_name|
+        test_downcase = test_name.downcase
+        _in_game_test, in_game_test_status = in_game_test_statuses.find { |search_in_game_test, _search_in_game_test_status| search_in_game_test.downcase == test_downcase }
+        in_game_test_status.nil? ? nil : [test_name, in_game_test_status]
+      end.compact
+    end
+
+  end
+
+end

data/lib/modsvaskr/tests_suites/exterior_cell.rb

@@ -1,9 +1,21 @@
+require 'modsvaskr/in_game_tests_suite'
+
 module Modsvaskr
 
   module TestsSuites
 
     class ExteriorCell < TestsSuite
 
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :locations
+      end
+
       # Discover the list of tests information that could be run.
       # [API] - This method is mandatory
       #
@@ -14,7 +26,7 @@ module Modsvaskr
         # Hash< String, Hash< String, Array<[Integer, Integer]> > >
         exterior_cells = {}
         @game.xedit.run_script('DumpInfo', only_once: true)
-        CSV.read("#{@game.xedit.install_path}/Edit Scripts/Modsvaskr_ExportedDumpInfo.csv", encoding: 'windows-1251:utf-8').each do |row|
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
           esp_name, record_type = row[0..1]
           if record_type.downcase == 'cell'
             cell_type, cell_name, cell_x, cell_y = row[3..6]
@@ -33,7 +45,7 @@ module Modsvaskr
         # Test only exterior cells that have been changed by mods, and make sure we test the minimum, knowing that each cell loaded in game tests 5x5 cells around
         vanilla_esps = @game.game_esps
         vanilla_exterior_cells = vanilla_esps.inject({}) do |merged_worldspaces, esp_name|
-          merged_worldspaces.merge(exterior_cells[esp_name]) do |worldspace, ext_cells1, ext_cells2|
+          merged_worldspaces.merge(exterior_cells[esp_name] || {}) do |worldspace, ext_cells1, ext_cells2|
             (ext_cells1 + ext_cells2).sort.uniq
           end
         end
@@ -75,7 +87,7 @@ module Modsvaskr
                   slice(*(candidate_cell_x - delta_cells..candidate_cell_x + delta_cells)).
                   inject(0) { |sum_cells, (_cur_cell_x, cur_cell_ys)| sum_cells + cur_cell_ys.slice(*(candidate_cell_y - delta_cells..candidate_cell_y + delta_cells)).size }
                 if best_cell_score.nil? || nbr_tested_cells > best_cell_score
-                  nbr_tested_cells = best_cell_score
+                  best_cell_score = nbr_tested_cells
                   best_cell_x = candidate_cell_x
                   best_cell_y = candidate_cell_y
                 end
@@ -98,30 +110,6 @@ module Modsvaskr
         tests
       end
 
-      # Get the list of tests to be run in-game for a given list of test names.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # Result::
-      # * Hash<Symbol, Array<String> >: List of in-game test names, per in-game tests suite
-      def in_game_tests_for(tests)
-        { locations: tests }
-      end
-
-      # Set statuses based on the result of AutoTest statuses.
-      # AutoTest names are case insensitive.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # * *auto_test_statuses* (Hash<Symbol, Array<[String, String]> >): Ordered list of AutoTest [test name, test status], per AutoTest tests suite
-      # Result::
-      # * Array<[String, String]>: Corresponding list of [test name, test status]
-      def parse_auto_tests_statuses_for(tests, auto_test_statuses)
-        auto_test_statuses.key?(:locations) ? auto_test_statuses[:locations] : []
-      end
-
     end
 
   end

data/lib/modsvaskr/tests_suites/interior_cell.rb

@@ -1,9 +1,21 @@
+require 'modsvaskr/in_game_tests_suite'
+
 module Modsvaskr
 
   module TestsSuites
 
     class InteriorCell < TestsSuite
 
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :locations
+      end
+
       # Discover the list of tests information that could be run.
       # [API] - This method is mandatory
       #
@@ -14,7 +26,7 @@ module Modsvaskr
         # Hash< String, Array<String> >
         interior_cells = {}
         @game.xedit.run_script('DumpInfo', only_once: true)
-        CSV.read("#{@game.xedit.install_path}/Edit Scripts/Modsvaskr_ExportedDumpInfo.csv", encoding: 'windows-1251:utf-8').each do |row|
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
           esp_name, record_type = row[0..1]
           if record_type.downcase == 'cell'
             cell_type, cell_name = row[3..4]
@@ -27,7 +39,7 @@ module Modsvaskr
         end
         # Test only interior cells that have been changed by mods
         vanilla_esps = @game.game_esps
-        vanilla_interior_cells = vanilla_esps.map { |esp_name| interior_cells[esp_name] }.flatten.sort.uniq
+        vanilla_interior_cells = vanilla_esps.map { |esp_name| interior_cells[esp_name] || [] }.flatten.sort.uniq
         Hash[interior_cells.
           map { |esp_name, esp_cells| vanilla_esps.include?(esp_name) ? [] : vanilla_interior_cells & esp_cells }.
           flatten.
@@ -44,30 +56,6 @@ module Modsvaskr
         ]
       end
 
-      # Get the list of tests to be run in-game for a given list of test names.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # Result::
-      # * Hash<Symbol, Array<String> >: List of in-game test names, per in-game tests suite
-      def in_game_tests_for(tests)
-        { locations: tests }
-      end
-
-      # Set statuses based on the result of AutoTest statuses.
-      # AutoTest names are case insensitive.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # * *auto_test_statuses* (Hash<Symbol, Array<[String, String]> >): Ordered list of AutoTest [test name, test status], per AutoTest tests suite
-      # Result::
-      # * Array<[String, String]>: Corresponding list of [test name, test status]
-      def parse_auto_tests_statuses_for(tests, auto_test_statuses)
-        auto_test_statuses.key?(:locations) ? auto_test_statuses[:locations] : []
-      end
-
     end
 
   end

data/lib/modsvaskr/tests_suites/npc.rb

@@ -1,9 +1,21 @@
+require 'modsvaskr/in_game_tests_suite'
+
 module Modsvaskr
 
   module TestsSuites
 
     class Npc < TestsSuite
 
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :npcs
+      end
+
       # Discover the list of tests information that could be run.
       # [API] - This method is mandatory
       #
@@ -12,38 +24,24 @@ module Modsvaskr
       def discover_tests
         tests = {}
         @game.xedit.run_script('DumpInfo', only_once: true)
-        CSV.read("#{@game.xedit.install_path}/Edit Scripts/Modsvaskr_ExportedDumpInfo.csv", encoding: 'windows-1251:utf-8').each do |row|
-          tests["#{row[0].downcase}/#{row[2].to_i(16)}"] = {
-            name: "Take screenshot of #{row[0]} - #{row[3]}"
-          } if row[1].downcase == 'npc_'
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
+          if row[1].downcase == 'npc_'
+            # Know from which mod this ID comes from
+            plugin, base_form_id = @game.decode_form_id(row[2])
+            test_name = "#{plugin}/#{base_form_id}"
+            if tests.key?(test_name)
+              # Add the name of the mod to the description, so that we know which mod modifies which NPC.
+              tests[test_name][:name] << "/#{row[0].downcase}"
+            else
+              tests[test_name] = {
+                name: "Take screenshot of #{row[3]} - #{row[0].downcase}"
+              }
+            end
+          end
         end
         tests
       end
 
-      # Get the list of tests to be run in-game for a given list of test names.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # Result::
-      # * Hash<Symbol, Array<String> >: List of in-game test names, per in-game tests suite
-      def in_game_tests_for(tests)
-        { npcs: tests }
-      end
-
-      # Set statuses based on the result of AutoTest statuses.
-      # AutoTest names are case insensitive.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # * *auto_test_statuses* (Hash<Symbol, Array<[String, String]> >): Ordered list of AutoTest [test name, test status], per AutoTest tests suite
-      # Result::
-      # * Array<[String, String]>: Corresponding list of [test name, test status]
-      def parse_auto_tests_statuses_for(tests, auto_test_statuses)
-        auto_test_statuses.key?(:npcs) ? auto_test_statuses[:npcs] : []
-      end
-
     end
 
   end

data/lib/modsvaskr/tests_suites/npc_head.rb

@@ -1,9 +1,21 @@
+require 'modsvaskr/in_game_tests_suite'
+
 module Modsvaskr
 
   module TestsSuites
 
     class NpcHead < TestsSuite
 
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :npcshead
+      end
+
       # Discover the list of tests information that could be run.
       # [API] - This method is mandatory
       #
@@ -12,38 +24,24 @@ module Modsvaskr
       def discover_tests
         tests = {}
         @game.xedit.run_script('DumpInfo', only_once: true)
-        CSV.read("#{@game.xedit.install_path}/Edit Scripts/Modsvaskr_ExportedDumpInfo.csv", encoding: 'windows-1251:utf-8').each do |row|
-          tests["#{row[0].downcase}/#{row[2].to_i(16)}"] = {
-            name: "Take head screenshot of #{row[0]} - #{row[3]}"
-          } if row[1].downcase == 'npc_'
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
+          if row[1].downcase == 'npc_'
+            # Know from which mod this ID comes from
+            plugin, base_form_id = @game.decode_form_id(row[2])
+            test_name = "#{plugin}/#{base_form_id}"
+            if tests.key?(test_name)
+              # Add the name of the mod to the description, so that we know which mod modifies which NPC.
+              tests[test_name][:name] << "/#{row[0].downcase}"
+            else
+              tests[test_name] = {
+                name: "Take head screenshot of #{row[3]} - #{row[0].downcase}"
+              }
+            end
+          end
         end
         tests
       end
 
-      # Get the list of tests to be run in-game for a given list of test names.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # Result::
-      # * Hash<Symbol, Array<String> >: List of in-game test names, per in-game tests suite
-      def in_game_tests_for(tests)
-        { npcshead: tests }
-      end
-
-      # Set statuses based on the result of AutoTest statuses.
-      # AutoTest names are case insensitive.
-      # [API] - This method is mandatory for tests needing to be run in-game.
-      #
-      # Parameters::
-      # * *tests* (Array<String>): List of test names
-      # * *auto_test_statuses* (Hash<Symbol, Array<[String, String]> >): Ordered list of AutoTest [test name, test status], per AutoTest tests suite
-      # Result::
-      # * Array<[String, String]>: Corresponding list of [test name, test status]
-      def parse_auto_tests_statuses_for(tests, auto_test_statuses)
-        auto_test_statuses.key?(:npcshead) ? auto_test_statuses[:npcshead] : []
-      end
-
     end
 
   end

data/lib/modsvaskr/ui.rb

@@ -1,4 +1,3 @@
-require 'csv'
 require 'curses_menu'
 require 'modsvaskr/logger'
 require 'modsvaskr/tests_runner'

data/lib/modsvaskr/version.rb

@@ -1,5 +1,5 @@
 module Modsvaskr
 
-  VERSION = '0.1.5'
+  VERSION = '0.1.10'
 
 end

data/lib/modsvaskr/xedit.rb

@@ -1,3 +1,5 @@
+require 'csv'
+require 'modsvaskr/encoding'
 require 'modsvaskr/run_cmd'
 
 module Modsvaskr
@@ -47,6 +49,17 @@ module Modsvaskr
       end
     end
 
+    # Parse a CSV that has been dumped by a previous run of xEdit
+    #
+    # Parameters::
+    # * *csv* (String): Name of the CSV file (from Edit Scripts), without .csv
+    # * *row_block* (Proc): Code called for each CSV row
+    #   Parameters::
+    #   * *row* (Array<String>): CSV row
+    def parse_csv(csv, &row_block)
+      CSV.parse(Encoding.to_utf8(File.read("#{install_path}/Edit Scripts/#{csv}.csv", mode: 'rb'))).each(&row_block)
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modsvaskr
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.10
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses_menu
@@ -104,9 +104,11 @@ extra_rdoc_files: []
 files:
 - bin/modsvaskr
 - lib/modsvaskr/config.rb
+- lib/modsvaskr/encoding.rb
 - lib/modsvaskr/game.rb
 - lib/modsvaskr/games/skyrim_se.rb
 - lib/modsvaskr/in_game_tests_runner.rb
+- lib/modsvaskr/in_game_tests_suite.rb
 - lib/modsvaskr/logger.rb
 - lib/modsvaskr/run_cmd.rb
 - lib/modsvaskr/tests_runner.rb