module RSpec module Support # Provide additional output details beyond what `inspect` provides when # printing Time, DateTime, or BigDecimal module ObjectFormatter # @api private def self.format(object) prepare_for_inspection(object).inspect end # rubocop:disable MethodLength # @private # Prepares the provided object to be formatted by wrapping it as needed # in something that, when `inspect` is called on it, will produce the # desired output. # # This allows us to apply the desired formatting to hash/array data structures # at any level of nesting, simply by walking that structure and replacing items # with custom items that have `inspect` defined to return the desired output # for that item. Then we can just use `Array#inspect` or `Hash#inspect` to # format the entire thing. def self.prepare_for_inspection(object) case object when Array return object.map { |o| prepare_for_inspection(o) } when Hash return prepare_hash(object) when Time inspection = format_time(object) else if defined?(DateTime) && DateTime === object inspection = format_date_time(object) elsif defined?(BigDecimal) && BigDecimal === object inspection = "#{object.to_s 'F'} (#{object.inspect})" elsif RSpec::Support.is_a_matcher?(object) && object.respond_to?(:description) inspection = object.description else return object end end InspectableItem.new(inspection) end # rubocop:enable MethodLength # @private def self.prepare_hash(input) input.inject({}) do |hash, (k, v)| hash[prepare_for_inspection(k)] = prepare_for_inspection(v) hash end end TIME_FORMAT = "%Y-%m-%d %H:%M:%S" if Time.method_defined?(:nsec) # @private def self.format_time(time) time.strftime("#{TIME_FORMAT}.#{"%09d" % time.nsec} %z") end else # for 1.8.7 # @private def self.format_time(time) time.strftime("#{TIME_FORMAT}.#{"%06d" % time.usec} %z") end end DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S.%N %z" # ActiveSupport sometimes overrides inspect. If `ActiveSupport` is # defined use a custom format string that includes more time precision. # @private def self.format_date_time(date_time) if defined?(ActiveSupport) date_time.strftime(DATE_TIME_FORMAT) else date_time.inspect end end # @private InspectableItem = Struct.new(:inspection) do def inspect inspection end def pretty_print(pp) pp.text inspection end end end end end