reek 3.8.1 → 3.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa22fd6869d0e417b1a06439dfe1708b19681806
-  data.tar.gz: 64206ff481be4eec7b81f104414b8adfe20368c9
+  metadata.gz: 4b0a5ac6a8b0b3a7b7c68c09462e3337c8914e9e
+  data.tar.gz: 519f5ade29783ce076e8b6ee58b126ccef9afc27
 SHA512:
-  metadata.gz: 5d1059a61327c5541cb78cc9d03eb14e09c07ecd282c4231ab84f18afc98aa627b581238e960d23d061b22dd6e18a1cc3b0a0e99c3d9928dc7adecdbd6466eec
-  data.tar.gz: 849705c263f676c58fc845ccfdad492ee807fc28e1f7e20fa6a5fbd6b146aa69325f909bfdf6bf07a063c9a3172e494cbb0390e49c328e765293d32135ccde0e
+  metadata.gz: 336a10dfe8f830398b76dc288aab1eaad282d6f6e83d904d5292ee08436ea932e14090f791f9eee039fea211b772aee472ca66a0f31f4b10c5742db147b5e414
+  data.tar.gz: 8a120730d0611c4ca5e23bbddfca5c0ea76badf734dfe925588b299e2d5508298cbeae7be1c943e6e3b8dfe21e813907085eda4fcf15024c96dd32926edd0f4d

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.8.2 (2016-01-07)
+
+* (pocke) Skip path if path doesn't exist.
+
 ## 3.8.1 (2015-12-28)
 
 * (troessner) Don't raise on missing directory for directive.

data/README.md

@@ -17,7 +17,7 @@ Reek is a tool that examines Ruby classes, modules and methods and reports any
 
 For an excellent introduction to
 [Code Smells](docs/Code-Smells.md) and `Reek` check out [this blog post](https://blog.codeship.com/how-to-find-ruby-code-smells-with-reek/)
-or [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA).
+or [that one](https://troessner.wordpress.com/2016/01/01/the-latest-and-greatest-additions-to-reek/). There is also [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA) from the RUBYCONF Porto.
 
 Install it via rubygems:
 
@@ -385,6 +385,8 @@ Just add this to your configuration file:
     enabled: false
   NestedIterators:
     max_allowed_nesting: 2
+  UnusedPrivateMethod:
+    enabled: false
 "app/helpers":
   IrresponsibleModule:
     enabled: false

data/features/command_line_interface/options.feature

@@ -14,6 +14,16 @@ Feature: Reek can be controlled using command-line options
     Then it succeeds
     And it reports the current version
 
+  Scenario: return given status code when using --failure-exit-code
+    Given the smelly file 'smelly.rb'
+    When I run reek smelly.rb --failure-exit-code 23
+    Then the exit status is 23
+
+  Scenario: return given status code when using --success-exit-code
+    Given the clean file 'clean.rb'
+    When I run reek clean.rb --success-exit-code 42
+    Then the exit status is 42
+
   Scenario: display the help information
     When I run reek --help
     Then it succeeds
@@ -52,6 +62,10 @@ Feature: Reek can be controlled using command-line options
                                              smelliness ("smelliest" files first)
                                              none (default - output in processing order)
 
+     Exit codes:
+              --success-exit-code CODE     The exit code when no smells are found (default: 0)
+              --failure-exit-code CODE     The exit code when smells are found (default: 2)
+
       Utility options:
           -h, --help                       Show this message
           -v, --version                    Show version

data/features/step_definitions/reek_steps.rb

@@ -23,20 +23,24 @@ Then /^stdout includes "(.*)"$/ do |text|
 end
 
 Then /^it succeeds$/ do
-  success = Reek::CLI::Application::STATUS_SUCCESS
+  success = Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
   expect(last_command_started).to have_exit_status(success)
 end
 
 Then /^the exit status indicates an error$/ do
-  error = Reek::CLI::Application::STATUS_ERROR
+  error = Reek::CLI::Options::DEFAULT_ERROR_EXIT_CODE
   expect(last_command_started).to have_exit_status(error)
 end
 
 Then /^the exit status indicates smells$/ do
-  smells = Reek::CLI::Application::STATUS_SMELLS
+  smells = Reek::CLI::Options::DEFAULT_FAILURE_EXIT_CODE
   expect(last_command_started).to have_exit_status(smells)
 end
 
+Then(/^the exit status is (\d+)$/) do |status|
+  expect(last_command_started).to have_exit_status(status.to_i)
+end
+
 Then /^it reports:$/ do |report|
   expect(last_command_started).to have_output_on_stdout(report.gsub('\n', "\n"))
 end

data/features/step_definitions/sample_file_steps.rb

@@ -1,3 +1,22 @@
+Given(/^the smelly file 'smelly.rb'$/) do
+  contents = <<-EOS.strip_heredoc
+    class Smelly
+      def x; end
+    end
+  EOS
+  write_file('smelly.rb', contents)
+end
+
+Given(/^the clean file 'clean.rb'$/) do
+  contents = <<-EOS.strip_heredoc
+    # Explanatory comment
+    class Clean
+      def foo; end
+    end
+  EOS
+  write_file('clean.rb', contents)
+end
+
 Given(/^the smelly file 'demo.rb' from the example in the README$/) do
   contents = <<-EOS.strip_heredoc
     class Dirty

data/lib/reek/cli/application.rb

@@ -11,53 +11,45 @@ module Reek
     # command line.
     #
     class Application
-      STATUS_SUCCESS = 0
-      STATUS_ERROR   = 1
-      STATUS_SMELLS  = 2
       attr_reader :configuration
 
       private_attr_accessor :status
       private_attr_reader :command, :options
 
       def initialize(argv)
-        @status = STATUS_SUCCESS
         @options = configure_options(argv)
+        @status = options.success_exit_code
         @configuration = configure_app_configuration(options.config_file)
         @command = ReekCommand.new(OptionInterpreter.new(options))
       end
 
       def execute
-        return status if error_occured?
         command.execute self
         status
       end
 
       def report_success
-        self.status = STATUS_SUCCESS
+        self.status = options.success_exit_code
       end
 
       def report_smells
-        self.status = STATUS_SMELLS
+        self.status = options.failure_exit_code
       end
 
       private
 
-      def error_occured?
-        status == STATUS_ERROR
-      end
-
       def configure_options(argv)
         Options.new(argv).parse
       rescue OptionParser::InvalidOption => error
         $stderr.puts "Error: #{error}"
-        exit STATUS_ERROR
+        exit Options::DEFAULT_ERROR_EXIT_CODE
       end
 
       def configure_app_configuration(config_file)
         Configuration::AppConfiguration.from_path(config_file)
       rescue Reek::Configuration::ConfigFileException => error
         $stderr.puts "Error: #{error}"
-        exit STATUS_ERROR
+        exit Options::DEFAULT_ERROR_EXIT_CODE
       end
     end
   end

data/lib/reek/cli/options.rb

@@ -9,9 +9,14 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 9 }
     # :reek:Attribute: { enabled: false }
+    #
     class Options
+      DEFAULT_SUCCESS_EXIT_CODE  = 0
+      DEFAULT_ERROR_EXIT_CODE    = 1
+      DEFAULT_FAILURE_EXIT_CODE  = 2
+
       attr_reader :argv, :parser, :smells_to_detect
       attr_accessor :colored,
                     :config_file,
@@ -19,16 +24,20 @@ module Reek
                     :report_format,
                     :show_empty,
                     :show_links,
-                    :sorting
+                    :sorting,
+                    :success_exit_code,
+                    :failure_exit_code
 
       def initialize(argv = [])
-        @argv             = argv
-        @parser           = OptionParser.new
-        @report_format    = :text
-        @location_format  = :numbers
-        @show_links       = true
-        @smells_to_detect = []
-        @colored          = color_support?
+        @argv              = argv
+        @parser            = OptionParser.new
+        @report_format     = :text
+        @location_format   = :numbers
+        @show_links        = true
+        @smells_to_detect  = []
+        @colored           = color_support?
+        @success_exit_code = DEFAULT_SUCCESS_EXIT_CODE
+        @failure_exit_code = DEFAULT_FAILURE_EXIT_CODE
 
         set_up_parser
       end
@@ -46,11 +55,13 @@ module Reek
         $stdout.tty?
       end
 
+      # :reek:TooManyStatements: { max_statements: 6 }
       def set_up_parser
         set_banner
         set_configuration_options
         set_alternative_formatter_options
         set_report_formatting_options
+        set_exit_codes
         set_utility_options
       end
 
@@ -138,6 +149,21 @@ module Reek
         end
       end
 
+      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      def set_exit_codes
+        parser.separator "\nExit codes:"
+        parser.on('--success-exit-code CODE',
+                  'The exit code when no smells are found '\
+                  "(default: #{DEFAULT_SUCCESS_EXIT_CODE})") do |option|
+          self.success_exit_code = Integer(option)
+        end
+        parser.on('--failure-exit-code CODE',
+                  'The exit code when smells are found '\
+                  "(default: #{DEFAULT_FAILURE_EXIT_CODE})") do |option|
+          self.failure_exit_code = Integer(option)
+        end
+      end
+
       # :reek:TooManyStatements: { max_statements: 7 }
       def set_utility_options
         parser.separator "\nUtility options:"

data/lib/reek/source/source_code.rb

@@ -21,7 +21,7 @@ module Reek
       # code   - Ruby code as String
       # origin - 'STDIN', 'string' or a filepath as String
       # parser - the parser to use for generating AST's out of the given source
-      def initialize(code, origin, parser: Parser::Ruby22)
+      def initialize(code: raise, origin: raise, parser: Parser::Ruby22)
         @source = code
         @origin = origin
         @parser = parser
@@ -39,10 +39,10 @@ module Reek
       # :reek:DuplicateMethodCall: { max_calls: 2 }
       def self.from(source)
         case source
-        when File     then new(source.read, source.path)
-        when IO       then new(source.readlines.join, IO_IDENTIFIER)
-        when Pathname then new(source.read, source.to_s)
-        when String   then new(source, STRING_IDENTIFIER)
+        when File     then new(code: source.read,           origin: source.path)
+        when IO       then new(code: source.readlines.join, origin: IO_IDENTIFIER)
+        when Pathname then new(code: source.read,           origin: source.to_s)
+        when String   then new(code: source,                origin: STRING_IDENTIFIER)
         end
       end
 

data/lib/reek/source/source_locator.rb

@@ -31,11 +31,15 @@ module Reek
 
       private_attr_reader :configuration, :paths
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # :reek:TooManyStatements: { max_statements: 7 }
       # :reek:NestedIterators: { max_allowed_nesting: 2 }
       def source_paths
         paths.each_with_object([]) do |given_path, relevant_paths|
-          print_no_such_file_error(given_path) && next unless given_path.exist?
+          unless given_path.exist?
+            print_no_such_file_error(given_path)
+            next
+          end
+
           given_path.find do |path|
             if path.directory?
               ignore_path?(path) ? Find.prune : next

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.8.1'
+    STRING = '3.8.2'
   end
 end

data/spec/reek/source/source_code_spec.rb

@@ -6,20 +6,20 @@ RSpec.describe Reek::Source::SourceCode do
   describe '#syntax_tree' do
     it 'associates comments with the AST' do
       source = "# this is\n# a comment\ndef foo; end"
-      source_code = Reek::Source::SourceCode.new(source, '(string)')
+      source_code = Reek::Source::SourceCode.new(code: source, origin: '(string)')
       result = source_code.syntax_tree
       expect(result.leading_comment).to eq "# this is\n# a comment"
     end
 
     it 'cleanly processes empty source' do
-      source_code = Reek::Source::SourceCode.new('', '(string)')
+      source_code = Reek::Source::SourceCode.new(code: '', origin: '(string)')
       result = source_code.syntax_tree
       expect(result).to be_nil
     end
 
     it 'cleanly processes empty source with comments' do
       source = "# this is\n# a comment\n"
-      source_code = Reek::Source::SourceCode.new(source, '(string)')
+      source_code = Reek::Source::SourceCode.new(code: source, origin: '(string)')
       result = source_code.syntax_tree
       expect(result).to be_nil
     end
@@ -30,7 +30,7 @@ RSpec.describe Reek::Source::SourceCode do
     let(:source_name) { 'Test source' }
     let(:error_message) { 'Error message' }
     let(:parser) { double('parser') }
-    let(:src) { Reek::Source::SourceCode.new('', source_name, parser: parser) }
+    let(:src) { Reek::Source::SourceCode.new(code: '', origin: source_name, parser: parser) }
 
     before { $stderr = catcher }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.8.2
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -538,7 +538,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby