redmine_extensions 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfaa9aa76c5f09acfc9163785c65c267e5500ca0
-  data.tar.gz: fc9a9fb9fad18b78326cfee660a7d144bbc70c5a
+  metadata.gz: 80de0c2943007be3336e1a07b280a51ce0f26738
+  data.tar.gz: a5f3b74b3f06ff90aa22ea3e7f3780aaa2926224
 SHA512:
-  metadata.gz: a78db6122d709924533f68e8da5ae3ca8612385f0478fb41dd101a9a1e16e5bb2de33917aff69e504b36be1d1d56c6dc07d26d91f84948a3582966cd12b58d8b
-  data.tar.gz: 2b75967a1eed06e4ce7ed3da83c2b626937813a6813e2218bd5505569d481815c60ba0ee9faf3dd02f363ae019bc2f487dd8f7bdacdd83d69bbebfc760fcf29a
+  metadata.gz: 11e228ee7c6304db152af464882c1da6f07e016206024295d964efabc79c0ab9c7571ea201154aabaa1c623001154a29157d9b5811b0393ac06e6fd0c5f0a379
+  data.tar.gz: 9d7bffff1fb3dec3c63ba5892c18936b00376c6cb904626f9f6fb4e8c4ba2994a81bff5a11ed88b434bddb73dbd5a3b8842f11477624215ceb42ddbdf39cd8a4

data/app/assets/javascripts/redmine_extensions/blocking_render.js

@@ -15,6 +15,14 @@
   var renderPhase = false;
   var lastTime = 0.0;
   /**
+   * Wrapper for safe execution of [body] function only in read phase to prevent force-redraws.
+   * @example
+   * // fill storage with values from DOM
+   * var storage = {};
+   * EasyGem.read(function(){
+   *   this.offset = $element.offset();
+   *   this.scrollTop = $(window).scrollTop();
+   * }, storage);
    * @param {RenderFunction} body
    * @param {Object} [context]
    */
@@ -26,7 +34,13 @@
     }
   };
   /**
-   * @param {RenderFunction} body
+   * Wrapper for safe execution of [body] function only in render phase to prevent force-redraws.
+   * @example
+   * var left = $element.css("left");
+   * EasyGem.render(function(){
+   *   $element.css({left: (left + 5) + "px"});
+   * });
+   * @param {RenderFunction} body - obtain execution time as first parameter
    * @param {Object} [context]
    */
   EasyGem.render = function (body, context) {
@@ -37,8 +51,19 @@
     }
   };
   /**
+   * Complex and most-safe wrapper for DOM-manipulation code
+   * Execute [read] and [render] function only in proper phases.
+   * @example
+   * // prevents layout thrashing
+   * $table.find("td.first_column").each(function() {
+   *   EasyGem.readAndRender(function() {
+   *     return this.width();
+   *   }, function(width, time) {
+   *     this.next().width(width);
+   *   }, $(this));
+   * });
    * @param {RenderFunction} read
-   * @param {RenderFunction} render
+   * @param {RenderFunction} render - function(readResult, time) callback
    * @param {Object} [context]
    */
   EasyGem.readAndRender = function (read, render, context) {
@@ -75,7 +100,7 @@
         renderQueue = [];
         for (var i = 0; i < queue.length; i++) {
           var pack = queue[i];
-          pack.body.call(pack.ctx, time, pack.value);
+          pack.body.call(pack.ctx, pack.value, time);
         }
         renderQueue = [];
       }

data/app/assets/javascripts/redmine_extensions/blocking_schedule.js

@@ -14,6 +14,10 @@
   var lateArray = [];
   /** @type {Array.<?ScheduleTask>} */
   var prerequisiteArray = [];
+  /**
+   * Predefined getters for [require] function. Just specify the name of the module
+   * @type {{jquery: jquery, jqueryui: jqueryui, c3: c3, ckeditor: ckeditor}}
+   */
   var moduleGetters = {
     jquery: function () {
       return window.jQuery;
@@ -21,10 +25,10 @@
     jqueryui: function () {
       return window.jQuery && jQuery.Widget;
     },
-    c3:function () {
+    c3: function () {
       return window.c3;
     },
-    ckeditor:function () {
+    ckeditor: function () {
       return window.CKEDITOR;
     }
   };
@@ -82,7 +86,7 @@
     if (prerequisiteArray.length === 0) return 0;
     var count = 0;
     for (var i = 0; i < prerequisiteArray.length; i++) {
-      if(executeOnePrerequisite(prerequisiteArray[i])) {
+      if (executeOnePrerequisite(prerequisiteArray[i])) {
         count++;
         prerequisiteArray[i] = null;
       }
@@ -148,9 +152,10 @@
    */
   EasyGem.schedule = {
     /**
-     * Functions, which should be executed right after "DOMContentLoaded" event
+     * Functions, which should be executed right after "DOMContentLoaded" event.
      * @param {Function} func
-     * @param {number} [priority]
+     * @param {number} [priority=0] - Greater the priority, sooner [func] are called. Each 5 priority delays execution
+     *                              by 30ms. Also negative values are accepted.
      */
     main: function (func, priority) {
       mainArray.push({func: func, priority: priority || 0})
@@ -158,8 +163,19 @@
     /**
      * Functions, which should wait for [prerequisite] fulfillment
      * After that [func] is executed with return value of [prerequisite] as parameter
-     * @param {Function} func
-     * @param {...(SchedulePrerequisite|string)} prerequisite
+     * @example
+     * // execute function after jQuery and window.logger are present
+     * EasyGem.schedule.require(function($,logger){
+     *   logger.log($.fn.jquery);
+     * },'jQuery',function(){
+     *   return window.logger;
+     * });
+     * @param {Function} func - function which will be called when all prerequisites are met. Results of prerequisites
+     *                          are send into [func] as parameters
+     * @param {...(SchedulePrerequisite|string)} prerequisite - more than one prerequisite can be specified here
+     *                                           as rest parameters. Function or String are accepted. If String is used,
+     *                                           predefined getter from [moduleGetters] or getter defined by [define]
+     *                                           are called.
      */
     require: function (func, prerequisite) {
       if (arguments.length > 2) {
@@ -186,19 +202,27 @@
       }
     },
     /**
-     * Functions, which should be executed after several render loops after "DOMContentLoaded" event
-     * each 5 levels of priority increase delay by one stack
+     * Functions, which should be executed after several loops after "DOMContentLoaded" event.
+     * Each 5 levels of priority increase delay by one stack.
      * @param {Function} func
-     * @param {number} [priority]
+     * @param {number} [priority=0]
      */
     late: function (func, priority) {
       lateArray.push({func: func, priority: priority || 0})
     },
     /**
-     * Define module, which will be loaded by [require] function with [name] argument
-     * Only one instance will be created
+     * Define module, which will be loaded by [require] function with [name] prerequisite
+     * Only one instance will be created and cached also for future use.
+     * If no one request the module, getter is never called.
+     * @example
+     * EasyGem.schedule.define('Counter', function () {
+     *   var count = 0;
+     *   return function () {
+     *     console.log("Count: " + count++);
+     *   }
+     * });
      * @param {string} name
-     * @param {Function} getter
+     * @param {Function} getter - getter or constructor
      */
     define: function (name, getter) {
       moduleGetters[name.toLocaleLowerCase()] = getter;

data/app/assets/javascripts/redmine_extensions/blocking_utils.js

@@ -1,3 +1,10 @@
+/**
+ * Duplication of $.extend(), so whole jQuery dont have to be loaded
+ * @param {boolean|Object} deep
+ * @param {Object} target
+ * @param {Object} [source]
+ * @return {Object}
+ */
 EasyGem.extend = function (deep, target, source) {
   var copyIsArray;
   if (typeof deep !== "boolean") {
@@ -5,7 +12,7 @@ EasyGem.extend = function (deep, target, source) {
     target = deep;
     deep = false;
   }
-  if (!source) return;
+  if (source === undefined) return target;
   if (typeof target !== "object") {
     target = {};
   }
@@ -16,19 +23,18 @@ EasyGem.extend = function (deep, target, source) {
 
     // Prevent never-ending loop
     if (trg === src) continue;
-    if (deep && src && (typeof src === "object" ||
-            (copyIsArray = Array.isArray(src)))) {
-
+    if (deep && src && typeof src === "object") {
+      copyIsArray = Array.isArray(src);
       if (copyIsArray) {
         copyIsArray = false;
         var clone = trg && Array.isArray(trg) ? trg : [];
 
       } else {
-        clone = trg && (typeof src === "object") ? trg : {};
+        clone = trg && (typeof trg === "object") ? trg : {};
       }
 
       // Never move original objects, clone them
-      target[name] = EASY.extend(deep, trg, src);
+      target[name] = EasyGem.extend(deep, clone, src);
 
       // Don't bring in undefined values
     } else if (src !== undefined) {
@@ -37,4 +43,4 @@ EasyGem.extend = function (deep, target, source) {
   }
   return target;
 };
-EASY.extend = EasyGem.extend;
+EASY.extend = EasyGem.extend;

data/app/assets/javascripts/redmine_extensions/dynamic_loading.js

@@ -1,11 +1,31 @@
 EasyGem.dynamic = {
+  _alreadyLoaded: {},
+  /**
+   * Append Javascript <script> tag to page
+   * @example
+   * EasyGem.dynamic.jsTag("/plugin_assets/my_plugin/javascripts/counter.js");
+   * EasyGem.schedule.require(function(counter){
+   *   setInterval(counter.count(), 1000);
+   * }, function(){
+   *   return window.utils.counter;
+   * })
+   * @param {String} src - absolute path to requested file
+   */
   jsTag: function (src) {
+    if (this._alreadyLoaded[src]) return;
+    this._alreadyLoaded[src] = true;
     var jsScript = document.createElement("script");
     jsScript.setAttribute("src", src);
     jsScript.setAttribute("defer", "true");
     document.head.appendChild(jsScript);
   },
+  /**
+   * Append CSS <link> tag to page
+   * @param {String} src - absolute path to requested file
+   */
   cssTag: function (src) {
+    if (this._alreadyLoaded[src]) return;
+    this._alreadyLoaded[src] = true;
     var link = document.createElement('link');
     link.rel = "stylesheet";
     link.type = "text/css";
@@ -13,14 +33,22 @@ EasyGem.dynamic = {
     link.media = "all";
     document.head.appendChild(link);
   },
-  jsTags: function (array, plugin) {
+  /**
+   * Load multiple JS files into page
+   * @param {Array.<String>} array
+   */
+  jsTags: function (array) {
     for (var i = 0; i < array.length; i++) {
-      this.jsTag(array[i], plugin);
+      this.jsTag(array[i]);
     }
   },
-  cssTags: function (array, plugin) {
+  /**
+   * Load multiple CSS files into page
+   * @param {Array.<String>} array
+   */
+  cssTags: function (array) {
     for (var i = 0; i < array.length; i++) {
-      this.cssTag(array[i], plugin);
+      this.cssTag(array[i]);
     }
   }
 };

data/lib/redmine_extensions/version.rb

@@ -1,3 +1,3 @@
 module RedmineExtensions
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_extensions
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Easy Software Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails