trackler 2.0.1.1 → 2.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0668847547af08df3e6296f50d8ee7b1acb6d86
-  data.tar.gz: 3733aa995d8e62eaa5d97e224f39f74fbb186974
+  metadata.gz: 7b688c37ee3986356aaadb9bd39b4dd72524ed7f
+  data.tar.gz: 0023dcfdc396190c1c7ee84988a9e183d9ec1459
 SHA512:
-  metadata.gz: f80278c35da0397606227fd884ec94a4e5b325e0983da69bd82a6b8039e776729d1b696357f3efe56b9c809e599219a6568cf50a705881582d64c696a018fef8
-  data.tar.gz: 176cdc2e4a3b5a58ff89a07a9261215e293723b963af269a3cc02858be676e622a1e3adc7c646c2ae5a04d812b4c57b0a1cbf089f7b86106284ba5fe63ede4d7
+  metadata.gz: c723690b00d103e004d70e3b1436ce5fb406e2ad06dd4d18e120f16578c3b31164430936bc3f5127e2431426be5a2e814923b98cfca95af03247ef64044708aa
+  data.tar.gz: a45271733dc3dc85ba092a50293cf267acdd14343cecffa9fac2cbf980be3b9b7b8c26e29f90c5b3fc499faef4ad4f2a5671070ab03c827cb2ba88d4393e9488

data/bin/update

@@ -1,5 +1,9 @@
 #!/bin/bash
 
+git checkout master
+git fetch origin master
+git reset --hard origin/master
+
 git submodule foreach git pull origin master
 
 rake && bin/verify-configs && bin/verify-metadata

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

@@ -56,9 +56,9 @@
     {
       "description": "space surrounded by mines",
       "input": [
-        "   ",
-        " 8 ",
-        "   "
+        "***",
+        "* *",
+        "***"
       ],
       "expected": [
         "***",

data/fixtures/common/exercises/imbe/description.md

@@ -0,0 +1,2 @@
+Garcinia livingstonei (imbe) is a species of Garcinia, native to a broad area of tropical Africa.
+

data/fixtures/common/exercises/imbe/metadata.yml

@@ -0,0 +1,3 @@
+---
+blurb: "This is imbe."
+source: "Africa."

data/fixtures/common/exercises/no-metadata/description.md

@@ -0,0 +1 @@
+This exercise should have no metadata.yml file.

data/fixtures/tracks/fruit/exercises/imbe/HINTS.md

@@ -0,0 +1 @@
+Hints file is ignored.

data/fixtures/tracks/fruit/exercises/imbe/also_an_example.txt

@@ -0,0 +1 @@
+This file is also ignored.

data/fixtures/tracks/fruit/exercises/imbe/example.ext

@@ -0,0 +1 @@
+Any file containing example is ignored.

data/fixtures/tracks/fruit/exercises/imbe/imbe.txt

@@ -0,0 +1 @@
+All files in this directory, EXCEPT for this file, should be ignored.

data/lib/trackler/file_bundle.rb

@@ -1,18 +1,19 @@
 require 'zip'
 
 module Trackler
-  # FileBundle is a zippech archive of a directory.
+  # A FileBundle is a collection of files from within an exercise directory
+  # It contains all the files that will be provided by the `exercism fetch` command
+  # EXCEPT for those whose names match any of the ignore patterns.
   class FileBundle
-    attr_reader :dir, :ignore_patterns
-    def initialize(dir, ignore_patterns=[])
-      @dir = dir
+    def initialize(base_directory, ignore_patterns = [])
+      @base_directory = base_directory
       @ignore_patterns = ignore_patterns
     end
 
     def zip
       Zip::OutputStream.write_buffer do |io|
         paths.each do |path|
-          io.put_next_entry(path.relative_path_from(dir))
+          io.put_next_entry(path.relative_path_from(base_directory))
           io.print IO.read(path)
         end
         yield io if block_given?
@@ -20,10 +21,27 @@ module Trackler
     end
 
     def paths
-      Pathname.glob("#{dir}/**/*", File::FNM_DOTMATCH).reject {|file|
-        file.directory? ||
-          ignore_patterns.any? { |pattern| file.to_s =~ pattern }
-      }.sort
+      all_files_below(base_directory).reject { |file| ignored? file }.sort
+    end
+
+    private
+
+    attr_reader :base_directory, :ignore_patterns
+
+    def all_files_below(dir)
+      Pathname.glob("#{dir}/**/*", File::FNM_DOTMATCH)
+    end
+
+    def ignored?(file)
+      ignored_by_name?(file) || ignored_by_type?(file)
+    end
+
+    def ignored_by_name?(file)
+      ignore_patterns.any? { |pattern| file.to_s =~ pattern }
+    end
+
+    def ignored_by_type?(file)
+      file.directory?
     end
   end
 end

data/lib/trackler/implementation.rb

@@ -8,6 +8,7 @@ module Trackler
       Regexp.new("HINTS\.md$"),
       Regexp.new("example", Regexp::IGNORECASE),
       Regexp.new("\/\.$"),
+      Regexp.new("/\.meta/")
     ]
 
     attr_reader :track_id, :repo, :problem, :root, :file_bundle
@@ -17,16 +18,16 @@ module Trackler
       @repo = repo
       @problem = problem
       @root = Pathname.new(root)
-      @file_bundle = FileBundle.new(dir, IGNORE)
+      @file_bundle = FileBundle.new(track_directory, IGNORE)
     end
 
     def exists?
-      File.exist?(dir)
+      File.exist?(track_directory)
     end
 
     def files
       @files ||= Hash[file_bundle.paths.map {|path|
-        [path.relative_path_from(dir).to_s, File.read(path)]
+        [path.relative_path_from(track_directory).to_s, File.read(path)]
       }].merge("README.md" => readme)
     end
 
@@ -55,8 +56,8 @@ module Trackler
 
     private
 
-    def dir
-      @dir ||= track_dir.join(exercise_dir)
+    def track_directory
+      @track_directory ||= track_dir.join(exercise_dir)
     end
 
     def track_dir
@@ -105,7 +106,7 @@ It's possible to submit an incomplete solution so you can see how others have co
     end
 
     def implementation_hint
-      read File.join(dir, 'HINTS.md')
+      read File.join(track_directory, 'HINTS.md')
     end
 
     def read(f)

data/lib/trackler/problem.rb

@@ -10,78 +10,103 @@ module Trackler
     end
 
     def exists?
-      !!md && !!yaml
+      !!description && !!metadata
     end
 
     def name
-      @name ||= slug.split('-').map(&:capitalize).join(' ')
+      slug.split('-').map(&:capitalize).join(' ')
     end
 
     def description
-      @description ||= File.read(filepath(md))
+      return @description unless @description.nil?
+      filename = common_metadata_path(description_path)
+      if File.exists?(filename)
+        @description = File.read(filename)
+      end
     end
 
     def source_markdown
-      body = source.empty? ? "" : "%s" % source
-      url = source_url.empty? ? "" : "[%s](%s)" % [source_url, source_url]
-      if url.empty? && body.empty?
-        ""
-      else
-        "## Source\n\n" + [body, url].reject(&:empty?).join(" ")
-      end
+      text = [source, markdown_link(source_url)].reject(&:empty?).join(" ")
+      text.empty? ? text : "## Source\n\n#{text}"
     end
 
+    ######
+    # Deprecated methods
+    # TODO: remove external references to these methods.
+    # found in: x-api
+    # NOT in: exercism.io, cli
+    # Anywhere else we need to look?
+    # Should this output a warning or raise an error?
     def md_url
-      repo_url(md)
+      description_url
     end
 
     def json_url
-      repo_url(json) if !!json
+      canonical_data_url
     end
 
     def yaml_url
-      repo_url(yaml)
+      metadata_url
     end
+    # End deprecated methods
+    ######
 
-    %w(blurb source source_url).each do |name|
-      define_method name do
-        metadata[name].to_s.strip
-      end
+    def description_url
+      repo_url(description_path)
+    end
+
+    def canonical_data_url
+      repo_url(canonical_data_path) if File.exists?(common_metadata_path(canonical_data_path))
+    end
+
+    def metadata_url
+      repo_url(metadata_path)
+    end
+
+    def blurb
+      metadata['blurb'].to_s.strip
+    end
+
+    def source
+      metadata['source'].to_s.strip
+    end
+
+    def source_url
+      metadata['source_url'].to_s.strip
     end
 
     private
 
-    def json
-      [
-        "exercises/%s/canonical-data.json" % slug,
-        "%s.json" % slug,
-      ].find { |path| File.exist?(filepath(path)) }
+    def canonical_data_path
+      "exercises/%s/canonical-data.json" % slug
     end
 
-    def yaml
-      [
-        "exercises/%s/metadata.yml" % slug,
-        "%s.yml" % slug,
-      ].find { |path| File.exist?(filepath(path)) }
+    def metadata_path
+      "exercises/%s/metadata.yml" % slug
     end
 
-    def md
-      [
-        "exercises/%s/description.md" % slug,
-        "%s.md" % slug,
-      ].find { |path| File.exist?(filepath(path)) }
+    def description_path
+      "exercises/%s/description.md" % slug
     end
 
     def repo_url(path)
-      "https://github.com/exercism/x-common/blob/master/%s" % path
+      "https://github.com/exercism/x-common/blob/master/#{path}" unless path.nil?
     end
 
-    def filepath(f)
-      File.join(root, "common", f)
+    def metadata
+      return @metadata unless @metadata.nil?
+      filename = common_metadata_path(metadata_path)
+      if File.exists?(filename)
+        @metadata = YAML.load(File.read(filename))
+      end
     end
 
-    def metadata
-      @metadata ||= YAML.load(File.read(filepath(yaml)))
+    def common_metadata_path(path)
+      File.join(root, "common", path)
+    end
+
+    def markdown_link(url)
+      url.empty? ? url : format("[%s](%s)", url, url)
     end
   end
 end

data/lib/trackler/version.rb

@@ -1,3 +1,3 @@
 module Trackler
-  VERSION = "2.0.1.1"
+  VERSION = "2.0.1.2"
 end

data/tracks/c/config.json

@@ -180,6 +180,15 @@
         "text formatting",
         "preprocessor (x-macros in test)"
      ]
+  },  {
+     "difficulty": 2,
+     "slug": "series",
+     "topics": [
+        "control-flow (if-statements)",
+        "strings",
+        "text formatting",
+        "memory management"
+     ]
   }],
   "deprecated": [
 

data/tracks/c/exercises/series/makefile

@@ -0,0 +1,16 @@
+CFLAGS  = -std=c99
+CFLAGS += -Wall
+CFLAGS += -Wextra
+CFLAGS += -pedantic
+CFLAGS += -Werror
+
+
+test: tests.out
+	@./tests.out
+
+clean:
+	rm -f *.o *.out
+
+tests.out: test/test_series.c src/series.c src/series.h
+	@echo Compiling $@
+	@cc $(CFLAGS) src/series.c test/vendor/unity.c test/test_series.c -o tests.out

data/tracks/c/exercises/series/src/example.c

@@ -0,0 +1,24 @@
+#include <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+
+#include "series.h"
+
+SeriesResults_t series(char *inputText, unsigned int substringLength)
+{
+   int substringCount = strlen(inputText) - (substringLength - 1);
+   SeriesResults_t results;
+
+   memset(&results, 0, sizeof(results));
+   if ((substringCount > 0) && (substringLength > 0)) {
+      results.substringCount = substringCount;
+      results.substring = malloc(sizeof(char *) * substringCount);
+      for (int index = 0; index < substringCount; index++) {
+         results.substring[index] =
+             malloc(sizeof(char) * (substringLength + 1));
+         sprintf(results.substring[index], "%.*s", substringLength,
+                 &inputText[index]);
+      }
+   }
+   return results;
+}

data/tracks/c/exercises/series/src/series.h

@@ -0,0 +1,28 @@
+#ifndef _SERIES_H
+#define _SERIES_H
+
+#define MAX_INPUT_TEXT_LENGTH (8)
+#define MAX_SERIES_RESULTS (MAX_INPUT_TEXT_LENGTH)
+#define MAX_SERIES_LENGTH (5)
+
+// results structure
+typedef struct SeriesResults {
+   unsigned int substringCount;
+   char **substring;            // array of pointers of dimension substringCount
+} SeriesResults_t;
+
+// series - routine to split up input text into consecutive substrings of text of a given substringLength
+//
+// inputs:
+//    inputText - bounded to MAX_INPUT_TEXT_LENGTH
+//    substringLength - the desired length of substrings that are returned bounded to MAX_SERIES_LENGTH
+//
+// outputs:
+//    SeriesResult_t results - structure containing count of the substring and an array of
+//       pointers to the substrings.
+//
+//       calling routine will free memory associated with each of the substrings and
+//       the pointers to the substrings.
+SeriesResults_t series(char *inputText, unsigned int substringLength);
+
+#endif

data/tracks/c/exercises/series/test/test_series.c

@@ -0,0 +1,63 @@
+#include <stdlib.h>
+#include "vendor/unity.h"
+#include "../src/series.h"
+
+// helper routines to validate test results
+static void testSolution(SeriesResults_t * expectedSolution,
+                         SeriesResults_t * actualSolution)
+{
+   // result count correct
+   TEST_ASSERT_EQUAL(expectedSolution->substringCount,
+                     actualSolution->substringCount);
+
+   // test each substring...
+   for (unsigned int index = 0; index < expectedSolution->substringCount;
+        index++) {
+      TEST_ASSERT_EQUAL_STRING(expectedSolution->substring[index],
+                               actualSolution->substring[index]);
+      free(actualSolution->substring[index]);
+   }
+   if (actualSolution->substringCount) {
+      free(actualSolution->substring);
+   }
+}
+
+#define EXPAND_SERIES_TEST_CASES_AS_TEST(test_name, inputText, substringLength, expectedResultCount, expectedResultSubstrings)\
+   void test_name(void)\
+   {\
+   char *substrings[] =  expectedResultSubstrings;\
+   SeriesResults_t expected = {expectedResultCount, &substrings[0]};\
+   SeriesResults_t actual = series(inputText, substringLength);\
+   testSolution(&expected, &actual);\
+   }\
+
+#define ASSEMBLE_STRING_ARRAY(...) __VA_ARGS__
+
+// Test cases
+#define SERIES_TEST_CASES(ENTRY) \
+   ENTRY(test_slices_of_one, "01234", 1, 5, { ASSEMBLE_STRING_ARRAY("0","1","2","3","4") })\
+   ENTRY(test_slices_of_two, "97867564", 2, 7, { ASSEMBLE_STRING_ARRAY("97","78","86","67","75","56", "64") })\
+   ENTRY(test_slices_of_three, "97867564", 3, 6, { ASSEMBLE_STRING_ARRAY("978","786","867","675","756","564") })\
+   ENTRY(test_slices_of_four, "01234", 4, 2, { ASSEMBLE_STRING_ARRAY("0123","1234") })\
+   ENTRY(test_slices_of_five, "01234", 5, 1, { ASSEMBLE_STRING_ARRAY("01234") })\
+   ENTRY(test_overly_long_slice, "012", 4, 0, { ASSEMBLE_STRING_ARRAY("") })\
+   ENTRY(test_overly_short_slice, "01234", 0, 0, { ASSEMBLE_STRING_ARRAY("") })\
+
+SERIES_TEST_CASES(EXPAND_SERIES_TEST_CASES_AS_TEST)
+
+int main(void)
+{
+   UnityBegin("test/test_word_count.c");
+
+   RUN_TEST(test_slices_of_one);
+   RUN_TEST(test_slices_of_two);
+   RUN_TEST(test_slices_of_three);
+   RUN_TEST(test_slices_of_four);
+   RUN_TEST(test_slices_of_five);
+   RUN_TEST(test_overly_long_slice);
+   RUN_TEST(test_overly_short_slice);
+
+   UnityEnd();
+
+   return 0;
+}