pippi 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c05baba246fbeb0947f998387800ef5e59bea9d0
-  data.tar.gz: 88364a935624811ace53ee739bf5f7bde545ad0e
+  metadata.gz: 3c24ec1b3f56f5dba07eaa8619badfc62dfcd5ab
+  data.tar.gz: ffa9fa8962b11c79dfce4047599cd5718858fce1
 SHA512:
-  metadata.gz: 8d7e3c193f1d5c74835b4eaf2e94cb5c4038a2a202ce7b89febeab9f7529ee8db5a6f49acd89f77578e16772846321898fb777502104064a72596232cbf5bbda
-  data.tar.gz: 4fa3c78158aa1469e4354e97826ccf4cba4cd41d560dfd7ca24bc00783d174d78417bd236161f1e0573eee081b798b8022ee0981ffbf967aa58592f3142d7c50
+  metadata.gz: 6161dc0accabc5bc2200c50988cb9dc1c8cbe1fd6e3d2896de5baaf0b6e9c2b3462f81b295a91436a008bec02538d16258920d61e52350139e981cf4a2f9239e
+  data.tar.gz: 17e840883462738dd6785e07e5891019f42fe24497aa72f90ca7e6906c47691fbb35e9902d2bdb66b2fd2b0410ea4586dd5c5d2120c5df3204e9195d15e26055

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.12 (2015-02-16)
+
+* (NEW) Changed output format to work better with IDEs
+
 ## 0.0.11 (2014-12-19)
 
 * [NEW] More logging options

data/README.md

@@ -7,19 +7,19 @@ Pippi is a utility for finding suboptimal Ruby class API usage.
 Consider this little array:
 
 ```ruby
-[1,2,3]
+[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
+[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}
+[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.
@@ -31,8 +31,8 @@ There are many nifty Ruby static analysis tools - flay, reek, flog, etc. This is
 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 = [1, 2, 3].select { |y| y > 1 }
+x.reject! { |y| y > 2 } if rand < 0.5
 x.first
 ```
 
@@ -83,7 +83,7 @@ Here's a [demo Rails application](https://github.com/tcopeland/pippi_demo#pippi-
 ### Rails with rspec
 
 * Add `gem 'pippi'` to the `test` group in your project's `Gemfile`
-* Add this to `spec/spec_helper.rb`, just below the `require 'rspec/rails'` line (if there is one):
+* Add this to `spec/spec_helper.rb` or `spec/rails_helper.rb`, just below the `require 'rspec/rails'` line (if there is one):
 
 ```ruby
 if ENV['USE_PIPPI'].present?
@@ -134,13 +134,13 @@ Don't use each followed by reverse; use reverse_each instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].reverse.each {|x| x+1 }
+[1, 2, 3].reverse.each { |x| x + 1 }
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].reverse_each {|x| x+1 }
+[1, 2, 3].reverse_each { |x| x + 1 }
 ```
 
 #### SelectFollowedByAny
@@ -150,13 +150,13 @@ Don't use select followed by any?; use any? with a block instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.any?
+[1, 2, 3].select { |x| x > 1 }.any?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].any? {|x| x > 1 }
+[1, 2, 3].any? { |x| x > 1 }
 ```
 
 #### SelectFollowedByEmpty
@@ -166,13 +166,13 @@ Don't use select followed by empty?; use none? instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.empty?
+[1, 2, 3].select { |x| x > 1 }.empty?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].none? {|x| x > 1 }
+[1, 2, 3].none? { |x| x > 1 }
 ```
 
 #### SelectFollowedByFirst
@@ -182,13 +182,13 @@ Don't use select followed by first; use detect instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.first
+[1, 2, 3].select { |x| x > 1 }.first
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].detect {|x| x > 1 }
+[1, 2, 3].detect { |x| x > 1 }
 ```
 
 #### SelectFollowedByNone
@@ -198,13 +198,13 @@ Don't use select followed by none?; use none? with a block instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.none?
+[1, 2, 3].select { |x| x > 1 }.none?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].none? {|x| x > 1 }
+[1, 2, 3].none? { |x| x > 1 }
 ```
 
 #### SelectFollowedBySelect
@@ -214,13 +214,13 @@ Don't use consecutive select blocks; use a single select instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.select {|x| x > 2 }
+[1, 2, 3].select { |x| x > 1 }.select { |x| x > 2 }
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 2 }
+[1, 2, 3].select { |x| x > 2 }
 ```
 
 #### SelectFollowedBySize
@@ -230,13 +230,13 @@ Don't use select followed by size; use count instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].select {|x| x > 1 }.size
+[1 ,2, 3].select { |x| x > 1 }.size
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].count {|x| x > 1 }
+[1, 2, 3].count { |x| x > 1 }
 ```
 ### buggy
 
@@ -263,13 +263,13 @@ Don't use map followed by flatten(1); use flat_map instead
 For example, rather than doing this:
 
 ```ruby
-[1,2,3].map {|x| [x,x+1] }.flatten(1)
+[1, 2, 3].map { |x| [x, x + 1] }.flatten(1)
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1,2,3].flat_map {|x| [x, x+1]}
+[1, 2, 3].flat_map { |x| [x, x + 1] }
 ```
 
 ## Ideas for other problems to detect:
@@ -377,5 +377,6 @@ rm -rf pippi_debug.log pippi.log .bundle/gems/pippi-0.0.1/ .bundle/cache/pippi-0
 * [Igor Kapkov](https://twitter.com/igasgeek)([@igas](https://github.com/igas)) documentation fixes
 * [Josh Bodah](https://github.com/jbodah): Better logging support
 * [LivingSocial](https://www.livingsocial.com/) for letting me develop and open source this utility.
+* Martin Spickermann: Better output format
 * [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/lib/pippi/problem.rb

@@ -10,7 +10,7 @@ module Pippi
 
     # TODO probably need various reporting formats
     def to_text
-      "#{file_path},#{check_class.name.split('::').last},#{line_number}"
+      "#{file_path}:#{line_number},#{demodulized_check_class_name}"
     end
 
     # TODO correct method?
@@ -21,7 +21,13 @@ module Pippi
     end
 
     def to_s
-      "#{file_path},#{check_class.name.split('::').last},#{line_number}"
+      "#{file_path}:#{line_number},#{demodulized_check_class_name}"
     end
+
+  private
+    def demodulized_check_class_name
+      check_class.name.split('::').last
+    end
+
   end
 end

data/lib/pippi/version.rb

@@ -1,3 +1,3 @@
 module Pippi
-  VERSION = '0.0.11'
+  VERSION = '0.0.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pippi
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Tom Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake