decanter 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99d5bfae4e2f4ed374e9851fd07d53d524963349
-  data.tar.gz: ad634273515df9853b3566948a1dcf61884d5b80
+  metadata.gz: 59c4f720f9e7e8d34a163d6b06314adb05aad75e
+  data.tar.gz: 57fb16ed8e5d10a7b265dfe3a1b201867a938017
 SHA512:
-  metadata.gz: 09420cff51f63c0971a7dc1651b27078d209588f65373608c3be654dbea9bfad1d4ef0727b7170c8aa9bf65d271220c396e7d0f0ed01c028ccb64d2e3e1ec9b0
-  data.tar.gz: 03dd595cc9e0f01ca5963d8fdb88763300990a018ec639c7d093bd6098d1fb18c6e7ffde8a07c663adc911d43ab7a54cddb1f5b66c371b0aaaf0fccaf97e00b1
+  metadata.gz: 950d5a5e1a6110a19b7acb242fb8baaacd526c969caff7966fa6122c3f3ca53c96e3a6fe7dc8ad74c202ff6986384a8a2f52649282a2c1fce26bd60e72bf634b
+  data.tar.gz: 10666cd624edba38e980e4e5d90684e62bf8b452905e4a8b882fe0bbfc32e1e5aae237a0e88a3988358a9987195fdd8a0fe419fb07e497e7011fa74d11a15fc9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (0.8.1)
+    decanter (0.9.0)
       activesupport
 
 GEM
@@ -97,4 +97,4 @@ DEPENDENCIES
   rspec-rails
 
 BUNDLED WITH
-   1.10.6
+   1.14.4

data/README.md

@@ -422,27 +422,53 @@ 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:
+Note: starting with version 0.7.2, the default strict mode is ```:with_exception```. You can modify your default strict mode in your configuration file (see the "Configuration" section below).
+
+#### Mode: with_exception (default mode)
+
+To raise exceptions when parameters arrive in your Decanter that you didn't expect:
 
 ```ruby
 class TripDecanter <  Decanter::Base
-  strict true
+  strict :with_exception
 
   input :name
 end
 ```
 
-Or to raise exceptions when parameters arrive in your Decanter that you didn't expect:
+#### Mode: strict
+
+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 :with_exception
+  strict true
 
   input :name
 end
 ```
 
-In addition, if you provide the option `:required` for an input in your decanter, an exception will be thrown if the parameters is nil or an empty string.
+#### Requiring Params
+
+If you provide the option `:required` for an input in your decanter, an exception will be thrown if the parameters is nil or an empty string.
+
+```ruby
+class TripDecanter <  Decanter::Base
+  input :name, :string, required: true
+end
+```
+
+#### Ignoring Params
+
+If you anticipate your decanter will receive certain params that you simply want to ignore and therefore do not want Decanter to raise an exception, you can do so by calling the `ignore` method:
+
+```ruby
+class TripDecanter <  Decanter::Base
+  ignore :created_at, :updated_at
+
+  input :name, :string
+end
+```
 
 Configuration
 ---

data/lib/decanter.rb

@@ -5,14 +5,20 @@ module Decanter
   class << self
 
     def decanter_for(klass_or_sym)
-      case klass_or_sym
-      when Class
-        klass_or_sym.name
-      when Symbol
-        klass_or_sym.to_s.singularize.camelize
-      else
-        raise ArgumentError.new("cannot lookup decanter for #{klass_or_sym} with class #{klass_or_sym.class}")
-      end.concat('Decanter').constantize
+      decanter_name =
+        case klass_or_sym
+        when Class
+          klass_or_sym.name
+        when Symbol
+          klass_or_sym.to_s.singularize.camelize
+        else
+          raise ArgumentError.new("cannot lookup decanter for #{klass_or_sym} with class #{klass_or_sym.class}")
+        end.concat('Decanter')
+      begin
+        decanter_name.constantize
+      rescue
+        raise NameError.new("uninitialized constant #{decanter_name}")
+      end
     end
 
     def decanter_from(klass_or_string)
@@ -21,7 +27,11 @@ module Decanter
         when Class
           klass_or_string
         when String
-          klass_or_string.constantize
+          begin
+            klass_or_string.constantize
+          rescue
+            raise NameError.new("uninitialized constant #{klass_or_string}")
+          end
         else
           raise ArgumentError.new("cannot find decanter from #{klass_or_string} with class #{klass_or_string.class}")
         end
@@ -51,4 +61,4 @@ require 'decanter/core'
 require 'decanter/base'
 require 'decanter/extensions'
 require 'decanter/parser'
-require 'decanter/railtie' if defined?(::Rails)
+require 'decanter/railtie' if defined?(::Rails)

data/lib/decanter/core.rb

@@ -44,6 +44,10 @@ module Decanter
         }
       end
 
+      def ignore(*args)
+        keys_to_ignore.push(*args)
+      end
+
       def strict(mode)
         raise( ArgumentError.new("#{self.name}: Unknown strict value #{mode}")) unless [:with_exception, true, false].include? mode
         @strict_mode = mode
@@ -61,16 +65,17 @@ module Decanter
       def unhandled_keys(args)
         unhandled_keys = args.keys.map(&:to_sym) -
           handlers.keys.flatten.uniq -
+          keys_to_ignore -
           handlers.values
             .select { |handler| handler[:type] != :input }
-            .map { |handler| "#{handler[:name]}_attributes".to_sym }
+            .map { |handler| "#{handler[:name]}_attributes".to_sym }            
 
         if unhandled_keys.any?
           case strict_mode
           when true
             p "#{self.name} ignoring unhandled keys: #{unhandled_keys.join(', ')}."
             {}
-          when :with_exception
+          when :with_exception            
             raise ArgumentError.new("#{self.name} received unhandled keys: #{unhandled_keys.join(', ')}.")
           else
             args.select { |key| unhandled_keys.include? key }
@@ -173,6 +178,10 @@ module Decanter
         @handlers ||= {}
       end
 
+      def keys_to_ignore
+        @keys_to_ignore ||= []
+      end
+
       def strict_mode
         @strict_mode.nil? ? Decanter.configuration.strict : @strict_mode
       end

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Form Parser for Rails