openproject/frontend/app/components/wp-fast-table/wp-table-group-by.ts

// -- 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.
// ++

import {QueryGroupByResource} from '../api/api-v3/hal-resources/query-group-by-resource.service';
import {QueryResource} from '../api/api-v3/hal-resources/query-resource.service';
import {QuerySchemaResourceInterface} from '../api/api-v3/hal-resources/query-schema-resource.service';
import {WorkPackageTableBaseState} from './wp-table-base';
import {QueryColumn} from '../wp-query/query-column';

export class WorkPackageTableGroupBy extends WorkPackageTableBaseState<QueryGroupByResource | undefined> {
  public available:QueryGroupByResource[] = [];
  public current:QueryGroupByResource | undefined;

  constructor(query:QueryResource, schema?:QuerySchemaResourceInterface) {
    super();
    this.current = angular.copy(query.groupBy);

    if (schema) {
      this.available = angular.copy(schema.groupBy.allowedValues as QueryGroupByResource[]);
    }
  }

  public hasChanged(query:QueryResource) {
    const comparer = (groupBy:QueryColumn|undefined) => groupBy ? groupBy.href : null;

    return !_.isEqual(
      comparer(query.groupBy),
      comparer(this.current)
    );
  }

  public applyToQuery(query:QueryResource) {
    query.groupBy = _.cloneDeep(this.current);
  }

  public update(query:QueryResource|null, schema?:QuerySchemaResourceInterface) {
    if (query) {
      this.current = angular.copy(query.groupBy);
    }

    if (schema) {
      this.available = angular.copy(schema.groupBy.allowedValues as QueryGroupByResource[]);
    }
  }

  public setBy(column:QueryColumn) {
    let groupBy = _.find(this.available, candidate => candidate.id === column.id)

    this.current = groupBy;
  }

  public isGroupable(column:QueryColumn):boolean {
    return !!_.find(this.available, candidate => candidate.id === column.id)
  }

  public isCurrentlyGroupedBy(column:QueryColumn):boolean {
    return !!this.current && this.current.id === column.id;
  }
}