reek 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d10cc19d7d47e9a5094aaf117aac55072abe9064
-  data.tar.gz: db2544839858ea0cad619f8bef26c77e0ebb9745
+  metadata.gz: 02b11e29be1e78d0ca3b5c5bb7e209d215a34142
+  data.tar.gz: 2fbda696128728c307a65abe0c61479bccc197ea
 SHA512:
-  metadata.gz: 0b29e3d3b6fcdcd5399b3d6faa881c88a226626589f5fff426c62e550c836b53b74280117a0dd9e362a9921b5fac4b2b86762714388d5a48ed425b0425c703e5
-  data.tar.gz: 7bc7a0108f69942487dc213fa76a5f43c09780d8c162151c0a66351aaa5520cafc2c4de5946050034827b3c6dcea5ad7abe728e709c6481efd62c0031df1b732
+  metadata.gz: 08a97e6cba42ad58c4f6691d89cf4267ce79777095766859421ef6853b98f51c44521988f977e2d78d6dd1ebcdb56bc9b88e53e1fdc0af204f1aba22fe38be8c
+  data.tar.gz: 6074cc6366979c9e75722d8359fbdba75a2539eba9b3ffad21b5eaee59fa4ae7789d717ea6044b128577ccf13010a49caf69156eef34f239594cc592354eb2d1

data/.gitignore

@@ -11,3 +11,4 @@ Gemfile.lock
 tags
 .pryrc
 .tags*
+.DS_Store

data/.travis.yml

@@ -13,8 +13,8 @@ rvm:
   - ruby-head
 matrix:
   include:
-    - rvm: jruby-19mode
-      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
+    - rvm: jruby
+      env: JRUBY_OPTS='--2.0 --server -Xcompile.invokedynamic=false'
     - rvm: jruby-head
       env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
   allow_failures:

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 3.0.4
+
+* (troessner) Fix wiki-link cli option.
+
 == 3.0.3
 
 * (troessner) Fix finding sources when using just the current directory.

data/CONTRIBUTING.md

@@ -45,13 +45,7 @@ bundle
 bundle exec rake
 ```
 
-Once you’re sure your copy of reek works (and that there are no
-failing tests on the "develop" branch) create your own branch from our "develop" branch.
-
-We are using the popular [gitflow branch model](http://nvie.com/posts/a-successful-git-branching-model/) and
-require contributions to follow to this model as well.
-This probably sounds more complicated than it is, for you this just means that you should branch off
-of our "develop" branch for your pull request, not master (which is the default already):
+Once you’re sure your copy of reek works create your own feature branch from our "master" branch:
 
 ```
 git checkout -b your_feature_or_fix_name
