mumuki-puzzle-runner 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725586c41840661a2deeb9f2cb179b0ca4181e9e7116f72d5a91cc0deaf2ac44
-  data.tar.gz: db8a8081c4f4f13e95300abce70767e2fe54649c98da2f0686c5712634fbf71f
+  metadata.gz: f021b6da535ba17552c88c6e273d6dcd0aab75e02637420d6859864dac6c31d6
+  data.tar.gz: 173cdc9a8f6dbe9b5e83c2c684168db5c2b05c9bbc0c9ae5bce2016c346ffe20
 SHA512:
-  metadata.gz: 98d5444f8a2ad9430ed1bb744770e522225a9295c3b1d1a478767c5bf255cb542e27ddfa1ba7ee2f625dc1536f37fe9850715b30501094649073d02caddb683a
-  data.tar.gz: a69f232d47d551d976d854856b4c40e5be94e8312e0dc2e32db2f8c16321136845fa6aca1565282ed66fe1728f0602142c05452313335fc3e8ba996936eb7016
+  metadata.gz: 3263f1c2fd1398d9d159f714cbc0c38308375cde0620bd22f50c21d08a42e17c584bcfc405db4398cca548e69f8dacabee11071e0ae8b26bc51ea795e93483e9
+  data.tar.gz: 9419c14f400ae387ead448c2a68ec5063d371c00d92e4247c10c5ac366cc5c7a92b82e98d79bac435326be53633e0455596f9f2caa9f6f31deb0e829a9c2e1e1

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

@@ -1,4 +1,52 @@
+
+/*
+ * ============
+ * Initial size
+ * ============
+ */
+
+
 .mu-kids-state-image img {
-  width: 90%;
+  height: 100%;
+  width: auto;
   padding: 30px;
 }
+
+.mu-kids-state.mu-state-initial {
+  width: 100%;
+}
+
+/*
+ * ====================
+ * Submit button hiding
+ * ====================
+ */
+
+.mu-kids-exercise-workspace.muzzle-simple .mu-kids-submit-button {
+  display: none;
+}
+
+/*
+ * ===========
+ * 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 .mu-kids-blocks:after {
+   content: ' ';
+   box-shadow: inset 0 0 30px 30px #FFFFFF;
+   position: absolute;
+   top: 0;
+   left: 0;
+   right: 0;
+   bottom: 0;
+   pointer-events: none;
+}

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

@@ -1,5 +1,6 @@
 // @ts-nocheck
 $(() => {
+
   // ================
   // Muzzle rendering
   // ================
@@ -27,39 +28,55 @@ $(() => {
     getContent() { return { name: "client_result[status]", value: Muzzle.clientResultStatus }; }
   })
 
-  // Requiered to actually bind Muzzle's submit to
+  // Required to actually bind Muzzle's submit to
   // mumuki's solution processing
-  const _onSubmit = Muzzle.onSubmit;
-  Muzzle.onSubmit = (submission) => {
+  Muzzle.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
+  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();
+    const height = ($state.height() - fullMargin) / $image.height();
+    $image.css('transform', 'scale(' + Math.min(width, height) + ')');
   });
+
   mumuki.kids.registerBlocksAreaScaler(($blocks) => {
-    // nothing
-    // no blocks scaling needed
+    console.debug("Scaler fired");
+    const maxHeight = $('.mu-kids-exercise').height() - $('.mu-kids-exercise-description').height();
+    Muzzle.run(() => Muzzle.scale($blocks.width(), Math.min($blocks.height(), maxHeight)));
+  });
+
+  Muzzle.manualScale = true;
+
+  // ====================
+  // Submit button hiding
+  // ====================
+
+  Muzzle.register('onReady', () => {
+    if (Muzzle.simple) {
+      $('.mu-kids-exercise-workspace').addClass('muzzle-simple');
+    }
   });
 
   // ==============
   // Assets loading
   // ==============
 
-  const _onReady = Muzzle.onReady;
-  Muzzle.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
     // to be used without a custom editor
     mumuki.assetsLoadedFor('layout');
-    _onReady();
-  };
+  });
 });

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,
@@ -93,7 +95,7 @@ class MuzzleCanvas {
      *
      * @type {number}
      */
