nitpick 1.0.0

data/lib/nitpick/rescue_nitpicker.rb

@@ -0,0 +1,15 @@
+module Nitpick
+  class RescueNitpicker < Nitpicker
+    def process_resbody(exp)
+      exceptions = exp.shift
+      rescue_value = exp.shift
+      
+      scan_for [Warnings::RescueValue, Warnings::RescueEverything],
+           :with => [exceptions, rescue_value]
+      
+      exp.clear
+
+      s(:resbody, exceptions, rescue_value)
+    end
+  end
+end

data/lib/nitpick/sexp_extension.rb

@@ -0,0 +1,7 @@
+module Nitpick
+  module SexpExtension
+    define_method :"!~" do |pattern|
+      !(self =~ pattern)
+    end
+  end
+end

data/lib/nitpick/warnings/assignment_as_condition.rb

@@ -0,0 +1,22 @@
+module Nitpick
+  module Warnings
+    class AssignmentAsCondition < SimpleWarning
+      ASSIGNMENT_NODES = [:lasgn, :op_asgn_or, :op_asgn_and, :iasgn,
+                          :op_asgn1, :gasgn, :dasgn_curr]
+      
+      attr_reader :condition
+      
+      def initialize(*args)
+        @condition = args.shift
+      end
+        
+      def matches?
+        ASSIGNMENT_NODES.include? @condition.first
+      end
+
+      def message
+        "An assigment is being used as a condition: (#{sexp_to_ruby(@condition)})"
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/empty_method.rb

@@ -0,0 +1,19 @@
+module Nitpick
+  module Warnings
+    class EmptyMethod < SimpleWarning
+      attr_reader :body
+  
+      def initialize(*args)
+        @name, @args, @body = args
+      end
+    
+      def matches?
+        @body == [:nil]
+      end
+      
+      def message
+        "The method #{@name.inspect} is empty."
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/identical_branch.rb

@@ -0,0 +1,18 @@
+module Nitpick
+  module Warnings
+    class IdenticalBranch < SimpleWarning
+      attr_reader :yes_branch, :no_branch
+      def initialize(*args)
+        @cond, @yes_branch, @no_branch = args
+      end
+        
+      def matches?
+        yes_branch == no_branch
+      end
+      
+      def message
+        "The branches of 'if (#{sexp_to_ruby(@cond)})' are identical."
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/rescue_everything.rb

@@ -0,0 +1,20 @@
+module Nitpick
+  module Warnings
+    class RescueEverything < SimpleWarning
+      def initialize(*args)
+        @exceptions, @rescue_value = args
+      end
+      
+      def matches?
+        return false unless @exceptions
+        [:Object, :Exception].find do |const|
+          @exceptions.include? [:const, const]
+        end
+      end
+      
+      def message
+        "A rescue is capturing Object or Exception, which may hide errors."
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/rescue_value.rb

@@ -0,0 +1,22 @@
+module Nitpick
+  module Warnings
+    class RescueValue < SimpleWarning
+      def initialize(*args)
+        @exceptions, *@rescue_value = args
+      end
+      
+      def matches?
+        return false if @rescue_value.nil?
+        return false if @rescue_value.size > 1
+        return false if @rescue_value.empty?
+        val = @rescue_value.first
+        return false if val.nil? or val.empty?
+        [:lit, :nil].include? val.first # the value's type
+      end
+      
+      def message
+        "A rescue is returning #{sexp_to_ruby(@rescue_value.first).inspect} directly and may not handle an error."
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/shadowed_variable.rb

@@ -0,0 +1,51 @@
+require 'set'
+
+module Nitpick
+  module Warnings
+    class ShadowedVariable < SimpleWarning
+      attr_reader :vars
+      
+      # ShadowedVariable.new takes one or more block variable assignment sexps
+      def initialize(*args)
+        @block_vars = args.shift
+        @vars = Set.new
+      end
+        
+      def matches?
+        case @block_vars && @block_vars.first
+        when :masgn
+          matched = false
+          #                     label,  args,                                     splats,       ..
+          # :masgns look like [:masgn, [:array, [:dasgn_curr, :x]],               [:lasgn, :a], nil]
+          #         or        [:masgn, nil,                                       [:lasgn, :a], nil]
+          #         or        [:masgn, [:array, [:dasgn_curr, :x], [:lasgn, :a]], nil,          nil]
+          
+          to_check = []
+          
+          assigns = @block_vars[1].deep_clone
+          if assigns
+            assigns.shift # bump the array
+            to_check += assigns
+          end
+          
+          to_check += s(@block_vars[2].deep_clone) if @block_vars[2]
+          
+          to_check.each do |sexp|
+            next unless sexp.first == :lasgn
+            vars << sexp[1]
+            matched = true
+          end
+          
+          matched
+        when :lasgn
+          vars << @block_vars[1]
+          true
+        end
+      end
+      
+      def message
+        "One or more variables are being shadowed (#{@vars.to_a.join(',')})"
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/simple_warning.rb

@@ -0,0 +1,28 @@
+module Nitpick
+  module Warnings
+    class SimpleWarning
+      def self.discover(args = [])
+        warning = new(*args)
+        warning if warning.matches?
+      end
+      
+      def matches?
+        false
+      end
+      
+      def ==(other)
+        other.is_a? self.class
+      end
+      
+      def message
+        raise NotImplementedError
+      end
+      
+      private
+      
+        def sexp_to_ruby(sexp)
+          Ruby2Ruby.new.process(Unifier.new.process(sexp))
+        end
+    end
+  end
+end

data/lib/nitpick/warnings/unprotected_block.rb

@@ -0,0 +1,24 @@
+module Nitpick
+  module Warnings
+    class UnprotectedBlock < SimpleWarning
+      attr_reader :condition, :yes_branch, :no_branch
+      
+      def initialize(*args)
+        @condition, @yes_branch, @no_branch = args
+      end
+      
+      def matches?
+        # raise "YES: #{yes_branch.inspect}"
+        yes_branch =~ s(:yield) && condition !~ s(:fcall, :block_given?)
+      end
+      
+      def ==(other)
+        yes_branch == other.yes_branch && no_branch == other.no_branch
+      end
+      
+      def message
+        "A block is being yielded to without a check for block_given?"
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/unused_argument.rb

@@ -0,0 +1,19 @@
+module Nitpick
+  module Warnings
+    class UnusedArgument < SimpleWarning
+      attr_reader :argument
+
+      def initialize(arg)
+        @argument = arg
+      end
+
+      def ==(other)
+        @argument == other.argument
+      end
+      
+      def message
+        "The argument #{@argument.inspect} is unused."
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/unused_variable.rb

@@ -0,0 +1,19 @@
+module Nitpick
+  module Warnings
+    class UnusedVariable < SimpleWarning
+      attr_reader :variable
+
+      def initialize(variable)
+        @variable = variable
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && @variable == other.variable
+      end
+      
+      def message
+        "The variable #{@variable.inspect} is unused."
+      end
+    end
+  end
+end

data/lib/nitpick/warnings/useless_branch.rb

@@ -0,0 +1,20 @@
+module Nitpick
+  module Warnings
+    class UselessBranch < SimpleWarning
+      attr_reader :yes_branch, :no_branch
+  
+      def initialize(*args)
+        @cond, @yes_branch, @no_branch = args
+      end
+    
+      def matches?
+        (yes_branch == s(:true) and no_branch == s(:false)) or
+          (yes_branch == s(:false) and no_branch == s(:true))
+      end
+      
+      def message
+        "No need for an if. Just return '#{sexp_to_ruby(@cond)}' as a boolean."
+      end
+    end
+  end
+end

data/spec/argument_nitpicker_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/local_variable_badness'
+require 'fixtures/block_badness'
+
+include Fixtures
+
+describe Nitpick::ArgumentNitpicker do
+  it "should create warnings for an unreferenced argument" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :unused_arg)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UnusedArgument.new(:arg)]
+  end
+  
+  it "should not create warnings for a referenced argument" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :used_arg)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not create warnings for splat args" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :used_splat_arg)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should not create warnings when calling super with no explicit arguments" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :super_with_implicit_args)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should create warnings when calling super with explicit arguments" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :super_with_explicit_args)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UnusedArgument.new(:arg)]
+  end
+  
+  it "should create warnings when calling super with explicit arguments but without referencing the passed arguments" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :super_with_explicit_args)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UnusedArgument.new(:arg)]
+  end
+  
+  it "should not create warnings for args used with splats" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :args_used_with_splats)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should ignore [:block] arguments in args" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :default_args)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should handle &block in args when called" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :block_arg_called)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should handle &block in args when curried" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :block_arg_curried)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should warn when &block in args is unused" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :block_arg_unused)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UnusedArgument.new(:block)]
+  end
+  
+  it "shouldn't warn on non-argument variables" do
+    nitpicker = Nitpick::ArgumentNitpicker.new(LocalVariableBadness, :rescue_to_variable)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+end

data/spec/assignment_as_condition_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/branch_badness'
+
+include Fixtures
+
+describe Nitpick::Warnings::AssignmentAsCondition do
+  it "should match against an assignment" do
+    # TODO(kevinclark): 
+    #   This should really include :dasgn, :cvasgn, and :op_asgn2,
+    #   but I can't figure out how they show up in the AST.
+    
+    matches = {
+      "a = 1" => s(:lasgn, :a, s(:lit, 1)),
+      "a ||= 2" => s(:op_asgn_or,  s(:lvar, :a), s(:lasgn, :a, s(:lit, 2))),
+      "a &&= 3" => s(:op_asgn_and, s(:lvar, :a), s(:lasgn, :a, s(:lit, 2))),
+      "@a = 4" => s(:iasgn, :@a, s(:lit, 4)),
+      "a[0] ||= 5" => s(:op_asgn1, s(:vcall, :a), s(:array, s(:lit, 0)), :"||", s(:lit, 1)),
+      "$a = 6" => s(:gasgn, :$a, s(:lit, 1)),
+      "a = 7 # in a block" => s(:dasgn_curr, :a, s(:lit, 1))
+    }
+        
+    matches.each do |_, assignment|
+      warning = Nitpick::Warnings::AssignmentAsCondition.new(assignment)
+      warning.matches?.should be_true
+    end
+  end
+  
+  it "shouldn't match against nodes that aren't an assignment" do
+    non_matches = {
+      "a == 1" => s(:call, s(:vcall, :a), :==, s(:array, s(:lit, 1))),
+      "a.nil?" => s(:call, s(:vcall, :a), :nil?),
+      "a" => s(:vcall, :a),
+      "a(b,c,d)" => s(:fcall, :a, s(:array, s(:vcall, :b), s(:vcall, :c), s(:vcall, :d)))
+    }
+    
+    non_matches.each do |_, condition|
+      warning = Nitpick::Warnings::AssignmentAsCondition.new(condition)
+      warning.matches?.should be_false
+    end
+  end
+end

data/spec/block_nitpicker_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'fixtures/block_badness'
+
+include Fixtures
+
+describe Nitpick::BlockNitpicker do
+  it "should warn when a yield is present without a conditional" do
+    nitpicker = Nitpick::BlockNitpicker.new(BlockBadness, :no_conditional_for_block_given)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == [Nitpick::Warnings::UnprotectedBlock.new]
+  end
+  
+  it "should not warn when there is a check for block_given? before yield" do
+    nitpicker = Nitpick::BlockNitpicker.new(BlockBadness, :simple_check_for_block_given)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+  
+  it "should warn when there is a yield in a conditional without a block_given? check" do
+    nitpicker = Nitpick::BlockNitpicker.new(BlockBadness, :simple_conditional_without_check)
+    nitpicker.nitpick!
+    nitpicker.warnings.size.should == 1
+    nitpicker.warnings.first.should be_a_kind_of(Nitpick::Warnings::UnprotectedBlock)
+  end
+  
+  it "should not warn when there is a check for block_given? in a complex conditional before yield" do
+    nitpicker = Nitpick::BlockNitpicker.new(BlockBadness, :complex_conditional_with_check)
+    nitpicker.nitpick!
+    nitpicker.warnings.should == []
+  end
+end