Add tests and address #31

[davidteren]

PR Type

Tests, Enhancement

---

Description

• Added a comprehensive test suite using RSpec for the FileHelpers and LpxLinks classes.
• Configured SimpleCov to track test coverage.
• Updated the Gemfile to include rspec and simplecov gems.
• Set up RSpec configuration and command-line options for improved test output.

---

Changes walkthrough 📝

	Relevant files
Tests	file_helpers_spec.rb Add RSpec tests for FileHelpers methods                                    spec/lib/file_helpers_spec.rb Added RSpec tests for FileHelpers methods. Tested plist_file_path, app_path, and links_dir methods. Included scenarios for different application installations. +59/-0    lpx_links_spec.rb Add RSpec tests for LpxLinks class                                              spec/lpx_links_spec.rb Added RSpec tests for LpxLinks class. Tested download_links and read_packages methods. Included tests for mandatory and non-mandatory packages. +45/-0
Configuration changes	spec_helper.rb Configure RSpec and SimpleCov for testing                                spec/spec_helper.rb Configured SimpleCov for test coverage. Set up RSpec configuration options. Included necessary requires for testing. +28/-0    .rspec Add RSpec command-line options                                                      .rspec Added RSpec command-line options. Enabled documentation format and color output. +3/-0
Dependencies	Gemfile Add RSpec and SimpleCov to Gemfile                                              Gemfile Added rspec and simplecov gems. Specified version constraints for gems. +4/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Test Coverage Ensure that all edge cases and error scenarios for FileHelpers methods are covered, particularly for different application installations and file paths. Error Handling Verify that error scenarios, such as missing or malformed JSON files, are properly tested in the LpxLinks class. Configuration Review the RSpec and SimpleCov configuration to ensure it meets the project's needs and follows best practices.

[qodo-merge-pro]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Enhancement	✅ Configure SimpleCov to exclude irrelevant files from coverage reports for more accurate results Consider adding SimpleCov configuration to exclude certain files or directories from coverage reports, such as test files or external libraries, to focus on the coverage of your application code. spec/spec_helper.rb [1-2] require 'simplecov' -SimpleCov.start +SimpleCov.start do + add_filter '/spec/' + add_filter '/vendor/' +end [Suggestion has been applied] Suggestion importance[1-10]: 8 Why: Excluding test files and external libraries from SimpleCov reports focuses coverage on application code, providing more meaningful insights into code coverage. This enhances the utility of coverage reports.	8
	Refactor repetitive test contexts using shared examples to improve maintainability and extensibility Consider using a shared example or context for testing different application installations in the '.app_path' describe block. This would reduce code duplication and make it easier to add tests for new applications in the future. spec/lib/file_helpers_spec.rb [21-40] -context 'when Logic Pro X is installed' do - before do - allow(File).to receive(:exist?).with('/Applications/Logic Pro X.app/Contents/Resources').and_return(true) - end +shared_examples 'app installation' do |app_name, path| + context "when #{app_name} is installed" do + before do + allow(File).to receive(:exist?).with(path).and_return(true) + end - it 'returns the correct path' do - expect(FileHelpers.app_path('LOGIC')).to eq('/Applications/Logic Pro X.app/Contents/Resources') + it 'returns the correct path' do + expect(FileHelpers.app_path('LOGIC')).to eq(path) + end end end -context 'when Logic Pro is installed' do - before do - allow(File).to receive(:exist?).with('/Applications/Logic Pro X.app/Contents/Resources').and_return(false) - allow(File).to receive(:exist?).with('/Applications/Logic Pro.app/Contents/Resources').and_return(true) - end +include_examples 'app installation', 'Logic Pro X', '/Applications/Logic Pro X.app/Contents/Resources' +include_examples 'app installation', 'Logic Pro', '/Applications/Logic Pro.app/Contents/Resources' - it 'returns the correct path' do - expect(FileHelpers.app_path('LOGIC')).to eq('/Applications/Logic Pro.app/Contents/Resources') - end -end - Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion to use shared examples reduces code duplication and enhances maintainability, making it easier to add tests for new applications in the future. It is a good practice for improving test structure and readability.	7
Best practice	Use RSpec's let helper to define and reuse the result of LpxLinks.read_packages across multiple tests Consider using let to define the LpxLinks.read_packages result, which can be reused across multiple tests, reducing duplication and improving test readability. spec/lpx_links_spec.rb [24-44] +let(:read_packages) { LpxLinks.read_packages } + describe '.download_links' do it 'returns all download links when mandatory flag is false' do links = LpxLinks.download_links(false) expect(links.length).to eq(2) expect(links).to include("http://example.com/content/mandatory_package.pkg\n") expect(links).to include("http://example.com/content/optional_package.pkg\n") end it 'returns only mandatory download links when mandatory flag is true' do links = LpxLinks.download_links(true) expect(links.length).to eq(1) expect(links).to include("http://example.com/content/mandatory_package.pkg\n") end end describe '.read_packages' do it 'correctly parses the JSON file' do - packages = LpxLinks.read_packages - expect(packages).to eq(sample_packages["Packages"]) + expect(read_packages).to eq(sample_packages["Packages"]) end end Apply this suggestion Suggestion importance[1-10]: 6 Why: Utilizing let to define LpxLinks.read_packages improves test readability and reduces duplication. This is a best practice in RSpec to keep tests DRY and maintainable.	6

💡 Need additional feedback ? start a PR chat