PojoViz - Plain Old JavaScript Object Visualization

%PojoViz is a tool to analyze the plain objects of a JavaScript library/framework by finding all the relationships found between the library entry point (typically a global variable) and the objects/functions linked to it

Note: this webpage was developed to work with Google Chrome and it uses Shadow DOM, it's suggested that you use this browser for a complete experience

Why?

How many times did you find an awesome library/framework and wanted to see how it's structured just for fun?

Features

Export the generated graph to a simple JSON file consisting of nodes/edges
Two renderers: SVG (d3) and WebGL (threejs)

Analyze your preferred library/framework hosted anywhere, additional support to search libraries hosted on http://cdnjs.com

The algorithm

%PojoViz works in three phases:

Configuration phase

The library's representation in %PojoViz is configured with the following properties:
- Global access point to the library (e.g. window.d3 or window.THREE)
- The maximum number of levels allowed while running the DFS algorithm
- The src of the script (if it fetched from an external resource)
- The forbidden objects which are discarded when found by the DFS algorithm

Process phase

After the configuration is read %PojoViz's ObjectAnalyzer class analyzes the properties the global library/framework object, if any of these properties is an object/function constructor (configurable in settings) then ObjectAnalyzer will follow this link
The previous step is done recursively saving each object/function found in a HashMap until maximum number of levels has been reached discarding the fobidden objects in the process
ObjectAnalyzer will also in the process save the links found (from an object property to an object/function constructor) as the edges an internal graph
The main program then asks ObjectAnalyzer for a JSON representation of the nodes/edges of the generated graph
Dagre's layout program is executed with the generated JSON which returns the positions of each node in a 2D plane

Render phase

The chosen renderer (d3 or three.js) renders the graph provided by the process phase

Hello Pojoviz

Let's say we want to analyze the structure of the mother of all objects, the Object function, in the following example each link analyzed is marked with -->:

Object
 + length (number)
 ... many properties here
 + keys (function)
 +--> prototype (object, the Object's prototype)
 +--> [[Prototype]] (the hidden link to its prototype, which is
 					Function.prototype since Object is a function)

	Object.prototype
	 + toString (function, not a function constructor so it's not saved)
	 + constructor (function constructor but it's already saved)
	 ... many properties here

	Function.prototype (following the hidden [[Prototype]] link of the Object function)
	 + bind (function)
	 + toString (fucntion)
	 ... many properties here
	 +--> constructor (function, the object Function)
	 + [[Prototype]] (points to Object.prototype but it's already saved)

	 	Function
	 	+ length (number)
	 	... many properties here
 		+ prototype (points to Function.prototype which is already saved)
 		+ [[Prototype]] (points to Function.prototype too)

As seen, it's guaranteed that if no object is forbidden from the graph a minimum of 4 nodes will be saved.

The expected hashMap contents for the previous example:

{
	'function-Object': Object,
	'object-Object-prototype': Object.prototype,
	'function-Function': Function,
	'function-Function-prototype': Function.prototype
}

The previous test is verified in the file ObjectAnalyzer.spec.js:

// wrap is an instance of ObjectAnalyzer
it('should store the objects correctly', function () {
  wrap.add([Object]);
  expect(wrap.objects['function-Object']).to.equal(Object);
  expect(wrap.objects['object-Object-prototype']).to.equal(Object.prototype);
  expect(wrap.objects['function-Function']).to.equal(Function);
  expect(wrap.objects['function-Function-prototype']).to.equal(Function.prototype);
});

Show me the Object example

Installation

With bower:

bower install pojoviz

Usage:

<!-- dagre, Q and lodash -->
<script src="bower_components/pojoviz/build/pojoviz-vendor.js"></script>
<script src="bower_components/pojoviz/build/pojoviz.js"></script>

<!-- include this script if you want the d3 and three.js renderers too -->
<!-- required dependencies: THREE, sole/tween.js, d3, t3 -->
<script src="bower_components/pojoviz-renderers.js"></script>

Development notes:

%PojoViz's hashKey class adds an additional property to any object analyzed which is __pojoVizKey__, the property is not writtable nor enumerable

API

Show me the API

new pojoviz.ObjectAnalyzer()

Creates an instance of the analyzer class

instance.setLevels(levels)

Sets the maximum number of levels to analyze to be levels

instance.forbid([objects])

Forbids each element of the array objects from being analyzed

instance.add([objects])

Analyzes each element of the array objects

instance.stringify()

Stringifies the internal representation of the graph, this line should be called after add is called, it returns a JSON representation of the graph like this one:

{
  "nodes": {
    "function-Object": [{
      "name": "length",
      "type": "number",
      "linkeable": false,
      "label": "function-Object"
    }, {
      "name": "name",
      "type": "string",
      "linkeable": false,
      "label": "function-Object"
    }, ...],
    "object-Object-prototype": [{
      "name": "constructor",
      "type": "function",
      "linkeable": true,
      "label": "object-Object-prototype"
    }, {
      "name": "toString",
      "type": "function",
      "linkeable": true,
      "label": "object-Object-prototype"
    }, ...],
    "function-Function-prototype": [{
      "name": "length",
      "type": "number",
      "linkeable": false,
      "label": "function-Function-prototype"
    }, {
      "name": "name",
      "type": "string",
      "linkeable": false,
      "label": "function-Function-prototype"
    }, ...],
    "function-Function": [{
      "name": "prototype",
      "type": "function",
      "linkeable": true,
      "label": "function-Function"
    }, {
      "name": "[[Prototype]]",
      "type": "object",
      "linkeable": true,
      "hidden": true,
      "label": "function-Function"
    }, ...]
  },
  "edges": {
    "function-Object": [{
      "from": "function-Object",
      "to": "object-Object-prototype",
      "property": "prototype"
    }, {
      "from": "function-Object",
      "to": "function-Function-prototype",
      "property": "[[Prototype]]"
    }],
    "object-Object-prototype": [{
      "from": "object-Object-prototype",
      "to": "function-Object",
      "property": "constructor"
    }],
    "function-Function-prototype": [{
      "from": "function-Function-prototype",
      "to": "function-Function",
      "property": "constructor"
    }, {
      "from": "function-Function-prototype",
      "to": "object-Object-prototype",
      "property": "[[Prototype]]"
    }],
    "function-Function": [{
      "from": "function-Function",
      "to": "function-Function-prototype",
      "property": "prototype"
    }, {
      "from": "function-Function",
      "to": "function-Function-prototype",
      "property": "[[Prototype]]"
    }]
  }
}

Changelog

v0.1.2

Dagre is now in the pojoviz-vendor bundle

v0.1.1

Improvements in the build system
%PojoViz is now available through bower

v0.1.0

Initial release

TODO list

Move to the selected object on dot click
Undo/redo

Acknowledgments

Special thanks once again to @mrdoob the author of three.js and to @mbostock author of d3.

joskid / pojoviz Goto Github PK

pojoviz's Introduction