trackler 2.1.0.24 → 2.1.0.25

data/lib/trackler/problems.rb

@@ -1,52 +1,7 @@
+require_relative 'specifications'
+
 module Trackler
   # Problems is the collection of problems that we have metadata for.
-  class Problems
-    include Enumerable
-
-    attr_reader :root
-    def initialize(root)
-      @root = root
-    end
-
-    def each
-      active.each do |problem|
-        yield problem
-      end
-    end
-
-    def [](slug)
-      by_slug[slug]
-    end
-
-    # rubocop:disable Style/OpMethod
-    def -(slugs)
-      (by_slug.keys - slugs).sort
-    end
-
-    private
-
-    def active
-      @active ||= all.select(&:active?)
-    end
-
-    def all
-      @all_problems ||= exercise_slugs.map { |slug| Problem.new(slug, root) }
-    end
-
-    def exercise_slugs
-      Dir["%s/common/exercises/*/" % root].map { |path| File.basename(path) }.sort
-    end
-
-    def by_slug
-      @by_slug ||= problem_map
-    end
-
-    def problem_map
-      hash = Hash.new { |_, k| Problem.new(k, root) }
-      active.each do |problem|
-        hash[problem.slug] = problem
-      end
-      hash
-    end
+  class Problems < Trackler::Specifications
   end
 end

data/lib/trackler/specification.rb

@@ -0,0 +1,101 @@
+require 'yaml'
+require_relative 'metadata'
+require_relative 'description'
+require_relative 'null_track'
+
+module Trackler
+  # Specification is a language-independent definition of a problem to solve.
+  class Specification
+    attr_reader :slug, :root, :metadata
+    def initialize(slug, root, track = NullTrack.new)
+      @slug = slug
+      @root = root
+      @file_root = File.join(root, 'common', 'exercises', self.slug)
+      @repo_root = "https://github.com/exercism/x-common/blob/master/exercises/%s/" % self.slug
+
+      @metadata = Metadata.for(specification: self, track: track)
+      self.description_object = Description.for(specification: self, track: track)
+    end
+
+    def exists?
+      description_object.exists? && metadata.exists?
+    end
+
+    def deprecated?
+      @deprecated ||= File.exists?(file_path(deprecation_file_name, @file_root))
+    end
+
+    def active?
+      exists? && !deprecated?
+    end
+
+    def name
+      slug.split('-').map(&:capitalize).join(' ')
+    end
+
+    def description
+      description_object.to_s
+    end
+
+    def source_markdown
+      text = [source, markdown_link(source_url)].reject(&:empty?).join(" ")
+      text.empty? ? text : "## Source\n\n#{text}"
+    end
+
+    def description_url
+      description_object.url
+    end
+
+    def canonical_data_url
+      repo_url(canonical_data_file_name) if File.exists?(file_path(canonical_data_file_name, @file_root))
+    end
+
+    def metadata_url
+      metadata.url
+    end
+
+    def blurb
+      metadata.blurb
+    end
+
+    def source
+      metadata.source
+    end
+
+    def source_url
+      metadata.source_url
+    end
+
+    private
+
+    attr_accessor :description_object
+
+    def canonical_data_file_name
+      "canonical-data.json"
+    end
+
+    def description_file_name
+      "description.md"
+    end
+
+    def metadata_file_name
+      "metadata.yml"
+    end
+
+    def deprecation_file_name
+      ".deprecated"
+    end
+
+    def repo_url(filename)
+      @repo_root + filename
+    end
+
+    def file_path(filename, root = @file_root)
+      File.join(root, filename)
+    end
+
+    def markdown_link(url)
+      url.empty? ? url : format("[%s](%s)", url, url)
+    end
+  end
+end

data/lib/trackler/specifications.rb

@@ -0,0 +1,52 @@
+module Trackler
+  # Specifications is the collection of problems that we have metadata for.
+  class Specifications
+    include Enumerable
+
+    attr_reader :root
+    def initialize(root)
+      @root = root
+    end
+
+    def each
+      active.each do |specification|
+        yield specification
+      end
+    end
+
+    def [](slug)
+      by_slug[slug]
+    end
+
+    # rubocop:disable Style/OpMethod
+    def -(slugs)
+      (by_slug.keys - slugs).sort
+    end
+
+    private
+
+    def active
+      @active ||= all.select(&:active?)
+    end
+
+    def all
+      @all_specifications ||= exercise_slugs.map { |slug| Specification.new(slug, root) }
+    end
+
+    def exercise_slugs
+      Dir["%s/common/exercises/*/" % root].map { |path| File.basename(path) }.sort
+    end
+
+    def by_slug
+      @by_slug ||= specification_map
+    end
+
+    def specification_map
+      hash = Hash.new { |_, k| Specification.new(k, root) }
+      active.each do |specification|
+        hash[specification.slug] = specification
+      end
+      hash
+    end
+  end
+end

data/lib/trackler/track.rb

@@ -68,10 +68,12 @@ module Trackler
       @icon ||= svg_icon.exists? ? svg_icon : png_icon
     end
 
-    %w(language repository).each do |name|
-      define_method name do
-        config[name].to_s.strip
-      end
+    def language
+      config['language'].to_s.strip
+    end
+
+    def repository
+      config['repository'].to_s.strip
     end
 
     def test_pattern

data/lib/trackler/version.rb

@@ -1,3 +1,3 @@
 module Trackler
-  VERSION = "2.1.0.24"
+  VERSION = "2.1.0.25"
 end

data/tracks/bash/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/bash/README.md

@@ -8,11 +8,6 @@ Exercism Exercises in Bash
 
 Please see the [contributing guide](https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md#the-exercise-data)
 
-## License
-
-The MIT License (MIT)
-
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com
 
 ### Bash icon
 We are using an unofficial logo of the GNU Bash project created by Justin Dorfman. It's not clear under which terms it's released. We believe that our adaptation, changing the colours, falls under fair use.

data/tracks/c/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/c/README.md

@@ -26,8 +26,3 @@ indent -nbad -bap -nbc -bbo -hnl -br -brs -c33 -cd33 -ncdb -ce -ci4 -cli0 -d0 -d
 
 See the [GNU `indent` manual](https://www.gnu.org/software/indent/manual/indent.html#SEC4) for more information.
 
-## License
-
-The MIT License (MIT)
-
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com

data/tracks/clojure/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com
+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

data/tracks/clojure/README.org

@@ -8,11 +8,6 @@ Exercism exercises in Clojure
 * Contributing Guide
 Please see the [[https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md#the-exercise-data][contributing guide]].
 
-* License
-The MIT License (MIT)
-
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com
-
 *** [[https://github.com/exercism/xclojure/tree/master/img/icon.png][Clojure icon]]
 The Clojure logo is owned by Rich Hickey.
 We are using it to identify the Clojure language itself, not any part of Exercism, which we believe to be admissible under fair use.

data/tracks/clojure/config.json

@@ -92,6 +92,11 @@
       "slug": "flatten-array",
       "topics": []
     },
+    {
+      "difficulty": 1,
+      "slug": "sublist",
+      "topics": []
+    },
     {
       "difficulty": 1,
       "slug": "binary-search",

data/tracks/clojure/exercises/sublist/project.clj

@@ -0,0 +1,4 @@
+(defproject sublist "0.1.0-SNAPSHOT"
+  :description "sublist exercise."
+  :url "https://github.com/exercism/xclojure/tree/master/exercises/sublist"
+  :dependencies [[org.clojure/clojure "1.8.0"]])

data/tracks/clojure/exercises/sublist/src/example.clj

@@ -0,0 +1,19 @@
+(ns sublist)
+
+(defn- list-contains?
+  "Returns truthy when list2 is contained within list1, nil otherwise"
+  [list1 list2]
+  (some #(when (= % list2) val)
+        (partition (count list2) 1 list1)))
+
+(defn classify
+  "Classifies two lists based on whether coll1 is the same list, a superlist,
+  a sublist, or disjoint (unequal) from coll2."
+  [coll1 coll2]
+  (let [len1 (count coll1)
+        len2 (count coll2)]
+    (cond
+      (= coll1 coll2) :equal
+      (and (> len1 len2) (list-contains? coll1 coll2)) :superlist
+      (and (> len2 len1) (list-contains? coll2 coll1)) :sublist
+      :else :unequal)))

data/tracks/clojure/exercises/sublist/sublist.mustache

@@ -0,0 +1,9 @@
+(ns sublist-test
+  (:require [clojure.test :refer [deftest is testing]]
+            sublist))
+
+(deftest sublist-tests
+{{#cases}}
+  (testing "{{{description}}}"
+    (is (= :{{{expectation}}} (sublist/classify {{{list_one}}} {{{list_two}}}))))
+{{/cases}})

data/tracks/clojure/exercises/sublist/test/sublist_test.clj

@@ -0,0 +1,40 @@
+(ns sublist-test
+  (:require [clojure.test :refer [deftest is testing]]
+            sublist))
+
+(deftest sublist-tests
+  (testing "empty lists"
+    (is (= :equal (sublist/classify [] []))))
+  (testing "empty list within non empty list"
+    (is (= :sublist (sublist/classify [] [1 2 3]))))
+  (testing "non empty list contains empty list"
+    (is (= :superlist (sublist/classify [1 2 3] []))))
+  (testing "list equals itself"
+    (is (= :equal (sublist/classify [1 2 3] [1 2 3]))))
+  (testing "different lists"
+    (is (= :unequal (sublist/classify [1 2 3] [2 3 4]))))
+  (testing "false start"
+    (is (= :sublist (sublist/classify [1 2 5] [0 1 2 3 1 2 5 6]))))
+  (testing "consecutive"
+    (is (= :sublist (sublist/classify [1 1 2] [0 1 1 1 2 1 2]))))
+  (testing "sublist at start"
+    (is (= :sublist (sublist/classify [0 1 2] [0 1 2 3 4 5]))))
+  (testing "sublist in middle"
+    (is (= :sublist (sublist/classify [2 3 4] [0 1 2 3 4 5]))))
+  (testing "sublist at end"
+    (is (= :sublist (sublist/classify [3 4 5] [0 1 2 3 4 5]))))
+  (testing "at start of superlist"
+    (is (= :superlist (sublist/classify [0 1 2 3 4 5] [0 1 2]))))
+  (testing "in middle of superlist"
+    (is (= :superlist (sublist/classify [0 1 2 3 4 5] [2 3]))))
+  (testing "at end of superlist"
+    (is (= :superlist (sublist/classify [0 1 2 3 4 5] [3 4 5]))))
+  (testing "first list missing element from second list"
+    (is (= :unequal (sublist/classify [1 3] [1 2 3]))))
+  (testing "second list missing element from first list"
+    (is (= :unequal (sublist/classify [1 2 3] [1 3]))))
+  (testing "order matters to a list"
+    (is (= :unequal (sublist/classify [1 2 3] [3 2 1]))))
+  (testing "same digits but different numbers"
+    (is (= :unequal (sublist/classify [1 0 1] [10 1]))))
+)

data/tracks/cpp/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com
+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

data/tracks/cpp/README.md

@@ -8,8 +8,3 @@ Exercism Exercises in C++
 
 Please see the [contributing guide](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md)
 
-## License
-
-The MIT License (MIT)
-
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com

data/tracks/csharp/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2014 Katrina Owen, _@kytrinyx.com
+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