type-humanizer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94441bb261b664b050d691e742937cee4a660084
-  data.tar.gz: b6f767ada57a7405fc9cb6463b727a9f4ce0573b
+  metadata.gz: aeaef0b54d823153c2202e8cbf9a3536c9864ed8
+  data.tar.gz: bcf0b0123f80d1ef0239c579bb005e4ce7f87778
 SHA512:
-  metadata.gz: 47db09f56abe66f98180bc7a3b31eec13ea5fa2857d943d376f4503abc29213a40343ef20a501c8345fe8b06ad33eeda997e6decf53fe6f53434d3023b39706e
-  data.tar.gz: a9141a44c408ac5f77fb3be381f315fa08b6ced19fda5c4688c969c563cdb72976b55148b63ccc4fa4172d4e6f7cb28ed17943dd71c921e8880cf5163254a727
+  metadata.gz: 958cc0661fdb64d0e41fb096ef9533165cbc450659c12cb8d35b1d3e25a4cffe80346aaa1964bc966f4e6a11ad2a031ad4039733709f6ce62f5289973d47c5c0
+  data.tar.gz: 926ed3f3c450341309c36ce0265f8a213482ba0f9201e5e56bb40bf030c9e8c559875eeae3be70b4be5a5ce6042a0e79f3aca0c63e96281c01242a0bdc1e2cb6

data/README.md

@@ -1,12 +1,14 @@
 # Humanizer
 
-TODO: Write a gem description
+A library for humazing and sanitizing array and hash
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'type-humanizer'
+```ruby
+gem 'type-humanizer'
+```
 
 And then execute:
 
@@ -18,7 +20,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Humanizing
+
+We can humanize `Array` and `Hash`
+
+To do that, we just call `Humanizer::Human#from`
+
+```ruby
+Humanizer::Human.from ['a', 'b', 'c']
+=> "a, b, c"
+
+Humanizer::Human.from { :foo => 'bar', :boo => 'baz' }
+=> "foo: bar, boo: baz"
+```
+
+### Sanitizing
+Again, we can sanitize `Array` and `Hash`
+
+This time we need the `Humanizer::Sanitize` class
+```ruby
+sanitizer = Humanizer::Sanitize.new
+
+sanitizer.to_array 'a, b, c'
+=> ["a", "b", "c"]
+
+sanitizer.to_hash 'foo: bar, boo: baz'
+=> { "foo" => "bar", "boo" => "baz" }
+```
+    
+We can also sanitize a hash of params.. This could be some Rails params
+
+All we need to do is pass the params and specify which params should be sanitized to what type
+
+```ruby
+params = { friends: 'Jack, Jill', favorites: 'drink: Coffee, fruit: Bananas' }
+
+Humanizer::Sanitize.params params, friends: :array, favorites: :hash
+=> { :friends => ["Jack", "Jill"], :favorites => { "drink" => "Coffee", "fruit" => "Banana" } }
+```
+
+
 
 ## Contributing
 
@@ -27,3 +68,4 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+    

data/lib/humanizer.rb

@@ -41,7 +41,7 @@ module Humanizer
 
   class Human
     def self.from(value)
-      type = String(value.class).downcase
+      type = String(value).class.downcase
       human = Human.new
 
       human.send "from_#{type}", value

data/lib/humanizer/version.rb

@@ -1,3 +1,3 @@
 module Humanizer
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: type-humanizer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Aske Hansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler