jQuery Github
-
+
diff --git a/dist/jquery.github.js b/dist/jquery.github.js
index 220967d..27e6de9 100644
--- a/dist/jquery.github.js
+++ b/dist/jquery.github.js
@@ -1,180 +1,152 @@
/*
- * jQuery Github - v0.3.2
+ * jquery-github - v0.4.0
* A jQuery plugin to display your Github Repositories.
- * https://github.com/zenorocha/jquery-github/
+ * https://github.com/zenorocha/jquery-github
*
- * Copyright (c) 2013
+ * Copyright (c) 2014
* MIT License
*/
// -- Github Repository --------------------------------------------------------
function GithubRepo( repo ) {
this.description = repo.description;
- this.forks = repo.forks;
+ this.forks = repo.forks_count;
this.name = repo.name;
this.open_issues = repo.open_issues;
this.pushed_at = repo.pushed_at;
this.url = repo.url;
- this.watchers = repo.watchers;
+ this.stargazers = repo.stargazers_count;
}
// Parses HTML template
GithubRepo.prototype.toHTML = function () {
- var self = this;
-
- self.pushed_at = self._parsePushedDate( self.pushed_at ),
- self.url = self._parseURL( self.url );
+ this.pushed_at = this._parsePushedDate( this.pushed_at ),
+ this.url = this._parseURL( this.url );
return $(
"" +
"
");
};
// Parses pushed_at with date format
GithubRepo.prototype._parsePushedDate = function ( pushed_at ) {
- var self = this,
- date = new Date( pushed_at );
+ var date = new Date( pushed_at );
return date.getDate() + "/" + ( date.getMonth() + 1 ) + "/" + date.getFullYear();
};
// Parses URL to be friendly
GithubRepo.prototype._parseURL = function ( url ) {
- var self = this;
-
return url.replace( "api.", "" ).replace( "repos/", "" );
};
// -- Github Plugin ------------------------------------------------------------
function Github( element, options ) {
- var self = this,
- defaults = {
+ var defaults = {
iconStars: true,
iconForks: true,
iconIssues: false
};
- self.element = element;
- self.$container = $( element );
- self.repo = self.$container.attr( "data-repo" );
+ this.element = element;
+ this.$container = $( element );
+ this.repo = this.$container.attr( "data-repo" );
- self.options = $.extend( {}, defaults, options ) ;
+ this.options = $.extend( {}, defaults, options ) ;
- self._defaults = defaults;
+ this._defaults = defaults;
- self.init();
- self.displayIcons();
+ this.init();
+ this.displayIcons();
}
// Initializer
Github.prototype.init = function () {
- var self = this,
- cached = self.getCache();
+ var cached = this.getCache();
if ( cached !== null ) {
- self.applyTemplate( JSON.parse( cached ) );
- }
- else {
- self.requestData( self.repo );
+ this.applyTemplate( JSON.parse( cached ) );
+ return;
}
+
+ this.requestData( this.repo );
};
// Display or hide icons
Github.prototype.displayIcons = function () {
- $iconStars = $( ".repo-stars" );
- $iconForks = $( ".repo-forks" );
- $iconIssues = $( ".repo-issues" );
-
- if ( this.options.iconStars ) {
- $iconStars.css( "display", "inline-block" );
- } else {
- $iconStars.css( "display", "none" );
- }
-
- if ( this.options.iconForks ) {
- $iconForks.css( "display", "inline-block" );
- } else {
- $iconForks.css( "display", "none" );
- }
-
- if ( this.options.iconIssues ) {
- $iconIssues.css( "display", "inline-block" );
- } else {
- $iconIssues.css( "display", "none" );
- }
+ var options = this.options,
+ $iconStars = $( ".repo-stars" ),
+ $iconForks = $( ".repo-forks" ),
+ $iconIssues = $( ".repo-issues" );
+
+ $iconStars.css( "display", options.iconStars ? "inline-block" : "none" );
+ $iconForks.css( "display", options.iconForks ? "inline-block" : "none" );
+ $iconIssues.css( "display", options.iconIssues ? "inline-block" : "none" );
};
// Request repositories from Github
Github.prototype.requestData = function ( repo ) {
- var self = this;
+ var that = this;
$.ajax({
url: "https://api.github.com/repos/" + repo,
dataType: "jsonp",
success: function( results ) {
- var result_data = results.data;
+ var result_data = results.data,
+ isFailling = results.meta.status >= 400 && result_data.message;
- // Handle API failures
- if ( results.meta.status >= 400 && result_data.message ) {
- self.handleErrorRequest( result_data );
- }
- else {
- self.handleSuccessfulRequest( result_data );
+ if ( isFailling ) {
+ that.handleErrorRequest( result_data );
+ return;
}
+
+ that.handleSuccessfulRequest( result_data );
}
});
};
// Handle Errors requests
Github.prototype.handleErrorRequest = function ( result_data ) {
- var self = this;
-
console.warn( result_data.message );
return;
};
// Handle Successful request
Github.prototype.handleSuccessfulRequest = function ( result_data ) {
- var self = this;
-
- self.applyTemplate( result_data );
- self.setCache( result_data );
+ this.applyTemplate( result_data );
+ this.setCache( result_data );
};
// Stores repostories in sessionStorage if available
Github.prototype.setCache = function ( result_data ) {
- var self = this;
-
// Cache data
if ( window.sessionStorage ) {
- window.sessionStorage.setItem( "gh-repos:" + self.repo, JSON.stringify( result_data ) );
+ window.sessionStorage.setItem( "gh-repos:" + this.repo, JSON.stringify( result_data ) );
}
};
// Grab cached results
Github.prototype.getCache = function() {
- var self = this;
-
if ( window.sessionStorage ) {
- return window.sessionStorage.getItem( "gh-repos:" + self.repo );
+ return window.sessionStorage.getItem( "gh-repos:" + this.repo );
}
else {
return false;
@@ -183,11 +155,10 @@ Github.prototype.getCache = function() {
// Apply results to HTML template
Github.prototype.applyTemplate = function ( repo ) {
- var self = this,
- githubRepo = new GithubRepo( repo ),
- $widget = githubRepo.toHTML();
+ var githubRepo = new GithubRepo( repo ),
+ $widget = githubRepo.toHTML();
- $widget.appendTo( self.$container );
+ $widget.appendTo( this.$container );
};
// -- Attach plugin to jQuery's prototype --------------------------------------
diff --git a/dist/jquery.github.min.js b/dist/jquery.github.min.js
index 87920e9..4d06fc4 100644
--- a/dist/jquery.github.min.js
+++ b/dist/jquery.github.min.js
@@ -1,9 +1,9 @@
/*
- * jQuery Github - v0.3.2
+ * jquery-github - v0.4.0
* A jQuery plugin to display your Github Repositories.
- * https://github.com/zenorocha/jquery-github/
+ * https://github.com/zenorocha/jquery-github
*
- * Copyright (c) 2013
+ * Copyright (c) 2014
* MIT License
*/
-function GithubRepo(s){this.description=s.description,this.forks=s.forks,this.name=s.name,this.open_issues=s.open_issues,this.pushed_at=s.pushed_at,this.url=s.url,this.watchers=s.watchers}function Github(s,t){var e=this,o={iconStars:!0,iconForks:!0,iconIssues:!1};e.element=s,e.$container=$(s),e.repo=e.$container.attr("data-repo"),e.options=$.extend({},o,t),e._defaults=o,e.init(),e.displayIcons()}GithubRepo.prototype.toHTML=function(){var s=this;return s.pushed_at=s._parsePushedDate(s.pushed_at),s.url=s._parseURL(s.url),$("" +
"
" +
"" +
"" +
"" + - "" + self.name + "" + + "" + this.name + "" + "
" + "" +
- "" + self.watchers + "" +
- "" + self.forks + "" +
- "" + self.open_issues + "" +
+ "" + this.stargazers + "" +
+ "" + this.forks + "" +
+ "" + this.open_issues + "" +
"
" +
""+s.name+""+"
"+""+""+"
"+""+""+s.description+" — Read More
"+""+this.description+" — Read More
" +
"
");
};
// Parses pushed_at with date format
GithubRepo.prototype._parsePushedDate = function ( pushed_at ) {
- var self = this,
- date = new Date( pushed_at );
+ var date = new Date( pushed_at );
return date.getDate() + "/" + ( date.getMonth() + 1 ) + "/" + date.getFullYear();
};
-// Parses URL to be friendly
-GithubRepo.prototype._parseURL = function ( url ) {
- var self = this;
-
- return url.replace( "api.", "" ).replace( "repos/", "" );
-};
-
// -- Github Plugin ------------------------------------------------------------
function Github( element, options ) {
- var self = this,
- defaults = {
+ var defaults = {
iconStars: true,
iconForks: true,
iconIssues: false
};
- self.element = element;
- self.$container = $( element );
- self.repo = self.$container.attr( "data-repo" );
+ this.element = element;
+ this.$container = $( element );
+ this.repo = this.$container.attr( "data-repo" );
- self.options = $.extend( {}, defaults, options ) ;
+ this.options = $.extend( {}, defaults, options ) ;
- self._defaults = defaults;
+ this._defaults = defaults;
- self.init();
- self.displayIcons();
+ this.init();
}
// Initializer
Github.prototype.init = function () {
- var self = this,
- cached = self.getCache();
+ var cached = this.getCache();
if ( cached !== null ) {
- self.applyTemplate( JSON.parse( cached ) );
- }
- else {
- self.requestData( self.repo );
+ this.applyTemplate( JSON.parse( cached ) );
+ return;
}
+
+ this.requestData( this.repo );
};
// Display or hide icons
Github.prototype.displayIcons = function () {
- $iconStars = $( ".repo-stars" );
- $iconForks = $( ".repo-forks" );
- $iconIssues = $( ".repo-issues" );
-
- if ( this.options.iconStars ) {
- $iconStars.css( "display", "inline-block" );
- } else {
- $iconStars.css( "display", "none" );
- }
-
- if ( this.options.iconForks ) {
- $iconForks.css( "display", "inline-block" );
- } else {
- $iconForks.css( "display", "none" );
- }
-
- if ( this.options.iconIssues ) {
- $iconIssues.css( "display", "inline-block" );
- } else {
- $iconIssues.css( "display", "none" );
- }
+ var options = this.options,
+ $iconStars = $( ".repo-stars" ),
+ $iconForks = $( ".repo-forks" ),
+ $iconIssues = $( ".repo-issues" );
+
+ $iconStars.css( "display", options.iconStars ? "inline-block" : "none" );
+ $iconForks.css( "display", options.iconForks ? "inline-block" : "none" );
+ $iconIssues.css( "display", options.iconIssues ? "inline-block" : "none" );
};
// Request repositories from Github
Github.prototype.requestData = function ( repo ) {
- var self = this;
+ var that = this;
$.ajax({
url: "https://api.github.com/repos/" + repo,
dataType: "jsonp",
success: function( results ) {
- var result_data = results.data;
+ var result_data = results.data,
+ isFailling = results.meta.status >= 400 && result_data.message;
- // Handle API failures
- if ( results.meta.status >= 400 && result_data.message ) {
- self.handleErrorRequest( result_data );
- }
- else {
- self.handleSuccessfulRequest( result_data );
+ if ( isFailling ) {
+ that.handleErrorRequest( result_data );
+ return;
}
+
+ that.handleSuccessfulRequest( result_data );
}
});
};
// Handle Errors requests
Github.prototype.handleErrorRequest = function ( result_data ) {
- var self = this;
-
console.warn( result_data.message );
return;
};
// Handle Successful request
Github.prototype.handleSuccessfulRequest = function ( result_data ) {
- var self = this;
-
- self.applyTemplate( result_data );
- self.setCache( result_data );
+ this.applyTemplate( result_data );
+ this.setCache( result_data );
};
// Stores repostories in sessionStorage if available
Github.prototype.setCache = function ( result_data ) {
- var self = this;
-
// Cache data
if ( window.sessionStorage ) {
- window.sessionStorage.setItem( "gh-repos:" + self.repo, JSON.stringify( result_data ) );
+ window.sessionStorage.setItem( "gh-repos:" + this.repo, JSON.stringify( result_data ) );
}
};
// Grab cached results
Github.prototype.getCache = function() {
- var self = this;
-
if ( window.sessionStorage ) {
- return window.sessionStorage.getItem( "gh-repos:" + self.repo );
+ return window.sessionStorage.getItem( "gh-repos:" + this.repo );
}
else {
return false;
@@ -175,11 +140,12 @@ Github.prototype.getCache = function() {
// Apply results to HTML template
Github.prototype.applyTemplate = function ( repo ) {
- var self = this,
- githubRepo = new GithubRepo( repo ),
- $widget = githubRepo.toHTML();
+ var githubRepo = new GithubRepo( repo ),
+ $widget = githubRepo.toHTML();
+
+ $widget.appendTo( this.$container );
- $widget.appendTo( self.$container );
+ this.displayIcons();
};
// -- Attach plugin to jQuery's prototype --------------------------------------
" +
"
" +
"" +
"" +
"" + - "" + self.name + "" + + "" + this.name + "" + "
" + "" +
- "" + self.watchers + "" +
- "" + self.forks + "" +
- "" + self.open_issues + "" +
+ "" + this.stargazers + "" +
+ "" + this.forks + "" +
+ "" + this.open_issues + "" +
"
" +
"