decanter 1.0.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2fa863d89a9c427e9815369584031324fbf713dabe73bd73b9b0c21884d03ea
-  data.tar.gz: a4b41823be541c4be5315677e5f7ebf9255ace1d3b9a52128e49d3630377aa2d
+  metadata.gz: de971a9c8d08bf65660675e95ca43de42cddf43b23b3d3445106da15cf53b6c8
+  data.tar.gz: 13feb40fcd6deaa283ed88242dd6b9f6920c251d292f373a929f7eab1b273579
 SHA512:
-  metadata.gz: dbe99fcf88bd3744d275b0440a90425e7831360b954e0ff27b8720b2db67ba58e4ed9ac3ce5bcbf0778d9dd6a1022873420092ebf421c209222683849457fb27
-  data.tar.gz: d5a99430067df32bad53fd74bab938cebd024be2a8c609597dd80affaaf8272721a01ffed8ec9edbbe13f7884deee1d1aa6095a3b68e50aa47aa29a467ad9c72
+  metadata.gz: 4b354554c39f316a26d12b0b936c051ee1ecbaf944450486dd93114f6b0c4ed96ae1dbac9399c57e8c37daef177175a25749e5bdb207f725e1c43e3f30c94527
+  data.tar.gz: a7f12000a741edb01768496935c1870cce41613c7e2ae2f842da6330892e9b22c4154fb504bb93398cdc25a94a864acc888663a2268c47162896581c4b569cd3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (1.0.2)
+    decanter (1.0.3)
       actionpack (>= 4.2.10)
       activesupport
 
@@ -40,15 +40,14 @@ GEM
     loofah (2.1.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.8.2)
+    method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.10.3)
     nokogiri (1.8.1)
       mini_portile2 (~> 2.3.0)
-    pry (0.10.4)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
     rack (1.6.8)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -88,7 +87,6 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    slop (3.6.0)
     thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.4)
@@ -107,4 +105,4 @@ DEPENDENCIES
   simplecov (~> 0.15.1)
 
 BUNDLED WITH
-   1.16.0
+   1.15.2

data/README.md

@@ -40,6 +40,18 @@ class TripDecanter < Decanter::Base
 end
 ```
 
+By default, Decanter will use the [default parser](https://github.com/LaunchPadLab/decanter#default-parsers) that matches your input data type.
+
+```ruby
+  input :name, :string #=> StringParser
+```
+
+To reference a custom or modified parser,
+
+```ruby
+  input :name, :string, :custom_string_parser
+```
+
 In your controller:
 
 ```ruby
@@ -491,3 +503,14 @@ Decanter.configuration.strict = true
 
 Likewise, you can put the above code in a specific environment configuration.
 
+Decanter Exceptions
+---
+
+ - MissingRequiredInputValue
+
+  Raised when required inputs have been enabled, but provided arguments to `decant()` do not contain values for those required inputs.
+
+ - UnhandledKeysError
+
+  Raised when there are unhandled keys.
+

data/lib/decanter.rb

@@ -60,5 +60,6 @@ require 'decanter/configuration'
 require 'decanter/core'
 require 'decanter/base'
 require 'decanter/extensions'
+require 'decanter/exceptions'
 require 'decanter/parser'
 require 'decanter/railtie' if defined?(::Rails)

data/lib/decanter/core.rb

@@ -1,12 +1,14 @@
+require 'pry'
+
 module Decanter
   module Core
-
+    
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
-
+      
       def input(name, parsers=nil, **options)
 
         _name = [name].flatten
@@ -49,17 +51,48 @@ module Decanter
       end
 
       def strict(mode)
-        raise( ArgumentError.new("#{self.name}: Unknown strict value #{mode}")) unless [:with_exception, true, false].include? mode
+        raise(ArgumentError, "#{self.name}: Unknown strict value #{mode}") unless [:with_exception, true, false].include? mode
         @strict_mode = mode
       end
 
       def decant(args)
-        return {} unless args.present?
+        return handle_empty_args if args.blank?
+        return empty_required_input_error unless 
+          required_input_values_present?(args)
         args = args.to_unsafe_h.with_indifferent_access if args.class.name == 'ActionController::Parameters'
         {}.merge( unhandled_keys(args) )
           .merge( handled_keys(args) )
       end
 
+      def handle_empty_args    
+        any_inputs_required? ? empty_args_error : {}
+      end
+
+      def any_inputs_required?
+        required_inputs.any?
+      end
+
+      def required_inputs
+        handlers.map do |h|
+          options = h.last[:options]
+          h.first.first if options && options[:required]
+        end  
+      end
+
+      def required_input_values_present?(args={})
+        required_inputs.all? do |input|
+          args.keys.include?(input)
+        end
+      end
+
+      def empty_required_input_error
+        raise(MissingRequiredInputValue, 'Required inputs have been declared, but no values for those inputs were passed.')
+      end
+
+      def empty_args_error
+        raise(ArgumentError, 'Decanter has required inputs but no values were passed')
+      end
+
       # protected
 
       def unhandled_keys(args)
@@ -76,7 +109,7 @@ module Decanter
             p "#{self.name} ignoring unhandled keys: #{unhandled_keys.join(', ')}."
             {}
           when :with_exception            
-            raise ArgumentError.new("#{self.name} received unhandled keys: #{unhandled_keys.join(', ')}.")
+            raise(UnhandledKeysError, "#{self.name} received unhandled keys: #{unhandled_keys.join(', ')}.")
           else
             args.select { |key| unhandled_keys.include? key }
           end
@@ -174,7 +207,7 @@ module Decanter
         end
       end
 
-      def handlers
+      def handlers        
         @handlers ||= {}
       end
 

data/lib/decanter/exceptions.rb

@@ -0,0 +1,7 @@
+module Decanter
+  module Core
+    class Error < StandardError; end
+    class UnhandledKeysError < Error; end
+    class MissingRequiredInputValue < Error; end
+  end
+end

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.1.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,6 +146,7 @@ files:
 - lib/decanter/base.rb
 - lib/decanter/configuration.rb
 - lib/decanter/core.rb
+- lib/decanter/exceptions.rb
 - lib/decanter/extensions.rb
 - lib/decanter/parser.rb
 - lib/decanter/parser/base.rb