From: eregontp@gmail.com
To: ruby-core@ruby-lang.org
Subject: [ruby-core:92185] [Ruby trunk Feature#14844] Future of RubyVM::AST?
Date: Sun, 07 Apr 2019 19:07:14 +0000 (UTC) [thread overview]
Message-ID: <redmine.journal-77514.20190407190713.0412b0bc33bf611a@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-14844.20180612141613@ruby-lang.org
Issue #14844 has been updated by Eregon (Benoit Daloze).
mame (Yusuke Endoh) wrote:
> As far as I understand, RubyVM module is completely different than other builtin modules.
> It exposes an access to Ruby internal for very limited purpose, such as debugging the internal, prototyping a new feature, implementing a MRI-bundled feature, etc. No compatibility is guaranteed at all; its API will arbitrarily change along with internal change. It is never intended for normal users to use it. Usefulness is not a priority for the modules under RubyVM.
>
> `RubyVM::AST` does not decrease the value of the parser gem. `RubyVM::AST` is useful to investigate how MRI looks a Ruby program, but is not useful as a general Ruby program parser; it may optimize the AST by omitting some non-significant letters and restructuring the tree structure, so the result might not correspond to the original source code literally.
>
> In short, I think that RubyVM::AST is not what people expected.
> Users may use it just for research purpose, but must not use it in production.
@mame Could you summarize this in the documentation of `RubyVM::AbstractSyntaxTree`?
Currently, it doesn't mention anything about being not stable, being not so appropriate for source code analysis, etc:
```
AbstractSyntaxTree provides methods to parse Ruby code into
abstract syntax trees. The nodes in the tree
are instances of RubyVM::AbstractSyntaxTree::Node.
```
---
I think that such an AST module could have the potential to be portable, but it would need to be much more fledged out.
Relying on the order of `children` to access AST node fields is impractical and brittle.
I think we should have nodes with methods to access each part/field, such as ModuleDefinitionNode#body, ModuleDefinitionNode#name, etc.
----------------------------------------
Feature #14844: Future of RubyVM::AST?
https://bugs.ruby-lang.org/issues/14844#change-77514
* Author: rmosolgo (Robert Mosolgo)
* Status: Open
* Priority: Normal
* Assignee:
* Target version:
----------------------------------------
Hi! Thanks for all your great work on the Ruby language.
I saw the new RubyVM::AST module in 2.6.0-preview2 and I quickly went to try it out.
I'd love to have a well-documented, user-friendly way to parse and manipulate Ruby code using the Ruby standard library, so I'm pretty excited to try it out. (I've been trying to learn Ripper recently, too: https://ripper-preview.herokuapp.com/, https://rmosolgo.github.io/ripper_events/ .)
Based on my exploration, I opened a small PR on GitHub with some documentation: https://github.com/ruby/ruby/pull/1888
I'm curious though, are there future plans for this module? For example, we might:
- Add more details about each node (for example, we could expose the names of identifiers and operators through the node classes)
- Document each node type
I see there is a lot more information in the C structures that we could expose, and I'm interested to help out if it's valuable. What do you think?
--
https://bugs.ruby-lang.org/
next prev parent reply other threads:[~2019-04-07 19:07 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <redmine.issue-14844.20180612141613@ruby-lang.org>
2018-06-12 14:16 ` [ruby-core:87480] [Ruby trunk Feature#14844] Future of RubyVM::AST? rdmosolgo
2018-06-12 15:42 ` [ruby-core:87481] " shevegen
2018-06-30 23:43 ` [ruby-core:87727] " samuel
2018-07-02 0:07 ` [ruby-core:87733] " samuel
2018-07-05 4:13 ` [ruby-core:87799] " samuel
2018-08-10 9:26 ` [ruby-core:88432] " bozhidar
2018-08-17 0:33 ` [ruby-core:88509] " mame
2018-08-28 1:00 ` [ruby-core:88700] " samuel
2018-12-07 11:43 ` [ruby-core:90367] " lucasbuchala
2018-12-20 4:28 ` [ruby-core:90628] " samuel
2019-01-26 11:06 ` [ruby-core:91282] " samuel
2019-04-07 19:07 ` eregontp [this message]
2019-04-07 19:16 ` [ruby-core:92186] " eregontp
2019-04-18 22:26 ` [ruby-core:92323] " eregontp
2019-05-15 21:37 ` [ruby-core:92670] " eregontp
2019-05-17 1:05 ` [ruby-core:92692] " mame
2019-05-17 12:56 ` [ruby-core:92696] " eregontp
2019-05-17 16:22 ` [ruby-core:92701] " mame
2019-05-17 19:53 ` [ruby-core:92703] " eregontp
2019-05-22 7:41 ` [ruby-core:92770] " akr
2019-05-22 10:15 ` [ruby-core:92782] " eregontp
2019-12-14 11:31 ` [ruby-core:96231] [Ruby master " eregontp
2019-12-14 11:50 ` [ruby-core:96232] " eregontp
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-77514.20190407190713.0412b0bc33bf611a@ruby-lang.org \
--to=ruby-core@ruby-lang.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
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).