Add perfect-numbers generator (#253)

Restructured generators
Support exception-based tests

exercises/perfect-numbers/Example.cs

@@ -1,35 +1,33 @@
-public enum NumberType
+using System;
+
+public enum Classification
 {
     Perfect,
     Abundant,
     Deficient
 }
 
-public class PerfectNumbers
+public static class PerfectNumbers
 {
-    public static NumberType Classify(int number)
+    public static Classification Classify(int number)
     {
+        if (number < 1)
+            throw new ArgumentOutOfRangeException();
+
         int sumOfFactors = 0;
 
         for (int i = 1; i < number; i++)
         {
             if (number % i == 0)
-            {
                 sumOfFactors += i;
-            }
         }
 
         if (sumOfFactors < number)
-        {
-            return NumberType.Deficient;
-        }
-        else if (sumOfFactors == number)
-        {
-            return NumberType.Perfect;
-        }
-        else
-        {
-            return NumberType.Abundant;
-        }
+            return Classification.Deficient;
+
+        if (sumOfFactors == number)
+            return Classification.Perfect;
+
+        return Classification.Abundant;
     }
 }

exercises/perfect-numbers/PerfectNumbers.cs

@@ -1,6 +1,6 @@
 using System;
 
-public enum NumberType
+public enum Classification
 {
     Perfect,
     Abundant,
@@ -9,7 +9,7 @@ public enum NumberType
 
 public static class PerfectNumbers
 {
-    public static NumberType Classify(int number)
+    public static Classification Classify(int number)
     {
         throw new NotImplementedException();
     }

exercises/perfect-numbers/PerfectNumbersTest.cs

@@ -1,31 +1,83 @@
-using Xunit;
+using Xunit;
+using System;
 
 public class PerfectNumbersTest
 {
-    [Theory]
-    [InlineData(3)]
-    [InlineData(7)]
-    [InlineData(13)]
-    public void Can_classify_deficient_numbers(int number)
-    {
-        Assert.Equal(NumberType.Deficient, PerfectNumbers.Classify(number));
-    }
-
-    [Theory(Skip = "Remove to run test")]
-    [InlineData(6)]
-    [InlineData(28)]
-    [InlineData(496)]
-    public void Can_classify_perfect_numbers(int number)
-    {
-        Assert.Equal(NumberType.Perfect, PerfectNumbers.Classify(number));
-    }
-
-    [Theory(Skip = "Remove to run test")]
-    [InlineData(12)]
-    [InlineData(18)]
-    [InlineData(20)]
-    public void Can_classify_abundant_numbers(int number)
-    {
-        Assert.Equal(NumberType.Abundant, PerfectNumbers.Classify(number));
+    [Fact]
+    public void Smallest_perfect_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Perfect, PerfectNumbers.Classify(6));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Medium_perfect_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Perfect, PerfectNumbers.Classify(28));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Large_perfect_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Perfect, PerfectNumbers.Classify(33550336));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Smallest_abundant_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Abundant, PerfectNumbers.Classify(12));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Medium_abundant_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Abundant, PerfectNumbers.Classify(30));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Large_abundant_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Abundant, PerfectNumbers.Classify(33550335));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Smallest_prime_deficient_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Deficient, PerfectNumbers.Classify(2));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Smallest_non_prime_deficient_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Deficient, PerfectNumbers.Classify(4));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Medium_deficient_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Deficient, PerfectNumbers.Classify(32));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Large_deficient_number_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Deficient, PerfectNumbers.Classify(33550337));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Edge_case_no_factors_other_than_itself_is_classified_correctly()
+    {
+        Assert.Equal(Classification.Deficient, PerfectNumbers.Classify(1));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Zero_is_rejected_not_a_natural_number_()
+    {
+        Assert.Throws<ArgumentOutOfRangeException>(() => PerfectNumbers.Classify(0));
+    }
+
+    [Fact(Skip = "Remove to run test")]
+    public void Negative_integer_is_rejected_not_a_natural_number_()
+    {
+        Assert.Throws<ArgumentOutOfRangeException>(() => PerfectNumbers.Classify(-1));
     }
 }

generators/TestClass.cs → generators/Classes/TestClass.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
+using Generators.Methods;
 
