pippi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b2991c3de0e47fb2502ca50193e9c6d1d1afef7
-  data.tar.gz: 16af3bb256083ed6f0b0f9faa2410e20110590a7
+  metadata.gz: c5a74d95bf3f5630ef99c31014f3bfcc83043cab
+  data.tar.gz: d3225b55129c7c327fa963cec71a281c17f275c3
 SHA512:
-  metadata.gz: 320cd3c32751f7835f3b8213b5d51841f27400f564161b7a4e55d38db747cec4984f8d31c81c9ff63a5186f509d868407e87146210d37d620c2397db3f36b1c0
-  data.tar.gz: 44110d0bca80145d567821a6202562dac0f0757911feb983ff404932c87ad6843077ada711b37754c9bb9d4dca3e0dc268b4f7fc59dcd9ffe70033c8b15c773e
+  metadata.gz: 367327d170a40465f8df9ff8bd41efb8c673068898dce752958557cf3cdc0c28f14f3fb8f4b0c8d2efe71ac18f321010f7f6814e679c4739010297daa7ab6fe1
+  data.tar.gz: a2900f8d02ca4d99aed0f5180ba87489da2d9ca260434b7bd582d019eed30ec8f502f2c8c142a78f83d06da596d603057fc68425d768cd83530662cc442cd4e0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+Oct 22, 2014 - 0.0.2:
+Added AssertWithNil
+
 Oct 22, 2014 - 0.0.1:
 Initial release.
 

data/Gemfile.lock

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

data/README.md

@@ -1,9 +1,24 @@
 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>.
+<a href="http://thomasleecopeland.com/2014/10/22/finding-suboptimal-api-usage.html">Here's a project overview</a>.
 
 ## Checks
 
+### AssertWithNil
+
+Don't use assert_equal with nil as a first argument; use assert_nil instead
+
+For example, rather than doing this:
+
+```ruby
+x = nil ; assert_equal(nil, x)
+```
+
+Instead, consider doing this:
+
+```ruby
+x = nil ; assert_nil(x)
+
 ### MapFollowedByFlatten
 
 Don't use map followed by flatten; use flat_map instead
@@ -92,11 +107,6 @@ bundle exec ruby -rpippi/auto_runner -e "MyClass.new.exercise_some_code"
 
 ```ruby
 # Don't use select followed by compact, use select with the nil inside the block
-# Use assert_nil rather than assert_equals
-# wrong
-assert_equals(nil, foo)
-# right
-assert_nil foo
 
 # unnecessary assignment since String#strip! mutates receiver
 # wrong

data/doc/docs.md

@@ -1,4 +1,20 @@
 
+### AssertWithNil
+
+Don't use assert_equal with nil as a first argument; use assert_nil instead
+
+For example, rather than doing this:
+
+```ruby
+x = nil ; assert_equal(nil, x)
+```
+
+Instead, consider doing this:
+
+```ruby
+x = nil ; assert_nil(x)
+```
+
 ### MapFollowedByFlatten
 
 Don't use map followed by flatten; use flat_map instead

data/lib/pippi/check_set_mapper.rb

@@ -22,6 +22,7 @@ module Pippi
           "SelectFollowedByFirst",
           "SelectFollowedBySize",
           "ReverseFollowedByEach",
+          "AssertWithNil"
         ],
         "training" => [
         ],

data/lib/pippi/checks/assert_with_nil.rb

@@ -0,0 +1,43 @@
+module Pippi::Checks
+
+  class AssertWithNil < Check
+
+    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
+      end
+    end
+
+    def decorate
+      if defined?(ActiveSupport::TestCase)
+        ActiveSupport::TestCase.class_exec(self) do |my_check|
+          @_pippi_check_assert_with_nil = my_check
+          def self._pippi_other_check_assert_with_nil
+            @_pippi_check_assert_with_nil
+          end
+          def self._pippi_check_assert_with_nil
+            self.ancestors.detect {|x| x == ActiveSupport::TestCase }._pippi_other_check_assert_with_nil
+          end
+        end
+        ActiveSupport::TestCase.prepend Pippi::Checks::AssertWithNil::MyAssertEqual
+      end
+    end
+
+    class Documentation
+      def description
+        "Don't use assert_equal with nil as a first argument; use assert_nil instead"
+      end
+      def sample
+        "x = nil ; assert_equal(nil, x)"
+      end
+      def instead_use
+        "x = nil ; assert_nil(x)"
+      end
+    end
+  end
+
+end

data/lib/pippi/tasks.rb

@@ -7,7 +7,8 @@ module Pippi
       [Pippi::Checks::SelectFollowedBySize::Documentation,
        Pippi::Checks::SelectFollowedByFirst::Documentation,
        Pippi::Checks::ReverseFollowedByEach::Documentation,
-       Pippi::Checks::MapFollowedByFlatten::Documentation
+       Pippi::Checks::MapFollowedByFlatten::Documentation,
+       Pippi::Checks::AssertWithNil::Documentation,
       ].sort {|a,b| a.name <=> b.name }.each do |clz|
         obj = clz.new
         str << %Q{

data/lib/pippi/version.rb

@@ -1,3 +1,3 @@
 module Pippi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/pippi.rb

@@ -12,4 +12,5 @@ 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/assert_with_nil'
 require 'pippi/checks/debug_check'

data/test/check_test.rb

@@ -4,12 +4,12 @@ class CheckTest < MiniTest::Test
 
   CodeSample = Struct.new(:code_text, :eval_to_execute)
 
-  def assert_no_problems(str)
-    assert execute_pippi_on(foo_bar_code_sample(str)).empty?
+  def assert_no_problems(str, opts={})
+    assert execute_pippi_on(foo_bar_code_sample(str, opts[:subclass] || ""), opts).empty?
   end
 
   def assert_problems(str, opts={})
-    assert_equal opts[:count] || 1, execute_pippi_on(foo_bar_code_sample(str), opts).size
+    assert_equal opts[:count] || 1, execute_pippi_on(foo_bar_code_sample(str, opts[:subclass] || ""), opts).size
   end
 
   def output_file_name
@@ -20,8 +20,8 @@ class CheckTest < MiniTest::Test
     @tmp_code_sample_file_name ||= Tempfile.new("pippi_codesample").path
   end
 
-  def foo_bar_code_sample(code)
-    CodeSample.new.tap {|c| c.code_text = "class Foo ; def bar ; #{code} ; end ; end" ; c.eval_to_execute = "Foo.new.bar" }
+  def foo_bar_code_sample(code, subclass="")
+    CodeSample.new.tap {|c| c.code_text = "class Foo #{subclass.size > 0 ? "< #{subclass}" : ""}; def bar ; #{code} ; end ; end" ; c.eval_to_execute = "Foo.new.bar" }
   end
 
   def execute_pippi_on(code, opts={})

data/test/rails_core_extensions.rb

@@ -3,3 +3,11 @@ class Object
     self.nil? || self.size == 0
   end
 end
+
+
+module ActiveSupport
+  class TestCase
+    def assert_equal(*args)
+    end
+  end
+end

data/test/unit/assert_with_nil_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class AssertWithNilTest < CheckTest
+
+  def test_canonical_case_is_found
+    assert_problems "x = 42 ; assert_equal(nil, x)", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
+  end
+
+  def test_non_nil_first_arg_doesnt_flag
+    assert_no_problems "x = 42 ; assert_equal(42, x)", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
+  end
+
+  def test_three_arg_is_flagged
+    assert_problems "x = 42 ; assert_equal(nil, x, 'whatevs')", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pippi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Copeland
@@ -74,6 +74,7 @@ files:
 - lib/pippi/auto_runner.rb
 - lib/pippi/check_loader.rb
 - lib/pippi/check_set_mapper.rb
+- lib/pippi/checks/assert_with_nil.rb
 - lib/pippi/checks/check.rb
 - lib/pippi/checks/debug_check.rb
 - lib/pippi/checks/map_followed_by_flatten.rb
@@ -91,6 +92,7 @@ files:
 - test/check_test.rb
 - test/rails_core_extensions.rb
 - test/test_helper.rb
+- test/unit/assert_with_nil_test.rb
 - test/unit/map_followed_by_flatten_test.rb
 - test/unit/problem_test.rb
 - test/unit/report_test.rb
@@ -131,6 +133,7 @@ test_files:
 - test/check_test.rb
 - test/rails_core_extensions.rb
 - test/test_helper.rb
+- test/unit/assert_with_nil_test.rb
 - test/unit/map_followed_by_flatten_test.rb
 - test/unit/problem_test.rb
 - test/unit/report_test.rb