reek 1.3.8 → 1.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,36 +10,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sexp_processor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: ruby2ruby
   requirement: !ruby/object:Gem::Requirement
@@ -98,75 +104,81 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: |
-  Reek is a tool that examines Ruby classes, modules and methods
-  and reports any code smells it finds.
+        version: 0.8.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |2
+      Reek is a tool that examines Ruby classes, modules and methods and reports
+      any code smells it finds.
 email:
 - timo.roessner@googlemail.com
 executables:
@@ -181,9 +193,11 @@ files:
 - License.txt
 - README.md
 - Rakefile
+- assets/html_output.html.erb
 - bin/reek
 - config/defaults.reek
 - features/command_line_interface/options.feature
+- features/command_line_interface/smell_selection.feature
 - features/command_line_interface/smells_count.feature
 - features/command_line_interface/stdin.feature
 - features/configuration_files/masking_smells.feature
@@ -197,10 +211,13 @@ files:
 - features/support/env.rb
 - lib/reek.rb
 - lib/reek/cli/application.rb
-- lib/reek/cli/command_line.rb
+- lib/reek/cli/command.rb
 - lib/reek/cli/help_command.rb
+- lib/reek/cli/options.rb
 - lib/reek/cli/reek_command.rb
-- lib/reek/cli/report.rb
+- lib/reek/cli/report/formatter.rb
+- lib/reek/cli/report/report.rb
+- lib/reek/cli/report/strategy.rb
 - lib/reek/cli/version_command.rb
 - lib/reek/config_file_exception.rb
 - lib/reek/core/code_context.rb
@@ -264,6 +281,7 @@ files:
 - spec/gem/updates_spec.rb
 - spec/gem/yard_spec.rb
 - spec/matchers/smell_of_matcher.rb
+- spec/quality/reek_source_spec.rb
 - spec/reek/cli/help_command_spec.rb
 - spec/reek/cli/report_spec.rb
 - spec/reek/cli/version_command_spec.rb
@@ -348,6 +366,7 @@ files:
 - spec/samples/not_quite_masked/dirty.rb
 - spec/samples/not_quite_masked/masked.reek
 - spec/samples/not_quite_masked/smelly.rb
+- spec/samples/one_smelly_file/dirty.rb
 - spec/samples/optparse.rb
 - spec/samples/overrides/masked/dirty.rb
 - spec/samples/overrides/masked/lower.reek
@@ -369,19 +388,22 @@ files:
 - tasks/reek.rake
 - tasks/test.rake
 homepage: http://wiki.github.com/troessner/reek
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: Thank you for downloading Reek. For info see the reek wiki http://wiki.github.com/troessner/reek
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.md
+- "-x"
+- assets/|bin/|config/|features/|spec/|tasks/
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/reek/cli/command_line.rb

@@ -1,126 +0,0 @@
-require 'optparse'
-require 'rainbow'
-require 'reek/cli/report'
-require 'reek/cli/reek_command'
-require 'reek/cli/help_command'
-require 'reek/cli/version_command'
-require 'reek/source'
-
-module Reek
-  module Cli
-
-    #
-    # Parses the command line
-    #
-    class Options
-
-      def initialize(argv)
-        @argv = argv
-        @parser = OptionParser.new
-        @colored = true
-        @report_class = QuietReport
-        @warning_formatter = WarningFormatterWithLineNumbers
-        @command_class = ReekCommand
-        @format = Report::DefaultFormat
-        @config_files = []
-        @sort_by_issue_count = false
-        set_options
-      end
-
-      def banner
-        progname = @parser.program_name
-        # SMELL:
-        # The following banner isn't really correct. Help, Version and Reek
-        # are really sub-commands (in the git/svn sense) and so the usage
-        # banner should show three different command-lines. The other
-        # options are all flags for the Reek sub-command.
-        #
-        # reek -h|--help           Display a help message
-        #
-        # reek -v|--version        Output the tool's version number
-        #
-        # reek [options] files     List the smells in the given files
-        #      -c|--config file    Specify file(s) with config options
-        #      -n|--line-number    Prefix smelly lines with line numbers
-        #      -q|-[no-]quiet      Only list files that have smells
-        #      files               Names of files or dirs to be checked
-        #
-        return <<EOB
-Usage: #{progname} [options] [files]
-
-Examples:
-
-#{progname} lib/*.rb
-#{progname} -q lib
-cat my_class.rb | #{progname}
-
-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
-        end
-
-        @parser.separator "\nConfiguration:"
-        @parser.on("-c", "--config FILE", "Read configuration options from FILE") do |file|
-          @config_files << file
-        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|
-          @report_class = QuietReport
-        end
-        @parser.on("-V", "--no-quiet", "--verbose", "Show headings for smell-free source files") do |opt|
-          @report_class = VerboseReport
-        end
-        @parser.on("-n", "--no-line-numbers", "Suppress line numbers from the output") do 
-          @warning_formatter = SimpleWarningFormatter
-        end
-        @parser.on("--line-numbers", "Show line numbers in the output (this is the default)") do 
-          @warning_formatter = WarningFormatterWithLineNumbers
-        end
-        @parser.on("-s", "--single-line", "Show IDE-compatible single-line-per-warning") do 
-          @warning_formatter = 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
-          @format = :yaml
-        end
-      end
-
-      def parse
-        @parser.parse!(@argv)
-        if @command_class == HelpCommand
-          HelpCommand.new(@parser)
-        elsif @command_class == VersionCommand
-          VersionCommand.new(@parser.program_name)
-        else
-          Rainbow.enabled = @colored
-          reporter = @report_class.new(@warning_formatter, ReportFormatter, @sort_by_issue_count, @format)
-          ReekCommand.create(get_sources, reporter, @config_files)
-        end
-      end
-
-      def get_sources
-        if @argv.empty?
-          return [$stdin.to_reek_source('$stdin')]
-        else
-          return Source::SourceLocator.new(@argv).all_sources
-        end
-      end
-    end
-  end
-end

data/lib/reek/cli/report.rb

@@ -1,138 +0,0 @@
-require 'rainbow'
-
-module Reek
-  module Cli
-    module ReportFormatter
-      def self.format_list(warnings, formatter = SimpleWarningFormatter)
-        warnings.map do |warning|
-          "  #{formatter.format warning}"
-        end.join("\n")
-      end
-
-      def self.header(examiner)
-        count = examiner.smells_count
-        result = Rainbow("#{examiner.description} -- ").cyan + Rainbow("#{count} warning").yellow
-        result += Rainbow('s').yellow unless count == 1
-        result
-      end
-    end
-
-    module SimpleWarningFormatter
-      def self.format(warning)
-        "#{warning.context} #{warning.message} (#{warning.subclass})"
-      end
-    end
-
-    module WarningFormatterWithLineNumbers
-      def self.format(warning)
-        "#{warning.lines.inspect}:#{SimpleWarningFormatter.format(warning)}"
-      end
-    end
-
-    module SingleLineWarningFormatter
-      def self.format(warning)
-        "#{warning.source}:#{warning.lines.first}: #{SimpleWarningFormatter.format(warning)}"
-      end
-    end
-
-    #
-    # A report that contains the smells and smell counts following source code analysis.
-    #
-    class Report
-      DefaultFormat = :text
-
-      def initialize(warning_formatter = SimpleWarningFormatter, report_formatter = ReportFormatter, sort_by_issue_count = false, format = DefaultFormat)
-        @warning_formatter   = warning_formatter
-        @report_formatter    = report_formatter
-        @examiners           = []
-        @total_smell_count   = 0
-        @sort_by_issue_count = sort_by_issue_count
-        @format              = format
-      end
-
-      def add_examiner(examiner)
-        @total_smell_count += examiner.smells_count
-        @examiners << examiner
-        self
-      end
-
-      def show
-        case @format
-        when DefaultFormat
-          sort_examiners
-          display_summary
-          display_total_smell_count
-        when :yaml
-          if all_smells.size > 0
-            print(all_smells.to_yaml)
-          else
-            print ''
-          end
-        end
-      end
-
-      def has_smells?
-        @total_smell_count > 0
-      end
-
-    private
-
-      def all_smells
-        @all_smells ||= @examiners.each_with_object([]) { |examiner, smells| smells << examiner.smells }
-                                  .flatten
-      end
-
-      def sort_examiners
-        @examiners.sort! {|first, second| second.smells_count <=> first.smells_count } if @sort_by_issue_count
-      end
-
-      def display_summary
-        print gather_results.reject(&:empty?).join("\n")
-      end
-
-      def display_total_smell_count
-        if @examiners.size > 1
-          print "\n"
-          print total_smell_count_message
-        end
-      end
-
-      def total_smell_count_message
-        Rainbow("#{@total_smell_count} total warning#{'s' unless @total_smell_count == 1 }\n").red
-      end
-
-      def summarize_single_examiner(examiner)
-        result = @report_formatter.header examiner
-        if examiner.smelly?
-          formatted_list = @report_formatter.format_list examiner.smells, @warning_formatter
-          result += ":\n#{formatted_list}"
-        end
-        result
-      end
-    end
-
-    #
-    # A report that lists smell-free source files.
-    #
-    class VerboseReport < Report
-      def gather_results
-        @examiners.each_with_object([]) do |examiner, result|
-          result << summarize_single_examiner(examiner)
-        end
-      end
-    end
-
-    #
-    # A report that does not list smell-free source files.
-    #
-    class QuietReport < Report
-      def gather_results
-        @examiners.each_with_object([]) do |examiner, result|
-          if examiner.smelly?
-            result << summarize_single_examiner(examiner)
-          end
-        end
-      end
-    end
-  end
-end