mumuki-puzzle-runner 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c06f3a9c0ab060ce1746fbd08687e44bdd3edc9d2bd7bc9f27991cfa56d34e96
-  data.tar.gz: 3fd982c69ed60580166016ad4824be96a67b5480d238311e347c7588e86ededd
+  metadata.gz: 2b959c734b9bad4afe953699049bf7ecc09a37176eae6d38fdb9734a63e5a1d2
+  data.tar.gz: bd617cf58d7bd0d870d4d620dfca48dc329dd560786a0f0b9a912cea3fa6d400
 SHA512:
-  metadata.gz: 594855995d69d145ceb3294c3bfc571d681a18e5983e9130884bde9508feea77519764066ceb7fa6b843923dfebc728bfe8a5cf3f08058c9aacc5362f4e784c5
-  data.tar.gz: 6f2d79e5203433e39a8d0bcea6ca80442f8eac32e3eb3d72f04fbadd82490578836444f0c57ad93163d74c9bbbcbcec268b04c97a77d33a2152d191b73cdfba8
+  metadata.gz: 8972354d9f4c3c474e497ae29f50b0b09025b0da69a4b632bcdfabf8cbc7df18480ee78a0a3450af5d904c9bdb235ced2eada0b4aa52c8ce2ec55b026f4d255f
+  data.tar.gz: a5aea1cba3903c0032f55dd35c148172272aedd8a0b9e3cea7b7cd383ce75a82a8120557ef1d8088eaa722d90de301c2a07bd62ea79ca417e4d3aca83f12de37

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,5 +1,13 @@
 // @ts-nocheck
 $(() => {
+  function register(event, callback) {
+    const _event = Muzzle[event];
+    Muzzle[event] = (...args) => {
+      callback(...args);
+      _event(...args);
+    }
+  }
+
   // ================
   // Muzzle rendering
   // ================
@@ -29,37 +37,44 @@ $(() => {
 
   // Requiered to actually bind Muzzle's submit to
   // mumuki's solution processing
-  const _onSubmit = Muzzle.onSubmit;
-  Muzzle.onSubmit = (submission) => {
+  register('onSubmit', (submission) => {
     mumuki.submission.processSolution(submission);
-    _onSubmit(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

@@ -64,14 +64,22 @@ class MuzzleCanvas {
      *
      * @type {number}
      */
-    this.canvasWidth = 800;
+    this.canvasWidth = 600;
 
     /**
      * Height of canvas
      *
      * @type {number}
      */
-    this.canvasHeight = 800;
+    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
@@ -80,6 +88,13 @@ class MuzzleCanvas {
      */
     this.borderFill = null;
 
+    /**
+     * Canvas line width
+     *
+     * @type {number}
+     */
+    this.strokeWidth = 3;
+
     /**
      * Piece size
      *
@@ -88,11 +103,22 @@ class MuzzleCanvas {
     this.pieceSize = 100;
 
     /**
-     * * Whether image's width should be scaled to piece
+     * 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.scaleImageWidthToFit = true;
+    this.fitImagesVertically = false;
+
+    this.manualScale = false;
 
     /**
      * Callback that will be executed
@@ -110,7 +136,19 @@ class MuzzleCanvas {
      *
      * @type {string}
      */
-    this.previousSolutionContent = 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;
+
+    this.spiky = false;
 
     /**
      * Callback to be executed when submitting puzzle.
@@ -132,18 +170,55 @@ class MuzzleCanvas {
     this.onValid = () => {};
   }
 
+
+
   /**
    */
   get baseConfig() {
-    return {
+    return Object.assign({
       width: this.canvasWidth,
       height: this.canvasHeight,
-      pieceSize: this.pieceSize,
-      proximity: this.pieceSize / 5,
-      borderFill: this.borderFill === null ? this.pieceSize / 10 : this.borderFill,
-      strokeWidth: 1.5,
+      pieceSize: this.adjustedPieceSize,
+      proximity: Math.min(this.adjustedPieceSize.x, this.adjustedPieceSize.y) / 5,
+      strokeWidth: this.strokeWidth,
       lineSoftness: 0.18
-    };
+    }, this.outlineConfig);
+  }
+
+  /**
+   */
+  get outlineConfig() {
+    if (this.spiky) {
+      return {
+        borderFill: this.borderFill === null ? headbreaker.Vector.divide(this.adjustedPieceSize, 10) : this.borderFill,
+      }
+    } else {
+      return {
+        borderFill: 0,
+        outline: new headbreaker.outline.Rounded({bezelize: true, insertDepth: 3/5, bezelDepth: 9/10}),
+      }
+    }
+  }
+
+  /**
+   * The piece size, adjusted to the aspect ratio
+   *
+   * @returns {Vector}
+   */
+  get adjustedPieceSize() {
+    if (!this._adjustedPieceSize) {
+      const aspectRatio = this.aspectRatio || 1;
+      this._adjustedPieceSize = headbreaker.vector(this.pieceSize / aspectRatio, this.pieceSize);
+    }
+    return this._adjustedPieceSize;
+  }
+
+  /**
+   * @type {Axis}
+   */
+  get imageAdjustmentAxis() {
+    console.log(this.fitImagesVertically)
+    return this.fitImagesVertically ? headbreaker.Vertical : headbreaker.Horizontal;
   }
 
   /**
@@ -188,15 +263,25 @@ 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 = this._createCanvas(image);
+    const canvas = this._createCanvas({ image: image });
+    canvas.adjustImagesToPuzzle(this.imageAdjustmentAxis);
     canvas.autogenerate({ horizontalPiecesCount: x, verticalPiecesCount: y });
     this._attachBasicValidator(canvas);
+    canvas.shuffleGrid(0.8);
     this._configCanvas(canvas);
     canvas.onValid(() => {
       setTimeout(() => {
@@ -218,7 +303,7 @@ class MuzzleCanvas {
     const count = imagePaths.length;
     const images = await Promise.all(imagePaths.map(imagePath => this._loadImage(imagePath)));
 
-    const canvas = this._createCanvas(null);
+    const canvas = this._createCanvas();
     canvas.autogenerate({ horizontalPiecesCount: x, verticalPiecesCount: y * count });
 
     // todo validate
@@ -249,17 +334,20 @@ class MuzzleCanvas {
       const leftId = `l${i}`;
       const rightId = `r${i}`;
 
-      pushTemplate(leftUrls[i], {id: leftId, left: true, rightTargetId: rightId});
-      pushTemplate(rightUrls[i], {id: rightId});
+      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}));
-    rightOddUrls.forEach((it, i) => pushTemplate(it, {id: `ro${i}`, odd: true}));
+    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 = this._createCanvas();
+    const canvas = this._createCanvas({ maxPiecesCount: {x: 2, y: leftUrls.length} });
+    canvas.adjustImagesToPiece(this.imageAdjustmentAxis);
     templates.forEach(it => canvas.sketchPiece(it));
+    canvas.shuffleColumns(0.8);
     this._attachMatchValidator(canvas);
     this._configCanvas(canvas);
     return canvas;
@@ -276,19 +364,11 @@ class MuzzleCanvas {
 
   /**
    * @private
-   * @param {HTMLImageElement} image
+   * @param {any} config
    * @return {Canvas}
    */
-  _createCanvas(image = null) {
-    return new headbreaker.Canvas(this.canvasId, this._canvasConfig(image));
-  }
-
-  /**
-   * @private
-   * @param {HTMLImageElement} image
-   */
-  _canvasConfig(image) {
-    return Object.assign({ image }, this.baseConfig);
+  _createCanvas(config = {}) {
+    return new headbreaker.Canvas(this.canvasId, Object.assign(config, this.baseConfig));
   }
 
   /**
@@ -332,37 +412,17 @@ class MuzzleCanvas {
    * @param {object} options
    * @returns {Promise<object>}
    */
-  _createMatchTemplate(imagePath, {id, left = false, rightTargetId = null, odd = false}) {
+  _createMatchTemplate(imagePath, {id, left = false, targetPosition = null, rightTargetId = null, odd = false}) {
     const structure = left ? 'T-N-' : `N-S-`;
 
     return this._loadImage(imagePath).then((image) => {
-      const scale = this._imageScale(image);
-      const offset = this.baseConfig.borderFill / scale;
       return {
         structure,
-        metadata: {
-          id,
-          left,
-          odd,
-          rightTargetId,
-          image: {
-            scale,
-            content: image,
-            offset: { x: offset, y: offset }
-          }
-        }
+        metadata: { id, left, odd, rightTargetId, image, targetPosition }
       }
     });
   }
 
-  /**
-   * @private
-   * @param {HTMLImageElement} image
-   */
-  _imageScale(image) {
-    return this.scaleImageWidthToFit ? this.pieceSize / image.width  : 1;
-  }
-
   /**
    * @private
    * @param {Canvas} canvas
@@ -372,15 +432,86 @@ class MuzzleCanvas {
     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);
+      });
+    });
+  }
+
+  /**
+   * Scales the canvas to the given width and height
+   *
+   * @param {number} width
+   * @param {number} height
+   */
+  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();
+  }
+
+  /**
+   * Focuses the stage around the canvas center
+   */
+  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();
+  }
+
+  /**
+   * @private
+   */
+  get coordinates() {
+    const points = this.canvas.puzzle.points;
+    return [points.map(([x, _y]) => x), points.map(([_x, y]) => y)];
+  }
+
+  /**
+   * @private
+   * @param {number} width
+   * @param {number} height
+   */
+  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();
   }
@@ -406,6 +537,7 @@ class MuzzleCanvas {
    */
   loadSolution(solution) {
     this.canvas.puzzle.relocateTo(solution.positions);
+    this.canvas.puzzle.autoconnect();
   }
 
   /**
@@ -419,11 +551,20 @@ class MuzzleCanvas {
       } catch (e) {
         console.warn("Ignoring unparseabe editor value");
       }
-    } else {
-      this.canvas.shuffle(0.8);
     }
   }
 
+  /**
+   * Translates the pieces so that
+   * they start at canvas' coordinates origin
+   */
+  resetCoordinates() {
+    const [xs, ys] = this.coordinates;
+    const minX = Math.min(...xs);
+    const minY = Math.min(...ys);
+    this.canvas.puzzle.translate(-minX, -minY);
+  }
+
   // ==========
   // Submitting
   // ==========
@@ -470,9 +611,19 @@ const Muzzle = new class extends MuzzleCanvas {
     super();
     this.aux = {};
   }
-  another = (id) => {
+
+  /**
+   * 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;