joenas / preek Goto Github PK

Some companies will only use gems with a certain license.
The canonical and easy way to check is via the gemspec
via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

There is even a License Finder to help companies ensure all gems they use
meet their licensing needs. This tool depends on license information being available in the gemspec.
Including a license in your gemspec is a good practice, in any case.

How did I find you?

I'm using a script to collect stats on gems, originally looking for download data, but decided to collect licenses too,
and make issues for missing ones as a public service :)
https://gist.github.com/bf4/5952053#file-license_issue-rb-L13 So far it's going pretty well

Not sure what the problem is...

/home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_warning.rb:13:in *': String can't be coerced into Fixnum (TypeError)
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_warning.rb:13:in smell_string' from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_klass.rb:18:in block in smells'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_klass.rb:17:in map' from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_klass.rb:17:in smells'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_reporter.rb:22:in block in print_klasses' from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_reporter.rb:19:in each'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_reporter.rb:19:in print_klasses' from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_reporter.rb:14:in block in print_smells'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_reporter.rb:12:in each' from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek/smell_reporter.rb:12:in print_smells'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek.rb:29:in report_smells_for' from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/lib/preek.rb:20:in parse'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/gems/preek-0.1.0/bin/preek:9:in <top (required)>' from /home/jon/.rvm/gems/ruby-2.0.0-p0/bin/preek:23:in load'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/bin/preek:23:in <main>' from /home/jon/.rvm/gems/ruby-2.0.0-p0/bin/ruby_noexec_wrapper:14:in eval'
from /home/jon/.rvm/gems/ruby-2.0.0-p0/bin/ruby_noexec_wrapper:14:in <main>'

Plan

• Remove -i option, and let users configure unwanted reports with .reek files.
• Remove lib/preek/ext/smell_warning.rb if possible and rely on reeks public API.
• Prepare/simplify code to implement #9 (and maybe #6)
• Update reek to 2.0.x

I think it would be useful to have something like preek sample SOMEPATH that collects a single problem and reports it. Running preek on a big project can be so overwhelming that you just can't muster the courage to start fixing it. Having a single thing to focus on at the time would be easier.

Make something that compares a given branch to master and reports added(/removed?) smells.

Add option to report only total smells.

 M app/something.rb
 D app/deleted.rb
?? app/new.rb

Will display errors. Not good!