cuprum-collections 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53ab28a09a25a4de8a7ca405a3f59b45b5b9cec3fc0acd243a8815bfdfee80ae
+  data.tar.gz: aef7d1257fd0997c284a1cad91118086ae2672789fe40d9648fc6a553fb70abd
+SHA512:
+  metadata.gz: 2f9544cd606500cca431300aa4432ab58a475fbb2ee6c813bbdef36d8a10a5cec3eea7b219eb16dfcf4a810fa022154e554e61373ad47e080818933f97f76d74
+  data.tar.gz: 46f80cf9f3d575e564a46230fc65c984d4886f7f23ca62cdd2454f528a9d2f96fc70e31d23f222c7acd944ab5f5a9a468f94ed3a928a191d5bdaf0057219288a

data/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+## 0.1.0
+
+Initial version.
+
+## Collections
+
+Implemented `Basic::Collection` and associated commands:
+
+- `Basic::Commands::AssignOne`
+- `Basic::Commands::BuildOne`
+- `Basic::Commands::DestroyOne`
+- `Basic::Commands::FindMany`
+- `Basic::Commands::FindMatching`
+- `Basic::Commands::FindOne`
+- `Basic::Commands::InsertOne`
+- `Basic::Commands::UpdateOne`
+- `Basic::Commands::ValidateOne`
+
+Implemented `Basic::Query`
+
+Defined contract for validating collections.
+
+## Commands
+
+Defined contracts for validating collection commands.
+
+## Constraints
+
+Implemented collection constraints:
+
+- `AttributeName`
+- `Order::SortDirection`
+- `Ordering`
+- `QueryHash`
+
+ `AttributeName`, `Ordering`, and `QueryHash` constraints.
+
+## Errors
+
+Implemented collection errors:
+
+- `AlreadyExists`
+- `ExtraAttributes`
+- `FailedValidation`
+- `InvalidParameters`
+- `InvalidQuery`
+- `MissingDefaultContract`
+- `NotFound`
+- `UnknownOperator`
+
+## Queries
+
+Implemented abstract `Query`.
+
+Implemented `ParseBlock` strategy.
+
+Defined contract for validating collection queries.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, 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 community leaders responsible for enforcement at
+merlin@sleepingkingstudios.com.
+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.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+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.0]: https://www.contributor-covenant.org/version/2/0/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

data/DEVELOPMENT.md

@@ -0,0 +1,25 @@
+# Development
+
+## Queries
+
+### Operators
+
+Steps to add an operator:
+
+- Update Queries::Operators.
+- Update Queries::ParseBlock::Builder.
+- Define context(s) in RSpec::QUERYING_CONTEXTS.
+- Add test cases in RSpec::QUERYING_CONTRACT.
+- Add implementations to Basic::QueryBuilder.
+
+### ParseCriteria
+
+Validates and returns an Array of criteria.
+
+### ParseHash
+
+All values use :eq operator.
+
+### ParseQuery
+
+Extends ParseCriteria, passes Query#criteria to super.

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2020 Rob Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.