mod_organizer 1.0.0

data/spec/mod_organizer_test/scenarios/mod_organizer_spec.rb

@@ -0,0 +1,292 @@
+describe ModOrganizer do
+
+  shared_examples 'a ModOrganizer instance' do
+
+    context 'when validating ini file reading' do
+
+      it 'returns the game path' do
+        setup_mo(ini: { General: { gamePath: 'C:/path/to/Skyrim Special Edition' } })
+        expect(mod_organizer.game_path).to eq 'C:/path/to/Skyrim Special Edition'
+      end
+
+      it 'returns the game path from a ByteArray' do
+        setup_mo(ini: { General: { gamePath: '@ByteArray(C:\\\\path\\\\to\\\\Skyrim Special Edition)' } })
+        expect(mod_organizer.game_path).to eq 'C:/path/to/Skyrim Special Edition'
+      end
+
+      it 'returns the downloads directory from the ini file' do
+        setup_mo(ini: { Settings: { download_directory: '/path/to/downloads' } })
+        expect(mod_organizer.downloads_dir).to eq '/path/to/downloads'
+      end
+
+      it 'returns mod names from the mods directory specified in the ini file' do
+        mods_dir = "#{Dir.tmpdir}/ModOrganizerTest/AlternativeMods"
+        setup_mo(ini: { Settings: { mod_directory: mods_dir } })
+        FileUtils.mkdir_p("#{mods_dir}/TestMod1")
+        FileUtils.mkdir_p("#{mods_dir}/TestMod2")
+        expect(mod_organizer.mod_names.sort).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'retrieves the modlist from the profiles directory and the profile specified in the ini file' do
+        setup_mo(
+          ini: {
+            Settings: { profiles_directory: "#{Dir.tmpdir}/ModOrganizerTest/AlternativeProfiles" },
+            General: { selected_profile: 'TestProfile' }
+          }
+        )
+        FileUtils.mkdir_p("#{Dir.tmpdir}/ModOrganizerTest/AlternativeProfiles/TestProfile")
+        File.write(
+          "#{Dir.tmpdir}/ModOrganizerTest/AlternativeProfiles/TestProfile/modlist.txt",
+          <<~EO_MOD_LIST
+            -TestMod2
+            +TestMod1
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.mods_list).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'retrieves a download by its file name from the downloads directory specified in the ini file' do
+        downloads_dir = "#{Dir.tmpdir}/ModOrganizerTest/AlternativeDownloads"
+        setup_mo(ini: { Settings: { download_directory: downloads_dir } })
+        FileUtils.mkdir_p(downloads_dir)
+        downloaded_file = "#{downloads_dir}/TestMod.7z"
+        File.write(downloaded_file, 'TestMod downloaded content')
+        expect(mod_organizer.download(file_name: 'TestMod.7z').downloaded_file_path).to eq downloaded_file
+      end
+
+    end
+
+    context 'with the default ini file' do
+
+      before do
+        setup_mo
+      end
+
+      it 'returns the default downloads directory' do
+        expect(mod_organizer.downloads_dir).to eq "#{instance_dir}/downloads"
+      end
+
+      it 'runs ModOrganizer' do
+        mo_run_from = nil
+        expect(mod_organizer).to receive(:system).with('ModOrganizer.exe') do
+          mo_run_from = Dir.pwd
+        end
+        mod_organizer.run
+        expect(mo_run_from).to eq instance_dir
+      end
+
+      it 'returns mod names from the default mods directory' do
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod1")
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod2")
+        expect(mod_organizer.mod_names.sort).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'returns mod names without considering files' do
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod1")
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod2")
+        File.write("#{instance_dir}/mods/WrongMod", 'File content')
+        expect(mod_organizer.mod_names.sort).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'caches mod names returned' do
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod1")
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod2")
+        expect(mod_organizer.mod_names.sort).to eq %w[TestMod1 TestMod2]
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod3")
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod4")
+        expect(mod_organizer.mod_names.sort).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'retrieves a mod by its name' do
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod")
+        expect(mod_organizer.mod(name: 'TestMod').name).to eq 'TestMod'
+      end
+
+      it 'does not retrieve an unknown mod' do
+        expect(mod_organizer.mod(name: 'UnknownMod')).to be_nil
+      end
+
+      it 'caches mods being retrieved' do
+        FileUtils.mkdir_p("#{instance_dir}/mods/TestMod")
+        expect(mod_organizer.mod(name: 'TestMod').name).to eq 'TestMod'
+        FileUtils.rm_rf("#{instance_dir}/mods/TestMod")
+        expect(mod_organizer.mod(name: 'TestMod').name).to eq 'TestMod'
+      end
+
+      it 'retrieves the modlist of the default profile' do
+        FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+        File.write(
+          "#{instance_dir}/profiles/Default/modlist.txt",
+          <<~EO_MOD_LIST
+            # This file was automatically generated by Mod Organizer.
+            -TestMod2
+            +TestMod1
+            *Creation Club: ccBGSSSE001-Fish
+            *Creation Club: ccBGSSSE025-AdvDSGS
+            *Creation Club: ccBGSSSE037-Curios
+            *Creation Club: ccQDRSSE001-SurvivalMode
+            *DLC: Dawnguard
+            *DLC: Dragonborn
+            *DLC: HearthFires
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.mods_list).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'caches the modlist being retrieved' do
+        FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+        File.write(
+          "#{instance_dir}/profiles/Default/modlist.txt",
+          <<~EO_MOD_LIST
+            -TestMod2
+            +TestMod1
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.mods_list).to eq %w[TestMod1 TestMod2]
+        File.write(
+          "#{instance_dir}/profiles/Default/modlist.txt",
+          <<~EO_MOD_LIST
+            -TestMod4
+            +TestMod3
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.mods_list).to eq %w[TestMod1 TestMod2]
+      end
+
+      it 'returns the list of enabled mods' do
+        FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+        File.write(
+          "#{instance_dir}/profiles/Default/modlist.txt",
+          <<~EO_MOD_LIST
+            -TestMod4
+            +TestMod3
+            -TestMod2
+            +TestMod1
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.enabled_mods).to eq %w[TestMod1 TestMod3]
+      end
+
+      it 'caches the list of enabled mods' do
+        FileUtils.mkdir_p("#{instance_dir}/profiles/Default")
+        File.write(
+          "#{instance_dir}/profiles/Default/modlist.txt",
+          <<~EO_MOD_LIST
+            -TestMod2
+            +TestMod1
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.enabled_mods).to eq %w[TestMod1]
+        File.write(
+          "#{instance_dir}/profiles/Default/modlist.txt",
+          <<~EO_MOD_LIST
+            -TestMod4
+            +TestMod3
+          EO_MOD_LIST
+        )
+        expect(mod_organizer.enabled_mods).to eq %w[TestMod1]
+      end
+
+      it 'returns the default list of categories' do
+        expect(mod_organizer.categories.sort.to_a[0..4].to_h).to eq(
+          {
+            1 => 'Animations',
+            2 => 'Armour',
+            3 => 'Audio',
+            4 => 'Cities',
+            5 => 'Clothing'
+          }
+        )
+      end
+
+      it 'returns the list of categories specific to the ModOrganizer instance' do
+        File.write(
+          "#{instance_dir}/categories.dat",
+          <<~EO_CATEGORIES
+            1|TestAnimations|4,51|0
+            2|TestArmour|5,54|0
+          EO_CATEGORIES
+        )
+        expect(mod_organizer.categories).to eq(
+          {
+            1 => 'TestAnimations',
+            2 => 'TestArmour'
+          }
+        )
+      end
+
+      it 'caches categories returned' do
+        File.write(
+          "#{instance_dir}/categories.dat",
+          <<~EO_CATEGORIES
+            1|TestAnimations|4,51|0
+            2|TestArmour|5,54|0
+          EO_CATEGORIES
+        )
+        expect(mod_organizer.categories).to eq(
+          {
+            1 => 'TestAnimations',
+            2 => 'TestArmour'
+          }
+        )
+        File.write(
+          "#{instance_dir}/categories.dat",
+          <<~EO_CATEGORIES
+            1|TestOtherAnimations|4,51|0
+            2|TestOtherArmour|5,54|0
+            3|TestOtherCities|5,54|0
+          EO_CATEGORIES
+        )
+        expect(mod_organizer.categories).to eq(
+          {
+            1 => 'TestAnimations',
+            2 => 'TestArmour'
+          }
+        )
+      end
+
+      it 'retrieves a download by its file name' do
+        FileUtils.mkdir_p("#{instance_dir}/downloads")
+        downloaded_file = "#{instance_dir}/downloads/TestMod.7z"
+        File.write(downloaded_file, 'TestMod downloaded content')
+        expect(mod_organizer.download(file_name: 'TestMod.7z').downloaded_file_path).to eq downloaded_file
+      end
+
+      it 'does not retrieve a download for an unknown file' do
+        expect(mod_organizer.download(file_name: 'UnknownMod.7z')).to be_nil
+      end
+
+      it 'caches a download returned' do
+        FileUtils.mkdir_p("#{instance_dir}/downloads")
+        downloaded_file = "#{instance_dir}/downloads/TestMod.7z"
+        File.write(downloaded_file, 'TestMod downloaded content')
+        expect(mod_organizer.download(file_name: 'TestMod.7z').downloaded_file_path).to eq downloaded_file
+        File.unlink(downloaded_file)
+        expect(mod_organizer.download(file_name: 'TestMod.7z')).not_to be_nil
+      end
+
+    end
+
+  end
+
+  context 'with a portable installation' do
+
+    it_behaves_like 'a ModOrganizer instance' do
+      before do
+        @instance_name = nil
+      end
+    end
+
+  end
+
+  context 'with a shared installation' do
+
+    it_behaves_like 'a ModOrganizer instance' do
+      before do
+        @instance_name = 'TestInstance'
+      end
+    end
+
+  end
+
+end

