feat: add propNotEq (#275)

Closes #238

src/index.d.ts

@@ -569,6 +569,17 @@ declare namespace RamdaAdjunct {
             from(lens: Function): Function
         }
 
+        /**
+         * Returns true if the specified object property is not equal,
+         * in R.equals terms, to the given value; false otherwise.
+         */
+        propNotEq(prop: string|number, value: any, obj: object): boolean;
+        propNotEq(prop: string|number, value: any): (obj: object) => boolean;
+        propNotEq(prop: string|number): {
+            (value: any, obj: object): boolean;
+            (value: any): (obj: object) => boolean;
+        }
+
         /**
          * Returns whether or not an object has an own property with the specified name at a given path.
          */

src/index.js

@@ -115,6 +115,7 @@ export { default as lensNotEq } from './lensNotEq';
 export { default as lensSatisfies } from './lensSatisfies';
 export { default as lensNotSatisfy } from './lensNotSatisfy';
 export { default as lensIso } from './lensIso';
+export { default as propNotEq } from './propNotEq';
 // Logic
 export { default as defaultWhen } from './defaultWhen';
 export { default as notBoth } from './notBoth';

src/propNotEq.js

@@ -0,0 +1,23 @@
+import { propEq, complement, curryN } from 'ramda';
+
+/**
+ * Returns true if the specified object property is not equal,
+ * in R.equals terms, to the given value; false otherwise.
+ *
+ * @func propNotEq
+ * @memberOf RA
+ * @since {@link https://char0n.github.io/ramda-adjunct/1.1.0|v1.1.0}
+ * @category Relation
+ * @sig  String → a → Object → Boolean
+ * @param {String} prop The prop to pick
+ * @param {a} value The value to compare to
+ * @param {Object} object The object, that presumably contains value under the prop
+ * @return {Boolean} Comparison result
+ * @see {@link http://ramdajs.com/docs/#propEq|propEq}
+ * @example
+ *
+ * RA.propNotEq('Not you!', 'a', { a: 'foo', b: 'bar' }); //=> true
+ */
+const propNotEq = curryN(3, complement(propEq));
+
+export default propNotEq;

test/propNotEq.js

@@ -0,0 +1,41 @@
+import * as RA from '../src/index';
+import eq from './shared/eq';
+
+
+describe('propNotEq', function() {
+  let prop;
+  let value;
+  let obj;
+  let expected;
+
+  beforeEach(function() {
+    prop = 'a';
+    value = 'foo';
+    obj = { a: 1, b: 2 };
+    expected = true;
+  });
+
+  it('tests currying', function() {
+    eq(RA.propNotEq(prop, value, obj), expected);
+    eq(RA.propNotEq(prop)(value, obj), expected);
+    eq(RA.propNotEq(prop, value)(obj), expected);
+    eq(RA.propNotEq(prop)(value)(obj), expected);
+  });
+
+  it('tests prop value is not equal', function() {
+    eq(RA.propNotEq(prop, value, obj), expected);
+  });
+
+  it('tests prop value is equal', function() {
+    value = 1;
+    expected = false;
+
+    eq(RA.propNotEq(prop, value, obj), expected);
+  });
+
+  it('tests no prop', function() {
+    prop = 'bar';
+
+    eq(RA.propNotEq(prop, value, obj), expected);
+  });
+});