decanter 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e9d0d0e614da38a16d45d56bee4977a6e2092538d6909a373e705ca30a06860
-  data.tar.gz: 1a468f81cedf900e10614d8328d486494d9b91ae0fbf9ee3876c3825377f4ebf
+  metadata.gz: 855c0c38fda4543f1542a7519ff4234544d696a910f39fe195cf99f50ad6a780
+  data.tar.gz: 28b8bb87ee97e7a0c371124cbb8a04319b35df6c2ee642f75290d822a2015186
 SHA512:
-  metadata.gz: f7acb57f4a7c60c17c4fa175d735c619d0f5e3b0b9f5f5f0095d00c8f27e0cb2a80369cdea8ed1334007bf93c8094e2de1994b3258463d93e77c9c696f73d7a1
-  data.tar.gz: 96195a3c43d867c73e4e6fb6a39d0d69248e66179c4756615e20cbc93c1b3d8056b654956459cb2daf4d29b16d28006a354cba2f2608a0d4c0271d057b37de85
+  metadata.gz: 523f731eb6580679bc32699b6ae473220dabf8840124657bd0bfbfbbfd2c892affdcf44ba33c9435f51366c83bb8d86ebe467f7b2a98ae0da32211b525d062ca
+  data.tar.gz: 9923cf90108899c59990687ace8b0e23bad06dfb01b52d8c28594ba1f657a687007f33c4aacad4981dd2391106114df3098121a74e845ee967cccb52a94405c2

data/Gemfile.lock

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

data/README.md

@@ -61,14 +61,48 @@ Then, transform incoming params in your controller using `Decanter#decant`:
 
 ### Generators
 
-Decanter comes with generators for creating `Decanter` and `Parser` files:
+Decanter comes with custom generators for creating `Decanter` and `Parser` files:
+
+#### Decanters
 
 ```
 rails g decanter Trip name:string start_date:date end_date:date
+
+# Creates app/decanters/trip_decanter.rb:
+class TripDecanter < Decanter::Base
+  input :name, :string
+  input :start_date, :date
+  input :end_date, :date
+end
 ```
 
+#### Parsers
 ```
 rails g parser TruncatedString
+
+# Creates lib/decanter/parsers/truncated_string_parser.rb:
+class TruncatedStringParser < Decanter::Parser::ValueParser
+  parser do |value, options|
+    value
+  end
+end
+```
+
+[Learn more about using custom parsers](#custom-parsers)
+
+#### Resources
+
+When using the Rails resource generator in a project that includes Decanter, a decanter will be automatically created for the new resource:
+
+```
+rails g resource Trip name:string start_date:date end_date:date
+
+# Creates app/decanters/trip_decanter.rb:
+class TripDecanter < Decanter::Base
+  input :name, :string
+  input :start_date, :date
+  input :end_date, :date
+end
 ```
 
 ### Decanting Collections
@@ -184,8 +218,8 @@ You can also disable strict mode globally using a [global configuration](#global
 To add a custom parser, first create a parser class:
 
 ```rb
-# app/parsers/truncate_string_parser.rb
-class TruncateStringParser < Decanter::Parser::ValueParser
+# app/parsers/truncated_string_parser.rb
+class TruncatedStringParser < Decanter::Parser::ValueParser
 
   parser do |value, options|
     length = options.fetch(:length, 100)
@@ -197,7 +231,7 @@ end
 Then, use the appropriate key to look up the parser:
 
 ```ruby
-  input :name, :truncate_string #=> TruncateStringParser
+  input :name, :truncated_string #=> TruncatedStringParser
 ```
 
 #### Custom parser methods

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '4.0.3'.freeze
+  VERSION = '4.0.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Ryan Francis