nitpick 1.0.0

data/spec/branch_nitpicker_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/branch_badness'
+
+include Fixtures
+
+describe Nitpick::BranchNitpicker do
+  it "should warn for a branch simply returning true and false" do
+    nitpicker = Nitpick::BranchNitpicker.new(BranchBadness, :branch_returning_true_or_false)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UselessBranch.new]
+  end
+  
+  it "should warn for identical branches" do
+    nitpicker = Nitpick::BranchNitpicker.new(BranchBadness, :branch_returning_identical_things)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::IdenticalBranch.new]
+  end
+  
+  it "should warn for assignments as conditions" do
+    nitpicker = Nitpick::BranchNitpicker.new(BranchBadness, :branch_with_assignment_as_condition)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::AssignmentAsCondition.new]
+  end
+end

data/spec/fixtures/block_badness.rb

@@ -0,0 +1,23 @@
+module Fixtures
+  class BlockBadness
+    def no_conditional_for_block_given
+      yield
+    end
+    
+    def simple_check_for_block_given
+      yield if block_given?
+    end
+    
+    def simple_conditional_without_check
+      if true
+        yield
+      end
+    end
+    
+    def complex_conditional_with_check(var)
+      if (1 + 2 == var) && block_given?
+        yield
+      end
+    end
+  end
+end

data/spec/fixtures/branch_badness.rb

@@ -0,0 +1,27 @@
+module Fixtures
+  class BranchBadness
+    def branch_returning_true_or_false
+      if 1 == 2
+        true
+      else
+        false
+      end
+    end
+    
+    def branch_returning_identical_things
+      if true
+        1 + 2
+      else
+        1 + 2
+      end
+    end
+    
+    def branch_with_assignment_as_condition
+      if a = 1
+        1
+      else
+        2
+      end
+    end
+  end
+end

data/spec/fixtures/local_variable_badness.rb

@@ -0,0 +1,113 @@
+module Fixtures
+  class LocalVariableBadness
+    def unused_lasgn
+      bar = 4
+      1 + 2
+    end
+
+    def used_lvar
+      bar = 4
+      bar + 4
+    end
+    
+    def unused_lvar
+      bar = 4
+      bar
+      1 + 2
+    end
+    
+    def lvar_with_call(foo)
+      foo.bar
+    end
+    
+    def simple_unused_arg(other)
+      -1
+    end
+    
+    def unused_arg(arg)
+      1 + 2
+    end
+    
+    def used_arg(arg)
+      arg + 4
+    end
+    
+    def lvar_with_iasgn
+      foo = 1
+      @bar = foo
+    end
+    
+    def arg_with_iasgn(arg)
+      @foo = arg
+    end
+    
+    def lvar_shadowed
+      x = 1
+      yields_to do |x|
+        something_else_happens_here
+      end
+      x + 1
+    end
+    
+    def lvar_shadowed_many_block_vars
+      x = 1
+      yields_to do |p,d,q,x|
+        something_else_happens_here
+      end
+      x + 1
+    end
+    
+    def lvar_not_shadowed
+      x = 1
+      yields_to do |y|
+        something_else_happens_here
+      end
+      x + 1
+    end
+    
+    def used_splat_arg(*args)
+      args + 4
+    end
+    
+    def args_used_with_splats(args)
+      respond(*args)
+    end
+    
+    def splat_args_used_with_splat(*args)
+      respond(*args)
+    end
+    
+    def default_args(args=false)
+      args
+    end
+    
+    def block_arg_unused(&block)
+      1 + 2
+    end
+    
+    def block_arg_called(&block)
+      block.call
+    end
+    
+    def block_arg_curried(&block)
+      respond(&block)
+    end
+    
+    def super_with_implicit_args(arg)
+      super
+    end
+    
+    def super_with_explicit_args(arg)
+      super()
+    end
+    
+    def rescue_to_variable
+      begin
+      rescue => e
+      end
+    end
+    
+    def anonymous_args(*)
+    end
+  end
+end

data/spec/fixtures/method_badness.rb

@@ -0,0 +1,10 @@
+module Fixtures
+  class MethodBadness
+    def empty_method
+    end
+    
+    def non_empty_method
+      1 + 2
+    end
+  end
+end

data/spec/fixtures/rescue_badness.rb

@@ -0,0 +1,15 @@
+module Fixtures
+  class RescueBadness
+    def rescue_nil
+      raise rescue nil
+    end
+    
+    def rescue_exception
+    rescue Exception
+    end
+    
+    def rescue_object
+    rescue Object
+    end
+  end
+end

data/spec/local_variable_nitpicker_spec.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/local_variable_badness'
+
+include Fixtures
+
+describe Nitpick::LocalVariableNitpicker do
+  it "should increment uses for an lasgn node" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :unused_lasgn)
+    nitpicker.nitpick!
+    nitpicker.uses(:bar).should == 1
+  end
+  
+  it "should increment uses for an lvar node" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :used_lvar)
+    nitpicker.nitpick!
+    nitpicker.uses(:bar).should == 2 # lvar + lasgn
+  end
+  
+  it "should create warnings for an an assigned but unused local variable" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :unused_lasgn)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UnusedVariable.new(:bar)]
+  end
+  
+  it "should not create warnings for used local variables" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :used_lvar)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not create warnings for local variables with calls" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :lvar_with_call)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not create warnings for local variables with iasgns" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :lvar_with_iasgn)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not create warnings for arguments with iasgns" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :arg_with_iasgn)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should warn when a block variable shadows a local variable" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :lvar_shadowed)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::ShadowedVariable.new(:x)]
+  end
+  
+  it "should warn when a block variable (among many) shadows a local variable" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :lvar_shadowed_many_block_vars)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::ShadowedVariable.new]
+  end
+  
+  it "should not warn when a block variable does not shadow a local variable" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :lvar_not_shadowed)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not warn when a block arg is referenced" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :block_arg_curried)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not warn when splat args are used with splats" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :splat_args_used_with_splat)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not warn about unused args" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :simple_unused_arg)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "shouldn't barf on anonymous splat args" do
+    nitpicker = Nitpick::LocalVariableNitpicker.new(LocalVariableBadness, :anonymous_args)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+end

data/spec/method_nitpicker_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/method_badness'
+
+include Fixtures
+
+describe Nitpick::MethodNitpicker do
+  it "should create a warning for an empty method" do
+    nitpicker = Nitpick::MethodNitpicker.new(MethodBadness, :empty_method)
+    nitpicker.nitpick!
+    nitpicker.warnings.include?(Nitpick::Warnings::EmptyMethod.new(:empty_method)).should be_true
+  end
+  
+  it "should not create a empty method warning for a non empty method" do
+    nitpicker = Nitpick::MethodNitpicker.new(MethodBadness, :non_empty_method)
+    nitpicker.nitpick!
+    nitpicker.warnings.any? {|w| w.is_a? Nitpick::Warnings::EmptyMethod }.should be_false
+  end
+end

data/spec/nitpicker_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/branch_badness'
+
+include Fixtures
+
+describe Nitpick::Nitpicker do
+  before do
+    @nitpicker = nitpicker = Nitpick::Nitpicker.new(BranchBadness, :branch_returning_true_or_false)
+  end
+  
+  it "should discover each of the warning classes with the correct options" do
+    warnings = [Nitpick::Warnings::UselessBranch, Nitpick::Warnings::IdenticalBranch]
+    branches = [s(:true), s(:false)]
+    warnings.each do |warning|
+      warning.should_receive(:discover).with(branches)
+    end
+    
+    @nitpicker.scan_for warnings, :with => branches
+  end
+end

data/spec/rescue_nitpicker_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/rescue_badness'
+
+include Fixtures
+
+describe Nitpick::RescueNitpicker do
+  it "should create a warning for rescuing to a value" do
+    nitpicker = Nitpick::RescueNitpicker.new(RescueBadness, :rescue_nil)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::RescueValue.new]
+  end
+  
+  it "should create a warning for rescuing Exception" do
+    nitpicker = Nitpick::RescueNitpicker.new(RescueBadness, :rescue_exception)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::RescueEverything.new]
+  end
+  
+  it "should create a warning for rescuing Object" do
+    nitpicker = Nitpick::RescueNitpicker.new(RescueBadness, :rescue_object)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::RescueEverything.new]
+  end
+   
+end

data/spec/rescue_value_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/rescue_badness'
+
+include Fixtures
+
+describe Nitpick::Warnings::RescueValue do
+
+  it "should match rescuing to a nil" do
+    warning = Nitpick::Warnings::RescueValue.new(nil, [:nil])
+    warning.matches?.should be_true
+  end
+  
+  it "should match rescuing to a lit" do
+    warning = Nitpick::Warnings::RescueValue.new(nil, [:lit, 4])
+    warning.matches?.should be_true
+  end
+  
+  it "should not match with a rescue body" do
+    exp = [nil,
+             [:block,
+              [:call, [:lit, 4], :+, [:array, [:lit, 5]]],
+              [:call, [:lit, 6], :+, [:array, [:lit, 7]]]]]
+              
+    warning = Nitpick::Warnings::RescueValue.new(*exp)
+    warning.matches?.should be_false
+  end
+end

data/spec/shadowed_variable_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/local_variable_badness'
+
+include Fixtures
+
+describe Nitpick::Warnings::ShadowedVariable do
+
+  it "should match an lasgn" do
+    warning = Nitpick::Warnings::ShadowedVariable.new(s(:lasgn, :x, nil))
+    warning.matches?.should be_true
+  end
+  
+  it "should not match when there are no assignments" do
+    warning = Nitpick::Warnings::ShadowedVariable.new(nil)
+    warning.matches?.should_not be_true
+  end
+  
+  it "should not match a block variable assignment" do
+    warning = Nitpick::Warnings::ShadowedVariable.new(s(:dasgn_curr, :y))
+    warning.matches?.should_not be_true
+  end
+  
+  it "should store the name of a shadowed variable" do
+    warning = Nitpick::Warnings::ShadowedVariable.new(s(:lasgn, :x, nil))
+    warning.matches?
+    warning.vars.should == Set.new([:x])
+  end
+  
+  it "should match and store names in multiple assignment" do
+    exp = s(:masgn, s(:array, s(:dasgn_curr, :p), s(:dasgn_curr, :d), 
+                               s(:dasgn_curr, :q), s(:lasgn, :x, nil)), nil, nil)
+    
+    warning = Nitpick::Warnings::ShadowedVariable.new(exp)
+    warning.matches?.should be_true
+    warning.vars.should == Set.new([:x])
+  end
+  
+  it "should handle splat args in multiple assignment" do
+    exp =  s(:masgn, s(:array, s(:dasgn_curr, :x), s(:dasgn_curr, :y)), s(:lasgn, :a), nil)
+    warning = Nitpick::Warnings::ShadowedVariable.new(exp)
+    warning.matches?.should be_true
+    warning.vars.should == Set.new([:a])
+  end
+  
+  it "should handle one splat arg" do
+    exp = s(:masgn, nil, s(:lasgn, :a), nil)
+    warning = Nitpick::Warnings::ShadowedVariable.new(exp)
+    warning.matches?.should be_true
+    warning.vars.should == Set.new([:a])
+  end
+  
+  it "should store the name of all shadowed variables" do
+    exp = s(:masgn, s(:array, s(:dasgn_curr, :p), s(:dasgn_curr, :d), 
+                               s(:lasgn, :q, nil), s(:lasgn, :x, nil)), nil, nil)
+    warning = Nitpick::Warnings::ShadowedVariable.new(exp)
+    warning.matches?
+    warning.vars.should == Set.new([:q, :x])
+  end
+  
+end