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

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Rails::TimeZone

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/bbatsov/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:

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

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

# no offense only if style is 'acceptable'
Time.current
DateTime.strptime(str, "%Y-%m-%d %H:%M %Z").in_time_zone
Time.at(timestamp).in_time_zone

Constant Summary

MSG =

'Do not use `%s` without zone. Use `%s` instead.'.freeze

MSG_ACCEPTABLE =

'Do not use `%s` without zone. ' \
'Use one of %s instead.'.freeze

MSG_LOCALTIME =

'Do not use `Time.localtime` without ' \
'offset or zone.'.freeze

MSG_CURRENT =

'Do not use `%s`. Use `Time.zone.now` instead.'.freeze

TIMECLASS =

[:Time, :DateTime].freeze

DANGEROUS_METHODS =

[:now, :local, :new, :strftime,
:parse, :at, :current].freeze

ACCEPTED_METHODS =

[:in_time_zone, :utc, :getlocal,
:iso8601, :jisx0301, :rfc3339,
:to_i, :to_f].freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #on_const(node) ⇒ Object

Methods included from ConfigurableEnforcedStyle

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

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_const(node) ⇒ Object

# File 'lib/rubocop/cop/rails/time_zone.rb', line 53

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

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