Attribution.isInstance - Code Metrics - Inspection of "Objects being copied when building with instances" - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#13)

by Justin

created 2016-06-06 17:54 UTC

Attribution.isInstance A

↳ Parent: src/Attribution.js

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

var ExtensibleData = require('./ExtensibleData'),
    ResourceReference = require('./ResourceReference'),
    utils = require('./utils');

/**
 * Define who is contributing information, when they contributed it, 
 * and why they are making the contribution.
 * 
 * @constructor
 * @param {Object} [json]

 */
var Attribution = function(json){
  
  // Protect against forgetting the new keyword when calling the constructor
  if(!(this instanceof Attribution)){
    return new Attribution(json);
  }
  
  // If the given object is already an instance then just return it. DON'T copy it.
  if(Attribution.isInstance(json)){
    return json;
  }
  
  ExtensibleData.call(this, json);
  
  if(json){
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
    this.setChangeMessage(json.changeMessage);
    this.setContributor(json.contributor);
    this.setCreated(json.created);
    this.setCreator(json.creator);
    this.setModified(json.modified);

  }
};

Attribution.prototype = Object.create(ExtensibleData.prototype);

Attribution._gedxClass = Attribution.prototype._gedxClass = 'GedcomX.Attribution';

/**
 * Check whether the given object is an instance of this class.
 * 
 * @param {Object} obj
 * @returns {Boolean}
 */
Attribution.isInstance = function(obj){
  return utils.isInstance(obj, this._gedxClass);
};

/**
 * Get the change message.
 * 
 * @returns {String} Change message
 */
Attribution.prototype.getChangeMessage = function(){
  return this.changeMessage;
};

/**
 * Set the change message.
 * 
 * @param {String} changeMessage
 * @returns {Attribution} This object
 */
Attribution.prototype.setChangeMessage = function(changeMessage){
  this.changeMessage = changeMessage;
  return this;
};

/**
 * Get the contributor.
 * 
 * @returns {ResourceReference} contributor
 */
Attribution.prototype.getContributor = function(){
  return this.contributor;
};

/**
 * Set the contributor
 * 
 * @param {Object|ResourceReference} contributor ResourceReference representing the contributor.
 * @returns {Attribution} This instance
 */
Attribution.prototype.setContributor = function(contributor){
  if(contributor){
    this.contributor = ResourceReference(contributor);
  }
  return this;
};

/**
 * Get the created timestamp
 * 
 * @returns {Date} created
 */
Attribution.prototype.getCreated = function(){
  return this.created;
};

/**
 * Set the created timestamp
 * 
 * @param {Date|Number} date Integer timestamp (milliseconds since epoch) or JavaScript Date instance
 * @returns {Attribution} This instance
 */
Attribution.prototype.setCreated = function(date){
  if(date){
    this.created = new Date(date);
  }
  return this;
};

/**
 * Get the creator
 * 
 * @returns {ResourceReference} Creator
 */
Attribution.prototype.getCreator = function(){
  return this.creator;
};

/**
 * Set the creator
 * 
 * @param {Object|ResourceReference} creator ResourceReference representing the creator.
 * @returns {Attribution} This instance
 */
Attribution.prototype.setCreator = function(creator){
  if(creator){
    this.creator = new ResourceReference(creator);
  }
  return this;
};

/**
 * Get the modified timestamp
 * 
 * @returns {Date} modified
 */
Attribution.prototype.getModified = function(){
  return this.modified;
};

/**
 * Set the modified timestamp
 * 
 * @param {Date|Number} date Integer timestamp (milliseconds since epoch) or JavaScript Date instance
 * @returns {Attribution} This instance
 */
Attribution.prototype.setModified = function(date){
  if(date){
    this.modified = new Date(date);
  }
  return this;
};

/**
 * Export the object as JSON
 * 
 * @return {Object} JSON object
 */
Attribution.prototype.toJSON = function(){
  var json = ExtensibleData.prototype.toJSON.call(this);
  
  if(this.changeMessage){
    json.changeMessage = this.changeMessage;
  }
  
  if(this.contributor){
    json.contributor = this.contributor.toJSON();
  }
  
  if(this.created){
    json.created = this.created.getTime();
  }
  
  if(this.creator){
    json.creator = this.creator.toJSON();
  }
  
  if(this.modified){
    json.modified = this.modified.getTime();
  }
  
  return json;
};

module.exports = Attribution;

1			var ExtensibleData = require('./ExtensibleData'),
2			ResourceReference = require('./ResourceReference'),
3			utils = require('./utils');
4
5			/**
6			* Define who is contributing information, when they contributed it,
7			* and why they are making the contribution.
8			*
9			* @constructor
10			* @param {Object} [json]
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `[json]` does not exist. Did you maybe forget to remove this comment? Loading history...
11			*/
12			var Attribution = function(json){
13
14			// Protect against forgetting the new keyword when calling the constructor
15			if(!(this instanceof Attribution)){
16			return new Attribution(json);
17			}
18
19			// If the given object is already an instance then just return it. DON'T copy it.
20			if(Attribution.isInstance(json)){
21			return json;
22			}
23
24			ExtensibleData.call(this, json);
25
26			if(json){
			0 ignored issues – show Complexity Best Practice introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report There is no return statement if `json` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
27			this.setChangeMessage(json.changeMessage);
28			this.setContributor(json.contributor);
29			this.setCreated(json.created);
30			this.setCreator(json.creator);
31			this.setModified(json.modified);
			0 ignored issues – show Best Practice introduced 2016-05-27 14:53 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...
32			}
33			};
34
35			Attribution.prototype = Object.create(ExtensibleData.prototype);
36
37			Attribution._gedxClass = Attribution.prototype._gedxClass = 'GedcomX.Attribution';
38
39			/**
40			* Check whether the given object is an instance of this class.
41			*
42			* @param {Object} obj
43			* @returns {Boolean}
44			*/
45			Attribution.isInstance = function(obj){
46			return utils.isInstance(obj, this._gedxClass);
47			};
48
49			/**
50			* Get the change message.
51			*
52			* @returns {String} Change message
53			*/
54			Attribution.prototype.getChangeMessage = function(){
55			return this.changeMessage;
56			};
57
58			/**
59			* Set the change message.
60			*
61			* @param {String} changeMessage
62			* @returns {Attribution} This object
63			*/
64			Attribution.prototype.setChangeMessage = function(changeMessage){
65			this.changeMessage = changeMessage;
66			return this;
67			};
68
69			/**
70			* Get the contributor.
71			*
72			* @returns {ResourceReference} contributor
73			*/
74			Attribution.prototype.getContributor = function(){
75			return this.contributor;
76			};
77
78			/**
79			* Set the contributor
80			*
81			* @param {Object\|ResourceReference} contributor ResourceReference representing the contributor.
82			* @returns {Attribution} This instance
83			*/
84			Attribution.prototype.setContributor = function(contributor){
85			if(contributor){
86			this.contributor = ResourceReference(contributor);
87			}
88			return this;
89			};
90
91			/**
92			* Get the created timestamp
93			*
94			* @returns {Date} created
95			*/
96			Attribution.prototype.getCreated = function(){
97			return this.created;
98			};
99
100			/**
101			* Set the created timestamp
102			*
103			* @param {Date\|Number} date Integer timestamp (milliseconds since epoch) or JavaScript Date instance
104			* @returns {Attribution} This instance
105			*/
106			Attribution.prototype.setCreated = function(date){
107			if(date){
108			this.created = new Date(date);
109			}
110			return this;
111			};
112
113			/**
114			* Get the creator
115			*
116			* @returns {ResourceReference} Creator
117			*/
118			Attribution.prototype.getCreator = function(){
119			return this.creator;
120			};
121
122			/**
123			* Set the creator
124			*
125			* @param {Object\|ResourceReference} creator ResourceReference representing the creator.
126			* @returns {Attribution} This instance
127			*/
128			Attribution.prototype.setCreator = function(creator){
129			if(creator){
130			this.creator = new ResourceReference(creator);
131			}
132			return this;
133			};
134
135			/**
136			* Get the modified timestamp
137			*
138			* @returns {Date} modified
139			*/
140			Attribution.prototype.getModified = function(){
141			return this.modified;
142			};
143
144			/**
145			* Set the modified timestamp
146			*
147			* @param {Date\|Number} date Integer timestamp (milliseconds since epoch) or JavaScript Date instance
148			* @returns {Attribution} This instance
149			*/
150			Attribution.prototype.setModified = function(date){
151			if(date){
152			this.modified = new Date(date);
153			}
154			return this;
155			};
156
157			/**
158			* Export the object as JSON
159			*
160			* @return {Object} JSON object
161			*/
162			Attribution.prototype.toJSON = function(){
163			var json = ExtensibleData.prototype.toJSON.call(this);
164
165			if(this.changeMessage){
166			json.changeMessage = this.changeMessage;
167			}
168
169			if(this.contributor){
170			json.contributor = this.contributor.toJSON();
171			}
172
173			if(this.created){
174			json.created = this.created.getTime();
175			}
176
177			if(this.creator){
178			json.creator = this.creator.toJSON();
179			}
180
181			if(this.modified){
182			json.modified = this.modified.getTime();
183			}
184
185			return json;
186			};
187
188			module.exports = Attribution;

rootsdev / gedcomx-js

Pull Request — master (#13)

Attribution.isInstance A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like