decanter 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba861d2437b9eb12f96d0ec704fd942bdc9d1883759b3e30b17b223e936c1c3e
-  data.tar.gz: f475da814ab3af68c80452de399a4f633403b9ff1fb5756087f9f0eac04b7679
+  metadata.gz: d88913e453daf9b338ba361c9d0bcf8bd460c6cbf8f9ba9c8690f8bb72072350
+  data.tar.gz: 4831a0a79c97caaf4ebe48123e2ae77baa5bf15a95b911e639ead8c43c428186
 SHA512:
-  metadata.gz: cce2d74bc1e8437510b4a10c586f1cfd67d914d63cd9571c88d3290f1fc08d0050e5950c16ced0b9696548c39b93bc0c20329c2633bd60196b48b8acca9f1c2f
-  data.tar.gz: 90a256b4b3a30e18017b7b4cf471b72425446319dd2ca0a516d9ecb475e014f7717dc7071ba5898d24c9720d562991e228edbbc0e15eb5757d4443d3687d3b37
+  metadata.gz: 5b16bca4f276b1aceefb952104e38675ba0bea4792ef4d9b30e61d1b0501ed1dff9d832f97cb17cc2db62711c644e12183900ded11d6382dea0830a91f38c28a
+  data.tar.gz: 19b9c671278b61dc7a903f2df4861c606914585165bfa3bfd81f82d950db6fa02328ee3d25ead2dd9048690b92238856d7fd8b833def2bc40b045d405c3a4832

data/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,33 @@
+---
+name: Bug Report
+about: Report a bug with Decanter
+labels: bug
+---
+
+<!--
+  Please fill out this template with all the relevant information so we can
+  understand what's going on and fix the issue. We encourage you to submit a PR
+  to fix the reported issue!
+-->
+
+## Environment
+
+- `decanter` version:
+- `ruby` version:
+- `rails` version:
+
+## Expected Behavior
+
+## Current Behavior
+
+## Steps to Reproduce
+<!--
+  If possible, please create a repository that reproduces the issue with the
+minimal amount of code possible.
+-->
+
+## Suggested Solution
+<!--
+It's ok if you don't have a suggested solution, but please let us know if you
+have any ideas!
+-->

