pippi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95752be642c66d479b293d0887592472cbb7a6d4
-  data.tar.gz: 80f13c0e7329c6909e2729161f09f3489d6eb8e9
+  metadata.gz: b69820f23560f62844335dba76692a5b29c40523
+  data.tar.gz: bfdc9ccdd89aab53afc19f82c247c55e32f56eef
 SHA512:
-  metadata.gz: 3544e1ec0e442f38f8cfb52fe05a46eb6f504af6e9ff4f25665cf1930d1f618660a8adbd5e6bb0c19c750f46b542d2afa39ff42973d67441372a1aa0cc233b50
-  data.tar.gz: a56988007f42d5ee982887c5be19a8635fea55c0813193710dec41317f0125801658f87fb09a4a27e319c6f751844219362d8bc100f47d86c909b44ab76cfbc1
+  metadata.gz: 11480a7cce7761a9c2aeff77f31829872f79e577945082e1f6b7975f851b1968991d07c17eea8bbb3d28ae0e1eeceb0223edb99e578458e4fe987633a53b3ff1
+  data.tar.gz: 361ff7703eb9af5c59ea6a3385c6e2d8def03be9a2b94b4a2b6342e7689055fa4bc9497b2a2b8f85d5b797dfcf0ae4ad311a7eaec2989bf6a4eaabc2e3a9a887

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+Nov 5, 2014 - 0.0.5:
+Added SelectFollowedByEmpty
+
 Oct 30, 2014 - 0.0.4:
 Bugfixes around method delegation
 

data/README.md

@@ -2,7 +2,54 @@
 
 Pippi is a utility for finding suboptimal Ruby class API usage.
 
-[Here's a project overview](http://thomasleecopeland.com/2014/10/22/finding-suboptimal-api-usage.html).
+Consider this little array:
+
+```ruby
+[1,2,3]
+```
+
+Now suppose we want to find the first element in that array that's greater than one. We can use Array#select, which returns another Array, and then use Array#first:
+
+```ruby
+[1,2,3].select {|x| x > 1 }.first
+```
+
+Of course that's terribly inefficient. Since we only need one element we don't need to select all elements that match the predicate. We should use Array#detect instead:
+
+```ruby
+[1,2,3].detect {|x| x > 1}
+```
+
+A change like this is a small optimization, but they can add up.  More importantly, they communicate the intent of the programmer; the use of Array#detect makes it clear that we're just looking for the first item to match the predicate.
+
+This sort of thing can be be found during a code review, or maybe when you're just poking around the code. But why not have a tool find it instead? Thus, pippi. Pippi observes code while it's running - by hooking into your test suite execution - and reports misuse of class-level APIs.
+
+There are many nifty Ruby static analysis tools - flay, reek, flog, etc. This is not like those. It doesn't parse source code; it doesn't examine an abstract syntax tree or even sequences of MRI instructions. So it cannot find the types of issues that those tools can find. Instead, it's focused on runtime analysis; that is, method calls and method call sequences.
+
+Here's an important caveat: pippi is not, and more importantly cannot, be free of false positives. That's because of the halting problem. Pippi finds suboptimal API usage based on data flows as driven by a project's test suite. There may be alternate data flows where this API usage is correct. For example, in the code below, if rand < 0.5 is true, then the Array will be mutated and the program cannot correctly be simplified by replacing "select followed by first" with "detect":
+
+```ruby
+x = [1,2,3].select {|y| y > 1 }
+x.reject! {|y| y > 2} if rand < 0.5
+x.first
+```
+
+There are various techniques that eliminate many of these false positives. For example, after flagging an issue, pippi watches subsequent method invocations and if those indicate the initial problem report was in error it'll remove the problem from the report.
+
+Pippi is entirely dependent on the test suite to execute code in order to find problems. If a project's test code coverage is small, pippi probably won't find much.
+
+Here's how pippi stacks up using the [Aaron Quint](https://twitter.com/aq) [Ruby Performance Character Profiles](https://www.youtube.com/watch?v=cOaVIeX6qGg&t=8m50s) system:
+
+* Specificity - very specific, finds actual detailed usages of bad code
+* Impact - very impactful, slows things down lots
+* Difficulty of Operator Use - easy to install, just a new gemfile entry
+* Readability - results are easy to read
+* Realtimedness - finds stuff right away
+* Special Abilities - ?
+
+Finally, why "pippi"? Because Pippi Longstocking was a Thing-Finder, and pippi finds things.
+
+[![Build Status](http://img.shields.io/travis/tcopeland/pippi.svg)](http://travis-ci.org/tcopeland/pippi)
 
 ## Usage
 
@@ -22,11 +69,31 @@ end
 USE_PIPPI=true bundle exec rake test:units && cat log/pippi.log
 ```
 
+* You can also select a different checkset:
+
+```text
+USE_PIPPI=true PIPPI_CHECKSET=training bundle exec rake test:units && cat log/pippi.log
+```
+
+
 Here's a [demo Rails application](https://github.com/tcopeland/pippi_demo#pippi-demo).
 
 ### Rails with rspec
 
-TODO and FIXME
+* Add `gem 'pippi'` to the `test` group in your project's `Gemfile`
+* Add this to the bottom of `spec_helper.rb`:
+
+```ruby
+if ENV['USE_PIPPI'].present?
+  Pippi::AutoRunner.new(:checkset => ENV['PIPPI_CHECKSET'] || "basic")
+end
+```
+* Run it:
+
+```text
+USE_PIPPI=true bundle exec rake spec && cat log/pippi.log
+```
+
 
 ### From the command line:
 
@@ -43,106 +110,108 @@ bundle exec ruby -rpippi/auto_runner -e "MyClass.new.exercise_some_code"
 ```
 
 
-
 ## Checksets
 
 Pippi has the concept of "checksets" which are, well, sets of checks.  The current checksets are listed below.
 
-Maybe we should have a dedicated "test" checkset?  Let me know what you think at https://twitter.com/tcopeland, thanks!
+### basic
 
-### Basic
+#### ReverseFollowedByEach
 
-* SelectFollowedByFirst
-* SelectFollowedBySize
-* ReverseFollowedByEach
+Don't use each followed by reverse; use reverse_each instead
 
-### Buggy
+For example, rather than doing this:
 
-* AssertWithNil
-* MapFollowedByFlatten
+```ruby
+[1,2,3].reverse.each {|x| x+1 }
+```
 
-## Checks
+Instead, consider doing this:
 
-### AssertWithNil
+```ruby
+[1,2,3].reverse_each {|x| x+1 }
+```
 
-Don't use assert_equal with nil as a first argument; use assert_nil instead
+#### SelectFollowedByEmpty
+
+Don't use select followed by empty?; use none? instead
 
 For example, rather than doing this:
 
 ```ruby
-x = nil ; assert_equal(nil, x)
+[1,2,3].select {|x| x > 1 }.empty?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-x = nil ; assert_nil(x)
+[1,2,3].none? {|x| x > 1 }
 ```
 
-### MapFollowedByFlatten
+#### SelectFollowedByFirst
 
-Don't use map followed by flatten; use flat_map instead
+Don't use select followed by first; use detect instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].map {|x| [x,x+1] }.flatten
+[1,2,3].select {|x| x > 1 }.first
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].flat_map {|x| [x, x+1]}
+[1,2,3].detect {|x| x > 1 }
 ```
 
-### ReverseFollowedByEach
+#### SelectFollowedBySize
 
-Don't use each followed by reverse; use reverse_each instead
+Don't use select followed by size; use count instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].reverse.each {|x| x+1 }
+[1,2,3].select {|x| x > 1 }.size
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].reverse_each {|x| x+1 }
+[1,2,3].count {|x| x > 1 }
 ```
+### buggy
 
-### SelectFollowedByFirst
+#### AssertWithNil
 
-Don't use select followed by first; use detect instead
+Don't use assert_equal with nil as a first argument; use assert_nil instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.first
+x = nil ; assert_equal(nil, x)
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].detect {|x| x > 1 }
+x = nil ; assert_nil(x)
 ```
 
-### SelectFollowedBySize
+#### MapFollowedByFlatten
 
-Don't use select followed by size; use count instead
+Don't use map followed by flatten; use flat_map instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.size
+[1,2,3].map {|x| [x,x+1] }.flatten
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].count {|x| x > 1 }
+[1,2,3].flat_map {|x| [x, x+1]}
 ```
-
 ## Ideas for other problems to detect:
 
 ```ruby
@@ -226,7 +295,6 @@ When trying to find issues in a project:
 rm -rf pippi_debug.log pippi.log .bundle/gems/pippi-0.0.1/ .bundle/cache/pippi-0.0.1.gem .bundle/specifications/pippi-0.0.1.gemspec && bundle update pippi --local && PIPPI_DEBUG=1 bundle exec ruby -rpippi/auto_runner -e "puts 'hi'" && grep -C 5 BOOM pippi_debug.log
 # or to run some specs with pippi watching:
 rm -rf pippi_debug.log pippi.log .bundle/gems/pippi-0.0.1/ .bundle/cache/pippi-0.0.1.gem .bundle/specifications/pippi-0.0.1.gemspec && bundle update pippi --local && PIPPI_DEBUG=1 bundle exec ruby -rpippi/auto_runner -Ispec spec/unit/*.rb
-
 ```
 
 ## How to do a release
@@ -241,8 +309,9 @@ rm -rf pippi_debug.log pippi.log .bundle/gems/pippi-0.0.1/ .bundle/cache/pippi-0
 
 ## Credits
 
-* Christopher Schramm bugfixes in fault proc clearing
-* [Evan Phoenix](https://twitter.com/evanphx) for the idea of watching method invocations at runtime using metaprogramming rather than using `Tracepoint`.
-* Igor Kapkov documentation fixes
-* LivingSocial](https://www.livingsocial.com/) for letting me develop and open source this utility.
-* [Michael Bernstein](https://twitter.com/mrb_bk) (of [CodeClimate](https://codeclimate.com/) fame) for an inspirational discussion of code anaysis in general.
+* Christopher Schramm([@cschramm](https://github.com/cschramm)) bugfixes in fault proc clearing
+* [Evan Phoenix](https://twitter.com/evanphx)([@evanphx](https://github.com/evanphx)) for the idea of watching method invocations at runtime using metaprogramming rather than using `Tracepoint`.
+* [Igor Kapkov](https://twitter.com/igasgeek)([@igas](https://github.com/igas)) documentation fixes
+* [LivingSocial](https://www.livingsocial.com/) for letting me develop and open source this utility.
+* [Michael Bernstein](https://twitter.com/mrb_bk)([@mrb](https://github.com/mrb)) (of [CodeClimate](https://codeclimate.com/) fame) for an inspirational discussion of code anaysis in general.
+* [Olle Jonsson](https://twitter.com/olleolleolle)([@olleolleolle](https://github.com/olleolleolle)) rubocop fixes

data/bin/pippi

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'pippi'
 
-Pippi::ExecRunner.new(ARGV.dup).run
+Pippi::ExecRunner.new(ARGV.dup).run

data/doc/docs.md

@@ -1,80 +1,98 @@
+### basic
 
-### AssertWithNil
+#### ReverseFollowedByEach
 
-Don't use assert_equal with nil as a first argument; use assert_nil instead
+Don't use each followed by reverse; use reverse_each instead
 
 For example, rather than doing this:
 
 ```ruby
-x = nil ; assert_equal(nil, x)
+[1,2,3].reverse.each {|x| x+1 }
 ```
 
 Instead, consider doing this:
 
 ```ruby
-x = nil ; assert_nil(x)
+[1,2,3].reverse_each {|x| x+1 }
 ```
 
-### MapFollowedByFlatten
+#### SelectFollowedByEmpty
 
-Don't use map followed by flatten; use flat_map instead
+Don't use select followed by empty?; use none? instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].map {|x| [x,x+1] }.flatten
+[1,2,3].select {|x| x > 1 }.empty?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].flat_map {|x| [x, x+1]}
+[1,2,3].none? {|x| x > 1 }
 ```
 
-### ReverseFollowedByEach
+#### SelectFollowedByFirst
 
-Don't use each followed by reverse; use reverse_each instead
+Don't use select followed by first; use detect instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].reverse.each {|x| x+1 }
+[1,2,3].select {|x| x > 1 }.first
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].reverse_each {|x| x+1 }
+[1,2,3].detect {|x| x > 1 }
 ```
 
-### SelectFollowedByFirst
+#### SelectFollowedBySize
 
-Don't use select followed by first; use detect instead
+Don't use select followed by size; use count instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.first
+[1,2,3].select {|x| x > 1 }.size
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].detect {|x| x > 1 }
+[1,2,3].count {|x| x > 1 }
 ```
+### buggy
 
-### SelectFollowedBySize
+#### AssertWithNil
 
-Don't use select followed by size; use count instead
+Don't use assert_equal with nil as a first argument; use assert_nil instead
 
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.size
+x = nil ; assert_equal(nil, x)
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].count {|x| x > 1 }
+x = nil ; assert_nil(x)
+```
+
+#### MapFollowedByFlatten
+
+Don't use map followed by flatten; use flat_map instead
+
+For example, rather than doing this:
+
+```ruby
+[1,2,3].map {|x| [x,x+1] }.flatten
+```
+
+Instead, consider doing this:
+
+```ruby
+[1,2,3].flat_map {|x| [x, x+1]}
 ```

data/lib/pippi.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'pippi/context'
 require 'pippi/check_set_mapper'
 require 'pippi/report'
-require "pippi/checks/check"
+require 'pippi/checks/check'
 require 'pippi/problem'
 require 'pippi/check_loader'
 require 'pippi/exec_runner'
@@ -12,5 +12,6 @@ require 'pippi/checks/map_followed_by_flatten'
 require 'pippi/checks/reverse_followed_by_each'
 require 'pippi/checks/select_followed_by_first'
 require 'pippi/checks/select_followed_by_size'
+require 'pippi/checks/select_followed_by_empty'
 require 'pippi/checks/assert_with_nil'
 require 'pippi/checks/debug_check'

data/lib/pippi/auto_runner.rb

@@ -1,24 +1,20 @@
 module Pippi
-
   class AutoRunner
     attr_reader :ctx
 
-    def initialize(opts={})
-      checkset = opts.fetch(:checkset, "basic")
+    def initialize(opts = {})
+      checkset = opts.fetch(:checkset, 'basic')
       @ctx = Pippi::Context.new
       Pippi::CheckLoader.new(@ctx, checkset).checks.each(&:decorate)
       at_exit { dump }
     end
 
     def dump
-      File.open("log/pippi.log", "w") do |outfile|
+      File.open('log/pippi.log', 'w') do |outfile|
         @ctx.report.problems.each do |problem|
           outfile.syswrite("#{problem.to_text}\n")
         end
       end
     end
-
   end
-
 end
-

data/lib/pippi/check_loader.rb

@@ -1,13 +1,11 @@
 module Pippi
-
   class CheckLoader
-
     attr_reader :ctx, :check_names
 
     def initialize(ctx, check_names)
       @ctx = ctx
-      @check_names = if check_names.kind_of?(String)
-        Pippi::CheckSetMapper.new(check_names).check_names
+      @check_names = if check_names.is_a?(String)
+                       Pippi::CheckSetMapper.new(check_names).check_names
       else
         check_names
       end
@@ -18,6 +16,5 @@ module Pippi
         Pippi::Checks.const_get(check_name).new(ctx)
       end
     end
-
   end
 end