Skip to content

Track bare module_function mode with its own flag #1869

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
st0012 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Track bare module_function mode with its own flag #1869

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
29 changes: 22 additions & 7 deletions lib/rdoc/parser/ruby.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,22 @@ class Ruby < Parser
# Matches an RBS inline type annotation line: #: followed by whitespace
RBS_SIG_LINE = /\A#:\s/ # :nodoc:

attr_writer :visibility
attr_reader :container, :singleton, :in_proc_block
attr_reader :visibility, :container, :singleton, :in_proc_block

def visibility
@visibility == :module_function ? :private : @visibility
# Sets the default visibility for methods defined after this point.
# This ends a bare `module_function` region, as in Ruby.

def visibility=(visibility)
@visibility = visibility
@module_function = false
end

# Handles bare `module_function`. Methods defined after this point
# become private instance methods with public singleton copies.

def start_module_function
@visibility = :private
@module_function = true
end

def initialize(top_level, content, options, stats)
Expand All @@ -157,6 +168,7 @@ def initialize(top_level, content, options, stats)
@module_nesting = [[top_level, false]]
@container = top_level
@visibility = :public
@module_function = false
@singleton = false
@in_proc_block = false
@doc_state = :startdoc
Expand Down Expand Up @@ -224,10 +236,12 @@ def with_in_proc_block
def with_container(container, singleton: false)
old_container = @container
old_visibility = @visibility
old_module_function = @module_function
old_singleton = @singleton
old_in_proc_block = @in_proc_block
old_doc_state = @doc_state
@visibility = :public
@module_function = false
@container = container
@singleton = singleton
@in_proc_block = false
Expand All @@ -236,6 +250,7 @@ def with_container(container, singleton: false)
ensure
@container = old_container
@visibility = old_visibility
@module_function = old_module_function
@singleton = old_singleton
@in_proc_block = old_in_proc_block
@doc_state = old_doc_state
Expand Down Expand Up @@ -418,7 +433,7 @@ def handle_meta_method_comment(comment, directives, node)
handle_code_object_directives(@container, directives)
is_call_node = node.is_a?(Prism::CallNode)
singleton_method = false
visibility = self.visibility
visibility = @visibility
attributes = rw = line_no = method_name = nil
directives.each do |directive, (param, line)|
case directive
Expand Down Expand Up @@ -720,7 +735,7 @@ def add_method(method_name, receiver_name:, receiver_fallback_type:, visibility:
end

private def internal_add_method(method_name, container, comment:, directives:, modifier_comment_lines: nil, line_no:, visibility:, singleton:, params:, calls_super:, block_params:, node_id:, type_signature_lines: nil) # :nodoc:
module_function = @visibility == :module_function && !singleton && container.equal?(@container)
module_function = @module_function && !singleton && container.equal?(@container)
meth = AnyMethod.new(method_name, singleton: singleton)
meth.comment = comment
handle_code_object_directives(meth, directives) if directives
Expand Down Expand Up @@ -1283,7 +1298,7 @@ def _visit_call_require(call_node)
def _visit_call_module_function(call_node)
return if @scanner.in_proc_block || @scanner.singleton
if call_node.arguments.nil?
@scanner.visibility = :module_function
@scanner.start_module_function
else
names = visibility_method_arguments(call_node, singleton: false)&.map(&:to_s)
@scanner.change_method_to_module_function(names) if names
Expand Down
Loading