mumuki-laboratory 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e357f2b52646d202980e013193005ba137e09a00
+  data.tar.gz: add977973b135a270c47dc89b1909ed943d0303a
+SHA512:
+  metadata.gz: 7c52ddcc28cb56ead11d0caf61100aa61a29f91c123a98c2ad6d7f0320d37d9658fc69a1ea077e02f37a7a08f02fedc19ed1785655f2e2ab34ed10c80d48a3c3
+  data.tar.gz: b00b3c8c9c2583e6deeff34bc095a21054eaa122113e0b42d8289e1ee6f8b625b0dddfe833dcc1bf307c100a7e17362aff18eaf2cf0dc9973a4910b749b765da

data/README.md

@@ -0,0 +1,136 @@
+[![Build Status](https://travis-ci.org/mumuki/mumuki-laboratory.svg?branch=master)](https://travis-ci.org/mumuki/mumuki-laboratory)
+[![Code Climate](https://codeclimate.com/github/mumuki/mumuki-laboratory/badges/gpa.svg)](https://codeclimate.com/github/mumuki/mumuki-laboratory)
+[![Test Coverage](https://codeclimate.com/github/mumuki/mumuki-laboratory/badges/coverage.svg)](https://codeclimate.com/github/mumuki/mumuki-laboratory)
+[![Issue Count](https://codeclimate.com/github/mumuki/mumuki-laboratory/badges/issue_count.svg)](https://codeclimate.com/github/mumuki/mumuki-laboratory)
+
+<img width="60%" src="https://raw.githubusercontent.com/mumuki/mumuki-laboratory/master/laboratory-screenshot.png"></img>
+
+# Mumuki Laboratory [![btn_donate_lg](https://cloud.githubusercontent.com/assets/1039278/16535119/386d7be2-3fbb-11e6-9ee5-ecde4cef142a.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KCZ5AQR53CH26)
+> Code assement web application for the Mumuki Platform
+
+## About
+
+Laboratory is a multitenant Rails webapp for solving exercises, organized in terms of chapters and guides.
+
+## Preparing environment
+
+### 1. Install essentials and base libraries
+
+> First, we need to install some software: [PostgreSQL](https://www.postgresql.org) database, [RabbitMQ](https://www.rabbitmq.com/) queue, and some common Ruby on Rails native dependencies
+
+```bash
+sudo apt-get install autoconf curl git build-essential libssl-dev autoconf bison libreadline6 libreadline6-dev zlib1g zlib1g-dev postgresql libpq-dev rabbitmq-server
+```
+
+### 2. Install rbenv
+> [rbenv](https://github.com/rbenv/rbenv) is a ruby versions manager, similar to rvm, nvm, and so on.
+
+```bash
+curl https://raw.githubusercontent.com/fesplugas/rbenv-installer/master/bin/rbenv-installer | bash
+echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc # or .bash_profile
+echo 'eval "$(rbenv init -)"' >> ~/.bashrc # or .bash_profile
+```
+
+### 3. Install ruby
+
+> Now we have rbenv installed, we can install ruby and [bundler](http://bundler.io/)
+
+```bash
+rbenv install 2.3.1
+rbenv global 2.3.1
+rbenv rehash
+gem install bundler
+```
+
+### 4. Clone this repository
+
+> Because, err... we need to clone this repostory before developing it :stuck_out_tongue:
+
+```bash
+git clone https://github.com/mumuki/mumuki-laboratory
+cd mumuki-laboratory
+```
+
+### 5. Install and setup database
+
+> We need to create a PostgreSQL role - AKA a user - who will be used by Laboratory to create and access the database
+
+```bash
+# create db user
+sudo -u postgres psql <<EOF
+  create role mumuki with createdb login password 'mumuki';
+EOF
+
+# create schema and initial development data
+./devinit
+```
+
+
+## Installing and Running
+
+### Quick start
+
+If you want to start the server quickly in developer environment,
+you can just do the following:
+
+```bash
+./devstart
+```
+
+This will install your dependencies and boot the server.
+
+### Installing the server
+
+If you just want to install dependencies, just do:
+
+```
+bundle install
+```
+
+### Running the server
+
+You can boot the server by using the standard rackup command:
+
+```
+# using defaults from config/puma.rb and rackup default port 9292
+bundle exec rackup
+
+# changing port
+bundle exec rackup -p 8080
+
+# changing threads count
+MUMUKI_LABORATORY_THREADS=30 bundle exec rackup
+
+# changing workers count
+MUMUKI_LABORATORY_WORKERS=4 bundle exec rackup
+```
+
+Or you can also start it with `puma` command, which gives you more control:
+
+```
+# using defaults from config/puma.rb
+bundle exec puma
+
+# changing ports, workers and threads count, using puma-specific options:
+bundle exec puma -w 4 -t 2:30 -p 8080
+
+# changing ports, workers and threads count, using environment variables:
+MUMUKI_LABORATORY_WORKERS=4 MUMUKI_LABORATORY_PORT=8080 MUMUKI_LABORATORY_THREADS=30 bundle exec puma
+```
+
+Finally, you can also start your server using `rails`:
+
+```bash
+rails s
+```
+
+## Running tests
+
+```bash
+bundle exec rspec
+```
+
+
+## Authentication Powered by Auth0
+
+<a width="150" height="50" href="https://auth0.com/" target="_blank" alt="Single Sign On & Token Based Authentication - Auth0"><img width="150" height="50" alt="JWT Auth for open source projects" src="http://cdn.auth0.com/oss/badges/a0-badge-dark.png"/></a>

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mumuki::Laboratory'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task default: :spec
+
+
+
+
+

data/app/assets/javascripts/application.js

@@ -0,0 +1,34 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require momentjs
+//= require momentjs/locale/es
+//= require momentjs/locale/pt
+//= require webcomponents-lite
+//= require rails-ujs
+//= require turbolinks
+//= require mumuki-styles
+//= require nprogress
+//= require nprogress-turbolinks
+//= require nprogress-ajax
+//= require jquery-console
+
+//= require codemirror.min
+//= require_tree ../../../vendor/assets/javascripts/codemirror-modes
+//= require analytics
+//= require hotjar
+
+//= require_tree ./application
+
+NProgress.configure({
+  showSpinner: false
+});

data/app/assets/javascripts/application/alias-modes.js

@@ -0,0 +1,20 @@
+mumuki.load(function () {
+
+  function CodeMirrorAlias(alias, current) {
+    CodeMirror.defineMIME(alias, CodeMirror.mimeModes[current]);
+  }
+
+  CodeMirrorAlias('c', 'text/x-csrc');
+  CodeMirrorAlias('cpp', 'text/x-c++src');
+  CodeMirrorAlias('c_cpp', 'text/x-c++src');
+
+  CodeMirrorAlias("html", "text/html");
+
+  CodeMirrorAlias('java', 'text/x-java');
+
+  CodeMirrorAlias('sql', 'text/x-sql');
+
+  CodeMirrorAlias('sh', 'text/x-sh');
+  CodeMirrorAlias('bash', 'text/x-sh');
+
+});

data/app/assets/javascripts/application/bridge.js

@@ -0,0 +1,24 @@
+var mumuki = mumuki || {};
+(function (mumuki) {
+
+  function Laboratory(exerciseId){
+    this.exerciseId = exerciseId;
+  }
+
+  Laboratory.prototype = {
+    runTests: function (solution) {
+      return $.ajax({
+        type: 'POST',
+        url: window.location + '/solutions',
+        data: {
+          solution: solution
+        }
+      })
+    }
+  };
+
+  mumuki.bridge = {
+    Laboratory: Laboratory
+  };
+
+}(mumuki));

data/app/assets/javascripts/application/codemirror-builder.js

@@ -0,0 +1,59 @@
+var mumuki = mumuki || {};
+
+(function (mumuki) {
+
+  function CodeMirrorBuilder(textarea) {
+    this.textarea = textarea;
+    this.$textarea = $(textarea);
+  }
+
+  function submit() {
+    $('body').removeClass('fullscreen');
+    $('.editor-resize .fa-stack-1x').removeClass('fa-compress').addClass('fa-expand');
+    $('.btn-submit').click();
+  }
+
+  CodeMirrorBuilder.prototype = {
+    setupEditor: function () {
+      this.editor = CodeMirror.fromTextArea(this.textarea, {
+        autofocus: false,
+        tabSize: 2,
+        lineNumbers: true,
+        lineWrapping: true,
+        cursorHeight: 1,
+        matchBrackets: true,
+        lineWiseCopyCut: true,
+        autoCloseBrackets: true,
+        showCursorWhenSelecting: true,
+        extraKeys: {
+          'Ctrl-Space': 'autocomplete',
+          'Cmd-Enter': submit,
+          'Ctrl-Enter': submit,
+          'F11': function () {
+            mumuki.editor.toggleFullscreen();
+          },
+          'Tab': function (cm) {
+            mumuki.editor.indentWithSpaces(cm)
+          }
+        }
+      });
+    },
+    setupLanguage: function () {
+      var language = this.$textarea.data('editor-language');
+      if (language === 'dynamic') {
+        mumuki.page.dynamicEditors.push(this.editor);
+      } else {
+        mumuki.editor.setOption('mode', language);
+      }
+    },
+    setupOptions: function (minLines) {
+      this.editor.setOption('minLines', minLines);
+    },
+    build: function () {
+      return this.editor;
+    }
+  };
+
+  mumuki.editor = mumuki.editor || {};
+  mumuki.editor.CodeMirrorBuilder = CodeMirrorBuilder;
+}(mumuki));

data/app/assets/javascripts/application/codemirror.js

@@ -0,0 +1,89 @@
+var mumuki = mumuki || {};
+
+(function (mumuki) {
+  function createCodeMirrors() {
+    var editors = $(".editor").map(function (index, textarea) {
+      var $textarea = $("#solution_content");
+      var builder = new mumuki.editor.CodeMirrorBuilder(textarea);
+      builder.setupEditor();
+      builder.setupOptions($textarea.data('lines'));
+      builder.setupLanguage();
+      return builder.build();
+    });
+
+    return editors;
+  }
+
+  function onSelectUpdateCodeMirror() {
+    $("#exercise_language_id").change(updateCodeMirrorLanguage);
+  }
+
+  function resetEditor() {
+    mumuki.page.dynamicEditors.forEach(function (e) {
+      setDefaultContent(e, $('#default_content').val());
+    })
+  }
+
+  function toggleFullscreen() {
+    $('body').toggleClass('fullscreen');
+    $('.editor-resize .fa-stack-1x').toggleClass('fa-expand').toggleClass('fa-compress');
+  }
+
+  function indentWithSpaces(cm) {
+    if (cm.somethingSelected()) {
+      cm.indentSelection("add");
+    } else {
+      cm.execCommand("insertSoftTab");
+    }
+  }
+
+  function setDefaultContent(editor, content) {
+    editor.getDoc().setValue(content);
+  }
+
+  function updateCodeMirrorLanguage() {
+    var language = $("#exercise_language_id").find(":selected").html() || $('#exercise_language').val();
+    if (language !== undefined) {
+      mumuki.page.dynamicEditors.forEach(function (e) {
+        setEditorLanguage(e, language);
+      })
+    }
+  }
+
+  function setEditorLanguage(editor, language) {
+    editor.setOption("mode", language);
+    editor.setOption('theme', 'default ' + language);
+  }
+
+  function getContent(){
+    return mumuki.page.editors.map(function (_, editor) {
+      return editor.getValue();
+    }).get().join("\n");
+  }
+
+  mumuki.editor = mumuki.editor || {};
+  mumuki.editor.setupCodeMirrors = setEditorLanguage;
+  mumuki.editor.toggleFullscreen = toggleFullscreen;
+  mumuki.editor.indentWithSpaces = indentWithSpaces;
+  mumuki.editor.getContent = getContent;
+
+  mumuki.page = mumuki.page || {};
+  mumuki.page.dynamicEditors = [];
+  mumuki.page.editors = [];
+
+
+  mumuki.load(function () {
+    mumuki.page.editors = createCodeMirrors();
+    updateCodeMirrorLanguage();
+    onSelectUpdateCodeMirror();
+
+    $('.editor-reset').click(function () {
+      resetEditor();
+    });
+    $('.editor-resize').click(function () {
+      toggleFullscreen();
+    });
+
+  });
+
+}(mumuki));

data/app/assets/javascripts/application/confirmation.js

@@ -0,0 +1,14 @@
+mumuki.load(function () {
+  $('.btn-confirmation').on('click change', function (evt) {
+    var token = new mumuki.CsrfToken();
+
+    $.ajax(token.newRequest({
+      method: 'POST',
+      url: $(this).data('confirmation-url'),
+      xhrFields: {withCredentials: true}
+    }));
+
+    return true;
+  });
+});
+

data/app/assets/javascripts/application/console.js

@@ -0,0 +1,175 @@
+var mumuki = mumuki || {};
+(function (mumuki) {
+  function historicalQueries() {
+    var queries = $('#historical_queries').val();
+    if (queries) {
+      return JSON.parse(queries);
+    } else {
+      return [];
+    }
+  }
+  function renderPrompt() {
+    var prompt = $('#prompt').attr('value');
+    if (prompt && prompt.indexOf('ム') >= 0) {
+      $('.jquery-console-prompt-label')
+        .html('')
+        .append('<i class="text-primary da da-mumuki"></i>')
+        .append('<span>&nbsp;&nbsp;</span>');
+    }
+  }
+
+  function classForStatus(status) {
+    return 'jquery-console-message-' + (status === 'passed' ? 'value' : 'error');
+  }
+
+  function reportStatus(message, status, report) {
+    report([{
+      msg: message,
+      className: classForStatus(status)
+    }]);
+    renderPrompt();
+  }
+
+  function clearConsole() {
+    $('.jquery-console-message-error').remove();
+    $('.jquery-console-message-value').remove();
+    $('.jquery-console-prompt-box:not(:last)').remove()
+  }
+
+  function QueryConsole() {
+    this.endpoint = $('#console_endpoint').val();
+    this.token = new mumuki.CsrfToken();
+    this.statefulConsole = $('#stateful_console').val() === "true";
+    this.lines = [];
+  }
+
+  QueryConsole.prototype = {
+    newQuery: function (line) {
+      var cookies = this.statefulConsole ? this.lines : [];
+      return new Query(line, cookies, this);
+    },
+    clearState: function () {
+      this.lines = [];
+      clearConsole();
+    },
+    sendQuery: function (queryContent) {
+      this.controller.promptText(queryContent);
+      this.controller.typer.commandTrigger();
+    },
+    preloadQuery: function (queryWithResults) {
+      this.lines.push(queryWithResults.query);
+      this.enqueuePreloadedQuery(queryWithResults);
+      this.sendQuery(queryWithResults.query);
+    },
+    enqueuePreloadedQuery: function (queryWithResults) {
+      this.preloadedQuery = queryWithResults;
+    },
+    dequeuePreloadedQuery: function () {
+      var result = this.preloadedQuery;
+      this.preloadedQuery = undefined;
+      return result;
+    },
+    preloadHistoricalQueries: function () {
+      var self = this;
+      historicalQueries().forEach(function (queryWithResults) {
+        self.preloadQuery(queryWithResults);
+      });
+    }
+  };
+
+  function Query(line, cookie, console) {
+    this.console = console;
+    this.line = line;
+    this.cookie = cookie;
+  }
+
+  Query.prototype = {
+    get token() {
+      return this.console.token;
+    },
+    get content() {
+      var firstEditor = mumuki.page.editors[0];
+      if (firstEditor && $("#include_solution").prop("checked"))
+        return firstEditor.getValue();
+      else
+        return '';
+    },
+    submit: function (report, queryConsole, line) {
+      var self = this;
+      var preloadedQuery = queryConsole.dequeuePreloadedQuery();
+      if (preloadedQuery) {
+        return reportStatus(preloadedQuery.result, preloadedQuery.status, report);
+      }
+
+      $.ajax(self._request).done(function (response) {
+        if (response.query_result) {
+          self.displayGoalResult(response);
+          response = response.query_result;
+        }
+        self.displayQueryResult(report, queryConsole, line, response);
+      }).fail(function (response) {
+        reportStatus(response.responseText, 'failed', report);
+      });
+    },
+    displayGoalResult: function (response) {
+      if (response.status == 'passed') {
+        $('.submission-results').show();
+        $('.submission-results').html(response.html);
+        mumuki.pin.scroll();
+        mumuki.updateProgressBarAndShowModal(response);
+      } else {
+        $('.submission-results').hide();
+        $('.progress-list-item.active').attr('class', "progress-list-item text-center danger active");
+      }
+    },
+    displayQueryResult: function (report, queryConsole, line, response) {
+      if (response.status !== 'errored') {
+        queryConsole.lines.push(line);
+        reportStatus(response.result, response.status, report);
+      } else {
+        reportStatus(response.result, 'failed', report);
+      }
+    },
+    get _request() {
+      var self = this;
+      return self.token.newRequest({
+        url: self._requestUrl,
+        type: 'POST',
+        data: self._requestData
+      })
+    },
+    get _requestUrl() {
+      return this.console.endpoint;
+    },
+    get _requestData() {
+      return {content: this.content, query: this.line, cookie: this.cookie};
+    }
+  };
+
+
+  mumuki.load(function () {
+    var prompt = $('#prompt').attr('value');
+    var queryConsole = new QueryConsole();
+
+    $('.console-reset').click(function () {
+      queryConsole.clearState();
+    });
+
+    queryConsole.controller = $('.console').console({
+      promptLabel: prompt + ' ',
+      commandValidate: function (line) {
+        return line !== "";
+      },
+      commandHandle: function (line, report) {
+        queryConsole.newQuery(line).submit(report, queryConsole, line);
+      },
+      autofocus: !!$('#solution_editor_bottom').val(),
+      animateScroll: true,
+      promptHistory: true
+    });
+
+    renderPrompt();
+    queryConsole.preloadHistoricalQueries();
+  });
+
+}(mumuki));