trackler 2.1.0.46 → 2.1.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99aa3467314af74f350baacb1ffb1152c8975bf4
-  data.tar.gz: 5bdea88b725cba0d5e725efe8c775c49e8384805
+  metadata.gz: abacbba140846c7009970e81e498b44890347f87
+  data.tar.gz: 5e654ab7a1f5089d53b4b3b43769045ad5670417
 SHA512:
-  metadata.gz: 418d4afa86ee86fdfaa7bea540cb02ad939990c57aabbe74ca81341e6a94dc6229380d38010ef17f940c9e4f95f97156b862f7da3413ccd2a971f4e8b67886ab
-  data.tar.gz: 1247e2b9b602cf579781bc1d3b10eda8d9e3272896e142e880feb3b9bbc915c2e9096d92115665380cf0dfef54e2139b002664f4f32fca99b657fb5daed377f0
+  metadata.gz: 8e4ffd2d17ebe5674921d9aa886e492a749f6abd2d50c5d2918ec0188c8f4bf6144adb85391400fedfcb8424ad7e9edf374ff06da2ce5acb4c15d2251532e6cb
+  data.tar.gz: 0647a113a9dc3e90ba82beacb0c8b6696ea20c01d7f38234ace4513230b2ae711034e18d6ea555b2af2c712470e34f3d321f18852006095755455fa2805c0462

data/.gitmodules

@@ -181,3 +181,6 @@
 [submodule "tracks/fortran"]
 	path = tracks/fortran
 	url = https://github.com/exercism/xfortran
+[submodule "tracks/dartlang"]
+	path = tracks/dartlang
+	url = https://github.com/exercism/dartlang

data/fixtures/tracks/fake/docs/STRAY.md

@@ -0,0 +1 @@
+![](/docs/img/test.jpg)

data/lib/trackler/doc_file.rb

@@ -0,0 +1,75 @@
+class DocFile
+  DEFAULT_IMAGE_PATH = "/docs/img"
+
+  def self.find(basename:, track_dir:)
+    dir = File.join(track_dir, "docs")
+
+    [
+      MarkdownFile.new(basename: basename, docs_dir: dir),
+      OrgmodeFile.new(basename: basename, docs_dir: dir),
+    ].detect(&:exist?) || NullFile.new(basename: basename, docs_dir: dir)
+  end
+
+  attr_reader :basename, :dir
+  def initialize(basename:, docs_dir:)
+    @basename = basename
+    @dir = docs_dir
+  end
+
+  def render(image_path: DEFAULT_IMAGE_PATH)
+    body.gsub(img_src, img_dst(image_path))
+  end
+
+  def name
+    "%s.%s" % [basename, extension]
+  end
+
+  def extension
+    "md"
+  end
+
+  def exist?
+    File.exist?(path)
+  end
+
+  private
+
+  def body
+    File.read(path)
+  end
+
+  def path
+    File.join(dir, name)
+  end
+
+  def img_src
+    Regexp.new("]\\(%s" % DEFAULT_IMAGE_PATH)
+  end
+
+  def img_dst(image_path)
+    "](%s" % image_path.gsub(Regexp.new("/$"), "")
+  end
+end
+
+class OrgmodeFile < DocFile
+  def body
+    Orgmode::Parser.new(File.read(path)).to_markdown
+  end
+
+  def extension
+    "org"
+  end
+end
+
+class MarkdownFile < DocFile
+end
+
+class NullFile < DocFile
+  def render(image_path:"")
+    ""
+  end
+
+  def exist?
+    false
+  end
+end

data/lib/trackler/track.rb

@@ -8,7 +8,6 @@ module Trackler
   # Track is a collection of exercises in a given language.
   class Track
     TOPICS = %w(about installation tests learning resources)
-    DEFAULT_IMAGE_PATH = "/docs/img"
 
     Image = Struct.new(:path) do
       def exists?
@@ -88,7 +87,7 @@ module Trackler
       config.fetch('ignore_pattern', 'example')
     end
 
-    def docs(image_path: DEFAULT_IMAGE_PATH)
+    def docs(image_path: DocFile::DEFAULT_IMAGE_PATH)
       OpenStruct.new(docs_by_topic(image_path))
     end
 
@@ -116,19 +115,11 @@ module Trackler
     end
 
     def hints
-      if File.exist?(track_hints_filename)
-        File.read(track_hints_filename)
-      else
-        ""
-      end
+      docfile = DocFile.find(basename: 'EXERCISE_README_INSERT', track_dir: dir).render
     end
 
     private
 
-    def track_hints_filename
-      File.join(dir, 'docs', 'EXERCISE_README_INSERT.md')
-    end
-
     def active_slugs
       (config["exercises"] || []).map { |ex| ex["slug"] }
     end
@@ -156,35 +147,16 @@ module Trackler
       File.join(dir, "config.json")
     end
 
