saneitized 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c94e5037a177dcba5a97198c0b29a9ebdf46013b
-  data.tar.gz: f140fd55b042f7255d908a42192ac21c8c4c5c22
+  metadata.gz: b1aea000050c5391f959faea1399cbe08a651b86
+  data.tar.gz: 890266370085e2fddedd0c26169bde2fadfb6d74
 SHA512:
-  metadata.gz: a3347445524fa7cf0060ca9c915e9f23403dba14be1f42eb3bf1382b2342e1303126df8016c1ceb2c019e9846b9aefd873df3bbc0f8e9703c3da390245d664fb
-  data.tar.gz: 4ddd40e71917b2aeeb630534bfd2b7f78f2e357568f8e14923e2cc64424426f70caa418a9c293b8ad1643dd4bd21209267349fe7c634e2dd94d772f2a9ea010c
+  metadata.gz: d57de8a38f2ce61bf8c44f3a1254973b17ba842bd24f97ac98b708e5fffd5a7ed64c50a9583be9f8750ceb66cf1856441e21e38dd4104fd4891a37cb69fe8a94
+  data.tar.gz: 94ae347a107b4c72df66f9f2a04c59ae3a0d0ba1ebb6ac643c7f97d8f9d03a171a7815f74487cafdefd27fd68021ad64cdc2c31e0f9ecc74856da0e1995bc2a6

data/README.md

@@ -28,7 +28,58 @@ Or install it yourself as:
 
 ## Usage
 
-Use it like so
+The guts of sanitized is it's convert method, it will converts strings into their approprate 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
+
+    Boolean: Saneitized.convert('true') #=> true ('false' works the same way)
+    Integer: Saneitized.convert('42') #=> 42
+    Float:   Saneitized.convert('22.2') #=> 22.2
+    Time:    Saneitized.convert("2014-05-28T23:15:26Z") #=> 2014-05-28 23:15:26 UTC
+
+You can checkout `lib/saneitized/converter.rb` for more information
+
+Sanetized ignores all non-string types except Arrays and Hashes.
+
+### Arrays and Hashes
+
+Arrays and hashes are recursivly 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
+
+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
+
+    hash = Saneitized::Hash.new
+    hash['fred'] = '234'
+    hash['fred'] #=> 234
+
+### Important Notes
+
+To convert a sanetized array/hash back to a non-saneitized hash, simply call the #to_a and #to_h
+methods, but keep in mind that the resulting hash still points to the same underlying data, for
+example.
+
+    h = Sanetized::Hash.new({'key' => '10'})
+    h #=> {'key' => 10}
+    h['key'] = '20'
+    h #=> {'key' => 20}
+    hh = h.to_h
+    hh['key'] = '30'
+    h #=> {'key' => '30'}
+
+This is how normal ruby arrays and hashes work as well, if you want a new copy, you need to
+call dup.
+
+#### NotImplementedError
+
+If you run across a NotImplementedError with something that should works with a regular hash or
+array, it's because I plan to implement the saneitized version, but haven't had a need for it yet,
+you are welcome to submit pull requests that implements these holes.
+
+### More Example
 
     sane_hash = Saneitized::Hash.new({:false =>  'false',
                                       :number => '10',
@@ -44,6 +95,7 @@ See the specs for more examples.
 
 1. Fork it ( http://github.com/<my-github-username>/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.
 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.rb

@@ -1,3 +1,4 @@
 require 'saneitized/version'
 require 'saneitized/converter'
 require 'saneitized/hash'
+require 'saneitized/array'

data/lib/saneitized/array.rb

@@ -0,0 +1,31 @@
+
+module Saneitized
+
+  class Array < SimpleDelegator
+
+    def initialize(array = [])
+      super(array.map{|item| Saneitized.convert(item)})
+      self
+    end
+
+    def []=(index, value)
+      super index, Saneitized.convert(value)
+    end
+
+    def << (value)
+      super Saneitized.convert(value)
+    end
+
+    def push(*args)
+      raise NotImplementedError
+    end
+
+    def unshift(*args)
+      raise NotImplementedError
+    end
+
+    def insert(*args)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/saneitized/converter.rb

@@ -1,12 +1,14 @@
 module Saneitized
   def self.convert(unknown)
     return Saneitized::Hash.new(unknown) if unknown.is_a? ::Hash
+    return Saneitized::Array.new(unknown) if unknown.is_a? ::Array
     return unknown unless unknown.is_a? String #Only attempt to convert string
     return true  if unknown == 'true'
     return false if unknown == 'false'
 
     if value = Converter.integer?(unknown) then return value end
-    if value = Converter.float?(unknown) then return value end
+    if value = Converter.float?(unknown)   then return value end
+    if value = Converter.time?(unknown)    then return value end
 
     unknown
   end
@@ -24,6 +26,12 @@ module Saneitized
     rescue ArgumentError, TypeError
       false
     end
+
+    def time?(unknown)
+      Time.parse(unknown)
+    rescue ArgumentError, TypeError
+      false
+    end
   end
 
 end

data/lib/saneitized/hash.rb

@@ -2,12 +2,19 @@ module Saneitized
 
   class Hash < SimpleDelegator
 
-    def initialize(hash)
-      super(hash)
-      hash.each do |key, value|
-        hash[key] = Saneitized.convert(value)
-      end
+    def initialize(hash = {})
+      new_hash = {}
+      hash.each do |key, value| new_hash[key] = Saneitized.convert(value) end
+      super(new_hash)
+      self
     end
 
+    def []=(key, value)
+      super key, Saneitized.convert(value)
+    end
+
+    def merge!(*args, &block)
+      raise NotImplementedError
+    end
   end
 end

data/lib/saneitized/version.rb

@@ -1,3 +1,3 @@
 module Saneitized
-  VERSION = '0.1.0'
+  VERSION = '1.0.1'
 end

data/spec/saneitized/array_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Saneitized::Array do
+
+  describe '#new' do
+    it 'should convert array of numbers' do
+      Saneitized::Array.new(['1','2','3']).should == [1,2,3]
+    end
+  end
+
+  describe '#[]=' do
+    it 'should convert object at index' do
+      a = Saneitized::Array.new
+      a[0] = 'true'
+      a[0].should == true
+    end
+  end
+
+  describe '#<<' do
+    it 'should converted added object' do
+      a = Saneitized::Array.new
+      a << '11'
+      a.should == [11]
+    end
+  end
+end
+

data/spec/saneitized/converter_spec.rb

@@ -8,6 +8,12 @@ describe Saneitized do
       Saneitized.convert(unsullied).should == sanitized
     end
 
+    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')]
+      Saneitized.convert(insane).should == sane
+    end
+
     it "should change 'true' to true" do
       Saneitized.convert('true').should == true
     end
@@ -39,5 +45,9 @@ describe Saneitized do
     it 'should do nothing to nil' do
       Saneitized.convert(nil).should be_nil
     end
+
+    it 'should convert datetime string' do
+      Saneitized.convert("2001-02-03 10:11:12 -0400").should == Time.new(2001,2,3,10,11,12,'-04:00')
+    end
   end
 end

data/spec/saneitized/hash_spec.rb

@@ -36,4 +36,12 @@ describe Saneitized::Hash do
     end
   end
 
-end
+  describe "#[]=" do
+    it 'should sanitized assigned keys' do
+      hash = Saneitized::Hash.new
+      hash['key']= '10'
+      hash['key'].should == 10
+    end
+  end
+
+end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: saneitized
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Benjamin Guest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
 description: Converts ruby hash values from strings to fixnums, floats, true and false
@@ -88,18 +88,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/saneitized.rb
+- lib/saneitized/array.rb
 - lib/saneitized/converter.rb
 - lib/saneitized/hash.rb
 - lib/saneitized/version.rb
 - saneitized.gemspec
+- spec/saneitized/array_spec.rb
 - spec/saneitized/converter_spec.rb
 - spec/saneitized/hash_spec.rb
 - spec/spec_helper.rb
@@ -113,21 +115,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sanely converts string values to their ruby equivalent
 test_files:
+- spec/saneitized/array_spec.rb
 - spec/saneitized/converter_spec.rb
 - spec/saneitized/hash_spec.rb
 - spec/spec_helper.rb