class RuboCop::Cop::Rails::Date
This cop checks for the correct use of Date
methods, such as Date.today, Date.current etc.
Using `Date.today` is dangerous, because it doesn't know anything about Rails
time zone. You must use `Time.zone.today` instead.
The cop also reports warnings when you are using `to_time` method, because it doesn't know about Rails
time zone either.
Two styles are supported for this cop. When `EnforcedStyle` is 'strict' then the Date
methods `today`, `current`, `yesterday`, and `tomorrow` are prohibited and the usage of both `to_time` and 'to_time_in_current_zone' are reported as warning.
When `EnforcedStyle` is `flexible` then only `Date.today` is prohibited.
And you can set a warning for `to_time` with `AllowToTime: false`. `AllowToTime` is `true` by default to prevent false positive on `DateTime` object.
@example EnforcedStyle: strict
# bad Date.current Date.yesterday Date.today # good Time.zone.today Time.zone.today - 1.day
@example EnforcedStyle: flexible (default)
# bad Date.today # good Time.zone.today Time.zone.today - 1.day Date.current Date.yesterday date.in_time_zone
@example AllowToTime: true (default)
# good date.to_time
@example AllowToTime: false
# bad date.to_time
Constants
- BAD_DAYS
- DEPRECATED_METHODS
- DEPRECATED_MSG
- MSG
- MSG_SEND
- RESTRICT_ON_SEND
Public Instance Methods
# File lib/rubocop/cop/rails/date.rb, line 73 def on_const(node) mod, klass = *node.children # we should only check core Date class (`Date` or `::Date`) return unless (mod.nil? || mod.cbase_type?) && method_send?(node) check_date_node(node.parent) if klass == :Date end
# File lib/rubocop/cop/rails/date.rb, line 81 def on_send(node) return unless node.receiver && bad_methods.include?(node.method_name) return if allow_to_time? && node.method?(:to_time) return if safe_chain?(node) || safe_to_time?(node) check_deprecated_methods(node) add_offense(node.loc.selector, message: format(MSG_SEND, method: node.method_name)) end
Private Instance Methods
# File lib/rubocop/cop/rails/date.rb, line 149 def allow_to_time? cop_config.fetch('AllowToTime', true) end
# File lib/rubocop/cop/rails/date.rb, line 157 def bad_days BAD_DAYS - good_days end
# File lib/rubocop/cop/rails/date.rb, line 161 def bad_methods %i[to_time to_time_in_current_zone] end
# File lib/rubocop/cop/rails/date.rb, line 104 def check_date_node(node) chain = extract_method_chain(node) return if (chain & bad_days).empty? method_name = (chain & bad_days).join('.') day = method_name day = 'today' if method_name == 'current' message = format(MSG, method_called: method_name, day: day) add_offense(node.loc.selector, message: message) end
# File lib/rubocop/cop/rails/date.rb, line 94 def check_deprecated_methods(node) DEPRECATED_METHODS.each do |method| next unless node.method?(method[:deprecated].to_sym) message = format(DEPRECATED_MSG, deprecated: method[:deprecated], relevant: method[:relevant]) add_offense(node.loc.selector, message: message) end end
# File lib/rubocop/cop/rails/date.rb, line 119 def extract_method_chain(node) [node, *node.each_ancestor(:send)].map(&:method_name) end
# File lib/rubocop/cop/rails/date.rb, line 153 def good_days style == :strict ? [] : %i[current yesterday tomorrow] end
# File lib/rubocop/cop/rails/date.rb, line 165 def good_methods style == :strict ? [] : TimeZone::ACCEPTED_METHODS end
checks that parent node of send_type and receiver is the given node
# File lib/rubocop/cop/rails/date.rb, line 125 def method_send?(node) return false unless node.parent&.send_type? node.parent.receiver == node end
# File lib/rubocop/cop/rails/date.rb, line 131 def safe_chain?(node) chain = extract_method_chain(node) (chain & bad_methods).empty? || !(chain & good_methods).empty? end
# File lib/rubocop/cop/rails/date.rb, line 137 def safe_to_time?(node) return unless node.method?(:to_time) if node.receiver.str_type? zone_regexp = /([+-][\d:]+|\dZ)\z/ node.receiver.str_content.match(zone_regexp) else node.arguments.one? end end