• Stars
    star
    673
  • Rank 67,041 (Top 2 %)
  • Language
    Ruby
  • Created over 9 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Analyze code for potentially uncalled / dead methods, now with auto-removal.

debride

home

github.com/seattlerb/debride

rdoc

docs.seattlerb.org/debride

DESCRIPTION:

Analyze code for potentially uncalled / dead methods, now with auto-removal.

FEATURES/PROBLEMS:

  • Static analysis of code. Can be easily hooked up to a CI.

  • As with all static analysis tools of dynamic languages, can’t be 100%.

  • Whitelisting known good methods by name or regexp.

  • Use –rails for Rails-specific domain knowledge.

  • Use debride_rm to brazenly remove all unused methods. BE CAREFUL.

  • Use ‘debride_rails_whitelist` to generate an emperical whitelist from logs.

  • Uses path_expander, so you can use:

    • dir_arg – expand a directory automatically

    • @file_of_args – persist arguments in a file

    • -path_to_subtract – ignore intersecting subsets of files/directories

SYNOPSIS:

% debride lib

These methods MIGHT not be called:

MyClass
  good_method                         lib/some/file.rb:16
  bad_method                          lib/some/file.rb:20
...

But you know that good_method is called (perhaps because it is public API), then you can whitelist it:

% echo good_method > whitelist.txt
% debride --whitelist whitelist.txt lib

These methods MIGHT not be called:

MyClass
  bad_method                          lib/some/file.rb:20
...

Usage example for a typical rails application:

# dump rake routes into a file
% rake routes > routes.txt
# generate whitelist based on routes and usages from production log
% debride_rails_whitelist routes.txt log/production.log | sort -u > whitelist.txt
# add migration methods
% echo up >> whitelist.txt
% echo down >> whitelist.txt
% echo change >> whitelist.txt
# output debride report co standard output with the following options:
# ignore typical rails methods,
# specify generated whitelist,
# run in current directory (".")
% debride --rails --whitelist whitelist.txt .

You can also use regexps in your whitelist by delimiting them with //‘s.

To generate a whitelist for the last 28 days worth of logs on papertrail:

% seq 2 29 | xargs -I {} date -u -v-{}d +%Y-%m-%d | \
  xargs -I {} curl --progress-bar -f --no-include -L -H "X-Papertrail-Token: $PAPERTRAIL_APIKEY" https://papertrailapp.com/api/v1/archives/{}/download | \
  gzip -dc | grep production.log | cut -f 10- | \
  debride_rails_whitelist routes.txt - | sort -u > whitelist.txt

debride_rm

debride_rm will automatically remove dead code and optionally run a command in between each removal. The command will automatically substitute “NAME” and “PATH” with the name and path of the thing being removed. Eg:

% debride_rm -C="git commit -m 'debride NAME in PATH' ." \
    --rails \
    --whitelist whitelist.txt \
    --exclude test \
    --exclude script \
    --exclude bin \
    --minimum 30

This command will:

  1. run with rails extensions on

  2. treat anything named in whitelist.txt as “called”

  3. exclude directories that shouldn’t be scanned or mutated

  4. exclude anything under 30 lines long

One thing to note, debride_rm doesn’t do terribly well with things like attr_accessor lists, so running debride_rm with –minimum 2 (or more) is wise.

Strategy: start large (40+) and work your way down.

PLUGINS:

debride-erb

Extends debride to analyze erb files (via erubis ala rails).

debride-haml

Plugin to allow debride to parse Haml files.

debride-curly

A plugin for the Curly templating language

debride-slim

Extends debride to analyze Slim files

EDITOR INTEGRATION:

TextMate 2

REQUIREMENTS:

  • sexp_processor

  • ruby_parser

  • path_expander

INSTALL:

  • sudo gem install debride

CONTRIBUTING:

  • sudo gem install minitest

  • ruby -Ilib:test test/test_debride.rb

LICENSE:

(The MIT License)

Copyright © Ryan Davis, seattle.rb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

More Repositories

1

flog

Flog reports the most tortured code in an easy to read pain report. The higher the score, the more pain the code is in.
Ruby
869
star
2

flay

Flay analyzes code for structural similarities. Differences in literal values, variable, class, method names, whitespace, programming style, braces vs do/end, etc are all ignored.
Ruby
709
star
3

ruby_parser

ruby_parser is a ruby parser written in pure ruby. It outputs s-expressions which can be manipulated and converted back to ruby via the ruby2ruby gem.
Ruby
471
star
4

vlad

Ruby
353
star
5

rubyinline

Ruby
286
star
6

hoe

Hoe is a rake/rubygems helper for project Rakefiles. It helps you manage, maintain, and release your project and includes a dynamic plug-in system allowing for easy extensibility. Hoe ships with plug-ins for all your usual project tasks including rdoc generation, testing, packaging, deployment, and announcement.
Ruby
285
star
7

heckle

Ruby
176
star
8

ruby2ruby

Ruby
162
star
9

graph

Graph is a type of hash that outputs in graphviz's dot format. It comes with a command-line interface that is easily pluggable.
Ruby
158
star
10

zentest

Ruby
145
star
11

wilson

Ruby
138
star
12

image_science

Ruby
128
star
13

omnifocus

Ruby
127
star
14

rake-remote_task

Ruby
90
star
15

sexp_processor

Ruby
80
star
16

ruby_to_c

Ruby
79
star
17

zenweb

Ruby
64
star
18

parsetree

Ruby
54
star
19

omnifocus-github

Ruby
42
star
20

autotest-rails

Ruby
40
star
21

rdoc_osx_dictionary

Ruby
39
star
22

oedipus_lex

This is not your father’s lexer.
Ruby
34
star
23

osx_keychain

Ruby
24
star
24

sysloglogger

This project is EOL'd because it was merged into ruby 2.0.
Ruby
23
star
25

upnp

Ruby
20
star
26

ar_mailer

Ruby
20
star
27

zenprofile

Ruby
19
star
28

autotest-screen

Ruby
17
star
29

png

Ruby
17
star
30

metaruby

Ruby
15
star
31

seattlerb.org

CSS
15
star
32

omnifocus-redmine

Ruby
14
star
33

event_hook

Ruby
13
star
34

ohmygems

Ruby
12
star
35

production_log_analyzer

Ruby
12
star
36

minitest-excludes

Ruby
11
star
37

upnp-mediaserver

Ruby
10
star
38

ssh

Ruby
10
star
39

graphics

C++
9
star
40

ruby2smalltalk

Ruby
9
star
41

minitest-proveit

Ruby
8
star
42

orca_card

Ruby
8
star
43

gauntlet

Ruby
7
star
44

imap_processor

Ruby
7
star
45

rails_analyzer_tools

Ruby
7
star
46

path_expander

Ruby
7
star
47

minitest-macruby

Ruby
7
star
48

rubygems-sandbox

Ruby
7
star
49

github_contribs

Ruby
7
star
50

upnp-contentdirectory

Ruby
6
star
51

sphincter

6
star
52

cocor

Ruby
6
star
53

smtp_tls

Ruby
6
star
54

minitest-stackprofit

Ruby
6
star
55

upnp-igd

Ruby
5
star
56

cached_model

Ruby
5
star
57

mem_inspect

5
star
58

makerakeworkwell

Ruby
5
star
59

minitest-trump

Ruby
5
star
60

un

Ruby
5
star
61

debride-erb

Ruby
4
star
62

action_profiler

Ruby
4
star
63

synchronizer

Perforce, meet GitHub.
Ruby
3
star
64

rubyaudit

Ruby
3
star
65

minitest-speed

Ruby
3
star
66

minitest-compare

Ruby
3
star
67

rfc_spec

Ruby
3
star
68

rubyholic

Ruby
3
star
69

rubygems-cleanroom

Ruby
3
star
70

zombies

Ruby
3
star
71

upnp-connectionmanager

Ruby
3
star
72

box_layout

Ruby
3
star
73

zenhacks

Ruby
3
star
74

worker_bee

Ruby
3
star
75

ringydingy

Ruby
3
star
76

rubygems-sing

Ruby
3
star
77

minitest_tu_shim

Ruby
3
star
78

omnifocus-rubyforge

Ruby
2
star
79

rubyinlinefortran

Ruby
2
star
80

zencallgraph

Ruby
2
star
81

rubygems-isit19

Ruby
2
star
82

supercaller

Ruby
2
star
83

minitest-unordered

Ruby
2
star
84

siren_song

Ruby
2
star
85

zengraph

Ruby
2
star
86

gmail_contacts

Ruby
2
star
87

mogilefs-client

2
star
88

imap_to_rss

Ruby
2
star
89

drawr

Ruby
2
star
90

minitest_bench

Ruby
2
star
91

change_class

Ruby
2
star
92

minitest-allow

Ruby
2
star
93

hoe-seattlerb

Ruby
2
star
94

rbayes

Ruby
1
star
95

firebrigade_api

Ruby
1
star
96

flay-persistence

Ruby
1
star
97

seattlerb_dashboard

Ruby
1
star
98

memcache-client

1
star
99

rc-rest

Ruby
1
star
100

omnifocus-bugzilla

Ruby
1
star