Ruby AST Tools
Download as KEY, PDF10 likes1,882 views
The document discusses Ruby AST (abstract syntax tree) tools including ParseTree, ruby_parser, SexpProcessors, Flog, roodi, and Ambition. ParseTree allows parsing Ruby code into an AST and transforming it. ruby_parser uses Racc to parse Ruby but is slower. SexpProcessors allow processing and transforming AST nodes. Flog analyzes code for complexity. roodi checks for code smells. Ambition provides a DSL for querying data sources. Ripper in Ruby 1.9 offers similar functionality to ParseTree.
Editor's Notes
- #3: Ruby 1.8 uses a Bison Yacc-like parser Many different styles lead to the same Abstract Syntax tree or set of instructions.
- #4: Best to thing of the AST not as a tree but a large container composed of inner nodes
- #5: themselves composed of smaller nodes. until you get to an individual “token”
- #6: Both by Ryan Davis
- #9: Pure ruby implementation using racc. For those that don’t know RACC is a ruby based YACC parser. Slowness not a huge issue in my experience.
- #10: Pure ruby implementation using racc. For those that don’t know RACC is a ruby based YACC parser. Slowness not a huge issue in my experience.
- #11: Pure ruby implementation using racc. For those that don’t know RACC is a ruby based YACC parser. Slowness not a huge issue in my experience.
- #12: Pure ruby implementation using racc. For those that don’t know RACC is a ruby based YACC parser. Slowness not a huge issue in my experience.
- #13: Obtains the Parse tree and represents it as nested s-expresions.
- #14: Obtains the Parse tree and represents it as nested s-expresions.
- #15: composed of array’s, symbol’s and literals `structure` just returns the node type structure not the contents of the nodes. this is very handy for code structure analysis.
- #16: Takes the sexp objects returned by ParseTree and processes returning output.
- #29: Essentially turns the parse tree into an AST. It does this via a set of rewrite methods. By default ParseTree does this. To get the un-unified version you have to use RawParseTree. ParseTree does this by processing with a CompositeSexpProcessor called Unifier
- #30: A Module that can be included in a SexpProcessor.
- #31: Another good example of a SexpProcessor. Take a class or method and translates it into a string of valid Ruby code that would create that Class/method exactly. Useful for metaprogramming and dissecting dynamically created classes, methods, and procs
- #32: Convert Methods, UnboundMethods and Procs to sexps and strings of ruby code. Helpful in debuging mysterious Procs.
- #33: Often times I find libraries that use ParseTree but don't take advantage of SexpProcessor and often rebuild similar functionality. very sad.
- #34: 2 Types of Libraries based on ParseTree
- #35: Good at finding problem areas that may need refactoring
- #37: Also adds to varying amounts to a score multiplier for specific types of nestings.
- #39: with no options Ryan Davis has said to remember it's more about relative scores. Particularly bad scores I generally consider is those over 40 or if I'm being very rough those over 25.
- #40: with group option, groups by class
- #41: with detail version (old output) gives why each method earned it's score.
- #42: Converted over by Ben Scofield Working on a site that will allow you to share and download those weightings.
- #43: by Marty Andrews
- #44: by Marty Andrews
- #45: by Marty Andrews
- #46: by Marty Andrews
- #47: by Marty Andrews
- #48: by Marty Andrews
- #49: Once again, Very good at finding problem areas that need refactoring.
- #54: by github’s Chris Wanstrath Allows you to express queries in clear and concise ruby code. Think of it as a Framework for specific API adapters, e.g. ActiveRecord Includes a Rubigen based adapter generator for any data-source API you want
- #55: by github’s Chris Wanstrath Allows you to express queries in clear and concise ruby code. Think of it as a Framework for specific API adapters, e.g. ActiveRecord Includes a Rubigen based adapter generator for any data-source API you want
- #56: by github’s Chris Wanstrath Allows you to express queries in clear and concise ruby code. Think of it as a Framework for specific API adapters, e.g. ActiveRecord Includes a Rubigen based adapter generator for any data-source API you want
- #57: Just gives us another syntax for doing finds, the syntax may be preferable to some. Still needs lots of work to do everything you can do with find or SQL.
- #63: No composite SexpProcessor equivalent yet.
- #64: line and column, node/event type, “code” that produced it.
- #65: Very similar output to ParseTree, but does include line and column info for inner most nodes.
- #66: Uses Lexer and goes thru each node.