Merge lp:~ahayzen/ubuntu-ui-extras/job-model-filters-for-queue-dialog into lp:~phablet-team/ubuntu-ui-extras/printer-staging

[Andrew Hayzen]

* Add filters for active, paused and queued
* Add sorting by creationTime and then falling back to id
* Change time related roles in JobModel to return QDateTime, not QString, so sorting doesn't break
* Update tests

* Add filters for active, paused and queued
* Add sorting by creationTime and then falling back to id
* Change time related roles in JobModel to return QDateTime, not QString, so sorting doesn't break
* Update tests

[Jonas G. Drange (jonas-drange)]

Couple of minor comments, but looks real fine!

review: Needs Fixing

[lp:~ahayzen/ubuntu-ui-extras/job-model-filters-for-queue-dialog]

145. By Andrew Hayzen on 2017-03-06

* Change QList to QSet
* Add qHash for JobState
* Make Q_INVOKABLE methods Q_SLOTS
* Add comment about QML ownership

[Jonas G. Drange (jonas-drange)]

good show!

review: Approve

=== modified file 'modules/Ubuntu/Components/Extras/Printers/enums.h'
--- modules/Ubuntu/Components/Extras/Printers/enums.h	2017-02-23 14:04:26 +0000
+++ modules/Ubuntu/Components/Extras/Printers/enums.h	2017-03-06 13:19:21 +0000
@@ -103,4 +103,9 @@
     Q_ENUM(PrinterType)
 };
 
+inline uint qHash(const PrinterEnum::JobState &state, uint seed)
+{
+    return qHash((int) state, seed);
+}
+
 #endif // USC_PRINTERS_ENUMS_H

=== modified file 'modules/Ubuntu/Components/Extras/Printers/models/jobmodel.cpp'
--- modules/Ubuntu/Components/Extras/Printers/models/jobmodel.cpp	2017-03-02 14:52:47 +0000
+++ modules/Ubuntu/Components/Extras/Printers/models/jobmodel.cpp	2017-03-06 13:19:21 +0000
@@ -175,13 +175,13 @@
             break;
         }
         case CompletedTimeRole:
-            ret = job->completedTime().toString(QLocale::system().dateTimeFormat());
+            ret = job->completedTime();
             break;
         case CopiesRole:
             ret = job->copies();
             break;
         case CreationTimeRole:
-            ret = job->creationTime().toString(QLocale::system().dateTimeFormat());
+            ret = job->creationTime();
             break;
         case DuplexRole: {
             if (job->printer()) {
@@ -217,7 +217,7 @@
             ret = QVariant::fromValue<PrinterEnum::PrintRange>(job->printRangeMode());
             break;
         case ProcessingTimeRole:
-            ret = job->processingTime().toString(QLocale::system().dateTimeFormat());
+            ret = job->processingTime();
             break;
         case QualityRole: {
             if (job->printer()) {
@@ -359,6 +359,33 @@
     return rowCount();
 }
 
+void JobFilter::filterOnActive()
+{
+    m_activeStates = QSet<PrinterEnum::JobState>{
+        PrinterEnum::JobState::Processing,
+    };
+    m_activeFilterEnabled = true;
+    invalidate();
+}
+
+void JobFilter::filterOnPaused()
+{
+    m_pausedStates = QSet<PrinterEnum::JobState>{
+        PrinterEnum::JobState::Held,
+    };
+    m_pausedFilterEnabled = true;
+    invalidate();
+}
+
+void JobFilter::filterOnQueued()
+{
+    m_queuedStates = QSet<PrinterEnum::JobState>{
+        PrinterEnum::JobState::Pending,
+    };
+    m_queuedFilterEnabled = true;
+    invalidate();
+}
+
 void JobFilter::filterOnPrinterName(const QString &name)
 {
     m_printerName = name;
@@ -378,5 +405,50 @@
         accepts = m_printerName == printerName;
     }
 
+    if (accepts && m_activeFilterEnabled) {
+        PrinterEnum::JobState state = childIndex.model()->data(
+            childIndex, JobModel::StateRole
+        ).value<PrinterEnum::JobState>();
+
+        accepts = m_activeStates.contains(state);
+    }
+
+    if (accepts && m_pausedFilterEnabled) {
+        PrinterEnum::JobState state = childIndex.model()->data(
+            childIndex, JobModel::StateRole
+        ).value<PrinterEnum::JobState>();
+
+        accepts = m_pausedStates.contains(state);
+    }
+
+    if (accepts && m_queuedFilterEnabled) {
+        PrinterEnum::JobState state = childIndex.model()->data(
+            childIndex, JobModel::StateRole
+        ).value<PrinterEnum::JobState>();
+
+        accepts = m_queuedStates.contains(state);
+    }
+
     return accepts;
 }
+
+bool JobFilter::lessThan(const QModelIndex &source_left,
+                         const QModelIndex &source_right) const
+{
+    QVariant leftData = sourceModel()->data(source_left, sortRole());
+    QVariant rightData = sourceModel()->data(source_right, sortRole());
+
+    if (sortRole() == (int) JobModel::CreationTimeRole) {
+        // If creationDateTime is the same, fallback to Id
+        if (leftData.toDateTime() == rightData.toDateTime()) {
+            int leftId = sourceModel()->data(source_left, JobModel::IdRole).toInt();
+            int rightId = sourceModel()->data(source_right, JobModel::IdRole).toInt();
+
+            return leftId < rightId;
+        } else {
+            return leftData.toDateTime() < rightData.toDateTime();
+        }
+    } else {
+        return leftData < rightData;
+    }
+}

=== modified file 'modules/Ubuntu/Components/Extras/Printers/models/jobmodel.h'
--- modules/Ubuntu/Components/Extras/Printers/models/jobmodel.h	2017-03-01 12:53:55 +0000
+++ modules/Ubuntu/Components/Extras/Printers/models/jobmodel.h	2017-03-06 13:19:21 +0000
@@ -103,13 +103,19 @@
     explicit JobFilter(QObject *parent = Q_NULLPTR);
     ~JobFilter();
 
-    Q_INVOKABLE QVariantMap get(const int row) const;
-
     void filterOnPrinterName(const QString &name);
     int count() const;
+public Q_SLOTS:
+    QVariantMap get(const int row) const;
+
+    void filterOnActive();
+    void filterOnQueued();
+    void filterOnPaused();
 protected:
     virtual bool filterAcceptsRow(
         int sourceRow, const QModelIndex &sourceParent) const override;
+    virtual bool lessThan(const QModelIndex &source_left,
+                          const QModelIndex &source_right) const;
 
 Q_SIGNALS:
     void countChanged();
@@ -121,6 +127,15 @@
 private:
     QString m_printerName = QString::null;
     bool m_printerNameFilterEnabled = false;
+
+    bool m_activeFilterEnabled = false;
+    QSet<PrinterEnum::JobState> m_activeStates;
+
+    bool m_queuedFilterEnabled = false;
+    QSet<PrinterEnum::JobState> m_queuedStates;
+
+    bool m_pausedFilterEnabled = false;
+    QSet<PrinterEnum::JobState> m_pausedStates;
 };
 
 #endif // USC_JOB_MODEL_H

=== modified file 'modules/Ubuntu/Components/Extras/Printers/printers/printers.cpp'
--- modules/Ubuntu/Components/Extras/Printers/printers/printers.cpp	2017-03-02 14:19:56 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printers/printers.cpp	2017-03-06 13:19:21 +0000
@@ -144,6 +144,18 @@
     return new PrinterJob(printerName, m_backend);
 }
 
+QAbstractItemModel* Printers::createJobFilter()
+{
+    // Note: If called by QML, it gains ownership of the job filter.
+    JobFilter *filter = new JobFilter();
+    filter->setSourceModel(&m_jobs);
+
+    filter->setSortRole(JobModel::Roles::CreationTimeRole);
+    filter->sort(0, Qt::AscendingOrder);
+
+    return filter;
+}
+
 void Printers::cancelJob(const QString &printerName, const int jobId)
 {
     m_backend->cancelJob(printerName, jobId);

=== modified file 'modules/Ubuntu/Components/Extras/Printers/printers/printers.h'
--- modules/Ubuntu/Components/Extras/Printers/printers/printers.h	2017-03-02 14:19:56 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printers/printers.h	2017-03-06 13:19:21 +0000
@@ -62,6 +62,8 @@
 
 public Q_SLOTS:
     PrinterJob* createJob(const QString &printerName);
+    QAbstractItemModel* createJobFilter();
+
     void cancelJob(const QString &printerName, const int jobId);
     void holdJob(const QString &printerName, const int jobId);
     void releaseJob(const QString &printerName, const int jobId);

=== modified file 'tests/unittests/Printers/tst_jobmodel.cpp'
--- tests/unittests/Printers/tst_jobmodel.cpp	2017-03-02 12:49:06 +0000
+++ tests/unittests/Printers/tst_jobmodel.cpp	2017-03-06 13:19:21 +0000
@@ -192,10 +192,10 @@
         m_backend->mockJobCreated("", "", "", 1, "", true, 100, 1, "", "", 1);
 
         QTRY_COMPARE(m_model->count(), 2);
-        QCOMPARE(m_model->data(m_model->index(0), JobModel::CompletedTimeRole).toString(),
-                 dateTimeA.toString(QLocale::system().dateTimeFormat()));
-        QCOMPARE(m_model->data(m_model->index(1), JobModel::CompletedTimeRole).toString(),
-                 dateTimeB.toString(QLocale::system().dateTimeFormat()));
+        QCOMPARE(m_model->data(m_model->index(0), JobModel::CompletedTimeRole).toDateTime(),
+                 dateTimeA);
+        QCOMPARE(m_model->data(m_model->index(1), JobModel::CompletedTimeRole).toDateTime(),
+                 dateTimeB);
     }
     void testCopiesRole()
     {
@@ -227,10 +227,10 @@
         m_backend->mockJobCreated("", "", "", 1, "", true, 100, 1, "", "", 1);
 
         QTRY_COMPARE(m_model->count(), 2);
-        QCOMPARE(m_model->data(m_model->index(0), JobModel::CreationTimeRole).toString(),
-                 dateTimeA.toString(QLocale::system().dateTimeFormat()));
-        QCOMPARE(m_model->data(m_model->index(1), JobModel::CreationTimeRole).toString(),
-                 dateTimeB.toString(QLocale::system().dateTimeFormat()));
+        QCOMPARE(m_model->data(m_model->index(0), JobModel::CreationTimeRole).toDateTime(),
+                 dateTimeA);
+        QCOMPARE(m_model->data(m_model->index(1), JobModel::CreationTimeRole).toDateTime(),
+                 dateTimeB);
     }
     void testDuplexRole()
     {
@@ -385,10 +385,10 @@
         m_backend->mockJobCreated("", "", "", 1, "", true, 100, 1, "", "", 1);
 
         QTRY_COMPARE(m_model->count(), 2);
-        QCOMPARE(m_model->data(m_model->index(0), JobModel::ProcessingTimeRole).toString(),
-                 dateTimeA.toString(QLocale::system().dateTimeFormat()));
-        QCOMPARE(m_model->data(m_model->index(1), JobModel::ProcessingTimeRole).toString(),
-                 dateTimeB.toString(QLocale::system().dateTimeFormat()));
+        QCOMPARE(m_model->data(m_model->index(0), JobModel::ProcessingTimeRole).toDateTime(),
+                 dateTimeA);
+        QCOMPARE(m_model->data(m_model->index(1), JobModel::ProcessingTimeRole).toDateTime(),
+                 dateTimeB);
     }
     void testQualityRole()
     {