data_cleansing 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce7b23f60579cdfba99620dbe8d73e42c6963216126b3e9a3db9985eb423bd25
-  data.tar.gz: dbf234f058f1d401fd81eb4f6863401f1daa2293ba57a072719aca008b3b621c
+  metadata.gz: 04a8c565168dcba73088d9e17afcda3ab49097a41fb55bcf880f2cd04e6d38bf
+  data.tar.gz: da24439e8431d81c19241b7ed579bd73170cfc8e61c1781bc103befa1e37d6fe
 SHA512:
-  metadata.gz: a128353735b0e598532a1092018b0029f0390af20e6c37a10aa6c46fd472f6c4621e0e9d034e6f7b683cbba23d2741e877c9d0e11919d92b08b9c5900e50c7b3
-  data.tar.gz: f47693cf8b140a9fb4b8b20bd4c8df026a8237b6b6747a3d83d210b834be89d73713465684e66f6533a6cc5971cf4b9bf2dd61b1a5b620fb1bcd79c2f02c2a1c
+  metadata.gz: 28d9b9af8b18271bcbedd3930b0c1882ee162470959992ab2140f4a733377aaffadb0efef52d66ffeb86a93b1c10cdbcc78d61382d09fd85f8135596bd845628
+  data.tar.gz: f49c9062ffa4620c723cdb1d114f3baf649b63cb273dc67cadb34212cdf1d42c54a1ad4be90cff38e02f565c2135d18c3d58ccd0e90c3031e65dfe3fbef0e01c

data/Rakefile

@@ -1,21 +1,31 @@
-require 'rake/testtask'
-require_relative 'lib/data_cleansing/version'
+# Setup bundler to avoid having to run bundle exec all the time.
+require "rubygems"
+require "bundler/setup"
+
+require "rake/testtask"
+require_relative "lib/data_cleansing/version"
 
 task :gem do
-  system 'gem build data_cleansing.gemspec'
+  system "gem build data_cleansing.gemspec"
 end
 
 task publish: :gem do
   system "git tag -a v#{DataCleansing::VERSION} -m 'Tagging #{DataCleansing::VERSION}'"
-  system 'git push --tags'
+  system "git push --tags"
   system "gem push data_cleansing-#{DataCleansing::VERSION}.gem"
   system "rm data_cleansing-#{DataCleansing::VERSION}.gem"
 end
 
 Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
+  t.pattern = "test/**/*_test.rb"
   t.verbose = true
-  t.warning = true
+  t.warning = false
 end
 
-task default: :test
+# By default run tests against all appraisals
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  require "appraisal"
+  task default: :appraisal
+else
+  task default: :test
+end

data/lib/data_cleansing/cleaners.rb

@@ -1,4 +1,4 @@
-require 'cgi'
+require "cgi"
 module Cleaners
   # Strip leading and trailing whitespace
   module Strip
@@ -37,7 +37,7 @@ module Cleaners
     def self.call(string)
       return string unless string.is_a?(String)
 
-      string.gsub!(NOT_WORDS, '') || string
+      string.gsub!(NOT_WORDS, "") || string
     end
   end
   DataCleansing.register_cleaner(:remove_non_word, RemoveNonWord)
@@ -49,6 +49,10 @@ module Cleaners
     def self.call(string)
       return string unless string.is_a?(String)
 
+      # Strip invalid characters, since they are non printable
+      unless string.valid_encoding?
+        string = string.encode(string.encoding, invalid: :replace, undef: :replace, replace: "")
+      end
       string.gsub!(NOT_PRINTABLE, '') || string
     end
   end
@@ -63,18 +67,18 @@ module Cleaners
 
       string.gsub!(HTML_MARKUP) do |match|
         case match.downcase
