trackler 2.2.1.40 → 2.2.1.41

data/tracks/cfml/tasks/GenerateTests.cfc

@@ -0,0 +1,179 @@
+/**
+* I scaffold a new exercise from the template.
+*/
+component {
+	
+	function run(
+		slug,
+		boolean all=false
+	) {
+		var repoRootPath = expandPath( getDirectoryFromPath( getCurrentTemplatePath() ) & '../' );
+		var problemSpecsPath = expandPath( getDirectoryFromPath( getCurrentTemplatePath() ) & '../../problem-specifications' );
+				
+		if( !directoryExists( problemSpecsPath ) ){
+			error( 'Cannot find [problem-specifications] repo.  It needs to be git cloned to [#problemSpecsPath#]' );
+		}
+		
+		if( all ) {
+			
+			// Get an array of all the excercise names
+			var exercises = directoryList( expandPath( getDirectoryFromPath( getCurrentTemplatePath() ) & '../exercises' ) )
+				.map( function( path ) {
+					return path.listLast( '/\' );
+				} );
+		
+		} else {
+		
+			// Acquire slug
+			if( isNull( arguments.slug ) ) {
+				arguments.slug = ask( 'Exercise slug as defined by Excercism. Ex: "hello-world": ' );
+			}
+			var exercises = [ slug ];
+			
+		}
+				
+		exercises.each( function( slug ) {
+			
+			try {
+				
+				// Slug of hello-world defaults to name of HelloWorld
+				var exerciseName = arguments.slug
+					.listToArray( '-' )
+					.map( function( i ){
+						return i.left( 1 ).uCase() & i.right( -1 ).lCase();
+					} )
+					.toList( '' );
+				
+				var exercisePath = problemSpecsPath & '/exercises/' & slug;
+				if( !directoryExists( exercisePath ) ){
+					error( 'Cannot find exercise [#slug#] in problem-specifications repo.  Tests not generated.' );
+				}
+				
+				var canonicalDataPath = exercisePath & '/canonical-data.json';
+				if( !fileExists( canonicalDataPath ) ){
+					error( 'Cannot find [canonical-data.json] for this slug.  No tests will be generated' );
+				}
+		
+				var canonicalData = deserializeJSON( fileRead( canonicalDataPath ) );
+				var testCases = generateCases( canonicalData.cases );
+				
+				var testStub = fileRead( repoRootPath & '/tasks/exercise_template/@@name@@Test.cfc' );
+				testStub = testStub.replace( '@@name@@', exerciseName, 'all' );
+				testStub = testStub.replace( '@@testCases@@', testCases, 'all' );
+				var targetExercisePath = repoRootPath & 'exercises/' & slug;
+				var newTestPath = targetExercisePath & '/' & exerciseName & 'Test.cfc';
+				
+				if( !directoryExists( targetExercisePath ) ) {
+					error( 'Target exercise does not exist! [#targetExercisePath#]' );
+				}
+				
+				fileWrite( newTestPath, testStub );
+				
+				print.greenLine( 'Test generated!' )
+					.indentedYellowLine( newTestPath )
+					.toConsole();
+			} catch( 'commandException' var e ) {
+				print.boldRedLine( e.message )
+					.line();
+			}
+			
+		} ); // End exercises.each()
+	}
+	
+	private function generateCases( cases, level=1 ) {
+		var CRLF = chr( 13 ) & chr( 10 );
+		var testCases = ''
+			
+		cases.each( function( case ) {
+				
+			// Nested spec
+			if( case.keyExists( 'cases' ) ) {
+				
+					testCases &=  "#CRLF##repeatString( chr( 9 ), level )#		describe( #generateDescription( case.description )#, function(){
+#generateCases( case.cases, level+1 )#
+#repeatString( chr( 9 ), level )#		});#CRLF#";
+					
+			} else {
+				case.expected = case.expected ?: '__NULL__';
+				// Don't adjust whitespace
+				testCases &=  "#CRLF##repeatString( chr( 9 ), level )#		it( #generateDescription( case.description )#, function(){#CRLF#";
+				// Special check for when error should be tested
+				if( isStruct( case.expected ) && case.expected.keyExists( 'error' ) ) {
+					testCases &=  "#repeatString( chr( 9 ), level )#			expect( function(){ SUT.#case.property#(#generateInput( case )#); } ).#generateExpectation( case.expected )#;#CRLF#";	
+				// "normal" expectation
+				} else {
+					testCases &=  "#repeatString( chr( 9 ), level )#			expect( SUT.#case.property#(#generateInput( case )#) ).#generateExpectation( case.expected )#;#CRLF#";
+				}
+				testCases &=  "#repeatString( chr( 9 ), level )#		});#CRLF#";
+			} 
+			
+		} );
+		
+		return testCases;
+	}
+	
+	private function generateDescription( description ) {
+		return escapeString( description );
+	}
+	
+	private function generateInput( case ) {
+		var thisInput = '';
+		for( var key in case ) {
+			if( !listFindNoCase( 'description,property,expected,cases,comments', key ) && !isNull( case[ key ] ) ) {
+				thisInput = thisInput.listAppend( "#key#=#escapeString( case[ key ] )#" );
+			}
+		}
+		if( thisInput.len() ) {
+			return ' ' & thisInput.listChangeDelims( ', ', ',' ) & ' ';				
+		} else {
+			return thisInput;				
+		}
+	}
+	
+	private function generateExpectation( expected ) {
+		if( isSimpleValue( expected ) && compareNoCase( expected, 'true' ) == 0 ) {
+			return 'toBeTrue()';
+		} else if( isSimpleValue( expected ) && compareNoCase( expected, 'false' ) == 0 ) {
+			return 'toBeFalse()';
+		} else if( isSimpleValue( expected) && expected == '__NULL__' ) {
+			return 'toBeNull()';
+		} else if( isStruct( expected ) && expected.keyExists( 'error' ) ) {
+			return 'toThrow( message=#escapeString( expected.error )# )';
+		} else {
+			return "toBe( #escapeString( expected )# )";
+		}
+		
+	}
+	
+	private function escapeString( myString ) {
+		if( isSimpleValue( myString ) ) {
+			myString = replace( myString, "'", "''", "all" );
+			myString = replace( myString, '##', '####', 'all' );
+			myString = replace( myString, chr( 13 ), '##chr( 13 )##', 'all' );
+			myString = replace( myString, chr( 10 ), '##chr( 10 )##', 'all' );
+			return "'" & myString & "'";
+		} else {
+			return convertJSONEscapesToCFML( serializeJSON( myString ) );			
+		}
+	}
+	
+	
+	// A complex value serialized as JSON differs from CFML struct literals in that
+	// double quotes are \" instead of "".  Any escaped double quotes must be converted
+	// to the CFML version to work as an object literal.
+	private function convertJSONEscapesToCFML( required string arg ) {
+		arguments.arg = replaceNoCase( arguments.arg, '\\', '__double_backslash_', 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\/', '/', 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\"', '""', 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\t', '	', 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\n', chr(13)&chr(10), 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\r', chr(13), 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\f', chr(12), 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '\b', chr(8), 'all' );
+		// This doesn't work-- I'd need to do it in a loop and replace each one individually.  Meh...
+		// arguments.arg = reReplaceNoCase( arguments.arg, '\\u([0-9a-f]{4})', chr( inputBaseN( '\1', 16 ) ), 'all' );
+		arguments.arg = replaceNoCase( arguments.arg, '__double_backslash_', '\', 'all' );
+		return arguments.arg;
+	}
+	
+}

data/tracks/cfml/tasks/ScaffoldExercise.cfc

@@ -0,0 +1,85 @@
+/**
+* I scaffold a new exercise from the template.
+*/
+component {
+	
+	function run(
+		slug,
+		difficulty,
+		uuid=createGUID()
+	) {
+		var repoRootPath = expandPath( getDirectoryFromPath( getCurrentTemplatePath() ) & '../' );
+		
+		// Acquire slug
+		if( isNull( arguments.slug ) ) {
+			arguments.slug = ask( 'Exercise slug as defined by Excercism. Ex: "hello-world": ' );
+		}
+		
+		// Slug of hello-world defaults to name of HelloWorld
+		var exerciseName = arguments.slug
+			.listToArray( '-' )
+			.map( function( i ){
+				return i.left( 1 ).uCase() & i.right( -1 ).lCase();
+			} )
+			.toList( '' );
+		
+		// Acquire diffculty
+		if( isNull( arguments.difficulty ) ) {
+			arguments.difficulty = ask( message='Difficulty: ', defaultResponse=1 );
+		}
+
+		// Validation to prevent duplicate runs
+		var exerciseDirectory = repoRootPath & 'exercises/' & arguments.slug;
+		if( directoryExists( exerciseDirectory ) ) {
+			error( 'An exercise named [#arguments.slug#] already exists!' );
+		}
+
+		// Add this exercise to config.json
+		var configJSON = deserializeJSON( fileRead( repoRootPath & '/config.json' ) );
+		configJSON.exercises.append( {
+			"uuid": arguments.uuid,
+			"difficulty": arguments.difficulty+0,
+			"slug": arguments.slug,
+			"topics": []
+		} );		
+		fileWrite( repoRootPath & '/config.json', formatterUtil.formatJSON( json=configJSON, indent='  ' , lineEnding=chr( 10 ) ) );
+
+		// Create exercise scaffold
+		directoryCreate( exerciseDirectory );
+		directoryCopy( repoRootPath & '/tasks/exercise_template', exerciseDirectory, true );
+		
+		// Perform Token replacements
+		command( 'tokenReplace' )
+			.params( '**', '@@name@@', exerciseName )
+			.inWorkingDirectory( exerciseDirectory )
+			.run();
+		
+		directoryList( exerciseDirectory, true )
+			.each( function( path ){
+				if( path.findNoCase( '@@name@@' ) ) {
+					fileMove( path, path.replaceNoCase( '@@name@@', exerciseName, 'all' ) );
+				}
+			} );
+		
+		print.boldGreenLine( 'New exercise created!' )
+			.line()
+			.greenLine( 'The exercise is located here: ' )
+			.indentedYellowLine( exerciseDirectory )
+			.line()
+			.greenLine( 'Create a sample solution here: ' )
+			.indentedYellowLine( exerciseDirectory & '/Solution.cfc' )
+			.line()
+			.greenLine( 'Test your solution with this command: ' )
+			.indentedYellowLine( 'box task run TestRunner --:solution' )
+			.line()
+			.toConsole();
+
+		// Generate test suite
+		command( 'task run' )
+			.params( 'GenerateTests', 'run', slug )
+			.inWorkingDirectory( repoRootPath & '/tasks' )
+			.run();
+		
+	}
+	
+}

data/tracks/cfml/tasks/TestAllSolutions.cfc

@@ -0,0 +1,24 @@
+/**
+* I test all the solutions in each exercise to make sure they all pass.  
+*/
+component {
+	
+	function run() {
+		// Get an array of all the excercise names
+		var exercises = directoryList( expandPath( getDirectoryFromPath( getCurrentTemplatePath() ) & '../exercises' ) );
+		
+		// If there's a testrunner task in them, run it.  If any of the tasks fail, the exit code will come back as 1
+		exercises.each( function( path ) {
+			if( fileExists( path & '/TestRunner.cfc' ) ) {
+				command( 'task run' )
+					.params( 'TestRunner' )
+					// Specifically as the task runners to run the SolutionTest
+					.flags( ':solution' )
+					.inWorkingDirectory( path )
+					.run();
+			}
+		} );
+		
+	}
+	
+}

data/tracks/cfml/tasks/exercise_template/@@name@@.cfc

@@ -0,0 +1,13 @@
+/**
+* Your implmentation of the @@name@@ exercise
+*/
+component {
+	
+	/**
+	* @returns 
+	*/
+	function stubMethodName() {
+		// Implement me here
+	}
+	
+}

data/tracks/cfml/tasks/exercise_template/@@name@@Test.cfc

@@ -0,0 +1,15 @@
+component extends="testbox.system.BaseSpec" {
+
+	function beforeAll(){
+	  SUT = createObject( '@@name@@' );
+	}
+
+	function run(){
+	
+		describe( "My @@name@@ class", function(){			
+@@testCases@@
+		});
+		
+	}
+ 
+}

data/tracks/cfml/tasks/exercise_template/Solution.cfc

@@ -0,0 +1,6 @@
+/**
+* Here is an example solution for the @@name@@ exercise
+*/
+component {
+		
+}

data/tracks/cfml/tasks/exercise_template/SolutionTest.cfc

@@ -0,0 +1,7 @@
+component extends="@@name@@Test" {
+
+	function beforeAll(){
+	  SUT = createObject( 'Solution' );
+	}
+
+}

data/tracks/cfml/tasks/exercise_template/TestRunner.cfc

@@ -0,0 +1,103 @@
+/**
+* I am a CommandBox task runner which you can use to test your implementation of this exercise against the 
+* provided test suite.  To use me, open the CommandBox CLI and run this:
+* 
+* CommandBox> task run TestRunner
+*
+* To start up a test watcher that will automatically rerun the test suite every time you save a file change, run this:
+*
+* CommandBox> task run TestRunner --watcher
+*
+*/
+component {
+	
+	/**
+	* @solution Runs the tests against the solution
+	* @watcher Start up a file watch that re-runs the tests on file changes. Use Ctrl-C to stop
+	*/
+	function run( boolean solution=false, boolean watcher=false ) {
+		
+		ensureTestBox();
+
+		if( watcher ) {
+		
+			// Tabula rasa
+			command( 'cls' ).run();
+				
+			// Start watcher
+			watch()
+				.paths( '*.cfc' )
+				.inDirectory( getCWD() )
+				.withDelay( 500 )
+				.onChange( function() {
+	
+					// Clear the screen
+					command( 'cls' )
+						.run();
+
+					// This is neccessary so changes to tests get picked up right away.
+					pagePoolClear();	
+					
+					runTests( solution );
+	
+				} )
+				.start();
+					
+		} else {
+			runTests( solution );
+		}			
+
+	}
+
+	/**
+	* Make sure the TestBox framework is installed
+	*/
+	private function ensureTestBox() {
+		var excerciseRoot = getCWD();
+		var testBoxRoot = excerciseRoot & '/testbox';
+		
+		if( !directoryExists( testBoxRoot ) ) {
+			
+			print.boldYellowLine( 'Installing some missing dependencies for you!' ).toConsole();
+			command( 'install' )
+				.inWorkingDirectory( excerciseRoot )
+				.run();
+		}
+		
+		// Bootstrap TestBox framework
+		filesystemUtil.createMapping( '/testbox', testBoxRoot );
+	}
+
+	/**
+	* Invoke TestBox to run the test suite
+	*/
+	private function runTests( boolean solution=false ) {
+		
+		// Create TestBox and run the tests
+		testData = new testbox.system.TestBox()
+			.runRaw( directory = {
+				// Find all CFCs...
+				mapping = filesystemUtil.makePathRelative( getCWD() ),
+				// ... in this directory ...
+				recurse = false,
+				// ... whose name ends in "test"
+				filter = function( path ) {
+					return path.reFind( ( solution ? 'Solution' : '' ) & 'Test.cfc$' );
+				 }
+			} )
+			.getMemento();
+		
+		// Print out the results with ANSI formatting for the CLI
+		getInstance( 'CLIRenderer@testbox-commands' )
+			.render( print, testData, true );
+			
+		print.toConsole();
+		
+		// Set proper exit code
+		if( testData.totalFail || testData.totalError ) {
+			setExitCode( 1 );
+		}
+	}
+
+}
+

data/tracks/cfml/tasks/exercise_template/box.json

@@ -0,0 +1,8 @@
+{
+    "dependencies":{
+        "testbox":"^2.5.0+107"
+    },
+    "installPaths":{
+        "testbox":"testbox"
+    }
+}

data/tracks/cfml/tasks/exercise_template/index.cfm

@@ -0,0 +1,37 @@
+<!--- 
+
+This file will only be used if you want to start up a web server in this directory.  You can do so by running:
+
+$> box
+CommandBox> install
+CommandBox> server start
+
+However, this is not necessary unless you really just want to use the HTML reporters on TestBox.  
+Ideally, you'll skip the need for this file entirely and just run the tests directly frm the CLI like this:
+
+CommandBox> task run TestRunner
+
+ --->
+<cfsetting showDebugOutput="false">
+<cfparam name="url.reporter" 		default="simple">
+<cfscript>
+	// get a list of all CFCs in this folder whose name looks like "XXXTest.cfc"
+	// And turn it into compnent path relative to the web root
+	url.bundles = directoryList(
+			path=expandPath( '/' ),
+			filter='*Test.cfc' )
+		.map( function( path ) {
+			return path
+					.replaceNoCase( expandPath( '/' ), '' )
+					.left( -4 )
+		} )
+		.toList();
+</cfscript>
+
+<!--- Ensure TestBox --->
+<cfif fileExists( "/testbox/system/runners/HTMLRunner.cfm" )>
+	<!--- Include the TestBox HTML Runner --->
+	<cfinclude template="/testbox/system/runners/HTMLRunner.cfm">
+<cfelse>
+	Oops, you don't have TestBox installed yet! Please run <b>box install</b> from the root of your excercise folder and refresh this page.	
+</cfif>

data/tracks/coldfusion/docs/ABOUT.md

@@ -1,8 +1,10 @@
-ColdFusion (CFML) is a JVM scripting language whose syntax is similar to C or JavaScript.  It JIT compiles to byte code that runs on the JVM but is dynamic and loosely typed, making it fast and easy to develop in.  CF is a multi-paradigmed language, supporting classical OO and functional programming.  
-
-CF also has a built in tag-based templating language that makes it ideal for web apps.  It runs in a J2EE container with many bundled libraries that make it very productive without the need to install many packages. CF has native support zip files, PDF and Excel generation, E-mails, FTP, HTTP, S3 file systems, ESAPI security libraries, JDBC drivers, JSON data types and REST APIs.  
-
-CF can also leverage any Java project by dropping the jars in project and directly instantiating Java objects in your code.  You can learn more about basic syntax and first class data types in this guide: [Modern ColdFusion (CFML) in 100 Minutes](https://www.gitbook.com/book/ortus/modern-coldfusion-cfml-in-100-minutes/details)
-
+ColdFusion (CFML) is a JVM scripting language whose syntax is similar to C or JavaScript. 
+It JIT compiles to byte code that runs on the JVM but is dynamic and loosely typed, making it fast and easy to develop in. 
+CF is a multi-paradigmed language, supporting classical OO and functional programming.
 
+CFML also has a built-in tag-based templating language that makes it ideal for web apps. 
+It runs in a J2EE container with many bundled libraries that make it very productive without the need to install many packages. 
+CFML has native support for zip files, PDF and Excel generation, E-mails, FTP, HTTP, S3 file systems, ESAPI security libraries, JDBC drivers, JSON and REST APIs.  
 
+CFML can also leverage any Java project by dropping the jars in project and directly instantiating Java objects in your code. 
+You can learn more about basic syntax and first class data types in this guide: [Modern ColdFusion (CFML) in 100 Minutes](https://www.gitbook.com/book/ortus/modern-coldfusion-cfml-in-100-minutes/details)

data/tracks/csharp/docs/GENERATORS.md

@@ -82,6 +82,13 @@ An example of this is the [RunLengthEncoding](https://github.com/exercism/csharp
 
 Here the **Assert** is being overridden. The assert needs to call additional functions, but only if the property is `consistency`. Otherwise, render the assert as usual.
 
+### string[] RenderAdditionalMethods()
+Allow additional methods to be added to the test suite.
+
+There may exist cases where a suite of unit tests will need to reuse the same logic in each of the tests. Rather than duplicating code, this method allows you to provide helper methods for the tests.
+
+Additional methods added using this override will be added to the bottom of the test suite.
+
 ## Updating Existing Files
 It is possible that an existing exercise does not match the canonical data. It is OK to update the exercise stub and/or the exercise example to follow the canonical data! An example might be that an exercise is named SumOfMultiples, but the SumOfMultiples.cs and Example.cs files both use `Multiples` as the name of the class.
 

data/tracks/csharp/exercises/clock/ClockTest.cs

@@ -253,104 +253,104 @@ public class ClockTest
     public void Clocks_with_same_time()
     {
         var sut = new Clock(15, 37);
-        Assert.True(sut.Equals(new Clock(15, 37)));
+        Assert.Equal(new Clock(15, 37), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_a_minute_apart()
     {
         var sut = new Clock(15, 36);
-        Assert.False(sut.Equals(new Clock(15, 37)));
+        Assert.NotEqual(new Clock(15, 37), sut);
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_an_hour_apart()
     {
         var sut = new Clock(14, 37);
-        Assert.False(sut.Equals(new Clock(15, 37)));
+        Assert.NotEqual(new Clock(15, 37), sut);
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_hour_overflow()
     {
         var sut = new Clock(10, 37);
-        Assert.True(sut.Equals(new Clock(34, 37)));
+        Assert.Equal(new Clock(34, 37), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_hour_overflow_by_several_days()
     {
         var sut = new Clock(3, 11);
-        Assert.True(sut.Equals(new Clock(99, 11)));
+        Assert.Equal(new Clock(99, 11), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_hour()
     {
         var sut = new Clock(22, 40);
-        Assert.True(sut.Equals(new Clock(-2, 40)));
+        Assert.Equal(new Clock(-2, 40), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_hour_that_wraps()
     {
         var sut = new Clock(17, 3);
-        Assert.True(sut.Equals(new Clock(-31, 3)));
+        Assert.Equal(new Clock(-31, 3), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_hour_that_wraps_multiple_times()
     {
         var sut = new Clock(13, 49);
-        Assert.True(sut.Equals(new Clock(-83, 49)));
+        Assert.Equal(new Clock(-83, 49), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_minute_overflow()
     {
         var sut = new Clock(0, 1);
-        Assert.True(sut.Equals(new Clock(0, 1441)));
+        Assert.Equal(new Clock(0, 1441), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_minute_overflow_by_several_days()
     {
         var sut = new Clock(2, 2);
-        Assert.True(sut.Equals(new Clock(2, 4322)));
+        Assert.Equal(new Clock(2, 4322), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_minute()
     {
         var sut = new Clock(2, 40);
-        Assert.True(sut.Equals(new Clock(3, -20)));
+        Assert.Equal(new Clock(3, -20), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_minute_that_wraps()
     {
         var sut = new Clock(4, 10);
-        Assert.True(sut.Equals(new Clock(5, -1490)));
+        Assert.Equal(new Clock(5, -1490), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_minute_that_wraps_multiple_times()
     {
         var sut = new Clock(6, 15);
-        Assert.True(sut.Equals(new Clock(6, -4305)));
+        Assert.Equal(new Clock(6, -4305), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_hours_and_minutes()
     {
         var sut = new Clock(7, 32);
-        Assert.True(sut.Equals(new Clock(-12, -268)));
+        Assert.Equal(new Clock(-12, -268), sut); 
     }
 
     [Fact(Skip = "Remove to run test")]
     public void Clocks_with_negative_hours_and_minutes_that_wrap()
     {
         var sut = new Clock(18, 7);
-        Assert.True(sut.Equals(new Clock(-54, -11513)));
+        Assert.Equal(new Clock(-54, -11513), sut); 
     }
 }