cleanerupper 0.2.1 → 0.2.2

data/README.markdown

@@ -25,13 +25,13 @@ A default dictionary is included with this project, but only contains some test
 It works by  providing a new method to all of your ActiveRecord based objects called `clean`
 
     class Widget < ActiveRecord::Base
-      clean :body, :with => :scramble
+      clean :body, :method => :scramble
     end
 
-This method takes an array of columns to be cleaned by cleanerupper, followed by two options:
+This method takes an array of columns to be cleaned by cleanerupper, followed by three optional parameters:
 
-    :with       => Specifies which method to clean with
-    :dictionary => Specifies which dictionary should be used for this cleaning
+    :method     => Specifies which method to clean with
+    :dictionary => Specifies which dictionaries should be used for this cleaning
     :callback   => Specifies a callback to call if disallowed data is found
 
 Three methods have been provided for cleaning convenience, which are:
@@ -43,13 +43,10 @@ Three methods have been provided for cleaning convenience, which are:
 If no method is defined, `:scramble` will be used.  You can also define your own function, like so:
 
     class Widget < ActiveRecord::Base
-      clean :body, :with => :custom
+      clean :body, :method => :remove_vowels
 
-      def custom(found, dict)
-        Cleaner::Data.dictionaries[dict].each do |word|
-          found.gsub!(word, "CUSTOM") if found.include?(word)
-        end
-        return found
+      def custom(val)
+        return val.gsub(/(a|e|i|o|u)/, "*")
       end
     end
 
@@ -64,14 +61,20 @@ In the example above, we make use of the `word` dictionary to check our column f
 You can access these dictionaries by using the `Cleaner::Data.dictionaries[:key]` object, where `:key` is the key of your dictionary as defined by your config file.  You can specify that any cleaning method use a specific dictionary by adding a `:dictionary` paramater:
 
     class Widget < ActiveRecord::Base
-      clean :body, :with => :replace, :dictionary => :custom
+      clean :body, :method => :replace, :dictionary => :custom
+    end
+
+You can use multiple dictionaries for any given cleaning method by passing an array to the `:dictionary` option:
+
+    class Widget < ActiveRecord::Base
+      clean :body, :dictionary => [:words, :custom]
     end
 
 You can also define a callback. This callback will only be called if bad data was found in any of
-the columns.  If the callback returns falls, the save will fail (this works the same way as a `before_save`).
+the columns.  If the callback returns false, the save will fail (this works the same way as a `before_save`).
 
     class Widget < ActiveRecord::Base
-      clean :body, :with => :scramble, :callback => :found_words
+      clean :body, :method => :scramble, :callback => :found_words
 
       def found_words
         Emailer.email_teacher("Your student used a bad word!")
