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

src/records/RecordDescriptor.js A
last analyzed 2017-03-29 00:20 UTC

↳ Parent: Project

Complexity

Total Complexity	13
Complexity/F	1.3

Size

Lines of Code	126
Function Count	10

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	0
c	1
b	0
f	0
nc	2
dl	0
loc	126
rs	10
wmc	13
mnd	1
bc	13
fnc	10
bpm	1.3
cpm	1.3
noi	2

module.exports = function(GedcomX){
  
  var utils = require('../utils');
  
  /**
   * Metadata about the structure and layout of a record, as well as the expected
   * data to be extracted from a record.
   * 
   * @see {@link https://github.com/FamilySearch/gedcomx-record/blob/master/specifications/record-specification.md#record-descriptor|GEDCOM X Records Spec}
   * 
   * @class RecordDescriptor
   * @extends ExtensibleData
   * @param {Object} [json]
   */
  var RecordDescriptor = function(json){
    
    // Protect against forgetting the new keyword when calling the constructor
    if(!(this instanceof RecordDescriptor)){
      return new RecordDescriptor(json);
    }
    
    // If the given object is already an instance then just return it. DON'T copy it.
    if(RecordDescriptor.isInstance(json)){
      return json;
    }
    
    this.init(json);

  };
  
  RecordDescriptor.prototype = Object.create(GedcomX.ExtensibleData.prototype);
  
  RecordDescriptor._gedxClass = RecordDescriptor.prototype._gedxClass = 'GedcomX.RecordDescriptor';
  
  RecordDescriptor.jsonProps = [
    'lang',
    'fields'
  ];
  
  /**
   * Check whether the given object is an instance of this class.
   * 
   * @param {Object} obj
   * @returns {Boolean}
   */
  RecordDescriptor.isInstance = function(obj){
    return utils.isInstance(obj, this._gedxClass);
  };

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

   * @return {RecordDescriptor} this
   */
  RecordDescriptor.prototype.init = function(json){
    
    GedcomX.ExtensibleData.prototype.init.call(this, json);
    
    if(json){
      this.setLang(json.lang);
      this.setFields(json.fields);
    }
    return this;
  };
  
  /**
   * Set the lang
   * 
   * @param {String} lang
   * @return {RecordDescriptor} this
   */
  RecordDescriptor.prototype.setLang = function(lang){
    this.lang = lang;
    return this;
  };
  
  /**
   * Get the lang
   * 
   * @return {String} lang
   */
  RecordDescriptor.prototype.getLang = function(){
    return this.lang;
  };
  
  /**
   * Set the fields
   * 
   * @param {FieldDescriptor[]} fields
   * @return {RecordDescriptor} this
   */
  RecordDescriptor.prototype.setFields = function(fields){
    return this._setArray(fields, 'fields', 'addField');
  };
  
  /**
   * Add a field
   * 
   * @param {FieldDescriptor} field
   * @return {RecordDescriptor} this
   */
  RecordDescriptor.prototype.addField = function(field){
    return this._arrayPush(field, 'fields', GedcomX.FieldDescriptor);
  };
  
  /**
   * Get the fields
   * 
   * @return {FieldDescriptor[]}
   */
  RecordDescriptor.prototype.getFields = function(){
    return this.fields || [];
  };
   
  /**
   * Export the object as JSON
   * 
   * @return {Object} JSON object
   */
  RecordDescriptor.prototype.toJSON = function(){
    return this._toJSON(GedcomX.ExtensibleData, RecordDescriptor.jsonProps);
  };
  
  GedcomX.RecordDescriptor = RecordDescriptor;
  
};

1			module.exports = function(GedcomX){
2
3			var utils = require('../utils');
4
5			/**
6			* Metadata about the structure and layout of a record, as well as the expected
7			* data to be extracted from a record.
8			*
9			* @see {@link https://github.com/FamilySearch/gedcomx-record/blob/master/specifications/record-specification.md#record-descriptor\|GEDCOM X Records Spec}
10			*
11			* @class RecordDescriptor
12			* @extends ExtensibleData
13			* @param {Object} [json]
14			*/
15			var RecordDescriptor = function(json){
16
17			// Protect against forgetting the new keyword when calling the constructor
18			if(!(this instanceof RecordDescriptor)){
19			return new RecordDescriptor(json);
20			}
21
22			// If the given object is already an instance then just return it. DON'T copy it.
23			if(RecordDescriptor.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			RecordDescriptor.prototype = Object.create(GedcomX.ExtensibleData.prototype);
31
32			RecordDescriptor._gedxClass = RecordDescriptor.prototype._gedxClass = 'GedcomX.RecordDescriptor';
33
34			RecordDescriptor.jsonProps = [
35			'lang',
36			'fields'
37			];
38
39			/**
40			* Check whether the given object is an instance of this class.
41			*
42			* @param {Object} obj
43			* @returns {Boolean}
44			*/
45			RecordDescriptor.isInstance = function(obj){
46			return utils.isInstance(obj, this._gedxClass);
47			};
48
49			/**
50			* Initialize from JSON
51			*
52			* @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...
53			* @return {RecordDescriptor} this
54			*/
55			RecordDescriptor.prototype.init = function(json){
56
57			GedcomX.ExtensibleData.prototype.init.call(this, json);
58
59			if(json){
60			this.setLang(json.lang);
61			this.setFields(json.fields);
62			}
63			return this;
64			};
65
66			/**
67			* Set the lang
68			*
69			* @param {String} lang
70			* @return {RecordDescriptor} this
71			*/
72			RecordDescriptor.prototype.setLang = function(lang){
73			this.lang = lang;
74			return this;
75			};
76
77			/**
78			* Get the lang
79			*
80			* @return {String} lang
81			*/
82			RecordDescriptor.prototype.getLang = function(){
83			return this.lang;
84			};
85
86			/**
87			* Set the fields
88			*
89			* @param {FieldDescriptor[]} fields
90			* @return {RecordDescriptor} this
91			*/
92			RecordDescriptor.prototype.setFields = function(fields){
93			return this._setArray(fields, 'fields', 'addField');
94			};
95
96			/**
97			* Add a field
98			*
99			* @param {FieldDescriptor} field
100			* @return {RecordDescriptor} this
101			*/
102			RecordDescriptor.prototype.addField = function(field){
103			return this._arrayPush(field, 'fields', GedcomX.FieldDescriptor);
104			};
105
106			/**
107			* Get the fields
108			*
109			* @return {FieldDescriptor[]}
110			*/
111			RecordDescriptor.prototype.getFields = function(){
112			return this.fields \|\| [];
113			};
114
115			/**
116			* Export the object as JSON
117			*
118			* @return {Object} JSON object
119			*/
120			RecordDescriptor.prototype.toJSON = function(){
121			return this._toJSON(GedcomX.ExtensibleData, RecordDescriptor.jsonProps);
122			};
123
124			GedcomX.RecordDescriptor = RecordDescriptor;
125
126			};

rootsdev / gedcomx-js

src/records/RecordDescriptor.js A last analyzed 2017-03-29 00:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

src/records/RecordDescriptor.js A
last analyzed 2017-03-29 00:20 UTC