$30 off During Our Annual Pro Sale. View Details »

Refactor ruby code based on AST

flyerhzm
October 18, 2015

Refactor ruby code based on AST

flyerhzm

October 18, 2015
Tweet

More Decks by flyerhzm

Other Decks in Programming

Transcript

  1. Refactor ruby code
    based on AST
    Richard Huang
    @flyerhzm

    View Slide

  2. View Slide

  3. View Slide

  4. Problem

    View Slide

  5. Code Review

    View Slide

  6. View Slide

  7. View Slide

  8. Repeat, Repeat, Repeat

    View Slide

  9. View Slide

  10. View Slide

  11. Any solution?

    View Slide

  12. CodeClimate

    View Slide

  13. View Slide

  14. View Slide

  15. PullReview

    View Slide

  16. How they work?

    View Slide

  17. CodeClimate / PullReview
    flay flog brakeman rails_best_practices …
    Open Source Gems

    View Slide

  18. flay
    analyzes code for structural similarities

    View Slide

  19. View Slide

  20. flog
    reports the most tortured code

    View Slide

  21. View Slide

  22. brakeman
    a static analysis security vulnerability scanner
    for rails applications

    View Slide

  23. View Slide

  24. rails_best_practices
    checks the quality of rails code

    View Slide

  25. View Slide

  26. How they work?

    View Slide

  27. flay flog brakeman rails_best_practices …
    ruby_parser ripper parser
    ruby parser => AST
    CodeClimate / PullReview

    View Slide

  28. ParseTree
    • First ruby parser
    • Not support ruby 1.9 or newer

    View Slide

  29. ruby_parser
    • Most popular ruby parser
    • Output is 100% equivalent to ParseTree

    View Slide

  30. View Slide

  31. View Slide

  32. ActiveRecord::Base
    belongs_to :user
    touch :archived_at
    def archive

    View Slide

  33. ripper
    • Ruby built-in parser
    • Support ruby

    View Slide

  34. View Slide

  35. ActiveRecord::Base
    belongs_to :user
    def archive
    touch :archived_at

    View Slide

  36. parser
    • A new ruby parser
    • Support rewriting

    View Slide

  37. View Slide

  38. ActiveRecord::Base
    belongs_to :user
    def archive
    touch :archived_at

    View Slide

  39. Good enough?

    View Slide

  40. Auto rewrite!

    View Slide

  41. transpec
    the rspec syntax converter

    View Slide

  42. View Slide

  43. View Slide

  44. View Slide

  45. View Slide

  46. rubocop
    static code analyzer based on the
    community ruby style guide

    View Slide

  47. View Slide

  48. View Slide

  49. transpec rubocop
    parser

    View Slide

  50. View Slide

  51. Generic Solution

    View Slide

  52. Synvert
    converts ruby code to better syntax

    View Slide

  53. DSL
    • within_file / within_files
    • with_node / within_node
    • if_exist_node / unless_exist_node
    • append / insert / insert_after / replace_with /
    remove
    • ……

    View Slide

  54. View Slide

  55. View Slide

  56. View Slide

  57. Demo
    Convert rspec to new syntax
    Convert rails code from 2.3 to 3.0
    Convert rails code from 3.2 to 4.0

    View Slide

  58. Side Project
    not published yet

    View Slide

  59. View Slide

  60. View Slide

  61. 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

    View Slide

  62. 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

    View Slide

  63. Thank You

    View Slide