data_cleansing 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f07805d14a1985523defc78b1dead46165975d7e
-  data.tar.gz: 6d64e90d76621a9656a40610fcb5e9373062eb25
+  metadata.gz: 64293789c3bf568975be9ed1c8c05c8536c23144
+  data.tar.gz: dc47cfa960847eaf926eb7f9695c92750d05c515
 SHA512:
-  metadata.gz: f51316bdd3a17e6be5dcebb973883b826dfa38d3956a345a455f9d795cd7859a9f9818386846dc6dd326eed96036b4aec907529911ce4c1903b1415aab40820f
-  data.tar.gz: b33a0fc76fa07efc63fcc74d343ae123fc2b9b7572492e9d1387bff0da4ba1490ab82f066537e50366dcb2f57e74779ca71c24d5c3519383a986faa95c25cc2e
+  metadata.gz: e7f84d6c1858468a1bcd916f98cf14b20869c3a50bf556001192eb6f166b97c4489d5a20b062604afeb3cc309eb709423e3401f50bf77f7f9980decd2c931688
+  data.tar.gz: 6ce9b1ea07813cca4ee601c63dadab67c57c2d0e4e729f1a9b10175312be92c218d727ceca84060169215a24fd6e3d676cade7cc5a57de2918be81b7fe81ae90

data/README.md

@@ -1,7 +1,7 @@
 data_cleansing
 ==============
 
-Data Cleansing solution for Ruby with additional support for Rails and Mongoid
+Data Cleansing framework for Ruby with additional support for Rails and Mongoid
 
 * http://github.com/reidmorrison/data_cleansing
 
@@ -27,7 +27,7 @@ or pull request.
 
 ## Examples
 
-### Simple Example
+### Ruby Example
 ```ruby
 require 'data_cleansing'
 
@@ -54,7 +54,35 @@ puts "After data cleansing #{u.inspect}"
 # After data cleansing After data cleansing #<User:0x007fc9f1081980 @first_name="joe", @last_name="black">
 ```
 
-### Ruby Example
+### Rails Example
+
+```ruby
+# Define a global cleanser
+DataCleansing.register_cleaner(:strip) {|string| string.strip!}
+
+# 'users' table has the following columns :first_name, :last_name, :address1, :address2
+class User < ActiveRecord::Base
+  include DataCleansing::Cleanse
+
+  # Use a global cleaner
+  cleanse :first_name, :last_name, :cleaner => :strip
+
+  # Define a once off cleaner
+  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip!}
+
+  # Automatically cleanse data before validation
+  before_validation :cleanse_attributes!
+end
+
+# Create a User instance
+u = User.new(:first_name => '    joe   ', :last_name => "\n  black\n", :address1 => "2632 Brown St   \n")
+puts "Before data cleansing #{u.attributes.inspect}"
+u.validate
+puts "After data cleansing #{u.attributes.inspect}"
+u.save!
+```
+
+### Advanced Ruby Example
 
 ```ruby
 require 'data_cleansing'
@@ -106,34 +134,6 @@ puts "After data cleansing #{u.inspect}"
 # After data cleansing #<User:0x007fdd5a83a8f8 @first_name="joe", @last_name="black", @address1="2632 Brown St", @title="MR.", @gender="Male">
 ```
 
-### Rails Example
-
-```ruby
-# Define a global cleanser
-DataCleansing.register_cleaner(:strip) {|string| string.strip!}
-
-# 'users' table has the following columns :first_name, :last_name, :address1, :address2
-class User < ActiveRecord::Base
-  include DataCleansing::Cleanse
-
-  # Use a global cleaner
-  cleanse :first_name, :last_name, :cleaner => :strip
-
-  # Define a once off cleaner
-  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip!}
-
-  # Automatically cleanse data before validation
-  before_validation :cleanse_attributes!
-end
-
-# Create a User instance
-u = User.new(:first_name => '    joe   ', :last_name => "\n  black\n", :address1 => "2632 Brown St   \n")
-puts "Before data cleansing #{u.attributes.inspect}"
-u.validate
-puts "After data cleansing #{u.attributes.inspect}"
-u.save!
-```
-
 ## Notes
 
 Cleaners are called in the order in which they are defined, so subsequent cleaners
@@ -172,8 +172,15 @@ For example, in Rails it obtains the raw data value before Rails has converted i
 Which is useful for cleansing integer or float fields as raw strings before Rails
 tries to convert it to an integer or float.
 
-Meta
-----
+## Dependencies
+
+DataCleansing requires the following dependencies
+
+* Ruby V1.8.7, V1.9.3 or V2 and greater
+* Rails V2 or greater for Rails integration ( Only if Rails is being used )
+* Mongoid V2 or greater for Rails integration ( Only if Mongoid is being used )
+
+## Meta
 
 * Code: `git clone git://github.com/reidmorrison/data_cleansing.git`
 * Home: <https://github.com/reidmorrison/data_cleansing>
@@ -182,15 +189,13 @@ Meta
 
 This project uses [Semantic Versioning](http://semver.org/).
 
-Authors
--------
+## Authors
 
 Reid Morrison :: reidmo@gmail.com :: @reidmorrison
 
-License
--------
+## License
 
-Copyright 2013 Reid Morrison, Clarity Services, Inc.
+Copyright 2013 Reid Morrison
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/data_cleansing/cleanse.rb

@@ -23,16 +23,14 @@ module DataCleansing
       # Cleanse the attributes using specified cleaners
       def cleanse_attributes!
         self.class.cleaners.each do |cleaner_struct|
-          params  = cleaner_struct.params
-          attrs = cleaner_struct.attributes
+          params = cleaner_struct.params
+          attrs  = cleaner_struct.attributes
 
           # Special case to include :all fields
           # Only works with ActiveRecord based models, not supported with regular Ruby models
           if attrs.include?(:all) && defined?(ActiveRecord) && respond_to?(:attributes)
             attrs = attributes.keys.collect{|i| i.to_sym}
-            if except = params.delete(:except)
-              attrs -= except
-            end
+            attrs.delete(:id)
 
             # Remove serialized_attributes if any, from the :all condition
             if self.class.respond_to?(:serialized_attributes)
@@ -49,12 +47,18 @@ module DataCleansing
                 end
               end
             end
+
+            # Explicitly remove specified attributes from cleansing
+            if except = params[:except]
+              attrs -= except
+            end
+
           end
 
           attrs.each do |attr|
             # Under ActiveModel for Rails and Mongoid need to retrieve raw value
             # before data type conversion
-            value = if respond_to?(:read_attribute_before_type_cast)
+            value = if respond_to?(:read_attribute_before_type_cast) && has_attribute?(attr.to_s)
               read_attribute_before_type_cast(attr.to_s)
             else
               send(attr.to_sym)

data/lib/data_cleansing/version.rb

@@ -1,3 +1,3 @@
 module DataCleansing
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/active_record_test.rb

@@ -50,11 +50,14 @@ end
 class User < ActiveRecord::Base
   include DataCleansing::Cleanse
 
+  # Also cleanse non-database backed fields
+  attr_accessor :instance_var
+
   # Use a global cleaner
   cleanse :first_name, :last_name, :cleaner => :strip
 
   # Define a once off cleaner
-  cleanse :address1, :address2, :cleaner => Proc.new {|string| "<< #{string.strip!} >>"}
+  cleanse :address1, :address2, :instance_var, :cleaner => Proc.new {|string| "<< #{string.strip!} >>"}
 
   # Custom Zip Code cleaner
   cleanse :zip_code, :cleaner => :digits_to_integer
@@ -69,7 +72,7 @@ class User2 < ActiveRecord::Base
   self.table_name = 'users'
 
   # Test :all cleaner. Only works with ActiveRecord Models
-  cleanse :all, :cleaner => :strip
+  cleanse :all, :cleaner => [:strip, Proc.new{|s| "@#{s}@"}], :except => [:address1, :zip_code]
 
   # Automatically cleanse data before validation
   before_validation :cleanse_attributes!
@@ -88,10 +91,15 @@ class ActiveRecordTest < Test::Unit::TestCase
           :first_name => '    joe   ',
           :last_name  => "\n  black\n",
           :address1   => "2632 Brown St   \n",
-          :zip_code   => "\n\tblah 12345badtext\n"
+          :zip_code   => "\n\tblah 12345badtext\n",
+          :instance_var => "\n    instance\n\t      "
         )
       end
 
+      should 'only have 3 cleaners' do
+        assert_equal 3, User.cleaners.size, User.cleaners
+      end
+
       should 'cleanse_attributes! using global cleaner' do
         assert_equal true, @user.valid?
         assert_equal 'joe', @user.first_name
@@ -101,6 +109,7 @@ class ActiveRecordTest < Test::Unit::TestCase
       should 'cleanse_attributes! using attribute specific custom cleaner' do
         assert_equal true, @user.valid?
         assert_equal '<< 2632 Brown St >>', @user.address1
+        assert_equal '<< instance >>', @user.instance_var
       end
 
       should 'cleanse_attributes! using global cleaner using rails extensions' do
@@ -119,12 +128,16 @@ class ActiveRecordTest < Test::Unit::TestCase
         )
       end
 
+      should 'only have 1 cleaner' do
+        assert_equal 1, User2.cleaners.size, User2.cleaners
+      end
+
       should 'cleanse_attributes! clean all attributes' do
         assert_equal true, @user.valid?
-        assert_equal 'joe', @user.first_name, User2.cleaners
-        assert_equal 'black', @user.last_name
-        assert_equal '2632 Brown St', @user.address1
-        assert_equal 12345, @user.zip_code
+        assert_equal '@joe@', @user.first_name, User2.cleaners
+        assert_equal '@black@', @user.last_name
+        assert_equal "2632 Brown St   \n", @user.address1
+        assert_equal 12345, @user.zip_code, User2.cleaners
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_cleansing
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe