fix(cbstorages): Upgrade cbstorages to 2.0.0

Upgrade internal cbstorages library to 2.0.0

BREAKING CHANGE: Drop support for ACF 11

Author: elpete

.travis.yml

@@ -6,7 +6,6 @@ env:
   matrix:
     - ENGINE=adobe@2018
     - ENGINE=adobe@2016
-    - ENGINE=adobe@11
     - ENGINE=lucee@5
 before_install:
   - curl -fsSl https://downloads.ortussolutions.com/debs/gpg | sudo apt-key add -

box.json

@@ -25,10 +25,10 @@
         }
     ],
     "dependencies":{
-        "cbstorages":"^1.2.0"
+        "cbstorages":"^2.0.0"
     },
     "devDependencies":{
-        "testbox":"^2.3.0+00044"
+        "testbox":"^3.0.0"
     },
     "installPaths":{
         "testbox":"testbox/",

models/AuthenticationService.cfc

@@ -5,18 +5,18 @@ component singleton {
     property name="sessionStorage" inject="SessionStorage@cbauth";
     property name="requestStorage" inject="RequestStorage@cbauth";
     property name="userServiceClass" inject="coldbox:setting:userServiceClass@cbauth";
-    
+
     variables.USER_ID_KEY = "cbauth__userId";
     variables.USER_KEY = "cbauth__user";
 
     public void function logout() {
-        sessionStorage.deleteVar( USER_ID_KEY );
-        requestStorage.deleteVar( USER_KEY );
+        sessionStorage.delete( USER_ID_KEY );
+        requestStorage.delete( USER_KEY );
     }
 
     public void function login( required user ) {
-        sessionStorage.setVar( USER_ID_KEY, user.getId() );
-        requestStorage.setVar( USER_KEY, user );
+        sessionStorage.set( USER_ID_KEY, user.getId() );
+        requestStorage.set( USER_KEY, user );
     }
 
     public boolean function authenticate( required string username, required string password ) {
@@ -30,7 +30,7 @@ component singleton {
         if ( NOT getUserService().isValidCredentials( args.username, args.password ) ) {
             throw( "Incorrect Credentials Entered", "InvalidCredentials" );
         }
-        
+
         var user = getUserService().retrieveUserByUsername( args.username );
 
         interceptorService.processState( "postAuthentication", {
@@ -59,10 +59,10 @@ component singleton {
     public any function getUser() {
         if ( ! requestStorage.exists( USER_KEY ) ) {
             var userBean = getUserService().retrieveUserById( getUserId() );
-            requestStorage.setVar( USER_KEY, userBean );
+            requestStorage.set( USER_KEY, userBean );
         }
 
-        return requestStorage.getVar( USER_KEY );
+        return requestStorage.get( USER_KEY );
     }
 
     public any function user() {
@@ -74,7 +74,7 @@ component singleton {
             throw( "No user is currently logged in.", "NoUserLoggedIn" );
         }
 
-        return sessionStorage.getVar( USER_ID_KEY );
+        return sessionStorage.get( USER_ID_KEY );
     }
 
     private any function getUserService() {

server.json

@@ -1,6 +1,6 @@
 {
     "app":{
-        "cfengine":"adobe@11"
+        "cfengine":"adobe@2016"
     },
     "web":{
         "http":{

tests/Application.cfc

@@ -1,8 +1,9 @@
 component {
 
     this.name = 'TestBoxTestingSuite' & hash(getCurrentTemplatePath());
+    this.sessionManagement = true;
 
     this.mappings['/tests'] = getDirectoryFromPath(getCurrentTemplatePath());
     this.mappings['/root'] = REReplaceNoCase(this.mappings['/tests'], 'tests(\\|/)', '');;
 
-}
+}

tests/specs/AuthenticationSpec.cfc

@@ -23,6 +23,7 @@ component extends="testbox.system.BaseSpec" {
                 structDelete( variables, "requestStorageMock" );
                 structDelete( variables, "sessionStorageMock" );
                 structDelete( variables, "userMock" );
+                session = {};
             } );
 
             describe( "instantiating the user service", function() {
@@ -105,9 +106,9 @@ component extends="testbox.system.BaseSpec" {
                 describe( "getUser", function() {
                     it( "returns the currently logged in user component", function() {
                         requestStorageMock.$( "exists", false );
-                        requestStorageMock.$( "getVar", userMock );
+                        requestStorageMock.$( "get", userMock );
                         sessionStorageMock.$( "exists", true );
-                        sessionStorageMock.$( "getVar", 1 );
+                        sessionStorageMock.$( "get", 1 );
                         userServiceMock.$( "retrieveUserById" ).$args( 1 ).$results( userMock );
 
                         var actual = auth.getUser();
@@ -116,6 +117,7 @@ component extends="testbox.system.BaseSpec" {
                     } );
 
                     it( "throws an exception when trying to get the user without being logged in", function() {
+                        requestStorageMock.$( "exists", false );
                         sessionStorageMock.$( "exists", false );
 
                         expect( function() {
@@ -125,7 +127,7 @@ component extends="testbox.system.BaseSpec" {
 
                     it( "returns the user from the request if it exists", function() {
                         requestStorageMock.$( "exists", true );
-                        requestStorageMock.$( "getVar", userMock );
+                        requestStorageMock.$( "get", userMock );
 
                         auth.getUser();
 
@@ -134,17 +136,19 @@ component extends="testbox.system.BaseSpec" {
                         expect( sessionStorageCallLog )
                             .notToHaveKey( "exists", "[exists] should not be called on the SessionStorage" );
                         expect( sessionStorageCallLog )
-                            .notToHaveKey( "getVar", "[getVar] should not be called on the SessionStorage" );
+                            .notToHaveKey( "get", "[get] should not be called on the SessionStorage" );
                     } );
 
                     it( "caches the user from in request scope", function() {
+                        requestStorageMock.$( "exists", false );
                         sessionStorageMock.$( "exists", true );
-                        sessionStorageMock.$( "getVar", 1 );
+                        sessionStorageMock.$( "get", 1 );
+                        requestStorageMock.$( "get", 1 );
                         userServiceMock.$( "retrieveUserById" ).$args( 1 ).$results( userMock );
 
                         auth.getUser();
 
-                        expect( requestStorageMock.$once( "setVar" ) ).toBeTrue();
+                        expect( requestStorageMock.$once( "set" ) ).toBeTrue();
                         requestStorageMock.$( "exists", true );
 
                         auth.getUser();
@@ -153,17 +157,17 @@ component extends="testbox.system.BaseSpec" {
 
                         expect( sessionStorageCallLog.exists )
                             .toHaveLength( 1, "[exists] should only have been called once." );
-                        expect( sessionStorageCallLog.getVar )
-                            .toHaveLength( 1, "[getVar] should only have been called once." );
+                        expect( sessionStorageCallLog.get )
+                            .toHaveLength( 1, "[get] should only have been called once." );
                     } );
                 } );
 
                 describe( "user", function() {
                     it( "is an alias for getUser", function() {
                         requestStorageMock.$( "exists", false );
-                        requestStorageMock.$( "getVar", userMock );
+                        requestStorageMock.$( "get", userMock );
                         sessionStorageMock.$( "exists", true );
-                        sessionStorageMock.$( "getVar", 1 );
+                        sessionStorageMock.$( "get", 1 );
                         userServiceMock.$( "retrieveUserById" ).$args( 1 ).$results( userMock );
 
                         expect( auth.getUser() ).toBe( auth.user() );
@@ -174,28 +178,28 @@ component extends="testbox.system.BaseSpec" {
             describe( "logging in", function() {
                 it( "stores a user id in the session storage", function() {
                     auth.login( userMock );
-                    expect( sessionStorageMock.$once( "setVar" ) ).toBeTrue();
-                    expect( sessionStorageMock.$callLog().setVar[1][2] ) // first time called, second argument
-                        .toBe( userId, "User id of #userId# should have been passed to `setVar`." );
+                    expect( sessionStorageMock.$once( "set" ) ).toBeTrue();
+                    expect( sessionStorageMock.$callLog().set[1][2] ) // first time called, second argument
+                        .toBe( userId, "User id of #userId# should have been passed to `set`." );
                 } );
 
                 it( "sets the logged in user object in the request scope to save on multiple db requests", function() {
                     auth.login( userMock );
-                    expect( requestStorageMock.$once( "setVar" ) ).toBeTrue();
-                    expect( requestStorageMock.$callLog().setVar[1][2] ) // first time called, second argument
-                        .toBe( userMock, "User object should have been passed to `setVar`." );
+                    expect( requestStorageMock.$once( "set" ) ).toBeTrue();
+                    expect( requestStorageMock.$callLog().set[1][2] ) // first time called, second argument
+                        .toBe( userMock, "User object should have been passed to `set`." );
                 } );
             } );
 
             describe( "logging out", function() {
                 it( "logs a user out, regardless of if there was any user logged in", function() {
-                    sessionStorageMock.$( "deleteVar", true );
-                    requestStorageMock.$( "deleteVar", true );
+                    sessionStorageMock.$( "delete", true );
+                    requestStorageMock.$( "delete", true );
 
                     auth.logout();
 
-                    expect( sessionStorageMock.$once( "deleteVar" ) ).toBeTrue();
-                    expect( requestStorageMock.$once( "deleteVar" ) ).toBeTrue();
+                    expect( sessionStorageMock.$once( "delete" ) ).toBeTrue();
+                    expect( requestStorageMock.$once( "delete" ) ).toBeTrue();
                 } );
             } );
 
@@ -292,9 +296,9 @@ component extends="testbox.system.BaseSpec" {
 
                     auth.authenticate( validUsername, correctPassword );
 
-                    expect( sessionStorageMock.$once( "setVar" ) ).toBeTrue();
-                    expect( sessionStorageMock.$callLog().setVar[1][2] ) // first time called, second argument
-                        .toBe( userId, "User id of #userId# should have been passed to `setVar`." );
+                    expect( sessionStorageMock.$once( "set" ) ).toBeTrue();
+                    expect( sessionStorageMock.$callLog().set[1][2] ) // first time called, second argument
+                        .toBe( userId, "User id of #userId# should have been passed to `set`." );
                 } );
             } );
         } );
@@ -316,16 +320,13 @@ component extends="testbox.system.BaseSpec" {
     }
 
     function setUpSessionStorage() {
-        variables.sessionStorageMock = getMockBox()
-            .createMock( "modules.cbstorages.models.SessionStorage" );
-        sessionStorageMock.init();
-        sessionStorageMock.$( "setVar" );
+        variables.sessionStorageMock = getMockBox().createStub();
+        sessionStorageMock.$( "set" );
     }
 
     function setUpRequestStorage() {
-        variables.requestStorageMock = getMockBox().createMock( "modules.cbstorages.models.RequestStorage" );
-        requestStorageMock.init();
-        requestStorageMock.$( "setVar" );
+        variables.requestStorageMock = getMockBox().createStub();
+        requestStorageMock.$( "set" );
     }
 
     function setUpUserService() {