saneitized 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91046f5a6ab0ea08b9fd2b0d1eaef01ec362aa79
-  data.tar.gz: ea32d9f47246269f90a75c68c2d605fb79945da6
+  metadata.gz: 53b42ab2eac3361c84d349b909c00f7d0757e4f2
+  data.tar.gz: 1ce9c29cc4e9ce9864e6a4334c2dee887e537fe5
 SHA512:
-  metadata.gz: 70c89d0a54e3260de90eeef06ec11ded53054ea5b8eee4eee0d381f7400f84ad352dac6f341a736d52a0865af7a8b599e06a62cb5674c651e7cf477bc44b49b7
-  data.tar.gz: 7832ff18e346dbcb40b19f57a5a0e7ae420b49f014175ef3dfbaad6018fa5b3464f6de9ea8ad7597a088c412aa4258d4db61076aba18a25bd2a12c8d275fd745
+  metadata.gz: a3e99059dc40e6d595f2d6b1fb0f87872dca1462f941fe5fd48d492823c7aff46d9e9073762b8e24af9447f0dd8d4019849537805dc7037fb5985902f2df9860
+  data.tar.gz: 0a99e181dd840cd9dcd8ee8c90d6370f61206b132195fc0197141207a3f5781a7544243302463227f471fa5cf6fac384ebc557e38dfda3799452813990272d26

data/README.md

@@ -28,7 +28,7 @@ Or install it yourself as:
 
 ## Usage
 
-The guts of sanitized is it's convert method, it will converts strings into their approprate types.
+The guts of saneitized is it's convert method, it will converts strings into their appropriate types.
 It tries to convert strings in the following order, trying the next thing if it fails or returning
 the new value if it succeeds
 
@@ -41,15 +41,15 @@ the new value if it succeeds
 
 You can checkout `lib/saneitized/converter.rb` for more information
 
-Sanetized ignores all non-string types except Arrays and Hashes.
+Saneitized ignores all non-string types except Arrays and Hashes.
 
 ### Arrays and Hashes
 
-Arrays and hashes are recursivly traversed and saneitized. So something like
+Arrays and hashes are recursively traversed and saneitized. So something like
 
     insane = [{'number' => '10'}, {'float' => '34.5'}]
-    sane = Sanitized.convert(insane)              # Sanitized::Array.new(insane) is equivelent
-    sane == [{'number' => 10}, {'float' => 34.5}] # Note this is a Sanitized::Array
+    sane = Saneitized.convert(insane)              # Saneitized::Array.new(insane) is equivelent
+    sane == [{'number' => 10}, {'float' => 34.5}] # Note this is a Saneitized::Array
 
 Note that the returned types are Saneitized::Hash or Saneitized::Array, these function almost the same
 as regular arrays except that new assigned values will also be saneitized
@@ -60,9 +60,14 @@ as regular arrays except that new assigned values will also be saneitized
 
 ### Blacklists
 
-You can make sanitized ignore certain strings by includeing a blacklist option 
+You can make saneitized ignore certain strings by including a blacklist option
 
-   Sanitized.convert('23', blacklist:%w(21 22 23)) => '23'
+    Saneitized.convert('23', blacklist:%w(21 22 23)) #=> '23'
+
+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'}
 
 ### Important Notes
 
@@ -101,9 +106,9 @@ See the specs for more examples.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/saneitized_hash/fork )
+1. Fork it ( http://github.com//saneitized_hash/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-2. Writes Specs, pull requrests will not be accepted without tests.
+2. Writes Specs, pull requests will not be accepted without tests.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/lib/saneitized/hash.rb

@@ -6,8 +6,11 @@ module Saneitized
 
     def initialize(hash = {}, options = {})
       @options = options
+      @key_blacklist = Array(options.fetch(:key_blacklist){[]})
       new_hash = {}
-      hash.each do |key, value| new_hash[key] = Saneitized.convert(value, options) end
+      hash.each do |key, value|
+        new_hash[key] = convert_key_value(key, value)
+      end
       super(new_hash)
       self
     end
@@ -19,5 +22,16 @@ module Saneitized
     def merge!(*args, &block)
       raise NotImplementedError
     end
+
+    private
+
+    def convert_key_value(key, value)
+      if @key_blacklist.include? key
+        value
+      else
+        Saneitized.convert(value, @options)
+      end
+    end
+
   end
 end

data/lib/saneitized/version.rb

@@ -1,3 +1,3 @@
 module Saneitized
-  VERSION = '1.3.2'
+  VERSION = '1.4.0'
 end

data/spec/saneitized/converter_spec.rb

@@ -82,5 +82,13 @@ describe Saneitized do
         expect(Saneitized.convert('{"today":["day","month","week"]}', blacklist:%w(day month week))).to eq expected
       end
     end
+
+    context 'with key_blacklist' do
+      it 'should respect key_blacklist' do
+        expected = {name:'12345', 'age' => 21}
+        sane = Saneitized.convert( {name:'12345', 'age' => '21'}, :key_blacklist => :name)
+        expect(sane).to eq expected
+      end
+    end
   end
 end

data/spec/saneitized/hash_spec.rb

@@ -34,6 +34,21 @@ describe Saneitized::Hash do
     it 'should do nothing to nil' do
       expect(Saneitized::Hash.new({nill: nil})[:nill]).to be nil
     end
+
+    context 'with key_blacklist option' do
+      it 'should not convert blacklisted key' do
+        sane = Saneitized::Hash.new({name:'21', age:21}, :key_blacklist => :name)
+        expected = {name:'21', age:21}
+        expect(sane).to eql expected
+      end
+
+      it 'should not convert blacklisted keys' do
+        sane = Saneitized::Hash.new({name:'21', 'foo'=>'33.5', age:21}, :key_blacklist => [:name, 'foo'])
+        expected = {name:'21', 'foo'=>'33.5', age:21}
+        expect(sane).to eql expected
+      end
+    end
+
   end
 
   describe "#[]=" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saneitized
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Benjamin Guest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic