kevinrutherford-reek 1.1.3.8 → 1.1.3.9

data/History.txt

@@ -9,6 +9,7 @@
 ** Reports for multiple sources are run together; no more blank lines
 * The smells masked by *.reek config files can now be seen:
 ** The header for each source file now counts masked smells
+** The --show-all (-a) option shows masked warnings in the report
 
 === Minor Changes
 * Several changes to the LongMethod counting algorithm:

data/features/masking_smells.feature

@@ -40,3 +40,30 @@ Feature: Masking smells using config files
         Dirty#a/block/block is nested (Nested Iterators)
 
       """
+
+  Scenario: switch off one smell but show all in the report
+    When I run reek --show-all spec/samples/masked/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+        (masked) Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty#a calls @s.title multiple times (Duplication)
+        Dirty#a calls puts(@s.title) multiple times (Duplication)
+        (masked) Dirty#a has the name 'a' (Uncommunicative Name)
+        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """
+
+  Scenario: switch off one smell and show hide them in the report
+    When I run reek --no-show-all spec/samples/masked/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+        Dirty#a calls @s.title multiple times (Duplication)
+        Dirty#a calls puts(@s.title) multiple times (Duplication)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """

data/features/options.feature

@@ -18,3 +18,24 @@ Feature: Reek can be controlled using command-line options
     When I run reek --version
     Then it succeeds
     And it reports the current version
+
+  Scenario: display the help information
+    When I run reek --help
+    Then it succeeds
+    And it reports:
+      """
+      Usage: reek [options] files...
+
+      If no files are given, Reek reads source code from standard input.
+      See http://wiki.github.com/kevinrutherford/reek for detailed help.
+
+
+      Options:
+          -a, --[no-]show-all              Show all smells, including those masked by config settings
+          -h, --help                       Show this message
+          -f, --format FORMAT              Specify the format of smell warnings
+          -c, --context-first              Sort by context; sets the format string to "%m%c %w (%s)"
+          -s, --smell-first                Sort by smell; sets the format string to "%m[%s] %c %w"
+          -v, --version                    Show version
+
+      """

data/lib/reek/options.rb

@@ -5,12 +5,13 @@ module Reek
     
   class Options
 
-    CTX_SORT = '%c %w (%s)'
-    SMELL_SORT = '[%s] %c %w'
+    CTX_SORT = '%m%c %w (%s)'
+    SMELL_SORT = '%m[%s] %c %w'
 
     def self.default_options
       {
-        :format => CTX_SORT
+        :format => CTX_SORT,
+        :show_all => false
       }
     end
     
@@ -26,7 +27,7 @@ module Reek
       parser.parse!(args)
       result
     end
-    
+
     def self.set_options(opts, config)
       opts.banner = <<EOB
 Usage: #{opts.program_name} [options] files...
@@ -36,9 +37,7 @@ See http://wiki.github.com/kevinrutherford/reek for detailed help.
 EOB
       
       opts.separator "\nOptions:"
-      set_help_option(opts)
-      set_sort_option(config, opts)
-      set_version_option(opts)
+      set_all_options(opts, config)
     end
 
     def self.parse(args)
@@ -51,6 +50,13 @@ EOB
     end
 
   private
+
+    def self.set_all_options(opts, config)
+      set_show_all_option(opts, config)
+      set_help_option(opts)
+      set_sort_option(config, opts)
+      set_version_option(opts)
+    end
     
     def self.set_version_option(opts)
       opts.on("-v", "--version", "Show version") do
@@ -59,6 +65,12 @@ EOB
       end
     end
 
+    def self.set_show_all_option(opts, config)
+      opts.on("-a", "--[no-]show-all", "Show all smells, including those masked by config settings") do |opt|
+        config[:show_all] = opt
+      end
+    end
+
     def self.set_help_option(opts)
       opts.on("-h", "--help", "Show this message") do
         puts opts

data/lib/reek/report.rb

@@ -7,8 +7,8 @@ module Reek
     include Enumerable
 
     def initialize(sniffer = nil)  # :nodoc:
-      @masked_smells = SortedSet.new
-      @report = SortedSet.new
+      @masked_warnings = SortedSet.new
+      @warnings = SortedSet.new
       sniffer.report_on(self) if sniffer
     end
 
@@ -16,7 +16,7 @@ module Reek
     # Yields, in turn, each SmellWarning in this report.
     #
     def each
-      @report.each { |smell| yield smell }
+      @warnings.each { |smell| yield smell }
     end
 
     #
@@ -24,56 +24,58 @@ module Reek
     # only if one of them has a report string matching all of the +patterns+.
     #
     def has_smell?(smell_class, patterns)
-      @report.any? { |smell| smell.matches?(smell_class, patterns) }
+      @warnings.any? { |smell| smell.matches?(smell_class, patterns) }
     end
 
     def <<(smell)  # :nodoc:
-      @report << smell
+      @warnings << smell
       true
     end
 
     def record_masked_smell(smell)
-      @masked_smells << smell
+      @masked_warnings << smell
     end
 
     def num_masked_smells
-      @masked_smells.length
+      @masked_warnings.length
     end
     
     def empty?
-      @report.empty?
+      @warnings.empty?
     end
 
     def length
-      @report.length
+      @warnings.length
     end
     
     alias size length
 
-    def [](index)  # :nodoc:
-      @report.to_a[index]
-    end
-
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report, with a heading.
     def full_report(desc)
-      result = header(desc, @report.length)
-      result += ":\n#{to_s}" if length > 0
+      result = header(desc, @warnings.length)
+      result += ":\n#{to_s}" if should_report
       result += "\n"
       result
     end
 
+    def should_report
+      @warnings.length > 0 or (Options[:show_all] and @masked_warnings.length > 0)
+    end
+
     def header(desc, num_smells)
       result = "#{desc} -- #{num_smells} warning"
       result += 's' unless num_smells == 1
-      result += " (+#{@masked_smells.length} masked)" unless @masked_smells.empty?
+      result += " (+#{@masked_warnings.length} masked)" unless @masked_warnings.empty?
       result
     end
 
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report.
     def to_s
-      @report.map {|smell| "  #{smell.report}"}.join("\n")
+      all = SortedSet.new(@warnings)
+      all.merge(@masked_warnings) if Options[:show_all]
+      all.map {|smell| "  #{smell.report}"}.join("\n")
     end
   end
 

data/lib/reek/smell_warning.rb

@@ -9,17 +9,18 @@ module Reek
     include Comparable
 
     def initialize(smell, context, warning)
-      @smell = smell
+      @detector = smell
       @context = context
       @warning = warning
+      @is_masked = smell.masked?
     end
 
     def hash  # :nodoc:
-      report.hash
+      basic_report.hash
     end
 
     def <=>(other)
-      report <=> other.report
+      basic_report <=> other.basic_report
     end
 
     alias eql? <=>  # :nodoc:
@@ -29,21 +30,26 @@ module Reek
     # +smell_class+ and its report string matches all of the +patterns+.
     #
     def matches?(smell_class, patterns)
-      return false unless smell_class.to_s == @smell.class.class_name
+      return false unless smell_class.to_s == @detector.class.class_name
       rpt = report
       return patterns.all? {|exp| exp === rpt}
     end
 
+    def basic_report
+      Options[:format].gsub(/\%s/, @detector.smell_name).gsub(/\%c/, @context.to_s).gsub(/\%w/, @warning)
+    end
+
     #
     # Returns a copy of the current report format (see +Options+)
     # in which the following magic tokens have been substituted:
     #
-    # * %s <-- the name of the smell that was detected
     # * %c <-- a description of the +CodeContext+ containing the smell
+    # * %m <-- "(is_masked) " if this is a is_masked smell
+    # * %s <-- the name of the smell that was detected
     # * %w <-- the specific problem that was detected
     #
     def report
-      Options[:format].gsub(/\%s/, @smell.smell_name).gsub(/\%c/, @context.to_s).gsub(/\%w/, @warning)
+      basic_report.gsub(/\%m/, @is_masked ? '(masked) ' : '')
     end
   end
 end

data/lib/reek/smells/smell_detector.rb

@@ -58,6 +58,10 @@ module Reek
         @masked = true
       end
 
+      def masked?
+        @masked
+      end
+
       def enabled?
         @config[ENABLED_KEY]
       end

data/lib/reek.rb

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

data/reek.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3.8"
+  s.version = "1.1.3.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]

data/spec/reek/smell_warning_spec.rb

@@ -4,7 +4,7 @@ require 'reek/smells/smells'
 
 include Reek
 
-describe SmellWarning, ' in comparisons' do
+describe SmellWarning, 'equality' do
   before :each do
     @first = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self")
     @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self")

data/spec/slow/optparse_spec.rb

@@ -62,7 +62,6 @@ describe 'sample gem source code' do
     ruby.should reek_of(:LongMethod, /OptionParser#parse_in_order/)
     ruby.should reek_of(:LongParameterList, /OptionParser#List#complete/)
     ruby.should reek_of(:LongParameterList, /OptionParser#List#update/)
-    ruby.should reek_of(:LongParameterList, /OptionParser#Switch#initialize/)
     ruby.should reek_of(:LongParameterList, /OptionParser#Switch#summarize/)
     ruby.should reek_of(:LongParameterList, /OptionParser#complete/)
     ruby.should reek_of(:LongParameterList, /OptionParser#summarize/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3.8
+  version: 1.1.3.9
 platform: ruby
 authors: 
 - Kevin Rutherford