Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

fellow

Package Overview
Dependencies
Maintainers
1
Versions
118
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fellow - npm Package Compare versions

Comparing version 1.2.0 to 2.0.0

126

docs/data.json

@@ -69,6 +69,25 @@ {

"line": 33,
"description": "With the value, see if an existing fellow exists in our singleton list property with the value, otherwise create a new fellow instance with the value and add them to our singleton list",
"static": 1,
"itemtype": "method",
"name": "ensure",
"params": [
{
"name": "value",
"description": "The value to create a new fellow instance or find the existing fellow instance with",
"type": "Mixed"
}
],
"return": {
"description": "The new or existing fellow instance",
"type": "Fellow"
},
"class": "Fellow"
},
{
"file": "esnext/lib/fellow.js",
"line": 57,
"description": "An array of fields that will denote if the user is the same user or not when using ensure",
"access": "protected",
"tagname": "",
"static": 1,
"itemtype": "property",

@@ -81,17 +100,16 @@ "name": "ensureFields",

"file": "esnext/lib/fellow.js",
"line": 45,
"description": "With the value, see if an existing fellow exists in our singleton list property with the value, otherwise create a new fellow instance with the value and add them to our singleton list",
"static": 1,
"line": 67,
"description": "Compare a fellow to another fellow, uses ensureFields for the comparison\nIf an ensureField is an array for both ourself and the other fellow, we will check to see if only one item of that array is similar (this is useful for email comparisons)",
"itemtype": "method",
"name": "ensure",
"name": "compare",
"params": [
{
"name": "value",
"description": "The value to create a new fellow instance or find the existing fellow instance with",
"type": "Mixed"
"name": "other",
"description": "The other fellow to compare ourselves with",
"type": "Fellow"
}
],
"return": {
"description": "The new or existing fellow instance",
"type": "Fellow"
"description": "Returns `true` if they appear to be the same person, or `false` if not",
"type": "Boolean"
},

@@ -102,3 +120,3 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 72,
"line": 96,
"description": "Get a fellow from the singleton list",

@@ -123,3 +141,3 @@ "static": 1,

"file": "esnext/lib/fellow.js",
"line": 83,
"line": 107,
"description": "Add a fellow or a series of people, denoted by the value, to the singleton list",

@@ -144,3 +162,3 @@ "static": 1,

"file": "esnext/lib/fellow.js",
"line": 112,
"line": 136,
"description": "Get all fellows who contribute to a particular repository",

@@ -165,3 +183,3 @@ "static": 1,

"file": "esnext/lib/fellow.js",
"line": 125,
"line": 149,
"description": "Get all fellows who maintain a particular repository",

@@ -186,3 +204,3 @@ "static": 1,

"file": "esnext/lib/fellow.js",
"line": 138,
"line": 162,
"description": "Get all fellows who author a particular repository",

@@ -207,6 +225,15 @@ "static": 1,

"file": "esnext/lib/fellow.js",
"line": 155,
"description": "If the name is empty, we will try to fallback to githubUsername then twitterUsername\nIf the name is prefixed with a series of numbers, that is considered the year\nE.g. In `2015+ Bevry Pty Ltd` then `2015+` is the years\nE.g. In `2013-2015 Bevry Pty Ltd` then `2013-2015` is the years",
"line": 179,
"description": "Get the serialisable values of this fellow",
"itemtype": "property",
"name": "name",
"name": "json",
"type": "Object",
"class": "Fellow"
},
{
"file": "esnext/lib/fellow.js",
"line": 189,
"description": "Updating the email will add the email to the start of the `emails` array",
"itemtype": "property",
"name": "email",
"type": "String",

@@ -217,6 +244,6 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 175,
"description": "The years that this fellow has",
"line": 205,
"description": "When set, will determine if it is a github, facebook, or twitter url\nIf it is, then it will extract the username and url from it\nIf this is not one of those urls, then it will set the homepage variable\nWhen fetching, it will fetch `homepage || githubUrl || facebookUrl || twitterUrl || null`",
"itemtype": "property",
"name": "years",
"name": "url",
"type": "String",

@@ -227,5 +254,5 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 181,
"line": 241,
"itemtype": "property",
"name": "email",
"name": "homepage",
"type": "String",

@@ -236,6 +263,5 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 186,
"description": "When set, will determine if it is a github, facebook, or twitter url\nIf it is, then it will extract the username and url from it\nIf this is not one of those urls, then it will set the homepage variable\nWhen fetching, it will fetch `homepage || githubUrl || facebookUrl || twitterUrl || null`",
"line": 246,
"itemtype": "property",
"name": "url",
"name": "githubUrl",
"type": "String",

@@ -246,5 +272,5 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 222,
"line": 251,
"itemtype": "property",
"name": "homepage",
"name": "githubUsername",
"type": "String",

@@ -255,5 +281,5 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 227,
"line": 256,
"itemtype": "property",
"name": "githubUrl",
"name": "twitterUrl",
"type": "String",

@@ -264,5 +290,5 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 232,
"line": 261,
"itemtype": "property",
"name": "githubUsername",
"name": "twitterUsername",
"type": "String",

@@ -273,6 +299,22 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 240,
"line": 266,
"itemtype": "property",
"name": "facebookUrl",
"type": "String",
"class": "Fellow"
},
{
"file": "esnext/lib/fellow.js",
"line": 271,
"itemtype": "property",
"name": "facebookUsername",
"type": "String",
"class": "Fellow"
},
{
"file": "esnext/lib/fellow.js",
"line": 279,
"description": "Construct our fellow instance with the value",
"itemtype": "property",
"name": "value The value used to set the properties of the fellow, forwarded to setValue",
"name": "value The value used to set the properties of the fellow, forwarded to set",
"type": "Mixed",

@@ -283,3 +325,3 @@ "class": "Fellow"

"file": "esnext/lib/fellow.js",
"line": 249,
"line": 289,
"description": "Update our fellow with the passed value",

@@ -294,3 +336,3 @@ "itemtype": "property",

"file": "esnext/lib/fellow.js",
"line": 298,
"line": 338,
"description": "Ensures that the github repository exists on the class",

@@ -316,3 +358,3 @@ "access": "private",

"file": "esnext/lib/fellow.js",
"line": 311,
"line": 351,
"description": "Get all added github repository slugs that this fellow contributes to",

@@ -326,3 +368,3 @@ "itemtype": "property",

"file": "esnext/lib/fellow.js",
"line": 327,
"line": 367,
"description": "Make note that this fellow contributes to this repository slug",

@@ -343,3 +385,3 @@ "itemtype": "method",

"file": "esnext/lib/fellow.js",
"line": 338,
"line": 378,
"description": "Get all added github repository slugs that this fellow maintains",

@@ -353,3 +395,3 @@ "itemtype": "property",

"file": "esnext/lib/fellow.js",
"line": 354,
"line": 394,
"description": "Make note that this fellow maintains this repository slug",

@@ -370,3 +412,3 @@ "itemtype": "method",

"file": "esnext/lib/fellow.js",
"line": 365,
"line": 405,
"description": "Get all added github repository slugs that this fellow authors",

@@ -380,3 +422,3 @@ "itemtype": "property",

"file": "esnext/lib/fellow.js",
"line": 381,
"line": 421,
"description": "Make note that this fellow authors this repository slug",

@@ -383,0 +425,0 @@ "itemtype": "method",

231

es5/lib/fellow.js

@@ -19,36 +19,127 @@ /**

_createClass(Fellow, [{
key: 'name',
key: 'compare',
// -----------------------------------
// Properties
/**
Compare a fellow to another fellow, uses ensureFields for the comparison
If an ensureField is an array for both ourself and the other fellow, we will check to see if only one item of that array is similar (this is useful for email comparisons)
@method compare
@param {Fellow} other The other fellow to compare ourselves with
@return {Boolean} Returns `true` if they appear to be the same person, or `false` if not
*/
value: function compare(other) {
var fields = this.ensureFields;
var _iteratorNormalCompletion = true;
var _didIteratorError = false;
var _iteratorError = undefined;
try {
for (var _iterator = fields[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
var field = _step.value;
var value = this[field];
var otherValue = other[field];
if (value && otherValue) {
if (Array.isArray(value) && Array.isArray(otherValue)) {
var _iteratorNormalCompletion2 = true;
var _didIteratorError2 = false;
var _iteratorError2 = undefined;
try {
for (var _iterator2 = value[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
var item = _step2.value;
if (otherValue.indexOf(item) !== -1) {
return true;
}
}
} catch (err) {
_didIteratorError2 = true;
_iteratorError2 = err;
} finally {
try {
if (!_iteratorNormalCompletion2 && _iterator2['return']) {
_iterator2['return']();
}
} finally {
if (_didIteratorError2) {
throw _iteratorError2;
}
}
}
} else if (value === otherValue) {
return true;
}
}
}
} catch (err) {
_didIteratorError = true;
_iteratorError = err;
} finally {
try {
if (!_iteratorNormalCompletion && _iterator['return']) {
_iterator['return']();
}
} finally {
if (_didIteratorError) {
throw _iteratorError;
}
}
}
return false;
}
/**
If the name is empty, we will try to fallback to githubUsername then twitterUsername
If the name is prefixed with a series of numbers, that is considered the year
E.g. In `2015+ Bevry Pty Ltd` then `2015+` is the years
E.g. In `2013-2015 Bevry Pty Ltd` then `2013-2015` is the years
@property name
@type String
Get a fellow from the singleton list
@static
@method get
@param {Mixed} value The value to fetch the value with
@return {Fellow|Null} The fetched fellow, if they exist with that value
*/
set: function set(value) {
var match = /^((?:[0-9]+[\-\+]?)+)?(.+)$/.exec(value);
if (match) {
this.years = String(match[1] || '').trim();
this._name = (match[2] || '').trim();
}
},
}, {
key: 'ensureFields',
/**
An array of fields that will denote if the user is the same user or not when using ensure
@protected
@property ensureFields
@type Array
*/
get: function get() {
return this._name || this.githubUsername || this.twitterUsername || null;
return ['emails', 'homepage', 'githubUsername', 'twitterUsername', 'facebookUsername'];
}
}, {
key: 'json',
// -----------------------------------
// Properties
/**
The years that this fellow has
@property years
@type String
Get the serialisable values of this fellow
@property json
@type Object
*/
get: function get() {
var json = JSON.parse(JSON.stringify(this));
return json;
}
/**
Updating the email will add the email to the start of the `emails` array
@property email
@type String
*/
}, {
key: 'email',
set: function set(value) {
var index = this.emails.indexOf(value);
if (index !== -1) {
this.emails = this.emails.slice(0, index).concat(this.emails.slice(index + 1));
}
this.emails.unshift(value);
},
get: function get() {
return this.emails[0] || null;
}

@@ -105,2 +196,22 @@ /**

/**
@property twitterUrl
@type String
*/
/**
@property twitterUsername
@type String
*/
/**
@property facebookUrl
@type String
*/
/**
@property facebookUsername
@type String
*/
// -----------------------------------

@@ -112,3 +223,3 @@ // Methods

@method constructor
@property {Mixed} value The value used to set the properties of the fellow, forwarded to setValue
@property {Mixed} value The value used to set the properties of the fellow, forwarded to set
*/

@@ -151,49 +262,26 @@ }], [{

var newFellow = this.create(value);
var fields = this.ensureFields;
var people = this.list;
var _iteratorNormalCompletion = true;
var _didIteratorError = false;
var _iteratorError = undefined;
var _iteratorNormalCompletion3 = true;
var _didIteratorError3 = false;
var _iteratorError3 = undefined;
try {
for (var _iterator = people[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
var existingFellow = _step.value;
var _iteratorNormalCompletion2 = true;
var _didIteratorError2 = false;
var _iteratorError2 = undefined;
for (var _iterator3 = people[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
var existingFellow = _step3.value;
try {
for (var _iterator2 = fields[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
var field = _step2.value;
if (newFellow[field] && newFellow[field] === existingFellow[field]) {
return existingFellow.setValue(value);
}
}
} catch (err) {
_didIteratorError2 = true;
_iteratorError2 = err;
} finally {
try {
if (!_iteratorNormalCompletion2 && _iterator2['return']) {
_iterator2['return']();
}
} finally {
if (_didIteratorError2) {
throw _iteratorError2;
}
}
if (newFellow.compare(existingFellow)) {
return existingFellow.set(value);
}
}
} catch (err) {
_didIteratorError = true;
_iteratorError = err;
_didIteratorError3 = true;
_iteratorError3 = err;
} finally {
try {
if (!_iteratorNormalCompletion && _iterator['return']) {
_iterator['return']();
if (!_iteratorNormalCompletion3 && _iterator3['return']) {
_iterator3['return']();
}
} finally {
if (_didIteratorError) {
throw _iteratorError;
if (_didIteratorError3) {
throw _iteratorError3;
}

@@ -210,10 +298,2 @@ }

}
/**
Get a fellow from the singleton list
@static
@method get
@param {Mixed} value The value to fetch the value with
@return {Fellow|Null} The fetched fellow, if they exist with that value
*/
}, {

@@ -304,16 +384,2 @@ key: 'get',

}
/**
An array of fields that will denote if the user is the same user or not when using ensure
@protected
@static
@property ensureFields
@type Array
*/
}, {
key: 'ensureFields',
get: function get() {
if (this._ensureFields == null) this._ensureFields = ['email', 'homepage', 'githubUsername'];
return this._ensureFields;
}
}]);

@@ -324,3 +390,4 @@

this.setValue(value);
if (!this.emails) this.emails = [];
this.set(value);
}

@@ -335,4 +402,4 @@

_createClass(Fellow, [{
key: 'setValue',
value: function setValue(fellow) {
key: 'set',
value: function set(fellow) {
var _this2 = this;

@@ -339,0 +406,0 @@

124

esnext/lib/fellow.js

@@ -34,14 +34,2 @@ /**

/**
An array of fields that will denote if the user is the same user or not when using ensure
@protected
@static
@property ensureFields
@type Array
*/
static get ensureFields () {
if ( this._ensureFields == null ) this._ensureFields = ['email', 'homepage', 'githubUsername']
return this._ensureFields
}
/**
With the value, see if an existing fellow exists in our singleton list property with the value, otherwise create a new fellow instance with the value and add them to our singleton list

@@ -55,9 +43,6 @@ @static

const newFellow = this.create(value)
const fields = this.ensureFields
const people = this.list
for ( const existingFellow of people ) {
for ( const field of fields ) {
if ( newFellow[field] && newFellow[field] === existingFellow[field] ) {
return existingFellow.setValue(value)
}
if ( newFellow.compare(existingFellow) ) {
return existingFellow.set(value)
}

@@ -75,2 +60,41 @@ }

/**
An array of fields that will denote if the user is the same user or not when using ensure
@protected
@property ensureFields
@type Array
*/
get ensureFields () {
return ['emails', 'homepage', 'githubUsername', 'twitterUsername', 'facebookUsername']
}
/**
Compare a fellow to another fellow, uses ensureFields for the comparison
If an ensureField is an array for both ourself and the other fellow, we will check to see if only one item of that array is similar (this is useful for email comparisons)
@method compare
@param {Fellow} other The other fellow to compare ourselves with
@return {Boolean} Returns `true` if they appear to be the same person, or `false` if not
*/
compare (other) {
const fields = this.ensureFields
for ( const field of fields ) {
const value = this[field]
const otherValue = other[field]
if ( value && otherValue ) {
if ( Array.isArray(value) && Array.isArray(otherValue) ) {
for ( const item of value ) {
if ( otherValue.indexOf(item) !== -1 ) {
return true
}
}
}
else if ( value === otherValue ) {
return true
}
}
}
return false
}
/**
Get a fellow from the singleton list

@@ -159,31 +183,26 @@ @static

/**
If the name is empty, we will try to fallback to githubUsername then twitterUsername
If the name is prefixed with a series of numbers, that is considered the year
E.g. In `2015+ Bevry Pty Ltd` then `2015+` is the years
E.g. In `2013-2015 Bevry Pty Ltd` then `2013-2015` is the years
@property name
@type String
Get the serialisable values of this fellow
@property json
@type Object
*/
set name (value) {
const match = (/^((?:[0-9]+[\-\+]?)+)?(.+)$/).exec(value)
if ( match ) {
this.years = String(match[1] || '').trim()
this._name = (match[2] || '').trim()
}
get json () {
const json = JSON.parse(JSON.stringify(this))
return json
}
get name () {
return this._name || this.githubUsername || this.twitterUsername || null
}
/**
The years that this fellow has
@property years
@type String
*/
/**
Updating the email will add the email to the start of the `emails` array
@property email
@type String
*/
set email (value) {
const index = this.emails.indexOf(value)
if ( index !== -1 ) {
this.emails = this.emails.slice(0, index).concat(this.emails.slice(index + 1))
}
this.emails.unshift(value)
}
get email () {
return this.emails[0] || null
}

@@ -241,2 +260,22 @@ /**

/**
@property twitterUrl
@type String
*/
/**
@property twitterUsername
@type String
*/
/**
@property facebookUrl
@type String
*/
/**
@property facebookUsername
@type String
*/
// -----------------------------------

@@ -248,6 +287,7 @@ // Methods

@method constructor
@property {Mixed} value The value used to set the properties of the fellow, forwarded to setValue
@property {Mixed} value The value used to set the properties of the fellow, forwarded to set
*/
constructor (value) {
this.setValue(value)
if ( !this.emails ) this.emails = []
this.set(value)
}

@@ -260,3 +300,3 @@

*/
setValue (fellow) {
set (fellow) {
// String format

@@ -263,0 +303,0 @@ // Benjamin Lupton <b@lupton.cc> (https://balupton.com)

18

esnextguardian.js

@@ -1,17 +0,3 @@

// 9 September 2015
// 18 September 2015
// https://github.com/bevry/base
if ( process.env.REQUIRE_ESNEXT ) {
module.exports = require('./esnext/lib/fellow.js')
}
else if ( process.env.REQUIRE_ES5 || !process.versions.v8 || process.versions.v8.split('.')[0] < 4 ) {
module.exports = require('./es5/lib/fellow.js')
}
else {
try {
module.exports = require('./esnext/lib/fellow.js')
}
catch (e) {
// console.log('Downgrading from ESNEXT to ES5 due to:', e.stack)
module.exports = require('./es5/lib/fellow.js')
}
}
module.exports = require('esnextguardian')('./esnext/lib/fellow.js', './es5/lib/fellow.js', require)

10

HISTORY.md
# History
## v2.0.0 September 18, 2015
- Removed `years`, it was too specific to the [bevry/projectz](https://github.com/bevry/projectz) use case
- Added new `compare` method
- Added new `json` dynamic property
- Setting an `email` will now keep an `emails` array up to date, for multiple email support
- Renamed `setValue` to just `set`
- `ensureFields` no longer caches, and now supports array fields
## v1.2.0 September 16, 2015

@@ -10,2 +18,2 @@ - Added name fallbacks to githubUsername then twitterUsername

## v1.0.0 September 16, 2015
- Initial working release
- Initial working release

2

LICENSE.md

@@ -23,2 +23,2 @@ <!-- LICENSEFILE/ -->

<!-- /LICENSEFILE -->
<!-- /LICENSEFILE -->

18

package.json
{
"name": "fellow",
"version": "1.2.0",
"version": "2.0.0",
"description": "Fellow is a package for creating people that can be unified by their shared values via a singleton list on the class",

@@ -64,14 +64,20 @@ "homepage": "https://github.com/bevry/fellow",

},
"dependencies": {},
"dependencies": {
"esnextguardian": "^1.1.0"
},
"devDependencies": {
"assert-helpers": "^3.0.0",
"assert-helpers": "^4.0.0",
"babel": "^5.8.23",
"babel-eslint": "^4.1.1",
"eslint": "^1.3.1",
"babel-eslint": "^4.1.3",
"eslint": "^1.5.0",
"joe": "^1.6.0",
"joe-reporter-console": "^1.2.1",
"projectz": "^0.5.0",
"projectz": "^1.0.2",
"yuidocjs": "^0.9.0"
},
"main": "./esnextguardian.js",
"browser": "./es5/lib/fellow.js",
"jspm": {
"main": "./esnext/lib/fellow.js"
},
"scripts": {

@@ -78,0 +84,0 @@ "clean": "node --harmony nakefile.js clean",

8

README.md

@@ -45,3 +45,3 @@ <!-- TITLE/ -->

<li>Use: <code>require('fellow')</code></li>
<li>CDN URL: <code>//wzrd.in/bundle/fellow@1.2.0</code></li></ul>
<li>CDN URL: <code>//wzrd.in/bundle/fellow@2.0.0</code></li></ul>

@@ -57,3 +57,5 @@ <a href="http://enderjs.com" title="Ender is a full featured package manager for your browser"><h3>Ender</h3></a><ul>

[Check out the technical documentation.](https://rawgit.com/bevry/fellow/master/docs/index.html)
- [Technical Documentation](https://rawgit.com/bevry/fellow/master/docs/index.html)
- [Source Code](https://github.com/bevry/fellow/blob/master/esnext/lib/fellow.js#files)
- [Test Code](https://github.com/bevry/fellow/blob/master/esnext/lib/fellow-test.js#files)

@@ -123,2 +125,2 @@

<!-- /LICENSE -->
<!-- /LICENSE -->
docs/classes/Fellow.html

Sorry, the diff of this file is not supported yet

docs/files/esnext_lib_fellow.js.html

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc