Skip to content

Do not instantiate Public visibility for implicit public defs and attrs #658

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

Open
Morriar wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Do not instantiate Public visibility for implicit public defs and attrs #658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a59f797
Do not instantiate `Public` visibility for implicit public defs and a…
Morriar Aug 28, 2026
5ace0f8
Update exported RBI
Morriar Aug 28, 2026
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
2 changes: 1 addition & 1 deletion bench/allocation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def build_tree(num_methods: 200)
klass << RBI::Extend.new("RelMethods")
num_methods.times do |i|
vis = case i % 10
when 0..6 then RBI::Public::DEFAULT
when 0..6 then RBI::Public.new
when 7..8 then RBI::Private.new
else RBI::Protected.new
end #: RBI::Visibility
Expand Down
2 changes: 1 addition & 1 deletion bench/benchmark.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def build_large_tree(num_methods: 200, num_attrs: 20, num_includes: 5, num_scope
# Add methods (mix of public, private, singleton)
num_methods.times do |i|
visibility = case i % 10
when 0..6 then RBI::Public::DEFAULT
when 0..6 then RBI::Public.new
when 7..8 then RBI::Private.new
else RBI::Protected.new
end #: RBI::Visibility
Expand Down
31 changes: 14 additions & 17 deletions lib/rbi/model.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,8 +326,8 @@ class Attr < NodeWithComments
#: Array[Symbol]
attr_reader :names

#: Visibility
attr_accessor :visibility
#: Visibility?
attr_accessor :visibility # `nil` for implicit `public` visibility

#: -> Array[Sig]
def sigs
Expand All @@ -345,12 +345,12 @@ def sigs?
#: (
#| Symbol name,
#| Array[Symbol] names,
#| ?visibility: Visibility,
#| ?visibility: Visibility?,
#| ?sigs: Array[Sig]?,
#| ?loc: Loc?,
#| ?comments: Array[Comment]?
#| ) -> void
def initialize(name, names, visibility: Public::DEFAULT, sigs: nil, loc: nil, comments: nil)
def initialize(name, names, visibility: nil, sigs: nil, loc: nil, comments: nil)
super(loc: loc, comments: comments)
@names = [name, *names] #: Array[Symbol]
@visibility = visibility
Expand All @@ -366,12 +366,12 @@ class AttrAccessor < Attr
#: (
#| Symbol name,
#| *Symbol names,
#| ?visibility: Visibility,
#| ?visibility: Visibility?,
#| ?sigs: Array[Sig]?,
#| ?loc: Loc?,
#| ?comments: Array[Comment]?
#| ) ?{ (AttrAccessor node) -> void } -> void
def initialize(name, *names, visibility: Public::DEFAULT, sigs: nil, loc: nil, comments: nil, &block)
def initialize(name, *names, visibility: nil, sigs: nil, loc: nil, comments: nil, &block)
super(name, names, loc: loc, visibility: visibility, sigs: sigs, comments: comments)
block&.call(self)
end
Expand All @@ -395,12 +395,12 @@ class AttrReader < Attr
#: (
#| Symbol name,
#| *Symbol names,
#| ?visibility: Visibility,
#| ?visibility: Visibility?,
#| ?sigs: Array[Sig]?,
#| ?loc: Loc?,
#| ?comments: Array[Comment]?
#| ) ?{ (AttrReader node) -> void } -> void
def initialize(name, *names, visibility: Public::DEFAULT, sigs: nil, loc: nil, comments: nil, &block)
def initialize(name, *names, visibility: nil, sigs: nil, loc: nil, comments: nil, &block)
super(name, names, loc: loc, visibility: visibility, sigs: sigs, comments: comments)
block&.call(self)
end
Expand All @@ -424,12 +424,12 @@ class AttrWriter < Attr
#: (
#| Symbol name,
#| *Symbol names,
#| ?visibility: Visibility,
#| ?visibility: Visibility?,
#| ?sigs: Array[Sig]?,
#| ?loc: Loc?,
#| ?comments: Array[Comment]?
#| ) ?{ (AttrWriter node) -> void } -> void
def initialize(name, *names, visibility: Public::DEFAULT, sigs: nil, loc: nil, comments: nil, &block)
def initialize(name, *names, visibility: nil, sigs: nil, loc: nil, comments: nil, &block)
super(name, names, loc: loc, visibility: visibility, sigs: sigs, comments: comments)
block&.call(self)
end
Expand Down Expand Up @@ -463,8 +463,8 @@ def params
#: bool
attr_accessor :is_singleton

#: Visibility
attr_accessor :visibility
#: Visibility?
attr_accessor :visibility # `nil` for implicit `public` visibility

#: -> Array[Sig]
def sigs
Expand All @@ -483,7 +483,7 @@ def sigs?
#| String name,
#| ?params: Array[Param]?,
#| ?is_singleton: bool,
#| ?visibility: Visibility,
#| ?visibility: Visibility?,
#| ?sigs: Array[Sig]?,
#| ?loc: Loc?,
#| ?comments: Array[Comment]?
Expand All @@ -492,7 +492,7 @@ def initialize(
name,
params: nil,
is_singleton: false,
visibility: Public::DEFAULT,
visibility: nil,
sigs: nil,
loc: nil,
comments: nil,
Expand Down Expand Up @@ -991,9 +991,6 @@ def initialize(loc: nil, comments: nil, &block)
super(:public, loc: loc, comments: comments)
block&.call(self)
end

# Shared default instance to avoid allocating a new Public on every Method/Attr creation.
DEFAULT = new.freeze #: Public

@vinistock vinistock Sep 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If the implicit one is now represented by nil, could we make loc required for the visibility instances?

end

class Protected < Visibility
Expand Down
11 changes: 7 additions & 4 deletions lib/rbi/printer.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,10 @@ def visit_attr(node)

print_loc(node)
printt
unless in_visibility_group || node.visibility.public?
print(node.visibility.visibility.name)

visibility = node.visibility
unless in_visibility_group || visibility.nil? || visibility.public?
print(visibility.visibility.name)
print(" ")
end
case node
Expand Down Expand Up @@ -319,8 +321,9 @@ def visit_method(node)

print_loc(node)
printt
unless in_visibility_group || node.visibility.public?
print(node.visibility.visibility.name)
visibility = node.visibility
unless in_visibility_group || visibility.nil? || visibility.public?
print(visibility.visibility.name)
print(" ")
end
print("def ")
Expand Down
10 changes: 6 additions & 4 deletions lib/rbi/rbs_printer.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,8 +283,9 @@ def visit_attr(node)
visit_all(node.comments)
print_loc(node)
printt
unless in_visibility_group || node.visibility.public? || node.visibility.protected?
print(node.visibility.visibility.name)
visibility = node.visibility
unless in_visibility_group || visibility.nil? || visibility.public? || visibility.protected?
print(visibility.visibility.name)
print(" ")
end
case node
Expand Down Expand Up @@ -363,8 +364,9 @@ def visit_method(node)

print_loc(node)
printt
unless in_visibility_group || node.visibility.public?
print(node.visibility.visibility.name)
visibility = node.visibility
unless in_visibility_group || visibility.nil? || visibility.public?
print(visibility.visibility.name)
print(" ")
end
print("def ")
Expand Down
4 changes: 2 additions & 2 deletions lib/rbi/rewriters/attr_to_methods.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def parse_sig
[sig, attribute_type]
end

#: (String name, Sig? sig, Visibility visibility, Loc? loc, Array[Comment] comments) -> Method
#: (String name, Sig? sig, Visibility? visibility, Loc? loc, Array[Comment] comments) -> Method
def create_getter_method(name, sig, visibility, loc, comments)
Method.new(
name,
Expand All @@ -92,7 +92,7 @@ def create_getter_method(name, sig, visibility, loc, comments)
#| String name,
#| Sig? sig,
#| (Type | String)? attribute_type,
#| Visibility visibility,
#| Visibility? visibility,
#| Loc? loc,
#| Array[Comment] comments
#| ) -> Method
Expand Down
19 changes: 9 additions & 10 deletions rbi/rbi.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class RBI::Attr < ::RBI::NodeWithComments
params(
name: ::Symbol,
names: T::Array[::Symbol],
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
sigs: T.nilable(T::Array[::RBI::Sig]),
loc: T.nilable(::RBI::Loc),
comments: T.nilable(T::Array[::RBI::Comment])
Expand Down Expand Up @@ -64,7 +64,7 @@ class RBI::Attr < ::RBI::NodeWithComments
sig { returns(T::Boolean) }
def sigs?; end

sig { returns(::RBI::Visibility) }
sig { returns(T.nilable(::RBI::Visibility)) }
def visibility; end

def visibility=(_arg0); end
Expand All @@ -75,7 +75,7 @@ class RBI::Attr < ::RBI::NodeWithComments
params(
name: ::String,
sig: T.nilable(::RBI::Sig),
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).returns(::RBI::Method)
Expand All @@ -87,7 +87,7 @@ class RBI::Attr < ::RBI::NodeWithComments
name: ::String,
sig: T.nilable(::RBI::Sig),
attribute_type: T.nilable(T.any(::RBI::Type, ::String)),
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
loc: T.nilable(::RBI::Loc),
comments: T::Array[::RBI::Comment]
).returns(::RBI::Method)
Expand All @@ -103,7 +103,7 @@ class RBI::AttrAccessor < ::RBI::Attr
params(
name: ::Symbol,
names: ::Symbol,
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
sigs: T.nilable(T::Array[::RBI::Sig]),
loc: T.nilable(::RBI::Loc),
comments: T.nilable(T::Array[::RBI::Comment]),
Expand All @@ -130,7 +130,7 @@ class RBI::AttrReader < ::RBI::Attr
params(
name: ::Symbol,
names: ::Symbol,
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
sigs: T.nilable(T::Array[::RBI::Sig]),
loc: T.nilable(::RBI::Loc),
comments: T.nilable(T::Array[::RBI::Comment]),
Expand All @@ -157,7 +157,7 @@ class RBI::AttrWriter < ::RBI::Attr
params(
name: ::Symbol,
names: ::Symbol,
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
sigs: T.nilable(T::Array[::RBI::Sig]),
loc: T.nilable(::RBI::Loc),
comments: T.nilable(T::Array[::RBI::Comment]),
Expand Down Expand Up @@ -697,7 +697,7 @@ class RBI::Method < ::RBI::NodeWithComments
name: ::String,
params: T.nilable(T::Array[::RBI::Param]),
is_singleton: T::Boolean,
visibility: ::RBI::Visibility,
visibility: T.nilable(::RBI::Visibility),
sigs: T.nilable(T::Array[::RBI::Sig]),
loc: T.nilable(::RBI::Loc),
comments: T.nilable(T::Array[::RBI::Comment]),
Expand Down Expand Up @@ -787,7 +787,7 @@ class RBI::Method < ::RBI::NodeWithComments
sig { override.returns(::String) }
def to_s; end

sig { returns(::RBI::Visibility) }
sig { returns(T.nilable(::RBI::Visibility)) }
def visibility; end

def visibility=(_arg0); end
Expand Down Expand Up @@ -1507,7 +1507,6 @@ class RBI::Public < ::RBI::Visibility
def initialize(loc: T.unsafe(nil), comments: T.unsafe(nil), &block); end
end

RBI::Public::DEFAULT = T.let(T.unsafe(nil), RBI::Public)
module RBI::RBS; end

class RBI::RBS::MethodTypeTranslator
Expand Down
Loading