-namespace Generators
+namespace Generators.Classes
 {
     public class TestClass
     {

generators/TestClassNameTransformer.cs → generators/Classes/TestClassNameTransformer.cs

@@ -1,6 +1,6 @@
 using Humanizer;
 
-namespace Generators
+namespace Generators.Classes
 {
     public class TestClassNameTransformer : IStringTransformer
     {

generators/TestClassRenderer.cs → generators/Classes/TestClassRenderer.cs

@@ -1,7 +1,8 @@
 using System.Collections.Generic;
 using System.Linq;
+using Generators.Methods;
 
-namespace Generators
+namespace Generators.Classes
 {
     public static class TestClassRenderer
     {

generators/TestedClassNameTransformer.cs → generators/Classes/TestedClassNameTransformer.cs

@@ -1,6 +1,6 @@
 using Humanizer;
 
-namespace Generators
+namespace Generators.Classes
 {
     public class TestedClassNameTransformer : IStringTransformer
     {

generators/CanonicalData.cs → generators/Data/CanonicalData.cs

@@ -1,7 +1,7 @@
 using System.ComponentModel.DataAnnotations;
 using Newtonsoft.Json;
 
-namespace Generators
+namespace Generators.Data
 {
     public class CanonicalData
     {

generators/CanonicalDataCase.cs → generators/Data/CanonicalDataCase.cs

@@ -1,8 +1,8 @@
-using Newtonsoft.Json;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
+using Newtonsoft.Json;
 
-namespace Generators
+namespace Generators.Data
 {
     [JsonConverter(typeof(CanonicalDataCaseJsonConverter))]
     public class CanonicalDataCase

generators/CanonicalDataCaseJsonConverter.cs → generators/Data/CanonicalDataCaseJsonConverter.cs

@@ -3,7 +3,7 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
-namespace Generators
+namespace Generators.Data
 {
     public class CanonicalDataCaseJsonConverter : JsonConverter
     {

generators/CanonicalDataCasesJsonConverter.cs → generators/Data/CanonicalDataCasesJsonConverter.cs

@@ -1,11 +1,11 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Reflection;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
-using System.Linq;
 
-namespace Generators
+namespace Generators.Data
 {
     public class CanonicalDataCasesJsonConverter : JsonConverter
     {

generators/CanonicalDataParser.cs → generators/Data/CanonicalDataParser.cs

@@ -1,13 +1,13 @@
-using Newtonsoft.Json;
-using System;
+using System;
 using System.ComponentModel.DataAnnotations;
 using System.Net.Http;
+using Newtonsoft.Json;
 
-namespace Generators
+namespace Generators.Data
 {
     public static class CanonicalDataParser
     {
-        private static readonly HttpClient httpClient = new HttpClient();
+        private static readonly HttpClient HttpClient = new HttpClient();
 
         public static CanonicalData Parse(string exercise)
         {
@@ -20,7 +20,7 @@ public static CanonicalData Parse(string exercise)
         }
 
         private static string DownloadCanonicalDataJson(string exercise)
-            => httpClient.GetStringAsync(GetCanonicalDataUrl(exercise)).GetAwaiter().GetResult();
+            => HttpClient.GetStringAsync(GetCanonicalDataUrl(exercise)).GetAwaiter().GetResult();
 
         private static Uri GetCanonicalDataUrl(string exercise)
             => new Uri($"https://raw.githubusercontent.com/exercism/x-common/master/exercises/{exercise}/canonical-data.json");

generators/ExerciseCollection.cs → generators/Data/ExerciseCollection.cs

@@ -1,11 +1,11 @@
-using Generators.Exercises;
-using System;
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using Generators.Exercises;
 
-namespace Generators
+namespace Generators.Data
 {
     public class ExerciseCollection : IEnumerable<Exercise>
     {

generators/Exercises/AcronymExercise.cs

@@ -1,15 +1,20 @@
-namespace Generators.Exercises
+using Generators.Data;
+using Generators.Methods;
+
+namespace Generators.Exercises
 {
-    public class AcronymExercise : Exercise
+    public class AcronymExercise : EqualityExercise
     {
         public AcronymExercise() : base("acronym")
         {
         }
 
-        protected override TestMethod CreateTestMethod(TestMethodData testMethodData)
+        protected override TestMethodData CreateTestMethodData(CanonicalData canonicalData, CanonicalDataCase canonicalDataCase, int index)
         {
-            testMethodData.InputProperty = "phrase";
-            return CreateEqualityTestMethod(testMethodData);
+            var testMethodData = base.CreateTestMethodData(canonicalData, canonicalDataCase, index);
+            testMethodData.Options.InputProperty = "phrase";
+
+            return testMethodData;
         }
     }
 }

generators/Exercises/BooleanExercise.cs

@@ -0,0 +1,14 @@
+using Generators.Methods;
+
+namespace Generators.Exercises
+{
+    public abstract class BooleanExercise : Exercise
+    {
+        protected BooleanExercise(string name) : base(name)
+        {
+        }
+
+        protected override TestMethod CreateTestMethod(TestMethodData testMethodData)
+            => CreateBooleanTestMethod(testMethodData);
+    }
+}

generators/Exercises/EqualityExercise.cs

@@ -0,0 +1,14 @@
+using Generators.Methods;
+
+namespace Generators.Exercises
+{
+    public abstract class EqualityExercise : Exercise
+    {
+        protected EqualityExercise(string name) : base(name)
+        {
+        }
+
+        protected override TestMethod CreateTestMethod(TestMethodData testMethodData)
+            => CreateEqualityTestMethod(testMethodData);
+    }
+}