decanter 2.1.1 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3654e21a112ba4cfb15d661f705c72d1dffcffdec9ab3838ade05473929f8f0b
-  data.tar.gz: 62e14a4b78b57c911a4224ad00a5cefd3429499be6cf64e977807f3c4491d124
+  metadata.gz: 41a34deb5031de28979d99cb09d64538b2d718435d5d7786626c5d62c81021d1
+  data.tar.gz: a897bf8bccc8f3d282299a6d1f0f68a70dcdbaabd6b9b8ab933b52e619cd0e26
 SHA512:
-  metadata.gz: bf1b5b3fc1186296ab4f6d86e5c136cd2bda1df67a6a85e13d97cc2fc0e52616f301bc1b171cbe8f4f6e77e15609c5cd7394141ac952c1fd4bdaaac38d468ba0
-  data.tar.gz: f9f96171bf2b53c3250b978632513e79bcb3ad960f9cde88b482ec03f24292c7c4416c440b78d7b93e657c696d0e2ef9b1e00e3c4d27104bebe531a9e2f5265a
+  metadata.gz: d4409ea087acc2122ca50cdd57daf6edbf1fd08b2c34f3386c9ba8d1989e14ef60c648f45d0d3eaffdc14813b26d4c277d9abedbcb6b8424f404a8f1096eb161
+  data.tar.gz: 1fe1e1b5939338bca63153421810649afdadc2b169d45f5823bcd437f7229aa56bb8e4baceddf7c31e7c7fbe7624d49e3bf94820587e11f455727bbb49a87aee

data/.codeclimate.yml

@@ -0,0 +1,38 @@
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/Documentation:
+        enabled: false
+      Rubocop/Metrics/LineLength:
+        enabled: false
+      Rubocop/Rails/Validation:
+        enabled: false
+      Rubocop/Style/IndentationConsistency:
+        enabled: false
+      Rubocop/Style/EmptyLines:
+        enabled: false
+      Rubocop/Style/ClassAndModuleChildren:
+        enabled: false
+      Rubocop/Style/AccessorMethodName:
+        enabled: false
+  golint:
+    enabled: true
+  gofmt:
+    enabled: true
+  eslint:
+    enabled: true
+  csslint:
+    enabled: true
+  brakeman:
+    enabled: false
+  bundler-audit:
+    enabled: true
+ratings:
+   paths:
+   - lib/**
+   - "**.rb"
+exclude_paths:
+- bin/**/*
+- spec/**/*
+- coverage/**/*

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-public/blob/master/gists/gem-guidelines.md#pull-requests-and-deployments)
+

data/.gitignore

@@ -0,0 +1,5 @@
+/coverage
+.env
+.DS_Store
+# Builds for push
+decanter-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+cache:
+  bundler: true
+
+script:
+  - bundle exec rspec
+
+notifications:
+  email: false

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-public/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

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in goaltender.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    decanter (3.1.1)
+      actionpack (>= 4.2.10)
+      activesupport
+      rails-html-sanitizer (>= 1.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dotenv (2.2.1)
+    erubi (1.7.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.4)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  decanter!
+  dotenv
+  rake (~> 10.0)
+  rspec-rails
+  simplecov (~> 0.15.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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.

data/README.md

@@ -0,0 +1,241 @@
+# Decanter
+
+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
+
+- [Basic Usage](#basic-usage)
+  - [Decanters](#decanters)
+  - [Generators](#generators)
+  - [Nested resources](#nested-resources)
+  - [Default parsers](#default-parsers)
+  - [Parser options](#parser-options)
+  - [Exceptions](#exceptions)
+- [Advanced usage](#advanced-usage)
+  - [Custom parsers](#custom-parsers)
+  - [Squashing inputs](#squashing-inputs)
+  - [Chaining parsers](#chaining-parsers)
+  - [Requiring params](#requiring-params)
+  - [Global configuration](#global-configuration)
+- [Contributing](#contributing)
+
+## Basic Usage
+
+### Decanters
+
+Declare a `Decanter` for a model:
+
+```ruby
+# app/decanters/trip_decanter.rb
+
+class TripDecanter < Decanter::Base
+  input :name, :string
+  input :start_date, :date
+  input :end_date, :date
+end
+```
+
+Then, transform incoming params in your controller using `Decanter#decant`:
+
+```rb
+# app/controllers/trips_controller.rb
+
+  def create
+    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
+
+```
+
+### Generators
+
+Decanter comes with generators for creating `Decanter` and `Parser` files:
+
+```
+rails g decanter Trip name:string start_date:date end_date:date
+```
+
+```
+rails g parser TruncatedString
+```
+
+### Nested resources
+
+Decanters can declare relationships using `ActiveRecord`-style declarators:
+
+```ruby
+class TripDecanter < Decanter::Base
+  has_many :destinations
+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:
+
+- `:boolean`
+- `:date`
+- `:date_time`
+- `:float`
+- `:integer`
+- `:pass`
+- `:phone`
+- `:string`
+- `:array`
+
+Note: these parsers are designed to operate on a single value, except for `:array`. This parser expects an array, and will use the `parse_each` option to call a given parser on each of its elements:
+
+```ruby
+input :ids, :array, parse_each: :integer
+```
+
+### Parser options
+
+Parsers can receive options that modify their behavior. These options are passed in as named arguments to `input`:
+
+```ruby
+input :start_date, :date, parse_format: '%Y-%m-%d'
+```
+
+### Exceptions
+
+By default, `Decanter#decant` will raise an exception when unexpected parameters are passed. To override this behavior, you can disable strict mode:
+
+```ruby
+class TripDecanter <  Decanter::Base
+  strict false
+  # ...
+end
+```
+
+Or explicitly ignore a key:
+
+```rb
+class TripDecanter <  Decanter::Base
+  ignore :created_at, :updated_at
+  # ...
+end
+```
+
+You can also disable strict mode globally using a [global configuration](#global-configuration) setting.
+
+## Advanced Usage
+
+### Custom Parsers
+
+To add a custom parser, first create a parser class:
+
+```rb
+# app/parsers/truncate_string_parser.rb
+class TruncateStringParser < Decanter::Parser::ValueParser
+
+  parser do |value, options|
+    length = options.fetch(:length, 100)
+    value.truncate(length)
+  end
+end
+```
+
+Then, use the appropriate key to look up the parser:
+
+```ruby
+  input :name, :truncate_string #=> TruncateStringParser
+```
+
+#### Custom parser methods
+
+- `#parse <block>`: (required) recieves a block for parsing a value. Block parameters are `|value, options|` for `ValueParser` and `|name, value, options|` for `HashParser`.
+- `#allow [<class>]`: skips parse step if the incoming value `is_a?` instance of class(es).
+- `#pre [<parser>]`: applies the given parser(s) before parsing the value.
+
+#### Custom parser base classes
+
+- `Decanter::Parser::ValueParser`: subclasses are expected to return a single value.
+- `Decanter::Parser::HashParser`: subclasses are expected to return a hash of keys and values.
+
+### Squashing inputs
+
+Sometimes, you may want to take several inputs and combine them into one finished input prior to sending to your model. You can achieve this with a custom parser:
+
+```ruby
+class TripDecanter < Decanter::Base
+  input [:day, :month, :year], :squash_date, key: :start_date
+end
+```
+
+```ruby
+class SquashDateParser < Decanter::Parser::ValueParser
+  parser do |values, options|
+    day, month, year = values.map(&:to_i)
+    Date.new(year, month, day)
+  end
+end
+```
+
+### Chaining parsers
+
+You can compose multiple parsers by using the `#pre` method:
+
+```ruby
+class FloatPercentParser < Decanter::Parser::ValueParser
+
+  pre :float
+
+  parser do |val, options|
+    val / 100
+  end
+end
+```
+
+Or by declaring multiple parsers for a single input:
+
+```ruby
+class SomeDecanter < Decanter::Base
+  input :some_percent, [:float, :percent]
+end
+```
+
+### Requiring params
+
+If you provide the option `:required` for an input in your decanter, an exception will be thrown if the parameter is `nil` or an empty string.
+
+```ruby
+class TripDecanter <  Decanter::Base
+  input :name, :string, required: true
+end
+```
+
+_Note: we recommend using [Active Record validations](https://guides.rubyonrails.org/active_record_validations.html) to check for presence of an attribute, rather than using the `required` option. This method is intended for use in non-RESTful routes or cases where Active Record validations are not available._
+
+### Global configuration
+
+You can generate a local copy of the default configuration with `rails generate decanter:install`. This will create an initializer where you can do global configuration:
+
+```ruby
+# ./config/initializers/decanter.rb
+
+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).