Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Checks that memoized helpers names are symbols or strings.
      #
      # @example EnforcedStyle: symbols (default)
      #   # bad
      #   subject('user') { create_user }
      #   let('user_name') { 'Adam' }
      #
      #   # good
      #   subject(:user) { create_user }
      #   let(:user_name) { 'Adam' }
      #
      # @example EnforcedStyle: strings
      #   # bad
      #   subject(:user) { create_user }
      #   let(:user_name) { 'Adam' }
      #
      #   # good
      #   subject('user') { create_user }
      #   let('user_name') { 'Adam' }
      class VariableDefinition < Base
        include ConfigurableEnforcedStyle
        include RuboCop::RSpec::Variable

        MSG = 'Use %<style>s for variable names.'

        def on_send(node)
          variable_definition?(node) do |variable|
            if style_violation?(variable)
              add_offense(variable, message: format(MSG, style: style))
            end
          end
        end

        private

        def style_violation?(variable)
          style == :symbols && string?(variable) ||
            style == :strings && symbol?(variable)
        end

        def string?(node)
          node.str_type?
        end

        def symbol?(node)
          node.sym_type? || node.dsym_type?
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
rubocop-rspec-2.0.0.pre	lib/rubocop/cop/rspec/variable_definition.rb
rubocop-rspec-1.44.1	lib/rubocop/cop/rspec/variable_definition.rb
rubocop-rspec-1.44.0	lib/rubocop/cop/rspec/variable_definition.rb
rubocop-rspec-1.43.2	lib/rubocop/cop/rspec/variable_definition.rb
rubocop-rspec-1.43.1	lib/rubocop/cop/rspec/variable_definition.rb
rubocop-rspec-1.43.0	lib/rubocop/cop/rspec/variable_definition.rb