transformable 0.0.5 → 1.0.0

data/README.md

@@ -1,6 +1,6 @@
 # Transformable
 
-TODO: Write a gem description
+Lets you manipulate data as it's being set on an object without a lot of setter method boilerplate
 
 ## Installation
 
@@ -18,7 +18,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use the `clean` method on your objects to create a setter method that manipulates inputs:
+
+```ruby
+class User < ActiveRecord::Base
+  include Transformable
+  clean(:email) {|e| e.downcase}
+end
+
+> u = User.new(email: "foo@BAR.com")
+> u.email
+ => "foo@bar.com"
+```
+
+By default, nil values won't be passed through to the block. Use the skip_nil option if you want them:
+
+```ruby
+class User < ActiveRecord::Base
+  include Transformable
+  clean(:email, :skip_nil => false) {|e| e || "example@foobar.com"}
+end
+
+> u = User.new(email: "email@email.com")
+> u.email = nil
+> u.email
+ => "example@foobar.com"
+```
+
+I use regexes for removing forbidden characters:
+
+```ruby
+class User < ActiveRecord::Base
+  include Transformable
+  clean(:email) {|e| e.gsub(/\s/, "")} # remove spaces
+end
+
+> u = User.new(email: "f o o @ b a r . c o m")
+> u.email
+ => "foo@bar.com"
+```
+
+Transformable works on pure ruby objects as well as ActiveRecord objects!
 
 ## Contributing
 

data/lib/transformable/version.rb

@@ -1,3 +1,3 @@
 module Transformable
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transformable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies: []
 description: Lets you manipulate data as it's being set on an object without a lot
   of setter method boilerplate