mumuki-puzzle-runner 0.0.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03d2bd46ce0352ca4c5ad1f58d58fa1ae6a46abc0b817e09ae39d105e7a192d
-  data.tar.gz: ccb6886006ec2242006efcbffb9d96035edcc14e6146633bc6155c6a3a8f03c8
+  metadata.gz: 5da4e03efe5edbeb4e6eadfaf79f5d37e4f5bea50127a26e91c5f6d2cedb2438
+  data.tar.gz: f0eeb8f873165d98ecfcc04854aa4fb781d4753fc4350bcfed90fd24c184744b
 SHA512:
-  metadata.gz: 52de2959fbee8ccabdd04d01fc1881b0ec1e58e39c58a9c45dd9d59ac1f4ef8a38f388dcda54419875c869f6f11cad916ab4c82041c66a2f8f5bad7103f22f80
-  data.tar.gz: e0287cc443813d18bf5449da8dbf2c7383490ddc09bf0c1d1c179590d7d8d8b38e865ec16a4d41701e9b9b5d66121aaeda3f2f84eda2ea21f4d92de9a903938f
+  metadata.gz: c98b0e5f9fe633c8fb0587b3c948ce0a6d6d79b80619befc28bc4c583578be596b1d8d2d9f61fddbb3241a320424b602af417fca96827c632a9537342d2a62e9
+  data.tar.gz: f40b2c76b102651f25ca76eda5b82d24f6cb037e92efcbd68299d634ec8a4f8a22477f4639893b780f6e8f44e790761189c43c12a925a5421f8e33416b3273af

data/lib/metadata_hook.rb

@@ -3,14 +3,15 @@ class PuzzleMetadataHook < Mumukit::Hook
     {
       language: {
         name: 'muzzle',
-        version: '1.0.0',
+        version: PuzzleVersionHook::VERSION,
         extension: 'js',
         ace_mode: 'javascript'
       },
       test_framework: {
           name: 'muzzle',
-          version: '1.0.0',
-          test_extension: 'js'
+          version: PuzzleVersionHook::VERSION,
+          test_extension: 'js',
+          template: "// see more examples at https://github.com/mumuki/mumuki-puzzle-runner\nMuzzle.basic(3, 2, 'https://flbulgarelli.github.io/headbreaker/static/berni.jpg');"
       },
       layout_assets_urls: {
         js: [

data/lib/public/css/muzzle-editor.css

@@ -1,4 +1,13 @@
 .mu-kids-state-image img {
-  width: 90%;
+  height: 100%;
+  width: auto;
   padding: 30px;
 }
+
+.mu-kids-state.mu-state-initial {
+  width: 100%;
+}
+
+.mu-kids-exercise-workspace.muzzle-simple .mu-kids-submit-button {
+  display: none;
+}

data/lib/public/js/muzzle-editor.js

@@ -1,12 +1,18 @@
 // @ts-nocheck
 $(() => {
+  function register(event, callback) {
+    const _event = Muzzle[event];
+    Muzzle[event] = (...args) => {
+      callback(...args);
+      _event(...args);
+    }
+  }
+
   // ================
   // Muzzle rendering
   // ================
 
-  console.log('Registering Muzzle...')
-  const $customEditorValue = $('#mu-custom-editor-value');
-  Muzzle.previousSolutionJson = $customEditorValue.val();
+  Muzzle.previousSolutionContent = $('#mu-custom-editor-value').val();
 
   $('#mu-puzzle-custom-editor').append(`
     <div id="muzzle-canvas">
@@ -20,46 +26,55 @@ $(() => {
   // Submission config
   // =================
 
+
   // Required to sync state before submitting
-  mumuki.submission.registerContentSyncer(() => {
-    Muzzle.prepareSubmission();
-    $customEditorValue.val(Muzzle.previousSolutionJson);
+  mumuki.CustomEditor.addSource({
+    getContent() { return { name: "solution[content]", value: Muzzle.solutionContent }; }
   });
+  mumuki.CustomEditor.addSource({
+    getContent() { return { name: "client_result[status]", value: Muzzle.clientResultStatus }; }
+  })
 
   // Requiered to actually bind Muzzle's submit to
   // mumuki's solution processing
-  const _onSubmit = Muzzle.onSubmit;
-  Muzzle.onSubmit = (solutionJson, valid) => {
-    console.log('submitting muzzle...')
-    mumuki.submission.processSolution({solution: {content: solutionJson}});
-    _onSubmit(solutionJson, valid);
-  }
+  register('onSubmit', (submission) => {
+    mumuki.submission.processSolution(submission);
+  });
 
   // ===========
   // Kids config
   // ===========
 
-  // Required to make scaler work
   mumuki.kids.registerStateScaler(($state, fullMargin, preferredWidth, preferredHeight) => {
-    // nothing
-    // no state scaling needed
+    //  no manul image scalling. Leave it to css
   });
+
   mumuki.kids.registerBlocksAreaScaler(($blocks) => {
-    // nothing
-    // no blocks scaling needed
+    const maxHeight = $('.mu-kids-exercise').height() - $('.mu-kids-exercise-description').height();
+    Muzzle.scale($blocks.width(), Math.min($blocks.height(), maxHeight));
+  });
+
+  Muzzle.manualScale = true;
+
+  // ====================
+  // Submit button hiding
+  // ====================
+
+  register('onReady', () => {
+    if (Muzzle.simple) {
+      $('.mu-kids-exercise-workspace').addClass('muzzle-simple');
+    }
   });
 
   // ==============
   // Assets loading
   // ==============
 
-  const _onReady = Muzzle.onReady;
-  Muzzle.onReady = () => {
+  register('onReady', () => {
     mumuki.assetsLoadedFor('editor');
     // although layout assets
     // are actually loaded before this script, puzzle runner is not aimed
     // to be used without a custom editor
     mumuki.assetsLoadedFor('layout');
-    _onReady();
-  };
+  });
 });

data/lib/public/js/muzzle.js

@@ -32,19 +32,12 @@ class MuzzleCanvas {
      * @type {Canvas}
      **/
     this._canvas = null;
-    this.baseConfig = {
-      width: 800,
-      height: 650,
-      pieceSize: 100,
-      proximity: 20,
-      borderFill: 10,
-      strokeWidth: 1.5,
-      lineSoftness: 0.18
-    };
 
     /**
      * The id of the HTML element that will contain the canvas
      * Override it you are going to place in a non-standard way
+     *
+     * @type {string}
      */
     this.canvasId = id;
 
@@ -61,9 +54,72 @@ class MuzzleCanvas {
      * Wether expected refs shall be ignored by Muzzle.
      *
      * They will still be evaluated server-side.
+     *
+     * @type {boolean}
      */
     this.expectedRefsAreOnlyDescriptive = false;
 
+    /**
+     * Width of canvas
+     *
+     * @type {number}
+     */
+    this.canvasWidth = 600;
+
+    /**
+     * Height of canvas
+     *
+     * @type {number}
+     */
+    this.canvasHeight = 600;
+
+    /**
+     * Wether canvas shoud **not** be resized.
+     * Default is `false`
+     *
+     * @type {boolean}
+     */
+    this.fixedDimensions = false;
+
+    /**
+     * Size of fill. Set null for perfect-match
+     *
+     * @type {number}
+     */
+    this.borderFill = null;
+
+    /**
+     * Canvas line width
+     *
+     * @type {number}
+     */
+    this.strokeWidth = 1.5;
+
+    /**
+     * Piece size
+     *
+     * @type {number}
+     */
+    this.pieceSize = 100;
+
+    /**
+     * The x:y aspect ratio of the piece. Set null for automatic
+     * aspectRatio
+     *
+     * @type {number}
+     */
+    this.aspectRatio = null;
+
+    /**
+     * If the images should be adjusted vertically instead of horizontally
+     * to puzzle dimensions. `false` by default
+     *
+     * @type {boolean}
+     */
+    this.fitImagesVertically = false;
+
+    this.manualScale = false;
+
     /**
      * Callback that will be executed
      * when muzzle has fully loaded and rendered its first
@@ -75,12 +131,22 @@ class MuzzleCanvas {
     this.onReady = () => {};
 
     /**
-     * The previous solution to the current puzzle in this or a past session,
+     * The previous solution to the current puzzle in a past session,
      * if any
      *
      * @type {string}
      */
-    this.previousSolutionJson = null
+    this.previousSolutionContent = null;
+
+    /**
+     * Whether the current puzzle can be solved in very few tries.
+     *
+     * Set null for automatic configuration of this property. Basic puzzles will be considered
+     * basic and match puzzles will be considered non-basic.
+     *
+     * @type {boolean}
+     */
+    this.simple = null;
 
     /**
      * Callback to be executed when submitting puzzle.
@@ -88,15 +154,49 @@ class MuzzleCanvas {
      * Does nothing by default but you can
      * override it to perform additional actions
      *
-     * @param {string} solutionJson the solution, as a JSON
-     * @param {boolean} valid whether this puzzle is valid or nor
+     * @param {{solution: {content: string}, client_result: {status: "passed" | "failed"}}} submission
+     */
+    this.onSubmit = (submission) => {};
+
+     /**
+     * Callback that will be executed
+     * when muzzle's puzzle becomes valid
+     *
+     * It does nothing by default but you can override this
+     * property with any code you need the be called here
      */
-    this.onSubmit = (solutionJson, valid) => {};
+    this.onValid = () => {};
+  }
+
+  /**
+   */
+  get baseConfig() {
+    const aspectRatio = this.aspectRatio || 1;
+    const pieceSize = headbreaker.vector(this.pieceSize / aspectRatio, this.pieceSize);
+    return {
+      width: this.canvasWidth,
+      height: this.canvasHeight,
+      pieceSize: pieceSize,
+      proximity: Math.min(pieceSize.x, pieceSize.y) / 5,
+      borderFill: this.borderFill === null ? headbreaker.Vector.divide(pieceSize, 10) : this.borderFill,
+      strokeWidth: this.strokeWidth,
+      lineSoftness: 0.18
+    };
+  }
+
+  /**
+   * @type {Axis}
+   */
+  get imageAdjustmentAxis() {
+    console.log(this.fitImagesVertically)
+    return this.fitImagesVertically ? headbreaker.Vertical : headbreaker.Horizontal;
   }
 
   /**
    * The currently active canvas, or null if
    * it has not yet initialized
+   *
+   * @returns {Canvas}
    */
   get canvas() {
     return this._canvas;
@@ -134,53 +234,93 @@ class MuzzleCanvas {
    * @returns {Promise<Canvas>} the promise of the built canvas
    */
   async basic(x, y, imagePath) {
+    if (!this.aspectRatio) {
+      this.aspectRatio = x / y;
+    }
+
+    if (this.simple === null) {
+      this.simple = true;
+    }
+
     /**
      * @todo take all container size
      **/
     const image = await this._loadImage(imagePath);
     /** @type {Canvas} */
     // @ts-ignore
-    const canvas = new headbreaker.Canvas(this.canvasId, this._canvasConfig(image));
+    const canvas = this._createCanvas({ image: image });
+    canvas.adjustImagesToPuzzle(this.imageAdjustmentAxis);
     canvas.autogenerate({ horizontalPiecesCount: x, verticalPiecesCount: y });
-    this._attachValidator(canvas);
+    this._attachBasicValidator(canvas);
+    canvas.shuffleGrid(0.8);
+    this._configCanvas(canvas);
     canvas.onValid(() => {
       setTimeout(() => {
-        if (canvas.puzzle.isValid) {
-          this.submit()
+        if (canvas.valid) {
+          this.submit();
         }
       }, 1500);
     });
-    this._configInitialCanvas(canvas);
     return canvas;
   }
 
   /**
-   * @param {any} configs
+   * @param {number} x
+   * @param {number} y
+   * @param {string[]} [imagePaths]
    * @returns {Promise<Canvas>} the promise of the built canvas
    */
-  multi(configs) {
-    return Promise.reject("not implemented yet");
+  async multi(x, y, imagePaths) {
+    const count = imagePaths.length;
+    const images = await Promise.all(imagePaths.map(imagePath => this._loadImage(imagePath)));
+
+    const canvas = this._createCanvas();
+    canvas.autogenerate({ horizontalPiecesCount: x, verticalPiecesCount: y * count });
+
+    // todo validate
+    // todo set images
+
+    this._configCanvas(canvas);
+    return canvas;
   }
 
   /**
-   * @param {PieceConfig[]} lefts
-   * @param {PieceConfig[]} rights
+   * Craates a match puzzle, where left pieces are matched against right pieces,
+   * with optional odd left and right pieces that don't match
+   *
+   * @param {string[]} leftUrls
+   * @param {string[]} rightUrls must be of the same size of lefts
+   * @param {string[]} leftOddUrls
+   * @param {string[]} rightOddUrls
    * @returns {Promise<Canvas>} the promise of the built canvas
    */
-  async match(lefts, rights, leftOdds, rightOdds) {
-    /** @type {(Promise<Template>)[]} */
+  async match(leftUrls, rightUrls, leftOddUrls = [], rightOddUrls = []) {
+    /** @private @type {(Promise<Template>)[]} */
     const templatePromises = [];
-    const last = lefts.length - 1;
+    const pushTemplate = (config, options) =>
+      templatePromises.push(this._createMatchTemplate(config, options));
+
+    const last = leftUrls.length - 1;
     for (let i = 0; i <= last; i++) {
-      templatePromises.push(this._buildTemplate(lefts[i], `T-N-`));
-      templatePromises.push(this._buildTemplate(rights[i], `N-S-`));
+      const leftId = `l${i}`;
+      const rightId = `r${i}`;
+
+      pushTemplate(leftUrls[i], {id: leftId, targetPosition: { x: this.pieceSize, y: this.pieceSize * (i + 1) }, left: true, rightTargetId: rightId});
+      pushTemplate(rightUrls[i], {id: rightId, targetPosition: { x: 2 * this.pieceSize, y: this.pieceSize * (i + 1) }});
     }
+
+    leftOddUrls.forEach((it, i) =>  pushTemplate(it, {id: `lo${i}`, left: true, odd: true, targetPosition: { x: this.pieceSize, y: this.pieceSize * (i + leftUrls.length) }, }));
+    rightOddUrls.forEach((it, i) => pushTemplate(it, {id: `ro${i}`, odd: true, targetPosition: { x: 2 * this.pieceSize, y: this.pieceSize * (i + rightUrls.length) },}));
+
+    //  + Math.max(leftOddUrls.length, rightOddUrls.length)
     const templates = await Promise.all(templatePromises);
     /** @type {Canvas} */
-    const canvas = new headbreaker.Canvas(this.canvasId, this._canvasConfig(null));
+    const canvas = this._createCanvas({ maxPiecesCount: {x: 2, y: leftUrls.length} });
+    canvas.adjustImagesToPiece(this.imageAdjustmentAxis);
     templates.forEach(it => canvas.sketchPiece(it));
-    this._attachValidator(canvas);
-    this._configInitialCanvas(canvas);
+    canvas.shuffleColumns(0.8);
+    this._attachMatchValidator(canvas);
+    this._configCanvas(canvas);
     return canvas;
   }
 
@@ -189,32 +329,43 @@ class MuzzleCanvas {
    * @returns {Promise<Canvas>} the promise of the built canvas
    */
   custom(canvas) {
-    this._configInitialCanvas(canvas);
+    this._configCanvas(canvas);
     return Promise.resolve(canvas);
   }
 
   /**
    * @private
-   * @param {HTMLImageElement} image
+   * @param {any} config
+   * @return {Canvas}
    */
-  _canvasConfig(image) {
-    return Object.assign({ image }, this.baseConfig);
+  _createCanvas(config = {}) {
+    return new headbreaker.Canvas(this.canvasId, Object.assign(config, this.baseConfig));
   }
 
   /**
    * @private
    * @param {Canvas} canvas
    */
-  _attachValidator(canvas) {
+  _attachBasicValidator(canvas) {
     if (!this.expectedRefsAreOnlyDescriptive && this._expectedRefs) {
-      canvas.attachValidator(
-        new headbreaker.PuzzleValidator(
-          headbreaker.PuzzleValidator.relativeRefs(this._expectedRefs)));
+      canvas.attachRelativeRefsValidator(this._expectedRefs);
     } else {
       canvas.attachSolvedValidator();
     }
   }
 
+  /**
+   * @private
+   * @param {Canvas} canvas
+   */
+  _attachMatchValidator(canvas) {
+    canvas.attachValidator(new headbreaker.PuzzleValidator(
+      puzzle => puzzle.pieces
+                  .filter(it => !it.metadata.odd && it.metadata.left)
+                  .every(it => it.rightConnection && it.rightConnection.id === it.metadata.rightTargetId)
+    ));
+  }
+
   /**
    * @private
    * @param {string} path
@@ -226,23 +377,95 @@ class MuzzleCanvas {
     return new Promise((resolve, reject) => image.onload = () => resolve(image));
   }
 
-  _buildTemplate(config, structure) {
-    return this._loadImage(config.imagePath).then((image) =>({
-      structure: config.structure || structure,
-      metadata: {image}
-    }));
+  /**
+   * @private
+   * @param {string} imagePath
+   * @param {object} options
+   * @returns {Promise<object>}
+   */
+  _createMatchTemplate(imagePath, {id, left = false, targetPosition = null, rightTargetId = null, odd = false}) {
+    const structure = left ? 'T-N-' : `N-S-`;
+
+    return this._loadImage(imagePath).then((image) => {
+      return {
+        structure,
+        metadata: { id, left, odd, rightTargetId, image, targetPosition }
+      }
+    });
   }
 
   /**
+   * @private
    * @param {Canvas} canvas
    */
-  _configInitialCanvas(canvas) {
+  _configCanvas(canvas) {
     this._canvas = canvas;
+    this._canvas.onValid(() => {
+      setTimeout(() => this.onValid(), 0);
+    });
+    this._setUpScaler();
     this.ready();
   }
 
+  _setUpScaler() {
+    if (this.manualScale) return;
+
+    ['resize', 'load'].forEach((event) => {
+      window.addEventListener(event, () => {
+        var container = document.getElementById(this.canvasId);
+        this.scale(container.offsetWidth, container.scrollHeight);
+      });
+    });
+  }
+
+  scale(width, height) {
+    if (this.fixedDimensions || !this.canvas) return;
+    const factor = this.optimalScaleFactor(width, height);
+    this.canvas.resize(width, height);
+    this.canvas.scale(factor);
+    this.canvas.redraw();
+    this.focus();
+  }
+
+  focus() {
+    const stage = this.canvas['__konvaLayer__'].getStage();
+
+    const area = headbreaker.Vector.divide(headbreaker.vector(stage.width(), stage.height()), stage.scaleX());
+    const realDiameter = (() => {
+      const [xs, ys] = this.coordinates;
+
+      const minX = Math.min(...xs);
+      const minY = Math.min(...ys);
+
+      const maxX = Math.max(...xs);
+      const maxY = Math.max(...ys);
+
+      return headbreaker.Vector.plus(headbreaker.vector(maxX - minX, maxY - minY), this.canvas.puzzle.pieceDiameter);
+    })();
+    const diff = headbreaker.Vector.minus(area, realDiameter);
+    const semi = headbreaker.Vector.divide(diff, -2);
+
+    stage.setOffset(semi);
+    stage.draw();
+  }
+
+  get coordinates() {
+    const points = this.canvas.puzzle.points;
+    return [points.map(([x, _y]) => x), points.map(([_x, y]) => y)];
+  }
+
+  optimalScaleFactor(width, height) {
+    const factors = headbreaker.Vector.divide(headbreaker.vector(width, height), this.canvas.puzzleDiameter);
+    return Math.min(factors.x, factors.y) / 1.75;
+  }
+
+  /**
+   * Mark Muzzle as ready, loading previous solution
+   * and drawing the canvas
+   */
   ready() {
     this.loadPreviousSolution();
+    this.resetCoordinates();
     this.draw();
     this.onReady();
   }
@@ -262,30 +485,34 @@ class MuzzleCanvas {
   }
 
   /**
+   * Loads - but does not draw - a solution into the canvas.
+   *
    * @param {Solution} solution
    */
   loadSolution(solution) {
     this.canvas.puzzle.relocateTo(solution.positions);
+    this.canvas.puzzle.autoconnect();
   }
 
   /**
-   * Loads the current canvas with the
+   * Loads - but does not draw - the current canvas with the previous solution, if available.
+   *
    */
   loadPreviousSolution() {
-    if (this.previousSolutionJson) {
+    if (this.previousSolutionContent) {
       try {
-        this.loadSolution(JSON.parse(this.previousSolutionJson));
+        this.loadSolution(JSON.parse(this.previousSolutionContent));
       } catch (e) {
         console.warn("Ignoring unparseabe editor value");
       }
-    } else {
-      this.canvas.shuffle(0.8);
     }
   }
 
-  prepareSubmission() {
-    this.canvas.puzzle.validate();
-    this.previousSolutionJson = this._solutionJson;
+  resetCoordinates() {
+    const [xs, ys] = this.coordinates;
+    const minX = Math.min(...xs);
+    const minY = Math.min(...ys);
+    this.canvas.puzzle.translate(-minX, -minY);
   }
 
   // ==========
@@ -297,24 +524,56 @@ class MuzzleCanvas {
    * validating it if necessary
    */
   submit() {
-    this.prepareSubmission();
-    this.onSubmit(this._solutionJson, this.canvas.puzzle.valid);
+    this.onSubmit(this._prepareSubmission());
   }
 
   /**
    * The current solution, expressed as a JSON string
    */
-  get _solutionJson() {
+  get solutionContent() {
     return JSON.stringify(this.solution);
   }
-}
 
+  /**
+   * The solution validation status
+   *
+   * @returns {"passed" | "failed"}
+   */
+  get clientResultStatus() {
+    return this.canvas.valid ? 'passed' : 'failed';
+  }
 
-const Muzzle = new MuzzleCanvas();
+  _prepareSubmission() {
+    return {
+      solution: {
+        content: this.solutionContent
+      },
+      client_result: {
+        status: this.clientResultStatus
+      }
+    };
+  }
 
-Muzzle.aux = {};
-Muzzle.another = (id) => {
-  const muzzle = new MuzzleCanvas(id);
-  Muzzle.aux[id] = muzzle
-  return muzzle;
 }
+
+const Muzzle = new class extends MuzzleCanvas {
+  constructor() {
+    super();
+    this.aux = {};
+  }
+
+  /**
+   * Creates a suplementary canvas at the element
+   * of the given id
+   *
+   * @param {string} id
+   * @returns {MuzzleCanvas}
+   */
+  another(id) {
+    const muzzle = new MuzzleCanvas(id);
+    Muzzle.aux[id] = muzzle
+    return muzzle;
+  }
+}
+
+window['Muzzle'] = Muzzle;