-    def document_contents(topic)
-      filename = document_filename(topic)
-      case filename
-      when /\.md$/
-        File.read(filename)
-      when /\.org$/
-        Orgmode::Parser.new(File.read(filename)).to_markdown
-      else
-        ''
-      end
-    end
-
     def docs_by_topic(image_path)
-      src = Regexp.new("]\\(%s" % DEFAULT_IMAGE_PATH)
-      dst = "](%s" % image_path.gsub(Regexp.new("/$"), "")
       Hash[
         TOPICS.zip(
           TOPICS.map { |topic|
-            document_contents(topic).gsub(src, dst)
+            DocFile.find(basename: topic.upcase, track_dir: dir).render(image_path: image_path)
           }
         )
       ]
     end
 
-    def document_filename(topic)
-      path = File.join(dir, "docs", topic.upcase)
-      Dir.glob("%s.*" % path).sort.first
-    end
-
     def svg_icon
       @svg_icon ||= Image.new(File.join(dir, "img/icon.svg"))
     end

data/lib/trackler/version.rb

@@ -1,3 +1,3 @@
 module Trackler
-  VERSION = "2.1.0.46"
+  VERSION = "2.1.0.47"
 end

data/tracks/dartlang/.git

@@ -0,0 +1 @@
+gitdir: ../../.git/modules/tracks/dartlang

