trackler 1.0.0 → 1.0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b23dd6d96d001e37102ef1f796528b111256b51
-  data.tar.gz: bf6b9e323fcaaa809ee4be715908cc058ccc474a
+  metadata.gz: a340d68c1e7151758d18f1d5374de489565c7243
+  data.tar.gz: 97d055586fb1a486a35f63c0a3d56bf0d31efb6e
 SHA512:
-  metadata.gz: 381862c5404053b02a6402aeefe0de75fb886144cade20b4b8acc058e820947326cb6b384039a5c39fe1d55d12a6f5c7a17a0f8eddf4956da9bcd95bd9603e8a
-  data.tar.gz: 43cf11d486b318fac0b6502e628cf41f955d160c602aa08bb4a57dae8a2480eb03b8fc5f9c2222593e73794a056e63d4b26b73b2fcbc393dd0692d6f51b58e8c
+  metadata.gz: 787c7c324f3537c1f8ac7ff1549421ad78d63ad9f258bbecb8689fc13c3da4ee8de73c21835280ac9359bdde8f8777bc270dff03fee532c62576e41e243bf45f
+  data.tar.gz: 9bc618ceac0fb5d66caf5874e89f9bbbe398edf6e7a19e7f9de0a26c38fecf2d866020b4a7b2bafb3c8a29e15238cd2e480ff81e44ca1babfa3da8883a4a6a09

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.5
+script:
+  - bundle install
+  - rake test

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change log
 
