data_cleansing 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1895359140ba6c85db9f47c33a3ddb7b8558d6d
+  data.tar.gz: d2f610c71b6c413114d1b30f41aab6f8d9fdd403
+SHA512:
+  metadata.gz: 0503371aefa9478b62345cdbce5fcc88d344c2b080471e38e5c1d2bf0bdb0f7cd5f00b61e182d100b477994c567e5211f662a828ec781ef6955a24a19686aaa1
+  data.tar.gz: 1e48577434bafba21a884156ade715dbdc56d7dcabcb9ecdccbed057c22f2bcccd162e8f5c38b3822dbb03bde927b55a3967f940a550386bb9c8670b53aa9693

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "shoulda"
+
+  gem "activerecord"
+  gem 'sqlite3', :platform => :ruby
+
+  platforms :jruby do
+    gem 'jdbc-sqlite3'
+    gem 'activerecord-jdbcsqlite3-adapter'
+  end
+
+  gem "mongoid"
+end
+
+group :develop do
+  gem 'awesome_print'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.10)
+    awesome_print (1.1.0)
+    bson (1.9.1)
+    builder (3.1.4)
+    durran-validatable (2.0.1)
+    i18n (0.6.4)
+    leshill-will_paginate (2.3.11)
+    minitest (4.7.5)
+    mongo (1.9.1)
+      bson (~> 1.9.1)
+    mongoid (1.0.6)
+      activesupport (>= 2.2.2)
+      durran-validatable (>= 2.0.1)
+      leshill-will_paginate (>= 2.3.11)
+      mongo (>= 0.18.2)
+    multi_json (1.7.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.4)
+    shoulda-matchers (2.2.0)
+      activesupport (>= 3.0.0)
+    sqlite3 (1.3.7)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activerecord-jdbcsqlite3-adapter
+  awesome_print
+  jdbc-sqlite3
+  mongoid
+  shoulda
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Clarity Services, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,150 @@
+data_cleansing
+==============
+
+Data Cleansing solution for Ruby with additional support for Rails and Mongoid
+
+* http://github.com/ClarityServices/data_cleansing
+
+## Introduction
+
+It is important to keep internal data free of unwanted escape characters, leading
+or trailing blanks and even newlines.
+Similarly it would be useful to be able to attach a cleansing solution to a field
+in a model and have the data cleansed transparently when required.
+
+DataCleansing is a framework that allows any data cleansing to be applied to
+specific attributes or fields. At this time it does not supply the cleaning
+solutions themselves since they are usually straight forward, or so complex
+that they don't tend to be too usefull to others. However, over time built-in
+cleansing solutions may be added. Feel free to submit any suggestions via a ticket
+or pull request.
+
+## Features
+
+* Supports global cleansing definitions that can be associated with any Ruby,
+  Rails, Mongoid, or other model.
+* Supports custom cleansing definitions for a single attribute
+
+## Examples
+
+### Ruby Example
+
+```ruby
+class User
+  include DataCleansing::Cleanse
+
+  attr_accessor :first_name, :last_name, :address1, :address2
+
+  # 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!}
+end
+
+# Define a global cleanser
+DataCleansing.register_cleaner(:strip) {|string, params, object| string.strip!}
+
+u = User.new
+u.first_name = '    joe   '
+u.last_name = "\n  black\n"
+u.address1 = "2632 Brown St   \n"
+puts "Before data cleansing #{u.inspect}"
+u.cleanse_attributes!
+puts "After data cleansing #{u.inspect}"
+```
+
+### Rails Example
+
+To encrypt a field in a Mongoid document, just add ":encrypted => true" at the end
+of the field specifier. The field name must currently begin with "encrypted_"
+
+```ruby
+# '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
+
+# Define a global cleanser
+DataCleansing.register_cleaner(:strip) {|string, params, object| string.strip!}
+
+# 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!
+```
+
+## Installation
+
+### Add to an existing Rails project
+
+Add the following line to Gemfile
+
+```ruby
+gem 'data_validation'
+```
+
+Install the Gem with bundler
+
+    bundle install
+
+## Architecture
+
+DataCleansing has been designed to support externalized data cleansing routines.
+In this way the data cleansing routine itself can be loaded from a datastore and
+applied dynamically at runtime.
+Although not supported out of the box, this design allows for example for the
+data cleansing routines to be stored in something like [ZooKeeper](http://zookeeper.apache.org/).
+Then any changes to the data cleansing routines can be pushed out immediately to
+every server that needs it.
+
+DataCleansing is designed to support any Ruby model. In this way it can be used
+in just about any ORM or DOM. For example, it currently easily supports both
+Rails and Mongoid models. Some extensions have been added to support these frameworks.
+
+For example, in Rails it obtains the raw data value before Rails has converted it.
+Which is useful for cleansing integer or float fields as raw strings before Rails
+tries to convert it to an integer or float.
+
+Meta
+----
+
+* Code: `git clone git://github.com/ClarityServices/data_cleansing.git`
+* Home: <https://github.com/ClarityServices/data_cleansing>
+* Issues: <http://github.com/ClarityServices/data_cleansing/issues>
+* Gems: <http://rubygems.org/gems/data_cleansing>
+
+This project uses [Semantic Versioning](http://semver.org/).
+
+Authors
+-------
+
+Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+
+License
+-------
+
+Copyright 2013 Clarity Services, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,39 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'rubygems'
+require 'rubygems/package'
+require 'rake/clean'
+require 'rake/testtask'
+require 'date'
+require 'data_cleansing/version'
+
+desc "Build gem"
+task :gem  do |t|
+  gemspec = Gem::Specification.new do |s|
+    s.name        = 'data_cleansing'
+    s.version     = DataCleansing::VERSION
+    s.platform    = Gem::Platform::RUBY
+    s.authors     = ['Reid Morrison']
+    s.email       = ['reidmo@gmail.com']
+    s.homepage    = 'https://github.com/ClarityServices/data_cleansing'
+    s.date        = Date.today.to_s
+    s.summary     = "Data Cleansing framework for Ruby, and Ruby on Rails"
+    s.description = "Data Cleansing framework for Ruby with additional support for Rails and Mongoid"
+    s.files       = FileList["./**/*"].exclude(/.gem$/, /.log$/,/^nbproject/).map{|f| f.sub(/^\.\//, '')}
+    s.license     = "Apache License V2.0"
+    s.has_rdoc    = true
+    s.add_dependency 'thread_safe'
+  end
+  Gem::Package.build gemspec
+end
+
+desc "Run Test Suite"
+task :test do
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::Task['functional'].invoke
+end

data/lib/data_cleansing/cleanse.rb

@@ -0,0 +1,91 @@
+module DataCleansing
+  # Mix-in to add cleaner
+  module Cleanse
+    CleanerStruct = Struct.new(:cleaner, :attributes, :params)
+
+    module ClassMethods
+      # Define how to cleanse one or more attributes
+      def cleanse(*args)
+        last = args.last
+        params = (last.is_a?(Hash) && last.instance_of?(Hash)) ? args.pop.dup : {}
+        cleaner = params.delete(:cleaner)
+        raise(ArgumentError, "Mandatory :cleaner parameter is missing: #{params.inspect}") unless cleaner
+        (@cleaners ||= ThreadSafe::Array.new) << CleanerStruct.new(cleaner, args, params)
+      end
+
+      def cleaners
+        @cleaners
+      end
+    end
+
+    module InstanceMethods
+      # Cleanse the attributes using specified cleaners
+      def cleanse_attributes!
+        self.class.cleaners.each do |cleaner_struct|
+          params  = cleaner_struct.params
+          cleaner = cleaner_struct.cleaner
+          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
+
+            # Remove serialized_attributes if any, from the :all condition
+            if self.class.respond_to?(:serialized_attributes)
+              serialized_attrs = self.class.serialized_attributes.keys
+              attrs -= serialized_attrs.collect{|i| i.to_sym} if serialized_attrs
+            end
+
+            # Replace any encrypted attributes with their non-encrypted versions if any
+            if defined?(SymmetricEncryption) && self.class.respond_to?(:encrypted_attributes)
+              self.class.encrypted_attributes.each_pair do |clear, encrypted|
+                if attrs.include?(encrypted.to_sym)
+                  attrs.delete(encrypted.to_sym)
+                  attrs << clear.to_sym
+                end
+              end
+            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)
+              read_attribute_before_type_cast(attr.to_s)
+            else
+              send(attr.to_sym)
+            end
+
+            # No need to clean if attribute is nil
+            unless value.nil?
+              new_value = if cleaner.is_a?(Proc)
+                cleaner.call(value, params)
+              else
+                if c = DataCleansing.cleaner(cleaner)
+                  c.call(value, params)
+                else
+                  raise "No cleaner defined for #{cleaner.to_sym}"
+                end
+              end
+              # Update value if it has changed
+              send("#{attr.to_sym}=".to_sym, new_value) if new_value != value
+            end
+
+          end
+        end
+      end
+    end
+
+    def self.included(base)
+      base.class_eval do
+        extend(DataCleansing::Cleanse::ClassMethods)
+        include(DataCleansing::Cleanse::InstanceMethods)
+      end
+    end
+  end
+
+end

data/lib/data_cleansing/data_cleansing.rb

@@ -0,0 +1,23 @@
+module DataCleansing
+
+  # Global Data Cleansers
+  @@global_cleaners = ThreadSafe::Hash.new
+
+  # Register a new cleaner
+  # Replaces any existing cleaner with the same name
+  def self.register_cleaner(cleaner, &block)
+    if block
+      @@global_cleaners[cleaner.to_sym] = block
+    else
+      # TODO Expose class methods as cleaners
+      #
+      # cleaners[cleaner.to_sym] = block
+      # raise ArgumentError, "Must supply either a Proc, or a cleaner klass"
+    end
+  end
+
+  # Returns the cleaner matching the supplied cleaner name
+  def self.cleaner(cleaner_name)
+    @@global_cleaners[cleaner_name.to_sym]
+  end
+end

data/lib/data_cleansing/version.rb

@@ -0,0 +1,3 @@
+module DataCleansing
+  VERSION = "0.2.0"
+end

data/lib/data_cleansing.rb

@@ -0,0 +1,17 @@
+require 'thread_safe'
+require 'data_cleansing/version'
+require 'data_cleansing/data_cleansing'
+
+module DataCleansing
+  autoload :Cleanse, 'data_cleansing/cleanse'
+end
+
+# Rails Extensions
+#if defined?(Rails)
+#  require 'data_cleansing/railtie'
+#end
+
+# Mongoid Extensions
+#if defined?(Mongoid)
+#  require 'data_cleansing/extensions/mongoid/fields'
+#end

data/nbproject/private/private.properties

@@ -0,0 +1,3 @@
+file.reference.data_cleansing-examples=/Users/rmorrison/Sandbox/data_cleansing/examples
+file.reference.data_cleansing-lib=/Users/rmorrison/Sandbox/data_cleansing/lib
+file.reference.data_cleansing-test=/Users/rmorrison/Sandbox/data_cleansing/test

data/nbproject/project.properties

@@ -0,0 +1,9 @@
+examples.dir=${file.reference.data_cleansing-examples}
+file.reference.data_cleansing-examples=examples
+file.reference.data_cleansing-lib=lib
+file.reference.data_cleansing-test=test
+main.file=
+platform.active=Ruby_1
+source.encoding=UTF-8
+src.dir=${file.reference.data_cleansing-lib}
+test.src.dir=${file.reference.data_cleansing-test}

data/nbproject/project.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>data_cleansing</name>
+            <source-roots>
+                <root id="src.dir"/>
+                <root id="examples.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.src.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/test/active_record_test.rb

@@ -0,0 +1,133 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+# Load ActiveRecord before loading data_cleansing so that the AR extensions
+# are loaded
+require 'active_record'
+require 'data_cleansing'
+
+ActiveRecord::Base.logger = Logger.new($stderr)
+ActiveRecord::Base.configurations = {
+  '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|
+    t.string  :first_name
+    t.string  :last_name
+    t.string  :address1
+    t.string  :address2
+    t.integer :zip_code
+  end
+end
+
+# Define a global cleaner
+DataCleansing.register_cleaner(:strip) {|string, params, object| string.strip!}
+
+# Removes all non-digit characters, except '.' then truncates
+# the result to an integer string
+# Returns nil if no digits are present in the string
+DataCleansing.register_cleaner(:digits_to_integer) do |integer|
+  if integer.kind_of?(String)
+    # Remove Non-Digit Chars, except for '.'
+    integer = integer.gsub(/[^0-9\.]/, '')
+    integer.length > 0 ? integer.to_i : nil
+  else
+    integer
+  end
+end
+
+
+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!} >>"}
+
+  # Custom Zip Code cleaner
+  cleanse :zip_code, :cleaner => :digits_to_integer
+
+  # Automatically cleanse data before validation
+  before_validation :cleanse_attributes!
+end
+
+class User2 < ActiveRecord::Base
+  include DataCleansing::Cleanse
+  # Use the same table as User above
+  self.table_name = 'users'
+
+  # Test :all cleaner. Only works with ActiveRecord Models
+  cleanse :all, :cleaner => :strip
+
+  # Automatically cleanse data before validation
+  before_validation :cleanse_attributes!
+end
+
+class ActiveRecordTest < Test::Unit::TestCase
+  context "ActiveRecord Models" do
+
+    should 'have globally registered cleaner' do
+      assert DataCleansing.cleaner(:strip)
+    end
+
+    context "with user" do
+      setup do
+        @user = User.new(
+          :first_name => '    joe   ',
+          :last_name  => "\n  black\n",
+          :address1   => "2632 Brown St   \n",
+          :zip_code   => "\n\tblah 12345badtext\n"
+        )
+      end
+
+      should 'cleanse_attributes! using global cleaner' do
+        assert_equal true, @user.valid?
+        assert_equal 'joe', @user.first_name
+        assert_equal 'black', @user.last_name
+      end
+
+      should 'cleanse_attributes! using attribute specific custom cleaner' do
+        assert_equal true, @user.valid?
+        assert_equal '<< 2632 Brown St >>', @user.address1
+      end
+
+      should 'cleanse_attributes! using global cleaner using rails extensions' do
+        @user.cleanse_attributes!
+        assert_equal 12345, @user.zip_code
+      end
+    end
+
+    context "with user2" do
+      setup do
+        @user = User2.new(
+          :first_name => '    joe   ',
+          :last_name  => "\n  black\n",
+          :address1   => "2632 Brown St   \n",
+          :zip_code   => "\n\t12345\n"
+        )
+      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
+      end
+
+    end
+
+  end
+end

data/test/ruby_test.rb

@@ -0,0 +1,58 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'data_cleansing'
+
+# Define a global cleanser
+DataCleansing.register_cleaner(:strip) {|string, params, object| string.strip!}
+
+class RubyUser
+  include DataCleansing::Cleanse
+
+  attr_accessor :first_name, :last_name, :address1, :address2
+
+  # 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!} >>"}
+end
+
+class RubyTest < Test::Unit::TestCase
+  context "Ruby Models" do
+
+    should 'have globally registered cleaner' do
+      assert DataCleansing.cleaner(:strip)
+    end
+
+    context "with ruby user" do
+      setup do
+        @user = RubyUser.new
+        @user.first_name = '    joe   '
+        @user.last_name = "\n  black\n"
+        @user.address1 = "2632 Brown St   \n"
+      end
+
+      should 'cleanse_attributes! using global cleaner' do
+        @user.cleanse_attributes!
+        assert_equal 'joe', @user.first_name
+        assert_equal 'black', @user.last_name
+      end
+
+      should 'cleanse_attributes! using attribute specific custom cleaner' do
+        @user.cleanse_attributes!
+        assert_equal '<< 2632 Brown St >>', @user.address1
+      end
+
+      should 'cleanse_attributes! not cleanse nil attributes' do
+        @user.first_name = nil
+        @user.cleanse_attributes!
+        assert_equal nil, @user.first_name
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: data_cleansing
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Reid Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Data Cleansing framework for Ruby with additional support for Rails and
+  Mongoid
+email:
+- reidmo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/data_cleansing.rb
+- lib/data_cleansing/cleanse.rb
+- lib/data_cleansing/data_cleansing.rb
+- lib/data_cleansing/version.rb
+- nbproject/private/private.properties
+- nbproject/private/rake-d.txt
+- nbproject/project.properties
+- nbproject/project.xml
+- test/active_record_test.rb
+- test/ruby_test.rb
+- test/test_db.sqlite3
+homepage: https://github.com/ClarityServices/data_cleansing
+licenses:
+- Apache License V2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Data Cleansing framework for Ruby, and Ruby on Rails
+test_files: []