require 'reek/smells/smell_detector'
require 'reek/smell_warning'

module Reek
  module Smells

    #
    # An Uncommunicative Name is a name that doesn't communicate its intent
    # well enough.
    # 
    # Poor names make it hard for the reader to build a mental picture
    # of what's going on in the code. They can also be mis-interpreted;
    # and they hurt the flow of reading, because the reader must slow
    # down to interpret the names.
    #
    # Currently +UncommunicativeName+ checks for
    # * 1-character names
    # * names ending with a number
    #
    class UncommunicativeVariableName < SmellDetector

      SMELL_CLASS = 'UncommunicativeName'
      SMELL_SUBCLASS = self.name.split(/::/)[-1]
      VARIABLE_NAME_KEY = 'variable_name'

      # The name of the config field that lists the regexps of
      # smelly names to be reported.
      REJECT_KEY = 'reject'

      DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/]

      # The name of the config field that lists the specific names that are
      # to be treated as exceptions; these names will not be reported as
      # uncommunicative.
      ACCEPT_KEY = 'accept'

      DEFAULT_ACCEPT_SET = ['_']

      def self.default_config
        super.merge(
          REJECT_KEY => DEFAULT_REJECT_SET,
          ACCEPT_KEY => DEFAULT_ACCEPT_SET
        )
      end

      def self.contexts      # :nodoc:
        [:module, :class, :defn, :defs]
      end

      #
      # Checks the given +context+ for uncommunicative names.
      #
      # @return [Array<SmellWarning>]
      #
      def examine_context(ctx)
        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
        variable_names(ctx.exp).select do |name, lines|
          is_bad_name?(name, ctx)
        end.map do |name, lines|
          SmellWarning.new(SMELL_CLASS, ctx.full_name, lines,
                           "has the variable name '#{name}'",
                           @source, SMELL_SUBCLASS, {VARIABLE_NAME_KEY => name.to_s})
        end
      end

      def is_bad_name?(name, ctx)
        var = name.to_s.gsub(/^[@\*\&]*/, '')
        return false if @accept_names.include?(var)
        @reject_names.detect {|patt| patt === var}
      end

      def variable_names(exp)
        result = Hash.new {|hash, key| hash[key] = []}
        find_assignment_variable_names(exp, result)
        find_block_argument_variable_names(exp, result)
        result.to_a.sort_by {|name, _| name.to_s}
      end

      def find_assignment_variable_names(exp, accumulator)
        assignment_nodes = exp.each_node(:lasgn, [:class, :module, :defs, :defn])

        case exp.first
          when :class, :module
            assignment_nodes += exp.each_node(:iasgn, [:class, :module])
        end

        assignment_nodes.each {|asgn| accumulator[asgn[1]].push(asgn.line) }
      end

      def find_block_argument_variable_names(exp, accumulator)
        arg_search_exp = case exp.first
                         when :class, :module
                           exp
                         when :defs, :defn
                           exp.body
                         end

        args_nodes = arg_search_exp.each_node(:args, [:class, :module, :defs, :defn])

        args_nodes.each do |args_node|
          recursively_record_variable_names(accumulator, args_node)
        end
      end

      def recursively_record_variable_names(accumulator, exp)
        exp[1..-1].each do |subexp|
          if subexp.is_a? Symbol
            record_variable_name(exp, subexp, accumulator)
          elsif subexp.first == :masgn
            recursively_record_variable_names(accumulator, subexp)
          end
        end
      end

      def record_variable_name(exp, symbol, accumulator)
        varname = symbol.to_s.sub(/^\*/, '')
        if varname != ""
          var = varname.to_sym
          accumulator[var].push(exp.line)
        end
      end
    end
  end
end