@@ -81,8 +75,6 @@ Then go to your GitHub fork and [make a pull
 request](https://help.github.com/articles/creating-a-pull-request/)
 to the original repository.
 
-
-
 ## Review and Fixes
 
 Try to gauge and let us know in the pull request whether what
@@ -105,7 +97,15 @@ If there were any fixes to your pull request we’ll ask you to
 all of the commits into one:
 
 ```
-git rebase -i develop
+git rebase -i master
 # squash squash squash
 git push -f origin
 ```
+
+## Versioning policy
+
+We are following [semantic versioning](http://semver.org/).
+
+## Breaking changes
+
+If you're working on a change that is breaking backwards-compatibility according to our versioning policy from above just go ahead with your pull request like normal. We'll discuss this then in the pull request and help you to point your pull request to the right branch.

data/features/reports/reports.feature

@@ -190,9 +190,9 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 3 warnings:
-        [4, 5]:Smelly#m calls @foo.bar 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/wiki/Duplicate-Method-Call]
-        [4, 5]:Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/wiki/Duplicate-Method-Call]
-        [3]:Smelly#m has the name 'm' (UncommunicativeMethodName) [https://github.com/troessner/reek/wiki/Uncommunicative-Method-Name]
+        [4, 5]:Smelly#m calls @foo.bar 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        [4, 5]:Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        [3]:Smelly#m has the name 'm' (UncommunicativeMethodName) [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
       """
 
     Examples:
@@ -207,9 +207,9 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 3 warnings:
-        Smelly#m calls @foo.bar 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/wiki/Duplicate-Method-Call]
-        Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/wiki/Duplicate-Method-Call]
-        Smelly#m has the name 'm' (UncommunicativeMethodName) [https://github.com/troessner/reek/wiki/Uncommunicative-Method-Name]
+        Smelly#m calls @foo.bar 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall) [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        Smelly#m has the name 'm' (UncommunicativeMethodName) [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
       """
 
     Examples:

data/features/step_definitions/sample_file_steps.rb

@@ -27,7 +27,7 @@ end
 
 Given(/^the "(.*?)" sample file exists$/) do |file_name|
   full_path = File.expand_path file_name, 'spec/samples'
-  in_current_dir { FileUtils.cp full_path, file_name }
+  in_current_directory { FileUtils.cp full_path, file_name }
 end
 
 Given(/^a directory called 'clean_files' containing some clean files$/) do
@@ -135,7 +135,7 @@ When(/^I run "reek (.*?)" in the subdirectory$/) do |args|
 end
 
 Given(/^a masking configuration file in the HOME directory$/) do
-  set_env('HOME', File.expand_path(File.join(current_dir, 'home')))
+  set_env('HOME', File.expand_path(File.join(current_directory, 'home')))
   write_file('home/config.reek', <<-EOS.strip_heredoc)
     ---
     DuplicateMethodCall:

data/features/support/env.rb

@@ -16,7 +16,7 @@ class ReekWorld
   end
 
   def reek_with_pipe(stdin, args)
-    run_interactive("reek --no-color #{args}")
+    run "reek --no-color #{args}"
     type(stdin)
     close_input
   end

data/lib/reek/ast/node.rb

@@ -34,7 +34,7 @@ module Reek
       end
 
       def line
-        loc.line
+        loc.line unless loc.nil?
       end
 
       # @deprecated

data/lib/reek/ast/object_refs.rb

@@ -1,33 +1,30 @@
 module Reek
+  # @api private
   module AST
+    ObjectRef = Struct.new(:name, :line)
     #
     # Manages and counts the references out of a method to other objects.
     #
-    # @api private
-    class ObjectRefs  # :nodoc:
+    class ObjectRefs
       def initialize
-        @refs = Hash.new(0)
+        @refs = Hash.new { |refs, name| refs[name] = [] }
       end
 
-      def record_reference_to(exp)
-        @refs[exp] += 1
+      def most_popular
+        max = @refs.values.map(&:size).max
+        @refs.select { |_name, refs| refs.size == max }
       end
 
-      def references_to(exp)
-        @refs[exp]
+      def record_reference_to(name, line: nil)
+        @refs[name] << ObjectRef.new(name, line)
       end
 
-      def max_refs
-        @refs.values.max || 0
-      end
-
-      def max_keys
-        max = max_refs
-        @refs.select { |_key, val| val == max }
+      def references_to(name)
+        @refs[name]
       end
 
       def self_is_max?
-        max_keys.length == 0 || @refs[:self] == max_refs
+        @refs.empty? || most_popular.keys.include?(:self)
       end
     end
   end

data/lib/reek/ast/sexp_extensions.rb

@@ -249,6 +249,70 @@ module Reek
         end
       end
 
+      # Checking if a method is a singleton method.
+      module SingletonMethod
+        def singleton_method?
+          singleton_method_via_class_self_notation? ||
+            singleton_method_via_module_function?
+        end
+
+        # Ruby allows us to make a method a singleton_method after having defined the
+        # method via `module_function`.
+        #
+        # To check if we used "module_function" for a method we need to check on the parent
+        # level of the method in question if there is a call to "module_function".
+        # Given someting like
+        #   class C
+        #     def m; 3 + 7; end
+        #     module_function :m
+        #   end
+        # the AST (truncated, without the class definition) would look like this:
+        #   (def :m
+        #     (args)
+        #     (send
+        #       (int 3) :+
+        #       (int 7)))
+        #   (send nil :module_function
+        #     (sym :m))))
+        # With multiple arguments to module_function this gets more complicated:
+        #   (send nil :module_function
+        #     (sym :m1)
+        #     (send nil :m2))
+        #
+        # @return [Boolean]
+        def singleton_method_via_module_function?
+          return unless parent
+          module_function_calls(parent).any? do |module_function_call|
+            method_name_nodes = module_function_call.children[2..-1]
+            method_names = method_name_nodes.map do |node|
+              node.children.last
+            end
+            method_names.include?(name)
+          end
+        end
+
+        # Ruby allows us to make a method a singleton_method using the
+        # class << self syntax.
+        #
+        # To check for this we check if the parent node is of type :sclass.
+        #
+        # @return [Boolean]
+        def singleton_method_via_class_self_notation?
+          return unless parent
+          parent.type == :sclass
+        end
+
+        private
+
+        def module_function_calls(parent)
+          parent.children.select do |elem|
+            elem.is_a?(::Parser::AST::Node) &&
+              elem.type == :send &&
+              elem.children[1] == :module_function
+          end
+        end
+      end
+
       # Utility methods for :def nodes.
       module DefNode
         def name() self[1] end
@@ -257,7 +321,7 @@ module Reek
         def body
           self[3]
         end
-        include MethodNodeBase
+
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}#"
           "#{prefix}#{name}"