data/spec/mod_organizer_test/scenarios/rubocop_spec.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+describe 'Coding guidelines' do
+
+  it 'makes sure code style follow Rubocop guides' do
+    rubocop_report = JSON.parse(`bundle exec rubocop --format json`)
+    expect(rubocop_report['summary']['offense_count']).to(
+      eq(0),
+      proc do
+        # Format a great error message to help
+        wrong_files = rubocop_report['files'].reject { |file_info| file_info['offenses'].empty? }
+        <<~EO_ERROR
+          #{wrong_files.size} files have Rubocop issues:
+          #{
+            wrong_files.map do |file_info|
+              offenses = file_info['offenses'].map { |offense_info| "L#{offense_info['location']['start_line']}: #{offense_info['cop_name']} - #{offense_info['message']}" }
+              "* #{file_info['path']}:#{
+                if offenses.size == 1
+                  " #{offenses.first}"
+                else
+                  " #{offenses.size} offenses:\n#{offenses.map { |offense| "  - #{offense}" }.join("\n")}"
+                end
+              }"
+            end.join("\n")
+          }
+        EO_ERROR
+      end
+    )
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+require 'mod_organizer_test/helpers'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  # config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = "doc"
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: mod_organizer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: memoist3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: sem_ver_components
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+description: 
+email:
+- muriel@x-aeon.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/default_categories.dat
+- lib/mod_organizer.rb
+- lib/mod_organizer/download.rb
+- lib/mod_organizer/mod.rb
+- lib/mod_organizer/source.rb
+- lib/mod_organizer/utils.rb
+- lib/mod_organizer/version.rb
+- spec/mod_organizer_test/helpers.rb
+- spec/mod_organizer_test/scenarios/mod_organizer/download_spec.rb
+- spec/mod_organizer_test/scenarios/mod_organizer/mod_spec.rb
+- spec/mod_organizer_test/scenarios/mod_organizer/source_spec.rb
+- spec/mod_organizer_test/scenarios/mod_organizer_spec.rb
+- spec/mod_organizer_test/scenarios/rubocop_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Muriel-Salvan/mod_organizer
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/Muriel-Salvan/mod_organizer
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Ruby API accessing a Mod Organizer instance
+test_files: []