Skip to content

Commit

Permalink
Rename indexables to indexable_uris
Browse files Browse the repository at this point in the history
  • Loading branch information
vinistock committed Nov 27, 2024
1 parent f386d41 commit eaecbec
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion exe/ruby-lsp
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ if options[:doctor]

puts "Globbing for indexable files"

index.configuration.indexables.each do |uri|
index.configuration.indexable_uris.each do |uri|
puts "indexing: #{uri.full_path}"
index.index_single(uri)
end
Expand Down
6 changes: 3 additions & 3 deletions exe/ruby-lsp-check
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ puts "\n"
puts "Verifying that indexing executes successfully. This may take a while..."

index = RubyIndexer::Index.new
indexables = index.configuration.indexables
uris = index.configuration.indexable_uris

indexables.each_with_index do |uri, i|
uris.each_with_index do |uri, i|
index.index_single(uri)
rescue => e
errors[uri.full_path] = e
ensure
print("\033[M\033[0KIndexed #{i + 1}/#{indexables.length}") unless ENV["CI"]
print("\033[M\033[0KIndexed #{i + 1}/#{uris.length}") unless ENV["CI"]
end
puts "\n"

Expand Down
2 changes: 1 addition & 1 deletion lib/ruby_indexer/lib/ruby_indexer/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def merged_excluded_file_pattern
end

sig { returns(T::Array[URI::Generic]) }
def indexables
def indexable_uris
excluded_gems = @excluded_gems - @included_gems
locked_gems = Bundler.locked_gems&.specs

Expand Down
2 changes: 1 addition & 1 deletion lib/ruby_indexer/lib/ruby_indexer/index.rb
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ def resolve(name, nesting, seen_names = [])
block: T.nilable(T.proc.params(progress: Integer).returns(T::Boolean)),
).void
end
def index_all(uris: @configuration.indexables, &block)
def index_all(uris: @configuration.indexable_uris, &block)
# When troubleshooting an indexing issue, e.g. through irb, it's not obvious that `index_all` will augment the
# existing index values, meaning it may contain 'stale' entries. This check ensures that the user is aware of this
# behavior and can take appropriate action.
Expand Down
22 changes: 11 additions & 11 deletions lib/ruby_indexer/test/configuration_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def setup

def test_load_configuration_executes_configure_block
@config.apply_config({ "excluded_patterns" => ["**/fixtures/**/*.rb"] })
uris = @config.indexables
uris = @config.indexable_uris

assert(uris.none? { |uri| uri.full_path.include?("test/fixtures") })
assert(uris.none? { |uri| uri.full_path.include?("minitest-reporters") })
Expand All @@ -24,14 +24,14 @@ def test_load_configuration_executes_configure_block

def test_indexables_have_expanded_full_paths
@config.apply_config({ "included_patterns" => ["**/*.rb"] })
uris = @config.indexables
uris = @config.indexable_uris

# All paths should be expanded
assert(uris.all? { |uri| File.absolute_path?(uri.full_path) })
end

def test_indexables_only_includes_gem_require_paths
uris = @config.indexables
uris = @config.indexable_uris

Bundler.locked_gems.specs.each do |lazy_spec|
next if lazy_spec.name == "ruby-lsp"
Expand All @@ -44,20 +44,20 @@ def test_indexables_only_includes_gem_require_paths
end

def test_indexables_does_not_include_default_gem_path_when_in_bundle
uris = @config.indexables
uris = @config.indexable_uris
assert(uris.none? { |uri| uri.full_path.start_with?("#{RbConfig::CONFIG["rubylibdir"]}/psych") })
end

def test_indexables_includes_default_gems
paths = @config.indexables.map(&:full_path)
paths = @config.indexable_uris.map(&:full_path)

assert_includes(paths, "#{RbConfig::CONFIG["rubylibdir"]}/pathname.rb")
assert_includes(paths, "#{RbConfig::CONFIG["rubylibdir"]}/ipaddr.rb")
assert_includes(paths, "#{RbConfig::CONFIG["rubylibdir"]}/erb.rb")
end

def test_indexables_includes_project_files
paths = @config.indexables.map(&:full_path)
paths = @config.indexable_uris.map(&:full_path)

Dir.glob("#{Dir.pwd}/lib/**/*.rb").each do |path|
next if path.end_with?("_test.rb")
Expand All @@ -75,7 +75,7 @@ def test_indexables_avoids_duplicates_if_bundle_path_is_inside_project
end

def test_indexables_does_not_include_gems_own_installed_files
uris = @config.indexables
uris = @config.indexable_uris
indexables_inside_bundled_lsp = uris.select do |uri|
uri.full_path.start_with?(Bundler.bundle_path.join("gems", "ruby-lsp").to_s)
end
Expand All @@ -91,14 +91,14 @@ def test_indexables_does_not_include_non_ruby_files_inside_rubylibdir
path = Pathname.new(RbConfig::CONFIG["rubylibdir"]).join("extra_file.txt").to_s
FileUtils.touch(path)

uris = @config.indexables
uris = @config.indexable_uris
assert(uris.none? { |uri| uri.full_path == path })
ensure
FileUtils.rm(T.must(path))
end

def test_paths_are_unique
uris = @config.indexables
uris = @config.indexable_uris
assert_equal(uris.uniq.length, uris.length)
end

Expand Down Expand Up @@ -138,7 +138,7 @@ def test_indexables_respect_given_workspace_path
@config.apply_config({ "excluded_patterns" => ["ignore/**/*.rb"] })
@config.workspace_path = dir

uris = @config.indexables
uris = @config.indexable_uris
assert(uris.none? { |uri| uri.full_path.start_with?(File.join(dir, "ignore")) })

# After switching the workspace path, all indexables will be found in one of these places:
Expand All @@ -162,7 +162,7 @@ def test_includes_top_level_files
FileUtils.touch(File.join(dir, "find_me.rb"))
@config.workspace_path = dir

uris = @config.indexables
uris = @config.indexable_uris
assert(uris.find { |u| File.basename(u.full_path) == "find_me.rb" })
end
end
Expand Down

0 comments on commit eaecbec

Please sign in to comment.