reek 3.11 → 4.0.0.pre1

data/lib/reek/cli/warning_collector.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 
 module Reek

data/lib/reek/code_comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yaml'
 
 module Reek

data/lib/reek/configuration/app_configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require_relative './configuration_file_finder'
 require_relative './configuration_validator'

data/lib/reek/configuration/configuration_file_finder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 
 module Reek

data/lib/reek/configuration/configuration_validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Configuration
     #

data/lib/reek/configuration/default_directive.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Configuration
     #

data/lib/reek/configuration/directory_directives.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative './configuration_validator'
 
 module Reek

data/lib/reek/configuration/excluded_paths.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative './configuration_validator'
 
 module Reek

data/lib/reek/context/attribute_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'code_context'
 
 module Reek

data/lib/reek/context/class_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'module_context'
 
 module Reek

data/lib/reek/context/code_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../code_comment'
 require_relative '../ast/object_refs'
 require_relative 'statement_counter'

data/lib/reek/context/ghost_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'code_context'
 require_relative 'singleton_method_context'
 

data/lib/reek/context/method_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'code_context'
 
 module Reek

data/lib/reek/context/module_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'code_context'
 require_relative 'attribute_context'
 require_relative 'method_context'

data/lib/reek/context/root_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'code_context'
 require_relative 'method_context'
 

data/lib/reek/context/send_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'code_context'
 
 module Reek

data/lib/reek/context/singleton_attribute_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'attribute_context'
 
 module Reek

data/lib/reek/context/singleton_method_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'method_context'
 
 module Reek

data/lib/reek/context/statement_counter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../ast/node'
 
 module Reek

data/lib/reek/context/visibility_tracker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Context
     # Responsible for tracking visibilities in regards to CodeContexts.
@@ -18,7 +19,7 @@ module Reek
       # @param visibility [Symbol]
       # @param names [Array<Symbol>]
       #
-      def track_visibility(children: raise, visibility: raise, names: raise)
+      def track_visibility(children:, visibility:, names:)
         return unless VISIBILITY_MODIFIERS.include? visibility
         if names.any?
           children.each do |child|
@@ -40,7 +41,7 @@ module Reek
       # @param visibility [Symbol]
       # @param names [Array<Symbol>]
       #
-      def track_singleton_visibility(children: raise, visibility: raise, names: raise)
+      def track_singleton_visibility(children:, visibility:, names:)
         return if names.empty?
         visibility = VISIBILITY_MAP[visibility]
         return unless visibility

data/lib/reek/context_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'context/attribute_context'
 require_relative 'context/class_context'
 require_relative 'context/ghost_context'

data/lib/reek/examiner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'context_builder'
 require_relative 'source/source_code'
 require_relative 'cli/warning_collector'
@@ -26,7 +27,7 @@ module Reek
     #
     # @public
     def initialize(source,
-                   filter_by_smells = [],
+                   filter_by_smells: [],
                    configuration: Configuration::AppConfiguration.default)
       @source           = Source::SourceCode.from(source)
       @collector        = CLI::WarningCollector.new

data/lib/reek/rake/task.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rake'
 require 'rake/tasklib'

data/lib/reek/report.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'report/report'
 require_relative 'report/formatter'
 require_relative 'report/heading_formatter'

data/lib/reek/report/code_climate/code_climate_formatter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'codeclimate_engine'
 
 module Reek
@@ -27,11 +28,10 @@ module Reek
       end
 
       def check_name
-        [warning.smell_category, warning.smell_type].join('/')
+        warning.smell_type
       end
 
       def categories
-        # TODO: provide mappings for Reek's smell categories
         ['Complexity']
       end
 

data/lib/reek/report/formatter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'location_formatter'
 require_relative 'code_climate/code_climate_formatter'
 

data/lib/reek/report/heading_formatter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Report
     module HeadingFormatter

data/lib/reek/report/location_formatter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Report
     #

data/lib/reek/report/report.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 require 'pathname'
 require 'rainbow'
@@ -165,10 +166,9 @@ module Reek
       require 'erb'
 
       # @public
-      def show(target_path: Pathname.new('reek.html'))
+      def show
         template_path = Pathname.new("#{__dir__}/html_report.html.erb")
-        File.write target_path, ERB.new(template_path.read).result(binding)
-        puts 'HTML file saved'
+        puts ERB.new(template_path.read).result(binding)
       end
     end
 

data/lib/reek/smells.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smells/attribute'
 require_relative 'smells/boolean_parameter'
 require_relative 'smells/class_variable'

data/lib/reek/smells/attribute.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_configuration'
 require_relative 'smell_detector'
 require_relative 'smell_warning'

data/lib/reek/smells/boolean_parameter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -13,10 +14,6 @@ module Reek
     #
     # See {file:docs/Boolean-Parameter.md} for details.
     class BooleanParameter < SmellDetector
-      def self.smell_category
-        'ControlCouple'
-      end
-
       #
       # Checks whether the given method has any Boolean parameters.
       #

data/lib/reek/smells/class_variable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require_relative 'smell_detector'
 require_relative 'smell_warning'

data/lib/reek/smells/control_parameter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -42,10 +43,6 @@ module Reek
     #
     # See {file:docs/Control-Parameter.md} for details.
     class ControlParameter < SmellDetector
-      def self.smell_category
-        'ControlCouple'
-      end
-
       #
       # Checks whether the given method chooses its execution path
       # by testing the value of one of its parameters.
@@ -90,6 +87,8 @@ module Reek
         attr_reader :occurences, :param
       end
 
+      private_constant :FoundControlParameter
+
       # Finds cases of ControlParameter in a particular node for a particular parameter
       class ControlParameterFinder
         CONDITIONAL_NODE_TYPES = [:if, :case, :and, :or].freeze
@@ -166,6 +165,8 @@ module Reek
         end
       end
 
+      private_constant :ControlParameterFinder
+
       #
       # Collects all control parameters in a given context.
       #
@@ -192,6 +193,8 @@ module Reek
           ControlParameterFinder.new(context.exp, param).find_matches
         end
       end
+
+      private_constant :ControlParameterCollector
     end
   end
 end

data/lib/reek/smells/data_clump.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 

data/lib/reek/smells/duplicate_method_call.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -29,10 +30,6 @@ module Reek
       ALLOW_CALLS_KEY = 'allow_calls'.freeze
       DEFAULT_ALLOW_CALLS = [].freeze
 
-      def self.smell_category
-        'Duplication'
-      end
-
       def self.default_config
         super.merge(
           MAX_ALLOWED_CALLS_KEY => DEFAULT_MAX_CALLS,
@@ -89,6 +86,8 @@ module Reek
         attr_reader :call_node, :occurences
       end
 
+      private_constant :FoundCall
+
       # Collects all calls in a given context
       class CallCollector
         attr_reader :context
@@ -139,6 +138,8 @@ module Reek
           allow_calls.any? { |allow| /#{allow}/ =~ method }
         end
       end
+
+      private_constant :CallCollector
     end
   end
 end

data/lib/reek/smells/feature_envy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -35,10 +36,6 @@ module Reek
     #
     # See {file:docs/Feature-Envy.md} for details.
     class FeatureEnvy < SmellDetector
-      def self.smell_category
-        'LowCohesion'
-      end
-
       #
       # Checks whether the given +context+ includes any code fragment that
       # might "belong" on another class.

data/lib/reek/smells/irresponsible_module.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 

data/lib/reek/smells/long_parameter_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_configuration'
 require_relative 'smell_detector'
 require_relative 'smell_warning'

data/lib/reek/smells/long_yield_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -14,10 +15,6 @@ module Reek
       MAX_ALLOWED_PARAMS_KEY = 'max_params'.freeze
       DEFAULT_MAX_ALLOWED_PARAMS = 3
 
-      def self.smell_category
-        'LongParameterList'
-      end
-
       def self.default_config
         super.merge MAX_ALLOWED_PARAMS_KEY => DEFAULT_MAX_ALLOWED_PARAMS
       end

data/lib/reek/smells/module_initialize.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 

data/lib/reek/smells/nested_iterators.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -92,7 +93,7 @@ module Reek
       #
       # @return [Array<Iterator>]
       #
-      def scout(parent: raise, exp: raise, depth: raise)
+      def scout(parent:, exp:, depth:)
         return [Iterator.new(parent, depth)] unless exp
         iterators = exp.find_nodes([:block])
         return [Iterator.new(parent, depth)] if iterators.empty?

data/lib/reek/smells/nil_check.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -8,10 +9,6 @@ module Reek
     #
     # See {file:docs/Nil-Check.md} for details.
     class NilCheck < SmellDetector
-      def self.smell_category
-        'SimulatedPolymorphism'
-      end
-
       def inspect(ctx)
         call_node_finder = NodeFinder.new(ctx, :send, NilCallNodeDetector)
         case_node_finder = NodeFinder.new(ctx, :when, NilWhenNodeDetector)
@@ -45,6 +42,8 @@ module Reek
         attr_reader :detector, :nodes
       end
 
+      private_constant :NodeFinder
+
       # Detect 'call' nodes which perform a nil check.
       module NilCallNodeDetector
         module_function

data/lib/reek/smells/prima_donna_method.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'