data/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,18 @@
+---
+name: Feature Request
+about: Suggest a feature for Decanter
+labels: enhancement
+---
+
+## Feature Description
+
+## Suggested Solution
+<!--
+It's ok if you don't have a suggested solution, but please let us know if you
+have any ideas!
+-->
+
+## Alternatives Considered / Existing Workarounds
+
+## Additional Context
+<!-- Add other information, screenshots, etc. about the request here -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+## Items Addressed
+<!-- Include description and link to resolved issue(s) here. -->
+
+## Author Checklist
+- [ ] Add unit test(s)
+- [ ] Update documentation (if necessary)
+- [ ] Update version in `version.rb` following [versioning guidelines](https://github.com/LaunchPadLab/opex/blob/master/gists/gem-guidelines.md#pull-requests-and-deployments)
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, 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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [conor@launchpadlab.com](mailto:conor@launchpadlab.com). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+Thanks for your interest in contributing! This project follows our [Gem guidelines](https://github.com/LaunchPadLab/opex/blob/master/gists/gem-guidelines.md).
+
+## Code of Conduct
+
+We expect all participants to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## How Can I Contribute?
+
+There are several ways to contribute to this project, including (but not limited to):
+
+- Reporting bugs
+- Requesting features
+- Responding to bug reports / feature requests
+- Submitting PR(s) that address issues labeled with "help wanted"
+- Updating documentation
+
+Before making a contribution, search through the existing [issues](https://github.com/LaunchPadLab/decanter/issues) and [pull requests](https://github.com/LaunchPadLab/decanter/pulls) to see if your item has already been raised or addressed. If there is an existing **open** issue that impacts you, it is best practice to upvote (👍) the initial comment as opposed to adding an additional comment voicing your support. The latter creates noise for the LaunchPad Lab team and makes it difficult for us to quickly and effectively rank issues according to the community's priority.
+
+## Getting Started Locally
+1. Fork and clone the repo
+1. Run `bundle` to install dependencies
+1. Run `rspec` to run unit tests
+1. Load development changes in a local application in your Gemfile
+    ```ruby
+    gem "decanter", path: "/path/to/repo"
+    ```
+
+## Proposing a Change
+For any non-trivial change, we prefer an issue to be created first. This helps us (and you!) save time and keep track of conversations and decisions made regarding the project.
+
+### Sending a Pull Request
+If this is your first Pull Request, we recommend learning how to navigate GitHub via this free video tutorial: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
+
+The LaunchPad Lab team monitors this repository for pull requests. Once a pull request has been created from a forked repository that **meets all the guidelines** outlined in the [Pull Request Checklist](.github/PULL_REQUEST_TEMPLATE.md), we will review the request and either merge it, request changes, or close it with an explanation. We aim to respond to pull requests within 48 hours. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (3.0.0)
+    decanter (3.0.1)
       actionpack (>= 4.2.10)
       activesupport
       rails-html-sanitizer (>= 1.0.4)

data/README.md

@@ -1,14 +1,17 @@
 # Decanter
 
-Decanter is a Ruby gem that makes it easy to transform incoming data before it hits the model.
+Decanter is a Ruby gem that makes it easy to transform incoming data before it hits the model. You can think of Decanter as the opposite of Active Model Serializers (AMS). While AMS transforms your outbound data into a format that your frontend consumes, Decanter transforms your incoming data into a format that your backend consumes.
 
 ```ruby
 gem 'decanter', '~> 3.0'
 ```
 
+## Migration Guides
+
+- [v3.0.0](migration-guides/v3.0.0.md)
+
 ## Contents
 
-- [Migration guides](#migration-guides)
 - [Basic Usage](#basic-usage)
   - [Decanters](#decanters)
   - [Generators](#generators)
@@ -22,10 +25,7 @@ gem 'decanter', '~> 3.0'
   - [Chaining parsers](#chaining-parsers)
   - [Requiring params](#requiring-params)
   - [Global configuration](#global-configuration)
-
-## Migration Guides
-
-- [v3.0.0](migration-guides/v3.0.0.md)
+- [Contributing](#contributing)
 
 ## Basic Usage
 
@@ -43,14 +43,15 @@ class TripDecanter < Decanter::Base
 end
 ```
 
-Transform incoming params in your controller using `Decanter#decant`:
+Then, transform incoming params in your controller using `Decanter#decant`:
 
 ```rb
 # app/controllers/trips_controller.rb
 
   def create
-    trip_params = TripDecanter.decant(params[:trip])
-    @trip = Trip.new(trip_params)
+    trip_params = params.require(:trip) # or params[:trip] if you are not using Strong Parameters
+    decanted_trip_params = TripDecanter.decant(trip_params)
+    @trip = Trip.new(decanted_trip_params)
 
     # ...any response logic
   end
@@ -79,6 +80,8 @@ class TripDecanter < Decanter::Base
 end
 ```
 
+This decanter will look up and apply the corresponding `DestinationDecanter` whenever necessary to transform nested resources.
+
 ### Default parsers
 
 Decanter comes with the following parsers out of the box:
@@ -107,8 +110,6 @@ Parsers can receive options that modify their behavior. These options are passed
 input :start_date, :date, parse_format: '%Y-%m-%d'
 ```
 
-This decanter will look up and apply the corresponding `DestinationDecanter` whenever necessary to transform nested resources.
-
 ### Exceptions
 
 By default, `Decanter#decant` will raise an exception when unexpected parameters are passed. To override this behavior, you can disable strict mode:
@@ -230,3 +231,11 @@ Decanter.config do |config|
   config.strict = false
 end
 ```
+
+## Contributing
+
+This project is maintained by developers at [LaunchPad Lab](https://launchpadlab.com/). Contributions of any kind are welcome!
+
+We aim to provide a response to incoming issues within 48 hours. However, please note that we are an active dev shop and these responses may be as simple as _"we do not have time to respond to this right now, but can address it at {x} time"_.
+
+For detailed information specific to contributing to this project, reference our [Contribution guide](CONTRIBUTING.md).

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -132,10 +132,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/BUG_REPORT.md"
+- ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt