cleanerupper 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,105 @@
+# Cleanerupper #
+
+Cleanerupper can be used in any ActiveRecord based model to seamless clean, sanitize, and
+remove inappropriate or sensitive data.
+
+# Using Cleanerupper #
+
+Cleanerupper relies on a dictionary file located in the config directory of your rails
+application called `dictionary.yml`.  This file is structured as so:
+
+    words:
+      these
+      words
+      will
+      be
+      cleaned
+
+A default dictionary is included with this project, but only contains some test data for you to get started.  These words can be accessed via the `Cleaner::Dictionary` object, which has several dictionaries:
+
+    Cleaner::Dictionary.words             => Array of words from the dictionary
+    Cleaner::Dictionary.replacement_chars => Array of characters to use for the `replace` method
+    Cleaner::Dictionary.file              => Filepath of the used dictionary file
+    Cleaner::Dictionary.cleaner_methods   => List of cleaner methods included in this release
+
+It works by  providing a new method to all of your ActiveRecord based objects called `clean`
+
+    class Widget < ActiveRecord::Base
+      clean :body, :with => :scramble
+    end
+
+This method takes an array of columns to be cleaned by cleanerupper, followed by two options:
+
+    :with     => specifies which method to clean with
+    :callback => specifies a callback to call if disallowed data is found
+
+Three method have been provided for cleaning convenience, which are:
+
+    :scramble => keeps all characters, but scrambles the word
+    :remove   => removes the word completely
+    :replace  => replaces all characters of the word with $%@^ text
+
+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
+
+      def custom(found)
+        Cleaner::Dictionary.words.each do |word|
+          found.gsub!(word, "CUSTOM") if found.include?(word)
+        end
+        return found
+      end
+    end
+
+In the example above, we make use of the word dictionary to check our column for bad words.
+
+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`).
+
+    class Widget < ActiveRecord::Base
+      clean :body, :with => :scramble, :callback => :found_words
+
+      def found_words
+        Emailer.email_teacher("Your student used a bad word!")
+        true
+      end
+    end
+
+
+Examples
+=======
+
+    # Clean different columns with different methods
+    class Widget < ActiveRecord::Base
+      clean :body, :title, :with => :replace
+      clean :author_name, :with => :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
+
+      def send_email
+        if self.author.infractions >= 1
+          Mailer.send_infraction(self.author)
+          return true
+        end
+        return false #Don't save this if they've already been notified about the rules!
+      end
+    end
+
+    # Custom cleaning method
+    class Widget < ActiveRecord::Base
+      clean :body, :title, :author_name, :with => :remove_vowels
+
+      def remove_vowels(found)
+        Cleaner::Dictionary.words.each do |word|
+          found.gsub!(/#{word}/, word.gsub(/(a|e|i|o|u)/, "")
+        end
+        return found
+      end
+    end
+
+# Copyright and Licensing #
+Copyright (c) 2010 Mike Trpcic (Fluid Media Inc.), released under the MIT license

data/cleanerupper.gemspec

@@ -5,23 +5,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cleanerupper}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mike Trpcic"]
-  s.date = %q{2010-04-09}
+  s.date = %q{2010-04-10}
   s.email = %q{mike@fluidmedia.com}
   s.extra_rdoc_files = [
-    "README"
+    "README.markdown"
   ]
   s.files = [
-    "./cleanerupper-0.1.0.gem",
+    "./README.markdown",
      "./cleanerupper.gemspec",
+     "./cleanerupper.sqlite3.db",
      "./dictionary.yml",
      "./init.rb",
      "./install.rb",
      "./lib/cleanerupper.rb",
      "./pkg/cleanerupper-0.0.0.gem",
+     "./pkg/cleanerupper-0.1.0.gem",
      "./rails/init.rb",
      "./tasks/cleanerupper_tasks.rake",
      "./test/cleanerupper_test.rb",
@@ -34,8 +36,13 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/fmiopensource/cleanerupper}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Simple database sanitation}
+  s.test_files = [
+    "test/schema.rb",
+     "test/cleanerupper_test.rb",
+     "test/test_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/dictionary.yml

@@ -1,3 +1,6 @@
 words:
-  default
-  dictionary
+  foo
+  bar
+  baz
+  test
+  hippopotamus

data/lib/cleanerupper.rb

@@ -53,8 +53,7 @@ module Cleaner
           new_value = self.send(method, old_value.dup)
         end
         unless new_value == old_value
-          #debugger
-          to_save = callback.nil? ? true : self.send(callback)
+          to_save = callback.nil? ? true : self.send(callback) == false ? false : true
           write_attribute(column, new_value) if to_save
         end
       end

data/test/debug.log

@@ -2339,3 +2339,51 @@
   CustomWidget Load (0.3ms)   SELECT * FROM "custom_widgets" WHERE ("custom_widgets"."id" = 1) 
   ScrambleWidget Create (0.2ms)   INSERT INTO "scramble_widgets" ("title", "body", "author_name") VALUES('cleanerupper eetda_stuftl body', NULL, NULL)
   ScrambleWidget Load (0.2ms)   SELECT * FROM "scramble_widgets" WHERE ("scramble_widgets"."id" = 2) 
+  SQL (0.4ms)   select sqlite_version(*)
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (29.3ms)   CREATE TABLE "widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (3.8ms)   CREATE TABLE "replace_widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (91.3ms)   CREATE TABLE "remove_widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (19.9ms)   CREATE TABLE "scramble_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 (3.8ms)   CREATE TABLE "custom_widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (260.9ms)   CREATE TABLE "callback_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 (5.2ms)   CREATE TABLE "false_callback_widgets" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(100), "body" varchar(255), "author_name" varchar(100)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (3.3ms)   CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+  SQL (25.8ms)   CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  SQL (3.5ms)   INSERT INTO "schema_migrations" (version) VALUES ('1')

data/test/test_helper.rb

@@ -3,7 +3,7 @@ require 'active_support'
 require 'active_support/test_case'
 
 if ENV['RAILS'].nil?
-  require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
+  require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb')) 
 else
   # specific rails version targeted
   # load activerecord and plugin manually
@@ -27,4 +27,4 @@ load(File.dirname(__FILE__) + "/schema.rb")
 require File.expand_path(File.dirname(__FILE__) + "/../lib/cleanerupper.rb")
 ENV["RAILS_ENV"] = "test"
 require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
-require 'test_help'
+require 'test_help'

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cleanerupper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mike Trpcic
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 -04:00
+date: 2010-04-10 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -20,15 +25,17 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.markdown
 files: 
-- ./cleanerupper-0.1.0.gem
+- ./README.markdown
 - ./cleanerupper.gemspec
+- ./cleanerupper.sqlite3.db
 - ./dictionary.yml
 - ./init.rb
 - ./install.rb
 - ./lib/cleanerupper.rb
 - ./pkg/cleanerupper-0.0.0.gem
+- ./pkg/cleanerupper-0.1.0.gem
 - ./rails/init.rb
 - ./tasks/cleanerupper_tasks.rake
 - ./test/cleanerupper_test.rb
@@ -37,7 +44,7 @@ files:
 - ./test/schema.rb
 - ./test/test_helper.rb
 - ./uninstall.rb
-- README
+- README.markdown
 has_rdoc: true
 homepage: http://github.com/fmiopensource/cleanerupper
 licenses: []
@@ -51,20 +58,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Simple database sanitation
-test_files: []
-
+test_files: 
+- test/schema.rb
+- test/cleanerupper_test.rb
+- test/test_helper.rb

data/README

@@ -1,40 +0,0 @@
-Cleanerupper
-============
-
-Cleanerupper can be used in any ActiveRecord based model to seamless clean, sanitize, and
-remove inappropriate or sensitive data.
-
-
-Examples
-=======
-
-class Widget < ActiveRecord::Base
-  #The primary use of CleanerUpper is to be used as
-  #before_save filters.
-
-  #This will scramble the data before it is saved:
-  scramble :body, :title
-
-  #This will remove the data before it is saved:
-  remove :body, :title
-
-  #This will replace the data before it is saved:
-  replace :body, :title
-
-  #You can also define a block if you are using multiple
-  #different cleaning methods:
-  cleaner do |c|
-    c.scramble :body
-    c.remove :title
-    c.replace :author_name
-  end
-end
-
-#You can also manually invoke the cleaning methods on an
-#instance of any ActiveRecord object like so:
-w = Widget.last
-w.clean(:body)
-w.scramble(:title)
-w.remove(:author_name)
-
-Copyright (c) 2010 Mike Trpcic (Fluid Media Inc.), released under the MIT license