reek 4.7.2 → 4.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a57753b0b855d7182054e7551940eac44cf57f60
-  data.tar.gz: 245074bd6e150589a1bc7a69830a34e3db600a83
+  metadata.gz: a71c30d4b1f39eee7c330e391cb1e80afa0a2d3b
+  data.tar.gz: fad4cfa8b8d369ff2e5c6ac5a22f3be8abc03891
 SHA512:
-  metadata.gz: 4c422c0a25421d8d0abc337766f7b2defae5f7044137c3e5fb7c34fffea7ee409d165f56922f433565fa8643d716cdbb3e9a3c7cec568bfa50bf15b2eed8b254
-  data.tar.gz: d4b77922d2745ab3d7f6f053931193b543f646e605a0b3a7f7a444ddf24d3462df4bf7732a248f14fd49f9253925afbf441d3fda578df736b130bfbf80db5096
+  metadata.gz: 15725dcd429906aba55b5dd379f01b1bf5e6eb08dd8df814a8403752c1356481137e0804618a449010c1b6dbb90da5543f21cf9401d2faaacbb6254734b01f68
+  data.tar.gz: 4a7a38b3b04059de3f93bb90ee14354fc0052f6c8a23ff3f96b8f456643087aa9f51aca3ff22758ef118f4c3fc05c741892a9658c512c0f0f171ee7cbbbfbd9a

data/.rubocop.yml

@@ -36,6 +36,15 @@ Layout/MultilineOperationIndentation:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
+# Some of our source examples include interpolation explicitely.
+Lint/InterpolationCheck:
+  Exclude:
+    - 'spec/**/*'
+
+# We use :true and :false as AST node types.
+Lint/BooleanSymbol:
+  Enabled: false
+
 Lint/HandleExceptions:
   Exclude:
     - 'spec/reek/configuration/configuration_file_finder_spec.rb'
@@ -63,6 +72,15 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/reek/context/visibility_tracker.rb'
+
+# EOS is a fine name to use in our specs
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'spec/**/*'
+
 # FIXME: Update specs to avoid offenses
 RSpec/AnyInstance:
   Exclude:
@@ -109,10 +127,6 @@ RSpec/FilePath:
     - 'spec/reek/report/code_climate/code_climate_formatter_spec.rb'
     - 'spec/reek/report/code_climate/code_climate_report_spec.rb'
 
-Style/AccessorMethodName:
-  Exclude:
-    - 'lib/reek/context/visibility_tracker.rb'
-
 # Allow and/or for control flow only
 Style/AndOr:
   EnforcedStyle: conditionals

data/.travis.yml

@@ -20,11 +20,6 @@ matrix:
     - rvm: ruby-head
     - rvm: rubinius-3
   fast_finish: true
-before_install:
-  - rvm use @global
-  - gem uninstall bundler -x
-  - gem install bundler --version=1.13.7
-  - bundler --version
 notifications:
   email:
     - timo.roessner@googlemail.com

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## 4.7.3 (2017-11-05)
+
+* (mvz) Handle UTF-8 files in all locales
+* (troessner) Handle encoding and other errors when parsing the source
+* (mvz) Report method source line in PrimaDonnaMethod
+* (mvz) Pick up config file in reek matcher
+* (mvz) Let REEK_SRC override set values in rake task
+
 ## 4.7.2 (2017-07-24)
 
 * (mvz) Also report unused uncommunicative parameter names

data/CONTRIBUTING.md

@@ -111,7 +111,7 @@ regard than if it were run in a terminal.
 
 #### Failing Cucumber Scenarios
 
-If there is a failing scenario and you can not figure out why it is failing,
+If there is a failing scenario and you cannot figure out why it is failing,
 just run the failing scenario: `bundle exec cucumber
 features/failing_scenario.feature:line`. By doing so Aruba will leave its set
 up in the `tmp/aruba` directory. You can then `cd` into this directory and run

data/Gemfile

@@ -8,16 +8,16 @@ group :development do
   gem 'activesupport', '>= 4.2'
   gem 'aruba',         '~> 0.14.0'
   gem 'ataru',         '~> 0.2.0'
-  gem 'cucumber',      '~> 2.0'
+  gem 'cucumber',      '~> 3.0'
   gem 'factory_girl',  '~> 4.0'
   gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.14.0'
+  gem 'simplecov',     '~> 0.15.0'
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.49.1'
-    gem 'rubocop-rspec', '~> 1.15.0'
+    gem 'rubocop',       '~> 0.51.0'
+    gem 'rubocop-rspec', '~> 1.19.0'
   end
 
   platforms :mri do

data/docs/How-To-Write-New-Detectors.md

@@ -27,20 +27,21 @@ module Reek
       end
 
       #
-      # Here you should document what you expect "ctx" to look like.
+      # Here you should document what you expect the detector's context to look
+      # like.
       #
       # @return [Array<SmellWarning>]
       #
-      def sniff(ctx)
+      def sniff
         # "found_smells" below is just an abstraction for
-        # "find the smells in question" and iteratore over them.
+        # "find the smells in question" and iterate over them.
         # This can just be a method but it can also be a more sophisticated set up.
         # Check out other smell detectors to get a feeling for what to do here.
-        found_smells(ctx).map do |smell|
+        found_smells.map do |smell|
           # "smell_warning" is defined in BaseDetector and should be used by you
           # to construct smell warnings
           smell_warning(
-            context: ctx,
+            context: context,
             lines: [], # lines on which the smell was detected
             message: "...", # the message that is printed on STDOUT
             # whatever you interpolate into the "message" should go into

data/docs/Unused-Private-Method.md

@@ -78,7 +78,7 @@ end
 ## Known limitations
 
 * Method calls via dynamic dispatch (e.g. via `send`) is something Reek (or any other
-  static tool for that matter) can not detect.
+  static tool for that matter) cannot detect.
 * Method calls via callback like [Rails filters](http://guides.rubyonrails.org/action_controller_overview.html#filters)
   will trigger this as well, e.g.:
 

data/features/configuration_via_source_comments/erroneous_source_comments.feature

@@ -48,7 +48,7 @@ Feature: Erroneous source comments are handled properly
       """
     When I run reek bad_comment.rb
     Then it reports the error "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
-    And it reports the error "Unfortunately we can not parse the configuration you have given."
+    And it reports the error "Unfortunately we cannot parse the configuration you have given."
     And it reports the error "The source is 'bad_comment.rb'"
     And it reports the error "the comment belongs to the expression starting in line 3"
 

data/features/locales.feature

@@ -0,0 +1,32 @@
+Feature: Handling different locales
+  In order to work in a variety of environments
+  As a developer
+  I want Reek to work properly in any locale
+
+  Scenario: Running Reek in an UTF-8 locale
+    Given I set the environment variable "LANG" to "en_US.utf8"
+    And a file "konnichiwa.rb" with:
+    """
+    puts 'こんにちは世界'
+    """
+    When I run `reek -V konnichiwa.rb`
+    Then it succeeds
+    And it reports no errors
+    And it reports:
+      """
+      konnichiwa.rb -- 0 warnings
+      """
+
+  Scenario: Running Reek in the POSIX locale
+    Given I set the environment variable "LANG" to "POSIX"
+    And a file "konnichiwa.rb" with:
+    """
+    puts 'こんにちは世界'
+    """
+    When I run `reek -V konnichiwa.rb`
+    Then it succeeds
+    And it reports no errors
+    And it reports:
+      """
+      konnichiwa.rb -- 0 warnings
+      """

data/features/rake_task/rake_task.feature

@@ -4,13 +4,16 @@ Feature: Reek can be driven through its Task
 
   Scenario: source_files points at the desired files
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.source_files = 'smelly.rb'
         t.reek_opts = '--no-color'
       end
       """
+    When I run `rake reek`
     Then the exit status indicates an error
     And it reports:
       """
@@ -21,13 +24,16 @@ Feature: Reek can be driven through its Task
 
   Scenario: source_files using a FileList instead of a String
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.source_files = FileList['smelly.*']
         t.reek_opts = '--no-color'
       end
       """
+    When I run `rake reek`
     Then the exit status indicates an error
     And it reports:
       """
@@ -38,13 +44,16 @@ Feature: Reek can be driven through its Task
 
   Scenario: name changes the task name
     Given the smelly file 'smelly.rb'
-    When I run rake silky with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new('silky') do |t|
         t.source_files = 'smelly.rb'
         t.reek_opts = '--no-color'
       end
       """
+    When I run `rake silky`
     Then the exit status indicates an error
     And it reports:
       """
@@ -55,26 +64,32 @@ Feature: Reek can be driven through its Task
 
   Scenario: verbose prints the reek command
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.source_files = 'smelly.rb'
         t.verbose = true
       end
       """
+    When I run `rake reek`
     Then the exit status indicates an error
     And stdout includes "Running 'reek' rake command"
 
   Scenario: fail_on_error can hide the error status
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.fail_on_error = false
         t.source_files = 'smelly.rb'
         t.reek_opts = '--no-color'
       end
       """
+    When I run `rake reek`
     Then it reports no errors
     And it succeeds
     And it reports:
@@ -87,12 +102,37 @@ Feature: Reek can be driven through its Task
   Scenario: can be configured with config_file
     Given the smelly file 'smelly.rb'
     And a configuration file 'full_mask.reek'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.config_file  = 'full_mask.reek'
         t.source_files = 'smelly.rb'
       end
       """
+    When I run `rake reek`
     Then it succeeds
     And it reports nothing
+
+  Scenario: REEK_SRC overrides the files to check
+    Given the smelly file 'smelly.rb'
+    And the clean file 'clean.rb'
+    And a file "Rakefile" with:
+      """
+      require 'reek/rake/task'
+
+      Reek::Rake::Task.new do |t|
+        t.source_files = 'clean.rb'
+        t.reek_opts = '--no-color'
+      end
+      """
+    When I set the environment variable "REEK_SRC" to "smelly.rb"
+    And I run `rake reek`
+    Then the exit status indicates an error
+    And it reports:
+      """
+      smelly.rb -- 2 warnings:
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      """

data/features/rspec_matcher.feature

@@ -0,0 +1,32 @@
+Feature: Use reek_of matcher
+  As a developer
+  In order to check code quality as part of my spec suite
+  I want to assert that my code doesn't smell
+
+  Background:
+    Given the smelly file 'smelly.rb'
+    And a file "reek_spec.rb" with:
+    """
+    require 'reek/spec'
+
+    describe 'smelly.rb' do
+      it 'is clean' do
+        expect(Pathname.new('smelly.rb')).not_to reek
+      end
+    end
+    """
+
+  Scenario: Failing on a smelly file
+    When I run `rspec reek_spec.rb`
+    Then stdout should contain:
+    """
+    Failure/Error: expect(Pathname.new('smelly.rb')).not_to reek
+    """
+
+  Scenario: Masking smells with a configuration file
+    Given a configuration file 'full_mask.reek'
+    When I run `rspec reek_spec.rb`
+    Then stdout should contain:
+    """
+    1 example, 0 failures
+    """

data/features/step_definitions/reek_steps.rb

@@ -6,10 +6,6 @@ When /^I pass "([^\"]*)" to reek *(.*)$/ do |stdin, args|
   reek_with_pipe(stdin, args)
 end
 
-When /^I run rake (\w*) with:$/ do |name, task_def|
-  rake(name, task_def)
-end
-
 Then /^it reports nothing$/ do
   expect(last_command_started).to have_output_on_stdout('')
 end

data/features/support/env.rb

@@ -21,15 +21,6 @@ class ReekWorld
     type(stdin)
     close_input
   end
-
-  def rake(name, task_def)
-    header = <<-EOS.strip_heredoc
-      require 'reek/rake/task'
-
-    EOS
-    write_file 'Rakefile', header + task_def
-    run_simple("rake #{name}", false)
-  end
 end
 
 World do

data/lib/reek/ast/builder.rb

@@ -6,7 +6,7 @@ module Reek
     # An AST Builder for ruby parser.
     #
     class Builder < ::Parser::Builders::Default
-      # This is a work around for parsing ruby code that has a string with invliad sequence as UTF-8.
+      # This is a work around for parsing ruby code that has a string with invalid sequence as UTF-8.
       # See. https://github.com/whitequark/parser/issues/283
       def string_value(token)
         value(token)

data/lib/reek/ast/sexp_extensions/send.rb

@@ -23,10 +23,6 @@ module Reek
           ([receiver] + args).compact
         end
 
-        def arg_names
-          args.map { |arg| arg.children.first }
-        end
-
         def module_creation_call?
           object_creation_call? && module_creation_receiver?
         end

data/lib/reek/cli/options.rb

@@ -82,7 +82,7 @@ module Reek
 
       def set_banner
         program_name = parser.program_name
-        parser.banner = <<-EOB.gsub(/^[ ]+/, '')
+        parser.banner = <<-BANNER.gsub(/^[ ]+/, '')
           Usage: #{program_name} [options] [files]
 
           Examples:
@@ -93,7 +93,7 @@ module Reek
 
           See https://wiki.github.com/troessner/reek for detailed help.
 
-        EOB
+        BANNER
       end
 
       # :reek:TooManyStatements: { max_statements: 6 }

data/lib/reek/configuration/app_configuration.rb

@@ -17,9 +17,10 @@ module Reek
       include ConfigurationValidator
       EXCLUDE_PATHS_KEY = 'exclude_paths'.freeze
 
-      # Instantiate a configuration via given path.
+      # Instantiate a configuration via given path, or the default path.
       #
-      # @param path [Pathname] the path to the config file
+      # @param path [Pathname] the path to the config file, or nil to use the
+      # default path.
       #
       # @return [AppConfiguration]
       #

data/lib/reek/configuration/configuration_file_finder.rb

@@ -18,7 +18,7 @@ module Reek
     # The order in which ConfigurationFileFinder tries to find such a
     # configuration file is exactly like above.
     module ConfigurationFileFinder
-      TOO_MANY_CONFIGURATION_FILES_MESSAGE = <<-EOS.freeze
+      TOO_MANY_CONFIGURATION_FILES_MESSAGE = <<-MESSAGE.freeze
 
         Error: Found multiple configuration files %s
         while scanning directory %s.
@@ -27,7 +27,7 @@ module Reek
         1) Remove all offending files.
         2) Be specific about which one you want to load via the -c switch.
 
-      EOS
+      MESSAGE
 
       class << self
         #
@@ -64,7 +64,7 @@ module Reek
           return {} unless path
           begin
             configuration = YAML.load_file(path) || {}
-          rescue => error
+          rescue StandardError => error
             raise ConfigFileException, "Invalid configuration file #{path}, error is #{error}"
           end