Sha256: ff78e3d16d1224260365256b758961dc29138f516b58d8a98666530f5e9a9668

Contents?: true

Size: 1.4 KB

Versions: 73

Compression:

Stored size: 1.4 KB

Contents

# encoding: utf-8
module Mongoid

  # Contains the bahviour around inspecting documents via inspect.
  #
  # @since 4.0.0
  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.
    #
    # @since 1.0.0
    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.
    #
    # @since 1.0.0
    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.
    #
    # @since 1.0.0
    def inspect_dynamic_fields
      []
    end
  end
end

Version data entries

73 entries across 68 versions & 6 rubygems

Version Path
mongoid-7.0.13 lib/mongoid/inspectable.rb
mongoid-7.0.12 lib/mongoid/inspectable.rb
mongoid-6.4.8 lib/mongoid/inspectable.rb
mongoid-7.0.11 lib/mongoid/inspectable.rb
mongoid-7.0.10 lib/mongoid/inspectable.rb
mongoid-6.4.7 lib/mongoid/inspectable.rb
mongoid-6.4.5 lib/mongoid/inspectable.rb
mongoid-7.0.8 lib/mongoid/inspectable.rb
mongoid-7.0.7 lib/mongoid/inspectable.rb
mongoid-7.0.6 lib/mongoid/inspectable.rb
mongoid-5.4.1 lib/mongoid/inspectable.rb
mongoid-7.0.5 lib/mongoid/inspectable.rb
mongoid-7.0.4 lib/mongoid/inspectable.rb
mongoid-6.4.4 lib/mongoid/inspectable.rb
mongoid-7.0.3 lib/mongoid/inspectable.rb
mongoid-6.4.2 lib/mongoid/inspectable.rb
mongoid-7.0.2 lib/mongoid/inspectable.rb
mongoid-7.0.1 lib/mongoid/inspectable.rb
mongoid-6.4.1 lib/mongoid/inspectable.rb
mongoid-5.4.0 lib/mongoid/inspectable.rb