reek 4.5.0 → 4.6.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -31,9 +31,9 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1.2
@@ -41,9 +41,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1.2
@@ -151,10 +151,12 @@ files:
 - features/configuration_files/accept_setting.feature
 - features/configuration_files/directory_specific_directives.feature
 - features/configuration_files/exclude_directives.feature
+- features/configuration_files/exclude_paths_directives.feature
 - features/configuration_files/masking_smells.feature
 - features/configuration_files/mix_accept_reject_setting.feature
 - features/configuration_files/reject_setting.feature
 - features/configuration_files/unused_private_method.feature
+- features/configuration_files/warn_about_multiple_configuration_files.feature
 - features/configuration_loading.feature
 - features/configuration_via_source_comments/erroneous_source_comments.feature
 - features/configuration_via_source_comments/well_formed_source_comments.feature
@@ -200,6 +202,7 @@ files:
 - lib/reek/cli/command/todo_list_command.rb
 - lib/reek/cli/options.rb
 - lib/reek/cli/silencer.rb
+- lib/reek/cli/status.rb
 - lib/reek/code_comment.rb
 - lib/reek/configuration/app_configuration.rb
 - lib/reek/configuration/configuration_file_finder.rb
@@ -220,13 +223,20 @@ files:
 - lib/reek/context/statement_counter.rb
 - lib/reek/context/visibility_tracker.rb
 - lib/reek/context_builder.rb
+- lib/reek/detector_repository.rb
+- lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb
 - lib/reek/errors/bad_detector_in_comment_error.rb
+- lib/reek/errors/base_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
+- lib/reek/errors/incomprehensible_source_error.rb
+- lib/reek/errors/parse_error.rb
 - lib/reek/examiner.rb
+- lib/reek/logging_error_handler.rb
 - lib/reek/rake/task.rb
 - lib/reek/report.rb
 - lib/reek/report/base_report.rb
 - lib/reek/report/code_climate.rb
+- lib/reek/report/code_climate/code_climate_configuration.rb
 - lib/reek/report/code_climate/code_climate_configuration.yml
 - lib/reek/report/code_climate/code_climate_fingerprint.rb
 - lib/reek/report/code_climate/code_climate_formatter.rb
@@ -243,6 +253,7 @@ files:
 - lib/reek/report/text_report.rb
 - lib/reek/report/xml_report.rb
 - lib/reek/report/yaml_report.rb
+- lib/reek/smell_configuration.rb
 - lib/reek/smell_detectors.rb
 - lib/reek/smell_detectors/attribute.rb
 - lib/reek/smell_detectors/base_detector.rb
@@ -250,7 +261,6 @@ files:
 - lib/reek/smell_detectors/class_variable.rb
 - lib/reek/smell_detectors/control_parameter.rb
 - lib/reek/smell_detectors/data_clump.rb
-- lib/reek/smell_detectors/detector_repository.rb
 - lib/reek/smell_detectors/duplicate_method_call.rb
 - lib/reek/smell_detectors/feature_envy.rb
 - lib/reek/smell_detectors/instance_variable_assumption.rb
@@ -263,8 +273,6 @@ files:
 - lib/reek/smell_detectors/nil_check.rb
 - lib/reek/smell_detectors/prima_donna_method.rb
 - lib/reek/smell_detectors/repeated_conditional.rb
-- lib/reek/smell_detectors/smell_configuration.rb
-- lib/reek/smell_detectors/smell_warning.rb
 - lib/reek/smell_detectors/subclassed_from_core_class.rb
 - lib/reek/smell_detectors/too_many_constants.rb
 - lib/reek/smell_detectors/too_many_instance_variables.rb
@@ -277,6 +285,7 @@ files:
 - lib/reek/smell_detectors/unused_parameters.rb
 - lib/reek/smell_detectors/unused_private_method.rb
 - lib/reek/smell_detectors/utility_function.rb
+- lib/reek/smell_warning.rb
 - lib/reek/source/source_code.rb
 - lib/reek/source/source_locator.rb
 - lib/reek/spec.rb
@@ -295,13 +304,15 @@ files:
 - reek.gemspec
 - samples/checkstyle.xml
 - samples/clean.rb
-- samples/configuration/.reek
 - samples/configuration/corrupt.reek
 - samples/configuration/empty.reek
 - samples/configuration/full_configuration.reek
 - samples/configuration/full_mask.reek
+- samples/configuration/more_than_one_configuration_file/regular.reek
+- samples/configuration/more_than_one_configuration_file/todo.reek
 - samples/configuration/non_public_modifiers_mask.reek
 - samples/configuration/partial_mask.reek
+- samples/configuration/single_configuration_file/.reek
 - samples/configuration/with_excluded_paths.reek
 - samples/exceptions.reek
 - samples/inline.rb
@@ -342,8 +353,11 @@ files:
 - spec/reek/context/root_context_spec.rb
 - spec/reek/context/statement_counter_spec.rb
 - spec/reek/context_builder_spec.rb
+- spec/reek/detector_repository_spec.rb
 - spec/reek/examiner_spec.rb
+- spec/reek/logging_error_handler_spec.rb
 - spec/reek/rake/task_spec.rb
+- spec/reek/report/code_climate/code_climate_configuration_spec.rb
 - spec/reek/report/code_climate/code_climate_fingerprint_spec.rb
 - spec/reek/report/code_climate/code_climate_formatter_spec.rb
 - spec/reek/report/code_climate/code_climate_report_spec.rb
@@ -355,13 +369,13 @@ files:
 - spec/reek/report/xml_report_spec.rb
 - spec/reek/report/yaml_report_spec.rb
 - spec/reek/report_spec.rb
+- spec/reek/smell_configuration_spec.rb
 - spec/reek/smell_detectors/attribute_spec.rb
 - spec/reek/smell_detectors/base_detector_spec.rb
 - spec/reek/smell_detectors/boolean_parameter_spec.rb
 - spec/reek/smell_detectors/class_variable_spec.rb
 - spec/reek/smell_detectors/control_parameter_spec.rb
 - spec/reek/smell_detectors/data_clump_spec.rb
-- spec/reek/smell_detectors/detector_repository_spec.rb
 - spec/reek/smell_detectors/duplicate_method_call_spec.rb
 - spec/reek/smell_detectors/feature_envy_spec.rb
 - spec/reek/smell_detectors/instance_variable_assumption_spec.rb
@@ -374,8 +388,6 @@ files:
 - spec/reek/smell_detectors/nil_check_spec.rb
 - spec/reek/smell_detectors/prima_donna_method_spec.rb
 - spec/reek/smell_detectors/repeated_conditional_spec.rb
-- spec/reek/smell_detectors/smell_configuration_spec.rb
-- spec/reek/smell_detectors/smell_warning_spec.rb
 - spec/reek/smell_detectors/subclassed_from_core_class_spec.rb
 - spec/reek/smell_detectors/too_many_constants_spec.rb
 - spec/reek/smell_detectors/too_many_instance_variables_spec.rb
@@ -388,6 +400,7 @@ files:
 - spec/reek/smell_detectors/unused_parameters_spec.rb
 - spec/reek/smell_detectors/unused_private_method_spec.rb
 - spec/reek/smell_detectors/utility_function_spec.rb
+- spec/reek/smell_warning_spec.rb
 - spec/reek/source/source_code_spec.rb
 - spec/reek/source/source_locator_spec.rb
 - spec/reek/spec/should_reek_of_spec.rb
@@ -399,7 +412,6 @@ files:
 - tasks/ataru.rake
 - tasks/configuration.rake
 - tasks/console.rake
-- tasks/mutant.rake
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake

data/lib/reek/smell_detectors/detector_repository.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-require_relative '../smell_detectors'
-require_relative 'base_detector'
-require_relative '../configuration/app_configuration'
-
-module Reek
-  module SmellDetectors
-    #
-    # Contains all the existing smell detectors and exposes operations on them.
-    #
-    class DetectorRepository
-      # @return [Array<Reek::SmellDetectors::BaseDetector>] All known SmellDetectors
-      #         e.g. [Reek::Smells::BooleanParameter, Reek::Smells::ClassVariable].
-      def self.smell_types
-        Reek::SmellDetectors::BaseDetector.descendants.sort_by(&:name)
-      end
-
-      # @param filter_by_smells [Array<String>]
-      #   List of smell types to filter by, e.g. "DuplicateMethodCall".
-      #   More precisely it should be whatever is returned by `BaseDetector`.smell_type.
-      #   This means that you can write the "DuplicateMethodCall" from above also like this:
-      #     Reek::Smells::DuplicateMethodCall.smell_type
-      #   if you want to make sure you do not fat-finger strings.
-      #
-      # @return [Array<Reek::SmellDetectors::BaseDetector>] All SmellDetectors that we want to filter for
-      #         e.g. [Reek::Smells::Attribute].
-      def self.eligible_smell_types(filter_by_smells = [])
-        return smell_types if filter_by_smells.empty?
-        smell_types.select do |klass|
-          filter_by_smells.include? klass.smell_type
-        end
-      end
-
-      def initialize(smell_types: self.class.smell_types,
-                     configuration: {})
-        @configuration = configuration
-        @smell_types   = smell_types
-        @detectors     = smell_types.map { |klass| klass.new configuration_for(klass) }
-      end
-
-      def examine(context)
-        smell_detectors_for(context.type).flat_map do |detector|
-          detector.run_for(context)
-        end
-      end
-
-      private
-
-      attr_reader :configuration, :smell_types, :detectors
-
-      def configuration_for(klass)
-        configuration.fetch klass, {}
-      end
-
-      def smell_detectors_for(type)
-        enabled_detectors.select do |detector|
-          detector.contexts.include? type
-        end
-      end
-
-      def enabled_detectors
-        detectors.select { |detector| detector.config.enabled? }
-      end
-    end
-  end
-end

data/lib/reek/smell_detectors/smell_configuration.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-module Reek
-  module SmellDetectors
-    #
-    # Represents a single set of configuration options for a smell detector
-    #
-    class SmellConfiguration
-      # The name of the config field that specifies whether a smell is
-      # enabled. Set to +true+ or +false+.
-      ENABLED_KEY = 'enabled'.freeze
-
-      # The name of the config field that sets scope-specific overrides
-      # for other values in the current smell detector's configuration.
-      OVERRIDES_KEY = 'overrides'.freeze
-
-      def initialize(hash)
-        @options = hash
-      end
-
-      def merge(new_options)
-        options.merge!(new_options)
-      end
-
-      def enabled?
-        options[ENABLED_KEY]
-      end
-
-      def overrides_for(context)
-        Overrides.new(options.fetch(OVERRIDES_KEY, {})).for_context(context)
-      end
-
-      # Retrieves the value, if any, for the given +key+ in the given +context+.
-      #
-      # Raises an error if neither the context nor this config have a value for
-      # the key.
-      #
-      def value(key, context)
-        overrides_for(context).each { |conf| return conf[key] if conf.key?(key) }
-        options.fetch(key)
-      end
-
-      private
-
-      attr_reader :options
-    end
-
-    #
-    # A set of context-specific overrides for smell detectors.
-    #
-    class Overrides
-      def initialize(hash)
-        @hash = hash
-      end
-
-      # Find any overrides that match the supplied context
-      def for_context(context)
-        contexts = hash.keys.select { |ckey| context.matches?([ckey]) }
-        contexts.map { |exc| hash[exc] }
-      end
-
-      private
-
-      attr_reader :hash
-    end
-  end
-end

data/lib/reek/smell_detectors/smell_warning.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-require 'forwardable'
-
-module Reek
-  # @public
-  module SmellDetectors
-    #
-    # Reports a warning that a smell has been found.
-    #
-    # @public
-    #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
-    class SmellWarning
-      include Comparable
-      extend Forwardable
-
-      # @public
-      attr_reader :context, :lines, :message, :parameters, :smell_detector, :source
-      def_delegators :smell_detector, :smell_type
-
-      # @note When using Reek's public API, you should not create SmellWarning
-      #   objects yourself. This is why the initializer is not part of the
-      #   public API.
-      #
-      # :reek:LongParameterList: { max_params: 6 }
-      def initialize(smell_detector, context: '', lines:, message:,
-                     source:, parameters: {})
-        @smell_detector = smell_detector
-        @source         = source
-        @context        = context.to_s
-        @lines          = lines
-        @message        = message
-        @parameters     = parameters
-
-        freeze
-      end
-
-      # @public
-      def hash
-        identifying_values.hash
-      end
-
-      # @public
-      def <=>(other)
-        identifying_values <=> other.identifying_values
-      end
-
-      # @public
-      def eql?(other)
-        (self <=> other).zero?
-      end
-
-      # @public
-      def to_hash
-        stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
-        base_hash.merge(stringified_params)
-      end
-
-      alias yaml_hash to_hash
-
-      def base_message
-        "#{smell_type}: #{context} #{message}"
-      end
-
-      def smell_class
-        smell_detector.class
-      end
-
-      protected
-
-      def identifying_values
-        [smell_type, context, message, lines]
-      end
-
-      private
-
-      def base_hash
-        {
-          'context'        => context,
-          'lines'          => lines,
-          'message'        => message,
-          'smell_type'     => smell_type,
-          'source'         => source
-        }
-      end
-    end
-  end
-end

data/tasks/mutant.rake

@@ -1,14 +0,0 @@
-desc 'Runs mutant'
-task :mutant do
-  command = <<-EOS
-    RUBY_THREAD_VM_STACK_SIZE=64000\
-    bundle exec mutant\
-      --include lib\
-      --require reek\
-      --use rspec\
-      --since master^\
-      --jobs 4 'Reek*'
-  EOS
-  system command
-  abort unless $CHILD_STATUS.success?
-end