Slide 1
Slide 1 text
Refactor ruby code
based on AST
Richard Huang
@flyerhzm
Slide 2
Slide 2 text
No content
Slide 3
Slide 3 text
No content
Slide 4
Slide 4 text
Problem
Slide 5
Slide 5 text
Code Review
Slide 6
Slide 6 text
No content
Slide 7
Slide 7 text
No content
Slide 8
Slide 8 text
Repeat, Repeat, Repeat
Slide 9
Slide 9 text
No content
Slide 10
Slide 10 text
No content
Slide 11
Slide 11 text
Any solution?
Slide 12
Slide 12 text
CodeClimate
Slide 13
Slide 13 text
No content
Slide 14
Slide 14 text
No content
Slide 15
Slide 15 text
PullReview
Slide 16
Slide 16 text
How they work?
Slide 17
Slide 17 text
CodeClimate / PullReview
flay flog brakeman rails_best_practices …
Open Source Gems
Slide 18
Slide 18 text
flay
analyzes code for structural similarities
Slide 19
Slide 19 text
No content
Slide 20
Slide 20 text
flog
reports the most tortured code
Slide 21
Slide 21 text
No content
Slide 22
Slide 22 text
brakeman
a static analysis security vulnerability scanner
for rails applications
Slide 23
Slide 23 text
No content
Slide 24
Slide 24 text
rails_best_practices
checks the quality of rails code
Slide 25
Slide 25 text
No content
Slide 26
Slide 26 text
How they work?
Slide 27
Slide 27 text
flay flog brakeman rails_best_practices …
ruby_parser ripper parser
ruby parser => AST
CodeClimate / PullReview
Slide 28
Slide 28 text
ParseTree
• First ruby parser
• Not support ruby 1.9 or newer
Slide 29
Slide 29 text
ruby_parser
• Most popular ruby parser
• Output is 100% equivalent to ParseTree
Slide 30
Slide 30 text
No content
Slide 31
Slide 31 text
No content
Slide 32
Slide 32 text
ActiveRecord::Base
belongs_to :user
touch :archived_at
def archive
Slide 33
Slide 33 text
ripper
• Ruby built-in parser
• Support ruby
Slide 34
Slide 34 text
No content
Slide 35
Slide 35 text
ActiveRecord::Base
belongs_to :user
def archive
touch :archived_at
Slide 36
Slide 36 text
parser
• A new ruby parser
• Support rewriting
Slide 37
Slide 37 text
No content
Slide 38
Slide 38 text
ActiveRecord::Base
belongs_to :user
def archive
touch :archived_at
Slide 39
Slide 39 text
Good enough?
Slide 40
Slide 40 text
Auto rewrite!
Slide 41
Slide 41 text
transpec
the rspec syntax converter
Slide 42
Slide 42 text
No content
Slide 43
Slide 43 text
No content
Slide 44
Slide 44 text
No content
Slide 45
Slide 45 text
No content
Slide 46
Slide 46 text
rubocop
static code analyzer based on the
community ruby style guide
Slide 47
Slide 47 text
No content
Slide 48
Slide 48 text
No content
Slide 49
Slide 49 text
transpec rubocop
parser
Slide 50
Slide 50 text
No content
Slide 51
Slide 51 text
Generic Solution
Slide 52
Slide 52 text
Synvert
converts ruby code to better syntax
Slide 53
Slide 53 text
DSL
• within_file / within_files
• with_node / within_node
• if_exist_node / unless_exist_node
• append / insert / insert_after / replace_with /
remove
• ……
Slide 54
Slide 54 text
No content
Slide 55
Slide 55 text
No content
Slide 56
Slide 56 text
No content
Slide 57
Slide 57 text
Demo
Convert rspec to new syntax
Convert rails code from 2.3 to 3.0
Convert rails code from 3.2 to 4.0
Slide 58
Slide 58 text
Side Project
not published yet
Slide 59
Slide 59 text
No content
Slide 60
Slide 60 text
No content
Slide 61
Slide 61 text
Refs
CodeClimate - https://codeclimate.com/
PullReview - https://www.pullreview.com/
flay - https://github.com/seattlerb/flay
flog - https://github.com/seattlerb/flog
brakeman - https://github.com/presidentbeef/brakeman
rails_best_practices - https://github.com/railsbp/
rails_best_practices
Slide 62
Slide 62 text
Refs
parsetree - https://github.com/seattlerb/parsetree
ruby_parser - https://github.com/seattlerb/ruby_parser
parser - https://github.com/whitequark/parser
rubocop - https://github.com/bbatsov/rubocop
transpec - https://github.com/yujinakayama/transpec
synvert - https://github.com/xinminlabs/synvert
Slide 63
Slide 63 text
Thank You