New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

icepick

Package Overview
Dependencies
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

icepick - npm Package Compare versions

Comparing version

0.3.0
to
0.4.0

58

icepick.js

@@ -13,4 +13,3 @@ /**

var i = exports,
slice = [].slice;
var i = exports;

@@ -25,4 +24,9 @@ // we only care about objects or arrays for now

// circular.
(typeof val === "object" && val.constructor === Object));
isObjectLike(val));
}
function isObjectLike(val) {
return typeof val === "object" && val.constructor === Object;
}
// for testing

@@ -218,3 +222,3 @@ exports._weCareAbout = weCareAbout;

exports.assign = function assign(/*...objs*/) {
var newObj = slice.call(arguments).reduce(singleAssign, {});
var newObj = _slice(arguments).reduce(singleAssign, {});

@@ -231,4 +235,48 @@ return Object.freeze(newObj);

exports.merge = merge;
function merge(target, source) {
return Object.keys(source).reduce(function (obj, key) {
var sourceVal = source[key];
var targetVal = obj[key];
if (weCareAbout(sourceVal) && weCareAbout(targetVal)) {
// if they are both frozen and reference equal, assume they are deep equal
if (Object.isFrozen(sourceVal) &&
Object.isFrozen(targetVal) &&
sourceVal === targetVal) {
return obj;
}
if (Array.isArray(sourceVal)) {
return i.assoc(obj, key, sourceVal);
}
// recursively merge pairs of objects
return assocIfDifferent(obj, key, merge(targetVal, sourceVal));
}
// primitive values, stuff with prototypes
return assocIfDifferent(obj, key, sourceVal);
}, target);
}
function assocIfDifferent(target, key, value) {
if (target[key] === value) {
return target;
}
return i.assoc(target, key, value);
}
function _slice(array, start) {
var begin = start || 0;
var len = array.length;
len -= begin;
len = len < 0 ? 0 : len;
var result = new Array(len);
for (var i = 0; i < len; i += 1) {
result[i] = array[i + begin];
}
return result;
}
function rest(args) {
return slice.call(args, 1);
return _slice(args, 1);
}

75

icepick.test.js

@@ -53,2 +53,11 @@ /* jshint elision:true */

it("should freeze objects you assoc", function () {
var o = i.freeze({a: 1, b: 2, c: 3}),
result = i.assoc(o, "b", {d: 5});
expect(result).to.eql({a: 1, b: {d: 5}, c: 3});
expect(Object.isFrozen(result.b)).to.be.ok();
});
it("should work with arrays", function () {

@@ -67,2 +76,11 @@ var a = i.freeze([1, 2, 3]),

it("should freeze arrays you assoc", function () {
var o = i.freeze({a: 1, b: 2, c: 3}),
result = i.assoc(o, "b", [1, 2]);
expect(result).to.eql({a: 1, b: [1, 2], c: 3});
expect(Object.isFrozen(result.b)).to.be.ok();
});
it("should return a frozen copy", function () {

@@ -144,2 +162,7 @@ var o = i.freeze({a: 1, b: 2, c: 3}),

});
it("should work without a path", function () {
var o = i.freeze({a: {b: 1}});
expect(i.getIn(o)).to.equal(o);
});
});

@@ -261,2 +284,54 @@

describe("merge", function () {
it("should merge nested objects", function () {
var o1 = i.freeze({a: 1, b: {c: 1, d: 1}});
var o2 = i.freeze({a: 1, b: {c: 2}, e: 2});
var result = i.merge(o1, o2);
expect(result).to.eql({a: 1, b: {c: 2, d: 1}, e: 2});
});
it("should replace arrays", function () {
var o1 = i.freeze({a: 1, b: {c: [1, 1]}, d: 1});
var o2 = i.freeze({a: 2, b: {c: [2]}});
var result = i.merge(o1, o2);
expect(result).to.eql({a: 2, b: {c: [2]}, d: 1});
});
it("should overwrite with nulls", function () {
var o1 = i.freeze({a: 1, b: {c: [1, 1]}});
var o2 = i.freeze({a: 2, b: {c: null}});
var result = i.merge(o1, o2);
expect(result).to.eql({a: 2, b: {c: null}});
});
it("should overwrite primitives with objects", function () {
var o1 = i.freeze({a: 1, b: 1});
var o2 = i.freeze({a: 2, b: {c: 2}});
var result = i.merge(o1, o2);
expect(result).to.eql({a: 2, b: {c: 2}});
});
it("should overwrite objects with primitives", function () {
var o1 = i.freeze({a: 1, b: {c: 2}});
var o2 = i.freeze({a: 1, b: 2});
var result = i.merge(o1, o2);
expect(result).to.eql({a: 1, b: 2});
});
it("should keep references the same if nothing changes", function () {
var o1 = i.freeze({a: 1, b: {c: 1, d: 1, e: [1]}});
var o2 = i.freeze({a: 1, b: {c: 1, d: 1, e: o1.b.e}});
var result = i.merge(o1, o2);
expect(result).to.equal(o1);
expect(result.b).to.equal(o1.b);
});
});
});

@@ -263,0 +338,0 @@

14

package.json
{
"name": "icepick",
"version": "0.3.0",
"version": "0.4.0",
"description": "Utilities for working with frozen objects",
"main": "icepick.js",
"scripts": {
"test": "make ci"
"test": "make ci",
"coverage": "nyc npm test && nyc report",
"coveralls": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
},

@@ -28,2 +30,3 @@ "repository": {

"devDependencies": {
"coveralls": "~2.11.2",
"expect.js": "~0.3.1",

@@ -33,7 +36,8 @@ "grunt": "~0.4.5",

"grunt-release": "~0.7.0",
"jscs": "~1.5.9",
"jshint": "~2.6.0",
"mocha": "~1.21.4"
"jscs": "~1.12.0",
"jshint": "~2.7.0",
"mocha": "~1.21.4",
"nyc": "~2.2.1"
},
"dependencies": {}
}

38

README.md

@@ -1,2 +0,2 @@

# icepick [![Build Status via Travis CI](https://travis-ci.org/aearly/icepick.svg?branch=master)](https://travis-ci.org/aearly/icepick) [![NPM version](http://img.shields.io/npm/v/icepick.svg)](https://www.npmjs.org/package/icepick)
# icepick [![Build Status via Travis CI](https://travis-ci.org/aearly/icepick.svg?branch=master)](https://travis-ci.org/aearly/icepick) [![NPM version](http://img.shields.io/npm/v/icepick.svg)](https://www.npmjs.org/package/icepick) [![Coverage Status](https://coveralls.io/repos/aearly/icepick/badge.svg?branch=)](https://coveralls.io/r/aearly/icepick?branch=)

@@ -19,2 +19,4 @@ Utilities for working with frozen objects

`icepick` is provided as a CommonJS module with no dependencies. It is designed for use in Node, or with module loaders like Browserify or Webpack. To use as a global or with require.js, you will have to shim it or wrap it with `browserify --standalone`.
```bash

@@ -30,3 +32,3 @@ $ npm install icepick --save

The API is heavily influenced from Clojure/mori. In the contexts of these docs "collection" means a plain, frozen `Object` or `Array`. Only JSON-style collections are supported. Functions, Dates, RegExps, DOM elements, and others are left as is, and could mutate if they exist in your hierarchy.
The API is heavily influenced from Clojure/mori. In the contexts of these docs "collection" means a plain, frozen `Object` or `Array`. Only JSON-style collections are supported. Functions, Dates, RegExps, DOM elements, and others are left as-is, and could mutate if they exist in your hierarchy.

@@ -49,2 +51,7 @@ ### freeze(collection)

coll.c.d = "baz"; // throws Error
var circular = {bar: {}};
circular.bar.foo = circular;
i.freeze(circular); // throws Error
```

@@ -145,2 +152,19 @@

### merge(target, source)
Deeply merge a `source` object into `target`, similar to Lodash.merge. Child collections that are both frozen and reference equal will be asusmed to be deeply equal. Arrays from the `source` object will completely replace those in the `target` object if the two differ. If nothing changed, the original reference will not change. Returns a frozen object, and works with both unfrozen and frozen objects.
```javascript
var defaults = {a: 1, c: {d: 1, e: [1, 2, 3], f: {g: 1}};
var obj = {c: {d: 2, e: [2], f: null};
var result1 = i.merge(defaults, obj); // {a: 1, c: {d: 2, e: [2]}, f: null}
var obj2 = {c: {d: 2}};
var result2 = i.merge(result1, obj2);
assert(result1 === result2); // true
```
### Array.prototype methods

@@ -189,2 +213,12 @@

### How does this differ from `React.addons.update` or `seamless-immutable`.
All three of these libraries are very similar in their goals -- provide incremental updates of plain JS objects. They mainly differ in their APIs.
[`React.addons.update`](https://facebook.github.io/react/docs/update.html) provides a single function to which you pass an object of commands. While this can be convenient to do many updates in a single batch, the syntax of the command object is very cumbersome, especially when dealing with computed property names. It also does not freeze the objects it operates on, leaving them open to modifications elsewhere in your code.
[`seamless-immutable`](https://github.com/rtfeldman/seamless-immutable) is the most similar to `icepick`. Its main difference is that it adds more methods to the prototypes of objects, and overrides array built-ins like `map` and `filter` to return frozen objects. It also adds a couple utility functions, like `asMutable` and `merge`. `icepick` does not modify the the methods or properties of collections in order to function, it merely provides a set of functions to operate on them, similar to Lodash, Underscore, or Ramda. This means that when passing frozen objects to third-party libraries, they will be able to `map` over them and obtain mutable arrays. `seamless-immutable` handles `Date`s, which `icepick` leaves as-is currently (as well as any other objects with custom constructors). `icepick` will detect circular references within an object and throw an Error, `seamless-immutable` will run into infinite recursion in such a case.
I also would like to benchmark all of these libraries to see in what cases each is faster.
### Isn't this horribly slow?

@@ -191,0 +225,0 @@ 

.jscsrc

Sorry, the diff of this file is not supported yet

.jshintrc

Sorry, the diff of this file is not supported yet

.npmignore

Sorry, the diff of this file is not supported yet

.travis.yml

Sorry, the diff of this file is not supported yet