@@ -83,13 +86,13 @@ the columns.  If the callback returns falls, the save will fail (this works the
 
     # Clean different columns with different methods
     class Widget < ActiveRecord::Base
-      clean :body, :title, :with => :replace
-      clean :author_name, :with => :scramble
+      clean :body, :title, :method => :replace
+      clean :author_name, :method => :scramble
     end
 
     # Clean the body, and send an email if this is the first time a bad word has been used
     class Widget < ActiveRecord::Base
-      clean :body, :with => :replace, :callback => :send_email
+      clean :body, :method => :replace, :callback => :send_email
 
       def send_email
         if self.author.infractions >= 1
@@ -102,7 +105,7 @@ the columns.  If the callback returns falls, the save will fail (this works the
 
     # Custom cleaning method
     class Widget < ActiveRecord::Base
-      clean :body, :title, :author_name, :with => :remove_vowels
+      clean :body, :title, :author_name, :method => :remove_vowels
 
       def remove_vowels(found)
         Cleaner::Dictionary.words.each do |word|
@@ -114,7 +117,7 @@ the columns.  If the callback returns falls, the save will fail (this works the
 
     # Custom dictionary
     class Widget < ActiveRecord::Base
-      clean :body, :title, :with => :replace, :dictionary => :animals
+      clean :body, :title, :method => :replace, :dictionary => :animals
     end
 
 # Disclaimer #
@@ -122,8 +125,8 @@ This code is still under development, and as such, minor revisions may break com
 the gem/plugin.  Please keep this in mind when using CleanerUpper.
 
 # What's Next? #
-* Change the custom cleaning code to be more user friendly
 * Optimize dictionary loops
+* Benchmark the impact of the CleanerUpper codebase on database activity
 * Increase test coverage
 * Remove test dependency on the rails environment
 

data/cleanerupper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cleanerupper}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mike Trpcic"]
-  s.date = %q{2010-04-20}
+  s.date = %q{2010-04-24}
   s.email = %q{mike@fluidmedia.com}
   s.extra_rdoc_files = [
     "README.markdown"
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "./pkg/cleanerupper-0.1.0.gem",
      "./pkg/cleanerupper-0.1.1.gem",
      "./pkg/cleanerupper-0.2.0.gem",
+     "./pkg/cleanerupper-0.2.1.gem",
      "./rails/init.rb",
      "./tasks/cleanerupper_tasks.rake",
      "./test/cleanerupper_test.rb",

data/lib/cleanerupper.rb

@@ -50,7 +50,8 @@ module Cleaner
         if Cleaner::Data.cleaner_methods.include?(method.to_sym)
           new_value = Cleaner.send(method.to_sym, old_value.dup, dictionary)
         else
-          new_value = self.send(method, old_value.dup, dictionary)
+          new_value = Cleaner.send(:custom_clean, old_value.dup, dictionary, self.method(method))
+          #new_value = self.send(method, old_value.dup, dictionary)
         end
         unless new_value == old_value
           to_save = callback.nil? ? true : self.send(callback) == false ? false : true
@@ -68,7 +69,7 @@ module Cleaner
     def clean(*args)
       params = args[-1].is_a?(Hash) ? args[-1] : {}
       attributes = args[0..-1] if params
-      with = params.has_key?(:with) ? params[:with] : :scramble
+      with = params.has_key?(:method) ? params[:method] : :scramble
       callback = params.has_key?(:callback) ? params[:callback] : nil
       dictionary = params.has_key?(:dictionary) ? params[:dictionary] : :words
       attributes.each do |attribute|
@@ -79,6 +80,14 @@ module Cleaner
 
   #Define all your actual manipulation methods here:
 
+  #This is a wrapper method for custom cleaning methods defined by a user
+  def custom_clean(value, dict, func)
+    dict.each do |word|
+      value.to_s.gsub!(/#{word}/, func.call(word))
+    end
+    value
+  end
+  
   #This method scrambles data by rearranging the letters.
   def scramble(value, dict)
     dict.each do |word|

data/test/cleanerupper_test.rb

@@ -13,31 +13,31 @@ end
 
 class ReplaceWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :with => :replace
+  clean :body, :method => :replace
 end
 
 class RemoveWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :title, :with => :remove
+  clean :body, :title, :method => :remove
 end
 
 class ScrambleWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :title, :with => :scramble
+  clean :title, :method => :scramble
 end
 
 class CustomWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :title, :with => :custom_function
+  clean :body, :title, :method => :remove_vowels
 
-  def custom_function(value, dict)
-    return "Custom Value: #{value}"
+  def remove_vowels(val)
+    val.gsub(/(a|e|i|o|u)/, "*")
   end
 end
 
 class CallbackWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :with => :scramble, :callback => :callback_method
+  clean :body, :method => :scramble, :callback => :callback_method
 
   def callback_method
     self.title = "CALLBACK"
@@ -47,7 +47,7 @@ end
 
 class FalseCallbackWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :with => :scramble, :callback => :callback_method
+  clean :body, :method => :scramble, :callback => :callback_method
 
   def callback_method
     self.title = "CALLBACK"
@@ -57,12 +57,12 @@ end
 
 class CustomDictWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :with => :scramble, :dictionary => :animals
+  clean :body, :method => :scramble, :dictionary => :animals
 end
 
 class MultiDictWidget < ActiveRecord::Base
   set_table_name :widgets
-  clean :body, :with => :scramble, :dictionary => [:animals, :furniture]
+  clean :body, :method => :scramble, :dictionary => [:animals, :furniture]
 end
 
 class CleanerupperTest < Test::Unit::TestCase
@@ -105,10 +105,10 @@ class CleanerupperTest < Test::Unit::TestCase
     w = CustomWidget.find(w.id)
 
     assert w.title != title
-    assert w.title == "Custom Value: cleanerupper remove_test title"
+    assert w.title == "cleanerupper r*m*v*_t*st title"
 
     assert w.body != body
-    assert w.body == "Custom Value: cleanerupper scramble_test body"
+    assert w.body == "cleanerupper scr*mbl*_t*st body"
   end
 
   def test_cleanerupper_custom_callback

data/test/debug.log

@@ -2800,3 +2800,85 @@
   ScrambleWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 7) 
   MultiDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'stdotge_ regular_test tb_edtse', NULL)
   MultiDictWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 8) 
+  SQL (0.4ms)   select sqlite_version(*)
+  SQL (1.6ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (79.7ms)   DROP TABLE "widgets"
+  SQL (5.0ms)   CREATE TABLE "widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (1.0ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  RemoveWidget Create (0.3ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper test', 'cleanerupper test', NULL)
+  RemoveWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 1) 
+  ReplaceWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'cleanerupper %$$$%**&%*@* test', NULL)
+  ReplaceWidget Load (2.0ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 2) 
+  ScrambleWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper ttlmescsbrae_ test', NULL, NULL)
+  ScrambleWidget Load (0.7ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 3) 
+  CallbackWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('CALLBACK', 'cleanerupper _ustescttmo body', NULL)
+  CallbackWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 4) 
+  CustomDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'tdsotge_ bird_test fsiest_ht', NULL)
+  CustomDictWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 5) 
+  ScrambleWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper tfauedts_elt body', NULL, NULL)
+  ScrambleWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 6) 
+  MultiDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'ots_gdte regular_test debts_et', NULL)
+  MultiDictWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 7) 
+  SQL (0.4ms)   select sqlite_version(*)
+  SQL (0.7ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (21.4ms)   DROP TABLE "widgets"
+  SQL (2.7ms)   CREATE TABLE "widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  RemoveWidget Create (0.3ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper test', 'cleanerupper test', NULL)
+  RemoveWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 1) 
+  ReplaceWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'cleanerupper &@$%%$**%$&* test', NULL)
+  ReplaceWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 2) 
+  ScrambleWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper rlbtsm_eeacts test', NULL, NULL)
+  ScrambleWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 3) 
+  CallbackWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('CALLBACK', 'cleanerupper cut_emtotss body', NULL)
+  CallbackWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 4) 
+  CustomDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'gs_otetd bird_test _ftshseti', NULL)
+  CustomDictWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 5) 
+  CustomWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper r*m*v*_t*st title', 'cleanerupper scr*mbl*_t*st body', NULL)
+  CustomWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 6) 
+  ScrambleWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper lftstedeau_t body', NULL, NULL)
+  ScrambleWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 7) 
+  MultiDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'tstdo_ge regular_test d_btsete', NULL)
+  MultiDictWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 8) 
+  SQL (0.4ms)   select sqlite_version(*)
+  SQL (0.7ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (38.7ms)   DROP TABLE "widgets"
+  SQL (2.8ms)   CREATE TABLE "widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  RemoveWidget Create (0.3ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper test', 'cleanerupper test', NULL)
+  RemoveWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 1) 
+  ReplaceWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'cleanerupper !*%$%*@$*%$@ test', NULL)
+  ReplaceWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 2) 
+  ScrambleWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper scsrm_tatbeel test', NULL, NULL)
+  ScrambleWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 3) 
+  CallbackWidget Create (1.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('CALLBACK', 'cleanerupper eut_tocmsts body', NULL)
+  CallbackWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 4) 
+  CustomDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, '_destogt bird_test htief_tss', NULL)
+  CustomDictWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 5) 
+  CustomWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper r*m*v*_t*st title', 'cleanerupper scr*mbl*_t*st body', NULL)
+  CustomWidget Load (0.3ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 6) 
+  ScrambleWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES('cleanerupper selfuetta_dt body', NULL, NULL)
+  ScrambleWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 7) 
+  MultiDictWidget Create (0.2ms)   INSERT INTO "widgets" ("title", "body", "author_name") VALUES(NULL, 'gd_tstoe regular_test tsedbt_e', NULL)
+  MultiDictWidget Load (0.2ms)   SELECT * FROM "widgets" WHERE ("widgets"."id" = 8) 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Mike Trpcic
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 -04:00
+date: 2010-04-24 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - ./pkg/cleanerupper-0.1.0.gem
 - ./pkg/cleanerupper-0.1.1.gem
 - ./pkg/cleanerupper-0.2.0.gem
+- ./pkg/cleanerupper-0.2.1.gem
 - ./rails/init.rb
 - ./tasks/cleanerupper_tasks.rake
 - ./test/cleanerupper_test.rb