Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix properties with undefined value pass property assertion #308

Merged
merged 7 commits into from
Dec 2, 2014

Conversation

joshperry
Copy link
Contributor

I was doing some interface assertions and noticed that properties that have a value of undefined assert as not existing. This is an initial hack at how I think this could be resolved. I just wanted to get this up and get some suggestions and comments to tighten this up.

var obj = { foo: undefined };
Object.defineProperty(obj, 'bar', {
    get: function() { }
});
// These both assert without this change
obj.should.have.property('foo');
obj.should.have.property('bar');

Fixes #184

@FredKSchott
Copy link

+1 it looks like @devand123 stopped responding to comments in #210, happy to move discussion/work over to this PR

return (typeof obj === 'object' || typeof obj === 'string' || typeof obj === 'function')
&& name in (typeof obj !== 'string' ? obj : new String(obj))
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't this function be defined outside the addMethod anon function?

@keithamus
Copy link
Member

Good work @joshperry 😄. I'd like to see a couple of comments addressed above, but largely this is looking in better shape than #210

@joshperry
Copy link
Contributor Author

I wasn't handling array indexes terminating the path, I figured an array index isn't technically a property. However, it looks like the documentation sells this, so I added the code in the documentation to the unit tests and added this functionality.

I also did some deduplication and cleanup of the code.

((typeof obj === 'object' || typeof obj === 'string' || typeof obj === 'function') &&
name in (typeof obj !== 'string' ? obj : new String(obj)))
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still looks like this function could be defined outside of Assertion.addMethod('property', function (name, val, msg) { (i.e. above line 765).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not against moving this outside, but it has no general applicability outside of this code. My own personal style is to put functions that are akin to variables inside of the scope where they are used, if it is more in-line with the project's style to have this outside then I'm cool with that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What you have done here is quite clever, however it is not very maintainable as its logic is quite dense. By moving it out of .addProperty you can provide first class documentation for its workings. Perhaps it might be relevant to add it as new utility and expose it for other plugin developers (just in case it has further use)?

Furthermore, any reason you are using typeof instead of our type-detect utility? I would also recommend just doing the type detection once to reduce overhead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback guys. I honestly wasn't trying to be clever, just adding functionality as I added more and more tests.

Ok, here's my plan:

  • A new util function getPathInfo that returns the property info struct including whether the property actually exists or not.
  • Keep getPathValue for back compat, but it can easily be implemented by calling getPropertyInfo to share the bulk of the code.

This will allow me to properly document the general functionality and make it available to others.

I'll take a look at the type utility you mentioned, I'm still getting introduced to the codebase.

@joshperry
Copy link
Contributor Author

I think this wraps things up guys, let me know what you think.

@@ -1,10 +1,12 @@
/*!
* Chai - getPathValue utility
* Chai - getPathInfo utility
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still getPathValue...

@logicalparadox
Copy link
Member

I'd like @keithamus to get eyes on this as well, but you got my 👍

@keithamus
Copy link
Member

Sorry, must have missed this notification. Given it a thorough look over and it looks amazing to me. Great work @joshperry!

keithamus added a commit that referenced this pull request Dec 2, 2014
Fix properties with `undefined` value pass property assertion
@keithamus keithamus merged commit 7de269a into chaijs:master Dec 2, 2014
@keithamus keithamus mentioned this pull request Feb 12, 2015
koulmomo added a commit to yahoo/fluxible-action-utils that referenced this pull request Feb 26, 2015
modify unit tests due to breaking changes from chai 1.10 -> 2.0
chaijs/chai#308
chaijs/chai#306
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Property assertion fails when object has a field with undefined values
4 participants