[GH-6357] Add missing Rubyzen APIs when parsing tests

[Stelios Frantzeskakis (steliosfran)]

New Rubyzen APIs to improve writing lint rules for our tests:

• Added missing call_sites in FileDeclaration
• Added blocks in FileDeclaration
• Added CallSiteProvider in BlockDeclaration
• Added BlocksCollection
• Added keyword_arg_value_pairs in CallSiteDeclaration

Example lint rule we had before, parsing nodes manually:

let(:all_call_sites) do
  test_files.without_paths(*baseline).flat_map do |file|
    file.ast.each_node(:send).map do |node|
      Rubyzen::Declarations::CallSiteDeclaration.new(node, file)
    end
  end
end

let(:profile_factory_call_sites) do
  all_call_sites.filter do |cs|
    cs.method_name.to_s == "create" &&
      cs.source_code.include?(':profile')
  end
end

let(:violations) do
  profile_factory_call_sites.filter do |cs|
    (cs.source_code.match?(/\blatitude:\s*['"]?[-+]?\d+(\.\d+)?['"]?/) ||
     cs.source_code.match?(/\blatitude:\s*-\d+(\.\d+)?/)) &&
      (cs.source_code.match?(/\blongitude:\s*['"]?[-+]?\d+(\.\d+)?['"]?/) ||
       cs.source_code.match?(/\blongitude:\s*-\d+(\.\d+)?/))
  end
end

it 'uses location traits instead of hardcoded coordinates' do
  expect(violations).to be_empty
end

This can be now written as:

let(:profile_factory_calls) do
  test_files.without_paths(*baseline)
    .call_sites
    .with_name('create')
    .with_symbol(:profile)
end

it 'uses location traits instead of hardcoded coordinates' do
  expect(profile_factory_calls).to be_false { |cs|
    cs.keyword_arg_value_pairs[:latitude].is_a?(Numeric) &&
      cs.keyword_arg_value_pairs[:longitude].is_a?(Numeric)
  }
end

In addition, we can now parse directly any block of code in our tests:

test_files.blocks.with_method_name('describe') # All describe blocks
test_files.blocks.with_method_name('context') # All context blocks
test_files.blocks.with_method_name('let') # All let blocks

[Bastian (bkoell)]

Approved with comments.

[Bastian (bkoell)]

Is this a breaking semantic change? Do we need to update any HR linters?

[Stelios Frantzeskakis (steliosfran)]

Good point, it could be if any lint rule was using it, but I just ran them all and they all pass.

Basically the parent.name here was wrong.

[Bastian (bkoell)]

Was this intentional to also make symbols and strings methods public?

[Stelios Frantzeskakis (steliosfran)]

Bastian (@bkoell) yes they were added to expand the API so you can now use them directly in the lint rules. They are also used in the Collections.