trackler 2.2.1.104 → 2.2.1.105

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 575d4e124815db45fba23a7e5f11503c9f0bab7e
-  data.tar.gz: 12c05d5db940e9518507ba0e156c946bfdb433b1
+  metadata.gz: 4e39b35583717370d798873a1221e64de40b594b
+  data.tar.gz: 73a7ac2d4e1bd78f378142b8fde385d69101b539
 SHA512:
-  metadata.gz: 886d6275e75c57648d746459c44b04fc0f582ef07698db2f1a71aca4257dec4eb1fd4205467aa25a908b72c3088d708152707ee53f419537d65c34f178941d8c
-  data.tar.gz: 60e49fd13be4129d91f444a0b0b723edb477fdeab5901ff16a8cc23f200089054688a57647bfae32da0e93fb6dc082c76fd4df3d29305f88838406a86eac1a4d
+  metadata.gz: dfd4bc875f948d5443ee5db0fbf7a43890669a1b4a91738a020429e2a74ba5a041b568aed039ebb7c18aa706bb6fb1dec2a627958d850f748b4541838b5ec0a6
+  data.tar.gz: 66aa09b0a1ccb8e3af6ac9b4ed419350bda659bbfc98ff4bbf07a111134e0e40c841b401141447cfbf97ec52a387b7879740f2c7290cb9dd66846fce85be38d2

data/lib/trackler/version.rb

@@ -1,3 +1,3 @@
 module Trackler
-  VERSION = "2.2.1.104"
+  VERSION = "2.2.1.105"
 end

data/problem-specifications/.travis.yml

@@ -6,4 +6,44 @@ cache: yarn
 
 script:
   - bin/check_required_files_present
-  - npm test
+  - |
+    invalid_old=""
+    invalid_new=""
+    forgotten=""
+
+    for json in exercises/*/canonical-data.json; do
+      dir=$(dirname $json)
+      ex=$(basename $dir)
+
+      if [ -f "$dir/USE_OLD_SCHEMA" ]; then
+        if ! ajv -s old-schema.json -d $json; then
+          invalid_old="$invalid_old $ex"
+        fi
+        # If we have converted to new,
+        # make sure we don't forget to remove USE_OLD_SCHEMA file!
+        if ajv -s canonical-schema.json -d $json 2>/dev/null; then
+          forgotten="$forgotten $ex"
+        fi
+      else
+        if ! ajv -s canonical-schema.json -d $json; then
+          invalid_new="$invalid_new $ex"
+        fi
+      fi
+    done
+
+    stat=0
+
+    if [ -n "$invalid_old" ]; then
+      echo "Exercises using old schema, but invalid: $invalid_old"
+      stat=1
+    fi
+    if [ -n "$invalid_new" ]; then
+      echo "Exercises using new schema, but invalid: $invalid_new"
+      stat=1
+    fi
+    if [ -n "$forgotten" ]; then
+      echo "Exercises using new schema, but forgot to remove USE_OLD_SCHEMA file: $forgotten"
+      stat=1
+    fi
+
+    exit $stat

data/problem-specifications/README.md

@@ -170,25 +170,25 @@ PATCH changes would never break well-designed test generators, because the test
 ## Automated Tests
 
 `canonical-data.json` for each exercise is checked for compliance against the [canonical-schema.json](canonical-schema.json).
-In order to run these tests, you will need to have `node` and `npm` installed on your system.
-Install them from [here](https://nodejs.org/en/). (`npm` comes bundled with most installations of `node`).
+In order to run these tests, you will need to have `yarn` installed on your system.
+Install them from [here](https://yarnpkg.com/en/docs/install).
 
 Install the required packages:
 
 ```shell
-npm install
+yarn install
 ```
 
 Run for all exercises:
 
 ```shell
-npm test
+yarn test
 ```
 
 Run for single exercise:
 
 ```shell
-npm run test-one exercises/<exercise>/canonical-data.json
+yarn run test-one exercises/<exercise>/canonical-data.json
 ```
 
 Replace `<exercise>` by the name of exercise which you want to check.

data/problem-specifications/canonical-schema.json

@@ -3,11 +3,9 @@
    [ " This is a JSON Schema for 'canonical-data.json' files.     "
    , "                                                            "
    , " It enforces just a general structure for all exercises,    "
-   , " without specifying how the test data should be organized   "
-   , " for each type of test. We do this to keep generality and   "
-   , " allow support for tests the do not fit well in the         "
-   , " 'function (input) == output' structure, like property      "
-   , " tests.                                                     "
+   , " optimising for the ability to represent example-based tests"
+   , " of the form 'function (input) == output'. Future expansions"
+   , " may allow for other types of tests such as property-based. "
    , "                                                            "
    , " The only thing enforced regarding how test data should be  "
    , " structured is the error encoding, because it was agreed    "
@@ -85,13 +83,15 @@
       "labeledTest":
           { "description": "A single test with a description"
           , "type"       : "object"
-          , "required"   : ["description", "property"]
+          , "required"   : ["description", "property", "input", "expected"]
           , "properties" :
                 { "description": { "$ref": "#/definitions/description" }
                 , "comments"   : { "$ref": "#/definitions/comments"    }
                 , "property"   : { "$ref": "#/definitions/property"    }
+                , "input"      : { "$ref": "#/definitions/input"       }
                 , "expected"   : { "$ref": "#/definitions/expected"    }
                 }
+          , "additionalProperties": false
           },
 
       "labeledTestGroup":
@@ -117,6 +117,11 @@
           , "pattern"    : "^[a-z]+([A-Z][a-z]+)*[A-Z]?$"
           },
 
+      "input":
+          { "description": "The inputs to a test case"
+          , "type"       : "object"
+          },
+
       "expected":
           { "description": "The expected return value of a test case"
           , "properties":

data/problem-specifications/exercises/all-your-base/canonical-data.json

@@ -1,6 +1,6 @@
 {
   "exercise": "all-your-base",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "comments": [
     "This canonical data makes the following choices:",
     "1. Zero is always represented in outputs as [0] instead of [].",
@@ -138,7 +138,7 @@
       "property": "rebase",
       "input": {
         "inputBase": 1,
-        "digits": [],
+        "digits": [0],
         "outputBase": 10
       },
       "expected": {"error": "input base must be >= 2"}

data/problem-specifications/exercises/complex-numbers/canonical-data.json

@@ -1,6 +1,6 @@
 {
   "exercise": "complex-numbers",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "comments": [
     " The canonical data assumes mathematically correct real   ",
     " numbers. The testsuites should consider rounding errors  ",
@@ -323,6 +323,14 @@
             "z": [1, 0]
           },
           "expected": ["e", 0]
+        },
+        {
+          "description": "Exponential of a number with real and imaginary part",
+          "property": "exp",
+          "input": {
+            "z": ["ln(2)", "pi"]
+          },
+          "expected": [-2, 0]
         }
       ]
     }

data/problem-specifications/exercises/scale-generator/canonical-data.json

@@ -0,0 +1,181 @@
+{
+  "exercise": "scale-generator",
+  "version": "1.0.0",
+  "cases": [
+    {
+      "comments": [
+        "These tests have no interval.",
+        "The chromatic scale is considered the default scale"
+      ],
+      "description": "Chromatic scales",
+      "cases": [
+        {
+          "description": "Chromatic scale with sharps",
+          "property": "pitches",
+          "input": {
+            "tonic": "C"
+          },
+          "expected": [ "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" ]
+        },
+        {
+          "description": "Chromatic scale with flats",
+          "property": "pitches",
+          "input": {
+            "tonic": "F"
+          },
+          "expected": [ "F", "Gb", "G", "Ab", "A", "Bb", "B", "C", "Db", "D", "Eb", "E" ]
+        }
+      ]
+    },
+    {
+      "comments": [
+        "These tests all have intervals and are explorations of different",
+        "traversals of the scale."
+      ],
+      "description": "Scales with specified intervals",
+      "cases": [
+        {
+          "description": "Simple major scale",
+          "comments": [
+            "The simplest major scale, with no sharps or flats."
+          ],
+          "property": "pitches",
+          "input": {
+            "tonic": "C",
+            "intervals": "MMmMMMm"
+          },
+          "expected": [ "C", "D", "E", "F", "G", "A", "B" ]
+        },
+        {
+          "description": "Major scale with sharps",
+          "property": "pitches",
+          "input": {
+            "tonic": "G",
+            "intervals": "MMmMMMm"
+          },
+          "expected": [ "G", "A", "B", "C", "D", "E", "F#" ]
+        },
+        {
+          "description": "Major scale with flats",
+          "property": "pitches",
+          "input": {
+            "tonic": "F",
+            "intervals": "MMmMMMm"
+          },
+          "expected": [ "F", "G", "A", "Bb", "C", "D", "E" ]
+        },
+        {
+          "description": "Minor scale with sharps",
+          "property": "pitches",
+          "input": {
+            "tonic": "f#",
+            "intervals": "MmMMmMM"
+          },
+          "expected": [ "F#", "G#", "A", "B", "C#", "D", "E" ]
+        },
+        {
+          "description": "Minor scale with flats",
+          "property": "pitches",
+          "input": {
+            "tonic": "bb",
+            "intervals": "MmMMmMM"
+          },
+          "expected": [ "Bb", "C", "Db", "Eb", "F", "Gb", "Ab" ]
+        },
+        {
+          "description": "Dorian mode",
+          "property": "pitches",
+          "input": {
+            "tonic": "d",
+            "intervals": "MmMMMmM"
+          },
+          "expected": [ "D", "E", "F", "G", "A", "B", "C" ]
+        },
+        {
+          "description": "Mixolydian mode",
+          "property": "pitches",
+          "input": {
+            "tonic": "Eb",
+            "intervals": "MMmMMmM"
+          },
+          "expected": [ "Eb", "F", "G", "Ab", "Bb", "C", "Db" ]
+        },
+        {
+          "description": "Lydian mode",
+          "property": "pitches",
+          "input": {
+            "tonic": "a",
+            "intervals": "MMMmMMm"
+          },
+          "expected": [ "A", "B", "C#", "D#", "E", "F#", "G#" ]
+        },
+        {
+          "description": "Phrygian mode",
+          "property": "pitches",
+          "input": {
+            "tonic": "e",
+            "intervals": "mMMMmMM"
+          },
+          "expected": [ "E", "F", "G", "A", "B", "C", "D" ]
+        },
+        {
+          "description": "Locrian mode",
+          "property": "pitches",
+          "input": {
+            "tonic": "g",
+            "intervals": "mMMmMMM"
+          },
+          "expected": [ "G", "Ab", "Bb", "C", "Db", "Eb", "F" ]
+        },
+        {
+          "comments": [
+            "Note that this case introduces the accidental interval (A)"
+          ],
+          "description": "Harmonic minor",
+          "property": "pitches",
+          "input": {
+            "tonic": "d",
+            "intervals": "MmMMmAm"
+          },
+          "expected": [ "D", "E", "F", "G", "A", "Bb", "Db" ]
+        },
+        {
+          "description": "Octatonic",
+          "property": "pitches",
+          "input": {
+            "tonic": "C",
+            "intervals": "MmMmMmMm"
+          },
+          "expected": [ "C", "D", "D#", "F", "F#", "G#", "A", "B" ]
+        },
+        {
+          "description": "Hexatonic",
+          "property": "pitches",
+          "input": {
+            "tonic": "Db",
+            "intervals": "MMMMMM"
+          },
+          "expected": [ "Db", "Eb", "F", "G", "A", "B" ]
+        },
+        {
+          "description": "Pentatonic",
+          "property": "pitches",
+          "input": {
+            "tonic": "A",
+            "intervals": "MMAMA"
+          },
+          "expected": [ "A", "B", "C#", "E", "F#" ]
+        },
+        {
+          "description": "Enigmatic",
+          "property": "pitches",
+          "input": {
+            "tonic": "G",
+            "intervals": "mAMMMmm"
+          },
+          "expected": [ "G", "G#", "B", "C#", "D#", "F", "F#" ]
+        }
+      ]
+    }
+  ]
+}

data/problem-specifications/old-schema.json

@@ -0,0 +1,137 @@
+{
+   "comments":
+   [ " This is a JSON Schema for 'canonical-data.json' files.     "
+   , "                                                            "
+   , " It enforces just a general structure for all exercises,    "
+   , " without specifying how the test data should be organized   "
+   , " for each type of test. We do this to keep generality and   "
+   , " allow support for tests that do not fit well in the        "
+   , " 'function (input) == output' structure, like property      "
+   , " tests.                                                     "
+   , "                                                            "
+   , " The only thing enforced regarding how test data should be  "
+   , " structured is the error encoding, because it was agreed    "
+   , " and it doesn't restrict flexibility in a significant way.  "
+   , "                                                            "
+   , " Standardized property names may help when automatically    "
+   , " deriving JSON parsers in some languages, so we followed    "
+   , " a few conventions from the 'Google JSON Style Guide'.      "
+   , "                                                            "
+   , " Additionally, this schema strictly enforces letters, in    "
+   , " lowerCamelCase, for naming the 'property' being tested. We "
+   , " expect this regularity will allow an easier automatic      "
+   , " generation of function's names in test generators,         "
+   , " slightly reducing the amount of manually generated code.   "
+   ],
+
+   "$schema": "http://json-schema.org/draft-04/schema#",
+
+   "self": { "vendor" : "io.exercism"
+           , "name"   : "canonical-data"
+           , "format" : "jsonschema"
+           , "version": "1-0-0"
+           },
+
+   "$ref": "#/definitions/canonicalData",
+
+   "definitions":{
+
+      "canonicalData":
+          { "description": "This is the top-level file structure"
+          , "type"       : "object"
+          , "required"   : ["exercise" , "version", "cases"]
+          , "properties" :
+                { "exercise" : { "$ref": "#/definitions/exercise"  }
+                , "version"  : { "$ref": "#/definitions/version"   }
+                , "comments" : { "$ref": "#/definitions/comments"  }
+                , "cases"    : { "$ref": "#/definitions/testGroup" }
+                }
+          , "additionalProperties": false
+          },
+
+      "exercise":
+          { "description": "Exercise's slug (kebab-case)"
+          , "type"       : "string"
+          , "pattern"    : "^[a-z]+(-[a-z]+)*$"
+          },
+
+      "version" :
+          { "description" : "Semantic versioning: MAJOR.MINOR.PATCH"
+          , "type"        : "string"
+          , "pattern"     : "^(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){2}$"
+          },
+
+      "comments":
+          { "description": "An array of strings to fake multi-line comments"
+          , "type"       : "array"
+          , "items"      : { "type": "string" }
+          , "minItems"   : 1
+          },
+
+      "testGroup":
+          { "description": "An array of labeled test items"
+          , "type"       : "array"
+          , "items"      : { "$ref": "#/definitions/labeledTestItem" }
+          , "minItems"   : 1
+          },
+
+      "labeledTestItem":
+          { "description": "A single test or group of tests with a description"
+          , "oneOf": [ { "$ref": "#/definitions/labeledTest"      }
+                     , { "$ref": "#/definitions/labeledTestGroup" }
+                     ]
+          },
+
+      "labeledTest":
+          { "description": "A single test with a description"
+          , "type"       : "object"
+          , "required"   : ["description", "property"]
+          , "properties" :
+                { "description": { "$ref": "#/definitions/description" }
+                , "comments"   : { "$ref": "#/definitions/comments"    }
+                , "property"   : { "$ref": "#/definitions/property"    }
+                , "expected"   : { "$ref": "#/definitions/expected"    }
+                }
+          },
+
+      "labeledTestGroup":
+          { "description": "A group of tests with a description"
+          , "type"       : "object"
+          , "required"   : ["description", "cases"]
+          , "properties" :
+                { "description": { "$ref": "#/definitions/description" }
+                , "comments"   : { "$ref": "#/definitions/comments"    }
+                , "cases"      : { "$ref": "#/definitions/testGroup"   }
+                }
+          , "additionalProperties": false
+          },
+
+      "description":
+          { "description": "A short, clear, one-line description"
+          , "type"       : "string"
+          },
+
+      "property":
+          { "description": "A letters-only, lowerCamelCase property name"
+          , "type"       : "string"
+          , "pattern"    : "^[a-z]+([A-Z][a-z]+)*[A-Z]?$"
+          },
+
+      "expected":
+          { "description": "The expected return value of a test case"
+          , "properties":
+               { "error": { "$ref": "#/definitions/error" }
+               }
+          , "dependencies":
+               { "error": { "maxProperties": 1 }
+               }
+          },
+
+      "error":
+          { "description": "A message describing an error condition"
+          , "type"       : "string"
+          }
+
+    }
+
+}