pippi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f1712f4957c4dc681c64b2031b42668a1965c26
-  data.tar.gz: 2e7795a1a90750cb9838dcfa37e6a83a5ea9d5d3
+  metadata.gz: 95752be642c66d479b293d0887592472cbb7a6d4
+  data.tar.gz: 80f13c0e7329c6909e2729161f09f3489d6eb8e9
 SHA512:
-  metadata.gz: d8c0198da71b5bc8ae6ce92d432374c74f97249394bfbe75c13862137d47d5864f0c8f7b43ed66084756a4677ac73f0c7dcd660df343455690330eeb5a52b5c1
-  data.tar.gz: 399fd31a5f4cb6938f2368b586902cfe7ded570ec00975d13c76eacdf90f2400a19c5f1d9afabc1efec1f6c1aa49b798a0cfa94bb874b2ded25d6e044325ab69
+  metadata.gz: 3544e1ec0e442f38f8cfb52fe05a46eb6f504af6e9ff4f25665cf1930d1f618660a8adbd5e6bb0c19c750f46b542d2afa39ff42973d67441372a1aa0cc233b50
+  data.tar.gz: a56988007f42d5ee982887c5be19a8635fea55c0813193710dec41317f0125801658f87fb09a4a27e319c6f751844219362d8bc100f47d86c909b44ab76cfbc1

data/.gitignore

@@ -1,4 +1,5 @@
-tmp/
+tmp/*
+!tmp/baz.rb
 pippi.log
 pippi_debug.log
 pippi*.gem

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+Oct 30, 2014 - 0.0.4:
+Bugfixes around method delegation
+
 Oct 22, 2014 - 0.0.3:
 Moved AssertWithNil to "buggy" checkset until I can figure out issues.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pippi (0.0.3)
+    pippi (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,48 @@
+# Pippi
+
 Pippi is a utility for finding suboptimal Ruby class API usage.
 
-<a href="http://thomasleecopeland.com/2014/10/22/finding-suboptimal-api-usage.html">Here's a project overview</a>.
+[Here's a project overview](http://thomasleecopeland.com/2014/10/22/finding-suboptimal-api-usage.html).
+
+## Usage
+
+### Rails with test-unit
+
+* Add `gem 'pippi'` to the `test` group in your project's `Gemfile`
+* Add this to `test_helper.rb` just before the `require 'rails/test_help'` line
+
+```ruby
+if ENV['USE_PIPPI'].present?
+  Pippi::AutoRunner.new(:checkset => ENV['PIPPI_CHECKSET'] || "basic")
+end
+```
+* Run it:
+
+```text
+USE_PIPPI=true 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
+
+### From the command line:
+
+Assuming you're using bundler:
+
+```bash
+# Add this to your project's Gemfile:
+gem 'pippi'
+# Run 'bundle', see some output
+# To run a particular check:
+bundle exec pippi tmp/tmpfile.rb MapFollowedByFlatten Foo.new.bar out.txt
+# Or to run all the basic Pippi checks on your code and exercise it with MyClass.new.exercise_some_code:
+bundle exec ruby -rpippi/auto_runner -e "MyClass.new.exercise_some_code"
+```
+
+
 
 ## Checksets
 
@@ -35,6 +77,7 @@ Instead, consider doing this:
 
 ```ruby
 x = nil ; assert_nil(x)
+```
 
 ### MapFollowedByFlatten
 
@@ -100,26 +143,6 @@ Instead, consider doing this:
 [1,2,3].count {|x| x > 1 }
 ```
 
-## Usage
-
-### Inside Rails tests
-
-See https://github.com/tcopeland/pippi_demo#pippi-demo
-
-### From the command line:
-
-Assuming you're using bundler:
-
-```bash
-# Add this to your project's Gemfile:
-gem 'pippi'
-# Run 'bundle', see some output
-# To run a particular check:
-bundle exec pippi tmp/tmpfile.rb MapFollowedByFlatten Foo.new.bar out.txt
-# Or to run all the basic Pippi checks on your code and exercise it with MyClass.new.exercise_some_code:
-bundle exec ruby -rpippi/auto_runner -e "MyClass.new.exercise_some_code"
-```
-
 ## Ideas for other problems to detect:
 
 ```ruby
@@ -158,20 +181,29 @@ product_path(@product)
 ````
 
 ## Here are some things that Pippi is not well suited for
-### Use self.new vs MyClass.new.  This is not a good fit for Pippi because it involves a receiver usage that can be detected with static analysis.
-#### wrong
+
+Use self.new vs MyClass.new. This is not a good fit for Pippi because it
+involves a receiver usage that can be detected with static analysis.
+
+**wrong**:
+
+```
 class Foo
   def self.bar
     Foo.new
   end
 end
-#### right
+```
+
+**right**:
+
+```
 class Foo
   def self.bar
     self.new
   end
 end
-
+```
 
 ## TODO
 
@@ -197,8 +229,20 @@ rm -rf pippi_debug.log pippi.log .bundle/gems/pippi-0.0.1/ .bundle/cache/pippi-0
 
 ```
 
+## How to do a release
+
+* Bump version number
+* Move anything from 'training' to 'buggy' or elsewhere
+* Tie off Changelog notes
+* Regenerate docs with `pippi:generate_docs`, copy and paste that into README
+* Commit, push
+* `bundle exec gem build pippi.gemspec`
+* `gem push pippi-x.gem`
+
 ## Credits
 
-* Thanks to <a href="https://www.livingsocial.com/">LivingSocial</a> for letting me develop and open source this utility.
-* Thanks to Evan Phoenix for the idea of watching method invocations at runtime using metaprogramming rather than using `Tracepoint`.
-* Thanks to Michael Bernstein (of Code Climate fame) for an inspirational discussion of code anaysis in general.
+* 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.

data/lib/pippi/check_set_mapper.rb

@@ -3,9 +3,11 @@ module Pippi
   class CheckSetMapper
 
     attr_reader :raw_check_specifier
+    attr_accessor :predefined_sets
 
     def initialize(raw_check_specifier)
       @raw_check_specifier = raw_check_specifier
+      define_standard_sets
     end
 
     def check_names
@@ -16,7 +18,8 @@ module Pippi
 
     private
 
-    def predefined_sets
+    def define_standard_sets
+      @predefined_sets =
       {
         "basic" => [
           "SelectFollowedByFirst",

data/lib/pippi/checks/assert_with_nil.rb

@@ -4,11 +4,10 @@ module Pippi::Checks
 
     module MyAssertEqual
       def assert_equal(*args)
-        result = super
         if args.size > 1 && args[0].object_id == 8
           self.class._pippi_check_assert_with_nil.add_problem
         end
-        result
+        super
       end
     end
 

data/lib/pippi/checks/check.rb

@@ -17,10 +17,11 @@ module Pippi::Checks
       ctx.report.add(Pippi::Problem.new(:line_number => problem_location.lineno, :file_path => problem_location.path, :check_class => self.class))
     end
 
-    def clear_fault_proc
-      Proc.new do
+    def clear_fault_proc(clz)
+      Proc.new do |*args, &blk|
         problem_location = caller_locations.detect {|c| c.to_s !~ /byebug|lib\/pippi\/checks/ }
-        self.class._pippi_check_select_followed_by_size.clear_fault(problem_location.lineno, problem_location.path)
+        clz.clear_fault(problem_location.lineno, problem_location.path)
+        super(*args, &blk)
       end
     end
 
@@ -29,11 +30,15 @@ module Pippi::Checks
     end
 
     def its_ok_watcher_proc(clazz, method_name)
-      Proc.new do
-        singleton_class.ancestors.detect {|x| x == clazz }.instance_eval { remove_method method_name }
-        super()
+      Proc.new do |*args, &blk|
+        begin
+          singleton_class.ancestors.detect {|x| x == clazz }.instance_eval { remove_method method_name }
+        rescue NameError
+          return super(*args, &blk)
+        else
+          return super(*args, &blk)
+        end
       end
     end
-
   end
 end

data/lib/pippi/checks/map_followed_by_flatten.rb

@@ -4,11 +4,14 @@ module Pippi::Checks
 
     module MyFlatten
       def flatten(depth=nil)
-        result = super(depth)
         if depth && depth == 1
           self.class._pippi_check_map_followed_by_flatten.add_problem
         end
-        result
+        if depth
+          super(depth)
+        else
+          super()
+        end
       end
     end
 

data/lib/pippi/checks/reverse_followed_by_each.rb

@@ -4,9 +4,8 @@ module Pippi::Checks
 
     module MyEach
       def each
-        result = super()
         self.class._pippi_check_reverse_followed_by_each.add_problem
-        result
+        super()
       end
     end
 

data/lib/pippi/checks/select_followed_by_first.rb

@@ -4,15 +4,14 @@ module Pippi::Checks
 
     module MyFirst
       def first(elements=nil)
-        result = if elements
+        unless elements
+          self.class._pippi_check_select_followed_by_first.add_problem
+        end
+        if elements
           super(elements)
         else
           super()
         end
-        unless elements
-          self.class._pippi_check_select_followed_by_first.add_problem
-        end
-        result
       end
     end
 

data/lib/pippi/checks/select_followed_by_size.rb

@@ -4,12 +4,11 @@ module Pippi::Checks
 
     module MySize
       def size
-        result = super()
         self.class._pippi_check_select_followed_by_size.add_problem
         self.class._pippi_check_select_followed_by_size.method_names_that_indicate_this_is_being_used_as_a_collection.each do |this_means_its_ok_sym|
-          define_singleton_method(this_means_its_ok_sym, self.class._pippi_check_select_followed_by_size.clear_fault_proc)
+          define_singleton_method(this_means_its_ok_sym, self.class._pippi_check_select_followed_by_size.clear_fault_proc(self.class._pippi_check_select_followed_by_size))
         end
-        result
+        super()
       end
     end
 

data/lib/pippi/version.rb

@@ -1,3 +1,3 @@
 module Pippi
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/unit/assert_with_nil_test.rb

@@ -26,6 +26,19 @@ class AssertWithNilTest < CheckTest
   # 0004 opt_send_simple  <callinfo!mid:x, argc:0, FCALL|VCALL|ARGS_SKIP>
   # 0006 opt_send_simple  <callinfo!mid:foo, argc:1, FCALL|ARGS_SKIP>
   # 0008 leave
+  # also consider
+=begin
+class Bar
+  def buz(x)
+  end
+  def foo
+    y = nil
+    buz(y)
+    RubyVM::InstructionSequence.of(method(__method__)).disasm.split("\n").each {|x| puts x }
+  end
+end
+Bar.new.foo
+=end
   def test_nil_reference_first_arg_doesnt_flag
     assert_no_problems "x = 42 ; y = nil ; assert_equal(nil, x)", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
   end

data/test/unit/check_set_mapper_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class CheckSetMapperTest < Minitest::Test
+
+  def test_should_find_predefined_sets
+    csm = Pippi::CheckSetMapper.new("basic")
+    assert csm.check_names.include?("SelectFollowedByFirst")
+  end
+
+  def test_should_allow_comma_separated_checkset_names
+    csm = Pippi::CheckSetMapper.new("a,b")
+    csm.predefined_sets = {"a" => ["foo"], "b" => ["bar"]}
+    assert csm.check_names.include?("foo")
+    assert csm.check_names.include?("bar")
+  end
+
+end

data/test/unit/select_followed_by_size_test.rb

@@ -26,8 +26,22 @@ class SelectFollowedBySizeTest < CheckTest
     assert_no_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.reject! {|x| x } ; tmp.size"
   end
 
-  def test_will_not_flag_if_method_subsequently_invokedzz
+  def test_will_not_flag_if_method_subsequently_invoked
     assert_no_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.size ; y = tmp.sort!"
   end
 
+  def test_clear_fault_proc_should_not_cause_errors_by_failing_to_return_result_of_method_invocations
+    str = <<-EOS
+tmp = [1,2,3].select {|x| x > 4 }
+tmp.size
+tmp = tmp.reject{|l| l.nil? }
+tmp.map {|x| 1 }
+EOS
+    assert_problems str
+  end
+
+  def test_clear_fault_proc_doesnt_try_to_remove_singleton_method_twice
+    assert_no_problems "tmp = [1,2,3].select {|x| x > 1 } ; y = tmp.sort! ; y = tmp.sort!"
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pippi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tom Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -93,13 +93,13 @@ files:
 - test/rails_core_extensions.rb
 - test/test_helper.rb
 - test/unit/assert_with_nil_test.rb
+- test/unit/check_set_mapper_test.rb
 - test/unit/map_followed_by_flatten_test.rb
 - test/unit/problem_test.rb
 - test/unit/report_test.rb
 - test/unit/reverse_followed_by_each_test.rb
 - test/unit/select_followed_by_first_test.rb
 - test/unit/select_followed_by_size_test.rb
-- tmp/.gitignore
 - vendor/cache/byebug-2.7.0.gem
 - vendor/cache/columnize-0.8.9.gem
 - vendor/cache/debugger-linecache-1.2.0.gem
@@ -134,6 +134,7 @@ test_files:
 - test/rails_core_extensions.rb
 - test/test_helper.rb
 - test/unit/assert_with_nil_test.rb
+- test/unit/check_set_mapper_test.rb
 - test/unit/map_followed_by_flatten_test.rb
 - test/unit/problem_test.rb
 - test/unit/report_test.rb