Class: RuboCop::Cop::Rails::TimeZone

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/rails/time_zone.rb

Overview

This cop checks for the use of Time methods without zone.

Built on top of Ruby on Rails style guide (github.com/rubocop-hq/rails-style-guide#time) and the article danilenko.org/2012/7/6/rails_timezones/

Two styles are supported for this cop. When EnforcedStyle is ‘strict’ then only use of Time.zone is allowed.

When EnforcedStyle is ‘flexible’ then it’s also allowed to use Time.in_time_zone.

Examples:

EnforcedStyle: strict

# `strict` means that `Time` should be used with `zone`.

# bad
Time.now
Time.parse('2015-03-02 19:05:37')

# bad
Time.current
Time.at(timestamp).in_time_zone

# good
Time.zone.now
Time.zone.parse('2015-03-02 19:05:37')

EnforcedStyle: flexible (default)

# `flexible` allows usage of `in_time_zone` instead of `zone`.

# bad
Time.now
Time.parse('2015-03-02 19:05:37')

# good
Time.zone.now
Time.zone.parse('2015-03-02 19:05:37')

# good
Time.current
Time.at(timestamp).in_time_zone

Constant Summary collapse

MSG = 
'Do not use `%<current>s` without zone. Use `%<prefer>s` ' \
'instead.'
MSG_ACCEPTABLE = 
'Do not use `%<current>s` without zone. ' \
'Use one of %<prefer>s instead.'
MSG_LOCALTIME = 
'Do not use `Time.localtime` without ' \
'offset or zone.'
TIMECLASSES = 
%i[Time DateTime].freeze
GOOD_METHODS = 
%i[zone zone_default find_zone find_zone!].freeze
DANGEROUS_METHODS = 
%i[now local new parse at current].freeze
ACCEPTED_METHODS = 
%i[in_time_zone utc getlocal xmlschema iso8601
jisx0301 rfc3339 httpdate to_i to_f].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rubocop/cop/rails/time_zone.rb', line 76

def autocorrect(node)
  lambda do |corrector|
    # add `.zone`: `Time.at` => `Time.zone.at`
    corrector.insert_after(node.children[0].source_range, '.zone')
    # replace `Time.zone.current` => `Time.zone.now`
    if node.method_name == :current
      corrector.replace(node.loc.selector, 'now')
    end
    # prefer `Time` over `DateTime` class
    if strict?
      corrector.replace(node.children.first.source_range, 'Time')
    end
    remove_redundant_in_time_zone(corrector, node)
  end
end

#on_const(node) ⇒ Object 



67
68
69
70
71
72
73
74
 
# File 'lib/rubocop/cop/rails/time_zone.rb', line 67

def on_const(node)
  mod, klass = *node
  # we should only check core classes
  # (`DateTime`, `Time`, `::DateTime` or `::Time`)
  return unless (mod.nil? || mod.cbase_type?) && method_send?(node)

  check_time_node(klass, node.parent) if TIMECLASSES.include?(klass)
end