Contents

# frozen_string_literal: true

require "rubocop"
require "yattho/classify/utilities"

# :nocov:
module RuboCop
  module Cop
    module Yattho
      # This cop ensures that components use System Arguments instead of CSS classes.
      #
      # bad
      # Component.new(classes: "mr-1")
      #
      # good
      # Component.new(mr: 1)
      class SystemArgumentInsteadOfClass < BaseCop
        INVALID_MESSAGE = <<~STR
          Avoid using CSS classes when you can use System Arguments: https://yattho.com/view-components/system-arguments.
        STR

        def on_send(node)
          return unless valid_node?(node)
          return unless node.arguments?

          # we are looking for hash arguments and they are always last
          kwargs = node.arguments.last

          return unless kwargs.type == :hash

          # find classes pair
          classes_arg = kwargs.pairs.find { |kwarg| kwarg.key.value == :classes }

          return if classes_arg.nil?
          return unless classes_arg.value.type == :str

          # get actual classes
          classes = classes_arg.value.value

          system_arguments = ::Yattho::Classify::Utilities.classes_to_hash(classes)

          # no classes are fixable
          return if system_arguments[:classes] == classes

          add_offense(classes_arg, message: INVALID_MESSAGE)
        end

        def autocorrect(node)
          lambda do |corrector|
            args = ::Yattho::Classify::Utilities.classes_to_args(node.value.value)
            corrector.replace(node.loc.expression, args)
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
yattho_view_components-0.1.1	lib/rubocop/cop/yattho/system_argument_instead_of_class.rb
yattho_view_components-0.0.1	lib/rubocop/cop/yattho/system_argument_instead_of_class.rb