trackler 2.1.0.48 → 2.1.0.49

data/{common → problem-specifications}/CONTRIBUTING.md

@@ -16,7 +16,7 @@ We are grateful for any help in making Exercism better!
 This guide covers several common scenarios pertaining to **improving the language tracks**
 themselves. There are other guides about contributing to other parts of the Exercism ecosystem.
 
-* [The Command-Line Client](https://github.com/exercism/cli/blob/master/CONTRIBUTING.md)
+* [The Command-Line Client](https://github.com/exercism/cli/blob/master/README.md)
 * [The Website](https://github.com/exercism/exercism.io/blob/master/CONTRIBUTING.md)
 * [The Exercises API](https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md) (used by both the command-line client and the website)
 
@@ -122,7 +122,7 @@ are used to hand-craft a test suite generator, allowing us to quickly regenerate
 test suites when edge cases or errors are discovered.
 
 The generic problem descriptions live in the `exercises` folder in this repository
-([exercism/x-common](https://github.com/exercism/x-common)).
+([exercism/problem-specifications](https://github.com/exercism/problem-specifications)).
 
 ## Updating an Exercise Test Suite
 
@@ -183,7 +183,7 @@ test suite](#updating-an-exercise-test-suite).
 #### Changing Inputs and Outputs
 
 If you want to add a new test or change some inputs or outputs, then the change
-needs to be made in the [exercism/x-common repository](https://github.com/exercism/x-common),
+needs to be made in the [exercism/problem-specifications repository](https://github.com/exercism/problem-specifications),
 not directly to the test suite itself.
 
 Find the JSON file for the problem in question. For example, if you want to change
@@ -224,7 +224,7 @@ A problem must have a unique slug. This slug is used as
 * the directory name for the folder that contains the metadata files (in this repository)
 * to identify the exercise in `config.json`
 
-### In exercism/x-common
+### In exercism/problem-specifications
 
 * Create `exercises/<slug>/description.md` and `exercises/<slug>/metadata.yml`.
 * Bonus: `exercises/<slug>/canonical-data.json` with inputs/outputs for the test suite.
@@ -234,8 +234,8 @@ A problem must have a unique slug. This slug is used as
 
 * Do the same as when [porting an
   exercise](#porting-an-exercise-to-another-language-track).
-  Reference the PR in x-common if it hasn't been merged yet,
-  this **must not** be merged until the exercism/x-common PR is merged.
+  Reference the PR in problem-specifications if it hasn't been merged yet,
+  this **must not** be merged until the exercism/problem-specifications PR is merged.
 
 ## Track Anatomy
 
@@ -286,25 +286,7 @@ The example template for a track can be found in the [request-new-language-track
 ## Starting a New Track
 
 If you're interested in adding problems for a language that we don't yet have,
-[email Katrina](mailto:kytrinyx@exercism.io) and she'll set up a new repo for
-that language.
-
-Then you can fork and clone per usual.
-
-In order to launch the track needs:
-
-- At least 10 problems implemented.
-- A handful of people who can check in regularly and provide feedback on solutions.
-- Documentation in `docs/` for how to get started / run the tests
-
-Description of what is required for `docs/` can be found in the [Track Anatomy](#track-anatomy).
-
-Once that is in place, the repository needs to be added as a submodule to
-[exercism/x-api](https://github.com/exercism/x-api/tree/master/tracks), and
-the `"active"` key in `config.json` must be flipped to `true`.
-
-We don't deploy x-api automatically, so it will go live the next time the submodules
-are updated (daily, for the most part).
+open an issue in the https://github.com/exercism/request-new-language-track repository.
 
 ### Beta-Testing a Language Track
 ---
@@ -361,31 +343,11 @@ the reference solution. If the change you're making is backwards-incompatible,
 then please increment the version in both the test suite and the reference
 solution.
 
-### Anatomy of an Exercise
-
-TODO: expand on notes below.
-
-#### README
+Please review the details in [README.md](https://github.com/exercism/problem-specifications#test-data-versioning) and bump the version number accordingly.
 
-TODO
-
-#### Test Suite
-
-TODO
-
-#### Supporting Files
-
-TODO (boilerplate, header files, etc)
-
-#### Reference Solution
-
-The reference solution is named something with `example` or `Example` in the path.
-
-The solution does not need to be particularly great code, it is only used to verify
-that the exercise is coherent.
+### Anatomy of an Exercise
 
-If you change the test suite, then make sure the reference solution is fixed
-to pass the updated tests.
+See the [anatomy of an exercise](https://github.com/exercism/docs/tree/master/maintaining-a-track/anatomy-of-an-exercise.md) in the docs repository.
 
 ### Track configuration file
 
@@ -395,7 +357,6 @@ Important keys are:
 * `problems` - actively served via `exercism fetch`
 * `deprecated` - implemented, but aren't served anymore
 * `foregone` - will not be implemented in the track
-* `ignored` - these directories do not contain problems
 
 The `configlet` tool uses those categories to ensure that
 
@@ -404,8 +365,7 @@ The `configlet` tool uses those categories to ensure that
 3. `foregone` problems are not implemented.
 
 In addition, it will complain about problems that are implemented but are not
-listed in the config under the `problems` key. This is where the `ignored` key
-is useful. Ignored directories don't get flagged as unimplemented problems.
+listed in the config under the `problems` key.
 
 A problem might be foregone for a number of reasons, typically because it's a
 bad exercise for the language.

data/{common → problem-specifications}/README.md

@@ -1,10 +1,10 @@
-# x-Common
+# problem-specifications
 
 Shared metadata for Exercism exercises.
 
 ## Contributing Guide
 
-Please see the [contributing guide](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md)
+Please see the [contributing guide](https://github.com/exercism/problem-specifications/blob/master/CONTRIBUTING.md)
 
 ## Problem metadata
 
@@ -183,10 +183,3 @@ Run for single exercise:
 npm test-one exercises/<exercise>/canonical-data.json
 ```
 Replace `<exercise>` by the name of exercise which you want to check.
-
-
-## License
-
-The MIT License (MIT)
-
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com

data/{common → problem-specifications}/bin/transfer_blurb_to_description.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-# This is a temporary file which exists to support the x-common issue #767
-# [Make description.md self contained.](# https://github.com/exercism/x-common/issues/767)
+# This is a temporary file which exists to support the problem-specifications issue #767
+# [Make description.md self contained.](# https://github.com/exercism/problem-specifications/issues/767)
 #
 # The exercise description given in description.md should be complete and self
 # contained, and not require the addition of the blurb to make sense.

data/{common → problem-specifications}/exercises/binary-search/canonical-data.json

@@ -6,14 +6,14 @@
     "It should be replaced with the respective expression that is idiomatic",
     "for the language that implements the tests.",
 
-    "Following https://github.com/exercism/x-common/issues/234 the exercise",
+    "Following https://github.com/exercism/problem-specifications/issues/234 the exercise",
     "should NOT include checking whether the array is sorted as it defeats",
     "the point of the binary search.",
 
     "The exercise should utilize an array-like (i.e. constant-time indexed)",
     "data structure and not a linked list. If something like an array is not",
     "usually used in the language the problem should not be implemented.",
-    "See https://github.com/exercism/x-common/issues/244 for details."
+    "See https://github.com/exercism/problem-specifications/issues/244 for details."
   ],
   "cases": [
     {

data/{common → problem-specifications}/exercises/binary/.deprecated

@@ -1,3 +1,3 @@
 **NOTE: This exercise has been deprecated**
 Your track should implement "all-your-base" instead.
-https://github.com/exercism/x-common/issues/279
+https://github.com/exercism/problem-specifications/issues/279

data/{common → problem-specifications}/exercises/collatz-conjecture/canonical-data.json

@@ -1,6 +1,6 @@
 {
   "exercise": "collatz-conjecture",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "cases": [
     {
       "description": "zero steps for one",
@@ -33,7 +33,7 @@
       "expected": { "error": "Only positive numbers are allowed" }
     },
     {
-      "description": "negative value is an error ",
+      "description": "negative value is an error",
       "property": "steps",
       "number": -15,
       "expected": { "error": "Only positive numbers are allowed" }

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

@@ -0,0 +1,270 @@
+{
+  "exercise": "complex-numbers",
+  "version": "1.0.0",
+  "comments": [
+    " The canonical data assumes mathematically correct real   ",
+    " numbers. The testsuites should consider rounding errors  ",
+    " instead of testing for exact values for any non-integer  ",
+    " tests.                                                   ",
+    " Complex numbers z are represented as arrays [x, y] so    ",
+    " that z = x + i * y.                                      ",
+    " Pi is represented as a string \"pi\", euler's number is  ",
+    " represented as \"e\".                                    "
+  ],
+  "cases": [
+    {
+      "description": "Imaginary unit",
+      "property": "mul",
+      "z1": [0, 1],
+      "z2": [0, 1],
+      "expected": [-1, 0]
+    },
+    {
+      "description": "Arithmetic",
+      "cases": [
+        {
+          "description": "Addition",
+          "cases": [
+            {
+              "description": "Add purely real numbers",
+              "property": "add",
+              "z1": [1, 0],
+              "z2": [2, 0],
+              "expected": [3, 0]
+            },
+            {
+              "description": "Add purely imaginary numbers",
+              "property": "add",
+              "z1": [0, 1],
+              "z2": [0, 2],
+              "expected": [0, 3]
+            },
+            {
+              "description": "Add numbers with real and imaginary part",
+              "property": "add",
+              "z1": [1, 2],
+              "z2": [3, 4],
+              "expected": [4, 6]
+            }
+          ]
+        },
+        {
+          "description": "Subtraction",
+          "cases": [
+            {
+              "description": "Subtract purely real numbers",
+              "property": "sub",
+              "z1": [1, 0],
+              "z2": [2, 0],
+              "expected": [-1, 0]
+            },
+            {
+              "description": "Subtract purely imaginary numbers",
+              "property": "sub",
+              "z1": [0, 1],
+              "z2": [0, 2],
+              "expected": [0, -1]
+            },
+            {
+              "description": "Subtract numbers with real and imaginary part",
+              "property": "sub",
+              "z1": [1, 2],
+              "z2": [3, 4],
+              "expected": [-2, -2]
+            }
+          ]
+        },
+        {
+          "description": "Multiplication",
+          "cases": [
+            {
+              "description": "Multiply purely real numbers",
+              "property": "mul",
+              "z1": [1, 0],
+              "z2": [2, 0],
+              "expected": [2, 0]
+            },
+            {
+              "description": "Multiply purely imaginary numbers",
+              "property": "mul",
+              "z1": [0, 1],
+              "z2": [0, 2],
+              "expected": [-2, 0]
+            },
+            {
+              "description": "Multiply numbers with real and imaginary part",
+              "property": "mul",
+              "z1": [1, 2],
+              "z2": [3, 4],
+              "expected": [-5, 10]
+            }
+          ]
+        },
+        {
+          "description": "Division",
+          "cases": [
+            {
+              "description": "Divide purely real numbers",
+              "property": "div",
+              "z1": [1, 0],
+              "z2": [2, 0],
+              "expected": [0.5, 0]
+            },
+            {
+              "description": "Divide purely imaginary numbers",
+              "property": "div",
+              "z1": [0, 1],
+              "z2": [0, 2],
+              "expected": [0.5, 0]
+            },
+            {
+              "description": "Divide numbers with real and imaginary part",
+              "property": "div",
+              "z1": [1, 2],
+              "z2": [3, 4],
+              "expected": [0.44, 0.08]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "description": "Absolute value",
+      "cases": [
+        {
+          "description": "Absolute value of a positive purely real number",
+          "property": "abs",
+          "input": [5, 0],
+          "expected": 5
+        },
+        {
+          "description": "Absolute value of a negative purely real number",
+          "property": "abs",
+          "input": [-5, 0],
+          "expected": 5
+        },
+        {
+          "description": "Absolute value of a purely imaginary number with positive imaginary part",
+          "property": "abs",
+          "input": [0, 5],
+          "expected": 5
+        },
+        {
+          "description": "Absolute value of a purely imaginary number with negative imaginary part",
+          "property": "abs",
+          "input": [0, -5],
+          "expected": 5
+        },
+        {
+          "description": "Absolute value of a number with real and imaginary part",
+          "property": "abs",
+          "input": [3, 4],
+          "expected": 5
+        }
+      ]
+    },
+    {
+      "description": "Complex conjugate",
+      "cases": [
+        {
+          "description": "Conjugate a purely real number",
+          "property": "conjugate",
+          "input": [5, 0],
+          "expected": [5, 0]
+        },
+        {
+          "description": "Conjugate a purely imaginary number",
+          "property": "conjugate",
+          "input": [0, 5],
+          "expected": [0, -5]
+        },
+        {
+          "description": "Conjugate a number with real and imaginary part",
+          "property": "conjugate",
+          "input": [1, 1],
+          "expected": [1, -1]
+        }
+      ]
+    },
+    {
+      "description": "Real part",
+      "cases": [
+        {
+          "description": "Real part of a purely real number",
+          "property": "real",
+          "input": [1, 0],
+          "expected": 1
+        },
+        {
+          "description": "Real part of a purely imaginary number",
+          "property": "real",
+          "input": [0, 1],
+          "expected": 0
+        },
+        {
+          "description": "Real part of a number with real and imaginary part",
+          "property": "real",
+          "input": [1, 2],
+          "expected": 1
+        }
+      ]
+    },
+    {
+      "description": "Imaginary part",
+      "cases": [
+        {
+          "description": "Imaginary part of a purely real number",
+          "property": "imaginary",
+          "input": [1, 0],
+          "expected": 0
+        },
+        {
+          "description": "Imaginary part of a purely imaginary number",
+          "property": "imaginary",
+          "input": [0, 1],
+          "expected": 1
+        },
+        {
+          "description": "Imaginary part of a number with real and imaginary part",
+          "property": "imaginary",
+          "input": [1, 2],
+          "expected": 2
+        }
+      ]
+    },
+    {
+      "description": "Complex exponential function",
+      "comments": [
+        " Defining the exponential function can be optional.       ",
+        " If the language used does not have sine and cosine       ",
+        " functions in the standard library, this will be          ",
+        " significantly more difficult than the rest of the exer-  ",
+        " cise and should probably not be part of the problem.     ",
+        " The recommended implementation uses Euler's formula      ",
+        " exp(ix) = cos(x) + i * sin(x). This is not an ideal sol- ",
+        " ution but works for the purpose of teaching complex      ",
+        " numbers.                                                 "
+      ],
+      "cases": [
+        {
+          "description": "Euler's identity/formula",
+          "property": "exp",
+          "input": [0, "pi"],
+          "expected": [-1, 0]
+        },
+        {
+          "description": "Exponential of 0",
+          "property": "exp",
+          "input": [0, 0],
+          "expected": [1, 0]
+        },
+        {
+          "description": "Exponential of a purely real number",
+          "property": "exp",
+          "input": [1, 0],
+          "expected": ["e", 0]
+        }
+      ]
+    }
+  ]
+}