mod_organizer 1.0.0

data/spec/mod_organizer_test/helpers.rb

@@ -0,0 +1,115 @@
+require 'fileutils'
+require 'logger'
+require 'mod_organizer'
+
+module ModOrganizerTest
+
+  module Helpers
+
+    # ModOrganizer: The ModOrganizer instance that has been setup
+    attr_reader :mod_organizer
+
+    # String: The instance directory that has been setup
+    attr_reader :instance_dir
+
+    # Prepare a ModOrganizer instance directory
+    # The directory path is stored in an instance variable named @instance_dir.
+    #
+    # Parameters::
+    # * *ini* (Hash< Symbol, Hash<Symbol, String> >): Content of the ini file to overwrite default values [default: {}]
+    # * *instance_name* (String or nil): The instance name to be used to mock a shared installation, or nil for a portable installation [default: nil]
+    def setup_instance_dir(ini: {}, instance_name: nil)
+      @instance_dir = "#{Dir.tmpdir}/ModOrganizerTest/ModOrganizer/#{instance_name || 'PortableInstance'}"
+      FileUtils.rm_rf(@instance_dir)
+      FileUtils.mkdir_p(@instance_dir)
+      IniFile.new(
+        content: {
+          General: {
+            gamePath: 'C:/path/to/game',
+            selected_profile: 'Default'
+          },
+          Settings: {
+            log_level: '1'
+          }
+        }.merge(ini) do |_section, default_properties, overwrite_properties|
+          default_properties.merge(overwrite_properties)
+        end
+      ).write(filename: "#{@instance_dir}/ModOrganizer.ini")
+    end
+
+    # Setup an instance of ModOrganizer setup on an instance directory.
+    # It uses the variable @instance_name to eventually setup a shared installation.
+    # The instance is stored in an instance variable named @mod_organizer.
+    #
+    # Parameters::
+    # * *ini* (Hash< Symbol, Hash<Symbol, String> >): Content of the ini file to overwrite default values [default: {}]
+    def setup_mo(ini: {})
+      setup_instance_dir(ini:, instance_name: @instance_name)
+      mo_logger = StringIO.new
+      ENV['LOCALAPPDATA'] = "#{Dir.tmpdir}/ModOrganizerTest"
+      @mod_organizer = ModOrganizer.new(@instance_dir, instance_name: @instance_name, logger: Logger.new(mo_logger))
+    end
+
+    # Setup a mod in the default mods folder.
+    # Prerequisite: instance_dir has to be setup previously with setup_instance_dir.
+    #
+    # Parameters::
+    # * *ini* (Hash< Symbol, Hash<Symbol, String> >): Content of the meta ini file to overwrite default values [default: {}]
+    # * *mod_name* (String): The mod name [default: 'TestMod']
+    # Result::
+    # * String: The mod directory
+    def setup_mod(ini: {}, mod_name: 'TestMod')
+      mod_dir = "#{instance_dir}/mods/#{mod_name}"
+      FileUtils.mkdir_p(mod_dir)
+      IniFile.new(
+        content: {
+          General: {
+            category: '2,',
+            url: 'https://test-mod.url',
+            installationFile: 'TestMod-v1.7z'
+          },
+          installedFiles: {
+            size: '1',
+            '1\\modid': '1337',
+            '1\\fileid': '666'
+          }
+        }.merge(ini) do |_section, default_properties, overwrite_properties|
+          default_properties.merge(overwrite_properties)
+        end
+      ).write(filename: "#{mod_dir}/meta.ini")
+      mod_dir
+    end
+
+    # Setup a download in the default downloads folder.
+    # Prerequisite: instance_dir has to be setup previously with setup_instance_dir.
+    #
+    # Parameters::
+    # * *ini* (Hash< Symbol, Hash<Symbol, String> >): Content of the meta ini file to overwrite default values [default: {}]
+    # * *file_name* (String): The downloaded file name [default: 'TestMod-v1.7z']
+    # Result::
+    # * String: The downloads directory
+    def setup_download(ini: {}, file_name: 'TestMod-v1.7z')
+      downloads_dir = "#{instance_dir}/downloads"
+      FileUtils.mkdir_p(downloads_dir)
+      IniFile.new(
+        content: {
+          General: {
+            name: 'Test Mod file',
+            modID: '1107',
+            fileID: '42'
+          }
+        }.merge(ini) do |_section, default_properties, overwrite_properties|
+          default_properties.merge(overwrite_properties)
+        end
+      ).write(filename: "#{downloads_dir}/#{file_name}.meta")
+      File.write("#{downloads_dir}/#{file_name}", "#{file_name} downloaded content")
+      downloads_dir
+    end
+
+  end
+
+end
+
+RSpec.configure do |config|
+  config.include ModOrganizerTest::Helpers
+end

data/spec/mod_organizer_test/scenarios/mod_organizer/download_spec.rb

@@ -0,0 +1,55 @@
+require 'time'
+
+describe ModOrganizer::Download do
+
+  let(:download) { mod_organizer.mod(name: 'TestMod').sources.first.download }
+  let(:download_dir) { "#{instance_dir}/downloads" }
+  let(:downloaded_file) { "#{instance_dir}/downloads/TestMod-v1.7z" }
+
+  before do
+    setup_mo
+    setup_mod
+    setup_download
+  end
+
+  it 'returns the downloaded file path' do
+    expect(download.downloaded_file_path).to eq downloaded_file
+  end
+
+  it 'returns the downloaded file date' do
+    file_date = Time.parse('2023-01-05 10:20:30 UTC')
+    File.utime(File.atime(downloaded_file), file_date, downloaded_file)
+    expect(download.downloaded_date).to eq file_date
+  end
+
+  it 'returns the NexusMods file name' do
+    expect(download.nexus_file_name).to eq 'Test Mod file'
+  end
+
+  it 'caches the returned NexusMods file name' do
+    expect(download.nexus_file_name).to eq 'Test Mod file'
+    setup_download(ini: { General: { name: 'Alternative Test Mod file' } })
+    expect(download.nexus_file_name).to eq 'Test Mod file'
+  end
+
+  it 'returns the NexusMods mod id' do
+    expect(download.nexus_mod_id).to eq 1107
+  end
+
+  it 'caches the returned NexusMods mod id' do
+    expect(download.nexus_mod_id).to eq 1107
+    setup_download(ini: { General: { modID: '666' } })
+    expect(download.nexus_mod_id).to eq 1107
+  end
+
+  it 'returns the NexusMods file id' do
+    expect(download.nexus_file_id).to eq 42
+  end
+
+  it 'caches the returned NexusMods file id' do
+    expect(download.nexus_file_id).to eq 42
+    setup_download(ini: { General: { fileID: '666' } })
+    expect(download.nexus_file_id).to eq 42
+  end
+
+end

data/spec/mod_organizer_test/scenarios/mod_organizer/mod_spec.rb

@@ -0,0 +1,184 @@
+describe ModOrganizer::Mod do
+
+  let(:mod) { mod_organizer.mod(name: 'TestMod') }
+  let(:mod_dir) { "#{instance_dir}/mods/TestMod" }
+
+  context 'with a simple mod' do
+
+    before do
+      setup_mo
+      setup_mod
+    end
+
+    it 'returns the mod name' do
+      expect(mod.name).to eq 'TestMod'
+    end
+
+    it 'returns the mod enabled flag when enabled' do
+      FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+      File.write(
+        "#{instance_dir}/profiles/Default/modlist.txt",
+        <<~EO_MOD_LIST
+          +TestMod
+        EO_MOD_LIST
+      )
+      expect(mod.enabled?).to be(true)
+    end
+
+    it 'returns the mod enabled flag when disabled' do
+      FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+      File.write(
+        "#{instance_dir}/profiles/Default/modlist.txt",
+        <<~EO_MOD_LIST
+          -TestMod
+        EO_MOD_LIST
+      )
+      expect(mod.enabled?).to be(false)
+    end
+
+    it 'returns the mod categories' do
+      expect(mod.categories).to eq %w[Armour]
+    end
+
+    it 'returns no plugins for mods having no plugins' do
+      expect(mod.plugins).to eq []
+    end
+
+    it 'returns plugins from the mod\'s root directory' do
+      File.write("#{mod_dir}/plugin1.esm", 'Plugin1 esm content')
+      File.write("#{mod_dir}/plugin2.esp", 'Plugin2 esp content')
+      File.write("#{mod_dir}/plugin3.esl", 'Plugin3 esl content')
+      File.write("#{mod_dir}/other_file.txt", 'Other file content')
+      FileUtils.mkdir_p("#{mod_dir}/others")
+      File.write("#{mod_dir}/others/plugin4.esp", 'Plugin4 esp content')
+      expect(mod.plugins.sort).to eq %w[
+        plugin1.esm
+        plugin2.esp
+        plugin3.esl
+      ]
+    end
+
+    it 'returns plugins in lower case' do
+      File.write("#{mod_dir}/PlUgIn1.esm", 'Plugin1 esm content')
+      expect(mod.plugins).to eq %w[plugin1.esm]
+    end
+
+    it 'caches plugins being returned' do
+      File.write("#{mod_dir}/plugin1.esm", 'Plugin1 esm content')
+      expect(mod.plugins).to eq %w[plugin1.esm]
+      File.unlink("#{mod_dir}/plugin1.esm")
+      expect(mod.plugins).to eq %w[plugin1.esm]
+    end
+
+    it 'returns the mod source' do
+      sources = mod.sources
+      expect(sources.size).to be 1
+      expect(sources.first.type).to be :nexus_mods
+      expect(sources.first.nexus_mod_id).to be 1337
+      expect(sources.first.nexus_file_id).to be 666
+      expect(sources.first.file_name).to eq 'TestMod-v1.7z'
+    end
+
+    it 'caches the returned the mod source' do
+      expect(mod.sources.first.nexus_mod_id).to be 1337
+      setup_mod(ini: { installedFiles: { '1\\modid': '1107' } })
+      expect(mod.sources.first.nexus_mod_id).to be 1337
+    end
+
+    it 'returns the mod URL' do
+      expect(mod.url).to eq 'https://test-mod.url'
+    end
+
+  end
+
+  context 'with a mod having no ini file' do
+
+    before do
+      setup_mo
+      setup_mod
+      File.unlink("#{mod_dir}/meta.ini")
+    end
+
+    it 'returns the mod name' do
+      expect(mod.name).to eq 'TestMod'
+    end
+
+    it 'returns the mod enabled flag when enabled' do
+      FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+      File.write(
+        "#{instance_dir}/profiles/Default/modlist.txt",
+        <<~EO_MOD_LIST
+          +TestMod
+        EO_MOD_LIST
+      )
+      expect(mod.enabled?).to be(true)
+    end
+
+    it 'returns the mod enabled flag when disabled' do
+      FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+      File.write(
+        "#{instance_dir}/profiles/Default/modlist.txt",
+        <<~EO_MOD_LIST
+          -TestMod
+        EO_MOD_LIST
+      )
+      expect(mod.enabled?).to be(false)
+    end
+
+    it 'returns no mod categories' do
+      expect(mod.categories).to eq []
+    end
+
+    it 'returns an unknown mod source' do
+      sources = mod.sources
+      expect(sources.size).to be 1
+      expect(sources.first.type).to be :unknown
+      expect(sources.first.nexus_mod_id).to be_nil
+      expect(sources.first.nexus_file_id).to be_nil
+      expect(sources.first.file_name).to be_nil
+    end
+
+    it 'returns no mod URL' do
+      expect(mod.url).to be_nil
+    end
+
+  end
+
+  context 'with a mod having several sources' do
+
+    before do
+      setup_mo
+      setup_mod(
+        ini: {
+          installedFiles: {
+            size: '3',
+            '1\\modid': '100',
+            '1\\fileid': '200',
+            '2\\modid': '101',
+            '2\\fileid': '201',
+            '3\\modid': '102',
+            '3\\fileid': '202'
+          }
+        }
+      )
+    end
+
+    it 'returns several sources' do
+      expect(mod.sources.map.with_index { |source, idx| [idx, source.nexus_mod_id, source.nexus_file_id] }.sort).to eq [
+        [0, 100, 200],
+        [1, 101, 201],
+        [2, 102, 202]
+      ]
+    end
+
+    it 'associates the downloaded file name to the last source only' do
+      expect(mod.sources.map.with_index { |source, idx| [idx, source.file_name] }.sort).to eq [
+        [0, nil],
+        [1, nil],
+        [2, 'TestMod-v1.7z']
+      ]
+    end
+
+  end
+
+end

data/spec/mod_organizer_test/scenarios/mod_organizer/source_spec.rb

@@ -0,0 +1,71 @@
+describe ModOrganizer::Source do
+
+  let(:source) { mod_organizer.mod(name: 'TestMod').sources.first }
+
+  context 'with a source from nexus_mods' do
+
+    before do
+      setup_mo
+      setup_mod
+    end
+
+    it 'returns the NexusMods mod id' do
+      expect(source.nexus_mod_id).to be 1337
+    end
+
+    it 'returns the NexusMods file id' do
+      expect(source.nexus_file_id).to be 666
+    end
+
+    it 'returns the source file name' do
+      expect(source.file_name).to eq 'TestMod-v1.7z'
+    end
+
+    it 'returns the source type' do
+      expect(source.type).to be :nexus_mods
+    end
+
+    it 'returns the download info of the source' do
+      FileUtils.mkdir_p("#{instance_dir}/downloads")
+      downloaded_file = "#{instance_dir}/downloads/TestMod-v1.7z"
+      File.write(downloaded_file, 'TestMod v1 downloaded content')
+      expect(source.download.downloaded_file_path).to eq downloaded_file
+    end
+
+    it 'returns no download info of the source if the downloaded file is missing' do
+      expect(source.download).to be_nil
+    end
+
+  end
+
+  context 'with an unknown source' do
+
+    before do
+      setup_mo
+      setup_mod
+      File.unlink("#{instance_dir}/mods/TestMod/meta.ini")
+    end
+
+    it 'returns no NexusMods mod id' do
+      expect(source.nexus_mod_id).to be_nil
+    end
+
+    it 'returns no NexusMods file id' do
+      expect(source.nexus_file_id).to be_nil
+    end
+
+    it 'returns no source file name' do
+      expect(source.file_name).to be_nil
+    end
+
+    it 'returns the source type' do
+      expect(source.type).to be :unknown
+    end
+
+    it 'returns no download info of the source' do
+      expect(source.download).to be_nil
+    end
+
+  end
+
+end