reek 1.6.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6b56b69887082aa037332d0e26893f0124b5217
-  data.tar.gz: 86dfd512f568cbdaca34fbdca28c05f97d9578d8
+  metadata.gz: 6e9938a6d72e1e64ab84f0cbfc67d43574a0d9b8
+  data.tar.gz: 102ac522a9e2df22fbbec630f09d97174e4e5bd0
 SHA512:
-  metadata.gz: c78a54feac15972836de8e6cc89172649db95bd3c1d113ba7e089a8558f1f8143fe520a2ada4185646586a90a146e9ca05a4687707799a1f13cf2cda088b2dc5
-  data.tar.gz: 55d5f7cfde48194423d1b685da1eb560bed74fc43f81df44d2166989ce58e7fab3ce720e30c9d02194901a75733ff10887f015573a8fc91a87c5f0f840d8bedb
+  metadata.gz: c7b67443588cd094db2a47cd4fddf96190ea87c4c44e68fe6620f86638346e1dc38ad9e84941e6939360765762738b3fa5902289db52f2fa1ef1e78066b412ef
+  data.tar.gz: 16a5d7d2c2750e4a7d1324ca9bb6076fb3caad8eb929fb319dff712e895c6ffe73420e4f914317a5981f26300dc3fe5f1c926e36e69dd1ed7b1bbed0214ff2a8

data/CHANGELOG

@@ -1,14 +1,11 @@
-== 1.6.6
-
-* (guilhermesimoes) Fix HTML report generation.
-
-== 1.6.5
-
-* (mvz) Make NestedIterator not break when iterator is called on super.
-
-== 1.6.4
+== 2.0.0
 
+* (troessner) Revise, improve & refactor our Rspec matcher and remove smell_of
+* (guilhermesimoes) Fix generating HTML report
+* (mvz) Re-organize CLI options
 * (maser) Fix file arguments without TTY
+* (marcofognog) Make NestedIterator not break if iterator is called on super
+* (troessner) Revamp & refactor our rake task
 
 == 1.6.3
 

data/features/command_line_interface/options.feature

@@ -25,29 +25,33 @@ Feature: Reek can be controlled using command-line options
       Examples:
 
       reek lib/*.rb
-      reek -q lib
+      reek -s lib
       cat my_class.rb | reek
 
       See http://wiki.github.com/troessner/reek for detailed help.
 
-      Common options:
-          -h, --help                       Show this message
-          -v, --version                    Show version
-
       Configuration:
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Detect smell SMELL (default is all enabled smells)
 
-      Report formatting:
-          -o, --[no-]color                 Use colors for the output (this is the default)
-          -q, --quiet                      Suppress headings for smell-free source files (this is the default)
-          -V, --no-quiet, --verbose        Show headings for smell-free source files
-          -U, --ultra-verbose              Be as explanatory as possible
-          -n, --no-line-numbers            Suppress line numbers from the output
-              --line-numbers               Show line numbers in the output (this is the default)
-          -s, --single-line                Show IDE-compatible single-line-per-warning
-          -S, --sort-by-issue-count        Sort by "issue-count", listing the "smelliest" files first
-          -y, --yaml                       Report smells in YAML format
-          -H, --html                       Report smells in HTML format
+      Report format:
+          -f, --format FORMAT              Report smells in the given format:
+                                             html
+                                             text (default)
+                                             yaml
+
+      Text format options:
+              --[no-]color                 Use colors for the output (this is the default)
+          -V, --[no-]empty-headings        Show headings for smell-free source files
+          -U, --[no-]wiki-links            Show link to related Reek wiki page for each smell
+          -n, --[no-]line-numbers          Show line numbers in the output (this is the default)
+          -s, --single-line                Show location in editor-compatible single-line-per-smell format
+              --sort-by SORTING            Sort reported files by the given criterium:
+                                             smelliness ("smelliest" files first)
+                                             none (default - output in processing order)
+
+      Utility options:
+          -h, --help                       Show this message
+          -v, --version                    Show version
 
       """

data/features/command_line_interface/stdin.feature

@@ -12,7 +12,7 @@ Feature: Reek reads from $stdin when no files are given
       """
 
   Scenario: outputs nothing on empty stdin
-    When I pass "" to reek --quiet
+    When I pass "" to reek
     Then it succeeds
     And stdout equals ""
 

data/features/rake_task/rake_task.feature

@@ -82,15 +82,3 @@ Feature: Reek can be driven through its Task
     And it reports:
       """
       """
-  Scenario: can be configured with config_files
-    When I run rake reek with:
-      """
-      Reek::Rake::Task.new do |t|
-        t.config_files = 'spec/samples/minimal_smelly_and_masked/config.reek'
-        t.source_files = 'spec/samples/minimal_smelly_and_masked/minimal_dirty.rb'
-      end
-      """
-    Then it succeeds
-    And it reports:
-      """
-      """

data/features/reports/reports.feature

@@ -31,8 +31,8 @@ Feature: Correctly formatted reports
       | spec/samples/two_smelly_files/*.rb |
       | spec/samples/two_smelly_files      |
 
-  Scenario: Do not sort by default (which means report each file as it is read in)
-    When I run reek spec/samples/three_smelly_files/*.rb
+  Scenario Outline: No sorting (which means report each file as it is read in)
+    When I run reek <option> spec/samples/three_smelly_files/*.rb
     Then the exit status indicates smells
     And it reports:
       """
@@ -51,6 +51,12 @@ Feature: Correctly formatted reports
       9 total warnings
       """
 
+    Examples:
+      | option         |
+      |                |
+      | --sort-by none |
+      | --sort-by n    |
+
   Scenario Outline: Sort by issue count
     When I run reek <option> spec/samples/three_smelly_files/*.rb
     Then the exit status indicates smells
@@ -72,11 +78,11 @@ Feature: Correctly formatted reports
       """
 
     Examples:
-      | option                |
-      | -S                    |
-      | --sort-by-issue-count |
+      | option               |
+      | --sort-by smelliness |
+      | --sort-by s          |
 
-  Scenario Outline: good files show no headers by default
+  Scenario Outline: good files show no headings by default
     When I run reek <args>
     Then it succeeds
     And it reports:
@@ -90,7 +96,7 @@ Feature: Correctly formatted reports
       | spec/samples/three_clean_files/*.rb |
       | spec/samples/three_clean_files      |
 
-  Scenario Outline: --verbose and --no-quiet turn on headers for fragrant files
+  Scenario Outline: --empty-headings turns on headings for fragrant files
     When I run reek <option> spec/samples/three_clean_files/*.rb
     Then it succeeds
     And it reports:
@@ -102,12 +108,11 @@ Feature: Correctly formatted reports
       """
 
     Examples:
-      | option     |
-      | --verbose  |
-      | -V         |
-      | --no-quiet |
+      | option            |
+      | --empty-headings  |
+      | -V                |
 
-  Scenario Outline: --quiet turns off headers for fragrant files
+  Scenario Outline: --no-empty-headings turns off headings for fragrant files
     When I run reek <option> spec/samples/three_clean_files/*.rb
     Then it succeeds
     And it reports:
@@ -117,11 +122,11 @@ Feature: Correctly formatted reports
     """
 
     Examples:
-      | option        |
-      | -V -q         |
-      | -V --quiet    |
+      | option                 |
+      | --no-empty-headings    |
+      | -V --no-empty-headings |
 
-  Scenario Outline: --line-number turns off line numbers
+  Scenario Outline: --no-line-numbers turns off line numbers
     When I run reek <option> spec/samples/standard_smelly/dirty.rb
     Then the exit status indicates smells
     And it reports:
@@ -136,11 +141,30 @@ Feature: Correctly formatted reports
       """
 
     Examples:
-      | option            |
-      | -n                |
-      | --no-line-numbers |
-      | -n -V             |
-      | -V -n             |
+      | option               |
+      | --no-line-numbers    |
+      | --no-line-numbers -V |
+      | -V --no-line-numbers |
+
+  Scenario Outline: --line-numbers turns on line numbers
+    When I run reek <option> spec/samples/standard_smelly/dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/standard_smelly/dirty.rb -- 6 warnings:
+        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+        [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+      """
+
+    Examples:
+      | option                           |
+      | --line-numbers                   |
+      | --no-line-numbers --line-numbers |
+      | --no-line-numbers -n             |
 
   Scenario Outline: --single-line shows filename and one line number
     When I run reek <option> spec/samples/standard_smelly/dirty.rb
@@ -190,7 +214,7 @@ Feature: Correctly formatted reports
       | spec/samples/two_smelly_files/ |
       | spec/samples/two_smelly_files  |
 
-  Scenario Outline: -U or --ultra-verbose adds helpful links to smell warnings
+  Scenario Outline: -U or --wiki-links adds helpful links to smell warnings
     When I run reek <option> spec/samples/one_smelly_file/dirty.rb
     Then the exit status indicates smells
     And it reports:
@@ -204,4 +228,20 @@ Feature: Correctly formatted reports
     Examples:
       | option           |
       | -U               |
-      | --ultra-verbose  |
+      | --wiki-links  |
+
+  Scenario Outline: --wiki-links is independent of --line-numbers
+    When I run reek <option> spec/samples/one_smelly_file/dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/one_smelly_file/dirty.rb -- 3 warnings:
+        D has no descriptive comment (IrresponsibleModule) [https://github.com/troessner/reek/wiki/Irresponsible-Module]
+        D has the name 'D' (UncommunicativeModuleName) [https://github.com/troessner/reek/wiki/Uncommunicative-Module-Name]
+        D#a has the name 'a' (UncommunicativeMethodName) [https://github.com/troessner/reek/wiki/Uncommunicative-Method-Name]
+      """
+
+    Examples:
+      | option                             |
+      | --no-line-numbers -U               |
+      | --no-line-numbers --wiki-links  |

data/features/reports/yaml.feature

@@ -4,7 +4,7 @@ Feature: Report smells using simple YAML layout
   output a list of smells in Yaml.
 
   Scenario: output is empty when there are no smells
-    When I run reek --yaml spec/samples/three_clean_files
+    When I run reek --format yaml spec/samples/three_clean_files
     Then it succeeds
     And it reports this yaml:
     """
@@ -12,7 +12,7 @@ Feature: Report smells using simple YAML layout
     """
 
   Scenario: Indicate smells and print them as yaml when using files
-    When I run reek --yaml spec/samples/standard_smelly/minimal_dirty.rb
+    When I run reek --format yaml spec/samples/standard_smelly/minimal_dirty.rb
     Then the exit status indicates smells
     And it reports this yaml:
       """
@@ -44,7 +44,7 @@ Feature: Report smells using simple YAML layout
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
-    When I pass "class Turn; end" to reek --yaml
+    When I pass "class Turn; end" to reek --format yaml
     Then the exit status indicates smells
     And it reports this yaml:
       """

data/features/samples.feature

@@ -6,7 +6,7 @@ Feature: Basic smell detection
 
   @inline
   Scenario: Correct smells from inline.rb
-    When I run reek -n spec/samples/inline.rb
+    When I run reek --no-line-numbers spec/samples/inline.rb
     Then the exit status indicates smells
     And it reports:
     """
@@ -58,7 +58,7 @@ Feature: Basic smell detection
     """
 
   Scenario: Correct smells from optparse.rb
-    When I run reek -n spec/samples/optparse.rb
+    When I run reek --no-line-numbers spec/samples/optparse.rb
     Then the exit status indicates smells
     And it reports:
     """
@@ -177,7 +177,7 @@ Feature: Basic smell detection
     """
 
   Scenario: Correct smells from redcloth.rb
-    When I run reek -n spec/samples/redcloth.rb
+    When I run reek --no-line-numbers spec/samples/redcloth.rb
     Then the exit status indicates smells
     And it reports:
     """

data/lib/reek/cli/application.rb

@@ -1,4 +1,5 @@
 require 'reek/cli/options'
+require 'reek/cli/reek_command'
 require 'reek/configuration/app_configuration'
 
 module Reek
@@ -9,17 +10,16 @@ module Reek
     # command line.
     #
     class Application
-      attr_reader :options
-
       STATUS_SUCCESS = 0
       STATUS_ERROR   = 1
       STATUS_SMELLS  = 2
 
       def initialize(argv)
         @status  = STATUS_SUCCESS
-        @options = Options.new(argv)
+        options_parser = Options.new(argv)
         begin
-          @command = @options.parse
+          @options = options_parser.parse
+          @command = ReekCommand.new(OptionInterpreter.new(@options))
           initialize_configuration
         rescue OptionParser::InvalidOption, Reek::Configuration::ConfigFileException => error
           $stderr.puts "Error: #{error}"
@@ -34,7 +34,7 @@ module Reek
       end
 
       def initialize_configuration
-        Configuration::AppConfiguration.initialize_with self
+        Configuration::AppConfiguration.initialize_with @options
       end
 
       def output(text)

data/lib/reek/cli/input.rb

@@ -1,7 +1,7 @@
 require 'reek/source'
 
 module Reek
-  module CLI
+  module Cli
     #
     # CLI Input utility
     #

data/lib/reek/cli/option_interpreter.rb

@@ -0,0 +1,77 @@
+require 'forwardable'
+require 'reek/cli/input'
+require 'reek/cli/report/report'
+require 'reek/cli/report/formatter'
+require 'reek/cli/report/heading_formatter'
+
+module Reek
+  module Cli
+    #
+    # Interprets the options set from the command line
+    #
+    class OptionInterpreter
+      include Cli::Input
+
+      extend Forwardable
+
+      def_delegators :@options, :smells_to_detect
+
+      def initialize(options)
+        @options = options
+        @argv = @options.argv
+      end
+
+      def reporter
+        @reporter ||=
+          report_class.new(
+            warning_formatter: warning_formatter,
+            report_formatter: Report::Formatter,
+            sort_by_issue_count: sort_by_issue_count,
+            heading_formatter: heading_formatter)
+      end
+
+      def report_class
+        case @options.report_format
+        when :yaml
+          Report::YamlReport
+        when :html
+          Report::HtmlReport
+        else # :text
+          Report::TextReport
+        end
+      end
+
+      def warning_formatter
+        klass = if @options.show_links
+                  Report::WikiLinkWarningFormatter
+                else
+                  Report::SimpleWarningFormatter
+                end
+        klass.new(location_formatter)
+      end
+
+      def location_formatter
+        case @options.location_format
+        when :single_line
+          Report::SingleLineLocationFormatter
+        when :plain
+          Report::BlankLocationFormatter
+        else # :numbers
+          Report::DefaultLocationFormatter
+        end
+      end
+
+      def heading_formatter
+        if @options.show_empty
+          Report::HeadingFormatter::Verbose
+        else
+          Report::HeadingFormatter::Quiet
+        end
+      end
+
+      def sort_by_issue_count
+        @options.sorting == :smelliness
+      end
+    end
+  end
+end

data/lib/reek/cli/options.rb

@@ -1,12 +1,7 @@
 require 'optparse'
+require 'ostruct'
 require 'rainbow'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-require 'reek/cli/report/strategy'
-require 'reek/cli/reek_command'
-require 'reek/cli/help_command'
-require 'reek/cli/version_command'
-require 'reek/cli/input'
+require 'reek/cli/option_interpreter'
 
 module Reek
   module Cli
@@ -14,110 +9,122 @@ module Reek
     # Parses the command line
     #
     class Options
-      include CLI::Input
+      def initialize(argv)
+        @argv    = argv
+        @parser  = OptionParser.new
+        @options = OpenStruct.new(colored: true, smells_to_detect: [])
+        set_up_parser
+      end
+
+      def parse
+        @parser.parse!(@argv)
+        @options.argv = @argv
+        Rainbow.enabled = @options.colored
+        @options
+      end
 
-      attr_reader :config_file, :smells_to_detect
+      private
 
-      def initialize(argv)
-        @argv                = argv
-        @parser              = OptionParser.new
-        @colored             = true
-        @report_class        = Report::TextReport
-        @strategy            = Report::Strategy::Quiet
-        @warning_formatter   = Report::WarningFormatterWithLineNumbers
-        @command_class       = ReekCommand
-        @config_file         = nil
-        @sort_by_issue_count = false
-        @smells_to_detect    = []
-        set_options
+      def set_up_parser
+        set_banner
+        set_configuration_options
+        set_alternative_formatter_options
+        set_report_formatting_options
+        set_utility_options
       end
 
-      def banner
-        progname = @parser.program_name
-        <<-EOB.gsub(/^[ ]+/, '')
-          Usage: #{progname} [options] [files]
+      def set_banner
+        program_name = @parser.program_name
+        @parser.banner = <<-EOB.gsub(/^[ ]+/, '')
+          Usage: #{program_name} [options] [files]
 
           Examples:
 
-          #{progname} lib/*.rb
-          #{progname} -q lib
-          cat my_class.rb | #{progname}
+          #{program_name} lib/*.rb
+          #{program_name} -s lib
+          cat my_class.rb | #{program_name}
 
           See http://wiki.github.com/troessner/reek for detailed help.
 
         EOB
       end
 
-      def set_options
-        @parser.banner = banner
-        @parser.separator 'Common options:'
-        @parser.on('-h', '--help', 'Show this message') do
-          @command_class = HelpCommand
-        end
-        @parser.on('-v', '--version', 'Show version') do
-          @command_class = VersionCommand
+      def set_alternative_formatter_options
+        @parser.separator "\nReport format:"
+        @parser.on(
+          '-f', '--format FORMAT', [:html, :text, :yaml],
+          'Report smells in the given format:',
+          '  html', '  text (default)', '  yaml'
+        ) do |opt|
+          @options.report_format = opt
         end
+      end
 
-        @parser.separator "\nConfiguration:"
+      def set_configuration_options
+        @parser.separator 'Configuration:'
         @parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
-          @config_file = file
+          @options.config_file = file
         end
         @parser.on('--smell SMELL', 'Detect smell SMELL (default is all enabled smells)') do |smell|
-          @smells_to_detect << smell
+          @options.smells_to_detect << smell
         end
+      end
 
-        @parser.separator "\nReport formatting:"
-        @parser.on('-o', '--[no-]color', 'Use colors for the output (this is the default)') do |opt|
-          @colored = opt
-        end
-        @parser.on('-q', '--quiet', 'Suppress headings for smell-free source files (this is the default)') do |_opt|
-          @strategy = Report::Strategy::Quiet
-        end
-        @parser.on('-V', '--no-quiet', '--verbose', 'Show headings for smell-free source files') do |_opt|
-          @strategy = Report::Strategy::Verbose
-        end
-        @parser.on('-U', '--ultra-verbose', 'Be as explanatory as possible') do |_opt|
-          @warning_formatter = Report::UltraVerboseWarningFormattter
-        end
-        @parser.on('-n', '--no-line-numbers', 'Suppress line numbers from the output') do
-          @warning_formatter = Report::SimpleWarningFormatter
-        end
-        @parser.on('--line-numbers', 'Show line numbers in the output (this is the default)') do
-          @warning_formatter = Report::WarningFormatterWithLineNumbers
-        end
-        @parser.on('-s', '--single-line', 'Show IDE-compatible single-line-per-warning') do
-          @warning_formatter = Report::SingleLineWarningFormatter
-        end
-        @parser.on('-S', '--sort-by-issue-count', 'Sort by "issue-count", listing the "smelliest" files first') do
-          @sort_by_issue_count = true
-        end
-        @parser.on('-y', '--yaml', 'Report smells in YAML format') do
-          @report_class = Report::YamlReport
-        end
-        @parser.on('-H', '--html', 'Report smells in HTML format') do
-          @report_class = Report::HtmlReport
+      def set_report_formatting_options
+        @parser.separator "\nText format options:"
+        set_up_color_option
+        set_up_verbosity_options
+        set_up_location_formatting_options
+        set_up_sorting_option
+      end
+
+      def set_up_color_option
+        @parser.on('--[no-]color', 'Use colors for the output (this is the default)') do |opt|
+          @options.colored = opt
         end
       end
 
-      def parse
-        @parser.parse!(@argv)
-        Rainbow.enabled = @colored
-        @command_class.new(self)
+      def set_up_verbosity_options
+        @parser.on('-V', '--[no-]empty-headings',
+                   'Show headings for smell-free source files') do |show_empty|
+          @options.show_empty = show_empty
+        end
+        @parser.on('-U', '--[no-]wiki-links',
+                   'Show link to related Reek wiki page for each smell') do |show_links|
+          @options.show_links = show_links
+        end
       end
 
-      def reporter
-        @reporter ||= @report_class.new(warning_formatter: @warning_formatter,
-                                        report_formatter: Report::Formatter,
-                                        sort_by_issue_count: @sort_by_issue_count,
-                                        strategy: @strategy)
+      def set_up_location_formatting_options
+        @parser.on('-n', '--[no-]line-numbers',
+                   'Show line numbers in the output (this is the default)') do |show_numbers|
+          @options.location_format = show_numbers ? :numbers : :plain
+        end
+        @parser.on('-s', '--single-line',
+                   'Show location in editor-compatible single-line-per-smell format') do
+          @options.location_format = :single_line
+        end
       end
 
-      def program_name
-        @parser.program_name
+      def set_up_sorting_option
+        @parser.on('--sort-by SORTING', [:smelliness, :none],
+                   'Sort reported files by the given criterium:',
+                   '  smelliness ("smelliest" files first)',
+                   '  none (default - output in processing order)') do |sorting|
+                     @options.sorting = sorting
+                   end
       end
 
-      def help_text
-        @parser.to_s
+      def set_utility_options
+        @parser.separator "\nUtility options:"
+        @parser.on_tail('-h', '--help', 'Show this message') do
+          puts @parser
+          exit
+        end
+        @parser.on_tail('-v', '--version', 'Show version') do
+          puts "#{@parser.program_name} #{Reek::VERSION}\n"
+          exit
+        end
       end
     end
   end