-The Trackler gem follows [semantic versioning](http://semver.org/).
+The Trackler gem almost follows [semantic versioning](http://semver.org/).
+
+We've added a forth level, which tracks content. It gets bumped each time we
+update the submodules.
+
+      1   .   0   .   0   .   0
+    MAJOR   MINOR   PATCH   CONTENT
+
+The changelog will not be updated for content updates.
 
 ----------------
 

data/README.md

@@ -74,6 +74,16 @@ See CONTRIBUTING.md for details.
 
 This is an extraction from https://github.com/exercism/x-api.
 
+## Publishing
+
+Owners of the gem can publish it to rubygems like this:
+
+```
+gem build trackler.gemspec
+gem install --local trackler-$VERSION.gem
+gem push trackler-$VERSION.gem
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/common/CONTRIBUTING.md

@@ -33,7 +33,9 @@ themselves. There are other guides about contributing to other parts of the Exer
 * [Implementing a Completely New Exercise](#implementing-a-completely-new-exercise)
 * [Improving Consistency By Extracting Shared Test Data](#improving-consistency-by-extracting-shared-test-data)
 * [Writing a New Test Suite Generator](#writing-a-new-test-suite-generator)
+* [Track Anatomy](#track-anatomy)
 * [Starting a New Track](#starting-a-new-track)
+    * [Beta-Testing a Language Track](#beta-testing-a-language-track)
 * [Maintaining a Track](#maintaining-a-track)
 * [Useful Tidbits](#useful-tidbits)
     * [Exercise Versioning](#exercise-versioning)
@@ -193,7 +195,7 @@ test suite](#updating-an-exercise-test-suite).
 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),
 not directly to the test suite itself.
-  
+
 Find the JSON file for the problem in question. For example, if you want to change
 the Clock problem, then look for `exercises/clock/canonical-data.json`.
 
@@ -382,6 +384,52 @@ TODO: elaborate.
 
 TODO: elaborate.
 
+## Track Anatomy
+
+Each track should have the following structure:
+
+```bash
+├── .gitignore
+├── .travis.yml
+├── LICENSE
+├── README.md
+├── SETUP.md
+├── bin
+│   └── fetch-configlet
+├── config.json
+├── docs
+│   ├── ABOUT.md
+│   ├── INSTALLATION.md
+│   ├── LEARNING.md
+│   ├── RESOURCES.md
+│   └── TESTS.md
+└── exercises
+    └── hello-world
+        ├── hello-world_example.file
+        ├── hello-world.file
+        └── hello-world_test.file
+```
+
+The example template for a track can be found at [x-template](https://github.com/exercism/x-template).
+
+* `LICENSE` - The MIT License (MIT)
+* `README.md` - a thorough explanation of how to contribute to the track.
+* `SETUP.md` - this should contain any track specific, problem agnostic information that will be included in the README.md of every exercise when fetched. Include information on how to run tests, how to get help, etc.
+* `bin` - scripts and other files related to running the track's tests, etc.
+* `config.json` - the track-level configuration. It contains configuration for which exercises (and in which order) are a part of the track, which exercises are deprecated, the track id, name of the language, and the location of the repository. Optionally, it may include a regex to recognize what files are part of the test suite (usually `/test/i`, but sometimes `/spec/i` or other things). If the test pattern is not included, then `/test/i` is assumed.
+* `docs` - the documentation for the track.These files are served to the exercism.io help site via the x-api. It should contain at minimum:
+
+    - `INSTALLATION.md` - about how to get the track's language set up locally.
+    - `TESTS.md` - how to run the tests for the track's individual exercises.
+
+    Some nice to haves:
+
+    - `ABOUT.md` - a short, friendly blurb about the track's language. What types of problems does it solve really well? What is it typically used for?
+    - `LEARNING.md` - a few notes about where people might want to go to learn the track's language from scratch. These are the the resources you need only when first getting up to speed with a language (tutorials, blog posts, etc.).
+    - `RESOURCES.md` - references and other useful resources. These resources are those that would commonly be used by a developer on an ongoing basis (core language docs, api docs, etc.).
+
+* `exercises` - all exercises for the track should live in subdirectories of this directory. Each exercise should have a test file, an example file that should pass all tests, and a template file that is a stub to help the user get started with the exercise. The example file should be used for the CI build.
+
 ## Starting a New Track
 
 If you're interested in adding problems for a language that we don't yet have,
@@ -396,7 +444,7 @@ In order to launch the track needs:
 - 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 [x-api CONTRIBUTING guide](https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md#track-anatomy)
+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

data/common/exercises/alphametics/canonical-data.json

@@ -12,16 +12,6 @@
                 "puzzle": "SEND + MORE == MONEY",
                 "expected": { "S": 9, "E": 5, "N": 6, "D": 7, "M": 1, "O": 0, "R": 8, "Y": 2 }
             },
-            {
-                "description": "solve puzzle with multiplication",
-                "puzzle": "IF * DR == DORI",
-                "expected": { "I": 8, "F": 2, "D": 3, "R": 9, "O": 1 }
-            },
-            {
-                "description": "solve puzzle with exponents",
-                "puzzle": "PI * R ^ 2 == AREA",
-                "expected": { "P": 9, "I": 6, "R": 7, "A": 4, "E": 0 }
-            },
             {
                 "description": "solution must have unique value for each letter",
                 "puzzle": "A == B",
@@ -31,6 +21,16 @@
                 "description": "leading zero solution is invalid",
                 "puzzle": "ACA + DD == BD",
                 "expected": null
+            },
+            {
+                "description": "solve puzzle with four words",
+                "puzzle": "HE + SEES + THE == LIGHT",
+                "expected": { "E": 4, "G": 2, "H": 5, "I": 0, "L": 1, "S": 9, "T": 7 }
+            },
+            {
+                "description": "solve puzzle with many words",
+                "puzzle": "AND + A + STRONG + OFFENSE + AS + A + GOOD = DEFENSE",
+                "expected": { "A": 5, "D": 3, "E": 4, "F": 7, "G": 8, "N": 0, "O": 2, "R": 1, "S": 6, "T": 9 }
             }
         ]
     }

data/common/exercises/markdown/canonical-data.json

@@ -21,17 +21,17 @@
     {
       "description": "parsing italics",
       "input": "_This will be italic_",
-      "expected": "<p><i>This will be italic</i></p>"
+      "expected": "<p><em>This will be italic</em></p>"
     },
     {
       "description": "parsing bold text",
       "input": "__This will be bold__",
-      "expected": "<p><em>This will be bold</em></p>"
+      "expected": "<p><strong>This will be bold</strong></p>"
     },
     {
       "description": "mixed normal, italics and bold text",
       "input": "This will _be_ __mixed__",
-      "expected": "<p>This will <i>be</i> <em>mixed</em></p>"
+      "expected": "<p>This will <em>be</em> <strong>mixed</strong></p>"
     },
     {
       "description": "with h1 header level",
@@ -56,7 +56,7 @@
     {
       "description": "With a little bit of everything",
       "input": "# Header!\n* __Bold Item__\n* _Italic Item_",
-      "expected": "<h1>Header!</h1><ul><li><em>Bold Item</em></li><li><i>Italic Item</i></li></ul>"
+      "expected": "<h1>Header!</h1><ul><li><strong>Bold Item</strong></li><li><em>Italic Item</em></li></ul>"
     }
   ]
 }

data/common/exercises/pov/canonical-data.json

@@ -0,0 +1,356 @@
+{
+  "from_pov": {
+    "description": [
+      "Reroot a tree so that its root is the specified node.",
+      "In this way, the tree is presented from the point of view of the specified node.",
+      "The input trees used here are those in the `trees` section of this file.",
+      "",
+      "If appropriate for your track, you may test that the input tree is not modified.",
+      "",
+      "Note that when rerooting upon a target node that has both parents and children,",
+      "it does not matter whether the former parent comes before or after the former children.",
+      "Please account for this when checking correctness of the resulting trees.",
+      "One suggested method is to only check two things:",
+      "1) The root of the returned tree is the root that was passed in to from_pov.",
+      "2) The sorted edge list of the returned tree is the same as the sorted edge list of the expected tree."
+    ],
+    "cases": [
+      {
+        "description": "Results in the same tree if the input tree is a singleton",
+        "tree": "singleton",
+        "from": "x",
+        "expected": {
+          "label": "x"
+        }
+      },
+      {
+        "description": "Can reroot a tree with a parent and one sibling",
+        "tree": "simple",
+        "from": "x",
+        "expected": {
+          "label": "x",
+          "children": [
+            {
+              "label": "parent",
+              "children": [
+                {
+                  "label": "sibling"
+                }
+              ]
+            }
+          ]
+        }
+      },
+      {
+        "description": "Can reroot a tree with a parent and many siblings",
+        "tree": "large_flat",
+        "from": "x",
+        "expected": {
+          "label": "x",
+          "children": [
+            {
+              "label": "parent",
+              "children": [
+                {
+                  "label": "a"
+                },
+                {
+                  "label": "b"
+                },
+                {
+                  "label": "c"
+                }
+              ]
+            }
+          ]
+        }
+      },
+      {
+        "description": "Can reroot a tree with new root deeply nested in tree",
+        "tree": "deeply_nested",
+        "from": "x",
+        "expected": {
+          "label": "x",
+          "children": [
+            {
+              "label": "level-3",
+              "children": [
+                {
+                  "label": "level-2",
+                  "children": [
+                    {
+                      "label": "level-1",
+                      "children": [
+                        {
+                          "label": "level-0"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      },
+      {
+        "description": "Moves children of the new root to same level as former parent",
+        "tree": "kids",
+        "from": "x",
+        "expected": {
+          "label": "x",
+          "children": [
+            {
+              "label": "kid-0"
+            },
+            {
+              "label": "kid-1"
+            },
+            {
+              "label": "parent"
+            }
+          ]
+        }
+      },
+      {
+        "description": "Can reroot a complex tree with cousins",
+        "tree": "cousins",
+        "from": "x",
+        "expected": {
+          "label": "x",
+          "children": [
+            {
+              "label": "kid-1"
+            },
+            {
+              "label": "kid-0"
+            },
+            {
+              "label": "parent",
+              "children": [
+                {
+                  "label": "sibling-0"
+                },
+                {
+                  "label": "sibling-1"
+                },
+                {
+                  "label": "grandparent",
+                  "children": [
+                    {
+                      "label": "uncle",
+                      "children": [
+                        {
+                          "label": "cousin-0"
+                        },
+                        {
+                          "label": "cousin-1"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      },
+      {
+        "description": "Errors if target does not exist in a singleton tree",
+        "tree": "singleton",
+        "from": "nonexistent",
+        "expected": null
+      },
+      {
+        "description": "Errors if target does not exist in a large tree",
+        "tree": "cousins",
+        "from": "nonexistent",
+        "expected": null
+      }
+    ]
+  },
+  "path_to": {
+    "description": [
+      "Given two nodes, find the path between them.",
+      "A typical implementation would first reroot the tree on one of the two nodes.",
+      "",
+      "If appropriate for your track, you may test that the input tree is not modified.",
+      "",
+      "The trees used here are those in the `trees` section of this file."
+    ],
+    "cases": [
+      {
+        "description": "Can find path to parent",
+        "from": "x",
+        "to": "parent",
+        "tree": "simple",
+        "expected": [
+          "x",
+          "parent"
+        ]
+      },
+      {
+        "description": "Can find path to sibling",
+        "from": "x",
+        "to": "b",
+        "tree": "large_flat",
+        "expected": [
+          "x",
+          "parent",
+          "b"
+        ]
+      },
+      {
+        "description": "Can find path to cousin",
+        "from": "x",
+        "to": "cousin-1",
+        "tree": "cousins",
+        "expected": [
+          "x",
+          "parent",
+          "grandparent",
+          "uncle",
+          "cousin-1"
+        ]
+      },
+      {
+        "description": "Can find path from nodes other than x",
+        "from": "kid-1",
+        "to": "cousin-0",
+        "tree": "cousins",
+        "expected": [
+          "kid-1",
+          "x",
+          "parent",
+          "grandparent",
+          "uncle",
+          "cousin-0"
+        ]
+      },
+      {
+        "description": "Errors if destination does not exist",
+        "from": "x",
+        "to": "nonexistent",
+        "tree": "cousins",
+        "expected": null
+      },
+      {
+        "description": "Errors if source does not exist",
+        "from": "nonexistent",
+        "to": "x",
+        "tree": "cousins",
+        "expected": null
+      }
+    ]
+  },
+  "trees": {
+    "singleton": {
+      "label": "x"
+    },
+    "simple": {
+      "label": "parent",
+      "children": [
+        {
+          "label": "x"
+        },
+        {
+          "label": "sibling"
+        }
+      ]
+    },
+    "large_flat": {
+      "label": "parent",
+      "children": [
+        {
+          "label": "a"
+        },
+        {
+          "label": "x"
+        },
+        {
+          "label": "b"
+        },
+        {
+          "label": "c"
+        }
+      ]
+    },
+    "deeply_nested": {
+      "label": "level-0",
+      "children": [
+        {
+          "label": "level-1",
+          "children": [
+            {
+              "label": "level-2",
+              "children": [
+                {
+                  "label": "level-3",
+                  "children": [
+                    {
+                      "label": "x"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    "kids": {
+      "label": "parent",
+      "children": [
+        {
+          "label": "x",
+          "children": [
+            {
+              "label": "kid-0"
+            },
+            {
+              "label": "kid-1"
+            }
+          ]
+        }
+      ]
+    },
+    "cousins": {
+      "label": "grandparent",
+      "children": [
+        {
+          "label": "parent",
+          "children": [
+            {
+              "label": "x",
+              "children": [
+                {
+                  "label": "kid-0"
+                },
+                {
+                  "label": "kid-1"
+                }
+              ]
+            },
+            {
+              "label": "sibling-0"
+            },
+            {
+              "label": "sibling-1"
+            }
+          ]
+        },
+        {
+          "label": "uncle",
+          "children": [
+            {
+              "label": "cousin-0"
+            },
+            {
+              "label": "cousin-1"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}