stannum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e4e097d69d42e93658309a2d4415742bdbeb66d48981f89a0a8b486c6935582
+  data.tar.gz: 2fdf05503a9fd0e480c30fe45283c1e21dae6701cf79599a0a39ace8717d587f
+SHA512:
+  metadata.gz: a650ec61bfc9997fef0ba824670b570c07e57089bde90c81a63fda2a5caaa3a6edfcf2075f2b4060bc25299858715bb8e97eca0548d4d729b9300a864c5cb141
+  data.tar.gz: 50ed1712df35e1ac05d88c0661be728e10d77df2fecfd6b521e5b3a35c1045e54f4a88c0c9a715d14f24ea4ab5e6f9c25c17c5bf526abf3271a0a19bb1df5617

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## 0.1.0
+
+Initial version.
+
+### Constraints
+
+Defined `Stannum::Constraint`.
+
+### Contracts
+
+Defined `Stannum::Contract`.
+
+### Errors
+
+Defined `Stannum::Errors`.
+
+### Structs
+
+Defined `Stannum::Struct`.

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,105 @@
+# Stannum Development
+
+## Documentation
+
+- Should provide a one-line short description.
+- Should provide a one+ paragraph short description.
+- Should document what errors look like in various circumstances.
+- Should provide examples of passing and failing objects.
+- Should document the methods.
+
+## Future Versions
+
+- What happens to a frozen constraint? A frozen contract?
+  - Should freezing a contract freeze its constraints? #deep_freeze ?
+
+### Constraints
+
+- Constraints::Always
+  - #does_not_match? and #matches? always return true
+- Constraints::Equality
+  - asserts actual == expected
+- Constraints::Never
+  - #does_not_match? and #matches? always return false
+- Constraints::Numeric
+  - asserts actual is numeric value
+  - options for integer, greater/less than
+- Constraints::Range
+  - asserts actual in range
+  - initialize with range or params
+    - max and/or min, gt/gte and/or lt/lte
+- Constraints::Size
+  - options for :is, :max, :min - delegate to Constraints::Range?
+
+#### Type Constraints
+
+- .instance method (caches instance by params (if any))
+  - a large application does not need 50 Type::String objects
+- Types::ArrayType
+  - add support for allowing/disallowing empty arrays (default to allowed)
+- Types::HashType
+  - add support for allowing/disallowing empty hashes (default to allowed)
+- Types::StringType
+  - add support for allowing/disallowing empty strings (default to allowed)
+- Types::SymbolType
+  - add support for allowing/disallowing empty symbols (default to allowed)
+- Types::Union
+  - redefine IndifferentKey as subclass ?
+
+### Contracts
+
+#### ::Builder
+
+- Implement #concat(contract):
+  ```ruby
+  contract = Stannum::Contract.new do
+    concat(OtherContract)
+  end
+  ```
+
+#### DSL
+
+- Define a DSL for adding constraints to a contract at the class level:
+  ```ruby
+  class CustomContract < HashContract
+    compose    OtherContract
+    constraint SomeConstraint
+    property   :property_name, PropertyConstraint
+    key        :key,           KeyConstraint
+  end
+  ```
+- Must be heritable.
+- Each class defines list of tuples [method_name, \*args, \*\*kwargs, &block]
+  - Enumerable over ancestors!
+- Passed to Builder ahead of the block.
+  - Builder executes each method.
+- Revise integration specs!
+
+### Errors
+
+- clean up error types
+- #generate_message(error)
+  - creates default string based on :type
+- #generate_messages
+  - for each error:
+    - if error.message present, no change
+    - set message to generate_message(error)
+- #include?(type OR hash)
+  - if type, call include?(type: type)
+  - errors.any? { |actual| actual >= expected }
+
+#### Strategies
+
+- I18n strategy
+
+### RSpec
+
+- MatchConstraint matcher (#match_constraint macro)
+- Matcher mixin - use a constraint in place of an RSpec matcher!
+
+### Support
+
+- Stannum::Support::Validations
+  - raise exception on invalid params
+  - #validate_integer
+  - #validate_name

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2019 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.