hub.me.js

/*
 *  Project: Hub.me
 *  Description: An alternative and responsive gallery for your projects on Github
 *  URL: https://github.com/zenorocha/hub.me
 *  Author: Zeno Rocha
 *  License: WTFPL - http://sam.zoy.org/wtfpl/COPYING
 */

// the semi-colon before function invocation is a safety net against concatenated
// scripts and/or other plugins which may not be closed properly.
;(function ( $, Hogan, window, document, undefined ) {

    // undefined is used here as the undefined global variable in ECMAScript 3 is
    // mutable (ie. it can be changed by someone else). undefined isn't really being
    // passed in so we can ensure the value of it is truly undefined. In ES5, undefined
    // can no longer be modified.

    // window and document are passed through as local variables rather than globals
    // as this (slightly) quickens the resolution process and can be more efficiently
    // minified (especially when both are regularly referenced in your plugin).

    // Create the defaults once
    var hubMe = 'hubMe',
        defaults = {
            username: 'github',
            theme: 'blue',
            exclude: [],
            languages: true
        };

    // The actual plugin constructor
    function Plugin( element, options ) {
        this.element = $(element);

        // jQuery has an extend method which merges the contents of two or
        // more objects, storing the result in the first object. The first object
        // is generally empty as we don't want to alter the default options for
        // future instances of the plugin
        this.options = $.extend( {}, defaults, options) ;

        this._defaults = defaults;
        this._name = hubMe;

        this.init();
    }

    Plugin.prototype.init = function () {
        // add theme
        $('#theme-css').attr('href', 'css/themes/' + this.options.theme + '.css');

        // get repository
        this.getRepos();
    };

    Plugin.prototype.getRepos = function () {

        var self = this,
            repos = [],
            thisRepo = self.options.username + '.github.com';

        $.getJSON('https://api.github.com/users/' + this.options.username + '/repos?callback=?', function (result) {

            $.each(result.data, function(i, field) {
            	if (field.language != null && field.name != thisRepo)
					repos.push(field);
            });

            repos = orderByLanguages(repos);

            $.each(repos, function(i, field) {

                if ( $.inArray( repos[i].name, self.options.exclude ) === -1 ) {

                    if (self.options.languages) {

                        if (i > 0) {
	                        if (repos[i].language != repos[i-1].language) {
	                            self.createCategory(repos[i].language);
	                        }
	                    }
	                    else {
	                        self.createCategory(repos[i].language);
	                    }

                    }

                    self.createRepo(repos[i]);
                }

            });

        });
    };

    Plugin.prototype.createCategory = function(catName) {

        var tmpl = Hogan.compile( $('#category-item').html() ),
            params = {category_name:catName},
            cat = tmpl.render(params);

        this.element.append(cat);

    };

    Plugin.prototype.createRepo = function(repo) {
        // test if homepage begins with http or https
        repo.homepage = ( repo.homepage && !( /^(http|https):\/\//.test( repo.homepage ) ) ) ? "http://" + repo.homepage : repo.homepage;

        var tmpl = Hogan.compile( $('#repository-item').html() ),
            repository = tmpl.render(repo);

        this.element.append(repository);

    };

    var orderByLanguages = function(repos) {

        return repos.sort(function(a, b) {

                var langA = a.language,
                    langB = b.language;

                if (langA < langB)
                    return -1;
                if (langA > langB)
                    return 1;

            });
    }

    // A really lightweight plugin wrapper around the constructor,
    // preventing against multiple instantiations
    $.fn.hubMe = function ( options ) {
        return this.each(function () {
            if (!$.data(this, 'plugin_' + hubMe)) {
                $.data(this, 'plugin_' + hubMe, new Plugin( this, options ));
            }
        });
    }

})(jQuery, Hogan, window, document);