yast/rubocop-yast

# encoding: utf-8

require "rubocop/yast/builtins/builtin"
require "rubocop/yast/builtins/getenv"
require "rubocop/yast/builtins/time"
require "rubocop/yast/builtins/y2log"

module RuboCop
  module Cop
    module Yast
      # This cop checks for using obsoleted Yast Builtins calls
      class Builtins < Cop
        include AST::Sexp

        attr_reader :handlers, :default_handler

        MSG = "Builtin call `%s` is obsolete, use native Ruby function instead."

        BUILTINS_NODES = [
          # Builtins.*
          s(:const, nil, :Builtins),
          # Yast::Builtins.*
          s(:const, s(:const, nil, :Yast), :Builtins),
          # ::Yast::Builtins.*
          s(:const, s(:const, s(:cbase), :Yast), :Builtins)
        ]

        def initialize(config = nil, options = nil)
          super(config, options)

          @handlers = builtin_mapping
          @default_handler = RuboCop::Yast::Builtins::Builtin.new
        end

        def on_send(node)
          receiver, method_name, *_args = *node

          # not an Yast builtin call or not an offense
          return if !BUILTINS_NODES.include?(receiver) ||
              !builtin_handler(method_name).offense?(node)

          add_offense(node, :selector, format(MSG, method_name))
        end

        def autocorrect(node)
          _builtins, method_name, *_args = *node

          @corrections << builtin_handler(method_name).correction(node)
        end

        private

        # rubocop:disable Metrics/MethodLength
        def builtin_mapping
          # use the same instance for all logging functions
          logging = RuboCop::Yast::Builtins::Y2log.new

          {
            y2debug: logging,
            y2milestone: logging,
            y2warning: logging,
            y2error: logging,
            y2security: logging,
            y2internal: logging,

            getenv: RuboCop::Yast::Builtins::Getenv.new,
            time: RuboCop::Yast::Builtins::Time.new
          }
        end
        # rubocop:enable Metrics/MethodLength

        def builtin_handler(method)
          handlers[method] || default_handler
        end
      end
    end
  end
end