No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 14 commits behind seattlerb:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.autotest
History.rdoc
Manifest.txt
README.rdoc
Rakefile

README.rdoc

debride

home

github.com/seattlerb/debride

rdoc

docs.seattlerb.org/debride

DESCRIPTION:

Analyze code for potentially uncalled / dead methods.

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

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

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

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.