clean_room 0.1.0 → 0.1.1

data/lib/clean_room/air_lock.rb

@@ -0,0 +1,25 @@
+require 'sanitize'
+
+module CleanRoom
+  class AirLock
+    def shower(value, options)
+      if value
+        allow = options[:allow] || :plain_text
+
+        cleaned_value = case allow
+        when :html
+          Sanitize.clean(value, Sanitize::Config::RELAXED)
+        when :simple_html
+          Sanitize.clean(value, Sanitize::Config::BASIC)
+        when :strict
+          regex =  /[^#{options[:character_class] || "a-zA-Z0-9 "}]/
+          Sanitize.clean(value).gsub(regex, "")
+        else
+          Sanitize.clean(value)
+        end
+      else
+        nil
+      end
+    end      
+  end
+end

data/lib/clean_room/dsl.rb

@@ -0,0 +1,44 @@
+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
+end

data/lib/clean_room/exceptions.rb

@@ -0,0 +1,8 @@
+module CleanRoom
+  module Exceptions
+    class Contaminated < StandardError
+    end
+    class InvalidAttribute < StandardError
+    end
+  end
+end

data/lib/clean_room/version.rb

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

data/test/clean_room_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class CleanRoomTest < MiniTest::Unit::TestCase
+  def test_can_be_included
+
+    test_class = Class.new do 
+      include CleanRoom::DSL
+    end
+
+    test_class = Class.new do 
+      include CleanRoom::DSL
+      attr_accessor :field1
+
+      sanitize_attribute :field1
+    end
+
+    assert_raises CleanRoom::Exceptions::InvalidAttribute do
+      test_class = Class.new do 
+        include CleanRoom::DSL
+
+        sanitize_attribute :field1
+      end
+    end
+
+    attribute_test(:normal, nil, nil)
+    attribute_test(:normal, "test-test", "test-test")
+    attribute_test(:normal, "<b>test-test</b>", "test-test")
+    attribute_test(:strict, "<b>Test-tesT</b>", "TesttesT")
+    attribute_test(:very_strict, "<b>Test-tesT</b>", "esttes")
+    attribute_test(:simple_html, "<b>Test-tesT</b>", "<b>Test-tesT</b>")
+    attribute_test(:simple_html, "<b>Test-tesT</b><div>block</div><table><tr><td>table</td></tr></table>", "<b>Test-tesT</b> block table")
+    attribute_test(:html, "<b>Test-tesT</b><div>block</div><table><tr><td>table</td></tr></table>", "<b>Test-tesT</b> block <table><tr><td>table</td></tr></table>")
+  end
+
+
+  def attribute_test(field, value_in, value_out)
+    test_object.send("#{field}=".to_sym, value_in)
+    test_object.sanitize_attributes
+    assert_equal value_out, test_object.send(field)
+  end
+
+  def test_object
+    unless @test_object
+      test_class = Class.new do 
+        include CleanRoom::DSL
+        attr_accessor :normal, :strict, :very_strict, :simple_html, :html
+
+        sanitize_attribute :normal
+        sanitize_attribute :strict, allow: :strict
+        sanitize_attribute :very_strict, allow: :strict, character_class: "a-z"
+        sanitize_attribute :simple_html, allow: :simple_html
+        sanitize_attribute :html, allow: :html
+      end
+
+      @test_object = test_class.new
+    end
+    @test_object
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "minitest/autorun"
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$: << File.join(APP_ROOT, "lib")
+
+require "clean_room"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean_room
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   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: &70267688357280 !ruby/object:Gem::Requirement
+  requirement: &70355882688980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70267688357280
+  version_requirements: *70355882688980
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: &70267688375940 !ruby/object:Gem::Requirement
+  requirement: &70355882688480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70267688375940
+  version_requirements: *70355882688480
 description: Work in progress, this will be a generic attribute sanitizer which can
   be used for sanitizing models and other objects holding data
 email:
@@ -48,7 +48,12 @@ files:
 - Rakefile
 - clean_room.gemspec
 - lib/clean_room.rb
+- lib/clean_room/air_lock.rb
+- lib/clean_room/dsl.rb
+- lib/clean_room/exceptions.rb
 - lib/clean_room/version.rb
+- test/clean_room_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ahmeij/clean_room
 licenses: []
 post_install_message: 
@@ -73,4 +78,6 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: An attribute sanitizer
-test_files: []
+test_files:
+- test/clean_room_test.rb
+- test/test_helper.rb