@@ -267,10 +331,8 @@ module Reek
           ReferenceCollector.new(self).num_refs_to_self > 0
         end
 
-        def singleton_method?
-          # This catches the case where methods are defined within the "class << self" syntax.
-          parent.type == :sclass if parent
-        end
+        include MethodNodeBase
+        include SingletonMethod
       end
 
       # Utility methods for :defs nodes.

data/lib/reek/cli/option_interpreter.rb

@@ -1,8 +1,6 @@
 require 'forwardable'
 require_relative 'input'
-require_relative '../report/report'
-require_relative '../report/formatter'
-require_relative '../report/heading_formatter'
+require_relative '../report'
 
 module Reek
   module CLI
@@ -31,48 +29,24 @@ module Reek
             heading_formatter: heading_formatter)
       end
 
-      # TODO: Move report type mapping into Report
       def report_class
-        case @options.report_format
-        when :yaml
-          Report::YAMLReport
-        when :json
-          Report::JSONReport
-        when :html
-          Report::HTMLReport
-        when :xml
-          Report::XMLReport
-        else # :text
-          Report::TextReport
-        end
+        Report.report_class(@options.report_format)
       end
 
       def warning_formatter
-        klass = if @options.show_links
-                  Report::WikiLinkWarningFormatter
-                else
-                  Report::SimpleWarningFormatter
-                end
-        klass.new(location_formatter)
+        warning_formatter_class.new(location_formatter)
+      end
+
+      def warning_formatter_class
+        Report.warning_formatter_class(@options.show_links ? :wiki_links : :simple)
       end
 
       def location_formatter
-        case @options.location_format
-        when :single_line
-          Report::SingleLineLocationFormatter
-        when :plain
-          Report::BlankLocationFormatter
-        else # :numbers
-          Report::DefaultLocationFormatter
-        end
+        Report.location_formatter(@options.location_format)
       end
 
       def heading_formatter
-        if @options.show_empty
-          Report::HeadingFormatter::Verbose
-        else
-          Report::HeadingFormatter::Quiet
-        end
+        Report.heading_formatter(@options.show_empty ? :verbose : :quiet)
       end
 
       def sort_by_issue_count

data/lib/reek/cli/options.rb

@@ -15,7 +15,9 @@ module Reek
       def initialize(argv = [])
         @argv    = argv
         @parser  = OptionParser.new
-        @options = OpenStruct.new(colored: color_support?,
+        @options = OpenStruct.new(report_format: :text,
+                                  location_format: :numbers,
+                                  colored: color_support?,
                                   smells_to_detect: [])
         set_up_parser
       end

data/lib/reek/context/method_context.rb

@@ -43,11 +43,11 @@ module Reek
         receiver ||= [:self]
         case receiver[0]
         when :lvasgn
-          @refs.record_reference_to(receiver.name)
+          @refs.record_reference_to(receiver.name, line: exp.line)
         when :lvar
-          @refs.record_reference_to(receiver.name) unless meth == :new
+          @refs.record_reference_to(receiver.name, line: exp.line) unless meth == :new
         when :self
-          @refs.record_reference_to(:self)
+          @refs.record_reference_to(:self, line: exp.line)
         end
       end
 
@@ -56,8 +56,8 @@ module Reek
       end
 
       def envious_receivers
-        return [] if @refs.self_is_max?
-        @refs.max_keys
+        return {} if @refs.self_is_max?
+        @refs.most_popular
       end
 
       def references_self?

data/lib/reek/context/module_context.rb

@@ -20,6 +20,17 @@ module Reek
       def descriptively_commented?
         CodeComment.new(exp.leading_comment).descriptive?
       end
+
+      # A namespace module is a module (or class) that is only there for namespacing
+      # purposes, and thus contains only nested constants, modules or classes.
+      #
+      # However, if the module is empty, it is not considered a namespace module.
+      #
+      # @return true if the module is a namespace module
+      def namespace_module?
+        contents = exp.children.last
+        contents && contents.find_nodes([:def, :defs], [:class, :module]).empty?
+      end
     end
   end
 end

data/lib/reek/context/singleton_method_context.rb

@@ -8,7 +8,7 @@ module Reek
     # @api private
     class SingletonMethodContext < MethodContext
       def envious_receivers
-        []
+        {}
       end
     end
   end

data/lib/reek/report.rb

@@ -0,0 +1,71 @@
+require_relative 'report/report'
+require_relative 'report/formatter'
+require_relative 'report/heading_formatter'
+
+module Reek
+  # Reek reporting functionality.
+  module Report
+    module_function
+
+    # @api private
+    REPORT_CLASSES = {
+      yaml: YAMLReport,
+      json: JSONReport,
+      html: HTMLReport,
+      xml: XMLReport,
+      text: TextReport
+    }
+
+    # @api private
+    LOCATION_FORMATTERS = {
+      single_line: SingleLineLocationFormatter,
+      plain: BlankLocationFormatter,
+      numbers: DefaultLocationFormatter
+    }
+
+    # @api private
+    HEADING_FORMATTERS = {
+      verbose: HeadingFormatter::Verbose,
+      quiet: HeadingFormatter::Quiet }
+
+    # @api private
+    WARNING_FORMATTER_CLASSES = {
+      wiki_links: WikiLinkWarningFormatter,
+      simple: SimpleWarningFormatter
+    }
+
+    # Map report format symbol to a report class.
+    #
+    # @param [Symbol] report_format The format to map
+    #
+    # @return The mapped report class
+    #
+    # @api private
+    def report_class(report_format)
+      REPORT_CLASSES.fetch(report_format) do
+        raise "Unknown report format: #{report_format}"
+      end
+    end
+
+    # @api private
+    def location_formatter(location_format)
+      LOCATION_FORMATTERS.fetch(location_format) do
+        raise "Unknown location format: #{location_format}"
+      end
+    end
+
+    # @api private
+    def heading_formatter(heading_format)
+      HEADING_FORMATTERS.fetch(heading_format) do
+        raise "Unknown heading format: #{heading_format}"
+      end
+    end
+
+    # @api private
+    def warning_formatter_class(warning_format)
+      WARNING_FORMATTER_CLASSES.fetch(warning_format) do
+        raise "Unknown warning format: #{warning_format}"
+      end
+    end
+  end
+end

data/lib/reek/report/formatter.rb

@@ -51,11 +51,11 @@ module Reek
     #
     # @api private
     class WikiLinkWarningFormatter < SimpleWarningFormatter
-      BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/wiki/'
+      BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/blob/master/docs/'
 
       def format(warning)
         "#{super} " \
-          "[#{explanatory_link(warning)}]"
+          "[#{explanatory_link(warning)}.md]"
       end
 
       def explanatory_link(warning)

data/lib/reek/report/heading_formatter.rb

@@ -14,6 +14,10 @@ module Reek
           @report_formatter = report_formatter
         end
 
+        def show_header?(_examiner)
+          raise NotImplementedError
+        end
+
         def header(examiner)
           if show_header?(examiner)
             report_formatter.header examiner

data/lib/reek/report/report.rb

@@ -129,13 +129,10 @@ module Reek
     class HTMLReport < Base
       require 'erb'
 
-      def show
-        path = File.expand_path('../../../../assets/html_output.html.erb',
-                                __FILE__)
-        File.open('reek.html', 'w+') do |file|
-          file.puts ERB.new(File.read(path)).result(binding)
-        end
-        print("Html file saved\n")
+      def show(target_path = 'reek.html')
+        template_path = File.expand_path('../html_report.html.erb', __FILE__)
+        File.write target_path, ERB.new(File.read(template_path)).result(binding)
+        puts 'HTML file saved'
       end
     end
 

data/lib/reek/smells/feature_envy.rb

@@ -48,13 +48,12 @@ module Reek
       #
       def examine_context(method_ctx)
         return [] unless method_ctx.references_self?
-        method_ctx.envious_receivers.map do |ref, occurs|
-          target = ref.to_s
+        method_ctx.envious_receivers.map do |name, refs|
           SmellWarning.new self,
                            context: method_ctx.full_name,
-                           lines: [method_ctx.exp.line],
-                           message: "refers to #{target} more than self",
-                           parameters: { name: target, count: occurs }
+                           lines: refs.map(&:line),
+                           message: "refers to #{name} more than self",
+                           parameters: { name: name.to_s, count: refs.size }
         end
       end
     end

data/lib/reek/smells/irresponsible_module.rb

@@ -10,12 +10,8 @@ module Reek
     # See {file:docs/Irresponsible-Module.md} for details.
     # @api private
     class IrresponsibleModule < SmellDetector
-      def self.contexts # :nodoc:
-        [:class]
-      end
-
-      def descriptive   # :nodoc:
-        @descriptive ||= {}
+      def self.contexts
+        [:class, :module]
       end
 
       #
@@ -24,13 +20,19 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        return [] if descriptive?(ctx)
+        return [] if descriptive?(ctx) || ctx.namespace_module?
         expression = ctx.exp
         [SmellWarning.new(self,
                           context: ctx.full_name,
                           lines: [expression.line],
                           message: 'has no descriptive comment',
-                          parameters: {  name: expression.text_name })]
+                          parameters: { name: expression.text_name })]
+      end
+
+      private
+
+      def descriptive
+        @descriptive ||= {}
       end
 
       def descriptive?(ctx)

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '3.0.3'
+    STRING = '3.0.4'
   end
 end

data/reek.gemspec

@@ -27,12 +27,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'unparser', '~> 0.2.2'
 
   s.add_development_dependency 'activesupport', '~> 4.2'
-  s.add_development_dependency 'aruba',         '~> 0.6.2'
+  s.add_development_dependency 'aruba',         '~> 0.7.2'
   s.add_development_dependency 'ataru',         '~> 0.2.0'
   s.add_development_dependency 'bundler',       '~> 1.1'
   s.add_development_dependency 'cucumber',      '~> 2.0'
   s.add_development_dependency 'factory_girl',  '~> 4.0'
   s.add_development_dependency 'rake',          '~> 10.0'
   s.add_development_dependency 'rspec',         '~> 3.0'
-  s.add_development_dependency 'rubocop',       '~> 0.30.0'
+  s.add_development_dependency 'rubocop',       '~> 0.32.1'
 end

data/spec/reek/ast/object_refs_spec.rb

@@ -8,24 +8,24 @@ RSpec.describe Reek::AST::ObjectRefs do
 
   context 'when empty' do
     it 'should report no refs to self' do
-      expect(@refs.references_to(:self)).to eq(0)
+      expect(@refs.references_to(:self)).to be_empty
     end
   end
 
   context 'with references to a, b, and a' do
     context 'with no refs to self' do
       before(:each) do
-        @refs.record_reference_to('a')
-        @refs.record_reference_to('b')
-        @refs.record_reference_to('a')
+        @refs.record_reference_to(:a)
+        @refs.record_reference_to(:b)
+        @refs.record_reference_to(:a)
       end
 
       it 'should report no refs to self' do
-        expect(@refs.references_to(:self)).to eq(0)
+        expect(@refs.references_to(:self)).to be_empty
       end
 
       it 'should report :a as the max' do
-        expect(@refs.max_keys).to eq('a' => 2)
+        expect(@refs.most_popular).to include(:a)
       end
 
       it 'should not report self as the max' do
@@ -38,12 +38,12 @@ RSpec.describe Reek::AST::ObjectRefs do
         end
 
         it 'should report 1 ref to self' do
-          expect(@refs.references_to(:self)).to eq(1)
+          expect(@refs.references_to(:self).size).to eq(1)
         end
 
         it 'should not report self among the max' do
-          expect(@refs.max_keys).to include('a')
-          expect(@refs.max_keys).not_to include(:self)
+          expect(@refs.most_popular).to include(:a)
+          expect(@refs.most_popular).not_to include(:self)
         end
 
         it 'should not report self as the max' do
@@ -57,19 +57,19 @@ RSpec.describe Reek::AST::ObjectRefs do
     before(:each) do
       @refs.record_reference_to(:self)
       @refs.record_reference_to(:self)
-      @refs.record_reference_to('a')
+      @refs.record_reference_to(:a)
       @refs.record_reference_to(:self)
-      @refs.record_reference_to('b')
-      @refs.record_reference_to('a')
+      @refs.record_reference_to(:b)
+      @refs.record_reference_to(:a)
       @refs.record_reference_to(:self)
     end
 
     it 'should report all refs to self' do
-      expect(@refs.references_to(:self)).to eq(4)
+      expect(@refs.references_to(:self).size).to eq(4)
     end
 
     it 'should report self among the max' do
-      expect(@refs.max_keys).to eq(self: 4)
+      expect(@refs.most_popular).to include(:self)
     end
 
     it 'should report self as the max' do
@@ -79,20 +79,20 @@ RSpec.describe Reek::AST::ObjectRefs do
 
   context 'when self is not the only max' do
     before(:each) do
-      @refs.record_reference_to('a')
+      @refs.record_reference_to(:a)
       @refs.record_reference_to(:self)
       @refs.record_reference_to(:self)
-      @refs.record_reference_to('b')
-      @refs.record_reference_to('a')
+      @refs.record_reference_to(:b)
+      @refs.record_reference_to(:a)
     end
 
     it 'should report all refs to self' do
-      expect(@refs.references_to(:self)).to eq(2)
+      expect(@refs.references_to(:self).size).to eq(2)
     end
 
     it 'should report self among the max' do
-      expect(@refs.max_keys).to include('a')
-      expect(@refs.max_keys).to include(:self)
+      expect(@refs.most_popular).to include(:a)
+      expect(@refs.most_popular).to include(:self)
     end
 
     it 'should report self as the max' do
@@ -102,19 +102,19 @@ RSpec.describe Reek::AST::ObjectRefs do
 
   context 'when self is not among the max' do
     before(:each) do
-      @refs.record_reference_to('a')
-      @refs.record_reference_to('b')
-      @refs.record_reference_to('a')
-      @refs.record_reference_to('b')
+      @refs.record_reference_to(:a)
+      @refs.record_reference_to(:b)
+      @refs.record_reference_to(:a)
+      @refs.record_reference_to(:b)
     end
 
     it 'should report all refs to self' do
-      expect(@refs.references_to(:self)).to eq(0)
+      expect(@refs.references_to(:self).size).to eq(0)
     end
 
     it 'should not report self among the max' do
-      expect(@refs.max_keys).to include('a')
-      expect(@refs.max_keys).to include('b')
+      expect(@refs.most_popular).to include(:a)
+      expect(@refs.most_popular).to include(:b)
     end
 
     it 'should not report self as the max' do

data/spec/reek/cli/option_interpreter_spec.rb

@@ -4,12 +4,17 @@ require_relative '../../../lib/reek/cli/options'
 require_relative '../../../lib/reek/report/report'
 
 RSpec.describe Reek::CLI::OptionInterpreter do
