[ADF-2131] Search sorting (#3334)

* sorting configuration

* detect primary sorting and use with document list

* search results sorting

* docs update

* unit tests and code updates

* update code

* update code

* generic sorting picker, test updates

* ability to switch off client side sorting

* update docs for document list

lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.html

@@ -0,0 +1,6 @@
+<adf-sorting-picker
+    [options]="options"
+    [selected]="value"
+    [ascending]="ascending"
+    (change)="onChanged($event)">
+</adf-sorting-picker>

lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.spec.ts

@@ -0,0 +1,81 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { SearchSortingPickerComponent } from './search-sorting-picker.component';
+import { SearchQueryBuilderService } from '../../search-query-builder.service';
+import { AppConfigService } from '@alfresco/adf-core';
+import { SearchConfiguration } from '../../search-configuration.interface';
+
+describe('SearchSortingPickerComponent', () => {
+
+    let queryBuilder: SearchQueryBuilderService;
+    let component: SearchSortingPickerComponent;
+
+    const buildConfig = (searchSettings): AppConfigService => {
+        const config = new AppConfigService(null);
+        config.config.search = searchSettings;
+        return config;
+    };
+
+    beforeEach(() => {
+        const config: SearchConfiguration = {
+            sorting: {
+                options: [
+                    <any> { 'key': 'name', 'label': 'Name', 'type': 'FIELD', 'field': 'cm:name', 'ascending': true },
+                    <any> { 'key': 'content.sizeInBytes', 'label': 'Size', 'type': 'FIELD', 'field': 'content.size', 'ascending': true },
+                    <any> { 'key': 'description', 'label': 'Description', 'type': 'FIELD', 'field': 'cm:description', 'ascending': true }
+                ],
+                defaults: [
+                    <any> { 'key': 'name', 'type': 'FIELD', 'field': 'cm:name', 'ascending': true }
+                ]
+            },
+            categories: [
+                <any> { id: 'cat1', enabled: true }
+            ]
+        };
+        queryBuilder = new SearchQueryBuilderService(buildConfig(config), null);
+        component = new SearchSortingPickerComponent(queryBuilder);
+    });
+
+    it('should load options from query builder', () => {
+        component.ngOnInit();
+
+        expect(component.options.length).toBe(3);
+        expect(component.options[0].key).toEqual('name');
+        expect(component.options[1].key).toEqual('content.sizeInBytes');
+        expect(component.options[2].key).toEqual('description');
+    });
+
+    it('should pre-select the primary sorting definition', () => {
+        component.ngOnInit();
+
+        expect(component.value).toEqual('name');
+        expect(component.ascending).toBeTruthy();
+    });
+
+    it('should update query builder each time selection is changed', () => {
+        spyOn(queryBuilder, 'update').and.stub();
+
+        component.ngOnInit();
+        component.onChanged({ key: 'description', ascending: false });
+
+        expect(queryBuilder.update).toHaveBeenCalled();
+        expect(queryBuilder.sorting.length).toBe(1);
+        expect(queryBuilder.sorting[0].key).toEqual('description');
+        expect(queryBuilder.sorting[0].ascending).toBeFalsy();
+    });
+});

lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts

@@ -0,0 +1,70 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component, OnInit, ViewEncapsulation } from '@angular/core';
+import { SearchQueryBuilderService } from '../../search-query-builder.service';
+import { SearchSortingDefinition } from '../../search-sorting-definition.interface';
+
+@Component({
+    selector: 'adf-search-sorting-picker',
+    templateUrl: './search-sorting-picker.component.html',
+    encapsulation: ViewEncapsulation.None,
+    host: { class: 'adf-search-sorting-picker' }
+})
+export class SearchSortingPickerComponent implements OnInit {
+
+    options: SearchSortingDefinition[] = [];
+    value: string;
+    ascending: boolean;
+
+    constructor(private queryBuilder: SearchQueryBuilderService) {}
+
+    ngOnInit() {
+        this.options = this.queryBuilder.getSortingOptions();
+
+        const primary = this.queryBuilder.getPrimarySorting();
+        if (primary) {
+            this.value = primary.key;
+            this.ascending = primary.ascending;
+        }
+    }
+
+    onChanged(sorting: { key: string, ascending: boolean }) {
+        this.value = sorting.key;
+        this.ascending = sorting.ascending;
+        this.applySorting();
+    }
+
+    private findOptionByKey(key: string): SearchSortingDefinition {
+        if (key) {
+            return this.options.find(opt => opt.key === key);
+        }
+        return null;
+    }
+
+    private applySorting() {
+        const option = this.findOptionByKey(this.value);
+        if (option) {
+            this.queryBuilder.sorting = [{
+                ...option,
+                ascending: this.ascending
+            }];
+            this.queryBuilder.update();
+        }
+    }
+
+}