Contents

# encoding: utf-8

module Rubocop
  module Cop
    class MethodAndVariableSnakeCase < Cop
      MSG = 'Use snake_case for methods and variables.'
      SNAKE_CASE = /^@?[\da-z_]+[!?=]?$/

      # http://phrogz.net/programmingruby/language.html#table_18.4
      OPERATOR_METHODS = %w(
        | ^ & <=> == === =~ > >= < <= << >>
        + - * / % ** ~ +@ -@ [] []= ` ! != !~
      ).map(&:to_sym)

      def inspect(source, tokens, node, comments)
        on_node([:def, :defs, :lvasgn, :ivasgn, :send], node) do |n|
          name = case n.type
                 when :def
                   name_of_instance_method(n)
                 when :defs
                   name_of_singleton_method(n)
                 when :lvasgn, :ivasgn
                   name_of_variable(n)
                 when :send
                   name_of_setter(n)
                 end

          next unless name
          next if name =~ SNAKE_CASE || OPERATOR_METHODS.include?(name)

          add_offence(:convention, n.location.line, MSG)
        end
      end

      def name_of_instance_method(def_node)
        def_node.children.first
      end

      def name_of_singleton_method(defs_node)
        defs_node.children[1]
      end

      def name_of_variable(vasgn_node)
        vasgn_node.children.first
      end

      def name_of_setter(send_node)
        receiver, method_name = *send_node
        return nil unless receiver && receiver.type == :self
        return nil unless method_name.to_s.end_with?('=')
        method_name
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
rubocop-0.8.3	lib/rubocop/cop/method_and_variable_snake_case.rb
rubocop-0.8.2	lib/rubocop/cop/method_and_variable_snake_case.rb
rubocop-0.8.1	lib/rubocop/cop/method_and_variable_snake_case.rb
rubocop-0.8.0	lib/rubocop/cop/method_and_variable_snake_case.rb