Merge branch 'add-after-before-options'

Author: icyflame

.editorconfig

@@ -1,9 +1,12 @@
 root = true
 
-[*]
+[Makefile]
+indent_style = tab
+
+[*.js]
 indent_style = space
 indent_size = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
-insert_final_newline = true
+insert_final_newline = true

Makefile

@@ -0,0 +1,24 @@
+help: ## Show this help
+	@awk 'BEGIN {FS = ":.*?## "} \
+			/^[a-zA-Z0-9_-]+:.*?## / { \
+				sub("\\\\n", "", $$2); \
+				printf "%-30s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+stats: ## Run a bunch of stats commands for testing
+	node cli.js --help && \
+		node cli.js stats && \
+		node cli.js stats --bucket 5 && \
+		node cli.js stats --bucket 5 --min 20 && \
+		node cli.js stats --bucket 5 --min 20 --max 40 && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2018-01-01" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --before "2018-01-01" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2018-11-25" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --before "2018-11-25" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2019-11-25" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --before "2019-11-25" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2019-11-25" --before "2019-11-27" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --before "2019-11-27" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2019-11-25" --before "2019-11-30" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2019-11-25" --before "2019-11-29" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2019-11-25" --before "2019-11-28" && \
+		node cli.js stats --bucket 5 --min 20 --max 40 --after "2019-11-25" --before "2019-11-27"

README.md

@@ -30,7 +30,7 @@ You need a GitHub account to store your solves on a Gist.
 
 This will begin a solving session. All session statistics will be stored locally for this session.
 
-### `solve stats [--bucket n] [--min min] [--max max]`
+### `solve stats [--bucket n] [--min min] [--max max] [--before timestamp] [--after timestamp]`
 
 > View your lifetime statistics
 
@@ -39,10 +39,18 @@ This will show you the mean, median, standard deviation and the distribution of
 The distribution is by default at a bucket size of 10 seconds. If you are an
 advanced solver and need more resolution, just use the bucket option and use
 `solve stats --bucket 2` to show your solves with a bucket size of 2 seconds
-each. If you would like to see just a subset of all your solves, you can use the
-`min` and `max` options. For eg: `solve stats --min 10 --max 20 --bucket 2` will
-print the distribution of your solve times between 10 and 20 seconds at a bucket
-sizeof 2 seconds.
+each.
+
+If you would like to see just a subset of all your solves, you can use the `min`
+and `max` options. For eg: `solve stats --min 10 --max 20 --bucket 2` will print
+the distribution of your solve times between 10 and 20 seconds with a bucket
+size of 2 seconds.
+
+Starting with v1.2.0, cli-cube-timer stores the time at which a solve was
+recorded. You can use the `--before` and `--after` options to filter out solves
+within a given period of time. Internally, the string is converted to a
+timestamp using [moment.js][1], so you can use any supported ISO 8601 string to
+specify the timestamps.
 
 ### `solve push`
 
@@ -92,3 +100,5 @@ on the dashboard, please do feel free to create new ones!
 Code licensed under MIT.
 
 Copyright Siddharth Kannan 2015.
+
+[1]: https://momentjs.com/docs/#/parsing/string/

cli.js

@@ -16,6 +16,10 @@ var cli = meow({
     '    - View statistics for all solves above 20 seconds',
     '  solve stats --max 30',
     '    - View statistics for all solves below 30 seconds',
+    '  solve stats --min 20 --after "2019-01-01"',
+    '    - View statistics for all solves above 20s, created (with v1.2.0+) after 1st January, 2019',
+    '  solve stats --before "2019-11-01"',
+    '    - View statistics for all solves created (with v1.2.0+) before 1st November, 2019',
     '  solve login',
     '    - Run the one time authentication module (GitHub)',
     '  solve push',
@@ -39,6 +43,8 @@ if (cli.flags.show) {
       bucket: cli.flags.bucket,
       min: cli.flags.min,
       max: cli.flags.max,
+      before: cli.flags.before,
+      after: cli.flags.after,
     });
       break;
     case 'login': require('./login-module.js')();

index.js

@@ -7,17 +7,15 @@ module.exports = function () {
   var threebythree = new Scrambo();
   var prettyMs = require('pretty-ms');
   var this_scramble, last_scramble, this_solve, stats = { };
+  // Helper functions
+  var prettifyVerbose = require('./utils.js').prettifyVerbose;
 
   const STATS_LINES = 11;
 
   function prettify (ms) {
     return prettyMs(ms, {secDecimalDigits: 2});
   }
 
-  function prettifyVerbose (ms) {
-    return prettyMs(ms, {verbose: true, secDecimalDigits: 2});
-  }
-
   function botSay (phrase) {
     console.log(clc.red('Bot: ') + phrase);
   }

package.json

@@ -42,6 +42,7 @@
     "math-avg": "1.0.0",
     "meow": "3.7.0",
     "mkdirp": "0.5.1",
+    "moment": "^2.24.0",
     "pretty-ms": "1.4.0",
     "read": "1.0.7",
     "remove-min-max": "1.0.0",

stats-module.js

@@ -1,33 +1,33 @@
-module.exports = function ({ bucket, min, max }) {
-  var bucket_size = typeof bucket === 'number' ? bucket : 10;
-  var min_solve = typeof min === 'number' ? min : 0;
-  var max_solve = typeof max === 'number' ? max : Number.MAX_SAFE_INTEGER;
-
+module.exports = function ({ bucket, min, max, before, after }) {
   var async = require('async');
-  var fileModule = require('./file-module.js');
-  var pushed_file_name = require('./constants.js').PUSHED_FILE_PATH;
-  var local_file_name = require('./constants.js').LOCAL_FILE_PATH;
-
   var fs = require('fs');
   var csv = require('fast-csv');
   var Stats = require('fast-stats').Stats;
   var clc = require('cli-color');
   var barHorizontal = require('bar-horizontal');
+  // Local modules
+  var fileModule = require('./file-module.js');
+  // Constants
+  var pushed_file_name = require('./constants.js').PUSHED_FILE_PATH;
+  var local_file_name = require('./constants.js').LOCAL_FILE_PATH;
+  // Helper functions
+  var parseStrToMomentOrUndefined = require('./utils.js').parseStrToMomentOrUndefined;
+  var solveValidator = require('./utils.js').solveValidator;
+  var prettifyVerbose = require('./utils.js').prettifyVerbose;
 
-  var prettyMs = require('pretty-ms');
-
-  function prettifyVerbose (ms) {
-    return prettyMs(ms, {verbose: true, secDecimalDigits: 2});
-  }
+  var bucket_size = typeof bucket === 'number' ? bucket : 10;
+  var min_solve = typeof min === 'number' ? min : 0;
+  var max_solve = typeof max === 'number' ? max : Number.MAX_SAFE_INTEGER;
+  var before_timestamp = parseStrToMomentOrUndefined(before);
+  var after_timestamp = parseStrToMomentOrUndefined(after);
+  var validatorFunc = solveValidator(min_solve, max_solve, before_timestamp, after_timestamp);
 
   var all_times = new Stats({bucket_precision: bucket_size});
 
   var avail_files = [ ];
-
   if (fileModule.pushedFileExists()) {
     avail_files.push(pushed_file_name);
   }
-
   if (fileModule.localFileExists()) {
     avail_files.push(local_file_name);
   }
@@ -36,8 +36,16 @@ module.exports = function ({ bucket, min, max }) {
     function (file_name, callback) {
       var csvStream = csv()
       .on('data', function (data) {
+        // Step 1: Get the solve time, this should always be present
         var solve_time = parseFloat(data[0]);
-        if (!isNaN(solve_time) && solve_time >= min_solve && solve_time <= max_solve) {
+
+        // Step 2: Try to parse solve timestamp
+        // This was introduced in v1.2.0. Files written by versions of cli-cube-timer before v1.2.0
+        // will not have this column.
+        var solve_timestamp = data.length >= 3 ? data[2] : undefined;
+        var solve_unix_ts = parseFloat(solve_timestamp, 10) / 1000;
+
+        if (validatorFunc(solve_time, solve_unix_ts)) {
           all_times.push(solve_time);
         }
       })
@@ -71,6 +79,17 @@ module.exports = function ({ bucket, min, max }) {
       });
 
       barHorizontal(input_obj, { labels: true });
+
+      if (before_timestamp !== undefined || after_timestamp !== undefined) {
+        console.log('\nTime constraints:');
+      }
+
+      if (after_timestamp !== undefined) {
+        console.log(`After: ${clc.green(after_timestamp)}`);
+      }
+      if (before_timestamp !== undefined) {
+        console.log(`Before: ${clc.green(before_timestamp)}`);
+      }
     }
   });
 };

utils.js

@@ -0,0 +1,44 @@
+var prettyMs = require('pretty-ms');
+var moment = require('moment');
+
+exports.parseStrToMomentOrUndefined = function (input) {
+  return input !== undefined && moment(input).isValid() ? moment(input) : undefined;
+}
+
+exports.solveValidator = function (min_solve, max_solve, before_timestamp, after_timestamp) {
+  return function (solve_time, solve_unix_ts) {
+    var solveTimeValid = (!isNaN(solve_time) && solve_time >= min_solve && solve_time <= max_solve);
+
+    var solveTsExists = !isNaN(solve_unix_ts) && typeof solve_unix_ts === 'number' && solve_unix_ts > 0;
+    var inputOptionsValid = before_timestamp !== undefined || after_timestamp !== undefined;
+
+    // Solve time itself is invalid
+    if (!solveTimeValid) {
+      return solveTimeValid;
+    }
+
+    // --after or --before not provided, so timestamp validity needn't be checked
+    if (!inputOptionsValid) {
+      return solveTimeValid;
+    }
+
+    // User has provided --after or --before, solves without timestamps will not be included in
+    // the statistics
+    if (inputOptionsValid && !solveTsExists) {
+      return false;
+    }
+
+    var solve_moment = moment.unix(solve_unix_ts);
+    if (before_timestamp === undefined) {
+      return solve_moment.isAfter(after_timestamp);
+    }
+    if (after_timestamp === undefined) {
+      return solve_moment.isBefore(before_timestamp);
+    }
+    return solve_moment.isBetween(after_timestamp, before_timestamp);
+  };
+}
+
+exports.prettifyVerbose = function (ms) {
+  return prettyMs(ms, {verbose: true, secDecimalDigits: 2});
+}