scrubby 0.1.1 → 0.2.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 laserlemon
+Copyright (c) 2009 Steve Richert
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,17 +1,91 @@
 = scrubby
 
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+It's so simple! <tt>scrubby</tt> makes sure that all your attributes are cleaned up before they make their way into your models.
+
+== Installation
+
+In <tt>environment.rb</tt>:
+
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'scrubby'
+    ...
+  end
+
+At your application root, run:
+
+  $ sudo rake gems:install
+
+== Example
+
+By default, <tt>scrubby</tt> will strip extra whitespace from strings, and turn blank strings into nil values:
+
+  class User < ActiveRecord::Base
+    scrub :first_name, :middle_name, :last_name
+  end
+
+  >> u = User.new(:first_name => " Steve", :middle_name => "  ", :last_name => "Richert ")
+  => #<User first_name: "Steve", middle_name: nil, last_name: "Richert">
+
+Or you can override the default behavior, just by defining a <tt>scrub</tt> instance method:
+
+  class User < ActiveRecord::Base
+    scrub :first_name, :middle_name, :last_name
+  
+    def scrub(value)
+      value.to_s.upcase
+    end
+  end
+
+  >> u = User.new(:first_name => "Steve", :last_name => "Richert")
+  => #<User first_name: "STEVE", middle_name: "", last_name: "RICHERT">
+
+And defining your own scrubbers inline is super easy:
+
+  class User < ActiveRecord::Base
+    scrub(:first_name, :last_name){|v| v.blank? ? nil : v.titleize }
+  
+    scrub(:middle_name) do |value|
+      initials = value.split(" ").map{|n| n.first + "." }
+      initials.empty? ? nil : initials.join(" ")
+    end      
+  end
+
+  class Admin < User
+    scrub(:middle_name){ nil }
+  end
+
+  >> u = User.new(:first_name => "stephen", :middle_name => "joel michael", :last_name => "richert")
+  => #<User first_name: "Stephen", middle_name: "J. M.", last_name: "Richert">
+  >> a = Admin.new(:first_name => "stephen", :middle_name => "joel michael", :last_name => "richert")
+  => #<Admin first_name: "Stephen", middle_name: nil, last_name: "Richert">
+
+== How It Works
+
+It's pretty straightforward, and there's nothing all that fancy happening behind the scenes.
+
+Scrubbing happens only when attributes are set. That way, no time is wasted scrubbing every time an attribute is retrieved.
+
+For column attributes, the scrubbing is done at the <tt>write_attribute</tt> level, without stepping on ActiveRecord's toes by creating a bunch of unnecessary setter methods.
+
+<tt>scrubby</tt> also works with virtual attributes, simply by adding an <tt>alias_method_chain</tt> to the corresponding setter method, so the original can still be accessed via <tt>attribute_without_scrub=</tt>.
+
+Inheritance is respected, just as you'd expect, down through model subclasses. Scrubbers are overridden in subclasses with no problem.
+
+== Inspiration
+
+Those of you who are familiar with <tt>attribute_normalizer</tt>[http://github.com/mdeering/attribute_normalizer] will recognize the how <tt>scrubby</tt> looks and feels, and that's no accident! <tt>attribute_normalizer</tt> has a simple, clean and effective interface.
+
+But <tt>scrubby</tt> was written to be an improvement on what's happening behind the scenes, particularly with regards to inheritance and avoiding unnecessary method definitions. Basically, the idea was to really clean up and simplify the back-end of an already awesome interface.
+
+== Contributing
+
+* Fork[http://github.com/laserlemon/scrubby/fork] the project
+* Make your feature addition or bug fix
+* Add, change or remove corresponding tests
+* Commit (please don't change Rakefile or VERSION)
+* Send me a pull request
 
 == Copyright
 
-Copyright (c) 2010 laserlemon. See LICENSE for details.
+Copyright (c) 2010 Steve Richert. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/scrubby.rb

@@ -15,6 +15,18 @@ module Scrubby
     def scrub(*attributes, &block)
       scrubber = block_given? ? block : instance_method(:scrub)
       self.scrubbers = attributes.inject({}){|s,a| s.merge!(a.to_s => scrubber) }
+
+      attributes.reject{|a| column_names.include?(a.to_s) }.each do |virtual_attribute|
+        unless instance_methods.include?("#{virtual_attribute}_with_scrub=")
+          define_method "#{virtual_attribute}_with_scrub=" do |value|
+            scrubber = scrubbers[virtual_attribute.to_s]
+            value = scrubber.bind(self).call(value)
+            send("#{virtual_attribute}_without_scrub=", value)
+          end
+
+          alias_method_chain "#{virtual_attribute}=", :scrub
+        end
+      end
     end
   end
 

data/scrubby.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{scrubby}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Richert"]

data/test/test_scrubby.rb

@@ -83,10 +83,10 @@ class TestScrubby < Test::Unit::TestCase
         @user = User.new
       end
 
-      should 'do nothing' do
+      should 'clean the value' do
         middle_name = ' Joel Michael '
         @user.middle_name = middle_name
-        assert_equal middle_name, @user.middle_name
+        assert_not_equal middle_name, @user.middle_name
       end
     end
 
@@ -117,6 +117,18 @@ class TestScrubby < Test::Unit::TestCase
       end
     end
 
+    context 'over multiple declarations' do
+      setup do
+        User.scrub(:first_name)
+        User.scrub(:last_name)
+        @user = User.new
+      end
+
+      should 'respect all scrubbers' do
+        assert_same_elements %w(first_name last_name), User.scrubbers.keys
+      end
+    end
+
     context 'an inherited model' do
       setup do
         User.scrub(:first_name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scrubby
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Steve Richert