reek 3.10.1 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf831607e9695f0bd26f4cd6ba2c5e155c43bbdf
-  data.tar.gz: d8288adc73c7bfbd81af8d81546f1e0583181a74
+  metadata.gz: a251ceb10b65df518731985aac57a7f73b29961b
+  data.tar.gz: 9490529cdf278161c31bf009b99bbb39dd9d633f
 SHA512:
-  metadata.gz: 408e265b23ef389a7d8a1f651c1b1c3d6cd77a3521abcb5cdd7233043ae389b709f48dbb1509cfceed38c815266b97acfcb0d2376811cc36da32fe71edec1534
-  data.tar.gz: af007da9b29b3c6f3bd70ccb0caec7aa7b8177a09ac3036cccb7725d2e208bd060bb167dba0e165df708f48aac87717d9fb645540da281c6de3ee36690d48ba1
+  metadata.gz: f1a8f22deef9a74aa7eb9938e637372e276b5af8ede419383364579950b4d59d3632bce86b8c023749282bd527fe7e27074f7a18154f8a7356157518c4b690c0
+  data.tar.gz: c2057985478a62c26b33b6e45db1c0dffc11ede4fa188ce6df4191369b8b5d0aba6d3f7b76f3d91004305f965e67e08b31339e6d9f89c3ca65dc2ad209a1ac76

data/.gitignore

@@ -2,6 +2,7 @@ pkg
 spec/output
 tmp
 doc
+coverage
 .yardoc
 .bundle
 .rspec

data/.rubocop.yml

@@ -22,21 +22,15 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
-# Indent one level for follow-up lines
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-# Allow small arrays of words with quotes
-Style/WordArray:
-  MinSize: 3
-
-# Allow single-line method definitions
-Style/SingleLineMethods:
-  Enabled: false
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/reek/context/visibility_tracker.rb'
 
-# Always use raise to signal exceptions
-Style/SignalException:
-  EnforcedStyle: only_raise
+Style/Documentation:
+  Exclude:
+    - 'lib/reek/ast/sexp_extensions/send.rb'
+    - 'lib/reek/ast/sexp_extensions/super.rb'
+    - 'lib/reek/ast/sexp_extensions/variables.rb'
 
 # Place . on the previous line
 Style/DotPosition:
@@ -50,19 +44,26 @@ Style/EmptyLineBetweenDefs:
 Style/MultilineBlockChain:
   Enabled: false
 
+# Indent one level for follow-up lines
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Indent one level for follow-up lines
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# There's nothing wrong with parallel assignment
+Style/ParallelAssignment:
+  Enabled: false
+
 # Allow Perl-style references to regex matches
 Style/PerlBackrefs:
   Enabled: false
 
-Style/Documentation:
-  Exclude:
-    - 'lib/reek/ast/sexp_extensions/send.rb'
-    - 'lib/reek/ast/sexp_extensions/super.rb'
-    - 'lib/reek/ast/sexp_extensions/variables.rb'
-
-Style/AccessorMethodName:
-  Exclude:
-    - 'lib/reek/context/visibility_tracker.rb'
-
-Style/ParallelAssignment:
+# Allow single-line method definitions
+Style/SingleLineMethods:
   Enabled: false
+
+# Allow small arrays of words with quotes
+Style/WordArray:
+  MinSize: 4

data/.simplecov

@@ -0,0 +1,10 @@
+SimpleCov.start do
+  track_files 'lib/**/*.rb'
+  add_filter 'lib/reek/version.rb' # version.rb is loaded too early to test
+end
+
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+  SimpleCov.minimum_coverage 98.9
+  SimpleCov.minimum_coverage_by_file 81.4
+end

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.10.2 (2016-02-15)
+
+* (troessner) Bump parser to 2.3.0.6 as minimum to fix problems with invalid syntax.
+
 ## 3.10.1 (2016-02-07)
 
 * (mvz) Fix edge case syntax problems

data/Gemfile

@@ -3,14 +3,15 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'aruba',         '~> 0.10.0'
+  gem 'aruba',         '~> 0.12.0'
   gem 'ataru',         '~> 0.2.0'
   gem 'cucumber',      '~> 2.0'
   gem 'factory_girl',  '~> 4.0'
   gem 'rake',          '~> 10.0'
   gem 'rspec',         '~> 3.0'
-  gem 'rubocop',       '~> 0.34.0'
+  gem 'rubocop',       '~> 0.37.0'
   gem 'yard',          '~> 0.8.7'
+  gem 'simplecov',     '~> 0.11.1'
 
   platforms :mri do
     gem 'redcarpet', '~> 3.3.1'

data/README.md

@@ -61,6 +61,17 @@ demo.rb -- 8 warnings:
   [3]:Dirty#awful has unused parameter 'y' (UnusedParameters)
 ```
 
+## Supported rubies
+
+`Reek` is officially running on the following MRI rubies:
+
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+
+Other rubies like Rubinius or JRuby are not officially supported but should work as well.
+
 ## Fixing Smell Warnings
 
 Reek focuses on high-level code smells, so we can't tell you how to fix warnings in

data/bin/code_climate_reek

@@ -13,7 +13,7 @@ class CodeClimateToReek
     '-f', 'code_climate',
     '--failure-exit-code', '0',
     '--success-exit-code', '0'
-  ]
+  ].freeze
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
 

data/docs/Feature-Envy.md

@@ -42,7 +42,7 @@ _Feature Envy_ reports any method that refers to self less often than it refers
 
 ## Differences to _Utility Function_
 
-_Feature Envy_ is only triggered if there are some references to self and _[Utility Function](Utility Function.md)_ is triggered if there are no references to self.
+_Feature Envy_ is only triggered if there are some references to self and _[Utility Function](Utility-Function.md)_ is triggered if there are no references to self.
 
 ## Configuration
 

data/docs/style-guide.md

@@ -9,10 +9,4 @@ We use instance vars only:
 
 For everything else we use proper getters / setters.
 
-If possible those should be private. We use the [private_attr](https://github.com/jswanner/private_attr) for this, e.g.:
-
-```Ruby
-private_attr_reader :configuration
-private_attr_writer :failure_message
-private_attr_accessor :examiner
-```
+If possible those should be private.

data/lib/reek/ast/ast_node_class_map.rb

@@ -34,7 +34,7 @@ module Reek
 
       private
 
-      private_attr_reader :klass_map
+      attr_reader :klass_map
     end
   end
 end

data/lib/reek/ast/node.rb

@@ -1,4 +1,3 @@
-require 'private_attr/everywhere'
 require_relative '../cli/silencer'
 
 Reek::CLI::Silencer.silently do
@@ -12,7 +11,6 @@ module Reek
     #
     class Node < ::Parser::AST::Node
       attr_reader :parent
-      private_attr_reader :comments
 
       def initialize(type, children = [], options = {})
         @comments = options.fetch(:comments, [])
@@ -109,14 +107,14 @@ module Reek
         each_sexp do |elem|
           elem.look_for_type(target_type, ignoring, &blk) unless ignoring.include?(elem.type)
         end
-        blk.call(self) if type == target_type
+        yield self if type == target_type
       end
 
       # See ".find_nodes" for documentation.
       def look_for_types(target_types, ignoring = [], &blk)
         return if ignoring.include?(type)
         if target_types.include? type
-          blk.call(self)
+          yield self
         else
           each_sexp do |elem|
             elem.look_for_types(target_types, ignoring, &blk)
@@ -126,6 +124,8 @@ module Reek
 
       private
 
+      attr_reader :comments
+
       def each_sexp
         children.each { |elem| yield elem if elem.is_a? ::Parser::AST::Node }
       end

data/lib/reek/ast/object_refs.rb

@@ -1,5 +1,3 @@
-require 'private_attr/everywhere'
-
 module Reek
   # Represents functionality related to an Abstract Syntax Tree.
   module AST
@@ -55,7 +53,7 @@ module Reek
 
       private
 
-      private_attr_reader :refs
+      attr_reader :refs
     end
   end
 end

data/lib/reek/ast/reference_collector.rb

@@ -1,5 +1,3 @@
-require 'private_attr/everywhere'
-
 module Reek
   module AST
     #
@@ -7,7 +5,7 @@ module Reek
     # of an abstract syntax tree.
     #
     class ReferenceCollector
-      STOP_NODES = [:class, :module, :def, :defs]
+      STOP_NODES = [:class, :module, :def, :defs].freeze
 
       def initialize(ast)
         @ast = ast
@@ -19,7 +17,7 @@ module Reek
 
       private
 
-      private_attr_reader :ast
+      attr_reader :ast
 
       def explicit_self_calls
         [:self, :super, :zsuper, :ivar, :ivasgn].flat_map do |node_type|

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

@@ -3,7 +3,7 @@ module Reek
     module SexpExtensions
       # Utility methods for :send nodes.
       module SendNode
-        ATTR_DEFN_METHODS = [:attr_writer, :attr_accessor]
+        ATTR_DEFN_METHODS = [:attr_writer, :attr_accessor].freeze
 
         def receiver
           children.first

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

@@ -27,7 +27,7 @@ module Reek
       module LvarNode
         include VariableBase
 
-        alias_method :var_name, :name
+        alias var_name name
       end
 
       # Utility methods for :gvar nodes.

data/lib/reek/cli/application.rb

@@ -13,9 +13,6 @@ module Reek
     class Application
       attr_reader :configuration
 
-      private_attr_accessor :status
-      private_attr_reader :command, :options
-
       def initialize(argv)
         @options = configure_options(argv)
         @status = options.success_exit_code
@@ -25,19 +22,13 @@ module Reek
 
       def execute
         command.execute self
-        status
-      end
-
-      def report_success
-        self.status = options.success_exit_code
-      end
-
-      def report_smells
-        self.status = options.failure_exit_code
       end
 
       private
 
+      attr_accessor :status
+      attr_reader :command, :options
+
       def configure_options(argv)
         Options.new(argv).parse
       rescue OptionParser::InvalidOption => error

data/lib/reek/cli/command.rb

@@ -1,20 +1,16 @@
-require 'private_attr/everywhere'
-
 module Reek
   module CLI
     #
     # Base class for all commands
     #
     class Command
-      attr_reader :options
-
       def initialize(options)
         @options = options
       end
 
       private
 
-      private_attr_reader :options
+      attr_reader :options
     end
   end
 end

data/lib/reek/cli/option_interpreter.rb

@@ -10,8 +10,7 @@ module Reek
     class OptionInterpreter
       include Input
       extend Forwardable
-      def_delegators :options, :smells_to_detect
-      private_attr_reader :argv, :options
+      def_delegators :options, :smells_to_detect, :success_exit_code, :failure_exit_code
 
       def initialize(options)
         @options = options
@@ -50,6 +49,10 @@ module Reek
       def sort_by_issue_count
         options.sorting == :smelliness
       end
+
+      private
+
+      attr_reader :argv, :options
     end
   end
 end

data/lib/reek/cli/reek_command.rb

@@ -12,12 +12,16 @@ module Reek
         options.sources.each do |source|
           reporter.add_examiner Examiner.new(source, smell_names, configuration: app.configuration)
         end
-        reporter.smells? ? app.report_smells : app.report_success
         reporter.show
+        result_code
       end
 
       private
 
+      def result_code
+        reporter.smells? ? options.failure_exit_code : options.success_exit_code
+      end
+
       def reporter
         @reporter ||= options.reporter
       end

data/lib/reek/cli/warning_collector.rb

@@ -1,4 +1,3 @@
-require 'private_attr/everywhere'
 require 'set'
 
 module Reek
@@ -21,7 +20,7 @@ module Reek
 
       private
 
-      private_attr_reader :warnings_set
+      attr_reader :warnings_set
     end
   end
 end

data/lib/reek/code_comment.rb

@@ -1,5 +1,4 @@
 require 'yaml'
-require 'private_attr/everywhere'
 
 module Reek
   #
@@ -9,11 +8,10 @@ module Reek
   class CodeComment
     CONFIGURATION_REGEX            = /:reek:(\w+)(:\s*\{.*?\})?/
     SANITIZE_REGEX                 = /(#|\n|\s)+/ # Matches '#', newlines and > 1 whitespaces.
-    DISABLE_DETECTOR_CONFIGURATION = ': { enabled: false }'
+    DISABLE_DETECTOR_CONFIGURATION = ': { enabled: false }'.freeze
     MINIMUM_CONTENT_LENGTH         = 2
 
     attr_reader :config
-    private_attr_reader :original_comment
 
     #
     # @param comment [String] - the original comment as found in the source code
@@ -35,6 +33,8 @@ module Reek
 
     private
 
+    attr_reader :original_comment
+
     def sanitized_comment
       @sanitized_comment ||= original_comment.
         gsub(CONFIGURATION_REGEX, '').

data/lib/reek/configuration/app_configuration.rb

@@ -1,5 +1,4 @@
 require 'pathname'
-require 'private_attr/everywhere'
 require_relative './configuration_file_finder'
 require_relative './configuration_validator'
 require_relative './default_directive'
@@ -14,8 +13,7 @@ module Reek
     # @public
     class AppConfiguration
       include ConfigurationValidator
-      EXCLUDE_PATHS_KEY = 'exclude_paths'
-      private_attr_writer :directory_directives, :default_directive, :excluded_paths
+      EXCLUDE_PATHS_KEY = 'exclude_paths'.freeze
 
       # Instantiate a configuration via given path.
       #
@@ -103,6 +101,8 @@ module Reek
 
       private
 
+      attr_writer :directory_directives, :default_directive, :excluded_paths
+
       def directory_directives
         @directory_directives ||= {}.extend(DirectoryDirectives)
       end