-        when '&' then
-          '&'
-        when '"' then
+        when "&"
+          "&"
+        when """
           '"'
-        when '>' then
-          '>'
-        when '<' then
-          '<'
-        when '&apos;' then
+        when "&gt;"
+          ">"
+        when "&lt;"
+          "<"
+        when "&apos;"
           "'"
-        when '&nbsp;' then
-          ' '
+        when "&nbsp;"
+          " "
         else
           "&#{match};"
         end
@@ -108,7 +112,7 @@ module Cleaners
     def self.call(string)
       return string unless string.is_a?(String)
 
-      string.gsub!(WHITESPACE, ' ') || string
+      string.gsub!(WHITESPACE, " ") || string
     end
   end
   DataCleansing.register_cleaner(:compress_whitespace, CompressWhitespace)
@@ -121,7 +125,7 @@ module Cleaners
     def self.call(string)
       return string unless string.is_a?(String)
 
-      string.gsub!(DIGITS, '')
+      string.gsub!(DIGITS, "")
       string.length > 0 ? string : nil
     end
   end
@@ -130,13 +134,13 @@ module Cleaners
   # Returns [Integer] after removing all non-digit characters, except '.'
   # Returns nil if no digits are present in the string.
   module StringToInteger
-    NUMERIC = Regexp.compile(/[^0-9\.]/)
+    NUMERIC = Regexp.compile(/[^0-9.]/)
 
     def self.call(string)
       return string unless string.is_a?(String)
 
       # Remove Non-Digit Chars, except for '.'
-      string.gsub!(NUMERIC, '')
+      string.gsub!(NUMERIC, "")
       string.length > 0 ? string.to_i : nil
     end
   end
@@ -145,13 +149,13 @@ module Cleaners
   # Returns [Integer] after removing all non-digit characters, except '.'
   # Returns nil if no digits are present in the string.
   module StringToFloat
-    NUMERIC = Regexp.compile(/[^0-9\.]/)
+    NUMERIC = Regexp.compile(/[^0-9.]/)
 
     def self.call(string)
       return string unless string.is_a?(String)
 
       # Remove Non-Digit Chars, except for '.'
-      string.gsub!(NUMERIC, '')
+      string.gsub!(NUMERIC, "")
       string.length > 0 ? string.to_f : nil
     end
   end

data/lib/data_cleansing/cleanse.rb

@@ -1,4 +1,4 @@
-require 'data_cleansing/cleaners'
+require "data_cleansing/cleaners"
 module DataCleansing
   # Mix-in to add cleaner
   module Cleanse
@@ -9,7 +9,7 @@ module DataCleansing
       def cleanse(*args)
         last       = args.last
         attributes = args.dup
-        params     = (last.is_a?(Hash) && last.instance_of?(Hash)) ? attributes.pop.dup : {}
+        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
 
@@ -34,6 +34,7 @@ module DataCleansing
       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
@@ -53,7 +54,7 @@ module DataCleansing
       #
       # Warning: If any of the cleaners read or write to other object attributes
       #          then a valid object instance must be supplied
-      def cleanse_attribute(attribute_name, value, object=nil)
+      def cleanse_attribute(attribute_name, value, object = nil)
         return if value.nil?
 
         # Collect parent cleaners first, starting with the top parent
@@ -100,6 +101,7 @@ module DataCleansing
       # itself is not modified
       def data_cleansing_clean(cleaner_struct, value, binding = nil)
         return if cleaner_struct.nil? || value.nil?
+
         # Duplicate value in case cleaner uses methods such as gsub!
         new_value = value.is_a?(String) ? value.dup : value
         cleaner_struct.cleaners.each do |name|
@@ -107,7 +109,6 @@ module DataCleansing
         end
         new_value
       end
-
     end
 
     module InstanceMethods
@@ -118,9 +119,9 @@ module DataCleansing
       #
       # Note: At this time the changes returned does not include any fields
       #       modified in any of the after_cleaner methods
-      def cleanse_attributes!(verbose=DataCleansing.logger.debug?)
+      def cleanse_attributes!(verbose = DataCleansing.logger.debug?)
         changes = {}
-        DataCleansing.logger.benchmark_info("#{self.class.name}#cleanse_attributes!", :payload => changes) do
+        DataCleansing.logger.benchmark_info("#{self.class.name}#cleanse_attributes!", payload: changes) do
           # 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)]
@@ -194,36 +195,33 @@ module DataCleansing
               end
 
             # No need to clean if attribute is nil
-            unless value.nil?
-              new_value = self.class.send(:data_cleansing_clean, cleaner_struct, value, self)
-
-              if new_value != value
-                # Update value only if it has changed
-                send("#{attr.to_sym}=".to_sym, new_value)
-
-                # Capture changed attributes
-                if changes
-                  # Mask sensitive attributes when logging
-                  masked    = DataCleansing.masked_attributes.include?(attr.to_sym)
-                  new_value = :masked if masked && !new_value.nil?
-                  if previous = changes[attr.to_sym]
-                    previous[:after] = new_value
-                  else
-                    if new_value.nil? || verbose
-                      changes[attr.to_sym] = {
-                        :before => masked ? :masked : value,
-                        :after  => new_value
-                      }
-                    end
-                  end
-                end
-              end
+            next if value.nil?
+
+            new_value = self.class.send(:data_cleansing_clean, cleaner_struct, value, self)
+
+            next unless new_value != value
+
+            # Update value only if it has changed
+            send("#{attr.to_sym}=".to_sym, new_value)
+
+            # Capture changed attributes
+            next unless changes
+
+            # Mask sensitive attributes when logging
+            masked    = DataCleansing.masked_attributes.include?(attr.to_sym)
+            new_value = :masked if masked && !new_value.nil?
+            if previous = changes[attr.to_sym]
+              previous[:after] = new_value
+            elsif new_value.nil? || verbose
+              changes[attr.to_sym] = {
+                before: masked ? :masked : value,
+                after:  new_value
+              }
             end
           end
         end
         changes
       end
-
     end
 
     def self.included(base)
@@ -233,5 +231,4 @@ module DataCleansing
       end
     end
   end
-
 end

data/lib/data_cleansing/data_cleansing.rb

@@ -9,6 +9,7 @@ module DataCleansing
   # Replaces any existing cleaner with the same name
   def self.register_cleaner(name, cleaner = nil, &block)
     raise "Must supply a Proc with the cleaner" unless block || cleaner
+
     @@global_cleaners[name.to_sym] = cleaner || block
   end
 
@@ -19,7 +20,7 @@ module DataCleansing
 
   # Register Attributes to be masked out in any log output
   def self.register_masked_attributes(*attributes)
-    attributes.each {|attr| @@masked_attributes << attr.to_sym }
+    attributes.each { |attr| @@masked_attributes << attr.to_sym }
   end
 
   # Returns the Global list of attributes to mask in any log output
@@ -44,5 +45,4 @@ module DataCleansing
       (proc.method(:call).arity == 1 ? proc.call(value) : proc.call(value, params))
     end
   end
-
 end

data/lib/data_cleansing/railtie.rb

@@ -1,6 +1,5 @@
 module RubySkynet #:nodoc:
   class Railtie < Rails::Railtie #:nodoc:
-
     # Exposes DataCleansing configuration to the Rails application configuration.
     #
     # @example Set up configuration in the Rails app.

data/lib/data_cleansing/version.rb

@@ -1,3 +1,3 @@
 module DataCleansing
-  VERSION = '1.0.2'
+  VERSION = "1.0.3"
 end

data/lib/data_cleansing.rb

@@ -1,13 +1,11 @@
-require 'concurrent'
-require 'semantic_logger'
-require 'data_cleansing/version'
-require 'data_cleansing/data_cleansing'
+require "concurrent"
+require "semantic_logger"
+require "data_cleansing/version"
+require "data_cleansing/data_cleansing"
 
 module DataCleansing
-  autoload :Cleanse, 'data_cleansing/cleanse'
+  autoload :Cleanse, "data_cleansing/cleanse"
 end
 
 # Rails Extensions
-if defined?(Rails)
-  require 'data_cleansing/railtie'
-end
+require "data_cleansing/railtie" if defined?(Rails)

data/test/active_record_test.rb

@@ -1,19 +1,19 @@
-require_relative 'test_helper'
-require 'active_record'
+require_relative "test_helper"
+require "active_record"
 
 ActiveRecord::Base.logger = SemanticLogger[ActiveRecord::Base]
 ActiveRecord::Base.configurations = {
-  'test' => {
-    'adapter'  => 'sqlite3',
-    'database' => 'test/test_db.sqlite3',
-    'pool'     => 5,
-    'timeout'  => 5000
+  "test" => {
+    "adapter"  => "sqlite3",
+    "database" => "test/test_db.sqlite3",
+    "pool"     => 5,
+    "timeout"  => 5000
   }
 }
 ActiveRecord::Base.establish_connection(:test)
 
-ActiveRecord::Schema.define :version => 0 do
-  create_table :users, :force => true do |t|
+ActiveRecord::Schema.define version: 0 do
+  create_table :users, force: true do |t|
     t.string  :first_name
     t.string  :last_name
     t.string  :address1
@@ -38,13 +38,13 @@ class User < ActiveRecord::Base
   attr_accessor :instance_var
 
   # Use a global cleaner
-  cleanse :first_name, :last_name, :cleaner => :strip
+  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 { |string| "<< #{string.strip} >>" }
 
   # Custom Zip Code cleaner
-  cleanse :zip_code, :cleaner => :string_to_integer
+  cleanse :zip_code, cleaner: :string_to_integer
 
   # Automatically cleanse data before validation
   before_validation :cleanse_attributes!
@@ -53,107 +53,104 @@ end
 class User2 < ActiveRecord::Base
   include DataCleansing::Cleanse
   # Use the same table as User above
-  self.table_name = 'users'
+  self.table_name = "users"
 
   serialize :text
 
   # Test :all cleaner. Only works with ActiveRecord Models
   # Must explicitly excelude :text since it is serialized
-  cleanse :all, :cleaner => [:strip, Proc.new{|s| "@#{s}@"}], :except => [:address1, :zip_code, :text]
+  cleanse :all, cleaner: [:strip, proc { |s| "@#{s}@" }], except: %i[address1 zip_code text]
 
   # Clean :first_name multiple times
-  cleanse :first_name, :cleaner => Proc.new {|string| "<< #{string} >>"}
+  cleanse :first_name, cleaner: proc { |string| "<< #{string} >>" }
 
   # Clean :first_name multiple times
-  cleanse :first_name, :cleaner => Proc.new {|string| "$#{string}$"}
+  cleanse :first_name, cleaner: proc { |string| "$#{string}$" }
 
   # Custom Zip Code cleaner
-  cleanse :zip_code, :cleaner => :string_to_integer
+  cleanse :zip_code, cleaner: :string_to_integer
 
   # Automatically cleanse data before validation
   before_validation :cleanse_attributes!
 end
 
 class ActiveRecordTest < Minitest::Test
-  describe 'ActiveRecord Models' do
-
-    it 'have globally registered cleaner' do
+  describe "ActiveRecord Models" do
+    it "have globally registered cleaner" do
       assert DataCleansing.cleaner(:strip)
     end
 
-    it 'Model.cleanse_attribute' do
-      assert_equal 'joe',                 User.cleanse_attribute(:first_name,   '    joe   ')
-      assert_equal 'black',               User.cleanse_attribute(:last_name,    "\n  black\n")
-      assert_equal '<< 2632 Brown St >>', User.cleanse_attribute(:address1,     "2632 Brown St   \n")
-      assert_equal '<< instance >>',      User.cleanse_attribute(:instance_var, "\n    instance\n\t      ")
-      assert_equal 12345,                 User.cleanse_attribute(:zip_code,     "\n\tblah 12345badtext\n")
+    it "Model.cleanse_attribute" do
+      assert_equal "joe",                 User.cleanse_attribute(:first_name,   "    joe   ")
+      assert_equal "black",               User.cleanse_attribute(:last_name,    "\n  black\n")
+      assert_equal "<< 2632 Brown St >>", User.cleanse_attribute(:address1,     "2632 Brown St   \n")
+      assert_equal "<< instance >>",      User.cleanse_attribute(:instance_var, "\n    instance\n\t      ")
+      assert_equal 12_345, User.cleanse_attribute(:zip_code, "\n\tblah 12345badtext\n")
     end
 
     describe "with user" do
       before do
         @user = User.new(
-          :first_name   => '    joe   ',
-          :last_name    => "\n  black\n",
-          :address1     => "2632 Brown St   \n",
-          :zip_code     => "\n\tblah 12345badtext\n",
-          :instance_var => "\n    instance\n\t      "
+          first_name:   "    joe   ",
+          last_name:    "\n  black\n",
+          address1:     "2632 Brown St   \n",
+          zip_code:     "\n\tblah 12345badtext\n",
+          instance_var: "\n    instance\n\t      "
         )
       end
 
-      it 'only have 3 cleaners' do
+      it "only have 3 cleaners" do
         assert_equal 3, User.send(:data_cleansing_cleaners).size, User.send(:data_cleansing_cleaners)
       end
 
-      it 'cleanse_attributes! using global cleaner' do
+      it "cleanse_attributes! using global cleaner" do
         assert_equal true, @user.valid?
-        assert_equal 'joe', @user.first_name
-        assert_equal 'black', @user.last_name
+        assert_equal "joe", @user.first_name
+        assert_equal "black", @user.last_name
       end
 
-      it 'cleanse_attributes! using attribute specific custom cleaner' do
+      it "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
+        assert_equal "<< 2632 Brown St >>", @user.address1
+        assert_equal "<< instance >>", @user.instance_var
       end
 
-      it 'cleanse_attributes! using global cleaner using rails extensions' do
+      it "cleanse_attributes! using global cleaner using rails extensions" do
         @user.cleanse_attributes!
-        assert_equal 12345, @user.zip_code
+        assert_equal 12_345, @user.zip_code
       end
     end
 
-    describe 'with user2' do
+    describe "with user2" do
       before do
         @user = User2.new(
-          :first_name => '    joe   ',
-          :last_name  => "\n  black\n",
-          :ssn        => "\n    123456789   \n  ",
-          :address1   => "2632 Brown St   \n",
-          :zip_code   => "\n\t  blah\n",
-          :text       => ["\n    123456789   \n  ", ' second ']
+          first_name: "    joe   ",
+          last_name:  "\n  black\n",
+          ssn:        "\n    123456789   \n  ",
+          address1:   "2632 Brown St   \n",
+          zip_code:   "\n\t  blah\n",
+          text:       ["\n    123456789   \n  ", " second "]
         )
       end
 
-      it 'have 4 cleaners defined' do
+      it "have 4 cleaners defined" do
         assert_equal 4, User2.send(:data_cleansing_cleaners).size, User2.send(:data_cleansing_cleaners)
       end
 
-      it 'have 3 attributes cleaners defined' do
+      it "have 3 attributes cleaners defined" do
         # :all, :first_name, :zip_code
         assert_equal 3, User2.send(:data_cleansing_attribute_cleaners).size, User2.send(:data_cleansing_attribute_cleaners)
       end
 
-      it 'cleanse_attributes! clean all attributes' do
+      it "cleanse_attributes! clean all attributes" do
         assert_equal true, @user.valid?
-        assert_equal '$<< @joe@ >>$', @user.first_name, User2.send(:data_cleansing_cleaners)
-        assert_equal '@black@', @user.last_name
+        assert_equal "$<< @joe@ >>$", @user.first_name, User2.send(:data_cleansing_cleaners)
+        assert_equal "@black@", @user.last_name
         assert_equal "2632 Brown St   \n", @user.address1
         assert_equal "@123456789@", @user.ssn
-        assert_equal nil, @user.zip_code, User2.send(:data_cleansing_cleaners)
-        assert_equal ["\n    123456789   \n  ", ' second '], @user.text
+        assert_nil @user.zip_code, User2.send(:data_cleansing_cleaners)
+        assert_equal ["\n    123456789   \n  ", " second "], @user.text
       end
-
     end
-
   end
 end

data/test/cleaners_test.rb

@@ -1,15 +1,15 @@
-require_relative 'test_helper'
-require 'active_support/core_ext/time/calculations'
+require_relative "test_helper"
+require "active_support/core_ext/time/calculations"
 
 class CleanersTest < Minitest::Test
   class User
     include DataCleansing::Cleanse
 
     attr_accessor :first_name, :last_name, :address1, :address2,
-      :make_this_upper, :clean_non_word, :clean_non_printable,
-      :clean_html, :clean_from_uri, :clean_to_uri, :clean_whitespace,
-      :clean_digits_only, :clean_to_integer, :clean_to_float, :clean_end_of_day,
-      :clean_order
+                  :make_this_upper, :clean_non_word, :clean_non_printable,
+                  :clean_html, :clean_from_uri, :clean_to_uri, :clean_whitespace,
+                  :clean_digits_only, :clean_to_integer, :clean_to_float, :clean_end_of_day,
+                  :clean_order
 
     cleanse :first_name, :last_name, :address1, :address2, cleaner: :strip
     cleanse :make_this_upper, cleaner: :upcase
@@ -25,197 +25,196 @@ class CleanersTest < Minitest::Test
     cleanse :clean_end_of_day, cleaner: :end_of_day
 
     # Call cleaners in the order they are defined
-    cleanse :clean_order, cleaner: [:upcase, :strip]
-    cleanse :clean_order, cleaner: -> val { val == 'BLAH' ? ' yes ' : ' no ' }
+    cleanse :clean_order, cleaner: %i[upcase strip]
+    cleanse :clean_order, cleaner: ->(val) { val == "BLAH" ? " yes " : " no " }
   end
 
-  describe 'Cleaners' do
-    it '#strip' do
+  describe "Cleaners" do
+    it "#strip" do
       user            = User.new
-      user.first_name = '     jack   black     '
+      user.first_name = "     jack   black     "
       user.last_name  = "  \n  \t   joe"
       user.address1   = "joe \n\n   \n  \t\t    "
       user.address2   = "joe \n\n bloggs  \n  \t\t    "
       user.cleanse_attributes!
-      assert_equal 'jack   black', user.first_name
-      assert_equal 'joe', user.last_name
-      assert_equal 'joe', user.address1
+      assert_equal "jack   black", user.first_name
+      assert_equal "joe", user.last_name
+      assert_equal "joe", user.address1
       assert_equal "joe \n\n bloggs", user.address2
     end
 
-    it '#upcase' do
+    it "#upcase" do
       user                 = User.new
-      user.make_this_upper = '     jacK   blAck     '
+      user.make_this_upper = "     jacK   blAck     "
       user.cleanse_attributes!
-      assert_equal '     JACK   BLACK     ', user.make_this_upper
+      assert_equal "     JACK   BLACK     ", user.make_this_upper
     end
 
-    it '#remove_non_word' do
+    it "#remove_non_word" do
       user                = User.new
       user.clean_non_word = "  !@#$%^&*()+=-~`\t\n   jacK   blAck   <>.,/\"':;{][]\|?/\\  "
       user.cleanse_attributes!
-      assert_equal 'jacKblAck', user.clean_non_word
+      assert_equal "jacKblAck", user.clean_non_word
     end
 
-    it '#remove_non_printable' do
+    it "#remove_non_printable" do
       user                     = User.new
-      user.clean_non_printable = "  !@#$%^&*()+=-~`\t\n   jacK   blAck   <>.,/\"':;{][]\|?/\\  "
+      user.clean_non_printable = "  !@#$%^&*()+=-~`\t\n   jacK   blAck   <>.,/\"':;{][]\|?/\\ \x89 "
       user.cleanse_attributes!
       assert_equal "  !@#$%^&*()+=-~`   jacK   blAck   <>.,/\"':;{][]\|?/\\  ", user.clean_non_printable
     end
 
-    describe '#clean_html' do
-      it 'cleans &quot;' do
+    describe "#clean_html" do
+      it "cleans &quot;" do
         user            = User.new
-        user.clean_html = 'O&quot;Leary'
+        user.clean_html = "O&quot;Leary"
         user.cleanse_attributes!
         assert_equal 'O"Leary', user.clean_html
       end
 
-      it 'cleans &amp;' do
+      it "cleans &amp;" do
         user            = User.new
-        user.clean_html = 'Jim &amp; Candi'
+        user.clean_html = "Jim &amp; Candi"
         user.cleanse_attributes!
-        assert_equal 'Jim & Candi', user.clean_html
+        assert_equal "Jim & Candi", user.clean_html
       end
 
-      it 'cleans &gt;' do
+      it "cleans &gt;" do
         user            = User.new
-        user.clean_html = '2 &gt; 1'
+        user.clean_html = "2 &gt; 1"
         user.cleanse_attributes!
-        assert_equal '2 > 1', user.clean_html
+        assert_equal "2 > 1", user.clean_html
       end
 
-      it 'cleans &lt;' do
+      it "cleans &lt;" do
         user            = User.new
-        user.clean_html = '1 &lt; 2'
+        user.clean_html = "1 &lt; 2"
         user.cleanse_attributes!
-        assert_equal '1 < 2', user.clean_html
+        assert_equal "1 < 2", user.clean_html
       end
 
-      it 'cleans &apos;' do
+      it "cleans &apos;" do
         user            = User.new
-        user.clean_html = '1&apos;2'
+        user.clean_html = "1&apos;2"
         user.cleanse_attributes!
         assert_equal "1'2", user.clean_html
       end
 
-      it 'cleans &nbsp;' do
+      it "cleans &nbsp;" do
         user            = User.new
-        user.clean_html = '1&nbsp;2'
+        user.clean_html = "1&nbsp;2"
         user.cleanse_attributes!
         assert_equal "1 2", user.clean_html
       end
 
-      it 'cleans &AMP;' do
+      it "cleans &AMP;" do
         user            = User.new
-        user.clean_html = 'Mutt &AMP; Jeff Inc.'
+        user.clean_html = "Mutt &AMP; Jeff Inc."
         user.cleanse_attributes!
-        assert_equal 'Mutt & Jeff Inc.', user.clean_html
+        assert_equal "Mutt & Jeff Inc.", user.clean_html
       end
 
-      it 'does not clean &;' do
+      it "does not clean &;" do
         user            = User.new
-        user.clean_html = 'Mutt &; Jeff Inc.'
+        user.clean_html = "Mutt &; Jeff Inc."
         user.cleanse_attributes!
-        assert_equal 'Mutt &; Jeff Inc.', user.clean_html
+        assert_equal "Mutt &; Jeff Inc.", user.clean_html
       end
 
-      it 'does not clean &blah;' do
+      it "does not clean &blah;" do
         user            = User.new
-        user.clean_html = '1&blah;2'
+        user.clean_html = "1&blah;2"
         user.cleanse_attributes!
-        assert_equal '1&blah;2', user.clean_html
+        assert_equal "1&blah;2", user.clean_html
       end
     end
 
-    describe '#unescape_uri' do
-      it 'converts %20' do
+    describe "#unescape_uri" do
+      it "converts %20" do
         user                = User.new
-        user.clean_from_uri = 'Jim%20%20Bob%20'
+        user.clean_from_uri = "Jim%20%20Bob%20"
         user.cleanse_attributes!
-        assert_equal 'Jim  Bob ', user.clean_from_uri
+        assert_equal "Jim  Bob ", user.clean_from_uri
       end
-      it 'converts %20 only' do
+      it "converts %20 only" do
         user                = User.new
-        user.clean_from_uri = '%20'
+        user.clean_from_uri = "%20"
         user.cleanse_attributes!
-        assert_equal ' ', user.clean_from_uri
+        assert_equal " ", user.clean_from_uri
       end
     end
 
-    describe '#escape_uri' do
-      it 'converts spaces' do
+    describe "#escape_uri" do
+      it "converts spaces" do
         user              = User.new
-        user.clean_to_uri = 'Jim  Bob '
+        user.clean_to_uri = "Jim  Bob "
         user.cleanse_attributes!
-        assert_equal 'Jim++Bob+', user.clean_to_uri
+        assert_equal "Jim++Bob+", user.clean_to_uri
       end
-      it 'converts space only' do
+      it "converts space only" do
         user              = User.new
-        user.clean_to_uri = ' '
+        user.clean_to_uri = " "
         user.cleanse_attributes!
-        assert_equal '+', user.clean_to_uri
+        assert_equal "+", user.clean_to_uri
       end
     end
 
-    describe '#compress_whitespace' do
-      it 'compresses multiple spaces' do
+    describe "#compress_whitespace" do
+      it "compresses multiple spaces" do
         user                  = User.new
-        user.clean_whitespace = '    J im  B ob       '
+        user.clean_whitespace = "    J im  B ob       "
         user.cleanse_attributes!
-        assert_equal ' J im B ob ', user.clean_whitespace
+        assert_equal " J im B ob ", user.clean_whitespace
       end
 
-      it 'does not compress single spaces' do
+      it "does not compress single spaces" do
         user                  = User.new
-        user.clean_whitespace = ' Jack Black'
+        user.clean_whitespace = " Jack Black"
         user.cleanse_attributes!
-        assert_equal ' Jack Black', user.clean_whitespace
+        assert_equal " Jack Black", user.clean_whitespace
       end
 
-      it 'compresses newlines and tabs' do
+      it "compresses newlines and tabs" do
         user                  = User.new
         user.clean_whitespace = "  \n\n  J im  B ob  \t\n\t     "
         user.cleanse_attributes!
-        assert_equal ' J im B ob ', user.clean_whitespace
+        assert_equal " J im B ob ", user.clean_whitespace
       end
     end
 
-    it '#digits_only' do
+    it "#digits_only" do
       user                   = User.new
       user.clean_digits_only = " 1 !@#$%^&*3()+=-~`\t\n   jacK6   blAck   <>.,/\"':;8{][]9\|?/\\  "
       user.cleanse_attributes!
-      assert_equal '13689', user.clean_digits_only
+      assert_equal "13689", user.clean_digits_only
     end
 
-    it '#string_to_integer' do
+    it "#string_to_integer" do
       user                  = User.new
       user.clean_to_integer = " 1 !@#$%^&*3()+=-~`\t\n   jacK6   blAck   <>.,/\"':;8{][]9\|?/\\  "
       user.cleanse_attributes!
       assert_equal 136, user.clean_to_integer
     end
 
-    it '#string_to_float' do
+    it "#string_to_float" do
       user                = User.new
       user.clean_to_float = " 1 !@#$%^&*3()+=-~`\t\n   jacK6   blAck   <>.,/\"':;8{][]9\|?/\\  "
       user.cleanse_attributes!
       assert_equal 136.89, user.clean_to_float
     end
 
-    it '#date_to_time_at_end_of_day' do
+    it "#date_to_time_at_end_of_day" do
       user                  = User.new
-      user.clean_end_of_day = Time.parse('2016-03-03 14:33:44 +0000')
+      user.clean_end_of_day = Time.parse("2016-03-03 14:33:44 +0000")
       user.cleanse_attributes!
-      assert_equal Time.parse('2016-03-03 23:59:59 +0000').to_i, user.clean_end_of_day.to_i
+      assert_equal Time.parse("2016-03-03 23:59:59 +0000").to_i, user.clean_end_of_day.to_i
     end
 
-    it 'cleans in the order defined' do
+    it "cleans in the order defined" do
       user             = User.new
-      user.clean_order = '  blah '
+      user.clean_order = "  blah "
       user.cleanse_attributes!
-      assert_equal ' yes ', user.clean_order
+      assert_equal " yes ", user.clean_order
     end
-
   end
 end

data/test/data_cleansing_test.rb

@@ -1,9 +1,9 @@
-require_relative 'test_helper'
+require_relative "test_helper"
 
 class DataCleansingTest < Minitest::Test
-  describe '#clean' do
-    it 'can call any cleaner directly' do
-      assert_equal 'jack   black', DataCleansing.clean(:strip, '     jack   black     ')
+  describe "#clean" do
+    it "can call any cleaner directly" do
+      assert_equal "jack   black", DataCleansing.clean(:strip, "     jack   black     ")
     end
   end
 end

data/test/ruby_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative "test_helper"
 
 # Non Cleansing base class
 class RubyUserBase
@@ -11,10 +11,10 @@ class RubyUser < RubyUserBase
   attr_accessor :first_name, :last_name, :address1, :address2
 
   # Use a global cleaner
-  cleanse :first_name, :last_name, :cleaner => :strip
+  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 { |string| "<< #{string.strip} >>" }
 
   # Execute after cleanser
   after_cleanse :name_check
@@ -31,7 +31,8 @@ end
 
 class RubyUserChild < RubyUser
   attr_accessor :gender
-  cleanse :gender, :cleaner => Proc.new {|gender| gender.to_s.strip.downcase}
+
+  cleanse :gender, cleaner: proc { |gender| gender.to_s.strip.downcase }
 end
 
 class RubyUser2
@@ -40,20 +41,20 @@ class RubyUser2
   attr_accessor :first_name, :last_name, :title, :address1, :address2, :gender
 
   # Use a global cleaner
-  cleanse :first_name, :last_name, :cleaner => :strip
+  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 { |string| string.strip }
 
   # Use multiple cleaners, and a custom block
-  cleanse :title, :cleaner => [:strip, :upcase, Proc.new {|string| "#{string}." unless string.end_with?('.')}]
+  cleanse :title, cleaner: [:strip, :upcase, proc { |string| "#{string}." unless string.end_with?(".") }]
 
   # Change the cleansing rule based on the value of other attributes in that instance of user
   # The 'title' is retrieved from the current instance of the user
-  cleanse :gender, :cleaner => [
+  cleanse :gender, cleaner: [
     :strip,
     :upcase,
-    Proc.new do |gender|
+    proc do |gender|
       if (gender == "UNKNOWN") && (title == "MR.")
         "Male"
       else
@@ -65,113 +66,110 @@ end
 
 class RubyTest < Minitest::Test
   describe "Ruby Models" do
-
-    it 'have globally registered cleaner' do
+    it "have globally registered cleaner" do
       assert DataCleansing.cleaner(:strip)
     end
 
-    it 'Model.cleanse_attribute' do
-      assert_equal 'male',                RubyUserChild.cleanse_attribute(:gender,     "\n   Male   \n"), RubyUserChild.send(:data_cleansing_attribute_cleaners)
-      assert_equal 'joe',                 RubyUserChild.cleanse_attribute(:first_name, '    joe   '), RubyUserChild.send(:data_cleansing_attribute_cleaners)
-      assert_equal 'black',               RubyUserChild.cleanse_attribute(:last_name,  "\n  black\n"), RubyUserChild.send(:data_cleansing_attribute_cleaners)
-      assert_equal '<< 2632 Brown St >>', RubyUserChild.cleanse_attribute(:address1,   "2632 Brown St   \n"), RubyUserChild.send(:data_cleansing_attribute_cleaners)
+    it "Model.cleanse_attribute" do
+      assert_equal "male",                RubyUserChild.cleanse_attribute(:gender,     "\n   Male   \n"), RubyUserChild.send(:data_cleansing_attribute_cleaners)
+      assert_equal "joe",                 RubyUserChild.cleanse_attribute(:first_name, "    joe   "), RubyUserChild.send(:data_cleansing_attribute_cleaners)
+      assert_equal "black",               RubyUserChild.cleanse_attribute(:last_name,  "\n  black\n"), RubyUserChild.send(:data_cleansing_attribute_cleaners)
+      assert_equal "<< 2632 Brown St >>", RubyUserChild.cleanse_attribute(:address1,   "2632 Brown St   \n"), RubyUserChild.send(:data_cleansing_attribute_cleaners)
       assert_equal 3,                     RubyUserChild.cleanse_attribute(:first_name, 3), RubyUserChild.send(:data_cleansing_attribute_cleaners)
     end
 
     describe "with ruby user" do
       before do
         @user = RubyUser.new
-        @user.first_name = '    joe   '
+        @user.first_name = "    joe   "
         @user.last_name = "\n  black\n"
         @user.address1 = "2632 Brown St   \n"
       end
 
-      it 'cleanse_attributes! using global cleaner' do
+      it "cleanse_attributes! using global cleaner" do
         @user.cleanse_attributes!
-        assert_equal 'joe', @user.first_name
-        assert_equal 'black', @user.last_name
+        assert_equal "joe", @user.first_name
+        assert_equal "black", @user.last_name
       end
 
-      it 'cleanse_attributes! using attribute specific custom cleaner' do
+      it "cleanse_attributes! using attribute specific custom cleaner" do
         @user.cleanse_attributes!
-        assert_equal '<< 2632 Brown St >>', @user.address1
+        assert_equal "<< 2632 Brown St >>", @user.address1
       end
 
-      it 'cleanse_attributes! not cleanse nil attributes' do
+      it "cleanse_attributes! not cleanse nil attributes" do
         @user.first_name = nil
         @user.cleanse_attributes!
-        assert_equal nil, @user.first_name
+        assert_nil @user.first_name
       end
 
-      it 'cleanse_attributes! call after cleaner' do
-        @user.first_name = 'Jack'
+      it "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
+        assert_nil @user.first_name, @user.inspect
+        assert_equal "Jack", @user.last_name, @user.inspect
       end
     end
 
     describe "with ruby user child" do
       before do
         @user = RubyUserChild.new
-        @user.first_name = '    joe   '
+        @user.first_name = "    joe   "
         @user.last_name  = "\n  black\n"
         @user.address1   = "2632 Brown St   \n"
         @user.gender     = "\n   Male   \n"
       end
 
-      it 'cleanse_attributes! using global cleaner' do
+      it "cleanse_attributes! using global cleaner" do
         @user.cleanse_attributes!
-        assert_equal 'joe', @user.first_name
-        assert_equal 'black', @user.last_name
+        assert_equal "joe", @user.first_name
+        assert_equal "black", @user.last_name
       end
 
-      it 'cleanse_attributes! using attribute specific custom cleaner' do
+      it "cleanse_attributes! using attribute specific custom cleaner" do
         @user.cleanse_attributes!
-        assert_equal '<< 2632 Brown St >>', @user.address1
+        assert_equal "<< 2632 Brown St >>", @user.address1
       end
 
-      it 'cleanse_attributes! not cleanse nil attributes' do
+      it "cleanse_attributes! not cleanse nil attributes" do
         @user.first_name = nil
         @user.cleanse_attributes!
-        assert_equal nil, @user.first_name
+        assert_nil @user.first_name
       end
 
-      it 'cleanse_attributes! clean child attributes' do
+      it "cleanse_attributes! clean child attributes" do
         @user.cleanse_attributes!
-        assert_equal 'male', @user.gender
+        assert_equal "male", @user.gender
       end
-
     end
 
     describe "with ruby user2" do
       before do
         @user = RubyUser2.new
-        @user.first_name = '    joe   '
+        @user.first_name = "    joe   "
         @user.last_name  = "\n  black\n"
         @user.address1   = "2632 Brown St   \n"
         @user.title      = "   \nmr   \n"
         @user.gender     = " Unknown  "
       end
 
-      it 'cleanse_attributes!' do
+      it "cleanse_attributes!" do
         @user.cleanse_attributes!
-        assert_equal 'joe', @user.first_name
-        assert_equal 'black', @user.last_name
-        assert_equal '2632 Brown St', @user.address1
+        assert_equal "joe", @user.first_name
+        assert_equal "black", @user.last_name
+        assert_equal "2632 Brown St", @user.address1
       end
 
-      it 'cleanse_attributes! with multiple cleaners' do
+      it "cleanse_attributes! with multiple cleaners" do
         @user.cleanse_attributes!
-        assert_equal 'MR.', @user.title
+        assert_equal "MR.", @user.title
       end
 
-      it 'cleanse_attributes! referencing other attributes' do
+      it "cleanse_attributes! referencing other attributes" do
         @user.cleanse_attributes!
-        assert_equal 'Male', @user.gender
+        assert_equal "Male", @user.gender
       end
     end
-
   end
 end

data/test/test_helper.rb

@@ -1,9 +1,9 @@
-ENV['RAILS_ENV'] = 'test'
+ENV["RAILS_ENV"] = "test"
 
-require 'active_record'
-require 'minitest/autorun'
-require 'data_cleansing'
-require 'awesome_print'
+require "active_record"
+require "minitest/autorun"
+require "data_cleansing"
+require "amazing_print"
 
-SemanticLogger.add_appender(file_name: 'test.log', formatter: :color)
+SemanticLogger.add_appender(file_name: "test.log", formatter: :color)
 SemanticLogger.default_level = :debug

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_cleansing
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,9 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
-- reidmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,7 +63,7 @@ homepage: http://github.com/reidmorrison/data_cleansing
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,21 +71,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Data Cleansing framework for Ruby, Rails, and Mongoid.
 test_files:
-- test/test_db.sqlite3
-- test/data_cleansing_test.rb
 - test/active_record_test.rb
+- test/cleaners_test.rb
+- test/data_cleansing_test.rb
 - test/ruby_test.rb
+- test/test_db.sqlite3
 - test/test_helper.rb
-- test/cleaners_test.rb