decanter 4.0.2 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2c8921ba27d831a863fd3220d2df2a538549b7bd2b12ba6cfac022abdc7f0fd
-  data.tar.gz: 22afd46a49a2e3b1ca797b84b9c145317fc61cf759f6b46988a079a965578635
+  metadata.gz: 855c0c38fda4543f1542a7519ff4234544d696a910f39fe195cf99f50ad6a780
+  data.tar.gz: 28b8bb87ee97e7a0c371124cbb8a04319b35df6c2ee642f75290d822a2015186
 SHA512:
-  metadata.gz: cef98a3a32c715d298c65c08bfaa5d5e9093d15be4c21bdf152093117444153dcf74327be75dbbb3f1981b7727d3b230b1369b8e9d459fbb3ab615a2bee8b9d3
-  data.tar.gz: 5d679309905d5a66b62b00ccdb1132738d462f8594c6c50b18a82caa13ba8f9ddcb62df2f92e2a6f3cf36a67e9c85305dc0eb1ad3f6689ab36e8584ae58fa701
+  metadata.gz: 523f731eb6580679bc32699b6ae473220dabf8840124657bd0bfbfbbfd2c892affdcf44ba33c9435f51366c83bb8d86ebe467f7b2a98ae0da32211b525d062ca
+  data.tar.gz: 9923cf90108899c59990687ace8b0e23bad06dfb01b52d8c28594ba1f657a687007f33c4aacad4981dd2391106114df3098121a74e845ee967cccb52a94405c2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (4.0.2)
+    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
@@ -137,11 +171,19 @@ 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`:
+Some parsers can receive options that modify their behavior. These options are passed in as named arguments to `input`:
+
+**Example:**
 
 ```ruby
 input :start_date, :date, parse_format: '%Y-%m-%d'
 ```
+**Available Options:**
+| Parser      | Option      | Default    | Notes
+| ----------- | ----------- | -----------| -----------
+| `ArrayParser`   | `parse_each`| N/A | Accepts a parser type, then uses that parser to parse each element in the array. If this option is not defined, each element is simply returned.
+| `DateParser`| `parse_format` | `'%m/%d/%Y'`| Accepts any format string accepted by Ruby's `strftime` method
+| `DateTimeParser` | `parse_format` | `'%m/%d/%Y %I:%M:%S %p'` | Accepts any format string accepted by Ruby's `strftime` method
 
 ### Exceptions
 
@@ -176,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)
@@ -189,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.2'.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.2
+  version: 4.0.4
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack