Contents

# frozen_string_literal: true

require 'digest'

module Reek
  module CodeClimate
    # Generates a string to uniquely identify a smell
    class CodeClimateFingerprint
      NON_IDENTIFYING_PARAMETERS = [:count, :depth].freeze

      def initialize(warning)
        @warning = warning
      end

      def compute
        return unless warning_uniquely_identifiable?

        identify_warning

        identifying_aspects.hexdigest.freeze
      end

      private

      attr_reader :warning

      def identify_warning
        identifying_aspects << warning.source
        identifying_aspects << warning.smell_type
        identifying_aspects << warning.context
        identifying_aspects << parameters
      end

      def identifying_aspects
        @identifying_aspects ||= Digest::MD5.new
      end

      def parameters
        warning.parameters.except(*NON_IDENTIFYING_PARAMETERS).sort.to_s
      end

      def warning_uniquely_identifiable?
        # These could be identifiable if they had parameters
        ![
          'ManualDispatch',
          'NilCheck'
        ].include?(warning.smell_type)
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
reek-6.4.0	lib/reek/code_climate/code_climate_fingerprint.rb
reek-6.3.0	lib/reek/code_climate/code_climate_fingerprint.rb
reek-6.2.0	lib/reek/code_climate/code_climate_fingerprint.rb