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

Inherits:
Cop
  • Object
show all
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 %s to constants as it will be evaluated only ' \
'once.'.freeze
RELATIVE_DATE_METHODS = 
%i[ago from_now since until].freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, 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 



54
55
56
57
58
59
60
61
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 54

def autocorrect(node)
  _scope, const_name, value = *node
  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
32
33
34
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 27

def on_casgn(node)
  _scope, _constant, rhs = *node

  # rhs would be nil in a or_asgn node
  return unless rhs

  check_node(rhs)
end

#on_masgn(node) ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 36

def on_masgn(node)
  lhs, rhs = *node

  return unless rhs && rhs.array_type?

  lhs.children.zip(rhs.children).each do |(name, value)|
    check_node(value) if name.casgn_type?
  end
end

#on_or_asgn(node) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/rails/relative_date_constant.rb', line 46

def on_or_asgn(node)
  lhs, rhs = *node

  return unless lhs.casgn_type?

  check_node(rhs)
end