Sha256: d019cce89d1fccab9c7c4c870b75ef5fefb70900abb3906ff980e4be2cdd35b5

Contents?: true

Size: 1.32 KB

Versions: 29

Compression:

Stored size: 1.32 KB

Contents

# frozen_string_literal: true

module Mongoid

  # Contains the behavior around inspecting documents via inspect.
  module Inspectable

    # Returns the class name plus its attributes. If using dynamic fields will
    # include those as well.
    #
    # @example Inspect the document.
    #   person.inspect
    #
    # @return [ String ] A nice pretty string to look at.
    def inspect
      inspection = []
      inspection.concat(inspect_fields).concat(inspect_dynamic_fields)
      "#<#{self.class.name} _id: #{_id}, #{inspection * ', '}>"
    end

    private

    # Get an array of inspected fields for the document.
    #
    # @api private
    #
    # @example Inspect the defined fields.
    #   document.inspect_fields
    #
    # @return [ String ] An array of pretty printed field values.
    def inspect_fields
      fields.map do |name, field|
        unless name == "_id"
          as = field.options[:as]
          "#{name}#{as ? "(#{as})" : nil}: #{@attributes[name].inspect}"
        end
      end.compact
    end

    # Get an array of inspected dynamic fields for the document.
    #
    # @api private
    #
    # @example Inspect the dynamic fields.
    #   document.inspect_dynamic_fields
    #
    # @return [ String ] An array of pretty printed dynamic field values.
    def inspect_dynamic_fields
      []
    end
  end
end

Version data entries

29 entries across 29 versions & 1 rubygems

Version Path
mongoid-8.0.10 lib/mongoid/inspectable.rb
mongoid-8.1.10 lib/mongoid/inspectable.rb
mongoid-8.1.9 lib/mongoid/inspectable.rb
mongoid-8.0.9 lib/mongoid/inspectable.rb
mongoid-8.1.8 lib/mongoid/inspectable.rb
mongoid-8.1.7 lib/mongoid/inspectable.rb
mongoid-8.1.6 lib/mongoid/inspectable.rb
mongoid-8.0.8 lib/mongoid/inspectable.rb
mongoid-8.1.5 lib/mongoid/inspectable.rb
mongoid-8.1.4 lib/mongoid/inspectable.rb
mongoid-8.0.7 lib/mongoid/inspectable.rb
mongoid-8.1.3 lib/mongoid/inspectable.rb
mongoid-8.1.2 lib/mongoid/inspectable.rb
mongoid-8.0.6 lib/mongoid/inspectable.rb
mongoid-7.5.4 lib/mongoid/inspectable.rb
mongoid-8.1.1 lib/mongoid/inspectable.rb
mongoid-8.0.5 lib/mongoid/inspectable.rb
mongoid-8.1.0 lib/mongoid/inspectable.rb
mongoid-7.5.3 lib/mongoid/inspectable.rb
mongoid-8.0.4 lib/mongoid/inspectable.rb