mm-sanitize 0.1.3 → 0.1.4

data/README.rdoc

@@ -22,13 +22,32 @@ Once it's loaded into a model, configure with 'sanitize'
     sanitize :list, :of, :keys
 
 This will use the default Sanitize config, if you want to override then set the :config option:
-  
+
     # Use the built-in Sanitize::Config::RESTRICTED configuration
     sanitize :title, :config => Sanitize::Config::RESTRICTED
-    
+
     # Use a custom configuration
     sanitize :description, :config => {:elements => ['a', 'span']}
-    
+
+The original text is stored as original_#{key}, for example:
+
+    class Item
+      key :description, String
+
+      sanitize :description
+    end
+
+    item = Item.create(:description => "some <b>text</b>")
+    item.description => "some text"
+    item.original_description => "some <b>text</b>"
+
+IMPORTANT - calling sanitize sets up original_#{key} as a copy of the existing key if it exists
+If the key doesn't yet exist, it will assume it's a String field, so if you use something different then make sure to define it first.
+
+You can disable this behaviour by setting :keep_original to false
+
+    sanitize :description, :keep_original => false
+
 See the Sanitize Docs (https://github.com/rgrove/sanitize) for more details on the different configuration options.
 
 == Note on Patches/Pull Requests

data/Rakefile

@@ -21,7 +21,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "mm-sanitize"
-  s.version           = "0.1.3"
+  s.version           = "0.1.4"
   s.summary           = "Tiny plugin for MongoMapper to sanitize strings before validation."
   s.author            = "Richard Livsey"
   s.email             = "youremail@example.com"

data/lib/mm-sanitize.rb

@@ -9,17 +9,33 @@ module MongoMapper
       end
 
       module ClassMethods
-        def sanitize(*keys)
+        def sanitize(*args)
           unless defined?(sanitize_keys)
             class_attribute :sanitize_keys
           end
 
-          options = keys.pop if keys.last.is_a?(Hash)
-          options ||= {}
+          options = {
+            :config         => {},
+            :keep_original  => true
+          }
+
+          if args.last.is_a?(Hash)
+            options = options.merge(args.pop)
+          end
 
           self.sanitize_keys ||= {}
-          keys.each do |key|
-            self.sanitize_keys[key] = options[:config]
+          args.each do |key_name|
+            self.sanitize_keys[key_name] = options
+
+            if options[:keep_original]
+              if key_definition = self.keys[key_name]
+                key_type = key_definition.type
+              else
+                key_type = String
+              end
+
+              self.key :"original_#{key_name}", key_type
+            end
           end
 
           self.send(:before_validation, :sanitize_attributes)
@@ -28,16 +44,19 @@ module MongoMapper
 
       module InstanceMethods
         def sanitize_attributes
-          self.class.sanitize_keys.each do |key, config|
-            config ||= {}
+          self.class.sanitize_keys.each do |key, options|
+
+            if options[:keep_original]
+              self["original_#{key}"] = self[key]
+            end
 
             if val = self[key]
               if val.is_a?(Array) || val.is_a?(Set)
-                self[key] = val.collect{|v| ::Sanitize.clean(v, config) }
+                self[key] = val.collect{|v| ::Sanitize.clean(v, options[:config]) }
               elsif val.is_a?(Hash)
-                self[key] = val.each{|k, v| val[k] = ::Sanitize.clean(v, config) if v.is_a?(String) }
+                self[key] = val.each{|k, v| val[k] = ::Sanitize.clean(v, options[:config]) if v.is_a?(String) }
               elsif val.is_a?(String)
-                self[key] = ::Sanitize.clean(val, config)
+                self[key] = ::Sanitize.clean(val, options[:config])
               end
             end
           end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mm-sanitize
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Richard Livsey
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +00:00
+date: 2011-03-02 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency