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

src/atom/AtomCategory.js A
last analyzed 2017-03-29 00:20 UTC

↳ Parent: Project

Complexity

Total Complexity	14
Complexity/F	1.27

Size

Lines of Code	140
Function Count	11

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	0
c	1
b	0
f	0
nc	1
dl	0
loc	140
rs	10
wmc	14
mnd	1
bc	14
fnc	11
bpm	1.2727
cpm	1.2727
noi	2

module.exports = function(GedcomX){

  var utils = require('../utils'),
      AtomCommon = require('./AtomCommon');
  
  /**
   * Information about a category associated with an atom entry or feed.
   * 
   * @see {@link https://github.com/FamilySearch/gedcomx-rs/blob/master/specifications/atom-model-specification.md#atom-json-media-type|GEDCOM X Atom JSON Spec}
   * @see {@link https://tools.ietf.org/html/rfc4287#section-4.2.2|RFC 4287}
   * 
   * @class AtomCategory
   * @extends AtomCommon
   * @param {Object} [json]
   */
  var AtomCategory = function(json){
    
    // Protect against forgetting the new keyword when calling the constructor
    if(!(this instanceof AtomCategory)){
      return new AtomCategory(json);
    }
    
    // If the given object is already an instance then just return it. DON'T copy it.
    if(AtomCategory.isInstance(json)){
      return json;
    }
    
    this.init(json);

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

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

   * @return {AtomCategory} this
   */
  AtomCategory.prototype.init = function(json){
    
    AtomCommon.prototype.init.call(this, json);
    
    if(json){
      this.setScheme(json.scheme);
      this.setTerm(json.term);
      this.setLabel(json.label);
    }
    return this;
  };
  
  /**
   * Set the scheme
   * 
   * @param {String} scheme
   * @return {AtomCategory} this
   */
  AtomCategory.prototype.setScheme = function(scheme){
    this.scheme = scheme;
    return this;
  };
  
  /**
   * Get the scheme
   * 
   * @return {AtomCategory} this
   */
  AtomCategory.prototype.getScheme = function(){
    return this.scheme;
  };
  
  /**
   * Set the term
   * 
   * @param {String} term
   * @return {AtomCategory} this
   */
  AtomCategory.prototype.setTerm = function(term){
    this.term = term;
    return this;
  };
  
  /**
   * Get the term
   * 
   * @return {AtomCategory} this
   */
  AtomCategory.prototype.getTerm = function(){
    return this.term;
  };
  
  /**
   * Set the label
   * 
   * @param {String} label
   * @return {AtomCategory} this
   */
  AtomCategory.prototype.setLabel = function(label){
    this.label = label;
    return this;
  };
  
  /**
   * Get the label
   * 
   * @return {AtomCategory} this
   */
  AtomCategory.prototype.getLabel = function(){
    return this.label;
  };
  
  /**
   * Export the object as JSON
   * 
   * @return {Object} JSON object
   */
  AtomCategory.prototype.toJSON = function(){
    return this._toJSON(AtomCommon, AtomCategory.jsonProps);
  };
  
  GedcomX.AtomCategory = AtomCategory;

};

1			module.exports = function(GedcomX){
2
3			var utils = require('../utils'),
4			AtomCommon = require('./AtomCommon');
5
6			/**
7			* Information about a category associated with an atom entry or feed.
8			*
9			* @see {@link https://github.com/FamilySearch/gedcomx-rs/blob/master/specifications/atom-model-specification.md#atom-json-media-type\|GEDCOM X Atom JSON Spec}
10			* @see {@link https://tools.ietf.org/html/rfc4287#section-4.2.2\|RFC 4287}
11			*
12			* @class AtomCategory
13			* @extends AtomCommon
14			* @param {Object} [json]
15			*/
16			var AtomCategory = function(json){
17
18			// Protect against forgetting the new keyword when calling the constructor
19			if(!(this instanceof AtomCategory)){
20			return new AtomCategory(json);
21			}
22
23			// If the given object is already an instance then just return it. DON'T copy it.
24			if(AtomCategory.isInstance(json)){
25			return json;
26			}
27
28			this.init(json);
			0 ignored issues – show Best Practice introduced 2016-10-13 18:47 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...
29			};
30
31			AtomCategory.prototype = Object.create(AtomCommon.prototype);
32
33			AtomCategory._gedxClass = AtomCategory.prototype._gedxClass = 'GedcomX.AtomCategory';
34
35			AtomCategory.jsonProps = [
36			'scheme',
37			'term',
38			'label'
39			];
40
41			/**
42			* Check whether the given object is an instance of this class.
43			*
44			* @param {Object} obj
45			* @returns {Boolean}
46			*/
47			AtomCategory.isInstance = function(obj){
48			return utils.isInstance(obj, this._gedxClass);
49			};
50
51			/**
52			* Initialize from JSON
53			*
54			* @param {Object}
			0 ignored issues – show Documentation introduced 2016-10-13 18:47 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
55			* @return {AtomCategory} this
56			*/
57			AtomCategory.prototype.init = function(json){
58
59			AtomCommon.prototype.init.call(this, json);
60
61			if(json){
62			this.setScheme(json.scheme);
63			this.setTerm(json.term);
64			this.setLabel(json.label);
65			}
66			return this;
67			};
68
69			/**
70			* Set the scheme
71			*
72			* @param {String} scheme
73			* @return {AtomCategory} this
74			*/
75			AtomCategory.prototype.setScheme = function(scheme){
76			this.scheme = scheme;
77			return this;
78			};
79
80			/**
81			* Get the scheme
82			*
83			* @return {AtomCategory} this
84			*/
85			AtomCategory.prototype.getScheme = function(){
86			return this.scheme;
87			};
88
89			/**
90			* Set the term
91			*
92			* @param {String} term
93			* @return {AtomCategory} this
94			*/
95			AtomCategory.prototype.setTerm = function(term){
96			this.term = term;
97			return this;
98			};
99
100			/**
101			* Get the term
102			*
103			* @return {AtomCategory} this
104			*/
105			AtomCategory.prototype.getTerm = function(){
106			return this.term;
107			};
108
109			/**
110			* Set the label
111			*
112			* @param {String} label
113			* @return {AtomCategory} this
114			*/
115			AtomCategory.prototype.setLabel = function(label){
116			this.label = label;
117			return this;
118			};
119
120			/**
121			* Get the label
122			*
123			* @return {AtomCategory} this
124			*/
125			AtomCategory.prototype.getLabel = function(){
126			return this.label;
127			};
128
129			/**
130			* Export the object as JSON
131			*
132			* @return {Object} JSON object
133			*/
134			AtomCategory.prototype.toJSON = function(){
135			return this._toJSON(AtomCommon, AtomCategory.jsonProps);
136			};
137
138			GedcomX.AtomCategory = AtomCategory;
139
140			};

rootsdev / gedcomx-js

src/atom/AtomCategory.js A last analyzed 2017-03-29 00:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

src/atom/AtomCategory.js A
last analyzed 2017-03-29 00:20 UTC