Merge pull request #158 from simplabs/exists

Add method to check whether a cookie exists

README.md

@@ -47,13 +47,17 @@ export default Ember.Controller.extend({
 
 The `cookies` service has methods for reading and writing cookies:
 
-* `read(name, options = {})`: reads the cookie with the given name, returns its value as a
-  `String`; options can be used to set `raw` (boolean, disables URL-decoding the value).
+* `read(name, options = {})`: reads the cookie with the given name, returns its
+  value as a `String`; options can be used to set `raw` (boolean, disables
+  URL-decoding the value).
 * `write(name, value, options = {})`: writes a cookie with the given name and
-  value; options can be used to set `domain`, `expires` (Date), `maxAge` (time in seconds), `path`, `secure`,
-  and `raw` (boolean, disables URL-encoding the value).
+  value; options can be used to set `domain`, `expires` (Date), `maxAge` (time
+  in seconds), `path`, `secure`, and `raw` (boolean, disables URL-encoding the
+  value).
 * `clear(name, options = {})`: clears the cookie so that future reads do not
   return a value; options can be used to specify `domain`, `path` or `secure`.
+* `exists(name)`: checks whether a cookie exists at all (even with a falsy
+  value) and returns `true` if that is the case or `false` otherwise.
 
 ## License
 

addon/services/cookies.js

@@ -30,7 +30,7 @@ export default Service.extend({
     return filtered.reduce((acc, cookie) => {
       if (!isEmpty(cookie)) {
         let [key, value] = cookie;
-        acc[key.trim()] = value.trim();
+        acc[key.trim()] = (value || '').trim();
       }
       return acc;
     }, {});
@@ -92,6 +92,17 @@ export default Service.extend({
     this.write(name, null, options);
   },
 
+  exists(name) {
+    let all;
+    if (this.get('_isFastBoot')) {
+      all = this.get('_fastBootCookies');
+    } else {
+      all = this.get('_documentCookies');
+    }
+
+    return all.hasOwnProperty(name);
+  },
+
   _writeDocumentCookie(name, value, options = {}) {
     let serializedCookie = this._serializeCookie(name, value, options);
     this.set('_document.cookie', serializedCookie);
@@ -178,7 +189,7 @@ export default Service.extend({
 
   _filterDocumentCookies(unfilteredCookies) {
     return unfilteredCookies.map((c) => c.split('='))
-      .filter((c) => isPresent(c[0]) && isPresent(c[1]));
+      .filter((c) => c.length === 2 && isPresent(c[0]));
   },
 
   _serializeCookie(name, value, options = {}) {

tests/unit/services/cookies-test.js

@@ -138,8 +138,9 @@ describe('CookiesService', function() {
         expect(afterRoundtrip).to.eq(value);
       });
 
-      it('handles invalid values for cookies', function() {
+      it('handles invalid cookies', function() {
         document.cookie = '=blank';
+
         expect(this.subject().read('')).to.deep.equal({});
       });
 
@@ -390,6 +391,25 @@ describe('CookiesService', function() {
       });
     });
 
+    describe("checking for a cookie's existence", function() {
+      it('returns true when the cookie exists', function() {
+        let value = randomString();
+        document.cookie = `${COOKIE_NAME}=${value};`;
+
+        expect(this.subject().exists(COOKIE_NAME)).to.be.true;
+      });
+
+      it('returns true when the cookie exists with a falsy value', function() {
+        document.cookie = `${COOKIE_NAME}=;`;
+
+        expect(this.subject().exists(COOKIE_NAME)).to.be.true;
+      });
+
+      it('returns false when the cookie does not exist', function() {
+        expect(this.subject().exists(COOKIE_NAME)).to.be.false;
+      });
+    });
+
     itReadsAfterWrite.apply(this);
   });
 
@@ -708,6 +728,25 @@ describe('CookiesService', function() {
       });
     });
 
+    describe("checking for a cookie's existence", function() {
+      it('returns true when the cookie exists', function() {
+        let value = randomString();
+        this.subject().write(COOKIE_NAME, value);
+
+        expect(this.subject().exists(COOKIE_NAME)).to.be.true;
+      });
+
+      it('returns true when the cookie exists with a falsy value', function() {
+        this.subject().write(COOKIE_NAME);
+
+        expect(this.subject().exists(COOKIE_NAME)).to.be.true;
+      });
+
+      it('returns false when the cookie does not exist', function() {
+        expect(this.subject().exists(COOKIE_NAME)).to.be.false;
+      });
+    });
+
     itReadsAfterWrite.apply(this);
   });
 });