reek 1.2.7.1 → 1.2.7.2

data/spec/reek/smells/smell_detector_shared.rb

@@ -21,7 +21,7 @@ shared_examples_for 'SmellDetector' do
 
   context 'configuration' do
     it 'becomes disabled when disabled' do
-      @detector.configure({@detector.smell_type => {SmellConfiguration::ENABLED_KEY => false}})
+      @detector.configure_with({SmellConfiguration::ENABLED_KEY => false})
       @detector.should_not be_enabled
     end
   end

data/spec/reek/smells/uncommunicative_method_name_spec.rb

@@ -15,43 +15,45 @@ describe UncommunicativeMethodName do
 
   it_should_behave_like 'SmellDetector'
 
-  it 'should not report one-word method name' do
-    'def help(fred) basics(17) end'.should_not reek
-  end
-  it 'should report one-letter method name' do
-    'def x(fred) basics(17) end'.should reek_only_of(:UncommunicativeMethodName, /x/)
-  end
-  it 'should report name of the form "x2"' do
-    'def x2(fred) basics(17) end'.should reek_only_of(:UncommunicativeMethodName, /x2/)
-  end
-  it 'should report long name ending in a number' do
-    'def method2(fred) basics(17) end'.should reek_only_of(:UncommunicativeMethodName, /method2/)
+  ['help', '+', '-', '/', '*'].each do |method_name|
+    it "accepts the method name '#{method_name}'" do
+      "def #{method_name}(fred) basics(17) end".should_not reek
+    end
   end
 
-  context 'looking at the YAML' do
-    before :each do
-      src = 'def bad3() end'
-      source = src.to_reek_source
-      sniffer = Core::Sniffer.new(source)
-      @mctx = Core::CodeParser.new(sniffer).process_defn(source.syntax_tree)
-      @detector.examine(@mctx)
-      warning = @detector.smells_found.to_a[0]   # SMELL: too cumbersome!
-      @yaml = warning.to_yaml
-    end
-    it 'reports the source' do
-      @yaml.should match(/source:\s*#{@source_name}/)
-    end
-    it 'reports the class' do
-      @yaml.should match(/\sclass:\s*UncommunicativeName/)
-    end
-    it 'reports the subclass' do
-      @yaml.should match(/subclass:\s*UncommunicativeMethodName/)
-    end
-    it 'reports the variable name' do
-      @yaml.should match(/method_name:\s*bad3/)
-    end
-    it 'reports the line number of the method def' do
-      @yaml.should match(/lines:\s*- 1/)
+  ['x', 'x2', 'method2'].each do |method_name|
+    context 'with a bad name' do
+      before :each do
+        @full_name = 'anything you like'
+        ctx = mock('method', :null_object => true)
+        ctx.should_receive(:name).and_return(method_name)
+        ctx.should_receive(:full_name).at_least(:once).and_return(@full_name)
+        ctx.should_receive(:exp).and_return(ast(:defn))
+        @detector.examine_context(ctx)
+        @smells = @detector.smells_found.to_a
+      end
+
+      it 'records only that attribute' do
+        @smells.length.should == 1
+      end
+      it 'reports the attribute name' do
+        @smells[0].smell[UncommunicativeMethodName::METHOD_NAME_KEY].should == method_name
+      end
+      it 'reports the declaration line number' do
+        @smells[0].lines.should == [1]
+      end
+      it 'reports the correct smell class' do
+        @smells[0].smell_class.should == UncommunicativeMethodName::SMELL_CLASS
+      end
+      it 'reports the correct smell subclass' do
+        @smells[0].subclass.should == UncommunicativeMethodName::SMELL_SUBCLASS
+      end
+      it 'reports the context fq name' do
+        @smells[0].context.should == @full_name
+      end
+      it 'reports the source name' do
+        @smells[0].source.should == @source_name
+      end
     end
   end
 end

data/spec/reek/smells/utility_function_spec.rb

@@ -6,6 +6,13 @@ include Reek
 include Reek::Smells
 
 describe UtilityFunction do
+  context 'with a singleton method' do
+    ['self', 'local_call', '$global'].each do |receiver|
+      it 'ignores the receiver' do
+        "def #{receiver}.simple(arga) arga.to_s + arga.to_i end".should_not reek
+      end
+    end
+  end
   context 'with no calls' do
     it 'does not report empty method' do
       'def simple(arga) end'.should_not reek

data/spec/reek/source/reference_collector_spec.rb

@@ -0,0 +1,53 @@
+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', 'source', 'reference_collector')
+
+include Reek::Source
+
+describe ReferenceCollector do
+
+  context 'counting refs to self' do
+    def refs_to_self(src)
+      ReferenceCollector.new(src.to_reek_source.syntax_tree).num_refs_to_self
+    end
+    it 'with no refs to self' do
+      refs_to_self('def no_envy(arga) arga.barg end').should == 0
+    end
+    it 'counts a call to super' do
+      refs_to_self('def simple() super; end').should == 1
+    end
+    it 'counts a local call' do
+      refs_to_self('def simple() to_s; end').should == 1
+    end
+    it 'counts a use of self' do
+      refs_to_self('def simple() lv = self; end').should == 1
+    end
+    it 'counts a call with self as receiver' do
+      refs_to_self('def simple() self.to_s; end').should == 1
+    end
+    it 'counts uses of an ivar' do
+      refs_to_self('def no_envy() @item.to_a; @item = 4; @item end').should == 3
+    end
+    it 'counts an ivar passed to a method' do
+      refs_to_self('def no_envy(arga) arga.barg(@item); arga end').should == 1
+    end
+    it 'ignores global variables' do
+      refs_to_self('def no_envy(arga) $s2.to_a; $s2[arga] end').should == 0
+    end
+    it 'ignores global variables' do
+      src = <<EOS
+    def accept(t, pat = /.*/nm, &block)
+      if pat
+        pat.respond_to?(:match) or raise TypeError, "has no `match'"
+      else
+        pat = t if t.respond_to?(:match)
+      end
+      unless block
+        block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
+      end
+      @atype[t] = [pat, block]
+    end
+EOS
+      refs_to_self(src).should == 2
+    end
+  end
+end

data/spec/reek/source/tree_dresser_spec.rb

@@ -15,6 +15,16 @@ describe TreeDresser do
   end
 end
 
+describe SexpNode do
+  context 'format' do
+    it 'formats self' do
+      @node = s(:self)
+      @node.extend(SexpNode)
+      @node.format.should == 'self'
+    end
+  end
+end
+
 describe SexpExtensions::DefnNode do
   context 'with no parameters' do
     before :each do

data/spec/reek/spec/should_reek_only_of_spec.rb

@@ -10,7 +10,7 @@ describe ShouldReekOnlyOf do
     @expected_context_name = 'SmellyClass#big_method'
     @matcher = ShouldReekOnlyOf.new(@expected_smell_class, [/#{@expected_context_name}/])
     @examiner = mock('examiner', :null_object => true)
-    @examiner.should_receive(:all_active_smells).and_return {smells}
+    @examiner.should_receive(:smells).and_return {smells}
     @match = @matcher.matches_examiner?(@examiner)
   end
 

data/spec/spec_helper.rb

@@ -10,5 +10,12 @@ end
 require 'spec/autorun'
 
 require File.join((File.dirname(File.dirname(File.expand_path(__FILE__)))), 'lib', 'reek', 'spec')
+require File.join((File.dirname(File.dirname(File.expand_path(__FILE__)))), 'lib', 'reek', 'source', 'tree_dresser')
 
 SAMPLES_DIR = 'spec/samples' unless Object.const_defined?('SAMPLES_DIR')
+
+def ast(*args)
+  result = Reek::Source::TreeDresser.new.dress(s(*args))
+  result.line = 1
+  result
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 1.2.7.1
+  version: 1.2.7.2
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-03 00:00:00 +00:00
+date: 2010-03-05 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,6 @@ files:
 - config/defaults.reek
 - features/masking_smells.feature
 - features/options.feature
-- features/profile.feature
 - features/rake_task.feature
 - features/reports.feature
 - features/samples.feature
@@ -81,7 +80,6 @@ files:
 - lib/reek/cli/report.rb
 - lib/reek/cli/version_command.rb
 - lib/reek/cli/yaml_command.rb
-- lib/reek/core/block_context.rb
 - lib/reek/core/class_context.rb
 - lib/reek/core/code_context.rb
 - lib/reek/core/code_parser.rb
@@ -122,6 +120,7 @@ files:
 - lib/reek/source/code_comment.rb
 - lib/reek/source/config_file.rb
 - lib/reek/source/core_extras.rb
+- lib/reek/source/reference_collector.rb
 - lib/reek/source/sexp_formatter.rb
 - lib/reek/source/source_code.rb
 - lib/reek/source/source_file.rb
@@ -137,7 +136,6 @@ files:
 - spec/reek/cli/report_spec.rb
 - spec/reek/cli/version_command_spec.rb
 - spec/reek/cli/yaml_command_spec.rb
-- spec/reek/core/block_context_spec.rb
 - spec/reek/core/class_context_spec.rb
 - spec/reek/core/code_context_spec.rb
 - spec/reek/core/code_parser_spec.rb
@@ -174,6 +172,7 @@ files:
 - spec/reek/smells/utility_function_spec.rb
 - spec/reek/source/code_comment_spec.rb
 - spec/reek/source/object_source_spec.rb
+- spec/reek/source/reference_collector_spec.rb
 - spec/reek/source/source_code_spec.rb
 - spec/reek/source/tree_dresser_spec.rb
 - spec/reek/spec/should_reek_of_spec.rb

data/features/profile.feature

@@ -1,34 +0,0 @@
-@profile
-Feature: Reek's configuration can be based on any number of canned profiles
-  The starting point for configuring the smell detectors can be
-  selected from a list of supplied config files.
-
-#  Scenario: XP profile reveals Attribute smells
-#    When I run reek --profile xp spec/samples/not_quite_masked/dirty.rb
-#    Then the exit status indicates smells
-#    And it reports:
-#      """
-#      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+2 masked):
-#        Dirty declares the attribute property (Attribute)
-#        Dirty has the variable name '@s' (Uncommunicative Name)
-#        Dirty#a calls @s.title twice (Duplication)
-#        Dirty#a calls puts(@s.title) twice (Duplication)
-#        Dirty#a has the name 'a' (Uncommunicative Name)
-#
-#      """
-#
-#  Scenario: XP profile works with unmasked smells
-#    When I run reek --show-all --profile xp spec/samples/not_quite_masked/dirty.rb
-#    Then the exit status indicates smells
-#    And it reports:
-#      """
-#      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+2 masked):
-#        Dirty declares the attribute property (Attribute)
-#        Dirty has the variable name '@s' (Uncommunicative Name)
-#        Dirty#a calls @s.title twice (Duplication)
-#        Dirty#a calls puts(@s.title) twice (Duplication)
-#        Dirty#a has the name 'a' (Uncommunicative Name)
-#        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
-#        (masked) Dirty#a/block/block is nested (Nested Iterators)
-#
-#      """

data/lib/reek/core/block_context.rb

@@ -1,18 +0,0 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'code_context')
-
-module Reek
-  module Core
-
-    #
-    # A context wrapper for any block found in a syntax tree.
-    #
-    class BlockContext < CodeContext
-
-      def initialize(outer, exp)
-        super
-        @name = 'block'
-        @scope_connector = '/'
-      end
-    end
-  end
-end

data/spec/reek/core/block_context_spec.rb

@@ -1,26 +0,0 @@
-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', 'core', 'block_context')
-require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core',  'method_context')
-
-include Reek::Core
-
-describe BlockContext do
-  context 'full_name' do
-    it "reports full context" do
-      bctx = BlockContext.new(StopContext.new, s(nil, nil))
-      bctx.full_name.should == 'block'
-    end
-    it 'uses / to connect to the class name' do
-      element = StopContext.new
-      element = ClassContext.new(element, :Fred, s(:class, :Fred))
-      element = BlockContext.new(element, s(:iter, nil, s(:lasgn, :x), nil))
-      element.full_name.should == 'Fred/block'
-    end
-    it 'uses / to connect to the module name' do
-      element = StopContext.new
-      element = ModuleContext.new(element, :Fred, s(:module, :Fred))
-      element = BlockContext.new(element, s(:iter, nil, s(:lasgn, :x), nil))
-      element.full_name.should == 'Fred/block'
-    end
-  end
-end