Skip to content

Preserve visibility when sorting members #3129

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
OskarEichler wants to merge 3 commits into
base: master
Choose a base branch
from
+27 −27
Open

Preserve visibility when sorting members #3129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0da841
Preserve visibility when sorting members
OskarEichler Aug 29, 2026
0dea864
Type sorter visibility partitions
OskarEichler Aug 29, 2026
864b5ad
Cover sorted visibility preservation
OskarEichler Aug 30, 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
36 changes: 17 additions & 19 deletions lib/rbs/sorter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ def sort_decl(decl)
class_instance_variables: [],
instance_variables: [],
singleton_attributes: [],
instance_attributes: [],
public_instance_attributes: [],
private_instance_attributes: [],
module_functions: [],
singleton_new_methods: [],
public_singleton_methods: [],
Expand All @@ -64,7 +65,8 @@ def sort_decl(decl)
when Members::Private
:private
when Members::MethodDefinition, Members::AttrReader, Members::AttrWriter, Members::AttrAccessor
visibility_annotated_members << member.update(visibility: member.visibility || current_visibility)
visibility = member.kind == :instance ? member.visibility || current_visibility : member.visibility
visibility_annotated_members << member.update(visibility: visibility)
current_visibility
else
visibility_annotated_members << member
Expand Down Expand Up @@ -94,21 +96,23 @@ def sort_decl(decl)
partitioned[:instance_variables] << member
when Members::AttrAccessor, Members::AttrWriter, Members::AttrReader
if member.kind == :singleton
partitioned[:singleton_attributes] << member.update(visibility: nil)
partitioned[:singleton_attributes] << member
elsif member.visibility == :private
partitioned[:private_instance_attributes] << member.update(visibility: nil)
else
partitioned[:instance_attributes] << member.update(visibility: nil)
partitioned[:public_instance_attributes] << member.update(visibility: nil)
end
when Members::MethodDefinition
case member.kind
when :singleton_instance
partitioned[:module_functions] << member.update(visibility: nil)
when :singleton
if member.name == :new
partitioned[:singleton_new_methods] << member.update(visibility: nil)
elsif member.visibility == :public
partitioned[:public_singleton_methods] << member.update(visibility: nil)
partitioned[:singleton_new_methods] << member
elsif member.visibility == :private
partitioned[:private_singleton_methods] << member
else
partitioned[:private_singleton_methods] << member.update(visibility: nil)
partitioned[:public_singleton_methods] << member
end
else
if member.name == :initialize
Expand Down Expand Up @@ -142,7 +146,8 @@ def sort_decl(decl)
partitioned[:class_instance_variables].sort_by! {|decl| decl.name.to_s }
partitioned[:instance_variables].sort_by! {|decl| decl.name.to_s }
partitioned[:singleton_attributes].sort_by! {|decl| decl.name.to_s }
partitioned[:instance_attributes].sort_by! {|decl| decl.name.to_s }
partitioned[:public_instance_attributes].sort_by! {|decl| decl.name.to_s }
partitioned[:private_instance_attributes].sort_by! {|decl| decl.name.to_s }
partitioned[:module_functions].sort_by! {|decl| decl.name.to_s }
partitioned[:public_singleton_methods].sort_by! {|decl| decl.is_a?(Members::MethodDefinition) ? decl.name.to_s : decl.new_name.to_s }
partitioned[:private_singleton_methods].sort_by! {|decl| decl.name.to_s }
Expand All @@ -167,24 +172,17 @@ def sort_decl(decl)
members.push(*partitioned[:singleton_new_methods])
members.push(*partitioned[:public_singleton_methods])

if !partitioned[:private_singleton_methods].empty?
current_visibility = :private
members.push Members::Private.new(location: nil)
end
members.push(*partitioned[:private_singleton_methods])

if current_visibility == :private && !partitioned[:public_instance_methods].empty?
current_visibility = :public
members.push Members::Public.new(location: nil)
end
members.push(*partitioned[:instance_attributes])
members.push(*partitioned[:public_instance_attributes])
members.push(*partitioned[:instance_initialize_methods])
members.push(*partitioned[:public_instance_methods])

if current_visibility == :public && !partitioned[:private_instance_methods].empty?
if current_visibility == :public && (!partitioned[:private_instance_attributes].empty? || !partitioned[:private_instance_methods].empty?)
current_visibility = :private
members.push Members::Private.new(location: nil)
end
members.push(*partitioned[:private_instance_attributes])
members.push(*partitioned[:private_instance_methods])

members.push(*partitioned[:other_decls])
Expand Down
3 changes: 2 additions & 1 deletion sig/sorter.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ module RBS
class_instance_variables: Array[AST::Members::ClassInstanceVariable],
instance_variables: Array[AST::Members::InstanceVariable],
singleton_attributes: Array[AST::Members::AttrAccessor | AST::Members::AttrWriter | AST::Members::AttrReader],
instance_attributes: Array[AST::Members::AttrAccessor | AST::Members::AttrWriter | AST::Members::AttrReader],
public_instance_attributes: Array[AST::Members::AttrAccessor | AST::Members::AttrWriter | AST::Members::AttrReader],
private_instance_attributes: Array[AST::Members::AttrAccessor | AST::Members::AttrWriter | AST::Members::AttrReader],
module_functions: Array[AST::Members::MethodDefinition],
singleton_new_methods: Array[AST::Members::MethodDefinition],
public_singleton_methods: Array[AST::Members::MethodDefinition | AST::Members::Alias],
Expand Down
15 changes: 8 additions & 7 deletions test/rbs/sorter_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,13 @@ def self?.modfunc: () -> void
attr_accessor self.a: String
attr_reader self.b: String
attr_writer self.c: String
private attr_reader self.private_singleton: String

def self.new: () -> instance
alias self.bb self.xx
def self.foo: () -> void
def self.pub: () -> void

private

def self.prv: () -> void

public
public def self.pub: () -> void
private def self.prv: () -> void

attr_accessor x: String
def initialize: () -> void
Expand All @@ -58,6 +54,7 @@ def pub: () -> void

private

attr_reader private_instance: String
def prv: () -> void
end
RUBY_EXPECTED
Expand All @@ -84,8 +81,12 @@ def self?.modfunc: () -> void

attr_writer self.c: String

private attr_reader self.private_singleton: String

attr_accessor x: String

private attr_reader private_instance: String

def self.new: () -> instance

def self.foo: () -> void
Expand Down
Loading