modsvaskr 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9da018a3ec7ff9aa0b326ab9ba345da5ae001d20c3a158ccb6e0b00f7a09b71
-  data.tar.gz: 04f068e2b37bdebe8162365034fb9acfd50c1d664fbba0f2a08c5e6acb929464
+  metadata.gz: ec8a78a2351a1b75ce524ec43bc394f32af0ca8f9f8bdcb503227ef61c67a835
+  data.tar.gz: 1368b7d37845214a577ce3c90a74d771921c82dd9b6e2b29ea7290c7087c503a
 SHA512:
-  metadata.gz: 26e7a236ac7b40df6b3298f02ef6ec9b774e7abee85fa0222af1891423202ae9b76cfbc9e195b34bb311f6f03e48bc35b28d57dd5bbbcf4fdd672917b68b69e0
-  data.tar.gz: 5503901acf312ce5b509760ee3af77b68262a537727498522cdea69e35f207eac1f1f7fec0868f3173ccb27ba273b590103c4c8171fae2b249c8badaf76f7355
+  metadata.gz: 7fcdfcb6474e23a2194c368c8eb77af05b83d8c3ded3f34d9a11ecd7e8decf0bfd33d4d2c07edd2ac0f2ce865004ce8a7b5c0fe4a205a5efb82745d2d8a38d25
+  data.tar.gz: cf8b50f20f69992e5830472809bdb356293f3b5d5e5c3410b4a3b996bab5234932162836f5fecf0d563af24ad9fad8cc92cc9dbb186a1458642053c662e82201

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

@@ -131,14 +131,15 @@ module Modsvaskr
         in_game_tests.each do |tests_suite, selected_tests|
           in_game_tests_to_subscribe = @tests_suites[tests_suite].in_game_tests_for(selected_tests)
           in_game_tests_to_subscribe.each do |in_game_tests_suite, selected_in_game_tests|
+            selected_in_game_tests_downcase = selected_in_game_tests.map(&:downcase)
             in_game_tests_subscriptions[in_game_tests_suite] = [] unless in_game_tests_subscriptions.key?(in_game_tests_suite)
             in_game_tests_subscriptions[in_game_tests_suite] << {
               tests_suite: tests_suite,
-              in_game_tests: selected_in_game_tests,
+              in_game_tests: selected_in_game_tests_downcase,
               selected_tests: selected_tests
             }
             merged_in_game_tests[in_game_tests_suite] = [] unless merged_in_game_tests.key?(in_game_tests_suite)
-            merged_in_game_tests[in_game_tests_suite] = (merged_in_game_tests[in_game_tests_suite] + selected_in_game_tests).uniq
+            merged_in_game_tests[in_game_tests_suite] = (merged_in_game_tests[in_game_tests_suite] + selected_in_game_tests_downcase).uniq
           end
         end
         in_game_tests_runner = InGameTestsRunner.new(@config, @game)

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,7 +24,7 @@ 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|
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
           tests["#{row[0].downcase}/#{row[2].to_i(16)}"] = {
             name: "Take screenshot of #{row[0]} - #{row[3]}"
           } if row[1].downcase == 'npc_'
@@ -20,30 +32,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)
-        { 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,7 +24,7 @@ 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|
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') 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_'
@@ -20,30 +32,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)
-        { 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/version.rb

@@ -1,5 +1,5 @@
 module Modsvaskr
 
-  VERSION = '0.1.4'
+  VERSION = '0.1.9'
 
 end

data/lib/modsvaskr/xedit.rb

@@ -1,3 +1,4 @@
+require 'modsvaskr/encoding'
 require 'modsvaskr/run_cmd'
 
 module Modsvaskr
@@ -47,6 +48,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.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-21 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