fix: .include to work with all objects

[meeber]

Overly strict type-checking was causing .include to reject Error
objects and objects with a custom @@toStringTag.

Fixes #1009

[vieiralucas]

Awesome as always

LGTM

[shvaikalesh]

Maybe we should move this check to default to eliminate !== 'string' check and use val === Object(val) to avoid === 'null' and allow functions?

[meeber]

@shvaikalesh @vieiralucas Updated.

[shvaikalesh]

Great job, @meeber. LGTM.

[metareven]

@meeber

This does not work. The following object still gives the error message:

AssertionError: object tested must be an array, a map, an object, a set, a string, or a weakset, but object given

When using:
expect(object).to.include('notReady')

{ id: 674,
  title: 'El Globo',
  floors: [ 4 ],
  topFloors: 0,
  ui: 
   { statusBarMenuVisible: false,
     statusBarMenuInitial: true,
     loggedInUsersMenuVisible: false,
     loggedInUsersMenuInitial: true,
     lockLabelOn: false },
  status: 
   { isPublishable: true,
     isBeingPublished: false,
     isDirty: false,
     published: false,
     stored: false },
  itemId: 1,
  createdBy: 'kurator2',
  createdDate: 1476885553000,
  latest: true,
  live: false,
  parentId: undefined,
  notReady: 
   { isHouseLockedByAnother: true,
     isAlreadyPublished: false,
     isAlreadyStored: false,
     isSingleFloor: false,
     isTemporaryFloor: false,
     isSingleRoom: false },
  type: undefined 
}

Tested on both chai 4.1.1 and chai 4.1.2

[meeber]

@metareven According to the docs, I don't think you can use .include in this way. Since your target is an object, the value you pass has to be an object too, not a string. This should work instead for your usage: expect(object).to.have.property('notReady');.

With that said, something is clearly not right with this error message and this PR in general. It's been quite awhile since I looked at the Chai codebase, but I'm thinking if (val !== Object(val)) { should be if (obj !== Object(obj)) { instead, and then a separate check is needed afterward to make sure val is an object as well with a more precise error message if it's not.