From: "byroot (Jean Boussier) via ruby-dev" <ruby-dev@ml.ruby-lang.org>
To: ruby-dev@ml.ruby-lang.org
Cc: "byroot (Jean Boussier)" <noreply@ruby-lang.org>
Subject: [ruby-dev:52065] [Ruby master Feature#16142] Implement code_range in Proc and Method
Date: Tue, 09 Jan 2024 18:30:10 +0000 (UTC) [thread overview]
Message-ID: <redmine.journal-106130.20240109183010.23655@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-16142.20190904054650.23655@ruby-lang.org
Issue #16142 has been updated by byroot (Jean Boussier).
> So what would be a good name?
What about `position`? I think it goes well together with `location`.
----------------------------------------
Feature #16142: Implement code_range in Proc and Method
https://bugs.ruby-lang.org/issues/16142#change-106130
* Author: okuramasafumi (Masafumi OKURA)
* Status: Open
* Priority: Normal
----------------------------------------
# Abstract
Add a new method `code_range` as an alternative to `source_location` to Proc and Method
# Background
I'd like to get a body from a Proc in TraceLocation gem (https://github.com/yhirano55/trace_location), in order to add what's executed to the output. There's no way to do that in current Ruby implementation, so as an alternative, I considered getting source code location of a Proc.
# Proposal
I propose that `Proc#code_range` and `Method#code_range`. Other names can work as well, for example `Proc#source_region`. It returns an array containing filename as a first argument and position information as a second array. For example:
`a_proc.position # => [(irb), [1, 5, 3, 25]]`
# Implementation
I've implemented a simpler version of this, see gist for more details.
https://gist.github.com/okuramasafumi/ac90bbf04a1c13b7d67954c9c5e62553
Notice I use `code_location` from iseq struct.
# Discussion
One might say that we can simply add columns and end position to Proc#source_location. However, this can easily brake existing apps such as Pry.
It's also possible that we add additional keyword argument to `Proc#source_location`, for instance:
`a_proc.source_location(including_range: true)`
This change can also break existing apps since in old Rubies this keyword argument cannot be accepted.
Therefore, adding a new method is better in terms of backward compatibility. It might be better at readability as well.
# Summary
I propose an API to get code position of Proc and Method so that we can get body of them (especially of a Proc).
--
https://bugs.ruby-lang.org/
prev parent reply other threads:[~2024-01-09 18:30 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <redmine.issue-16142.20190904054650.23655@ruby-lang.org>
2024-01-09 15:43 ` [ruby-dev:52064] [Ruby master Feature#16142] Implement code_range in Proc and Method okuramasafumi (Masafumi OKURA) via ruby-dev
2024-01-09 18:30 ` byroot (Jean Boussier) via ruby-dev [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.ruby-lang.org/en/community/mailing-lists/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=redmine.journal-106130.20240109183010.23655@ruby-lang.org \
--to=ruby-dev@ruby-lang.org \
--cc=noreply@ruby-lang.org \
--cc=ruby-dev@ml.ruby-lang.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).