redmine_extensions 0.2.14 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8b3425eda3edb8bd43328e8e60e35efa3ba60e81
-  data.tar.gz: acfa3a5fb739bca124209fc00e262159a61f0b8a
+SHA256:
+  metadata.gz: 5d23088d3d0f1dbefea12bcd0ded9bf06067c34f50e3bd4cadd8407e49ca0cfa
+  data.tar.gz: ce1030a05900dd45a6fe3afc959e819ccc5e45bda9ed8f65654dab561140994e
 SHA512:
-  metadata.gz: fcec4043c01a6378f2a57d3d252e6e9c340d608105947fd434072bb6281d3aab0edeb0679fae766ca065529c8204cd3a9465ac3a66989e82b631e9cb50a741b3
-  data.tar.gz: 8588f3ee85ec4a1bb91f355aa674281ec5792b945eab0ad28fcac6f48de7688712e29e211a0b74b99cc32e4983ec873c338e1f0d22963f1556147a4309d57e13
+  metadata.gz: ecf1c291b5c5ecbf2c4ece57696995494850a80029c4bb5c3b6c34086eb3a2ffa7afc765ec648a45859005ca916655ed7830e95d079a9e5bf9faee5cc401fb0a
+  data.tar.gz: af331f12bb00531e093a689feded32e1e825a1967404638bfa6e8815851016b94b29c4f257094ea45a0a4ec4c6493fa6a2ccda5ddf2cf39b9b31851b4d9f5308

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

@@ -4,12 +4,31 @@
   var moduleInstances = {};
   /** @type {Object.<String,EasyModule>} */
   var moduleDefinitions = {};
-  /** @type {Array.<Waiter>} */
+  /** @type {Array.<OptionWaiter|CallbackWaiter>} */
   var waiters = [];
   /** @type {Object.<String,String>} */
   var urls = {};
 
-  function Waiter(dependencies, callback) {
+  /**
+   * @param {Array.<String>} dependencies
+   * @param {Array} options
+   * @property {Array} options
+   * @property {Array.<String>} dependencies
+   * @constructor
+   */
+  function OptionWaiter(dependencies, options) {
+    this.dependencies = dependencies;
+    this.options = options;
+  }
+
+  /**
+   * @param {Array.<String>} dependencies
+   * @param {Function} callback
+   * @property {Function} callback
+   * @property {Array.<String>} dependencies
+   * @constructor
+   */
+  function CallbackWaiter(dependencies, callback) {
     this.dependencies = dependencies;
     this.callback = callback;
   }
@@ -17,7 +36,7 @@
   /**
    * @property {String} name
    * @property {Array.<String>} dependencies
-   * @property {Array.<Waiter>} waiters
+   * @property {Array.<CallbackWaiter>} waiters
    * @constructor
    */
   function EasyModule(moduleName) {
@@ -35,6 +54,7 @@
     var instance = {};
     var waiters = this.waiters;
     for (var i = 0; i < waiters.length; i++) {
+      /** @type {CallbackWaiter} */
       var waiter = waiters[i];
       var instances = waiter.dependencies.map(function (moduleName) {
         return moduleInstances[moduleName];
@@ -67,7 +87,15 @@
     var instances = waiter.dependencies.map(function (moduleName) {
       return moduleInstances[moduleName];
     });
-    waiter.callback.apply(window, instances);
+    if (waiter.callback) {
+      waiter.callback.apply(window, instances);
+    } else {
+      instances.forEach(function (instance) {
+        if (instance.call) {
+          instance.apply(window, waiter.options);
+        }
+      });
+    }
   }
 
   function executeWaiters() {
@@ -116,6 +144,24 @@
     }
   }
 
+  /**
+   * @param {Array.<String>} moduleNames
+   * @param {Array} options
+   */
+  function prepareModuleOrder(moduleNames, options) {
+    if (options.length === 1 && options[0].call) {
+      var waiter = new CallbackWaiter(moduleNames, options[0]);
+    } else {
+      waiter = new OptionWaiter(moduleNames, options);
+    }
+    if (checkDependencies(moduleNames)) {
+      executeWaiter(waiter);
+    } else {
+      waiters.push(waiter);
+      setTimeout(findMissingModules, 5000);
+    }
+  }
+
   /**
    *
    * @type {{urls: Object<String, String>, module: EasyGem.module.module, part: EasyGem.module.part, transform: EasyGem.module.transform, setUrl: EasyGem.module.setUrl}}
@@ -132,7 +178,11 @@
     urls: urls,
     /**
      * Define module in one separate file. Use this method as first line of the file
+     * Modules can be constructed by returning a function (simple one-method modules),
+     *   returning Object (complex, but one-file modules)
+     *   or by directly setting methods or properties with [this], because context is set to newly created module.
      * Module can be downloaded on-demand by loadModules() if url is provided by setUrl() function.
+     * [prerequisites] argument can be omitted if no prerequisites are required
      * @example
      *   EasyGem.module.module("myModule", ["jQuery", "c3"], function($, c3) {
      *     return {
@@ -141,18 +191,29 @@
      *       }
      *     }
      *   }
+     * @example - same as above but simpler
+     *   EasyGem.module.module("myModule", ["jQuery", "c3"], function($, c3) {
+     *     this.init = function(){
+     *       c3.init($("#graph"));
+     *     }
+     *   }
      * @param {String} moduleName
-     * @param {Array.<String>} prerequisites - other modules needed for construction of module
-     * @param {Function} getter - factory function
+     * @param {Array.<String>|Function} prerequisites - other modules needed for construction of module, can be omitted
+     * @param {Function} [getter] - factory function
      */
     module: function (moduleName, prerequisites, getter) {
       var module = moduleDefinitions[moduleName] = new EasyModule(moduleName);
+      if (getter === undefined) {
+        getter = prerequisites;
+        prerequisites = [];
+      }
       module.dependencies = prerequisites;
-      module.waiters = [new Waiter(prerequisites, getter)];
+      module.waiters = [new CallbackWaiter(prerequisites, getter)];
     },
     /**
      * Define module part if module code is distributed into many separate files.
      *   For dynamic loading by url, all files have to be combine by pipeline into one.
+     * You can append methods to module, just use [this].
      * Module is executed only if all [prerequisites] from all parts of the module is fulfilled, but only part's
      *   [prerequisites] will be used as arguments for [getter].
      * [prerequisites] argument can be omitted if no prerequisites are required
@@ -166,12 +227,12 @@
         prerequisites = [];
       }
       var module = moduleDefinitions[moduleName];
-      if (!module){
+      if (!module) {
         module = moduleDefinitions[moduleName] = new EasyModule(moduleName);
         module.waiters = [];
         module.dependencies = [];
       }
-      module.waiters.push(new Waiter(prerequisites, getter));
+      module.waiters.push(new CallbackWaiter(prerequisites, getter));
       for (var i = 0; i < prerequisites.length; i++) {
         var prerequisite = prerequisites[i];
         if (module.dependencies.indexOf(prerequisite) === -1) {
@@ -210,35 +271,44 @@
     }
   };
   /**
-   * Load specified modules and execute [callback].
-   * Module instances are constructed if not constructed before.
-   * Missing modules are downloaded if url is provided.
+   * Load [moduleNames] modules and do something afterward.
+   * Try to download the modules if url is provided by EasyGem.module.setUrl() or EasyGem.module.urls=.
+   * Downloaded (or already registered) modules are constructed and result is stored for further invocation of the module.
+   * There are two types of action after all module results are obtained.
+   * If [options] is only one function, this function is executed with the module results as the arguments.
+   * Otherwise, the module results, which are functions, are executed with [options] as the arguments.
+   * Error is thrown if any module hasn't been constructed in 5 seconds
    * @param {Array.<String>} moduleNames
-   * @param {Function} callback - function with module instances as arguments
+   * @param {...*} options - options for module function OR function with module instances as arguments
    * @example
+   *   // suitable for smaller modules with one method
+   *   EasyGem.module.module("colorizeBackground", function() {
+   *     return function(element, color) {
+   *       element.style.backgroundColor = color;
+   *     }
+   *   });
+   *   EasyGem.loadModules(["colorizeBackground"], document.getElementById("my_button"), "red");
+   * @example
+   *   // suitable for modules with many methods
    *   EasyGem.loadModules(["jQuery", "myModule"], function($, myModule) {
    *     myModule.init($("#my_module_container"));
    *   });
    */
-  EasyGem.loadModules = function (moduleNames, callback) {
-    var waiter = new Waiter(moduleNames, callback);
-    if (checkDependencies(moduleNames)) {
-      executeWaiter(waiter);
-    } else {
-      waiters.push(waiter);
-      setTimeout(findMissingModules, 5000);
-    }
+  EasyGem.loadModules = function (moduleNames, options) {
+    options = Array.prototype.slice.call(arguments, 1);
+    prepareModuleOrder(moduleNames, options);
   };
   /**
    * Same as EasyGem.loadModules, but only for one module.
    * @param {String} moduleName
-   * @param {Function} callback - function with the module instance as first argument
+   * @param {...*} options - options for module function OR function with module instances as arguments
    */
-  EasyGem.loadModule = function (moduleName, callback) {
-    this.loadModules([moduleName], callback);
+  EasyGem.loadModule = function (moduleName, options) {
+    options = Array.prototype.slice.call(arguments, 1);
+    prepareModuleOrder([moduleName], options);
   };
   var transform = EasyGem.module.transform;
   transform("jQuery", "jQuery");
   transform("jQueryUI", "jQueryUI");
 
-})();
+})();

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

@@ -1,4 +1,4 @@
-var EasyToggler = new function() {
+window.EasyToggler = new function() {
   // EasyToggler storage store object where key is ID of container and value is 0 - for hidden default state or 1 - for shown default state
   // Example:
   // localStorage # => {"easy-toggle-state": {myDiv: 0, history: 1}} # where myDiv is by default hidden, and now will be shown as visible and history is vice versa

data/app/assets/javascripts/redmine_extensions/jasmine_lib/jasmine_helper.js

@@ -99,8 +99,7 @@
   var data = {
     _locks: [],
     _timeout: null,
-    tags: {},
-    topMenuHeight: 60
+    tags: {}
   };
   var start = function () {
     if (new Date() - data._timeout > 5000) {
@@ -230,12 +229,8 @@
         element = element[0];
       }
       if (!element) throw new Error("missing element");
-      element.scrollIntoView();
+      element.scrollIntoView({block: "center", behavior: "instant"});
       var box = element.getBoundingClientRect();
-      if (box.top < data.topMenuHeight) {
-        window.scrollBy({top: -data.topMenuHeight});
-        box = element.getBoundingClientRect();
-      }
       var pointX = (box.left + box.right) / 2;
       var pointY = (box.top + box.bottom) / 2;
       var target = document.elementFromPoint(pointX, pointY);

data/app/assets/javascripts/redmine_extensions/jasmine_tests/modules.js

@@ -0,0 +1,164 @@
+describe("Modules", function () {
+  var nameCounter = 0;
+
+  function getName() {
+    return "jasmine_test_" + (nameCounter++);
+  }
+
+  function defineOptionModule(moduleName, context) {
+    EasyGem.module.module(moduleName, function () {
+      return function () {
+        context.add.apply(context, arguments);
+      }
+    });
+  }
+
+  function defineCallbackModule(moduleName, context) {
+    EasyGem.module.module(moduleName, function () {
+      return {
+        add: function () {
+          context.add.apply(context, arguments);
+        }
+      };
+    });
+  }
+
+  function resolveModules() {
+    EasyGem.module.setUrl("", null);
+  }
+
+  beforeEach(function () {
+    this.counter = 1;
+    var self = this;
+    this.count = function () {
+      self.counter++;
+    };
+    this.add = function (add) {
+      for (var i = 0; i < arguments.length; i++) {
+        self.counter += arguments[i];
+      }
+    };
+  });
+  describe("simple", function () {
+    it("works with option", function () {
+      var moduleName = getName();
+      defineOptionModule(moduleName, this);
+      expect(this.counter).toEqual(1);
+      EasyGem.loadModule(moduleName, 5);
+      expect(this.counter).toEqual(6);
+    });
+    it("works with callback", function () {
+      var moduleName = getName();
+      defineCallbackModule(moduleName, this);
+      expect(this.counter).toEqual(1);
+      EasyGem.loadModule(moduleName, function (module) {
+        module.add(5);
+      });
+      expect(this.counter).toEqual(6);
+    });
+    it("works with multiple options", function () {
+      var moduleName = getName();
+      defineOptionModule(moduleName, this);
+      expect(this.counter).toEqual(1);
+      EasyGem.loadModule(moduleName, 5, 9);
+      expect(this.counter).toEqual(15);
+    });
+    it("works with multiple options - loadModules", function () {
+      var moduleName = getName();
+      defineOptionModule(moduleName, this);
+      expect(this.counter).toEqual(1);
+      EasyGem.loadModules([moduleName], 5, 9);
+      expect(this.counter).toEqual(15);
+    });
+  });
+  describe("complex", function () {
+    describe("handle define after request", function () {
+      it("option", function () {
+        var moduleName = getName();
+        expect(this.counter).toEqual(1);
+        EasyGem.loadModule(moduleName, 8);
+        expect(this.counter).toEqual(1);
+        defineOptionModule(moduleName, this);
+        resolveModules();
+        expect(this.counter).toEqual(9);
+      });
+      it("callback", function () {
+        var moduleName = getName();
+        expect(this.counter).toEqual(1);
+        EasyGem.loadModule(moduleName, function (module) {
+          module.add(3);
+        });
+        expect(this.counter).toEqual(1);
+        defineCallbackModule(moduleName, this);
+        resolveModules();
+        expect(this.counter).toEqual(4);
+      });
+    });
+    describe("parts", function () {
+      it("define first", function () {
+        var moduleName = getName();
+        var self = this;
+        EasyGem.module.part(moduleName, [], function () {
+          this.add = function (option) {
+            self.add(option);
+          }
+        });
+        EasyGem.module.part(moduleName, function () {
+          this.addDouble = function (option) {
+            self.add(option * 2);
+          }
+        });
+        expect(this.counter).toEqual(1);
+        EasyGem.loadModule(moduleName, function (module) {
+          module.add(3);
+          module.addDouble(2);
+        });
+        expect(this.counter).toEqual(8);
+      });
+      it("request first", function () {
+        var moduleName = getName();
+        var self = this;
+        EasyGem.loadModule(moduleName, function (module) {
+          module.add(3);
+          module.addDouble(2);
+        });
+        expect(this.counter).toEqual(1);
+        EasyGem.module.part(moduleName, [], function () {
+          this.add = function (option) {
+            self.add(option);
+          }
+        });
+        expect(this.counter).toEqual(1);
+        EasyGem.module.part(moduleName, function () {
+          this.addDouble = function (option) {
+            self.add(option * 2);
+          }
+        });
+        resolveModules();
+        expect(this.counter).toEqual(8);
+      });
+    });
+    it("handle complex tree", function () {
+      var moduleName = getName();
+      var subModuleName1 = getName();
+      var subModuleName2 = getName();
+      EasyGem.module.module(moduleName, [subModuleName1, subModuleName2], function (sub1, sub2) {
+        this.sub1 = sub1;
+        this.sub2 = sub2;
+      });
+      expect(this.counter).toEqual(1);
+      EasyGem.loadModule(moduleName, function (module) {
+        module.sub1(2);
+        module.sub2.add(3);
+      });
+      resolveModules();
+      expect(this.counter).toEqual(1);
+      defineOptionModule(subModuleName1, this);
+      resolveModules();
+      expect(this.counter).toEqual(1);
+      defineCallbackModule(subModuleName2, this);
+      resolveModules();
+      expect(this.counter).toEqual(6);
+    });
+  });
+});

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

@@ -1,4 +1,4 @@
-REDMINE_EXTENSIONS = {
+window.REDMINE_EXTENSIONS = {
 
   toggleDiv: function (el_or_id) {
     var el;

data/app/views/easy_settings/edit.html.erb

@@ -4,7 +4,7 @@
   <%= render "easy_settings/#{@plugin.id}", easy_settings: @easy_settings, settings: @settings, form: f %>
 
   <div class="form-actions">
-    <%= f.submit l(:button_update_easy_settings), class: 'button-1' %>
+    <%= f.submit l(:button_update_easy_settings), class: 'button-positive' %>
 
     <% if params[:back_url].present? %>
       <%= link_to l(:button_back), params[:back_url], class: 'button' %>

data/db/migrate/20190206121100_remove_foreign_key_from_easy_settings.rb

@@ -0,0 +1,11 @@
+class RemoveForeignKeyFromEasySettings < RedmineExtensions::Migration
+  def up
+    begin
+      remove_foreign_key :easy_settings, :projects
+    rescue # rails 5 - if foreign_key_exists? :easy_settings, :projects
+    end
+  end
+
+  def down
+  end
+end

data/lib/generators/redmine_extensions/entity/templates/index.api.rsb.erb

@@ -1,5 +1,5 @@
-api.array :<%= model_name_pluralize_underscored %>, api_meta(total_count: @entity_count, offset: @offset, limit: @limit) do
-  @entities.each do |<%= model_name_underscored %>|
-    render_api_<%= model_name_underscored %>(api, <%= model_name_underscored %>)
-  end
-end
+api.array :<%= model_name_pluralize_underscored %>, api_meta(total_count: @entity_count, offset: @offset, limit: @limit) do
+  @entities.each do |<%= model_name_underscored %>|
+    render_api_<%= model_name_underscored %>(api, <%= model_name_underscored %>)
+  end
+end

data/lib/generators/redmine_extensions/entity/templates/mail_added.html.erb.erb

@@ -1 +1 @@
-<h1><%%= link_to(@<%= model_name_underscored %>.to_s, @<%= model_name_underscored %>_url) %></h1>
+<h1><%%= link_to(@<%= model_name_underscored %>.to_s, @<%= model_name_underscored %>_url) %></h1>

data/lib/generators/redmine_extensions/entity/templates/mail_added.text.erb.erb

@@ -1,2 +1,2 @@
-<%%= @<%= model_name_underscored %>.to_s %>
-<%%= @<%= model_name_underscored %>_url %>
+<%%= @<%= model_name_underscored %>.to_s %>
+<%%= @<%= model_name_underscored %>_url %>

data/lib/generators/redmine_extensions/entity/templates/mail_updated.text.erb.erb

@@ -1,2 +1,2 @@
-<%%= @<%= model_name_underscored %>.to_s %>
-<%%= @<%= model_name_underscored %>_url %>
+<%%= @<%= model_name_underscored %>.to_s %>
+<%%= @<%= model_name_underscored %>_url %>

data/lib/generators/redmine_extensions/entity/templates/routes.rb.erb

@@ -1,13 +1,13 @@
-<% if project? %>
-resources :projects do
-  resources :<%= model_name_pluralize_underscored %>
-end
-<% end %>
-resources :<%= model_name_pluralize_underscored %> do
-  collection do
-    get 'autocomplete'
-    get 'bulk_edit'
-    post 'bulk_update'
-    get 'context_menu'
-  end
+<% if project? %>
+resources :projects do
+  resources :<%= model_name_pluralize_underscored %>
+end
+<% end %>
+resources :<%= model_name_pluralize_underscored %> do
+  collection do
+    get 'autocomplete'
+    get 'bulk_edit'
+    post 'bulk_update'
+    get 'context_menu'
+  end
 end

data/lib/redmine_extensions/easy_settings/params_wrapper.rb

@@ -4,9 +4,15 @@ module EasySettings
     attr_reader :errors
 
     def self.from_params(raw_params, project: nil, prefix: nil)
-      if !raw_params.is_a?(Hash) && !raw_params.is_a?(ActionController::Parameters)
+      case raw_params
+      when Hash
+        # OK
+      when ActionController::Parameters
+        raw_params = raw_params.to_unsafe_h
+      else
         raw_params = {}
       end
+
       new(raw_params, project, prefix)
     end
 

data/lib/redmine_extensions/engine.rb

@@ -57,7 +57,7 @@ module RedmineExtensions
 
     # include helpers
     initializer 'redmine_extensions.rails_patching', before: :load_config_initializers do |app|
-      ActiveSupport.on_load :action_controller do
+      ActiveSupport.on_load(Rails.version.start_with?('5') ? :action_controller_base : :action_controller) do
         helper RedmineExtensions::ApplicationHelper
         # helper RedmineExtensions::EasyQueryHelper
       end

data/lib/redmine_extensions/version.rb

@@ -1,3 +1,3 @@
 module RedmineExtensions
-  VERSION = '0.2.14'
+  VERSION = '0.2.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_extensions
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.16
 platform: ruby
 authors:
 - Easy Software Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -160,6 +160,7 @@ files:
 - app/assets/javascripts/redmine_extensions/jasmine_lib/jasmine_lib.js
 - app/assets/javascripts/redmine_extensions/jasmine_tests/extend.js
 - app/assets/javascripts/redmine_extensions/jasmine_tests/jasmine_tests.js
+- app/assets/javascripts/redmine_extensions/jasmine_tests/modules.js
 - app/assets/javascripts/redmine_extensions/jquery.entityarray.js
 - app/assets/javascripts/redmine_extensions/redmine_extensions.js
 - app/assets/javascripts/redmine_extensions/render_polyfill.js
@@ -195,6 +196,7 @@ files:
 - config/routes.rb
 - db/migrate/20150705172511_create_easy_settings.rb
 - db/migrate/20160519161300_create_entity_assignments.rb
+- db/migrate/20190206121100_remove_foreign_key_from_easy_settings.rb
 - lib/generators/redmine_extensions/entity/USAGE
 - lib/generators/redmine_extensions/entity/entity_generator.rb
 - lib/generators/redmine_extensions/entity/templates/_form.html.erb.erb
@@ -312,23 +314,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Redmine Extensions is set of usefull features for Redmine. Main focus is
   on development helpers, but many users can find it helpfull
 test_files:
+- spec/rails_helper.rb
 - spec/factories/easy_queries.rb
+- spec/factories/trackers.rb
+- spec/factories/users.rb
 - spec/factories/easy_settings.rb
+- spec/factories/time_entries.rb
 - spec/factories/issues.rb
 - spec/factories/projects.rb
-- spec/factories/time_entries.rb
-- spec/factories/trackers.rb
-- spec/factories/users.rb
-- spec/features/autocomplete_spec.rb
-- spec/features/jasmine_spec.rb
+- spec/support/plugin_generator.rb
 - spec/models/easy_setting_spec.rb
-- spec/presenters/easy_settings/params_wrapper_spec.rb
-- spec/rails_helper.rb
 - spec/spec_helper.rb
-- spec/support/plugin_generator.rb
+- spec/presenters/easy_settings/params_wrapper_spec.rb
+- spec/features/autocomplete_spec.rb
+- spec/features/jasmine_spec.rb