Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Handle more 'nil' scenarios parsing YARD types #187

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

Merged
AaronC81 merged 1 commit into from
Jul 6, 2025
Merged

Handle more 'nil' scenarios parsing YARD types #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions lib/sord/type_converter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ def self.yard_to_parlour(yard, item, config)
case yard
when nil # Type not specified
Parlour::Types::Untyped.new
when "nil"
Parlour::Types::Raw.new('NilClass')
when "bool", "Bool", "boolean", "Boolean", "true", "false"
Parlour::Types::Boolean.new
when 'self'
Expand Down Expand Up @@ -195,10 +197,11 @@ def self.yard_to_parlour(yard, item, config)
relative_generic_type = generic_type.start_with?('::') \
? generic_type[2..-1] : generic_type

parameters = split_type_parameters(type_parameters)
yard_parameters = split_type_parameters(type_parameters)
parameters = yard_parameters
.map { |x| yard_to_parlour(x, item, config) }
if SINGLE_ARG_GENERIC_TYPES.include?(relative_generic_type) && parameters.length > 1
Parlour::Types.const_get(relative_generic_type).new(Parlour::Types::Union.new(parameters))
if SINGLE_ARG_GENERIC_TYPES.include?(relative_generic_type) && yard_parameters.length > 1
Parlour::Types.const_get(relative_generic_type).new(yard_to_parlour(yard_parameters, item, config))
elsif relative_generic_type == 'Class'
if parameters.length == 1
Parlour::Types::Class.new(parameters.first)
Expand Down
9 changes: 8 additions & 1 deletion spec/type_converter_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ def yard_to_parlour_default(type)

context 'with literals' do
it 'converts literals to their types' do
expect(yard_to_parlour_default('nil')).to eq Types::Raw.new('NilClass')
expect(yard_to_parlour_default([':up', ':down'])).to eq Types::Raw.new('Symbol')
expect(yard_to_parlour_default(['String', ':up', ':down'])).to eq \
Types::Union.new(['String', 'Symbol'])
Expand Down Expand Up @@ -132,6 +133,11 @@ def self.path
Types::Array.new(Types::Union.new(['String', 'Integer']))
end

it 'handles nil is one of multiple arguments in a one-argument type parameter' do
expect(yard_to_parlour_default('Array<String, nil>')).to eq \
Types::Array.new(Types::Nilable.new('String'))
end

it 'handles whitespace' do
expect(yard_to_parlour_default('Array < String >')).to eq Types::Array.new('String')
end
Expand All @@ -148,6 +154,7 @@ def self.path
it 'handles correctly-formed two-argument type parameters with hash rockets' do
expect(yard_to_parlour_default('Hash<String=>Symbol>')).to eq Types::Hash.new('String', 'Symbol')
expect(yard_to_parlour_default('Hash{String=>Symbol}')).to eq Types::Hash.new('String', 'Symbol')
expect(yard_to_parlour_default('Hash{String=>String}')).to eq Types::Hash.new('String', 'String')
expect(yard_to_parlour_default('Hash{String => Symbol}')).to eq Types::Hash.new('String', 'Symbol')
expect(yard_to_parlour_default('Hash{String, Integer => Symbol, Float}')).to eq \
Types::Hash.new(
Expand Down Expand Up @@ -339,7 +346,7 @@ def self.path
Sord::TypeConverter::Configuration.new(
output_language: :rbs,
replace_errors_with_untyped: false,
replace_unresolved_with_untyped: false,
replace_unresolved_with_untyped: false,
)
end

Expand Down