src/rs/Links.js - Code Metrics - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

src/rs/Links.js A
last analyzed 2017-03-29 00:20 UTC

↳ Parent: Project

Complexity

Total Complexity	19
Complexity/F	1.9

Size

Lines of Code	146
Function Count	10

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	2

Metric	Value
cc	0
c	4
b	0
f	2
nc	1
dl	0
loc	146
rs	10
wmc	19
mnd	3
bc	20
fnc	10
bpm	2
cpm	1.9
noi	3

module.exports = function(GedcomX){

  var utils = require('../utils'),
      Base = require('../Base');
  
  /**
   * A list of Links
   * 
   * {@link https://github.com/FamilySearch/gedcomx-rs/blob/master/specifications/rs-specification.md#json-type-member|GEDCOM X RS Spec}
   * 
   * @class Links
   * @extends Base
   * @param {Object} [json]
   */
  var Links = function(json){
    
    // Protect against forgetting the new keyword when calling the constructor
    if(!(this instanceof Links)){
      return new Links(json);
    }
    
    // If the given object is already an instance then just return it. DON'T copy it.
    if(Links.isInstance(json)){
      return json;
    }
    
    this.init(json);

  };
  
  // There's no value in us extending Base at the moment
  Links.prototype = Object.create(Base.prototype);
  
  Links._gedxClass = Links.prototype._gedxClass = 'GedcomX.Links';
  
  /**
   * Check whether the given object is an instance of this class.
   * 
   * @param {Object} obj
   * @returns {Boolean}
   */
  Links.isInstance = function(obj){
    return utils.isInstance(obj, this._gedxClass);
  };

  /**
   * Initialize from JSON
   * 
   * @param {Object}

   * @return {Link} this
   */
  Links.prototype.init = function(json){
    
    Base.prototype.init.call(this, json);
    
    this.links = [];
    
    if(json){
      this.setLinks(json);
    }
    return this;
  };
  
  /**
   * Get the list of links
   * 
   * @return {Link[]} links
   */
  Links.prototype.getLinks = function(){
    return this.links;
  };
  
  /**
   * Get a link matching a rel
   * 
   * @param {String} rel
   * @return {Link} link
   */
  Links.prototype.getLink = function(rel){
    return this.links.find(function(link){
      return link.getRel() === rel;
    });
  };
  
  /**
   * Add a link
   * 
   * @param {Link} link
   * @return {Links} this
   */
  Links.prototype.addLink = function(link){
    // TODO: check for duplicates
    this.links.push(GedcomX.Link(link));
    return this;
  };
  
  /**
   * Set the links. May either provide the JSON object structure or an array
   * of Link instances
   * 
   * @param {Object|Link[]} links
   * @return {Links} this
   */
  Links.prototype.setLinks = function(links){
    this.links = [];
    if(links){
      
      // List of link
      if(Array.isArray(links)){
        for(var i = 0; i < links.length; i++){
          this.addLink(links[i]);
        }
      }
      
      // JSON object
      else {
        for(var rel in links){
var someObject;
for (var key in someObject) {
    if ( ! someObject.hasOwnProperty(key)) {
        continue; // Skip keys from the prototype.
    }

    doSomethingWith(key);
}
          this.addLink(new GedcomX.Link(links[rel]).setRel(rel));
        }
      }
    }
    return this;
  };
  
  /**
   * Export the object as JSON
   * 
   * @return {Object} JSON object
   */
  Links.prototype.toJSON = function(){
    var links = this.getLinks(),
        json = {},
        linkJson, rel;
    for(var i = 0; i < links.length; i++){
      linkJson = utils.toJSON(links[i]);
      rel = linkJson.rel;
      if(rel){
        delete linkJson.rel;
        json[rel] = linkJson;
      }
    }
    return json;
  };
  
  GedcomX.Links = Links;

};

1			module.exports = function(GedcomX){
2
3			var utils = require('../utils'),
4			Base = require('../Base');
5
6			/**
7			* A list of Links
8			*
9			* {@link https://github.com/FamilySearch/gedcomx-rs/blob/master/specifications/rs-specification.md#json-type-member\|GEDCOM X RS Spec}
10			*
11			* @class Links
12			* @extends Base
13			* @param {Object} [json]
14			*/
15			var Links = function(json){
16
17			// Protect against forgetting the new keyword when calling the constructor
18			if(!(this instanceof Links)){
19			return new Links(json);
20			}
21
22			// If the given object is already an instance then just return it. DON'T copy it.
23			if(Links.isInstance(json)){
24			return json;
25			}
26
27			this.init(json);
			0 ignored issues – show Best Practice introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
28			};
29
30			// There's no value in us extending Base at the moment
31			Links.prototype = Object.create(Base.prototype);
32
33			Links._gedxClass = Links.prototype._gedxClass = 'GedcomX.Links';
34
35			/**
36			* Check whether the given object is an instance of this class.
37			*
38			* @param {Object} obj
39			* @returns {Boolean}
40			*/
41			Links.isInstance = function(obj){
42			return utils.isInstance(obj, this._gedxClass);
43			};
44
45			/**
46			* Initialize from JSON
47			*
48			* @param {Object}
			0 ignored issues – show Documentation introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
49			* @return {Link} this
50			*/
51			Links.prototype.init = function(json){
52
53			Base.prototype.init.call(this, json);
54
55			this.links = [];
56
57			if(json){
58			this.setLinks(json);
59			}
60			return this;
61			};
62
63			/**
64			* Get the list of links
65			*
66			* @return {Link[]} links
67			*/
68			Links.prototype.getLinks = function(){
69			return this.links;
70			};
71
72			/**
73			* Get a link matching a rel
74			*
75			* @param {String} rel
76			* @return {Link} link
77			*/
78			Links.prototype.getLink = function(rel){
79			return this.links.find(function(link){
80			return link.getRel() === rel;
81			});
82			};
83
84			/**
85			* Add a link
86			*
87			* @param {Link} link
88			* @return {Links} this
89			*/
90			Links.prototype.addLink = function(link){
91			// TODO: check for duplicates
92			this.links.push(GedcomX.Link(link));
93			return this;
94			};
95
96			/**
97			* Set the links. May either provide the JSON object structure or an array
98			* of Link instances
99			*
100			* @param {Object\|Link[]} links
101			* @return {Links} this
102			*/
103			Links.prototype.setLinks = function(links){
104			this.links = [];
105			if(links){
106
107			// List of link
108			if(Array.isArray(links)){
109			for(var i = 0; i < links.length; i++){
110			this.addLink(links[i]);
111			}
112			}
113
114			// JSON object
115			else {
116			for(var rel in links){
			0 ignored issues – show Complexity introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report A for in loop automatically includes the property of any prototype object, consider checking the key using `hasOwnProperty`. When iterating over the keys of an object, this includes not only the keys of the object, but also keys contained in the prototype of that object. It is generally a best practice to check for these keys specifically: var someObject; for (var key in someObject) { if ( ! someObject.hasOwnProperty(key)) { continue; // Skip keys from the prototype. } doSomethingWith(key); } Loading history...
117			this.addLink(new GedcomX.Link(links[rel]).setRel(rel));
118			}
119			}
120			}
121			return this;
122			};
123
124			/**
125			* Export the object as JSON
126			*
127			* @return {Object} JSON object
128			*/
129			Links.prototype.toJSON = function(){
130			var links = this.getLinks(),
131			json = {},
132			linkJson, rel;
133			for(var i = 0; i < links.length; i++){
134			linkJson = utils.toJSON(links[i]);
135			rel = linkJson.rel;
136			if(rel){
137			delete linkJson.rel;
138			json[rel] = linkJson;
139			}
140			}
141			return json;
142			};
143
144			GedcomX.Links = Links;
145
146			};

rootsdev / gedcomx-js

src/rs/Links.js A last analyzed 2017-03-29 00:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

src/rs/Links.js A
last analyzed 2017-03-29 00:20 UTC