vacuum_cleaner 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+doc
+pkg
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lukas Westermann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+Vacuum Cleaner
+==============
+
+A Ruby (and Rails) attribute normalization gem.
+
+** TODO **

data/Rakefile

@@ -0,0 +1,88 @@
+require 'rake'
+require 'rake/testtask'
+require 'yard'
+require File.join(File.dirname(__FILE__), 'lib', 'vacuum_cleaner')
+
+desc 'Test the vacuum_cleaner plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for vacuum_cleaner. (requires yard)'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = [
+      "--readme", "README.md",
+      "--title", "vacuum_cleaner (v#{VacuumCleaner::VERSION}) API Documentation"
+  ]
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "vacuum_cleaner"
+    gemspec.version = VacuumCleaner::VERSION
+    gemspec.summary = "Ruby (and Rails) attribute cleaning support, provides some nice default normalization strategies."
+    description = <<-DESC
+      ** Swoooosh ** - and all those leading and trailing whitespaces are gone, or ** Frooom ** - and the value
+      is normalized to always be prefixed by 'http://' and much more. Works with both plain old Ruby, and Rails (ActiveModel
+      and ActiveSupport).
+    DESC
+    gemspec.description = description.strip
+    gemspec.email = "lukas.westermann@gmail.com"
+    gemspec.homepage = "http://github.com/lwe/vacuum_cleaner"
+    gemspec.authors = ["Lukas Westermann"]
+    gemspec.licenses = %w{LICENSE}
+    gemspec.extra_rdoc_files = %w{README.md}
+    
+    gemspec.add_development_dependency('shoulda', '>= 2.10.2')
+    gemspec.add_development_dependency('rr', '>= 0.10.5')
+    # gemspec.add_development_dependency('activesupport', '>= 2.3.5')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Clean all generated files (.yardoc and doc/*)'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "pkg"
+  FileUtils.rm_rf ".yardoc"
+end
+
+namespace :metrics do
+  desc 'Report all metrics, i.e. stats and code coverage.'
+  task :all => [:stats, :coverage]
+  
+  desc 'Report code statistics for library and tests to shell.'
+  task :stats do |t|
+    require 'code_statistics'
+    dirs = {
+      'Libraries' => 'lib',
+      'Unit tests' => 'test/unit'
+    }.map { |name,dir| [name, File.join(File.dirname(__FILE__), dir)] }
+    CodeStatistics.new(*dirs).to_s
+  end
+  
+  desc 'Report code coverage to HTML (doc/coverage) and shell (requires rcov).'
+  task :coverage do |t|
+    rm_f "doc/coverage"
+    mkdir_p "doc/coverage"
+    rcov = %(rcov -Ilib:test --exclude '\/gems\/' -o doc/coverage -T test/unit/vacuum_cleaner/*_test.rb -T test/unit/vacuum_cleaner/*/*_test.rb)
+    system rcov
+  end
+  
+  desc 'Report the fishy smell of bad code (requires reek)'
+  task :smelly do |t|
+    puts
+    puts "* * * NOTE: reek currently reports several false positives,"
+    puts "      eventhough it's probably good to check once in a while!"
+    puts
+    reek = %(reek -s lib)
+    system reek
+  end
+end

data/init.rb

@@ -0,0 +1,4 @@
+require 'vacuum_cleaner'
+
+ActiveRecord::Base.class_eval { include VacuumCleaner::Normalizations } # all versions of rails
+ActiveModel::Base.class_eval { include VacuumCleaner::Normalizations } if defined?(ActiveModel::Base) # Rails 3+

data/lib/vacuum_cleaner.rb

@@ -0,0 +1,6 @@
+module VacuumCleaner
+  VERSION = "0.1.0".freeze
+  
+  autoload :Normalizer, 'vacuum_cleaner/normalizer'
+  autoload :Normalizations, 'vacuum_cleaner/normalizations'
+end

data/lib/vacuum_cleaner/normalizations.rb

@@ -0,0 +1,69 @@
+module VacuumCleaner
+  # Suffix added to existing setter methods
+  WITHOUT_NORMALIZATION_SUFFIX = "_without_normalization"
+  
+  module Normalizations
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+        
+    module ClassMethods
+      def normalizes(*attributes, &block)
+        metaklass = class << self; self; end
+        
+        normalizations = attributes.last.is_a?(Hash) ? attributes.pop : {}
+        raise ArgumentError, "You need to supply at least one attribute" if attributes.empty?
+        
+        normalizers = []
+        normalizers << Normalizer.new unless normalizations.delete(:default) === false
+        
+        normalizations.each do |key, options|
+          begin
+            normalizers << const_get("#{VacuumCleaner.camelize_value(key)}Normalizer").new(options === true ? {} : options)
+          rescue NameError
+            raise ArgumentError, "Unknown normalizer: '#{key}'"
+          end
+        end
+        
+        attributes.each do |attribute|
+          attribute = attribute.to_sym
+          send(:define_method, :"normalize_#{attribute}") do |value|
+            value = normalizers.inject(value) { |v,n| n.normalize(self, attribute, v) }
+            block_given? ? (block.arity == 1 ? yield(value) : yield(self, attribute, value)) : value
+          end
+          original_setter = "#{attribute}#{VacuumCleaner::WITHOUT_NORMALIZATION_SUFFIX}=".to_sym
+          send(:alias_method, original_setter, "#{attribute}=") if instance_methods.include?("#{attribute}=")
+                    
+          rb_src = <<-RUBY
+            def #{attribute}=(value)                                                                          #  1.  def name=(value)
+              value = send(:'normalize_#{attribute}', value)                                                  #  2.    value = send(:'normalize_name', value)
+              return send(#{original_setter.inspect}, value) if respond_to?(#{original_setter.inspect})       #  3.    return send(:'name_wo...=', value) if respond_to?(:'name_wo...=')
+              return send(:write_attribute, #{attribute.inspect}, value) if respond_to?(:write_attribute)     #  4.    return send(:write_attribute, :name, value) if respond_to?(:write_attribute)
+              @#{attribute} = value                                                                           #  5.   @name = value
+            end                                                                                               #  6.  end
+          RUBY
+          
+          module_eval rb_src, __FILE__, __LINE__
+        end
+      end      
+    end    
+  end
+  
+  # Okay, because this library currently does not depend on
+  # <tt>ActiveSupport</tt> or anything similar an "independent" camelizing process is
+  # required. So it works pretty easy.
+  #
+  # If <tt>value.to_s</tt> responds to <tt>:camelize</tt>, then call it else use implementation
+  # taken from http://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L25
+  def camelize_value(value)
+    value = value.to_s
+    value.respond_to?(:camelize) ? value.camelize : value.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+  module_function :camelize_value
+end
+
+# load standard normalizations
+Dir[File.dirname(__FILE__) + "/normalizations/*.rb"].sort.each do |path|
+  require "vacuum_cleaner/normalizations/#{File.basename(path)}"
+end

data/lib/vacuum_cleaner/normalizations/method.rb

@@ -0,0 +1,48 @@
+module VacuumCleaner
+  module Normalizations
+    
+    # Generic method based normalizer which just calls supplied method
+    # on value (unless nil).
+    #
+    #   normalizes :name, :method => :titelize
+    #
+    # Custom instances accept a <tt>:method</tt> option.
+    #
+    #   MethodNormalizer.new(:method => :titelize)
+    #
+    # Subclasses of the +MethodNormalizer+ can take advantage of it's
+    # +normalize_if_respond_to+ method, to easily create custom
+    # normalizers based on methods availble on the result value.
+    class MethodNormalizer < Normalizer
+      # Ensure access to default normalization method
+      alias_method :default_normalize_value, :normalize_value
+      
+      # Helper method to "bake" a method normalizer from a method, enabling us to do stuff like.
+      #
+      #   TitelizeNormalizer = MethodNormalizer.build(:titleize)
+      #
+      def self.build(sym)
+        module_eval "Class.new(MethodNormalizer) do; def initialize(*args); super({ :method => #{sym.inspect}}) end; end", __FILE__, __LINE__
+      end
+      
+      # Accept either a hash or symbol name.
+      def initialize(args = {})
+        args = { :method => args } unless args.is_a?(Hash)
+        super(args)
+      end
+      
+      # Normalize value by calling the default normalizer (strip + nil if empty)
+      # and then if not <tt>nil</tt> call the method defined.
+      def normalize_value(value)
+        sym = options[:method]
+        value.respond_to?(sym) ? value.send(sym) : value
+      end      
+    end
+    
+    # Downcase value unless nil or empty.
+    DowncaseNormalizer = MethodNormalizer.build(:downcase)
+    
+    # Upcases value unless nil or empty.
+    UpcaseNormalizer = MethodNormalizer.build(:upcase)
+  end
+end

data/lib/vacuum_cleaner/normalizations/url.rb

@@ -0,0 +1,15 @@
+module VacuumCleaner
+  module Normalizations
+    class UrlNormalizer < Normalizer
+      def initialize(options = {})
+        options = { :scheme => "http://", :unless => %r{\Ahttps?://}i } if options.nil? || options.empty?
+        options = { :scheme => options, :unless => %r{\A#{options}}i } unless options.is_a?(Hash)
+        super(options)
+      end
+      
+      def normalize_value(value)
+        value =~ options[:unless] ? value : "#{options[:scheme]}#{value}" unless value.nil?
+      end
+    end
+  end
+end

data/lib/vacuum_cleaner/normalizer.rb

@@ -0,0 +1,67 @@
+module VacuumCleaner #:nodoc:
+  
+  # A small base class for implementing custom value normalizers.
+  # Might seem like a slight overkill, yet makes the library pretty
+  # reusable and all. Based on Rails 3 validator stuff.
+  #
+  #
+  #   class Person
+  #     include VacuumCleaner::Normalizations
+  #     normalizes :name, :titleize => true
+  #   end
+  #
+  #   class TitleizeNormalizer < VacuumCleaner::Normalizer
+  #     def normalize_value(value)
+  #       value.titelize unless value.blank?
+  #     end
+  #   end
+  #
+  # Any class that inherits from +VacuumCleaner::Normalizer+ must implement
+  # a method called <tt>normalize_value</tt> which accepts the <tt>value</tt> to normalize. Furthermore
+  # the value returned by <tt>normalize</tt> is used as the new value for
+  # the attribute.
+  #
+  # To reuse the behaviour as defined by the default normalizer (strip & empty),
+  # just use <tt>super</tt>.
+  #
+  #   class TitleizeNormalizer < VacuumCleaner::Normalizer
+  #     def normalize_value(value)
+  #       super(value).try(:titelize)
+  #     end
+  #   end
+  #
+  # If access to the record or attribute being normalized is required the method
+  # +normalize+ can be overriden instead.
+  #
+  #    class FancyNormalizer < VacuumCleaner::Normalizer
+  #      def normalize(object, attribute, value)
+  #        ...
+  #      end
+  #    end
+  #
+  # This can be used together with the +normalizes+ method (see
+  # VacuumCleaner::Normalizers.normalizes for more on this).
+  class Normalizer
+    attr_reader :options
+        
+    # Accepts an array of options, which will be made available through the +options+ reader.
+    def initialize(options = {})
+      @options = options
+    end
+    
+    # Only override this method if access to the <tt>object</tt> or <tt>attribute</tt> name
+    # is required, else override +normalize_value+, makes life much simpler :)
+    #
+    # Default behaviour just calls <tt>normalize_value(value)</tt>.
+    def normalize(object, attribute, value); normalize_value(value) end
+    
+    # Override this method in subclasses to specifiy custom normalization steps and magic.
+    #
+    # The standard implementation strips the value of trailing/leading whitespace and then
+    # either returns that value or +nil+ if it's <tt>empty?</tt>.    
+    def normalize_value(value)
+      value = value.strip if value.respond_to?(:strip)
+      value.nil? || (value.respond_to?(:empty?) && value.empty?) ? nil : value
+    end
+  end  
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require 'vacuum_cleaner'
+
+ActiveRecord::Base.class_eval { include VacuumCleaner::Normalizations } # all versions of rails
+ActiveModel::Base.class_eval { include VacuumCleaner::Normalizations } if defined?(ActiveModel::Base) # Rails 3+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rr'
+
+# require 'normalo'
+
+Test::Unit::TestCase.send(:include, RR::Adapters::TestUnit)
+
+# Dir[File.dirname(__FILE__) + "/fixtures/*.rb"].each { |fixture| require fixture }

data/test/unit/vacuum_cleaner/normalizations/method_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'vacuum_cleaner/normalizer'
+require 'vacuum_cleaner/normalizations/method'
+
+class VacuumCleaner::Normalizations::MethodTest < Test::Unit::TestCase
+  include VacuumCleaner::Normalizations
+  
+  context "MethodNormalizer" do
+    should "accept method name as initialization argument" do
+      downcaser = MethodNormalizer.new(:downcase)
+      assert_equal "elliot\n", downcaser.normalize_value("Elliot\n")
+      assert_equal "  \t", downcaser.normalize_value("  \t")
+    end
+    
+    should "accept hash with :method key as initializer" do
+      upcaser = MethodNormalizer.new(:method => :upcase)
+      assert_equal "ELLIOT\n", upcaser.normalize_value("Elliot\n")
+      assert_equal "  \t", upcaser.normalize_value("  \t")      
+    end
+  end
+    
+  context "DowncaseNormalizer#normalize_value" do
+    should "downcase input" do
+      assert_equal "elliot", DowncaseNormalizer.new.normalize_value("Elliot")
+    end
+  end
+  
+  context "UpcaseNormalizer#normalize_value" do
+    should "upcase input" do
+      assert_equal "J.D.", UpcaseNormalizer.new.normalize_value("j.d.")
+    end
+  end
+end

data/test/unit/vacuum_cleaner/normalizations/url_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'vacuum_cleaner/normalizer'
+require 'vacuum_cleaner/normalizations/url'
+
+class VacuumCleaner::Normalizations::UrlTest < Test::Unit::TestCase
+  include VacuumCleaner::Normalizations
+  
+  #
+  #   normalizes :homepage, :url => true
+  #   normalizes :ftp, :url => "ftp://"
+  #   normalizes :uri, :url => { :scheme => "http://", :unless => %r{\A(https?://|ftp://|jabber:)} }
+  #
+  context "UrlNormalizer#normalize_value" do
+    should "ignore <nil>" do
+      assert_nil UrlNormalizer.new.normalize_value(nil)
+    end
+    
+    should "prefix string with 'http://' if string does not begin with it" do
+      assert_equal "http://google.com", UrlNormalizer.new.normalize_value("google.com")
+    end
+    
+    should "not prefix string with 'http://' if string already begins with http or https" do
+      assert_equal "http://google.com/", UrlNormalizer.new.normalize_value("http://google.com/")
+      assert_equal "https://docs.google.com/", UrlNormalizer.new.normalize_value("https://docs.google.com/")
+    end
+    
+    should "allow to specify custom scheme, like ftp://" do
+      assert_equal "ftp://ftp.sacred-heart.com", UrlNormalizer.new("ftp://").normalize_value("ftp.sacred-heart.com")
+      assert_equal "ftp://ftp.sacred-heart.com", UrlNormalizer.new("ftp://").normalize_value("ftp://ftp.sacred-heart.com")
+    end
+    
+    should "allow to specify :scheme and custom regex to exclude/allow certain protocols" do
+      n = UrlNormalizer.new(:scheme => "http://", :unless => %r{\A(https?://|ftp://|jabber:)})
+      assert_equal "http://google.com", n.normalize_value("google.com")
+      assert_equal "jabber:jd@sh.com", n.normalize_value("jabber:jd@sh.com")
+      assert_equal "https://docs.google.com", n.normalize_value("https://docs.google.com")
+    end
+  end
+end

data/test/unit/vacuum_cleaner/normalizations_test.rb

@@ -0,0 +1,192 @@
+require 'test_helper'
+
+require 'vacuum_cleaner/normalizer'
+require 'vacuum_cleaner/normalizations'
+
+class PrefixDoctorNormalizer < VacuumCleaner::Normalizer
+  def normalize_value(value)
+    "Dr. #{value}"
+  end
+end
+
+class Person
+  include VacuumCleaner::Normalizations
+  
+  attr_accessor :last_name, :first_name
+  
+  normalizes :last_name
+  normalizes :first_name
+end
+
+class Doctor
+  include VacuumCleaner::Normalizations
+  attr_accessor :name
+  
+  class GirlifyNormalizer < VacuumCleaner::Normalizer
+    def normalize_value(value)
+      value == "J.D." ? "Maria" : value
+    end
+  end          
+  
+  normalizes :name, :girlify => true          
+end
+
+class VacuumCleaner::NormalizationsTest < Test::Unit::TestCase
+  context "VacuumCleaner::Normalizations" do
+    context "ClassMethods#normalizes" do
+      should "throw ArgumentError if no attributes are passed in" do
+        assert_raise ArgumentError do
+          klass = Class.new do
+            include VacuumCleaner::Normalizations
+            normalizes
+          end
+        end
+      end
+      
+      should "take a symbol as argument" do
+        assert_respond_to Class.new { include VacuumCleaner::Normalizations; normalizes(:name) }, :normalizes
+      end
+
+      should "take multiple symbols as argument" do
+        klass = Class.new { include VacuumCleaner::Normalizations; normalizes(:name, :first_name) }
+        assert_respond_to klass, :normalizes
+        #assert_respond_to klass, :normalize_name
+        #assert_respond_to klass, :normalize_first_name
+      end
+
+      should "create a setter for supplied attribute" do
+        obj = Class.new { include VacuumCleaner::Normalizations; normalizes(:name) }.new
+        assert_respond_to obj, :name=
+      end
+
+      should "set the instance variable using the setter" do
+        obj = Class.new { include VacuumCleaner::Normalizations; normalizes(:name) }.new
+        obj.name = "J.D."
+        assert_equal "J.D.", obj.instance_variable_get(:@name)
+      end
+      
+      should "alias method to <attr>_without_normalization= if <attr>= already defined" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          def name=(name); @foo = name end
+          normalizes :name
+        end
+        obj = klass.new
+        obj.name = "Elliot Reid"
+        assert_respond_to obj, :name_without_normalization=
+        assert_equal "Elliot Reid", obj.instance_variable_get(:@foo)
+        assert_nil obj.instance_variable_get(:@name)
+      end
+
+      should "convert any blank input, like empty string, nil etc. to => <nil>" do
+        obj = Person.new
+        obj.first_name = " "
+        obj.last_name = ''
+        assert_nil obj.first_name
+        assert_nil obj.last_name
+      end
+      
+      should "strip leading and trailing white-space" do
+        obj = Person.new
+        obj.first_name = "\nElliot\t "
+        obj.last_name = nil
+        assert_nil obj.last_name
+        assert_equal "Elliot", obj.first_name
+      end
+
+      should "accept a block which overrides the default to_nil_if_empty strategy" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          attr_accessor :name
+          normalizes :name do |value|
+            value ? value.upcase : value
+          end
+        end
+        obj = klass.new
+        obj.name = "Turk"
+        assert_equal "TURK", obj.name
+      end
+      
+      should "accept custom options hash to define other normalizers to run" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          attr_accessor :email
+          normalizes :email, :downcase => true
+        end
+        obj = klass.new
+        obj.email = "\nJ.D.Dorian@Sacred-Heart.com "
+        assert_equal "j.d.dorian@sacred-heart.com", obj.email
+      end
+      
+      should "raise ArgumentError if invalid/unknown normalizer is called" do
+        assert_raise ArgumentError do
+          Class.new do
+            include VacuumCleaner::Normalizations
+            normalizes :foo, :invalid_unknown_normalizer => true
+          end
+        end
+      end
+      
+      should "ignore default split/empty? normalizer if :default => false" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          attr_accessor :name
+          normalizes :name, :default => false, :upcase => true
+        end
+        obj = klass.new
+        obj.name = "Dr. Dorian\n\t"
+        assert_equal "DR. DORIAN\n\t", obj.name
+      end
+      
+      should "be able to use normalizers from the global namespace" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          attr_accessor :name
+          normalizes :name, :prefix_doctor => true
+        end
+        obj = klass.new
+        obj.name = "Elliot Reid"
+        assert_equal "Dr. Elliot Reid", obj.name
+      end
+      
+      should "be able to use normalizers from within the class itself" do
+        obj = Doctor.new
+        obj.name = "Elliot Reid"
+        assert_equal "Elliot Reid", obj.name
+        obj = Doctor.new
+        obj.name = "J.D."
+        assert_equal "Maria", obj.name
+      end
+      
+      should "be able to combine normalizers and custom blocks" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          attr_accessor :name, :first_name
+          normalizes(:name, :first_name, :downcase => true) do |value|
+            value.nil? ? value : "#{value.to_s[0,1].upcase}#{value.to_s[1..-1]}"
+          end
+        end
+        
+        obj = klass.new
+        obj.name = "REID"
+        obj.first_name = "ELLIOT"
+        assert_equal "Reid", obj.name
+        assert_equal "Elliot", obj.first_name
+      end
+      
+      should "provide block with all values if asking for them!" do
+        klass = Class.new do
+          include VacuumCleaner::Normalizations
+          attr_accessor :name
+          normalizes(:name) do |object, attribute, value|
+            [object.object_id, attribute, value]
+          end
+        end
+        
+        obj = klass.new
+        obj.name = "Carla"
+        assert_equal [obj.object_id, :name, "Carla"], obj.name
+      end
+    end
+  end
+end

data/test/unit/vacuum_cleaner/normalizer_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'vacuum_cleaner/normalizer'
+
+class VacuumCleaner::NormalizerTest < Test::Unit::TestCase
+  context "VacuumCleaner::Normalizer" do
+    should "take an optional hash as argument during #initialize and expose that hash when calling #options" do
+      expected = { :doctor => "Dr. Dorian", :nurse => "Carla" }
+      normalizer = VacuumCleaner::Normalizer.new({ :doctor => "Dr. Dorian", :nurse => "Carla" })
+      assert_equal "Dr. Dorian", normalizer.options[:doctor]
+      assert_equal expected, normalizer.options
+    end
+    
+    context "#normalize_value" do
+      should "leave <nil>" do
+        assert_nil VacuumCleaner::Normalizer.new.normalize_value(nil)
+      end
+      
+      should "convert empty string to <nil>" do
+        assert_nil VacuumCleaner::Normalizer.new.normalize_value('')
+      end
+      
+      should "convert string with only space characters to <nil>" do
+        assert_nil VacuumCleaner::Normalizer.new.normalize_value(" ")
+        assert_nil VacuumCleaner::Normalizer.new.normalize_value(" \n\t ")        
+      end
+      
+      should "strip leading and trailing whitespace" do
+        assert_equal "Dr. Reid", VacuumCleaner::Normalizer.new.normalize_value(" \nDr. Reid\t ")
+        assert_equal "Dr. Dorian", VacuumCleaner::Normalizer.new.normalize_value("Dr. Dorian\t \r")
+      end
+    end
+    
+    context "#normalize" do
+      should "return always the same as #normalize_value and ignore object and attribute parameters" do
+        normalizer = VacuumCleaner::Normalizer.new
+        object = Object.new
+        attribute = :name
+        
+        [["Dr. Reid", "\t Dr. Reid"], ["Dr. Dorian", "Dr. Dorian\n "], [nil, nil], [nil, "\n "], [nil, ""]].each do |tests|
+          expected, value = *tests
+          assert_equal expected, normalizer.normalize_value(value)
+          assert_equal expected, normalizer.normalize(object, attribute, value)
+        end
+      end
+    end
+  end
+end

data/vacuum_cleaner.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vacuum_cleaner}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lukas Westermann"]
+  s.date = %q{2010-02-24}
+  s.description = %q{** Swoooosh ** - and all those leading and trailing whitespaces are gone, or ** Frooom ** - and the value
+      is normalized to always be prefixed by 'http://' and much more. Works with both plain old Ruby, and Rails (ActiveModel
+      and ActiveSupport).}
+  s.email = %q{lukas.westermann@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "init.rb",
+     "lib/vacuum_cleaner.rb",
+     "lib/vacuum_cleaner/normalizations.rb",
+     "lib/vacuum_cleaner/normalizations/method.rb",
+     "lib/vacuum_cleaner/normalizations/url.rb",
+     "lib/vacuum_cleaner/normalizer.rb",
+     "rails/init.rb",
+     "test/test_helper.rb",
+     "test/unit/vacuum_cleaner/normalizations/method_test.rb",
+     "test/unit/vacuum_cleaner/normalizations/url_test.rb",
+     "test/unit/vacuum_cleaner/normalizations_test.rb",
+     "test/unit/vacuum_cleaner/normalizer_test.rb",
+     "vacuum_cleaner.gemspec"
+  ]
+  s.homepage = %q{http://github.com/lwe/vacuum_cleaner}
+  s.licenses = ["LICENSE"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby (and Rails) attribute cleaning support, provides some nice default normalization strategies.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/unit/vacuum_cleaner/normalizations/method_test.rb",
+     "test/unit/vacuum_cleaner/normalizations/url_test.rb",
+     "test/unit/vacuum_cleaner/normalizations_test.rb",
+     "test/unit/vacuum_cleaner/normalizer_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_development_dependency(%q<rr>, [">= 0.10.5"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_dependency(%q<rr>, [">= 0.10.5"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    s.add_dependency(%q<rr>, [">= 0.10.5"])
+  end
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: vacuum_cleaner
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Lukas Westermann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 2
+        version: 2.10.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 5
+        version: 0.10.5
+  type: :development
+  version_requirements: *id002
+description: |-
+  ** Swoooosh ** - and all those leading and trailing whitespaces are gone, or ** Frooom ** - and the value
+        is normalized to always be prefixed by 'http://' and much more. Works with both plain old Ruby, and Rails (ActiveModel
+        and ActiveSupport).
+email: lukas.westermann@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/vacuum_cleaner.rb
+- lib/vacuum_cleaner/normalizations.rb
+- lib/vacuum_cleaner/normalizations/method.rb
+- lib/vacuum_cleaner/normalizations/url.rb
+- lib/vacuum_cleaner/normalizer.rb
+- rails/init.rb
+- test/test_helper.rb
+- test/unit/vacuum_cleaner/normalizations/method_test.rb
+- test/unit/vacuum_cleaner/normalizations/url_test.rb
+- test/unit/vacuum_cleaner/normalizations_test.rb
+- test/unit/vacuum_cleaner/normalizer_test.rb
+- vacuum_cleaner.gemspec
+has_rdoc: true
+homepage: http://github.com/lwe/vacuum_cleaner
+licenses: 
+- LICENSE
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby (and Rails) attribute cleaning support, provides some nice default normalization strategies.
+test_files: 
+- test/test_helper.rb
+- test/unit/vacuum_cleaner/normalizations/method_test.rb
+- test/unit/vacuum_cleaner/normalizations/url_test.rb
+- test/unit/vacuum_cleaner/normalizations_test.rb
+- test/unit/vacuum_cleaner/normalizer_test.rb