-  let(:options) { OpenStruct.new }
-  let(:instance) { Reek::CLI::OptionInterpreter.new(options) }
-
   describe '#reporter' do
-    it 'returns a Report::TextReport instance by default' do
-      expect(instance.reporter).to be_instance_of Reek::Report::TextReport
+    let(:instance) { Reek::CLI::OptionInterpreter.new(options) }
+
+    context 'with a valid set of options' do
+      let(:options) do
+        OpenStruct.new(report_format: :text,
+                       location_format: :plain)
+      end
+      it 'returns an object of the correct subclass of Report::Base' do
+        expect(instance.reporter).to be_instance_of Reek::Report::TextReport
+      end
     end
   end
 end

data/spec/reek/cli/options_spec.rb

@@ -3,17 +3,26 @@ require_relative '../../spec_helper'
 require_relative '../../../lib/reek/cli/options'
 
 RSpec.describe Reek::CLI::Options do
-  describe '#initialize' do
-    it 'should enable colors when stdout is a TTY' do
-      allow($stdout).to receive_messages(tty?: false)
-      options = Reek::CLI::Options.new.parse
-      expect(options.colored).to be false
-    end
+  describe '#parse' do
+    context 'with no arguments passed' do
+      let(:options) { Reek::CLI::Options.new.parse }
+      it 'enables colors when stdout is a TTY' do
+        allow($stdout).to receive_messages(tty?: false)
+        expect(options.colored).to be false
+      end
+
+      it 'does not enable colors when stdout is not a TTY' do
+        allow($stdout).to receive_messages(tty?: true)
+        expect(options.colored).to be true
+      end
+
+      it 'sets a valid default value for report_format' do
+        expect(options.report_format).to eq :text
+      end
 
-    it 'should not enable colors when stdout is not a TTY' do
-      allow($stdout).to receive_messages(tty?: true)
-      options = Reek::CLI::Options.new.parse
-      expect(options.colored).to be true
+      it 'sets a valid default value for location_format' do
+        expect(options.location_format).to eq :numbers
+      end
     end
   end
 end

data/spec/reek/context/method_context_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe Reek::Context::MethodContext do
     end
 
     it 'should ignore explicit calls to self' do
-      mc.refs.record_reference_to [:lvar, :other]
+      mc.refs.record_reference_to :other
       mc.record_call_to s(:send, s(:self), :thing)
       expect(mc.envious_receivers).to be_empty
     end
@@ -46,7 +46,7 @@ RSpec.describe Reek::Context::MethodContext do
 
     it 'should record envious calls' do
       mc.record_call_to s(:send, s(:lvar, :bar), :baz)
-      expect(mc.envious_receivers).to eq(bar: 1)
+      expect(mc.envious_receivers).to include(:bar)
     end
   end
 end

data/spec/reek/report/html_report_spec.rb

@@ -1,3 +1,4 @@
+require 'tempfile'
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/examiner'
 require_relative '../../../lib/reek/report/report'
@@ -13,13 +14,10 @@ RSpec.describe Reek::Report::HTMLReport do
     end
 
     it 'has the text 0 total warnings' do
-      instance.show
-
-      file = File.expand_path('../../../../reek.html', __FILE__)
-      text = File.read(file)
-      File.delete(file)
-
-      expect(text).to include('0 total warnings')
+      tempfile = Tempfile.new(['Reek::Report::HTMLReport.', '.html'])
+      response = "HTML file saved\n"
+      expect { instance.show tempfile.path }.to output(response).to_stdout
+      expect(tempfile.read).to include('0 total warnings')
     end
   end
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -260,7 +260,6 @@ RSpec.describe Reek::Smells::FeatureEnvy do
     end
 
     it 'reports the referring lines' do
-      skip
       expect(@smells[0].lines).to eq([2, 4, 5])
     end
   end

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -4,6 +4,16 @@ require_relative '../../../lib/reek/smells/irresponsible_module'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::IrresponsibleModule do
+  it 'reports a class without a comment' do
+    src = 'class BadClass; end'
+    expect(src).to reek_of :IrresponsibleModule, name: 'BadClass'
+  end
+
+  it 'reports a module without a comment' do
+    src = 'module BadClass; end'
+    expect(src).to reek_of :IrresponsibleModule, name: 'BadClass'
+  end
+
   it 'does not report re-opened modules' do
     src = <<-EOS
       # Abstract base class
@@ -22,11 +32,6 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
     expect(src).not_to reek_of(:IrresponsibleModule)
   end
 
-  it 'reports a class without a comment' do
-    src = 'class BadClass; end'
-    expect(src).to reek_of :IrresponsibleModule, name: 'BadClass'
-  end
-
   it 'reports a class with an empty comment' do
     src = <<-EOS
       #
@@ -61,6 +66,80 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
     expect(src).to reek_of :IrresponsibleModule, name: 'Foo::Bar'
   end
 
+  it 'does not report modules used only as namespaces' do
+    src = <<-EOS
+      module Foo
+        # Describes Bar
+        class Bar
+          def baz
+          end
+        end
+      end
+    EOS
+    expect(src).not_to reek_of(:IrresponsibleModule)
+  end
+
+  it 'does not report classes used only as namespaces' do
+    src = <<-EOS
+      class Foo
+        # Describes Bar
+        module Bar
+          def qux
+          end
+        end
+      end
+    EOS
+    expect(src).not_to reek_of(:IrresponsibleModule)
+  end
+
+  it 'reports modules that have both nested modules and methods' do
+    src = <<-EOS
+      module Foo
+        def foofoo
+        end
+        # Describes Bar
+        module Bar
+        end
+      end
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule)
+  end
+
+  it 'reports modules that have both nested modules and singleton methods' do
+    src = <<-EOS
+      module Foo
+        def self.foofoo
+        end
+        # Describes Bar
+        module Bar
+        end
+      end
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule)
+  end
+
+  it 'reports modules that have both nested modules and methods on the singleton class' do
+    src = <<-EOS
+      module Foo
+        class << self
+          def foofoo
+          end
+        end
+        # Describes Bar
+        module Bar
+        end
+      end
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule)
+  end
+
+  it 'reports classes that have a defined superclass' do
+    src = <<-EOS
+      class Foo < Bar; end
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule)
+  end
+
   context 'when a smell is reported' do
     before do
       @source_name = 'dummy_source'

data/spec/reek/smells/utility_function_spec.rb

@@ -62,6 +62,24 @@ RSpec.describe Reek::Smells::UtilityFunction do
       src = 'module M; def self.simple(a) a.to_s; end; end'
       expect(src).not_to reek_of(:UtilityFunction)
     end
+
+    context 'by using `module_function`' do
+      it 'should not report UtilityFunction' do
+        src = 'class C; def m(a) a.to_s; end; module_function :m; end'
+        expect(src).not_to reek_of(:UtilityFunction)
+      end
+
+      it 'should not report UtilityFunction also when using multiple arguments' do
+        src = <<-EOS
+          class C
+            def m1(a) a.to_s; end
+            def m2(a) a.to_s; end
+            module_function :m1, m2
+          end
+          EOS
+        expect(src).not_to reek_of(:UtilityFunction)
+      end
+    end
   end
 
   context 'with no calls' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -74,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: ataru
   requirement: !ruby/object:Gem::Requirement
@@ -172,14 +172,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.32.1
 description: |2
       Reek is a tool that examines Ruby classes, modules and methods and reports
       any code smells it finds.
@@ -202,7 +202,6 @@ files:
 - License.txt
 - README.md
 - Rakefile
-- assets/html_output.html.erb
 - bin/reek
 - config/cucumber.yml
 - config/defaults.reek
@@ -290,8 +289,10 @@ files:
 - lib/reek/context/singleton_method_context.rb
 - lib/reek/examiner.rb
 - lib/reek/rake/task.rb
+- lib/reek/report.rb
 - lib/reek/report/formatter.rb
 - lib/reek/report/heading_formatter.rb
+- lib/reek/report/html_report.html.erb
 - lib/reek/report/location_formatter.rb
 - lib/reek/report/report.rb
 - lib/reek/smells.rb