Unused code detection modeled after David Schnepper's talk (https://www.youtube.com/watch?v=29UXzfQWOhQ).
Finding unused code can be difficult. Especially in highly dynamic environments, where it is harder to make static assurances about what is in use.
Feierabend allows you to deprecated markers on code that you believe is no longer in use, and run that in production. If that code path gets executed, a backtrace is stored to redis, allowing you to see exactly what is using it.
By following a convention of including a date in the label (though some git blame magic could do the same) it becomes possible to filter markers by age, giving you increasing confidence that code can be cleaned up.
Here's an out-of-context Dijkstra quote for good measure:
Program testing can be a very effective way to show the presence of bugs, but it is hopelessly inadequate for showing their absence.
require 'travis/feierabend'
require 'travis/feierabend/redis_storage'
Travis::Feierabend.configure { Travis::Feierabend::RedisStorage.new }
The Deprecations refinement enables 2 methods for deprecating methods in classes or modules. It creates the warnings for the user. Examples:
class ExampleClass
using Travis::Feierabend::Deprecations
def expiring_method
puts "I'm not going to be around much longer!"
end
deprecate :expiring_method, expiration_date: "June 4th 2017", new_method_name: 'not_expiring_method'
end > ExampleClass.new.expiring_method
[DEPRECATION] 'expiring_method' is deprecated. Please use 'not_expiring_method' instead. expiring_method with no longer work after June 4th 2017
I'm not going to be around much longer!
=> nil
class ExampleClass
using Travis::Feierabend::Deprecations
def awesome_new_method
puts "Hello World!"
end
replace_method :expiring_method, :awesome_new_method
end> ExampleClass.new.expiring_method
[DEPRECATION] 'expiring_method' is no longer availible. Using 'awesome_new_method' instead.
Hello World!
=> nil
Travis::Feierabend.deprecated('2016-07-01/no-longer-needed-code')
Travis::Feierabend.list_in_use('2016-07-01/no-longer-needed-code')
#=> [{trace: "...", meta: nil}, ...]
$ make install
$ make
- method that recursively traverses a code base and its dependencies searching for
Feierabend.deprecatedin files and then using a ruby parser to extract the label from the line -- as well as calculating which line it was on - publish gem
MIT