Contents

module Reek

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

    attr_reader :hash

    def initialize(hash)
      @hash = hash
    end

    # SMELL: Getter
    def enabled?
      @hash[ENABLED_KEY]
    end

    def overrides_for(context)
      Overrides.new(@hash.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 @hash.fetch(key, fall_back)
    end
  end

  class Overrides
    def initialize(hash)
      @hash = hash
    end

    def for_context(context)
      contexts = @hash.keys.select {|ckey| context.matches?([ckey])}
      contexts.map { |exc| @hash[exc] }
    end
  end
end

Version data entries

7 entries across 7 versions & 2 rubygems

Version	Path
kevinrutherford-reek-1.1.3.14	lib/reek/configuration.rb
kevinrutherford-reek-1.1.3.15	lib/reek/configuration.rb
kevinrutherford-reek-1.1.3.16	lib/reek/configuration.rb
kevinrutherford-reek-1.2.0	lib/reek/configuration.rb
reek-1.2.2	lib/reek/configuration.rb
reek-1.2.1	lib/reek/configuration.rb
reek-1.2.0	lib/reek/configuration.rb