decanter 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42bc613e6f1049e3332f4ed3bad67d6031be513c
-  data.tar.gz: bc2fbd47a658c6dc924ea3de2667ab73c6c3b723
+  metadata.gz: db2d47fb35516ad171707804d74d599dfc9f4275
+  data.tar.gz: 9de4216e15cef03ab046d1dc68372ce3de6f834d
 SHA512:
-  metadata.gz: 43919de7aab2fce821689d08b631ff3e18226cd6e54823d979521073df659fe14bdd2178bac3713f3dc6c0399c58867ed0eb2cbda4b94c14ab035e2489fa57ef
-  data.tar.gz: ae021eb752244c37311232ec2b1213755c2f20efaa7b16bca9a3d7200ce8db052e8a9c74bc6fcb9e21775a487f04127216c9dc62dfa1e312c1fbe52365ff23d3
+  metadata.gz: f5a4887ef4cebe7358b2a57a25ef558647ebc4760369636c91dd65aa266649e0a85df014f02b746849d3fd301f603cb865154349aedba8a8232684d0ff1da127
+  data.tar.gz: 3efb3ee49fc50aaa223c2205fe4e2ff9bde46fc482529510d86735bc16d31db7243f7d1e58bc2433b852f46ec74358312fb748544f268e37176c3c9512f35eb8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (0.6.0)
+    decanter (0.6.2)
       activesupport
 
 GEM

data/README.md

@@ -8,7 +8,9 @@ Decanter
 What is Decanter?
 ---
 
-Decanter is a Rails gem that makes it easy to manipulate form data before it hits the model. The basic idea is that form data entered by a user often needs to be processed before it is stored into the database. A typical example of this is a datepicker. A user selects January 15th, 2015 as the date, but this is going to come into our controller as a string like "01/15/2015", so we need to convert this string to a Ruby Date object before it is stored in our database. Many developers perform this conversion right in the controller, which results in errors and unnecessary complexity, especially as the application grows.
+Decanter is a Rails gem that makes it easy to transform incoming data before it hits the model. The basic idea is that form data entered by a user often needs to be processed before it is stored into the database. A typical example of this is a datepicker. A user selects January 15th, 2015 as the date, but this is going to come into our controller as a string like "01/15/2015", so we need to convert this string to a Ruby Date object before it is stored in our database. Many developers perform this conversion right in the controller, which results in errors and unnecessary complexity, especially as the application grows.
+
+You can think of Decanter as the opposite of Active Model Serializer. Whereas AMS transforms your outbound data into a format that your frontend consumes, Decanter transforms your incoming data into a format that your backend consumes.
 
 Installation
 ---
@@ -73,6 +75,17 @@ In your controller:
   end
 ```
 
+Or, if you would prefer to get the parsed hash and then do your own logic, you can do the following:
+
+```ruby
+def create
+  parsed_params = Trip.decant(params[:trip])
+  @trip = Trip.new(parsed_params)
+
+  # save logic here
+end
+```
+
 Basic Example
 ---
 
@@ -134,7 +147,7 @@ class TripDecanter < Decanter::Base
 end
 ```
 
-You'll also notice that instead of ```@trip = Trip.new(params[:trip])``` we do ```@trip = Trip.decant_new(params[:trip])```. ```decant_new`` is where the magic happens. It is converting the params from this:
+You'll also notice that instead of ```@trip = Trip.new(params[:trip])``` we do ```@trip = Trip.decant_new(params[:trip])```. ```decant_new``` is where the magic happens. It is converting the params from this:
 
 ```ruby
 { 
@@ -271,7 +284,7 @@ Each of the destinations in our params[:trip] are automatically parsed according
 Non Database-Backed Objects
 ---
 
-Decanter will work for you non database-backed objects as well. We just need to call ```decant``` to parse our params according to our decanter logic. 
+Decanter will work for your non database-backed objects as well. We just need to call ```decant``` to parse our params according to our decanter logic. 
 
 Let's say we have a search filtering object called ```SearchFilter```. We start by generating our decanter:
 
@@ -336,11 +349,34 @@ rails g parser SquashDate
 # app/decanter/squashers/date_squasher.rb
 
 class SquashDateParser < Decanter::Parser::Base
-  parser do |name, values, options|    
-    day = values[0]
-    month = values[1]
-    year = values[2]
+  parser do |name, values, options|
+    day, month, year = values.map(&:to_i)
     Date.new(year, month, day)
   end
 end
 ```
+
+No Need for Strong Params
+---
+
+Since you are already defining your expected inputs in Decanter, you really don't need strong_params anymore.
+
+In order to tell Decanter to ignore the params not defined in your Decanter, just add the ```strict``` flag to your Decanters:
+
+```ruby
+class TripDecanter <  Decanter::Base
+  strict true
+
+  input :name
+end
+```
+
+Or to raise exceptions when parameters arrive in your Decanter that you didn't expect:
+
+```ruby
+class TripDecanter <  Decanter::Base
+  strict :with_exception
+
+  input :name
+end
+```

data/lib/decanter/extensions.rb

@@ -15,6 +15,10 @@ module Decanter
       self.save!(context: options[:context])
     end
 
+    def decant(args, **options)
+      self.class.decant(args, options)
+    end
+
     module ClassMethods
 
       def decant_create(args, **options)
@@ -31,7 +35,7 @@ module Decanter
             .save!(context: options[:context])
       end
 
-      def decant(args, options)
+      def decant(args, options={})
         options.fetch(:decanter, Decanter.decanter_for(self))
           .decant(args)
       end

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport