saneitized 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f39227b4a2052628cf273f36ebdfeaf1f2b0f68
-  data.tar.gz: ea5a4da25dfcaee502c4edcaafa05cb395313de5
+  metadata.gz: f390ff80b0e9ce1850fd6653214bd1fb6afced93
+  data.tar.gz: e068a16d99d010429df56ad57b72ba6e11ddb594
 SHA512:
-  metadata.gz: 0eb77f525b4221933868f3a3e059ded76cac2440b5e879733fca333fdf4471490de73e77cc210e01ebb2e32953c0a87eaa54112a270d30fa8576a1dde7c51ae8
-  data.tar.gz: b0c1914f4c95f4776c77a05612b38a7bbce74aff73312ac4240e98d220a7639db1253989c3aeee50036d6f3f62334dce6380f74dc3f91976479860746201f852
+  metadata.gz: bcb8bcef97aeba5d342666c6f7a81943b82d018b329a27276cc28bc49c3f6c1c2ce0ca3e183742ac9d417b80a4a891a511f9f912efbbc2b87773f47b4ccfa843
+  data.tar.gz: b0305d4e33ca6033ef3e165946873b4e6df76afcafe8394fd1674a5c32e3b9e65273f6214cdb4cbd34e648e0d8f48842531748a15166b2b5734725fa511d21bb

data/README.md

@@ -37,7 +37,13 @@ the new value if it succeeds
     Integer: Saneitized.convert('42') #=> 42
     Float:   Saneitized.convert('22.2') #=> 22.2
     JSON:    Saneitized.convert("{\"hello\":\"goodbye\"}") #=> {"hello"=>"goodbye"}
-    Time:    Saneitized.convert("2014-05-28T23:15:26Z") #=> 2014-05-28 23:15:26 UTC
+
+Additionaly you can sanitize time as well
+
+    Time:    Saneitized.convert("2014-05-28T23:15:26Z", :add => :time) #=> 2014-05-28 23:15:26 UTC
+
+Time is left out of the default sanitizers because the Chronic parser used is pretty agressive and
+will convert some things you might not thing would be time.
 
 You can checkout `lib/saneitized/converter.rb` for more information
 
@@ -78,6 +84,24 @@ You can also black list keys of hashes if thats your thing
     Saneitized.convert( {name:'12345', age:'21'}, :key_blacklist => :name}) #=> {name:'12345', age: 21}
     Saneitized.convert( {name:'12345', 'age' => '21'}, :key_blacklist => [:name, 'age'}) #=> {name:'12345', 'age' => '21'}
 
+### Sanitizers
+
+By default convert runs through the sanitizers, but you can pick and choose what sanitizers you want to use.
+
+You can select to 'only' use certian converter
+
+    Saneitized.convert( {a_float:'12.34', an_integer:'1234'}, :only => [:integer] ) #=> {a_float:'12.34', an_integer: 1234}
+
+You can choose to use all the sanitizers 'except' a selection
+
+    Saneitized.convert( {a_float:'12.34', an_integer:'1234'}, :except => :float ) #=> {a_float:'12.34', an_integer: 1234}
+
+You can also add sanitizers that are overly agressive and not part of the default set
+
+    Saneitized.convert( "2001-02-03 10:11:12 -0400", add: :time) #=> 2001-02-03 10:11:12 -0400
+
+You can pass these options as a single symbol or as an array of symbols
+
 ### Important Notes
 
 To convert a sanetized array/hash back to a non-saneitized hash, simply call the #to_a and #to_h

data/lib/saneitized/converter.rb

@@ -5,13 +5,22 @@ module Saneitized
 
   def self.convert(unknown, options = {})
     options[:blacklist] ||= nil
+    options[:except] ||= []
+    options[:add] ||= []
+    options[:only] ||= %w(true false nil integer float json)
 
     return Saneitized::Hash.new(unknown, options) if unknown.is_a? ::Hash
     return Saneitized::Array.new(unknown, options) if unknown.is_a? ::Array
     return unknown unless unknown.is_a? String #Only attempt to convert string
     return unknown if Array(options[:blacklist]).include?(unknown)
 
-    %w(true false nil integer float json time).each do |type|
+    except = Array(options[:except]).map(&:to_s)
+    only =   Array(options[:only]).map(&:to_s)
+    add =    Array(options[:add]).map(&:to_s)
+
+    sanitizers = (only + add).uniq - except
+
+    sanitizers.each do |type|
       value = Converter.send(type + '?', unknown)
       next if value == :nope
       return (type == 'json') ? convert(value, options) : value
@@ -20,7 +29,6 @@ module Saneitized
     unknown
   end
 
-
   module Converter
     extend self
 

data/lib/saneitized/version.rb

@@ -1,3 +1,3 @@
 module Saneitized
-  VERSION = '1.5.0'
+  VERSION = '2.0.0'
 end

data/spec/saneitized/converter_spec.rb

@@ -11,7 +11,7 @@ describe Saneitized do
     it 'should convert array' do
       insane = ['1', '3', '2014-05-29 19:19:44 -0400']
       sane = [1, 3, Time.new(2014,5,29,19,19,44,'-04:00')]
-      expect(Saneitized.convert(insane)).to eql sane
+      expect(Saneitized.convert(insane, add: :time)).to eql sane
     end
 
     it 'should convert json' do
@@ -59,16 +59,16 @@ describe Saneitized do
     end
 
     it 'should convert datetime string' do
-      expect(Saneitized.convert("2001-02-03 10:11:12 -0400")).to eql Time.new(2001,2,3,10,11,12,'-04:00')
+      expect(Saneitized.convert("2001-02-03 10:11:12 -0400", add: :time)).to eql Time.new(2001,2,3,10,11,12,'-04:00')
     end
 
-    %w(marketplaces).each do |string|
+    ["marketplaces", "cpr-first-aid.wonderhowto.com"].each do |string|
       it "should leave #{string} alone" do
         expect(Saneitized.convert(string)).to eq string
       end
     end
 
-    context 'with blacklist' do 
+    context 'with blacklist' do
       it 'should not convertet blacklisted item' do
         expect(Saneitized.convert('day', blacklist:'day')).to eql 'day'
       end
@@ -90,5 +90,25 @@ describe Saneitized do
         expect(sane).to eq expected
       end
     end
+
+    let(:input){ { integer:'12345', float:'12.345', true:'true', false:'false' } }
+
+    context 'with except' do
+      it 'should not convert ' do
+        expected = {integer: 12345, float:'12.345', true: 'true', false: false }
+        sane = Saneitized.convert( input, except:[:float, :true] )
+        expect(sane).to eq expected
+      end
+    end
+
+    context 'with only' do
+      it 'should only used passed in converters' do
+        expected = {integer: 12345.0, float: 12.345, true: true, false:'false'}
+        sane = Saneitized.convert( input, only:[:float, :true, :false], except: :false)
+        expect(sane).to eq expected
+      end
+    end
+
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saneitized
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Benjamin Guest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic