reek 1.2.5 → 1.2.6

data/History.txt

@@ -1,7 +1,12 @@
+== 1.2.6 (2009-11-28)
+
+=== Minor Changes
+* Corrected display of module methods to use # (#56)
+
 == 1.2.5 (2009-11-19)
 
 === Minor Changes
-* Ignores ruby_parser errors and pretneds the offending file was empty
+* Ignores ruby_parser errors and pretends the offending file was empty
 
 == 1.2.4 (2009-11-17)
 

data/features/samples.feature

@@ -13,6 +13,8 @@ Feature: Basic smell detection
     spec/samples/inline.rb -- 39 warnings (+1 masked):
       Inline declares the class variable @@directory (Class Variable)
       Inline declares the class variable @@rootdir (Class Variable)
+      Inline#self.rootdir calls env.nil? twice (Duplication)
+      Inline#self.rootdir has approx 8 statements (Long Method)
       Inline::C declares the class variable @@type_map (Class Variable)
       Inline::C has at least 13 instance variables (Large Class)
       Inline::C takes parameters [options, src] to 5 methods (Data Clump)
@@ -45,8 +47,6 @@ Feature: Basic smell detection
       Inline::C#parse_signature/block has the variable name 'x' (Uncommunicative Name)
       Inline::C#strip_comments doesn't depend on instance state (Utility Function)
       Inline::C#strip_comments refers to src more than self (Feature Envy)
-      Inline::self.rootdir calls env.nil? twice (Duplication)
-      Inline::self.rootdir has approx 8 statements (Long Method)
       Module#inline calls Inline.const_get(lang) twice (Duplication)
       Module#inline has approx 11 statements (Long Method)
       Module#inline is controlled by argument options (Control Couple)
@@ -65,70 +65,6 @@ Feature: Basic smell detection
       OptionParser tests default_pattern at least 7 times (Simulated Polymorphism)
       OptionParser tests not_style at least 3 times (Simulated Polymorphism)
       OptionParser tests s at least 7 times (Simulated Polymorphism)
-      OptionParser#CompletingHash#match/block/block is nested (Nested Iterators)
-      OptionParser#Completion::complete calls candidates.size twice (Duplication)
-      OptionParser#Completion::complete calls k.id2name twice (Duplication)
-      OptionParser#Completion::complete has approx 22 statements (Long Method)
-      OptionParser#Completion::complete has the variable name 'k' (Uncommunicative Name)
-      OptionParser#Completion::complete has the variable name 'v' (Uncommunicative Name)
-      OptionParser#Completion::complete is controlled by argument icase (Control Couple)
-      OptionParser#Completion::complete refers to candidates more than self (Feature Envy)
-      OptionParser#Completion::complete/block has the variable name 'k' (Uncommunicative Name)
-      OptionParser#Completion::complete/block has the variable name 'v' (Uncommunicative Name)
-      OptionParser#List#accept has the variable name 't' (Uncommunicative Name)
-      OptionParser#List#accept is controlled by argument pat (Control Couple)
-      OptionParser#List#accept refers to pat more than self (Feature Envy)
-      OptionParser#List#add_banner refers to opt more than self (Feature Envy)
-      OptionParser#List#complete has 4 parameters (Long Parameter List)
-      OptionParser#List#complete is controlled by argument icase (Control Couple)
-      OptionParser#List#reject has the variable name 't' (Uncommunicative Name)
-      OptionParser#List#summarize refers to opt more than self (Feature Envy)
-      OptionParser#List#update has 5 parameters (Long Parameter List)
-      OptionParser#List#update has approx 6 statements (Long Method)
-      OptionParser#List#update has the variable name 'o' (Uncommunicative Name)
-      OptionParser#List#update is controlled by argument lopts (Control Couple)
-      OptionParser#List#update is controlled by argument sopts (Control Couple)
-      OptionParser#List#update/block has the variable name 'o' (Uncommunicative Name)
-      OptionParser#ParseError#set_option is controlled by argument eq (Control Couple)
-      OptionParser#Switch#NoArgument#parse is controlled by argument arg (Control Couple)
-      OptionParser#Switch#OptionalArgument#parse is controlled by argument arg (Control Couple)
-      OptionParser#Switch#PlacedArgument#parse has approx 6 statements (Long Method)
-      OptionParser#Switch#RequiredArgument#parse is controlled by argument arg (Control Couple)
-      OptionParser#Switch#add_banner has the variable name 's' (Uncommunicative Name)
-      OptionParser#Switch#conv_arg calls conv twice (Duplication)
-      OptionParser#Switch#initialize has 7 parameters (Long Parameter List)
-      OptionParser#Switch#parse_arg calls pattern twice (Duplication)
-      OptionParser#Switch#parse_arg calls s.length twice (Duplication)
-      OptionParser#Switch#parse_arg has approx 11 statements (Long Method)
-      OptionParser#Switch#parse_arg has the variable name 'm' (Uncommunicative Name)
-      OptionParser#Switch#parse_arg has the variable name 's' (Uncommunicative Name)
-      OptionParser#Switch#self.guess has the variable name 't' (Uncommunicative Name)
-      OptionParser#Switch#self.incompatible_argument_styles has the variable name 't' (Uncommunicative Name)
-      OptionParser#Switch#summarize calls (indent + l) twice (Duplication)
-      OptionParser#Switch#summarize calls arg 4 times (Duplication)
-      OptionParser#Switch#summarize calls left.collect twice (Duplication)
-      OptionParser#Switch#summarize calls left.collect { |s| s.length }.max twice (Duplication)
-      OptionParser#Switch#summarize calls left.collect { |s| s.length }.max.to_i twice (Duplication)
-      OptionParser#Switch#summarize calls left.shift twice (Duplication)
-      OptionParser#Switch#summarize calls left[-1] 3 times (Duplication)
-      OptionParser#Switch#summarize calls s.length 3 times (Duplication)
-      OptionParser#Switch#summarize has 5 parameters (Long Parameter List)
-      OptionParser#Switch#summarize has approx 25 statements (Long Method)
-      OptionParser#Switch#summarize has the variable name 'l' (Uncommunicative Name)
-      OptionParser#Switch#summarize has the variable name 'r' (Uncommunicative Name)
-      OptionParser#Switch#summarize has the variable name 's' (Uncommunicative Name)
-      OptionParser#Switch#summarize/block has the variable name 's' (Uncommunicative Name)
-      OptionParser#Switch#summarize/block/block is nested (Nested Iterators)
-      OptionParser#block has the variable name 'f' (Uncommunicative Name)
-      OptionParser#block has the variable name 'k' (Uncommunicative Name)
-      OptionParser#block has the variable name 'o' (Uncommunicative Name)
-      OptionParser#block has the variable name 's' (Uncommunicative Name)
-      OptionParser#block is controlled by argument o (Control Couple)
-      OptionParser#block is controlled by argument s (Control Couple)
-      OptionParser#block/block has the variable name 's' (Uncommunicative Name)
-      OptionParser#block/block has the variable name 'v' (Uncommunicative Name)
-      OptionParser#block/block is controlled by argument pkg (Control Couple)
-      OptionParser#block/block is nested (Nested Iterators)
       OptionParser#complete has 4 parameters (Long Parameter List)
       OptionParser#complete is controlled by argument icase (Control Couple)
       OptionParser#complete/block/block is nested (Nested Iterators)
@@ -182,6 +118,70 @@ Feature: Basic smell detection
       OptionParser#summarize has 4 parameters (Long Parameter List)
       OptionParser#summarize/block has the variable name 'l' (Uncommunicative Name)
       OptionParser#ver has the variable name 'v' (Uncommunicative Name)
+      OptionParser/block has the variable name 'f' (Uncommunicative Name)
+      OptionParser/block has the variable name 'k' (Uncommunicative Name)
+      OptionParser/block has the variable name 'o' (Uncommunicative Name)
+      OptionParser/block has the variable name 's' (Uncommunicative Name)
+      OptionParser/block is controlled by argument o (Control Couple)
+      OptionParser/block is controlled by argument s (Control Couple)
+      OptionParser/block/block has the variable name 's' (Uncommunicative Name)
+      OptionParser/block/block has the variable name 'v' (Uncommunicative Name)
+      OptionParser/block/block is controlled by argument pkg (Control Couple)
+      OptionParser/block/block is nested (Nested Iterators)
+      OptionParser::CompletingHash#match/block/block is nested (Nested Iterators)
+      OptionParser::Completion#complete calls candidates.size twice (Duplication)
+      OptionParser::Completion#complete calls k.id2name twice (Duplication)
+      OptionParser::Completion#complete has approx 22 statements (Long Method)
+      OptionParser::Completion#complete has the variable name 'k' (Uncommunicative Name)
+      OptionParser::Completion#complete has the variable name 'v' (Uncommunicative Name)
+      OptionParser::Completion#complete is controlled by argument icase (Control Couple)
+      OptionParser::Completion#complete refers to candidates more than self (Feature Envy)
+      OptionParser::Completion#complete/block has the variable name 'k' (Uncommunicative Name)
+      OptionParser::Completion#complete/block has the variable name 'v' (Uncommunicative Name)
+      OptionParser::List#accept has the variable name 't' (Uncommunicative Name)
+      OptionParser::List#accept is controlled by argument pat (Control Couple)
+      OptionParser::List#accept refers to pat more than self (Feature Envy)
+      OptionParser::List#add_banner refers to opt more than self (Feature Envy)
+      OptionParser::List#complete has 4 parameters (Long Parameter List)
+      OptionParser::List#complete is controlled by argument icase (Control Couple)
+      OptionParser::List#reject has the variable name 't' (Uncommunicative Name)
+      OptionParser::List#summarize refers to opt more than self (Feature Envy)
+      OptionParser::List#update has 5 parameters (Long Parameter List)
+      OptionParser::List#update has approx 6 statements (Long Method)
+      OptionParser::List#update has the variable name 'o' (Uncommunicative Name)
+      OptionParser::List#update is controlled by argument lopts (Control Couple)
+      OptionParser::List#update is controlled by argument sopts (Control Couple)
+      OptionParser::List#update/block has the variable name 'o' (Uncommunicative Name)
+      OptionParser::ParseError#set_option is controlled by argument eq (Control Couple)
+      OptionParser::Switch#add_banner has the variable name 's' (Uncommunicative Name)
+      OptionParser::Switch#conv_arg calls conv twice (Duplication)
+      OptionParser::Switch#initialize has 7 parameters (Long Parameter List)
+      OptionParser::Switch#parse_arg calls pattern twice (Duplication)
+      OptionParser::Switch#parse_arg calls s.length twice (Duplication)
+      OptionParser::Switch#parse_arg has approx 11 statements (Long Method)
+      OptionParser::Switch#parse_arg has the variable name 'm' (Uncommunicative Name)
+      OptionParser::Switch#parse_arg has the variable name 's' (Uncommunicative Name)
+      OptionParser::Switch#self.guess has the variable name 't' (Uncommunicative Name)
+      OptionParser::Switch#self.incompatible_argument_styles has the variable name 't' (Uncommunicative Name)
+      OptionParser::Switch#summarize calls (indent + l) twice (Duplication)
+      OptionParser::Switch#summarize calls arg 4 times (Duplication)
+      OptionParser::Switch#summarize calls left.collect twice (Duplication)
+      OptionParser::Switch#summarize calls left.collect { |s| s.length }.max twice (Duplication)
+      OptionParser::Switch#summarize calls left.collect { |s| s.length }.max.to_i twice (Duplication)
+      OptionParser::Switch#summarize calls left.shift twice (Duplication)
+      OptionParser::Switch#summarize calls left[-1] 3 times (Duplication)
+      OptionParser::Switch#summarize calls s.length 3 times (Duplication)
+      OptionParser::Switch#summarize has 5 parameters (Long Parameter List)
+      OptionParser::Switch#summarize has approx 25 statements (Long Method)
+      OptionParser::Switch#summarize has the variable name 'l' (Uncommunicative Name)
+      OptionParser::Switch#summarize has the variable name 'r' (Uncommunicative Name)
+      OptionParser::Switch#summarize has the variable name 's' (Uncommunicative Name)
+      OptionParser::Switch#summarize/block has the variable name 's' (Uncommunicative Name)
+      OptionParser::Switch#summarize/block/block is nested (Nested Iterators)
+      OptionParser::Switch::NoArgument#parse is controlled by argument arg (Control Couple)
+      OptionParser::Switch::OptionalArgument#parse is controlled by argument arg (Control Couple)
+      OptionParser::Switch::PlacedArgument#parse has approx 6 statements (Long Method)
+      OptionParser::Switch::RequiredArgument#parse is controlled by argument arg (Control Couple)
       block has the variable name 'q' (Uncommunicative Name)
 
     """
@@ -198,8 +198,6 @@ Feature: Basic smell detection
       RedCloth tests codepre.zero? at least 3 times (Simulated Polymorphism)
       RedCloth tests href at least 3 times (Simulated Polymorphism)
       RedCloth tests title at least 4 times (Simulated Polymorphism)
-      RedCloth#block has the variable name 'a' (Uncommunicative Name)
-      RedCloth#block has the variable name 'b' (Uncommunicative Name)
       RedCloth#block_markdown_atx refers to text more than self (Feature Envy)
       RedCloth#block_markdown_bq has approx 6 statements (Long Method)
       RedCloth#block_markdown_rule refers to text more than self (Feature Envy)
@@ -288,5 +286,7 @@ Feature: Basic smell detection
       RedCloth#textile_p has 4 parameters (Long Parameter List)
       RedCloth#textile_p is controlled by argument atts (Control Couple)
       RedCloth#to_html has approx 24 statements (Long Method)
+      RedCloth/block has the variable name 'a' (Uncommunicative Name)
+      RedCloth/block has the variable name 'b' (Uncommunicative Name)
 
     """

data/features/stdin.feature

@@ -41,3 +41,19 @@ Feature: Reek reads from $stdin when no files are given
         Turn#y has the name 'y' (Uncommunicative Name)
 
       """
+
+  @stderr
+  Scenario: syntax error causes the source to be ignored
+    When I pass "def incomplete" to reek
+    Then it succeeds
+    And it reports:
+      """
+      $stdin -- 0 warnings
+
+      """
+    And stderr reports:
+      """
+      $stdin: Racc::ParseError: 
+      parse error on value "$end" ($end)
+
+      """

data/features/step_definitions/reek_steps.rb

@@ -30,6 +30,10 @@ Then /^it reports:$/ do |report|
   @last_stdout.should == report
 end
 
+Then /^stderr reports:$/ do |report|
+  @last_stderr.should == report
+end
+
 Then /^it reports the error ['"](.*)['"]$/ do |string|
   @last_stderr.chomp.should == string
 end

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.2.5'
+  VERSION = '1.2.6'
 end

data/lib/reek/adapters/source.rb

@@ -9,6 +9,16 @@ module Reek
   #
   class Source
 
+    @@err_io = $stderr
+
+    class << self
+      def err_io=(io)
+        original = @@err_io
+        @@err_io = io
+        original
+      end
+    end
+
     attr_reader :desc
 
     def initialize(code, desc, parser = RubyParser.new)
@@ -23,7 +33,7 @@ module Reek
       begin
         ast = @parser.parse(@source, @desc)
       rescue Exception => error
-        $stderr.puts "#{desc}: #{error.class.name}: #{error}"
+        @@err_io.puts "#{desc}: #{error.class.name}: #{error}"
       end
       ast ||= s()
       TreeDresser.new.dress(ast)

data/lib/reek/block_context.rb

@@ -38,6 +38,7 @@ module Reek
     def initialize(outer, exp)
       super
       @name = Name.new('block')
+      @scope_connector = '/'
       @parameters = exp[2] || []
       @parameters.extend(ParameterSet)
     end
@@ -53,10 +54,6 @@ module Reek
     def nested_block?
       @outer.inside_a_block?
     end
-
-    def outer_name
-      "#{@outer.outer_name}#{@name}/"
-    end
     
     def variable_names
       @parameters.names + @local_variables.to_a

data/lib/reek/class_context.rb

@@ -34,10 +34,6 @@ module Reek
       @instance_variables << Name.new(sym)
     end
 
-    def outer_name
-      "#{@outer.outer_name}#{@name}#"
-    end
-
     def variable_names
       @instance_variables
     end

data/lib/reek/code_context.rb

@@ -20,6 +20,7 @@ module Reek
     def initialize(outer, exp)
       @outer = outer
       @exp = exp
+      @scope_connector = ''
       @myself = nil
     end
 
@@ -42,7 +43,7 @@ module Reek
       me = @name.to_s
       strings.any? do |str|
         re = /#{str}/
-        re === me or re === self.to_s
+        re === me or re === self.full_name
       end
     end
     
@@ -58,12 +59,10 @@ module Reek
       0
     end
 
-    def outer_name
-      "#{@name}/"
-    end
-
-    def to_s
-      "#{@outer.outer_name}#{@name}"
+    def full_name
+      outer = @outer ? @outer.full_name : ''
+      prefix = outer == '' ? '' : "#{outer}#{@scope_connector}"
+      "#{prefix}#{@name}"
     end
   end
 end

data/lib/reek/if_context.rb

@@ -6,19 +6,13 @@ module Reek
     
     def initialize(outer, exp)
       super
+      @name = ''
+      @scope_connector = ''
       @if_expr = exp[1]
     end
     
     def tests_a_parameter?
       @if_expr[0] == :lvar and has_parameter(@if_expr[1])
     end
-
-    def outer_name
-      @outer.outer_name
-    end
-
-    def to_s      # SMELL: should be unnecessary :(
-      @outer.to_s
-    end
   end
 end

data/lib/reek/method_context.rb

@@ -76,6 +76,7 @@ module Reek
       @parameters ||= []
       @parameters.extend(MethodParameters)
       @name = Name.new(exp[1])
+      @scope_connector = '#'
       @num_statements = 0
       @calls = Hash.new(0)
       @depends_on_self = false
@@ -125,10 +126,6 @@ module Reek
       @depends_on_self = true
     end
 
-    def outer_name
-      "#{@outer.outer_name}#{@name}/"
-    end
-
     def envious_receivers
       return [] if @refs.self_is_max?
       @refs.max_keys

data/lib/reek/module_context.rb

@@ -21,6 +21,7 @@ module Reek
     def initialize(outer, name, exp)
       super(outer, exp)
       @name = name
+      @scope_connector = '::'
       @parsed_methods = []
     end
 
@@ -41,10 +42,6 @@ module Reek
       @parsed_methods << meth
     end
 
-    def outer_name
-      "#{@outer.outer_name}#{@name}::"
-    end
-
     def variable_names
       []
     end

data/lib/reek/singleton_method_context.rb

@@ -9,19 +9,18 @@ module Reek
       super(outer, exp)
       @name = Name.new(exp[2])
       @receiver = SexpFormatter.format(exp[1])
+      @scope_connector = ""
       record_depends_on_self
     end
 
     def envious_receivers
       []
     end
-    
-    def outer_name
-      "#{@outer.outer_name}#{@receiver}.#{@name}/"
-    end
 
-    def to_s
-      "#{@outer.outer_name}#{@receiver}.#{@name}"
+    def full_name
+      outer = @outer ? @outer.full_name : ''
+      prefix = outer == '' ? '' : "#{outer}#"
+      "#{prefix}#{@receiver}.#{@name}"
     end
   end
 end

data/lib/reek/smell_warning.rb

@@ -6,10 +6,11 @@ module Reek
   class SmellWarning
     include Comparable
 
-    def initialize(smell, context, warning, masked)
-      @detector = smell
+    def initialize(detector_class, context, line, message, masked)
+      @smell = detector_class.class.name.split(/::/)[-1]
       @context = context
-      @warning = warning
+      @line = line
+      @message = message
       @is_masked = masked
     end
 
@@ -25,28 +26,19 @@ module Reek
       (self <=> other) == 0
     end
 
-    #
-    # Returns +true+ only if this is a warning about an instance of
-    # +smell_class+ and its report string matches all of the +patterns+.
-    #
-    def matches?(smell_class, patterns)
-      return false unless smell_class.to_s == @detector.class.class_name
-      contains_all?(patterns)
-    end
-
     def contains_all?(patterns)
       rpt = sort_key.to_s
       return patterns.all? {|exp| exp === rpt}
     end
 
     def sort_key
-      [@context.to_s, @warning, @detector.smell_name]
+      [@context, @message, smell_name]
     end
 
     protected :sort_key
 
     def report(format)
-      format.gsub(/\%s/, @detector.smell_name).gsub(/\%c/, @context.to_s).gsub(/\%w/, @warning).gsub(/\%m/, @is_masked ? '(masked) ' : '')
+      format.gsub(/\%s/, smell_name).gsub(/\%c/, @context).gsub(/\%w/, @message).gsub(/\%m/, @is_masked ? '(masked) ' : '')
     end
 
     def report_on(report)
@@ -56,5 +48,9 @@ module Reek
         report.found_smell(self)
       end
     end
+
+    def smell_name
+      @smell.gsub(/([a-z])([A-Z])/) { |sub| "#{$1} #{$2}"}.split.join(' ')
+    end
   end
 end

data/lib/reek/smells/smell_detector.rb

@@ -1,12 +1,5 @@
 require 'reek/configuration'
 
-class Class
-  def name_words
-    class_name = name.split(/::/)[-1]
-    class_name.gsub(/([a-z])([A-Z])/) { |sub| "#{$1} #{$2}"}.split
-  end
-end
-
 module Reek
   module Smells
 
@@ -92,8 +85,8 @@ module Reek
         context.matches?(value(EXCLUDE_KEY, context, DEFAULT_EXCLUDE_SET))
       end
 
-      def found(scope, warning)
-        smell = SmellWarning.new(self, scope, warning, @masked)
+      def found(context, message)
+        smell = SmellWarning.new(self, context.full_name, context.exp.line, message, @masked)
         @smells_found << smell
         smell
       end
@@ -116,10 +109,6 @@ module Reek
         (not @masked) and (@smells_found.length > 0)
       end
 
-      def smell_name
-        self.class.name_words.join(' ')
-      end
-
       def value(key, ctx, fall_back)
         @config.value(key, ctx, fall_back)
       end

data/lib/reek/smells/uncommunicative_name.rb

@@ -65,11 +65,15 @@ module Reek
 
       def consider_name(context)  # :nodoc:
         name = context.name
-        return false if value(ACCEPT_KEY, context, DEFAULT_ACCEPT_SET).include?(context.to_s)  # TODO: fq_name() ?
+        return false if accept?(context)
         return false unless is_bad_name?(name, context)
         found(context, "has the name '#{name}'")
       end
 
+      def accept?(context)
+        value(ACCEPT_KEY, context, DEFAULT_ACCEPT_SET).include?(context.full_name)
+      end
+
       def is_bad_name?(name, context)  # :nodoc:
         var = name.effective_name
         return false if var == '*' or value(ACCEPT_KEY, context, DEFAULT_ACCEPT_SET).include?(var)

data/lib/reek/stop_context.rb

@@ -3,6 +3,7 @@ module Reek
     
     def initialize
       @refs = ObjectRefs.new
+      @name = ''
       @myself = Object
     end
 
@@ -18,6 +19,10 @@ module Reek
       sym = name.to_s
       @myself.const_defined?(sym) ? @myself.const_get(sym) : nil
     end
+
+    def full_name
+      ''
+    end
     
     def inside_a_block?
       false
@@ -26,9 +31,5 @@ module Reek
     def is_overriding_method?(name)
       false
     end
-    
-    def outer_name
-      ''
-    end
   end
 end

data/reek.gemspec

@@ -2,13 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.2.5"
+  s.version = "1.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-11-19}
+  s.date = %q{2009-11-28}
   s.default_executable = %q{reek}
-  s.description = %q{Code smell detector for Ruby}
+  s.description = %q{Reek is a tool that examines Ruby classes, modules and methods
+and reports any code smells it finds.
+}
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "README.rdoc"]

data/spec/reek/adapters/source_spec.rb

@@ -1,16 +1,41 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
 require 'reek/adapters/source'
+require 'stringio'
 
 include Reek
 
 describe Source do
   context 'when the parser fails' do
-    it 'returns an empty syntax tree' do
+    before :each do
+      @catcher = StringIO.new
+      @old_err_io = (Source.err_io = @catcher)
       parser = mock('parser')
-      parser.should_receive(:parse).and_raise(SyntaxError)
-      src = Source.new('', '', parser)
-      src.syntax_tree.should == s()
+      @error_message = 'Error message'
+      parser.should_receive(:parse).and_raise(SyntaxError.new(@error_message))
+      @source_name = 'Test source'
+      @src = Source.new('', @source_name, parser)
+    end
+    it 'raises a SyntaxError' do
+      @src.syntax_tree
+    end
+    it 'returns an empty syntax tree' do
+      @src.syntax_tree.should == s()
+    end
+    it 'records the syntax error' do
+      @src.syntax_tree
+      @catcher.string.should match(SyntaxError.name)
+    end
+    it 'records the source name' do
+      @src.syntax_tree
+      @catcher.string.should match(@source_name)
+    end
+    it 'records the error message' do
+      @src.syntax_tree
+      @catcher.string.should match(@error_message)
+    end
+    after :each do
+      Source.err_io = @old_err_io
     end
   end
 end

data/spec/reek/block_context_spec.rb

@@ -43,4 +43,23 @@ describe BlockContext do
     scope.record_instance_variable(:@list)
     scope.variable_names.should == [:@list]
   end
+
+  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

data/spec/reek/code_context_spec.rb

@@ -10,30 +10,37 @@ require 'reek/stop_context'
 include Reek
 
 describe CodeContext do
-  context 'to_s' do
+  context 'full_name' do
     it "reports the full context" do
       element = StopContext.new
       element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
       element = ClassContext.new(element, [0, :klass], s())
       element = MethodContext.new(element, [0, :bad])
       element = BlockContext.new(element, s(nil, nil))
-      element.to_s.should match(/bad/)
-      element.to_s.should match(/klass/)
-      element.to_s.should match(/mod/)
+      element.full_name.should match(/bad/)
+      element.full_name.should match(/klass/)
+      element.full_name.should match(/mod/)
     end
 
     it 'reports the method name via if context' do
       element1 = StopContext.new
       element2 = MethodContext.new(element1, [0, :bad])
       element3 = IfContext.new(element2, [0,1])
-      BlockContext.new(element3, s(nil, nil)).to_s.should match(/bad/)
+      BlockContext.new(element3, s(nil, nil)).full_name.should match(/bad/)
     end
 
     it 'reports the method name via nested blocks' do
       element1 = StopContext.new
       element2 = MethodContext.new(element1, [0, :bad])
       element3 = BlockContext.new(element2, s(nil, nil))
-      BlockContext.new(element3, s(nil, nil)).to_s.should match(/bad/)
+      BlockContext.new(element3, s(nil, nil)).full_name.should match(/bad/)
+    end
+    it 'includes the enclosing context name' do
+      outer_name = 'randomstring'
+      outer = mock('outer')
+      outer.should_receive(:full_name).and_return(outer_name)
+      ifc = IfContext.new(outer, s(:if, s()))
+      ifc.full_name.should == outer_name
     end
   end
 

data/spec/reek/if_context_spec.rb

@@ -5,11 +5,11 @@ require 'reek/if_context'
 include Reek
 
 describe IfContext do
-  it 'should find a class within top-level code' do
+  it 'finds a class within top-level code' do
     'unless jim; class Array; end; end'.should_not reek
   end
 
-  it 'should find class within top-level code' do
+  it 'finds class within top-level code' do
     stopctx = StopContext.new
     ifctx = IfContext.new(stopctx, [:if, [:vcall, :jim]])
     ifctx.find_module(Name.new(:Array)).should_not be_nil

data/spec/reek/module_context_spec.rb

@@ -35,4 +35,12 @@ describe ModuleContext do
     element = ModuleContext.create(StopContext.new, [:module, [:colon3, :GlobalTestModule], nil])
     element.myself.name.should == 'GlobalTestModule'
   end
+
+  context 'full_name' do
+    it "reports full context" do
+      element = StopContext.new
+      element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
+      element.full_name.should == 'mod'
+    end
+  end
 end

data/spec/reek/singleton_method_context_spec.rb

@@ -6,12 +6,11 @@ require 'reek/stop_context'
 
 include Reek
 
-describe SingletonMethodContext, 'outer_name' do
-
-  it "should report full context" do
+describe SingletonMethodContext do
+  it "reports full context" do
     element = StopContext.new
     element = ModuleContext.new(element, Name.new(:mod), s(:module, :mod, nil))
     element = SingletonMethodContext.new(element, s(:defs, s(:call, nil, :a, s(:arglist)), :b, s(:args)))
-    element.outer_name.should match(/mod::a\.b/)
+    element.full_name.should match(/mod#a\.b/)
   end
 end

data/spec/reek/smell_warning_spec.rb

@@ -5,12 +5,12 @@ require 'reek/smells/feature_envy'
 
 include Reek
 
-describe SmellWarning, 'equality' do
+describe SmellWarning do
   context 'sort order' do
     context 'smells differing only by masking' do
       before :each do
-        @first = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", false)
+        @first = SmellWarning.new(Smells::FeatureEnvy.new, "self", 27, "self", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", 27, "self", false)
       end
 
       it 'should hash equal when the smell is the same' do
@@ -46,8 +46,8 @@ describe SmellWarning, 'equality' do
 
     context 'smells differing only by detector' do
       before :each do
-        @first = SmellWarning.new(Smells::Duplication.new, "self", "self", false)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", true)
+        @first = SmellWarning.new(Smells::Duplication.new, "self", 27, "self", false)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", 27, "self", true)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -55,8 +55,8 @@ describe SmellWarning, 'equality' do
 
     context 'smells differing only by context' do
       before :each do
-        @first = SmellWarning.new(Smells::FeatureEnvy.new, "first", "self", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "second", "self", false)
+        @first = SmellWarning.new(Smells::FeatureEnvy.new, "first", 27, "self", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "second", 27, "self", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -64,8 +64,8 @@ describe SmellWarning, 'equality' do
 
     context 'smells differing only by message' do
       before :each do
-        @first = SmellWarning.new(Smells::FeatureEnvy.new, "context", "first", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", "second", false)
+        @first = SmellWarning.new(Smells::FeatureEnvy.new, "context", 27, "first", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", 27, "second", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -73,8 +73,8 @@ describe SmellWarning, 'equality' do
 
     context 'message takes precedence over smell name' do
       before :each do
-        @first = SmellWarning.new(Smells::UtilityFunction.new, "context", "first", true)
-        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", "second", false)
+        @first = SmellWarning.new(Smells::UtilityFunction.new, "context", 27, "first", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", 27, "second", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
@@ -82,14 +82,14 @@ describe SmellWarning, 'equality' do
 
     context 'smells differing everywhere' do
       before :each do
-        @first = SmellWarning.new(Smells::UncommunicativeName.new, "Dirty", "has the variable name '@s'", true)
-        @second = SmellWarning.new(Smells::Duplication.new, 'Dirty#a', "calls @s.title twice", false)
+        @first = SmellWarning.new(Smells::UncommunicativeName.new, "Dirty", 27, "has the variable name '@s'", true)
+        @second = SmellWarning.new(Smells::Duplication.new, 'Dirty#a', 27, "calls @s.title twice", false)
       end
 
       it_should_behave_like 'first sorts ahead of second'
     end
   end
-  
+
   context 'masked reporting' do
     class CountingReport
       attr_reader :masked, :non_masked
@@ -106,8 +106,8 @@ describe SmellWarning, 'equality' do
     end
 
     before :each do
-      @masked = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", true)
-      @visible = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", false)
+      @masked = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, "self", true)
+      @visible = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, "self", false)
     end
 
     it 'reports as masked when masked' do
@@ -124,4 +124,28 @@ describe SmellWarning, 'equality' do
       rpt.non_masked.should == 1
     end
   end
+
+  context 'YAML representation' do
+    before :each do
+      @message = 'message'
+      # Use a random string and a random bool
+      warning = SmellWarning.new(Smells::FeatureEnvy.new, 'Fred', 27, @message, true)
+      @yaml = warning.to_yaml
+    end
+    it 'includes the smell class' do
+      @yaml.should match(/smell:\s*FeatureEnvy/)
+    end
+    it 'includes the context' do
+      @yaml.should match(/context:\s*Fred/)
+    end
+    it 'includes the message' do
+      @yaml.should match(/message:\s*#{@message}/)
+    end
+    it 'indicates the masking' do
+      @yaml.should match(/is_masked:\s*true/)
+    end
+    it 'includes the line number' do
+      @yaml.should match(/line:\s*27/)
+    end
+  end
 end

data/spec/reek/smells/uncommunicative_name_spec.rb

@@ -119,18 +119,28 @@ EOS
   end
 end
 
-describe UncommunicativeName, '#examine' do
+describe UncommunicativeName do
   before :each do
-    @uc = UncommunicativeName.new
+    @detector = UncommunicativeName.new
   end
-  
-  it 'should return true when reporting a smell' do
-    mc = MethodContext.new(StopContext.new, s(:defn, :x, s(:args)))
-    @uc.examine(mc).should == true
+
+  context '#examine' do
+    it 'should return true when reporting a smell' do
+      mc = MethodContext.new(StopContext.new, s(:defn, :x, s(:args)))
+      @detector.examine(mc).should == true
+    end
+
+    it 'should return false when not reporting a smell' do
+      mc = MethodContext.new(StopContext.new, s(:defn, :not_bad, s(:args)))
+      @detector.examine(mc).should == false
+    end
   end
-  
-  it 'should return false when not reporting a smell' do
-    mc = MethodContext.new(StopContext.new, s(:defn, :not_bad, s(:args)))
-    @uc.examine(mc).should == false
+
+  context 'accepting names' do
+    it 'accepts Inline::C' do
+      ctx = mock('context')
+      ctx.should_receive(:full_name).and_return('Inline::C')
+      @detector.accept?(ctx).should == true
+    end
   end
 end

data/spec/reek/stop_context_spec.rb

@@ -24,4 +24,10 @@ describe StopContext do
       @stop.find_module('Reek').name.should == 'Reek'
     end
   end
+
+  context 'full_name' do
+    it "reports full context" do
+      @stop.full_name.should == ''
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +00:00
+date: 2009-11-28 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "3.0"
     version: 
-description: Code smell detector for Ruby
+description: |
+  Reek is a tool that examines Ruby classes, modules and methods
+  and reports any code smells it finds.
+
 email: 
 - kevin@rutherford-software.com
 executables: