Contents

module Reek
  module Core

    #
    # 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'

      # The name of the config field that sets scope-specific overrides
      # for other values in the current smell detector's configuration.
      OVERRIDES_KEY = 'overrides'

      def initialize(hash)
        @options = hash
      end

      def adopt!(options)
        @options.adopt!(options)
      end

      def deep_copy
        @options.deep_copy     # SMELL: Open Secret -- returns a Hash
      end

      #
      # Is this smell detector active?
      #--
      #  SMELL: Getter
      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+.
      #
      # Returns +fall_back+ if this config has no value for the key.
      #
      def value(key, context, fall_back)
        overrides_for(context).each { |conf| return conf[key] if conf.has_key?(key) }
        return @options.fetch(key, fall_back)
      end
    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
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
reek-1.2.7.2	lib/reek/core/smell_configuration.rb
reek-1.2.7.1	lib/reek/core/smell_configuration.rb
reek-1.2.7	lib/reek/core/smell_configuration.rb