clean_room 0.0.2 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # CleanRoom
 
-A class attribute sanitizer
+An attribute sanitizer (ruby 1.9) based on the sanitize gem by rgrove (https://github.com/rgrove/sanitize). Currently still dependant on active support, this requirement will be removed in the near future.
 
 ## Installation
 
@@ -18,12 +18,29 @@ Or install it yourself as:
 
 ## Usage
 
-WORK IN PROGRESS
+CleanRoom accepts any attributes for which readers and writers are available. The default is to sanitize and not allow any html in the field. Other settings can be configured with "allow" (see below). Allow accepts:
+
+* normal (or not set): no html
+* strict: no html + no characters except a-zA-Z0-9 and spaces. You can pass 'character_class' to specify your own character class of allowed characters
+* simple_html: allow the tags as by Sanitize::Config::BASIC
+* html: allow the tags as by Sanitize::Config::RELAXED
+
+  
+    class SanitizedAttributes
+      attr_accessor :normal, :strict, :very_strict, :simple_html, :html
+
+      sanitize_attribute :normal
+      sanitize_attribute :strict, allow: :strict, character_class: "a-z"
+      sanitize_attribute :simple_html, allow: :simple_html
+      sanitize_attribute :html, allow: :html
+    end
+
 
 ## Contributing
 
-1. Fork it
+1. Please fork it;
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+6. Many thanks!

data/clean_room.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency "activesupport", ">= 3.0.0"
+  gem.add_runtime_dependency "sanitize", ">= 2.0.0"
 
   gem.version       = CleanRoom::VERSION
 end

data/lib/clean_room/version.rb

@@ -1,3 +1,3 @@
 module CleanRoom
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/clean_room.rb

@@ -1,83 +1,6 @@
 require "active_support"
 
+require "clean_room/air_lock"
+require "clean_room/dsl"
+require "clean_room/exceptions"
 require "clean_room/version"
-
-module CleanRoom
-  module DSL
-    extend ActiveSupport::Concern
-
-    included do
-      self.sanitizable_attributes = {}
-
-      if respond_to? :before_save
-        before_save :sanitize_attributes
-      end
-    end
-
-    def sanitize_attributes
-      self.class.sanitizable_attributes.each do |name, options|
-        sanitize_attribute name, options
-      end
-    end
-
-    def sanitize_attribute(name, options = {})
-      current_value = self.send(name)
-      cleaned_value = air_lock.shower(current_value, options)
-
-      raise Exceptions::Contaminated.new("#{name} contained unacceptable data") if options[:raise] && (current_value != cleaned_value)
-      self.send("#{name}=".to_sym, cleaned_value)
-    end
-
-    def air_lock
-      @air_lock ||= AirLock.new
-    end
-
-    module ClassMethods
-      attr_accessor :sanitizable_attributes
-
-      def sanitize_attribute(name, options = {})
-        name = name.to_sym
-        if instance_methods.include?(name) && instance_methods.include?("#{name}=".to_sym)
-          sanitizable_attributes[name] = options
-        else
-          raise Exceptions::InvalidAttribute.new("#{self.class} does not respond to '#{name}(=)'")
-        end
-      end
-    end
-  end
-
-  module Exceptions
-    class Contaminated < StandardError
-    end
-    class InvalidAttribute < StandardError
-    end
-  end
-
-  class AirLock
-
-    def shower(value, options)
-      if value
-        allow = options[:allow] || :plain_text
-
-        cleaned_value = case allow
-        when :html
-
-        when :simple_html
-
-        else
-          value.gsub(/[^a-zA-Z0-9 ]/, "")
-        end
-      else
-        nil
-      end
-    end      
-
-    def sanitize(text)
-      #sanitizer.sanitize(text)
-    end
-
-    def sanitizer
-      #@sanitizer ||= HTML::WhiteListSanitizer.new
-    end
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean_room
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70341193917880 !ruby/object:Gem::Requirement
+  requirement: &70267688357280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70341193917880
+  version_requirements: *70267688357280
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: &70267688375940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70267688375940
 description: Work in progress, this will be a generic attribute sanitizer which can
   be used for sanitizing models and other objects holding data
 email: