openproject/frontend/app/work_packages/controllers/dialogs/columns.js

//-- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
//++

module.exports = function($scope, $filter, columnsModal, QueryService, WorkPackageService, WorkPackagesTableService, $rootScope) {

  this.name    = 'Columns';
  this.closeMe = columnsModal.deactivate;
  var vm;
  $scope.vm = vm = {};
  vm.selectedColumns = [];
  vm.oldSelectedColumns = [];
  vm.availableColumns = [];
  vm.unusedColumns = [];

  var selectedColumns = QueryService.getSelectedColumns();

  // Available selectable Columns
  vm.promise = QueryService.loadAvailableColumns()
    .then(function(availableColumns){
      vm.availableColumns = availableColumns; // all existing columns
      vm.unusedColumns = QueryService.selectUnusedColumns(availableColumns); // columns not shown

      var availableColumnNames = getColumnNames(availableColumns);
      selectedColumns.forEach(function(column) {
        if (_.contains(availableColumnNames, column.name)) {
          vm.selectedColumns.push(column);
          vm.oldSelectedColumns.push(column);
        }
      });
    });

  function getNewlyAddedColumns() {
    return _.difference(vm.selectedColumns, vm.oldSelectedColumns);
  }

  function getColumnName(column) {
    return column.name;
  }

  function getColumnNames(arr) {
    return _.map(arr, getColumnName);
  }

  $scope.updateSelectedColumns = function() {
    QueryService.setSelectedColumns(getColumnNames(vm.selectedColumns));

    // Augment work packages with new columns data
    var addedColumns        = getNewlyAddedColumns(),
        currentWorkPackages = WorkPackagesTableService.getRowsData(),
        groupBy             = WorkPackagesTableService.getGroupBy();

    if(groupBy.length === 0) groupBy = undefined; // don't pass an empty string as groupBy

    if(addedColumns.length) {
      $rootScope.refreshWorkPackages = WorkPackageService.augmentWorkPackagesWithColumnsData(currentWorkPackages, addedColumns, groupBy);
    }

    columnsModal.deactivate();
  };

  /**
   * When a column is removed from the selection it becomes unused and hence available for selection again.
   * When a column is added to the selection it becomes used and is therefore unavailable for selection.
   *
   * This function updates the unused columns according to the currently selected columns.
   *
   * @param selectedColumns Columns currently selected through the multi select box.
   */
  $scope.updateUnusedColumns = function(selectedColumns) {
    var used = _.map(selectedColumns, getColumnName);
    var isUsed = function(col) {
      return !_.contains(used, col.name);
    };

    vm.unusedColumns = _.filter(vm.availableColumns, isUsed);
  };
};