Closes Issue #27

Author: lmaccherone

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the primary community leader by private DM to 
+[Larry on LinkedIn](https://www.linkedin.com/in/LarryMaccherone/). 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+
+# Contributing to node-localstorage
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. The community looks forward to your contributions. 🎉
+
+## I Have a Question
+
+Before you ask a question read the available [documentation](https://github.com/lmaccherone/node-localstorage/blob/master/README.md) and search for existing [issues](https://github.com/lmaccherone/node-localstorage/issues) that might help you. In case you have found a suitable issue but need more clarification, you can write your question as a comment in the issue.
+
+If you then still need to ask a question, then feel free open an [Issue](https://github.com/lmaccherone/node-localstorage/issues/new).
+
+We will respond to the issue as soon as possible.
+
+
+## I Want To Contribute
+
+> ### Legal Notice 
+> Contributions must be free of any encumberance. Contributions are an attestation that you have the necessary authority to contribute it under the project license. By making a contribution of code or documentation, you agree to donate rights to the contribution to the project for the project to do with it whatever it wishes including but not limited to offering the project under a different license.
+
+### Reporting Bugs
+
+> #### Security Issues 
+> You must never report security related issues, including vulnerabilities or the presence of sensitive information, to the issue tracker or elsewhere in public. See [SECURITY.md](https://github.com/lmaccherone/node-localstorage/blob/master/SECURITY.md) for instructions on how to report security issues.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/lmaccherone/node-localstorage/issues/new).
+- Explain the behavior you would expect and the actual behavior.
+- The working agreement for this project is that the first step in fixing a bug is reproducing it in an automated test case, so the ideal bug report includes a failing test case but at the very least should include enough information for someone to reproduce it and write a test case. If you can't reproduce it, we can't fix it.
+- Make sure that your preferences are set so that you are notified when the issue is updated. This will allow you to respond to any questions or requests for additional information.
+
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/lmaccherone/node-localstorage/issues).
+
+Steps to suggest an enhancement:
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://github.com/lmaccherone/node-localstorage/blob/master/README.md) carefully and find out if the functionality is already covered, maybe with an optional parameter or configuration.
+- Perform a [search](https://github.com/lmaccherone/node-localstorage/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue in support rather than opening a new one.
+- Think about whether your idea fits with the scope and goals of the project.
+- Open an [Issue](https://github.com/lmaccherone/node-localstorage/issues/new).
+- Describe the enhancement and the motivation behind it. If your enhancement targets a minority of users or is backward breaking propose it as optional with additional parameters or configuration.
+
+
+### Your First  Contribution
+
+Use the steps below to make your first code or documentation contribution to the project:
+
+- Fork the [repository](https://github.com/lmaccherone/node-localstorage/fork) into your account.
+- Make your changes in your fork.
+- Be sure to keep the style consistent with the existing code or documentation.
+- If your contribution adds new functionality, make sure that you add tests for both the happy path and unexpected inputs.
+- If your contribution fixes a bug, start by writing a failing test the duplicates the bug, then modify the code so the test no longer fails. Then go back and write more tests to cover any other cases similar to the one you just fixed.
+
+
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

LocalStorage.coffee

@@ -76,16 +76,30 @@ class LocalStorage extends events.EventEmitter
         set: (receiver, key, value) =>
           if @[key]?
             @[key] = value
-            return true
           else
             @setItem(key, value)
+          return true
 
         get: (receiver, key) =>
           if @[key]?
             return @[key]
           else
             return @getItem(key)
 
+        ownKeys: (target) =>
+          return @_keys.map((k) -> 
+            if k is KEY_FOR_EMPTY_STRING
+              ''
+            else
+              k
+          )
+
+        getOwnPropertyDescriptor: (target, key) =>
+          return
+            value: @[key]
+            enumerable: true
+            configurable: true
+
       instanceMap[@_location] = new Proxy(this, handler)
       return instanceMap[@_location]
 

SECURITY.md

@@ -15,6 +15,5 @@ receiving such patches depend on the CVSS v3.0 Rating:
 Please report (suspected) security vulnerabilities by private DM to 
 [Larry on LinkedIn](https://www.linkedin.com/in/LarryMaccherone/). 
 You will receive a response within 48 hours. If the issue is confirmed, 
-
 I will release a patch as soon as possible depending on complexity
 but historically within a few days.

test/es6-test.coffee

@@ -13,6 +13,8 @@ tape('array and dot notation', (test) =>  # TODO: These tests are inadequate in
   localStorage.b = 1
   test.equal(localStorage['b'], '1')
 
+  test.deepEqual(Object.keys(localStorage), ['a', '', 'b'])
+
   localStorage._deleteLocation()
   test.end()
 )

test/localstorage-test.coffee

@@ -37,7 +37,6 @@ tape('localStorage API', (test) =>
   test.equal(localStorage.length, 0)
 
   localStorage._deleteLocation()
-
   test.end()
 )
 
@@ -93,6 +92,7 @@ tape('remove keys', (test) =>
   localStorage.setItem('d', 'hello')
 
   test.deepEqual(localStorage._keys, ['a', 'b', 'c', 'd'])
+  test.deepEqual(Object.keys(localStorage), ['a', 'b', 'c', 'd'])
   localStorage.removeItem('c')
   test.deepEqual(localStorage._keys, ['a', 'b', 'd'])
   localStorage.removeItem('a');
@@ -101,6 +101,7 @@ tape('remove keys', (test) =>
   test.deepEqual(localStorage._keys, ['d'])
   localStorage.removeItem('d')
   test.deepEqual(localStorage._keys, [])
+  test.deepEqual(Object.keys(localStorage), [])
 
   localStorage._deleteLocation()
   test.end()