-    this.strokeWidth = 1.5;
+    this.strokeWidth = 3;
 
     /**
      * Piece size
@@ -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,11 +114,26 @@ 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
@@ -134,7 +151,29 @@ 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-simple.
+     *
+     * @type {boolean}
+     */
+    this.simple = null;
+
+    this.spiky = false;
+
+    /**
+     * 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
+     *
+     * @type {Axis}
+     * */
+    this.referenceInsertAxis = null;
 
     /**
      * Callback to be executed when submitting puzzle.
@@ -154,32 +193,81 @@ 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() {
-    const aspectRatio = this.aspectRatio || 1;
-    const pieceSize = headbreaker.vector(this.pieceSize / aspectRatio, this.pieceSize);
-    return {
+    return Object.assign({
+      preventOffstageDrag: true,
       width: this.canvasWidth,
       height: this.canvasHeight,
-      pieceSize: pieceSize,
-      proximity: pieceSize.x / 5,
-      borderFill: this.borderFill === null ? headbreaker.Vector.divide(pieceSize, 10) : this.borderFill,
+      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);
+  }
+
+  /**
+   */
+  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,
+          referenceInsertAxis: this.referenceInsertAxis
+        }),
+      }
+    }
+  }
+
+  /**
+   * The piece size, adjusted to the aspect ratio
+   *
+   * @returns {Vector}
+   */
+  get adjustedPieceSize() {
+    if (!this._adjustedPieceSize) {
+      const aspectRatio = this.effectiveAspectRatio;
+      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;
   }
 
+  /**
+   * 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
@@ -193,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() {
@@ -222,9 +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;
-    }
+    this._config('aspectRatio', y / x);
+    this._config('simple', true);
+    this._config('shuffler', Muzzle.Shuffler.grid);
 
     /**
      * @todo take all container size
@@ -236,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(() => {
@@ -249,52 +336,94 @@ 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 {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 = []) {
+  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 pushTemplate = (config, options) =>
-      templatePromises.push(this._createMatchTemplate(config, options));
+
+    const rightSize = headbreaker.diameter(
+      headbreaker.Vector.multiply(this.adjustedPieceSize, headbreaker.vector(rightWidthRatio, 1)));
+
+    const pushTemplate = (path, options) =>
+      templatePromises.push(this._createMatchTemplate(path, options));
+
+    const pushLeftTemplate = (index, path, options) =>
+      pushTemplate(path, {
+        left: true,
+        targetPosition: headbreaker.Vector.multiply(this.pieceSize, headbreaker.vector(1, index)),
+        ...options
+      });
+
+    const pushRightTemplate = (index, path, options) =>
+      pushTemplate(path, {
+        size: rightSize,
+        targetPosition: headbreaker.Vector.multiply(this.pieceSize, headbreaker.vector(2, index)),
+        ...options
+      });
 
     const last = leftUrls.length - 1;
     for (let i = 0; i <= last; i++) {
       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) }});
+      pushLeftTemplate(i + 1, leftUrls[i], {
+        id: leftId,
+        rightTargetId: rightId
+      });
+      pushRightTemplate(i + 1, rightUrls[i], {
+        id: rightId
+      });
     }
 
-    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) },}));
+    leftOddUrls.forEach((it, i) =>
+      pushLeftTemplate(i + leftUrls.length, it, {
+        id: `lo${i}`,
+        odd: true
+      })
+    );
+    rightOddUrls.forEach((it, i) =>
+      pushRightTemplate(i + rightUrls.length, it, {
+        id: `ro${i}`,
+        odd: true
+      })
+    );
 
     //  + Math.max(leftOddUrls.length, rightOddUrls.length)
     const templates = await Promise.all(templatePromises);
@@ -302,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;
@@ -367,11 +495,11 @@ class MuzzleCanvas {
    * @param {object} options
    * @returns {Promise<object>}
    */
-  _createMatchTemplate(imagePath, {id, left = false, targetPosition = null, rightTargetId = null, odd = false}) {
+  _createMatchTemplate(imagePath, {id, left = false, targetPosition = null, rightTargetId = null, odd = false, size = null}) {
     const structure = left ? 'T-N-' : `N-S-`;
-
     return this._loadImage(imagePath).then((image) => {
       return {
+        ...(size ? {size} : {}),
         structure,
         metadata: { id, left, odd, rightTargetId, image, targetPosition }
       }
@@ -384,25 +512,85 @@ class MuzzleCanvas {
    */
   _configCanvas(canvas) {
     this._canvas = canvas;
+    this._canvas.shuffleWith(0.8, this.shuffler);
     this._canvas.onValid(() => {
       setTimeout(() => this.onValid(), 0);
     });
-    this._setupResponsiveness();
+    this._setUpScaler();
     this.ready();
   }
 
-  _setupResponsiveness() {
-    if (this.fixedDimensions) return;
+  _setUpScaler() {
+    if (this.manualScale) return;
 
     ['resize', 'load'].forEach((event) => {
       window.addEventListener(event, () => {
+        console.debug("Scaler event fired:", event);
         var container = document.getElementById(this.canvasId);
-        this.canvas.resize(container.offsetWidth, container.scrollHeight);
-        this.canvas.redraw();
+        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;
+
+    console.debug("Scaling:", {width, height})
+    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(maxX - minX, maxY - minY);
+    })();
+    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
@@ -410,10 +598,16 @@ class MuzzleCanvas {
    */
   ready() {
     this.loadPreviousSolution();
+    this.resetCoordinates();
     this.draw();
+    this._ready = true;
     this.onReady();
   }
 
+  isReady() {
+    return this._ready;
+  }
+
   // ===========
   // Persistence
   // ===========
@@ -435,6 +629,7 @@ class MuzzleCanvas {
    */
   loadSolution(solution) {
     this.canvas.puzzle.relocateTo(solution.positions);
+    this.canvas.puzzle.autoconnect();
   }
 
   /**
@@ -451,6 +646,17 @@ class MuzzleCanvas {
     }
   }
 
+  /**
+   * 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
   // ==========
@@ -490,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;
   }
 
   /**
@@ -511,3 +763,5 @@ const Muzzle = new class extends MuzzleCanvas {
     return muzzle;
   }
 }
+
+window['Muzzle'] = Muzzle;