cuprum 0.10.0 → 1.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87866e465634782fef9cd2ce7bebf42f56eeb789d235874a280134e6d2431104
-  data.tar.gz: e60264b79e82f77f5cbc2149c6522f0ef74fad2c198238ea6db3338ba3e35ce3
+  metadata.gz: 1acf1f03e1b78fd7c90cb8b3eb96bd2ba8771b29dd92c743a7580c22700919df
+  data.tar.gz: 07eae29a24b5819cf80c646c016fb7e0508ffe93f5820795a74d1c2dfdbd6bf4
 SHA512:
-  metadata.gz: 89aa00632c89bfddcc3063d0aff7344af81e36e4568d6899ef16c5a80b464ae43f7b530f689fb6a8e8f7e2c3987ee4463014744ab242b20828959483e070d968
-  data.tar.gz: 05cf7814eeff05e179bc006d1a9c80f8bc3ca7b9e4ca12256b34f65bc6aa1ba253e12a2c00fe411e38162b65d9d1a5a1ac6a3df3e820af40cec2944291b6e3a5
+  metadata.gz: cec2ebc229e0507dde9ca02aedf2bd93f55161151eef230f43408d4e39d7ab8b8711c655c72d4b193733f9a2b235e95cb390c57cccebb61f6e129915b261588c
+  data.tar.gz: d10c6180899006af62022ac1f9543897d258f8407a3dfca56d270f0eba356a7aabd418234330901dd3b8e3c55de27f07e9ae4c2c37398056800331bd8b6ae8f1

data/CHANGELOG.md

@@ -1,6 +1,64 @@
 # Changelog
 
-## 0.10
+## 1.0.0
+
+The "Look On My Works, Ye Mighty, and Despair" Update
+
+#### Steps
+
+Removed calling `#step` with a method name.
+
+## 0.11.0
+
+The "One Giant Leap" Update
+
+**Note:** This will be the last feature update before 1.0.
+
+### Commands
+
+Implemented the `#to_proc` method, which allows for constructs such as `array.map(&command)`.
+
+Removed the deprecated chaining mechanic.
+
+#### Currying
+
+Added support for currying block parameters.
+
+#### Exception Handling
+
+Defined `Cuprum::ExceptionHandling` to rescue uncaught errors in commands.
+
+Exception handling is *not* included by default - add `include Cuprum::ExceptionHandling` to your command classes to use this feature.
+
+#### Middleware
+
+Defined `Cuprum::Middleware` to define a wrapper that calls other commands.
+
+#### Steps
+
+Deprecated calling `#step` with a method name.
+
+The error type and message when calling `#steps` without a block has changed.
+
+### Errors
+
+Errors can now define their comparable properties by passing additional keywords to the constructor (or `super` for error subclasses).
+
+Added the `#type` method and property.
+
+Added serialization via the `#as_json` method.
+
+### Matchers
+
+Implemented `Cuprum::Matcher`, which provides a way to handle different result cases.
+
+### RSpec
+
+Added the `#be_callable` macro, which is a wrapper for `#respond_to` that references the `#process` method.
+
+RSpec matchers are no longer automatically included when the macro is required. To use the Cuprum matchers, add `config.include Cuprum::RSpec::Matchers` to your RSpec configuration, or add `include Cuprum::RSpec::Matchers` to your example groups.
+
+## 0.10.0
 
 The "One Small Step" Update
 
@@ -12,7 +70,7 @@ Implemented the `#curry` method, which performs partial application of arguments
 
 #### Chaining
 
-Added deprecation warnings to all chaining methods, and `Cuprum::Command` no longer includes `Cuprum::Chaining` by default. The `Cuprum::Chaining` module will be removed in version 1.0.
+Added deprecation warnings to all chaining methods, and `Cuprum::Command` no longer includes `Cuprum::Chaining` by default. The `Cuprum::Chaining` module will be removed in version 0.11.
 
 #### Steps
 

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

@@ -1,34 +1,9 @@
 # Development
 
-## Version 1.0.0
-
-The "Look On My Works, Ye Mighty, and Despair" Update
-
-- Integration specs.
-- Code cleanup: Hash syntax, remove end comments, remove file headers
-- Status Badges!
-
-Steps Case Study: |
-
-  CMS application - creating a new post.
-  Directory has many Posts
-  Post has a Content
-  Content has many ContentVersions
-  Post has many Tags
-
-  Find Directory
-  Create Post
-  Create Content
-  Create ContentVersion
-  Tags.each { FindOrCreate Tag }
-
-### Commands
-
-- Remove `Cuprum::Chaining`.
-- Implement `Command#to_proc`.
-
 ## Future Versions
 
+Add `.rbs` files
+
 ### Commands
 
 - Implement #<<, #>> composition methods.
@@ -60,19 +35,10 @@ Steps Case Study: |
 - RetryCommand - takes command, retry count
   - optional only:, except: - restrict what errors are retried
 
-### Matcher
-
-- Handle success(), failure(), failure(SomeError) cases.
-  - Custom matcher to handle additional cases - halted, pending, etc?
-
 ### Middleware
 
 - Implement Command.subclass
   - Curries constructor arguments
-- Implement Cuprum::Middleware
-  - #process takes next command, \*args, \*\*kwargs
-    - calls next command with \*args, \*\*kwargs
-  - .apply takes middleware: array, root: command
 - Implement Cuprum::AppliedMiddleware < Cuprum::Command
   - has readers #root (Class), #middleware (Array<Class>)
   - #initialize
@@ -87,8 +53,6 @@ Steps Case Study: |
 
 ### RSpec
 
-- be_callable matcher - delegates to respond_to(), but check arguments of
-  private #process method
 - call_command_step matcher
 - (optionally) alias be_a_result family as have_result for operations