Merge pull request #76 from exercism/static-readmes

Use static exercise README if it is present
exercism · Jul 16, 2017 · 58b942a · 58b942a
2 parents 0d6e66c + 755ff7f
commit 58b942a
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/fixtures/tracks/fake/exercises/two/README.md b/fixtures/tracks/fake/exercises/two/README.md
@@ -0,0 +1 @@
+custom readme for 'two'
diff --git a/lib/trackler/implementation.rb b/lib/trackler/implementation.rb
@@ -48,7 +48,7 @@ def zip
     end
 
     def readme
-      @readme ||= assemble_readme
+      @readme ||= static_readme || assemble_readme
     end
 
     def git_url
@@ -84,6 +84,11 @@ def exercise_dir
       File.join('exercises', slug)
     end
 
+    def static_readme
+      path = File.join(implementation_dir, 'README.md')
+      return File.read(path) if File.exist?(path)
+    end
+
     def assemble_readme
       <<-README
 # #{name}

diff --git a/test/trackler/implementation_test.rb b/test/trackler/implementation_test.rb
@@ -130,6 +130,13 @@ def test_language
     assert_equal expected_language, implementation.language
   end
 
+  def test_prefer_static_readme_if_present
+    track = Trackler::Track.new('fake', FIXTURE_PATH)
+    specification = Trackler::Specification.new('two', FIXTURE_PATH)
+    implementation = Trackler::Implementation.new(track, specification)
+    assert_equal "custom readme for 'two'\n", implementation.readme
+  end
+
   #### DEPRECATION TESTS: HINTS ####
   # These can be removed when all tracks have renamed their
   # HINTS.md files to .meta/hints.md