Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include non-development gemspec dependencies in DependencyDetector check #1031

Merged
merged 10 commits into from
Oct 4, 2023
Merged

Include non-development gemspec dependencies in DependencyDetector check #1031

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a94279b
Include gemspec in dependency check
andyw8 Oct 2, 2023
5349617
Ufuk feedback
andyw8 Oct 3, 2023
8090987
Pass regexp to any
andyw8 Oct 3, 2023
8e6bf39
Update lib/ruby_lsp/requests/support/dependency_detector.rb
andyw8 Oct 3, 2023
6250b49
Update lib/ruby_lsp/requests/support/dependency_detector.rb
andyw8 Oct 3, 2023
8af680d
Ensure multiple gemspecs are handled
andyw8 Oct 3, 2023
fa9cc96
Grep by class name
andyw8 Oct 4, 2023
03b19db
Merge branch 'main' into andyw8/include-gemspec-in-dependency-check
andyw8 Oct 4, 2023
90904da
Prevent state leak
andyw8 Oct 4, 2023
216877e
Use teardown instead
andyw8 Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/ruby_lsp/requests/support/dependency_detector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def detect_test_library

sig { params(gem_pattern: Regexp).returns(T::Boolean) }
def direct_dependency?(gem_pattern)
dependency_keys.grep(gem_pattern).any?
dependencies.grep(gem_pattern).any?
end

sig { returns(T::Boolean) }
Expand All @@ -65,16 +65,24 @@ def detect_typechecker
end

sig { returns(T::Array[String]) }
def dependency_keys
@dependency_keys ||= T.let(
def dependencies
# NOTE: If changing this behaviour, it's likely that the extension will also need changed.
andyw8 marked this conversation as resolved.
Show resolved Hide resolved
@dependencies ||= T.let(
begin
Bundler.with_original_env { Bundler.default_gemfile }
Bundler.locked_gems.dependencies.keys
Bundler.locked_gems.dependencies.keys + gemspec_dependencies
rescue Bundler::GemfileNotFound
[]
end,
T.nilable(T::Array[String]),
)
end

sig { returns(T::Array[String]) }
def gemspec_dependencies
Dir.glob("{,*}.gemspec").flat_map do |path|
Bundler.load_gemspec(path).dependencies.map(&:name)
end
Copy link
Member

@paracycle paracycle Oct 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The gemspec should have already been loaded by the gemfile, so I don't think finding it and loading it is the best way to do this.

I would instead recommend something like:

Bundler.locked_gems.sources.find { Bundler::Source::Gemspec === _1 }&.gemspec&.dependencies

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that seems cleaner. @vinistock, should we update the load_dependencies method to do the same?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for illustration, with

  spec.add_dependency("minitest", "~> 5.0")
  spec.add_dependency("minitest-reporters")

we get:

irb(main):005:0> Bundler.locked_gems.dependencies.keys
=> ["bundler", "debug", "rake", "rubocop-shopify", "rubocop-sorbet", "spoom", "tapioca"]
irb(main):006:0> Bundler.load_gemspec(gemspec_path).dependencies.map(&:name)
=> ["bundler", "minitest", "minitest-reporters", "rake", "erubi", "sorbet-static-and-runtime", "syntax_tree", "thor"]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make sure it is really equivalent and that we get the same results. In case we do, are you talking about load_dependencies in SetupBundler?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah SetupBundler#load_dependencies. But on second thoughts, let's keep this PR focused on the DependencyDetector.

end
end
end
4 changes: 4 additions & 0 deletions test/requests/support/dependency_detector_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ def test_detects_test_unit
assert_equal("test-unit", DependencyDetector.instance.detected_test_library)
end

def test_detects_dependencies_in_gemspecs
assert(DependencyDetector.instance.direct_dependency?(/^yarp$/))
end

def test_detects_rails_if_both_rails_and_minitest_are_present
stub_dependencies("minitest" => "1.2.3", "rails" => "1.2.3")

Expand Down