data_cleansing 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 720a83a0b486ac0d4ee6de7c7716de4d47ae6331
-  data.tar.gz: 5f2f86c19d4cfb896f124802bef947e6ebbaf1a7
+  metadata.gz: d330ec38e5e452e5a6278a9086d2fbd010240d12
+  data.tar.gz: 38dcd89391ba829b8d5b0d31fbf8f5b9c12ac6d0
 SHA512:
-  metadata.gz: 006f1106f3f67dad19c979d0384cb85f0c2bdbe8d3150d6c6ff13629b0c24fa1aaad70b0c9e66718d615dc63d5ca4202bf2125f8fd91a0190f4a1601a3a83a3e
-  data.tar.gz: 83a1ec0a5da0c2ec7d0a3475db95e5360613c53d36a4837b33385e1a8309e0cda894ede12d9dd8861c6d6db1ad80f683cdadff34191b99e87a299de897d6074b
+  metadata.gz: d7a6e0ff6067d55da2910f494a7f1f3b0688460e794daa9cf7b5e0fdd8e1233df0251573404af4178b4e6d1559cb61960a252a8fad4155a4d773e41090f34867
+  data.tar.gz: 29eb21b9b89ea762e405d80aefe947dc3c2066e563f3f07f2e491bee757cec5cdba5fa239741be8256ba701405278143c3811f61dd973503a0c7470bb547c0e5

data/README.md

@@ -52,7 +52,7 @@ or pull request.
 require 'data_cleansing'
 
 # Define a global cleaner
-DataCleansing.register_cleaner(:strip) {|string| string.strip!}
+DataCleansing.register_cleaner(:strip) {|string| string.strip}
 
 class User
   include DataCleansing::Cleanse
@@ -78,7 +78,7 @@ puts "After data cleansing #{u.inspect}"
 
 ```ruby
 # Define a global cleanser
-DataCleansing.register_cleaner(:strip) {|string| string.strip!}
+DataCleansing.register_cleaner(:strip) {|string| string.strip}
 
 # 'users' table has the following columns :first_name, :last_name, :address1, :address2
 class User < ActiveRecord::Base
@@ -88,7 +88,7 @@ class User < ActiveRecord::Base
   cleanse :first_name, :last_name, :cleaner => :strip
 
   # Define a once off cleaner
-  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip!}
+  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip}
 
   # Automatically cleanse data before validation
   before_validation :cleanse_attributes!
@@ -108,8 +108,8 @@ u.save!
 require 'data_cleansing'
 
 # Define a global cleaners
-DataCleansing.register_cleaner(:strip) {|string| string.strip!}
-DataCleansing.register_cleaner(:upcase) {|string| string.upcase!}
+DataCleansing.register_cleaner(:strip) {|string| string.strip}
+DataCleansing.register_cleaner(:upcase) {|string| string.upcase}
 
 class User
   include DataCleansing::Cleanse
@@ -120,7 +120,7 @@ class User
   cleanse :first_name, :last_name, :cleaner => :strip
 
   # Define a once off cleaner
-  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip!}
+  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip}
 
   # Use multiple cleaners, and a custom block
   cleanse :title, :cleaner => [:strip, :upcase, Proc.new {|string| "#{string}." unless string.end_with?('.')}]
@@ -175,7 +175,7 @@ module MyApplication
    config.data_cleansing.logger.level = :info
 
    # Register any global cleaners
-   config.data_cleansing.register_cleaner(:strip) {|string| string.strip!}
+   config.data_cleansing.register_cleaner(:strip) {|string| string.strip}
 
   end
 end

data/lib/data_cleansing/cleanse.rb

@@ -11,14 +11,32 @@ module DataCleansing
         params = (last.is_a?(Hash) && last.instance_of?(Hash)) ? attributes.pop.dup : {}
         cleaners = Array(params.delete(:cleaner))
         raise(ArgumentError, "Mandatory :cleaner parameter is missing: #{params.inspect}") unless cleaners
+
         cleaner = DataCleansingCleaner.new(cleaners, attributes, params)
         data_cleansing_cleaners << cleaner
+
+        # Create shortcuts to cleaners for each attribute for use by .cleanse_attribute
         attributes.each do |attr|
           (data_cleansing_attribute_cleaners[attr] ||= ThreadSafe::Array.new) << cleaner
         end
         cleaner
       end
 
+      # Add one or more methods on this object to be called after cleansing is complete
+      # on an object
+      # After cleansers are executed when #cleanse_attributes! is called, but after
+      # all other defined cleansers have been executed.
+      # They are _not_ called when .cleanse_attribute is called
+      #
+      # After cleaners should be used when based on the value of one attribute,
+      # one or more of the other attributes need to be modified
+      def after_cleanse(*methods)
+        methods.each do |m|
+          raise "Method #{m.inspect} must be a symbol" unless m.is_a?(Symbol)
+          data_cleansing_after_cleaners << m unless data_cleansing_after_cleaners.include?(m)
+        end
+      end
+
       # Returns the value cleansed using the cleaners defined for that attribute
       # in this model and any of it's parents
       #
@@ -57,6 +75,11 @@ module DataCleansing
         @data_cleansing_cleaners ||= ThreadSafe::Array.new
       end
 
+      # Array of cleaners to execute against this model and it's children
+      def data_cleansing_after_cleaners
+        @data_cleansing_after_cleaners ||= ThreadSafe::Array.new
+      end
+
       # Hash of attributes to clean with their corresponding cleaner
       def data_cleansing_attribute_cleaners
         @data_cleansing_attribute_cleaners ||= ThreadSafe::Hash.new
@@ -96,15 +119,21 @@ module DataCleansing
 
     module InstanceMethods
       # Cleanse the attributes using specified cleaners
+      # and execute after cleaners once complete
       def cleanse_attributes!
         # Collect parent cleaners first, starting with the top parent
         cleaners = [self.class.send(:data_cleansing_cleaners)]
+        after_cleaners = [self.class.send(:data_cleansing_after_cleaners)]
         klass = self.class.superclass
         while klass != Object
           cleaners << klass.send(:data_cleansing_cleaners) if klass.respond_to?(:data_cleansing_cleaners)
+          after_cleaners << klass.send(:data_cleansing_after_cleaners) if klass.respond_to?(:data_cleansing_after_cleaners)
           klass = klass.superclass
         end
         cleaners.reverse_each {|cleaner| data_cleansing_execute_cleaners(cleaner)}
+
+        # Execute the after cleaners, starting with the parent after cleanse methods
+        after_cleaners.reverse_each {|a| a.each {|method| send(method)} }
         true
       end
 

data/lib/data_cleansing/railtie.rb

@@ -4,15 +4,11 @@ module RubySkynet #:nodoc:
     # Exposes DataCleansing configuration to the Rails application configuration.
     #
     # @example Set up configuration in the Rails app.
-    #   module MyApplication
-    #     class Application < Rails::Application
+    #    module MyApplication
+    #      class Application < Rails::Application
     #
     #       # Data Cleansing Configuration
     #
-    #       # By default logging is enabled of data cleansing actions
-    #       # Set to false to disable
-    #       config.data_cleansing.logging_enabled = true
-    #
     #       # Attributes who's values are to be masked out during logging
     #       config.data_cleansing.register_masked_attributes :bank_account_number, :social_security_number
     #
@@ -23,10 +19,10 @@ module RubySkynet #:nodoc:
     #       config.data_cleansing.logger.level = :info
     #
     #       # Register any global cleaners
-    #       config.data_cleansing.register_cleaner(:strip) {|string| string.strip!}
+    #       config.data_cleansing.register_cleaner(:strip) {|string| string.strip}
     #
-    #     end
-    #   end
+    #      end
+    #    end
     config.data_cleansing = ::DataCleansing
   end
 end

data/lib/data_cleansing/version.rb

@@ -1,3 +1,3 @@
 module DataCleansing
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/test/active_record_test.rb

@@ -37,7 +37,7 @@ ActiveRecord::Schema.define :version => 0 do
 end
 
 # Define a global cleaner
-DataCleansing.register_cleaner(:strip) {|string, params, object| string.strip!}
+DataCleansing.register_cleaner(:strip) {|string| string.strip}
 
 # Log data cleansing result
 # Set to :warn or higher to disable
@@ -70,7 +70,7 @@ class User < ActiveRecord::Base
   cleanse :first_name, :last_name, :cleaner => :strip
 
   # Define a once off cleaner
-  cleanse :address1, :address2, :instance_var, :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

data/test/ruby_test.rb

@@ -7,7 +7,7 @@ require 'shoulda'
 require 'data_cleansing'
 
 # Define a global cleanser
-DataCleansing.register_cleaner(:strip) {|string, params, object| string.strip!}
+DataCleansing.register_cleaner(:strip) {|string| string.strip}
 
 # Non Cleansing base class
 class RubyUserBase
@@ -23,7 +23,19 @@ class RubyUser < RubyUserBase
   cleanse :first_name, :last_name, :cleaner => :strip
 
   # Define a once off cleaner
-  cleanse :address1, :address2, :cleaner => Proc.new {|string| "<< #{string.strip!} >>"}
+  cleanse :address1, :address2, :cleaner => Proc.new {|string| "<< #{string.strip} >>"}
+
+  # Execute after cleanser
+  after_cleanse :name_check
+
+  # Called once cleaning has been completed
+  def name_check
+    # If first_name has a value, but last_name does not
+    if last_name.nil? || (last_name.length == 0)
+      self.last_name = first_name
+      self.first_name = nil
+    end
+  end
 end
 
 class RubyUserChild < RubyUser
@@ -32,7 +44,7 @@ class RubyUserChild < RubyUser
 end
 
 # Another global cleaner, used by RubyUser2
-DataCleansing.register_cleaner(:upcase) {|string| string.upcase!}
+DataCleansing.register_cleaner(:upcase) {|string| string.upcase}
 
 class RubyUser2
   include DataCleansing::Cleanse
@@ -43,7 +55,7 @@ class RubyUser2
   cleanse :first_name, :last_name, :cleaner => :strip
 
   # Define a once off cleaner
-  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip!}
+  cleanse :address1, :address2, :cleaner => Proc.new {|string| string.strip}
 
   # Use multiple cleaners, and a custom block
   cleanse :title, :cleaner => [:strip, :upcase, Proc.new {|string| "#{string}." unless string.end_with?('.')}]
@@ -101,6 +113,14 @@ class RubyTest < Test::Unit::TestCase
         @user.cleanse_attributes!
         assert_equal nil, @user.first_name
       end
+
+      should 'cleanse_attributes! call after cleaner' do
+        @user.first_name = 'Jack'
+        @user.last_name = nil
+        @user.cleanse_attributes!
+        assert_equal nil, @user.first_name, @user.inspect
+        assert_equal 'Jack', @user.last_name, @user.inspect
+      end
     end
 
     context "with ruby user child" do

metadata

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