mumuki-puzzle-runner 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20cbf33422b40662d79aa0662f45011525a7260454eccfb1f64e5f0a4cdab780
-  data.tar.gz: e84cc1ba0a61dffe0be0ccb9bd26840ff5e9de7dc3b2d1ecff7a9010ac1a36ef
+  metadata.gz: f021b6da535ba17552c88c6e273d6dcd0aab75e02637420d6859864dac6c31d6
+  data.tar.gz: 173cdc9a8f6dbe9b5e83c2c684168db5c2b05c9bbc0c9ae5bce2016c346ffe20
 SHA512:
-  metadata.gz: ac96c26344814c63d596c1cb012781b18799eb683603ec738beea160ace4e677dd650926cd2720a3e4fb85e712d19a432137040233be99a7a69534823c82d655
-  data.tar.gz: c56d817d8240de55674cad90192c59f823da755ce9d3eabdf8a4f373cf84be5c22b1e15fdad64c1c5ff0f40770d9102c11fcd65674621910a07bbdccd95ed065
+  metadata.gz: 3263f1c2fd1398d9d159f714cbc0c38308375cde0620bd22f50c21d08a42e17c584bcfc405db4398cca548e69f8dacabee11071e0ae8b26bc51ea795e93483e9
+  data.tar.gz: 9419c14f400ae387ead448c2a68ec5063d371c00d92e4247c10c5ac366cc5c7a92b82e98d79bac435326be53633e0455596f9f2caa9f6f31deb0e829a9c2e1e1

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

@@ -1,3 +1,11 @@
+
+/*
+ * ============
+ * Initial size
+ * ============
+ */
+
+
 .mu-kids-state-image img {
   height: 100%;
   width: auto;
@@ -8,15 +16,31 @@
   width: 100%;
 }
 
+/*
+ * ====================
+ * Submit button hiding
+ * ====================
+ */
+
 .mu-kids-exercise-workspace.muzzle-simple .mu-kids-submit-button {
   display: none;
 }
 
-.mu-kids-exercise-workspace.muzzle-simple .mu-kids-blocks {
+/*
+ * ===========
+ * Blur effect
+ * ===========
+ */
+
+.mu-kids-exercise-workspace.mu-full-workspace .mu-kids-submit-button {
+  margin: 0 30px 30px;
+}
+
+.mu-kids-exercise-workspace .mu-kids-blocks {
   overflow: hidden;
 }
 
-.mu-kids-exercise-workspace.muzzle-simple .mu-kids-blocks:after {
+.mu-kids-exercise-workspace .mu-kids-blocks:after {
    content: ' ';
    box-shadow: inset 0 0 30px 30px #FFFFFF;
    position: absolute;
@@ -25,4 +49,4 @@
    right: 0;
    bottom: 0;
    pointer-events: none;
- }
+}

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

@@ -1,12 +1,5 @@
 // @ts-nocheck
 $(() => {
-  function register(event, callback) {
-    const _event = Muzzle[event];
-    Muzzle[event] = (...args) => {
-      callback(...args);
-      _event(...args);
-    }
-  }
 
   // ================
   // Muzzle rendering
@@ -37,7 +30,7 @@ $(() => {
 
   // Required to actually bind Muzzle's submit to
   // mumuki's solution processing
-  register('onSubmit', (submission) => {
+  Muzzle.register('onSubmit', (submission) => {
     mumuki.submission.processSolution(submission);
   });
 
@@ -47,6 +40,7 @@ $(() => {
 
   mumuki.kids.registerStateScaler(($state, fullMargin) => {
     const $image = $state.find('img');
+    if (!$image.length) return;
 
     $image.css('transform', 'scale(1)');
     const width = ($state.width() - fullMargin) / $image.width();
@@ -55,8 +49,9 @@ $(() => {
   });
 
   mumuki.kids.registerBlocksAreaScaler(($blocks) => {
+    console.debug("Scaler fired");
     const maxHeight = $('.mu-kids-exercise').height() - $('.mu-kids-exercise-description').height();
-    Muzzle.scale($blocks.width(), Math.min($blocks.height(), maxHeight));
+    Muzzle.run(() => Muzzle.scale($blocks.width(), Math.min($blocks.height(), maxHeight)));
   });
 
   Muzzle.manualScale = true;
@@ -65,7 +60,7 @@ $(() => {
   // Submit button hiding
   // ====================
 
-  register('onReady', () => {
+  Muzzle.register('onReady', () => {
     if (Muzzle.simple) {
       $('.mu-kids-exercise-workspace').addClass('muzzle-simple');
     }
@@ -75,7 +70,9 @@ $(() => {
   // Assets loading
   // ==============
 
-  register('onReady', () => {
+  Muzzle.register('onReady', () => {
+    console.debug("Muzzle is ready");
+
     mumuki.assetsLoadedFor('editor');
     // although layout assets
     // are actually loaded before this script, puzzle runner is not aimed

data/lib/public/js/muzzle.js

@@ -1,9 +1,3 @@
-/**
- * @typedef {object} PieceConfig
- * @property {string} imagePath
- * @property {string} structure
- */
-
 /**
  * @typedef {number[]} Point
  */
@@ -14,6 +8,14 @@
  */
 
 
+class MuzzlePainter extends headbreaker.painters.Konva {
+  _newLine(options) {
+
+    const line = super._newLine(options);
+    line.strokeScaleEnabled(false);
+    return line;
+  }
+}
 
 /**
  * Facade for referencing and creating a global puzzle canvas,
@@ -103,7 +105,7 @@ class MuzzleCanvas {
     this.pieceSize = 100;
 
     /**
-     * The x:y aspect ratio of the piece. Set null for automatic
+     * The `x:y` aspect ratio of the piece. Set null for automatic
      * aspectRatio
      *
      * @type {number}
@@ -112,14 +114,27 @@ class MuzzleCanvas {
 
     /**
      * If the images should be adjusted vertically instead of horizontally
-     * to puzzle dimensions. `false` by default
+     * to puzzle dimensions.
+     *
+     * Set null for automatic fit.
      *
      * @type {boolean}
      */
-    this.fitImagesVertically = false;
+    this.fitImagesVertically = null;
 
+    /**
+     * Wether the scaling should ignore the scaler
+     * rise events
+     */
     this.manualScale = false;
 
+    /**
+     * The canvas shuffler.
+     *
+     * Set it null to automatic shuffling algorithm selection.
+     */
+    this.shuffler = null;
+
     /**
      * Callback that will be executed
      * when muzzle has fully loaded and rendered its first
@@ -142,7 +157,7 @@ class MuzzleCanvas {
      * 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.
+     * basic and match puzzles will be considered non-simple.
      *
      * @type {boolean}
      */
@@ -152,6 +167,7 @@ class MuzzleCanvas {
 
     /**
      * The reference insert axis, used at rounded outline to compute insert internal and external diameters
+     *
      * Set null for default computation of axis - no axis reference for basic boards
      * and vertical axis for match
      *
@@ -177,20 +193,29 @@ class MuzzleCanvas {
      * property with any code you need the be called here
      */
     this.onValid = () => {};
-  }
 
+    /**
+     * @private
+     */
+    this._ready = false;
+  }
 
+  get painter() {
+    return new MuzzlePainter();
+  }
 
   /**
    */
   get baseConfig() {
     return Object.assign({
+      preventOffstageDrag: true,
       width: this.canvasWidth,
       height: this.canvasHeight,
       pieceSize: this.adjustedPieceSize,
       proximity: Math.min(this.adjustedPieceSize.x, this.adjustedPieceSize.y) / 5,
       strokeWidth: this.strokeWidth,
-      lineSoftness: 0.18
+      lineSoftness: 0.18,
+      painter: this.painter
     }, this.outlineConfig);
   }
 
@@ -221,8 +246,8 @@ class MuzzleCanvas {
    */
   get adjustedPieceSize() {
     if (!this._adjustedPieceSize) {
-      const aspectRatio = this.aspectRatio || 1;
-      this._adjustedPieceSize = headbreaker.vector(this.pieceSize / aspectRatio, this.pieceSize);
+      const aspectRatio = this.effectiveAspectRatio;
+      this._adjustedPieceSize = headbreaker.vector(this.pieceSize * aspectRatio, this.pieceSize);
     }
     return this._adjustedPieceSize;
   }
@@ -234,6 +259,15 @@ class MuzzleCanvas {
     return this.fitImagesVertically ? headbreaker.Vertical : headbreaker.Horizontal;
   }
 
+  /**
+   * The configured aspect ratio, or 1
+   *
+   * @type {number}
+   */
+  get effectiveAspectRatio() {
+    return this.aspectRatio || 1;
+  }
+
   /**
    * The currently active canvas, or null if
    * it has not yet initialized
@@ -247,7 +281,7 @@ class MuzzleCanvas {
   /**
    * Draws the - previusly built - current canvas.
    *
-   * Prefer {@code this.currentCanvas.redraw()} when performing
+   * Prefer `this.currentCanvas.redraw()` when performing
    * small updates to the pieces.
    */
   draw() {
@@ -276,13 +310,9 @@ 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;
-    }
+    this._config('aspectRatio', y / x);
+    this._config('simple', true);
+    this._config('shuffler', Muzzle.Shuffler.grid);
 
     /**
      * @todo take all container size
@@ -294,7 +324,6 @@ class MuzzleCanvas {
     canvas.adjustImagesToPuzzle(this.imageAdjustmentAxis);
     canvas.autogenerate({ horizontalPiecesCount: x, verticalPiecesCount: y });
     this._attachBasicValidator(canvas);
-    canvas.shuffleGrid(0.8);
     this._configCanvas(canvas);
     canvas.onValid(() => {
       setTimeout(() => {
@@ -307,45 +336,50 @@ class MuzzleCanvas {
   }
 
   /**
-   * @param {number} x
-   * @param {number} y
-   * @param {string[]} [imagePaths]
+   * Creates a choose puzzle, where a single right piece must match the single left piece,
+   * choosing the latter from a bunch of other left odd pieces. By default, `Muzzle.Shuffler.line` shuffling is used.
+   *
+   * This is a particular case of a match puzzle with line
+   *
+   * @param {string} leftUrl the url of the left piece
+   * @param {string} rightUrl the url of the right piece
+   * @param {string[]} leftOddUrls the urls of the off left urls
+   * @param {number} [rightAspectRatio] the `x:y` ratio of the right pieces, that override the general `aspectRatio` of the puzzle.
+   *                                    Use null to have the same aspect ratio as left pieces
+   *
    * @returns {Promise<Canvas>} the promise of the built canvas
    */
-  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;
+  async choose(leftUrl, rightUrl, leftOddUrls, rightAspectRatio = null) {
+    this._config('shuffler', Muzzle.Shuffler.line);
+    return this.match([leftUrl], [rightUrl], {leftOddUrls, rightAspectRatio});
   }
 
   /**
-   * Craates a match puzzle, where left pieces are matched against right pieces,
-   * with optional odd left and right pieces that don't match
+   * Creates a match puzzle, where left pieces are matched against right pieces,
+   * with optional odd left and right pieces that don't match. By default, `Muzzle.Shuffler.columns`
+   * shuffling is used.
    *
    * @param {string[]} leftUrls
    * @param {string[]} rightUrls must be of the same size of lefts
-   * @param {string[]} leftOddUrls
-   * @param {string[]} rightOddUrls
-   * @param {number?} rightWidthRatio a multiplicator to apply to the right piece's width
+   * @param {object} [options]
+   * @param {string[]} [options.leftOddUrls]
+   * @param {string[]} [options.rightOddUrls]
+   * @param {number?} [options.rightAspectRatio] the aspect ratio of the right pieces. Use null to have the same aspect ratio as left pieces
    * @returns {Promise<Canvas>} the promise of the built canvas
    */
-  async match(leftUrls, rightUrls, leftOddUrls = [], rightOddUrls = [], rightWidthRatio = 1) {
-    if (!this.referenceInsertAxis) {
-      this.referenceInsertAxis = headbreaker.Vertical;
-    }
+  async match(leftUrls, rightUrls, {leftOddUrls = [], rightOddUrls = [], rightAspectRatio = this.effectiveAspectRatio} = {}) {
+    const rightWidthRatio = rightAspectRatio / this.effectiveAspectRatio;
+
+    this._config('simple', false);
+    this._config('shuffler', Muzzle.Shuffler.columns);
+    this._config('fitImagesVertically', rightWidthRatio > 1);
+    this._config('referenceInsertAxis', headbreaker.Vertical);
 
     /** @private @type {(Promise<Template>)[]} */
     const templatePromises = [];
 
-    const rightSize = headbreaker.diameter(headbreaker.Vector.multiply(this.adjustedPieceSize, headbreaker.vector(rightWidthRatio, 1)));
+    const rightSize = headbreaker.diameter(
+      headbreaker.Vector.multiply(this.adjustedPieceSize, headbreaker.vector(rightWidthRatio, 1)));
 
     const pushTemplate = (path, options) =>
       templatePromises.push(this._createMatchTemplate(path, options));
@@ -397,7 +431,6 @@ class MuzzleCanvas {
     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;
@@ -479,6 +512,7 @@ class MuzzleCanvas {
    */
   _configCanvas(canvas) {
     this._canvas = canvas;
+    this._canvas.shuffleWith(0.8, this.shuffler);
     this._canvas.onValid(() => {
       setTimeout(() => this.onValid(), 0);
     });
@@ -491,6 +525,7 @@ class MuzzleCanvas {
 
     ['resize', 'load'].forEach((event) => {
       window.addEventListener(event, () => {
+        console.debug("Scaler event fired:", event);
         var container = document.getElementById(this.canvasId);
         this.scale(container.offsetWidth, container.scrollHeight);
       });
@@ -505,6 +540,8 @@ class MuzzleCanvas {
    */
   scale(width, height) {
     if (this.fixedDimensions || !this.canvas) return;
+
+    console.debug("Scaling:", {width, height})
     const factor = this.optimalScaleFactor(width, height);
     this.canvas.resize(width, height);
     this.canvas.scale(factor);
@@ -528,7 +565,7 @@ class MuzzleCanvas {
       const maxX = Math.max(...xs);
       const maxY = Math.max(...ys);
 
-      return headbreaker.Vector.plus(headbreaker.vector(maxX - minX, maxY - minY), this.canvas.puzzle.pieceDiameter);
+      return headbreaker.vector(maxX - minX, maxY - minY);
     })();
     const diff = headbreaker.Vector.minus(area, realDiameter);
     const semi = headbreaker.Vector.divide(diff, -2);
@@ -563,9 +600,14 @@ class MuzzleCanvas {
     this.loadPreviousSolution();
     this.resetCoordinates();
     this.draw();
+    this._ready = true;
     this.onReady();
   }
 
+  isReady() {
+    return this._ready;
+  }
+
   // ===========
   // Persistence
   // ===========
@@ -654,12 +696,58 @@ class MuzzleCanvas {
     };
   }
 
+  /**
+   * @param {string} key
+   * @param {any} value
+   */
+  _config(key, value) {
+    const current = this[key];
+    console.debug("Setting config: ", [key, value])
+
+    if (current === null) {
+      this[key] = value;
+    }
+  }
+
+  // ==============
+  // Event handling
+  // ==============
+
+
+  /**
+   * Registers an event handler
+   *
+   * @param {string} event
+   * @param {(...args: any) => void} callback
+   */
+  register(event, callback) {
+    const _event = this[event];
+    this[event] = (...args) => {
+      callback(...args);
+      _event(...args);
+    }
+  }
+
+  /**
+   * Runs the given action if muzzle is ready,
+   * queueing it otherwise
+   * @param {() => void} callback
+   */
+  run(callback) {
+    if (this.isReady()) {
+      callback();
+    } else {
+      this.register('onReady', callback);
+    }
+  }
 }
 
 const Muzzle = new class extends MuzzleCanvas {
   constructor() {
     super();
     this.aux = {};
+
+    this.Shuffler = headbreaker.Shuffler;
   }
 
   /**