data/tracks/dartlang/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+Thank you for this PR! :tada:
+
+When we review your submission we will check the following:
+
+- [ ] TODO: Update this list based on the appropriate checks for this specific track
+- [ ] No trailing whitespace nor extraneous blank lines
+- [ ] Proper indentation and consistent code formatting
+- [ ] Free from spelling and grammatical errors
+- [ ] Readable code style
+- [ ] Exemplifies the idioms of {{LANGUAGE}}
+- [ ] Absence of non-standard libraries
+- [ ] No extraneous configuration files
+- [ ] Free of development/debug artifacts such as `puts`, `console.log`, or `debugger` calls
+
+If you are submitting a new exercise, we will compare your submission to the common guidelines set out for the exercise in [exercism/problem-specifications](https://github.com/exercism/problem-specifications/tree/master/exercises).
+
+Your submission will be run through a series of automated tests and checks. The outcome will be displayed below. In addition to the test suite, the following issues are automatically checked:
+
+- TODO: Update this list based on the linting available for this specific track
+- No trailing whitespace nor extraneous blank lines
+- Proper indentation and consistent code formatting
+- Spelling and grammatical errors
+- Compiler and deprecation warnings

data/tracks/dartlang/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+.DS_Store
+bin/configlet
+bin/configlet.exe

data/tracks/dartlang/.travis.yml

@@ -0,0 +1,5 @@
+language: bash
+
+script:
+  - bin/fetch-configlet
+  - bin/configlet .

data/tracks/dartlang/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Exercism, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/tracks/dartlang/README.md

@@ -0,0 +1,72 @@
+# Exercism Dart Track
+
+![build status](https://travis-ci.org/exercism/{{SLUG}}.svg?branch=master)
+
+Exercism exercises in Dart.
+
+## Setup
+
+The simplest way to install Dart is ...
+
+## Contributing
+
+Thank you so much for contributing! :tada:
+
+Please read about how to [get involved in a track](https://github.com/exercism/docs/tree/master/contributing-to-language-tracks). Be sure to read the Exercism [Code of Conduct](https://github.com/exercism/exercism.io/blob/master/CODE_OF_CONDUCT.md).
+
+We welcome pull requests of all kinds. No contribution is too small.
+
+We encourage contributions that provide fixes and improvements to existing exercises. Please note that this track's exercises must conform to the standards determined in the [exercism/problem-specifications](https://github.com/exercism/problem-specifications) repo. Changes to the tests or documentation of a common exercise will often warrant a PR in that repo before it can be incorporated into this track's exercises. If you're unsure, then go ahead and open a GitHub issue, and we'll discuss the change.
+
+## Exercise Tests ##
+
+At the most basic level, Exercism is all about the tests. They drive the user's implementation forward and tell them when the exercise is complete.
+
+The utmost care and attention should be used when adding or making changes to the tests for an exercise. When implementing an exercise test suite, we want to provide a good user experience for the people writing a solution to the exercise. People should not be confused or overwhelmed.
+
+We simulate Test-Driven Development (TDD) by implementing the tests in order of increasing complexity. We try to ensure that each test either
+
+- helps triangulate a solution to be more generic, or
+- requires new functionality incrementally.
+
+Test files should use the following format:
+
+```
+# include the body of an example test
+```
+
+## Submitting a Pull Request ##
+
+Please keep the following in mind:
+
+- Pull requests should be focused on a single exercise, issue, or change.
+
+- We welcome changes to code style, and wording. Please open a separate PR for these changes if possible.
+
+- Please open an issue before creating a PR that makes significant (breaking) changes to an existing exercise or makes changes across many exercises. It is best to discuss these changes before doing the work. Discussions related to exercises that are not track specific can be found in [exercism/discussions](https://github.com/exercism/discussions/issues).
+
+- Follow the coding standards for Dart. (If there is a formatter for the track's language, add instructions for using it here.)
+
+- Watch out for trailing spaces, extra blank lines, and spaces in blank lines.
+
+- All the tests for Dart exercises can be run from the top level of the repo with ... Please run this command before submitting your PR.
+
+## Contributing a New Exercise ##
+
+- All Exercism exercises must be defined in [problem-specifications](https://github.com/exercism/problem-specifications/tree/master/exercises) before they are implemented for a specific track. Please submit a PR there if your exercise is new to Exercism.
+
+- Please make sure the new exercise conforms to specifications in the [exercism/problem-specifications](https://github.com/exercism/problem-specifications) repo.
+
+- Each exercise must stand on its own. Do not reference files outside the exercise directory. They will not be included when the user fetches the exercise.
+
+- Exercises should use only the Dart core libraries.
+
+- Please do not add a README or README.md file to the exercise directory. The READMEs are constructed using shared metadata, which lives in the
+[exercism/problem-specifications](https://github.com/exercism/problem-specifications) repository. Further explanation can be found in [fixing-exercise-readmes](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/exercise-readmes.md)
+
+- Each exercise should have a test suite, an example solution, a template file for the real implementation and ... (anything else that needs to go with each exercise for this track). The CI build expects files to be named using the following convention: (describe the Dart convention for naming the various files that make up an exercise).
+
+- Please do not commit any configuration files or directories inside the exercise other than ...
+
+- Be sure to add it to the appropriate place in the `config.json` file. Also, please run `bin/fetch-configlet && bin/configlet` to ensure the exercise is configured correctly.
+

data/tracks/dartlang/bin/fetch-configlet

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+LATEST=https://github.com/exercism/configlet/releases/latest
+
+OS=$(
+case $(uname) in
+    (Darwin*)
+        echo "mac";;
+    (Linux*)
+        echo "linux";;
+    (Windows*)
+        echo "windows";;
+    (*)
+        echo "linux";;
+esac)
+
+ARCH=$(
+case $(uname -m) in
+    (*64*)
+        echo 64bit;;
+    (*686*)
+        echo 32bit;;
+    (*386*)
+        echo 32bit;;
+    (*)
+        echo 64bit;;
+esac)
+
+VERSION="$(curl --head --silent $LATEST | awk -v FS=/ '/Location:/{print $NF}' | tr -d '\r')"
+URL=https://github.com/exercism/configlet/releases/download/$VERSION/configlet-$OS-${ARCH}.tgz
+
+curl -s --location $URL | tar xz -C bin/

data/tracks/dartlang/config.json

@@ -0,0 +1,16 @@
+{
+  "slug": "dartlang",
+  "language": "Dart",
+  "repository": "https://github.com/exercism/xdartlang",
+  "active": false,
+  "test_pattern": "TODO",
+  "exercises": [
+
+  ],
+  "deprecated": [
+
+  ],
+  "foregone": [
+
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trackler
 version: !ruby/object:Gem::Version
-  version: 2.1.0.46
+  version: 2.1.0.47
 platform: ruby
 authors:
 - Katrina Owen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -480,6 +480,7 @@ files:
 - fixtures/tracks/fake/docs/INSTALLATION.org
 - fixtures/tracks/fake/docs/LEARNING.org
 - fixtures/tracks/fake/docs/RESOURCES.org
+- fixtures/tracks/fake/docs/STRAY.md
 - fixtures/tracks/fake/docs/TESTS.md
 - fixtures/tracks/fake/docs/img/test.jpg
 - fixtures/tracks/fake/docs/img/test.png
@@ -528,6 +529,7 @@ files:
 - fixtures/tracks/vehicles/config.json
 - lib/trackler.rb
 - lib/trackler/description.rb
+- lib/trackler/doc_file.rb
 - lib/trackler/file_bundle.rb
 - lib/trackler/guaranteed_file.rb
 - lib/trackler/implementation.rb
@@ -1983,6 +1985,21 @@ files:
 - tracks/csharp/generators/generate.ps1
 - tracks/csharp/generators/generate.sh
 - tracks/csharp/img/icon.png
+- tracks/dartlang/.git
+- tracks/dartlang/.github/PULL_REQUEST_TEMPLATE.md
+- tracks/dartlang/.gitignore
+- tracks/dartlang/.travis.yml
+- tracks/dartlang/LICENSE
+- tracks/dartlang/README.md
+- tracks/dartlang/bin/fetch-configlet
+- tracks/dartlang/config.json
+- tracks/dartlang/docs/ABOUT.md
+- tracks/dartlang/docs/EXERCISE_README_INSERT.md
+- tracks/dartlang/docs/INSTALLATION.md
+- tracks/dartlang/docs/LEARNING.md
+- tracks/dartlang/docs/RESOURCES.md
+- tracks/dartlang/docs/TESTS.md
+- tracks/dartlang/img/.keep
 - tracks/delphi/.git
 - tracks/delphi/.github/stale.yml
 - tracks/delphi/.gitignore