Class: RuboCop::Cop::Rails::RelativeDateConstant

Inherits:
Cop
  • Object
show all
Includes:
RuboCop::Cop::RangeHelp
Defined in:
lib/rubocop/cop/rails/relative_date_constant.rb

Overview

This cop checks whether constant value isn’t relative date. Because the relative date will be evaluated only once.

Examples:

# bad
class SomeClass
  EXPIRED_AT = 1.week.since
end

# good
class SomeClass
  def self.expired_at
    1.week.since
  end
end

Constant Summary collapse

MSG = 
'Do not assign %<method_name>s to constants as it ' \
'will be evaluated only once.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 56

def autocorrect(node)
  return unless node.casgn_type?

  scope, const_name, value = *node
  return unless scope.nil?

  indent = ' ' * node.loc.column
  new_code = ["def self.#{const_name.downcase}",
              "#{indent}#{value.source}",
              'end'].join("\n#{indent}")
  ->(corrector) { corrector.replace(node.source_range, new_code) }
end

#on_casgn(node) ⇒ Object 



27
28
29
30
31
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 27

def on_casgn(node)
  relative_date_assignment?(node) do |method_name|
    add_offense(node, message: format(MSG, method_name: method_name))
  end
end

#on_masgn(node) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 33

def on_masgn(node)
  lhs, rhs = *node

  return unless rhs&.array_type?

  lhs.children.zip(rhs.children).each do |(name, value)|
    next unless name.casgn_type?

    relative_date?(value) do |method_name|
      add_offense(node,
                  location: range_between(name.loc.expression.begin_pos,
                                          value.loc.expression.end_pos),
                  message: format(MSG, method_name: method_name))
    end
  end
end

#on_or_asgn(node) ⇒ Object 



50
51
52
53
54
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 50

def on_or_asgn(node)
  relative_date_or_assignment?(node) do |method_name|
    add_offense(node, message: format(MSG, method_name: method_name))
  end
end