decanter 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1cea76ec8e01a183736aeb145f1b58cb8f00298
-  data.tar.gz: 370986b00b379fc188bc327a76e4411038f0c4b9
+  metadata.gz: fcecd146883e6b44658dcee94a7271f552c695cf
+  data.tar.gz: 1362e8a5b04500354b60f7530916c487fed7f6c6
 SHA512:
-  metadata.gz: 0e17c3aba3e202f20638f80993d73f9a7773b6890eb46006c470a972a8f7cf7a0ce87fd07713097a40fa48482430dfc3b897a9126e14f0c49297ca1e49fa941a
-  data.tar.gz: af705b120764f79bff09350351830f8908b2fcb73cd74463bde2bd66dc898c63673c30fd361ff71fbbe528d512bace6d2eef4d08d6ee954f60780807ce381507
+  metadata.gz: f95eee6b059ac8f0ec596fe74889dfeae1e30392a86d76a9159c07f895b5016300068f945d5e49d30bd9feace6257b28d3ab9f6ff29ec105fc923ff14a147ccf
+  data.tar.gz: bcc79760fca3ebfb1fc1d4ce4aa4ae04993d0acff6422be01e0a40a7de4c7556d7269d636fff739a8e90f022d0873c0a83cad0b3fd51ec4931adbda8ec4fe843

data/Gemfile.lock

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

data/README.md

@@ -55,7 +55,7 @@ In your controller:
 
   def update
     @trip = Trip.find(params[:id])
-    
+
     if @trip.decant_update(params[:trip])
       redirect_to trips_path
     else
@@ -139,7 +139,7 @@ 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:
 
 ```ruby
-{ 
+{
   name: "My Trip",
   start_date: "01/15/2015",
   end_date: "01/20/2015"
@@ -149,7 +149,7 @@ You'll also notice that instead of ```@trip = Trip.new(params[:trip])``` we do `
 to this:
 
 ```ruby
-{ 
+{
   name: "My Trip",
   start_date: Mon, 15 Jan 2015,
   end_date: Mon, 20 Jan 2015
@@ -163,12 +163,14 @@ Adding Custom Parsers
 
 In the above example, start_date and end_date are ran through a DateParser that lives in Decanter. Let's take a look at the DateParser:
 
+** Note this changed in version 0.7.2. Now parser must inherit from Decanter::Parser::ValueParser or Decanter::Parser::HashParser instead of Decanter::Parser::Base **
+
 ```ruby
-class DateParser < Decanter::ValueParser::Base
+class DateParser < Decanter::Parser::ValueParser
 
   allow Date
 
-  parser do |name, value, options|
+  parser do |value, options|
     parse_format = options.fetch(:parse_format, '%m/%d/%Y')
     ::Date.strptime(value, parse_format)
   end
@@ -182,7 +184,7 @@ You'll notice that the above ```parser do``` block takes a ```:parse_format``` o
 ```ruby
 # app/decanters/trip_decanter.rb
 
-class TripDecanter < Decanter::Base
+class TripDecanter < Decanter::ValueParser
   input :name, :string
   input :start_date, :date, parse_format: '%Y-%m-%d'
   input :end_date, :date, parse_format: '%Y-%m-%d'
@@ -198,13 +200,41 @@ rails g parser Date
 **lib/decanter/parsers/date_parser**
 
 ```ruby
-class DateParser < Decanter::ValueParser::Base
-  parser do |name, value, options|    
+class DateParser < Decanter::Parser::ValueParser
+  parser do |value, options|
     # your parsing logic here
   end
 end
 ```
 
+
+By inheriting from Decanter::Parser::ValueParser, the assumption is that the value returned from the parser will be the value associated with the provided key. If you need more control over the result, for example, you want a parser that returns multiple key value pairs, you should instead inherit from Decanter::Parser::HashParser. This requires that the value returned is a hash. For example:
+
+```ruby
+class KeyValueSplitterParser < Decanter::Parser::HashParser
+  ITEM_DELIM = ','
+  PAIR_DELIM = ':'
+
+  parser do |name, val, options|
+    # val = 'color:blue,price:45.31'
+
+    item_delimiter = options.fetch(:item_delimiter, ITEM_DELIM)
+    pair_delimiter = options.fetch(:pair_delimiter, PAIR_DELIM)
+
+    pairs = val.split(item_delimiter) # ['color:blue', 'price:45.31']
+
+    hash = {}
+    pairs.each do |pair|
+      key, value = pair.split(pair_delimiter) # 'color', 'blue'
+      hash[key] = value
+    end
+    return hash
+  end
+end
+```
+
+The ```parser``` block takes the 'name' as an additional argument and must return a hash.
+
 Nested Example
 ---
 
@@ -273,7 +303,7 @@ Each of the destinations in our params[:trip] are automatically parsed according
 Non Database-Backed Objects
 ---
 
-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. 
+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:
 
@@ -305,9 +335,12 @@ Default Parsers
 Decanter comes with the following parsers:
 - boolean
 - date
-- datetime
+- date_time
 - float
 - integer
+- join
+- key_value_splitter
+- pass
 - phone
 - string
 
@@ -322,11 +355,11 @@ rails g parser Zip
 Squashing Inputs
 ---
 
-Sometimes, you may want to take several inputs and combine them into one finished input prior to sending to your model. For example, if day, month, and year come in as separate parameters, but your database really only cares about start_date. 
+Sometimes, you may want to take several inputs and combine them into one finished input prior to sending to your model. For example, if day, month, and year come in as separate parameters, but your database really only cares about start_date.
 
 ```ruby
 class TripDecanter < Decanter::Base
-  input [:day, :month, :year], :squash_date, key: :start_date  
+  input [:day, :month, :year], :squash_date, key: :start_date
 end
 ```
 
@@ -337,8 +370,8 @@ rails g parser SquashDate
 ```ruby
 # lib/decanter/parsers/squash_date_parser.rb
 
-class SquashDateParser < Decanter::Parser::Base
-  parser do |name, values, options|
+class SquashDateParser < Decanter::Parser::ValueParser
+  parser do |values, options|
     day, month, year = values.map(&:to_i)
     Date.new(year, month, day)
   end
@@ -348,7 +381,7 @@ end
 No Need for Strong Params
 ---
 
-Since you are already defining your expected inputs in Decanter, you really don't need strong_params anymore.
+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:
 
@@ -369,3 +402,25 @@ class TripDecanter <  Decanter::Base
   input :name
 end
 ```
+
+Configuration
+---
+
+You can generate a local copy of the default configuration with ```rails generate decanter:install```. This will create the initializer ```../config/initializers/decanter.rb```.
+
+Starting with version 0.7.2, the default strict mode is ```:with_exception```. If this is what you prefer, you no longer have to set it in every decanter. You can still set this on individual decanters or you can configure it globally in the initializer:
+
+```ruby
+# ../config/initializers/decanter.rb
+
+Decanter.config do |config|
+  config.strict = true
+end
+
+# Or
+
+Decanter.configuration.strict = true
+```
+
+Likewise, you can put the above code in a specific environment configuration.
+

data/lib/decanter.rb

@@ -32,14 +32,23 @@ module Decanter
 
       constant
     end
+
+    def configuration
+      @config ||= Decanter::Configuration.new
+    end
+
+    def config
+      yield configuration
+    end
   end
 
   ActiveSupport.run_load_hooks(:decanter, self)
 end
 
 require 'decanter/version'
-require 'decanter/base'
+require 'decanter/configuration'
 require 'decanter/core'
+require 'decanter/base'
 require 'decanter/extensions'
-require 'decanter/value_parser'
+require 'decanter/parser'
 require 'decanter/railtie' if defined?(::Rails)

data/lib/decanter/configuration.rb

@@ -0,0 +1,10 @@
+module Decanter
+  class Configuration
+
+    attr_accessor :strict
+
+    def initialize
+      @strict = :with_exception
+    end
+  end
+end

data/lib/decanter/core.rb

@@ -156,7 +156,7 @@ module Decanter
 
       def parse(key, parser, values, options)
         parser ?
-          ValueParser.value_parser_for(parser)
+          Parser.parser_for(parser)
                      .parse(key, values, options)
           :
           { key => values }
@@ -167,7 +167,7 @@ module Decanter
       end
 
       def strict_mode
-        @strict_mode ||= {}
+        @strict_mode.nil? ? Decanter.configuration.strict : @strict_mode
       end
     end
   end

data/lib/decanter/parser.rb

@@ -0,0 +1,27 @@
+module Decanter
+  module Parser
+
+    class << self
+      def parser_for(klass_or_sym)
+        parser_str = 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 parser for #{klass_or_sym} with class #{klass_or_sym.class}")
+        end.concat('Parser')
+
+        parser = parser_str.safe_constantize || "Decanter::Parser::".concat(parser_str).safe_constantize
+        raise NameError.new("cannot find parser #{parser_str}") unless parser
+        parser
+      end
+    end
+  end
+end
+
+require "#{File.dirname(__FILE__)}/parser/core.rb"
+require "#{File.dirname(__FILE__)}/parser/base.rb"
+require "#{File.dirname(__FILE__)}/parser/value_parser.rb"
+require "#{File.dirname(__FILE__)}/parser/hash_parser.rb"
+Dir["#{File.dirname(__FILE__)}/parser/*_parser.rb"].each { |f| require f }

data/lib/decanter/parser/base.rb

@@ -0,0 +1,10 @@
+require_relative 'core'
+
+module Decanter
+  module Parser
+    class Base
+      include Core
+    end
+  end
+end
+

data/lib/decanter/{value_parser → parser}/boolean_parser.rb

@@ -1,10 +1,10 @@
 module Decanter
-  module ValueParser
-    class BooleanParser < Base
+  module Parser
+    class BooleanParser < ValueParser
 
       allow TrueClass, FalseClass
 
-      parser do |name, val, options|
+      parser do |val, options|
         [1, '1'].include?(val) || !!/true/i.match(val.to_s)
       end
     end

data/lib/decanter/{value_parser → parser}/core.rb

@@ -1,5 +1,5 @@
 module Decanter
-  module ValueParser
+  module Parser
     module Core
 
       def self.included(base)
@@ -8,6 +8,7 @@ module Decanter
 
       module ClassMethods
 
+        # Meant to be overriden and called by child parser
         def parse(name, values, options={})
 
           value_ary = values.is_a?(Array) ? values : [values]
@@ -21,7 +22,7 @@ module Decanter
             end
           end
 
-          if @allowed && value_ary.all? { |value| @allowed.include?(value.class) }
+          if @allowed && value_ary.all? { |value| @allowed.any? { |allowed| value.is_a? allowed } }
             return { name => values }
           end
 
@@ -29,17 +30,7 @@ module Decanter
             raise ArgumentError.new("No parser for argument: #{name} with types: #{value_ary.map(&:class).join(', ')}")
           end
 
-          case @result
-          when :raw
-            # Parser result must be a hash
-            parsed = @parser.call(name, values, options)
-            parsed.is_a?(Hash) ?
-              parsed :
-              raise(ArgumentError.new("Result of parser #{self.name} with values #{values} was #{parsed} when it must be a hash."))
-          else
-            # Parser result will be treated as a single value belonging to the name
-            { name => @parser.call(name, values, options) }
-          end
+          _parse(name, values, options)
         end
 
         def parser(&block)
@@ -49,10 +40,6 @@ module Decanter
         def allow(*args)
           @allowed = args
         end
-
-        def result(opt)
-          @result = opt
-        end
       end
     end
   end

data/lib/decanter/{value_parser → parser}/date_parser.rb

@@ -1,10 +1,10 @@
 module Decanter
-  module ValueParser
-    class DateParser < Base
+  module Parser
+    class DateParser < ValueParser
 
       allow Date
 
-      parser do |name, val, options|
+      parser do |val, options|
         parse_format = options.fetch(:parse_format, '%m/%d/%Y')
         ::Date.strptime(val, parse_format)
       end

data/lib/decanter/parser/datetime_parser.rb

@@ -0,0 +1,13 @@
+module Decanter
+  module Parser
+    class DateTimeParser < ValueParser
+
+      allow DateTime
+
+      parser do |val, options|
+        parse_format = options.fetch(:parse_format, '%m/%d/%Y %I:%M:%S %p')
+        ::DateTime.strptime(val, parse_format)
+      end
+    end
+  end
+end

data/lib/decanter/{value_parser → parser}/float_parser.rb

@@ -1,11 +1,11 @@
 module Decanter
-  module ValueParser
-    class FloatParser < Base
+  module Parser
+    class FloatParser < ValueParser
       REGEX = /(\d|[.])/
 
       allow Float, Fixnum
 
-      parser do |name, val, options|
+      parser do |val, options|
         val.scan(REGEX).join.try(:to_f)
       end
     end

data/lib/decanter/parser/hash_parser.rb

@@ -0,0 +1,18 @@
+require_relative 'core'
+
+module Decanter
+  module Parser
+    class HashParser < Base
+      def self._parse(name, values, options={})
+        validate_hash(@parser.call(name, values, options))
+      end
+
+      private
+      def self.validate_hash(parsed)
+        parsed.is_a?(Hash) ? parsed :
+          raise(ArgumentError.new("Result of HashParser #{self.name} was #{parsed} when it must be a hash."))
+      end
+    end
+  end
+end
+

data/lib/decanter/{value_parser → parser}/integer_parser.rb

@@ -1,11 +1,11 @@
 module Decanter
-  module ValueParser
-    class IntegerParser < Base
+  module Parser
+    class IntegerParser < ValueParser
       REGEX = /(\d|[.])/
 
       allow Fixnum
 
-      parser do |name, val, options|
+      parser do |val, options|
         val.is_a?(Float) ?
           val.to_i :
           val.scan(REGEX).join.try(:to_i)

data/lib/decanter/{value_parser → parser}/join_parser.rb

@@ -1,9 +1,9 @@
 module Decanter
-  module ValueParser
-    class JoinParser < Base
+  module Parser
+    class JoinParser < ValueParser
       DELIM = ','
 
-      parser do |name, val, options|
+      parser do |val, options|
         delimiter = options.fetch(:delimiter, ITEM_DELIM)
         val.join(DELIM)
       end

data/lib/decanter/{value_parser → parser}/key_value_splitter_parser.rb

@@ -1,11 +1,9 @@
 module Decanter
-  module ValueParser
-    class KeyValueSplitterParser < Base
+  module Parser
+    class KeyValueSplitterParser < HashParser
       ITEM_DELIM = ','
       PAIR_DELIM = ':'
 
-      result :raw
-
       parser do |name, val, options|
         item_delimiter = options.fetch(:item_delimiter, ITEM_DELIM)
         pair_delimiter = options.fetch(:pair_delimiter, PAIR_DELIM)

data/lib/decanter/parser/pass_parser.rb

@@ -0,0 +1,8 @@
+module Decanter
+  module Parser
+    class PassParser < ValueParser
+
+      allow Object
+    end
+  end
+end

data/lib/decanter/{value_parser → parser}/phone_parser.rb

@@ -1,11 +1,11 @@
 module Decanter
-  module ValueParser
-    class PhoneParser < Base
+  module Parser
+    class PhoneParser < ValueParser
       REGEX = /\d/
 
       allow Fixnum
 
-      parser do |name, val, options|
+      parser do |val, options|
         val.scan(REGEX).join.to_s
       end
     end

data/lib/decanter/parser/string_parser.rb

@@ -0,0 +1,12 @@
+module Decanter
+  module Parser
+    class StringParser < ValueParser
+
+      allow String
+
+      parser do |val, options|
+        val.to_s
+      end
+    end
+  end
+end

data/lib/decanter/parser/value_parser.rb

@@ -0,0 +1,12 @@
+require_relative 'core'
+
+module Decanter
+  module Parser
+    class ValueParser < Base
+      def self._parse(name, values, options={})
+        { name => @parser.call(values, options) }
+      end
+    end
+  end
+end
+

data/lib/decanter/railtie.rb

@@ -9,10 +9,8 @@ class Decanter::Railtie < Rails::Railtie
     end
   end
 
-  config.to_prepare do
-    Dir[
-      File.expand_path(Rails.root.join("lib/decanter/parsers/*"))
-    ].each { |file| require file }
+  initializer 'decanter.parser.autoload', :before => :set_autoload_paths do |app|
+    app.config.autoload_paths << Rails.root.join("lib/decanter/parsers")
   end
 
   generators do |app|

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/lib/generators/decanter/install_generator.rb

@@ -0,0 +1,13 @@
+module Decanter
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Creates a Decanter initializer in your application."
+
+      def copy_initializer
+        copy_file "initializer.rb", "config/initializers/decanter.rb"
+      end
+    end
+  end
+end

data/lib/generators/decanter/templates/initializer.rb

@@ -0,0 +1,4 @@
+Decanter.config do |config|
+  # Possible values are :with_exception, true or false
+  config.strict = :with_exception
+end

data/lib/generators/rails/parser_generator.rb

@@ -13,7 +13,7 @@ module Rails
       private
 
       def parent_class_name
-        'Decanter::ValueParser::Base'
+        'Decanter::Parser::Base'
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,22 +116,28 @@ files:
 - decanter.gemspec
 - lib/decanter.rb
 - lib/decanter/base.rb
+- lib/decanter/configuration.rb
 - lib/decanter/core.rb
 - lib/decanter/extensions.rb
+- lib/decanter/parser.rb
+- lib/decanter/parser/base.rb
+- lib/decanter/parser/boolean_parser.rb
+- lib/decanter/parser/core.rb
+- lib/decanter/parser/date_parser.rb
+- lib/decanter/parser/datetime_parser.rb
+- lib/decanter/parser/float_parser.rb
+- lib/decanter/parser/hash_parser.rb
+- lib/decanter/parser/integer_parser.rb
+- lib/decanter/parser/join_parser.rb
+- lib/decanter/parser/key_value_splitter_parser.rb
+- lib/decanter/parser/pass_parser.rb
+- lib/decanter/parser/phone_parser.rb
+- lib/decanter/parser/string_parser.rb
+- lib/decanter/parser/value_parser.rb
 - lib/decanter/railtie.rb
-- lib/decanter/value_parser.rb
-- lib/decanter/value_parser/base.rb
-- lib/decanter/value_parser/boolean_parser.rb
-- lib/decanter/value_parser/core.rb
-- lib/decanter/value_parser/date_parser.rb
-- lib/decanter/value_parser/datetime_parser.rb
-- lib/decanter/value_parser/float_parser.rb
-- lib/decanter/value_parser/integer_parser.rb
-- lib/decanter/value_parser/join_parser.rb
-- lib/decanter/value_parser/key_value_splitter_parser.rb
-- lib/decanter/value_parser/phone_parser.rb
-- lib/decanter/value_parser/string_parser.rb
 - lib/decanter/version.rb
+- lib/generators/decanter/install_generator.rb
+- lib/generators/decanter/templates/initializer.rb
 - lib/generators/rails/decanter_generator.rb
 - lib/generators/rails/parser_generator.rb
 - lib/generators/rails/resource_override.rb

data/lib/decanter/value_parser.rb

@@ -1,25 +0,0 @@
-module Decanter
-  module ValueParser
-    @@value_parsers = {}
-
-    def self.register(value_parser)
-      @@value_parsers[value_parser.name.demodulize] = value_parser
-    end
-
-    def self.value_parser_for(sym)
-      @@value_parsers["#{sym.to_s.camelize}Parser"] || (raise NameError.new("unknown value parser #{sym.to_s.capitalize}Parser"))
-    end
-  end
-end
-
-require_relative 'value_parser/base'
-require_relative 'value_parser/core'
-require_relative 'value_parser/boolean_parser'
-require_relative 'value_parser/date_parser'
-require_relative 'value_parser/datetime_parser'
-require_relative 'value_parser/string_parser'
-require_relative 'value_parser/phone_parser'
-require_relative 'value_parser/float_parser'
-require_relative 'value_parser/integer_parser'
-require_relative 'value_parser/key_value_splitter_parser'
-require_relative 'value_parser/join_parser'

data/lib/decanter/value_parser/base.rb

@@ -1,13 +0,0 @@
-require_relative 'core'
-
-module Decanter
-  module ValueParser
-    class Base
-      include Core
-      def self.inherited(subclass)
-        ValueParser.register(subclass)
-      end
-    end
-  end
-end
-

data/lib/decanter/value_parser/datetime_parser.rb

@@ -1,13 +0,0 @@
-module Decanter
-  module ValueParser
-    class DateTimeParser < Base
-
-      allow DateTime
-
-      parser do |name, val, options|
-        parse_format = options.fetch(:parse_format, '%m/%d/%Y')
-        ::Date.strptime(val, parse_format)
-      end
-    end
-  end
-end

data/lib/decanter/value_parser/string_parser.rb

@@ -1,12 +0,0 @@
-module Decanter
-  module ValueParser
-    class StringParser < Base
-
-      allow String
-
-      parser do |name, val, options|
-        val.to_s
-      end
-    end
-  end
-end