reek 1.3 → 1.3.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 1.3.1
+
+* (EmilRehnberg) Added smell for nil checks
+* (geoffharcourt) Updated dependencies to use ruby2ruby 2.0.2 and ruby_parser 3.1.1
+* (EmilRehnberg) Added command-line option for printing line numbers with the smell lines
+
 == 1.3
 
 * (mvz) Use new ruby_parser 3 and friends

data/config/defaults.reek

@@ -115,3 +115,6 @@ LongYieldList:
 UnusedParameters: 
   exclude: *id001
   enabled: true
+NilCheck:
+  exclude: *id001
+  enabled: true

data/features/command_line_interface/options.feature

@@ -39,6 +39,22 @@ Feature: Reek can be controlled using command-line options
 
       Report formatting:
           -q, --[no-]quiet                 Suppress headings for smell-free source files
+          -n, --line-number                Prefix the output with the line number(s).
           -y, --yaml                       Report smells in YAML format
 
       """
+
+  Scenario: output line numbers if -n flag is passed
+    When I run reek -n spec/samples/not_quite_masked/dirty.rb
+    Then the exit status indicates smells
+    And it should indicate the line numbers of those smells 
+    And it reports:
+      """
+      spec/samples/not_quite_masked/dirty.rb -- 5 warnings:
+        [7]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [6, 8]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [6, 8]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [7]:Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [5]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+
+      """

data/features/samples.feature

@@ -10,12 +10,13 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/inline.rb -- 41 warnings:
+    spec/samples/inline.rb -- 42 warnings:
       File has no descriptive comment (IrresponsibleModule)
       Inline declares the class variable @@directory (ClassVariable)
       Inline declares the class variable @@rootdir (ClassVariable)
       Inline#self.rootdir calls env.nil? twice (DuplicateMethodCall)
       Inline#self.rootdir has approx 8 statements (TooManyStatements)
+      Inline#self.rootdir performs a nil-check. (NilCheck)
       Inline::C declares the class variable @@type_map (ClassVariable)
       Inline::C has at least 13 instance variables (TooManyInstanceVariables)
       Inline::C takes parameters [options, src] to 5 methods (DataClump)
@@ -60,7 +61,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/optparse.rb -- 113 warnings:
+    spec/samples/optparse.rb -- 115 warnings:
       OptionParser has at least 42 methods (TooManyMethods)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
       OptionParser has the variable name 'k' (UncommunicativeVariableName)
@@ -99,6 +100,7 @@ Feature: Basic smell detection
       OptionParser#make_switch has the variable name 'q' (UncommunicativeVariableName)
       OptionParser#make_switch has the variable name 's' (UncommunicativeVariableName)
       OptionParser#make_switch has the variable name 'v' (UncommunicativeVariableName)
+      OptionParser#make_switch performs a nil-check. (NilCheck)
       OptionParser#order calls argv[0] twice (DuplicateMethodCall)
       OptionParser#order refers to argv more than self (FeatureEnvy)
       OptionParser#parse calls argv[0] twice (DuplicateMethodCall)
@@ -117,6 +119,7 @@ Feature: Basic smell detection
       OptionParser#permute calls argv[0] twice (DuplicateMethodCall)
       OptionParser#permute refers to argv more than self (FeatureEnvy)
       OptionParser#search has the variable name 'k' (UncommunicativeVariableName)
+      OptionParser#self.inc performs a nil-check. (NilCheck)
       OptionParser#summarize has 4 parameters (LongParameterList)
       OptionParser#summarize has the variable name 'l' (UncommunicativeVariableName)
       OptionParser#ver has the variable name 'v' (UncommunicativeVariableName)

data/features/step_definitions/reek_steps.rb

@@ -56,6 +56,10 @@ Then /^it reports a parsing error$/ do
   @last_stderr.chomp.should match(/Racc::ParseError/)
 end
 
+Then /^it should indicate the line numbers of those smells$/ do
+  @last_stdout.chomp.should match(/\[.*\]:/)
+end
+
 Then /^it reports the current version$/ do
   @last_stdout.should == "reek #{Reek::VERSION}\n"
 end

data/lib/reek/cli/command_line.rb

@@ -37,6 +37,7 @@ module Reek
         #
         # reek [options] files     List the smells in the given files
         #      -c|--config file    Specify file(s) with config options
+        #      -n|--line-number    Prefix smelly lines with line numbers
         #      -q|-[no-]quiet      Only list files that have smells
         #      files               Names of files or dirs to be checked
         #
@@ -73,6 +74,9 @@ EOB
         @parser.on("-q", "--[no-]quiet", "Suppress headings for smell-free source files") do |opt|
           @report_class = opt ? QuietReport : VerboseReport
         end
+        @parser.on("-n", "--line-number", "Prefix the output with the line number(s).") do 
+          @report_class = ShowLineReport
+        end
         @parser.on("-y", "--yaml", "Report smells in YAML format") do
           @command_class = YamlCommand
           # SMELL: the args passed to the command should be tested, because it may

data/lib/reek/cli/report.rb

@@ -54,5 +54,13 @@ module Reek
         @smell_count > 0 ? "#{header(@desc, @smell_count)}:\n#{format_list(@warnings)}\n" : ''
       end
     end
+
+    class ShowLineReport < VerboseReport
+      def format_list(warnings)
+        warnings.map do |warning|
+          "  #{warning.lines.inspect}:#{warning.context} #{warning.message} (#{warning.subclass})"
+        end.join("\n")
+      end
+    end
   end
 end

data/lib/reek/core/smell_repository.rb

@@ -20,6 +20,7 @@ module Reek
           Smells::LongParameterList,
           Smells::LongYieldList,
           Smells::NestedIterators,
+          Smells::NilCheck,
           Smells::SimulatedPolymorphism,
           Smells::UncommunicativeMethodName,
           Smells::UncommunicativeModuleName,

data/lib/reek/smells.rb

@@ -11,6 +11,7 @@ require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'long_me
 require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'long_parameter_list')
 require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'long_yield_list')
 require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'nested_iterators')
+require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'nil_check')
 require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'simulated_polymorphism')
 require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'uncommunicative_method_name')
 require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'uncommunicative_module_name')

data/lib/reek/smells/nil_check.rb

@@ -0,0 +1,86 @@
+require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+
+module Reek
+  module Smells
+
+    class NilCheck < SmellDetector
+
+      SMELL_CLASS = 'NilCheck'
+      SMELL_SUBCLASS = SMELL_CLASS
+
+      def initialize(source, config = NilCheck.default_config)
+        super(source, config)
+      end
+
+      def examine_context(ctx)
+
+        call_nodes = CallNodeFinder.new(ctx)
+        case_nodes = CaseNodeFinder.new(ctx)
+        smelly_calls = call_nodes.smelly
+        smelly_cases = case_nodes.smelly
+
+        smelly_nodes = smelly_calls + smelly_cases
+
+        smelly_nodes.map do |node|
+          SmellWarning.new(SMELL_CLASS, ctx.full_name, node.line,
+                           "performs a nil-check.",
+                           @source, SMELL_SUBCLASS )
+        end
+      end
+
+      class NodeFinder
+        SEXP_NIL = Sexp.new(:nil)
+        def initialize(ctx, type)
+          @nodes = Array(ctx.local_nodes(type))
+        end
+      end
+
+      class CallNodeFinder < NodeFinder
+        def initialize(ctx)
+          super(ctx, :call)
+        end
+
+        def smelly
+          @nodes.select{ |call|
+            nil_chk?(call) 
+          }
+        end
+
+        def nil_chk?(call)
+          nilQ_use?(call) || eq_nil_use?(call) 
+        end
+
+        def nilQ_use?(call)
+          call.last == :nil?
+        end
+
+        def eq_nil_use?(call)
+          include_eq?(call) && call.include?(SEXP_NIL)
+        end
+
+        def include_eq?(call)
+          [:==, :===].any? { |operator| call.include?(operator) }
+        end
+      end
+
+      class CaseNodeFinder < NodeFinder
+        CASE_NIL_NODE = Sexp.new(:array, SEXP_NIL)
+        def initialize(ctx)
+          super(ctx, :when)
+          end
+
+        def smelly
+          @nodes.select{ |when_node|
+            nil_chk?(when_node) 
+          }
+        end
+
+        def nil_chk?(when_node)
+          when_node.include?(CASE_NIL_NODE)
+        end
+      end
+
+    end
+  end
+end

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.3'
+  VERSION = '1.3.1'
 end

data/lib/xp.reek

@@ -61,3 +61,6 @@ LongYieldList:
   overrides: 
     initialize: 
       max_params: 5
+NilCheck:
+  exclude: []
+  enabled: true

data/reek.gemspec

@@ -25,9 +25,9 @@ and reports any code smells it finds.
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Code smell detector for Ruby}
 
-  s.add_runtime_dependency(%q<ruby_parser>, ["~> 3.0.4"])
+  s.add_runtime_dependency(%q<ruby_parser>, ["~> 3.1.1"])
   s.add_runtime_dependency(%q<sexp_processor>)
-  s.add_runtime_dependency(%q<ruby2ruby>, ["~> 2.0.0"])
+  s.add_runtime_dependency(%q<ruby2ruby>, ["~> 2.0.2"])
 
   s.add_development_dependency(%q<bundler>, ["~> 1.1"])
   s.add_development_dependency(%q<rake>)

data/spec/reek/smells/nil_check_spec.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smells', 'nil_check')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_detector_shared')
+
+include Reek
+include Reek::Smells
+
+describe NilCheck do
+
+  context 'for methods' do
+
+    it 'should report nothing when scope includes no nil checks' do
+      'def no_nils; end'.should_not smell_of(NilCheck)
+    end
+
+    it 'should report when scope uses multiple nil? methods' do
+      src = <<-eos
+      def chk_multi_nil(para) 
+        para.nil? 
+        puts "Hello"
+        \"\".nil? 
+      end
+      eos
+      src.should smell_of(NilCheck, 
+                          {NilCheck => nil}, {NilCheck => nil})
+    end
+
+    it 'should report twice when scope uses == nil and === nil' do
+      src= <<-eos
+      def chk_eq_nil(para)
+        para == nil
+        para === nil
+      end
+      eos
+      src.should smell_of(NilCheck,
+                          {NilCheck => nil}, {NilCheck => nil})
+    end
+
+    it 'should report when scope uses nil ==' do
+      'def chk_eq_nil_rev(para); nil == para; end'.should smell_of(NilCheck)
+    end
+
+    it 'should report when scope uses multiple case-clauses checking nil' do
+      src = <<-eos
+      def caseNil 
+        case @inst_var 
+        when nil then puts "Nil" 
+        end
+        puts "Hello"
+        case @inst_var2
+        when 1 then puts 1
+        when nil then puts nil.inspect
+        end
+      end 
+      eos
+      src.should smell_of(NilCheck,
+                          {NilCheck => nil}, {NilCheck => nil})
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 3
-  version: "1.3"
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -16,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-19 00:00:00 Z
+date: 2013-02-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -26,12 +27,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 1
         segments: 
         - 3
-        - 0
-        - 4
-        version: 3.0.4
+        - 1
+        - 1
+        version: 3.1.1
   requirement: *id001
   type: :runtime
 - !ruby/object:Gem::Dependency 
@@ -56,12 +57,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 11
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        - 2
+        version: 2.0.2
   requirement: *id003
   type: :runtime
 - !ruby/object:Gem::Dependency 
@@ -194,6 +195,7 @@ files:
 - lib/reek/smells/attribute.rb
 - lib/reek/smells/simulated_polymorphism.rb
 - lib/reek/smells/uncommunicative_method_name.rb
+- lib/reek/smells/nil_check.rb
 - lib/reek/smells/class_variable.rb
 - lib/reek/smells/long_parameter_list.rb
 - lib/reek/smells/feature_envy.rb
@@ -261,6 +263,7 @@ files:
 - spec/reek/smells/nested_iterators_spec.rb
 - spec/reek/smells/behaves_like_variable_detector.rb
 - spec/reek/smells/large_class_spec.rb
+- spec/reek/smells/nil_check_spec.rb
 - spec/reek/smells/irresponsible_module_spec.rb
 - spec/reek/smells/uncommunicative_variable_name_spec.rb
 - spec/reek/smell_warning_spec.rb