From ee85712ba3b9534d1b1c12f35021fde1aa3cffac Mon Sep 17 00:00:00 2001 From: George Cook Date: Thu, 21 Mar 2019 15:03:41 -0500 Subject: [PATCH] Bounce to 2.1.0 --- CHANGELOG.md | 39 ++++++++++++++++++++++++++++++++++++++- README.md | 10 ++++------ ROADMAP.md | 33 +++++++++------------------------ VERSION | 2 +- gulpfile.ts | 4 ++-- 5 files changed, 54 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e6375822..709137f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,43 @@ # Rooibos CHANGELOG -## 0.2.0 Initial feedback relase +## 2.1.0 + +### Added + - Multiple overloads for expectOnce, allowing for easy definition of multi params and return values from the same method invocation + +### Changed + +### Deprecated + +### Removed + +### Fixed + + - Potential crash when passing wrong type of arg value into a fake + +## 2.0.0 + +### Added + + - Leverage rooibosC preprocessor + - Better examples + - Faster parsing + +### Changed + + - Now requires rooibosC to create the test metadata structures + +### Deprecated + +### Removed + + - Legacy framework support + +### Fixed + + - various runtime error scenarios + +## 0.2.0 Initial feedback release - Compatability with Roku unit test framework - Fix issues submitted by initial users - Add `'@OnlyParams` tag diff --git a/README.md b/README.md index 9a250f5f..b6a0508f 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,6 @@

Simple, mocha-inspired, flexible, fun Brightscript test framework for ROKU apps

-

- Version 2.0.0 -

Mocha test framework

@@ -18,10 +15,10 @@ Simple, mocha-inspired, flexible, fun Brightscript test framework for ROKU apps - **[Youtube training videos](https://www.youtube.com/playlist?list=PLJRLV4QDx83vsYMD9bIs-cjoDXmNmO8Jv)** - **[Documentation](docs/index.md)** - **[API Documentaiton](https://georgejecook.github.io/rooibos)** - - **[Release notes / History / Changes](CHANGELOG.md)** + - **[CHANGELOG](CHANGELOG.md)** - **[VSCode snippets](docs/vsCodeSnippets.md)** - [Roku dev forum topic](https://forums.roku.com/viewforum.php?f=34) - - [Roku developer slack group](https://join.slack.com/t/rokudevelopers/shared_invite/enQtMzgyODg0ODY0NDM5LTc2ZDdhZWI2MDBmYjcwYTk5MmE1MTYwMTA2NGVjZmJiNWM4ZWY2MjY1MDY0MmViNmQ1ZWRmMWUzYTVhNzJiY2M) + - \#roku channel on the [roku developer's slack](https://join.slack.com/t/rokudevelopers/shared_invite/enQtMzgyODg0ODY0NDM5LTc2ZDdhZWI2MDBmYjcwYTk5MmE1MTYwMTA2NGVjZmJiNWM4ZWY2MjY1MDY0MmViNmQ1ZWRmMWUzYTVhNzJiY2M) - [Issue tracker](https://github.com/georgejecook/rooibos/issues) - [Roadmap](ROADMAP.md) @@ -40,7 +37,8 @@ Also thanks to the guys who made and maintain [mochaJs](https://mochajs.org/), o ## FAQ ### Is Rooibos ready for production use? -Rooibos has so far been used on a couple of production projects, running CI with over 1500 tests between them. It does however, use the same test running mechanism of the official roku unit testing framework, which has been in circulation for several years. +Rooibos is the test framework used by several of my clients, running CI with over 3000 tests between them. It started life as rewrite of the official roku unit testing framework, which has been in circulation for several years. + ### Is Rooibos actively maintained? diff --git a/ROADMAP.md b/ROADMAP.md index 3358fc6c..8f3dd8f3 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,25 +1,8 @@ -# Rooibos roadmap +# Rooibos Roadmap -Up to date as of Feb 4th, 2019 +## ShortTerm -## 0.1.0 Initial release [RELEASED] - -## 0.2.0 Initial feedback [RELEASED] - -Fix immediate issues that come back from the first few weeks of release -Also add an `'@OnlyParams[p1,...p6]` tag, so that we -don't need to use `@IgnoreParams` - -## 0.3.0 rooibosC (beta) - remove eval from rooibos [RELEASED] - -eval is no longer supported by roku. I don't want rooibos to lose it's accesible annotation style test writing. I've therefore created a preprocessor (named rooibosC) which creates a rooibos.function.map.brs. - - -## 2.0.0 Move ALL test parsing to rooibosC [RELEASED] - -It's so much quicker to parse in js, that I will rewrite the core parser, to spit out prebaked json, which can be loaded at runtime, to greatly increase rooibos's performance. - -## 2.0.x Unit tests for the framework +### Unit tests for the framework and general framework improvements Unit tests will be written which test the following: @@ -30,12 +13,14 @@ Unit tests will be written which test the following: - Stubs - Expect +# MidTerm -## 2.1.0 Add additional reporting opptions +### Add additional reporting options -Will add the ability to specifiy a unit test reporting class, to faciliate custom unit test reporting +Will add the ability to specify a unit test reporting class, to facilitate custom unit test reporting -## 2.2.0 Integration with [To be named] roku pre-processor +# LongTerm -I have another project in the works which pre-processes brightscript and xml to provide an Adobe flex-like syntax for easy MVVM roku development. I want to integrate hooks into that, which will automatically generate node test files. +### Integrate with vscode ide +Support test execution from and output to Visual Studio Code ide, as per mocha test runner extension diff --git a/VERSION b/VERSION index 6e8bf73a..7ec1d6db 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.1.0 +2.1.0 diff --git a/gulpfile.ts b/gulpfile.ts index 4c6e4d20..ee6fa7ac 100644 --- a/gulpfile.ts +++ b/gulpfile.ts @@ -85,5 +85,5 @@ export function doc(cb) { } exports.build = series(clean, createDirectories, squash, copyToSamples); -exports.runFrameworkTests = series(exports.build, prepareFrameworkTests, zipFrameworkTests, deployFrameworkTests) -exports.prePublishFrameworkTests = series(exports.build, prepareFrameworkTests) \ No newline at end of file +exports.runFrameworkTests = series(exports.build, prepareFrameworkTests, copyToSamples, zipFrameworkTests, deployFrameworkTests) +exports.prePublishFrameworkTests = series(exports.build, prepareFrameworkTests, copyToSamples) \ No newline at end of file