html_terminator 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html_terminator.gemspec
+gemspec
+
+group :test do
+  gem 'activerecord', '~> 2.3.0'
+  gem 'sqlite3'
+  gem 'guard-rspec'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--colour --format nested' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steel Fu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+```
+　　　　　　　　　　　　　　　　　　　　　　　　　　＿ _
+　　　　　 r┐　　　　　　　　　　　　　　　,r:ｰ'´.::.:: .:..｀ヽ、
+　　　　　 |i |　　　　　　　　　　　 　 　 f´.::.,__.:::::..::::::::::::::ヽ
+　　　　　 |l |　　　　　　　　　　　　　　ﾁr'´　　 ￣￣ヾ;::.:.|
+　　　　 ,ｒ1｜　　　　　　　　　　　　　 ｷ| _＿ '´ ＿_ 　l;::..l
+　　　　 |ｌ |｜　　　　　　　　　　　　　　}撻鬱ij!'徼i匐}ﾚ''１
+　　　　 |lr' i|　　　　　　　　　　　　　 　f{｀~゛ﾂ; ヾ~´　iﾉ｝|
+　　　　 ||ｌ　l|　　　　　　　　　　　 　 　 ぃ　　´'_｀　　　Y´
+　　　　 |||　l|　　　　　　　　　　　　　　　 ﾄ､ ´￣ ｀　,ｨ{
+　　　　 |||　i|　　　　　 　 　 　 　 　 　 　 |　｀ｰ-‐ '　　}｀iー -- ､
+　　　　 |||　l|　　　　　　　　　　　　　　　 ,!　i　　 /　ノ　 l　_,シ ム
+　　　　 |||　l|　　　　　　　　　　　　　　 〃ﾄ､＿,,,. ;i'ﾒ　　｜/ ,／　 ＼
+　　　　｜! ∥　　　　　　　　　　　　 ／/lliiiiiiiiiiiiiiiill/{r―‐^ i〃/　　　 ヽ
+　　　　｜ｌ ∥　　　　　　　　　 　 ／ ,ｲllliiiiiiiiiiiiillll/´　 ／r- ゝ 　' 　 　 l
+　　　　｜| ∥　　　　　　 　 　 ／ ／´ﾌliiiiiiiiiilllll/　, 　／　　 |/　　　　｜
+　　　　 jｌj　ｌ|　　　　 　 　 　 / ir'　 　 |liiiiiiiilllllli'　　／　　　　|　　　ーイ、
+　　　　ﾑ- 、|　　　　　 　 　 ﾊ |, 　　 /iiiiillllllllll|　 /　　　　　 |　　　　　　i
+　　　 ﾉ　　 ｀i　　　　　　　 /　ｌj　　 /llllllllllllllllll{／　　　　　　 l　　　　　　|
+　　　 ヽ　　 /　 　 　 　 　 ｌ　｜　 /llllliillllllllllllll|　　　　　　 　 |　　　　 　 |
+　　 ､r┤　,ﾑ､　　　　　 　 | ヽ|　 /lliiiiiiiiiillllllllllll}　　　 　 　 　 |　　　　　　|
+　　 '{ヽ'r_'__　i　　 　 　 　 〉　 l　|iiiiiiiiiiiiiiilllllllllll|　　　　　　　　|　、　　　　|
+　　 /〉ｰ-{　ｿト 、　　 　 / 　 ｜|iiiiiiiiiiiiiiiiiillllllll!、　　　　　　　|　　二　　 |
+　　 しt_;ｭ',//　　 ヽ、 ／　　　 | |iiiiiiiiiiiiiiiiiiiiillllllヽ、　　　　 　 |　　　　｀　|
+　 　 （_,イｰ'　　　 　 ´　　　　　| |iiiiiiiiiiiiiiiiiiiiiiiiiiiiiillヽ、　　　　 ||　　　 ヽ　|
+　　　　 └-､ 　　ノ´　 　 　 　 | |iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii|　　　　　||　　　　　 |
+```
+
+# HtmlTerminator
+
+Visits Active Record fields and terminates unsafe HTML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'html_terminator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html_terminator
+
+## Usage
+
+In your Rails models:
+
+    terminate_html :field1, :field2, :field3
+
+or
+
+    terminate_html :except => [:field8, :field9]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/html_terminator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html_terminator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html_terminator"
+  spec.version       = HtmlTerminator::VERSION
+  spec.authors       = ["Steel Fu", "Matt Diebolt"]
+  spec.email         = ["steel@polleverywhere.com", "matt@polleverywhere.com"]
+  spec.description   = %q{Terminate Active Records fields of html}
+  spec.summary       = %q{Terminate Active Records fields of html}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "sanitize"
+end

data/lib/html_terminator.rb

@@ -0,0 +1,69 @@
+require "html_terminator/version"
+require 'sanitize'
+
+module HtmlTerminator
+  SANITIZE_OPTIONS = {
+    :elements => ["b", "em", "i", "strong", "u", "br"]
+  }
+
+  def self.sanitize(val)
+    Sanitize.clean(val, SANITIZE_OPTIONS).strip
+  end
+
+  module ClassMethods
+    def terminate_html(*args)
+      class_attribute :html_terminator_fields
+
+      # By default all fields are to be seen by the terminator
+      self.html_terminator_fields = self.columns.inject([]) do |list, col|
+        if col.type == :string or col.type == :text
+          list << col.name.to_sym
+        end
+
+        list
+      end
+
+      if args.length == 1
+        if args[0].is_a?(Symbol)
+          self.html_terminator_fields = args
+        elsif args[0].is_a?(Object)
+          self.html_terminator_fields -= (args[0][:except] || [])
+        end
+      elsif args.length > 1
+        self.html_terminator_fields = args
+      end
+
+      unless self.html_terminator_fields.empty?
+        # sanitize writes
+        before_validation :terminate_html
+
+        # sanitize reads
+        self.html_terminator_fields.each do |attr|
+          define_method "#{attr}" do |*args|
+            # sanitize it
+            HtmlTerminator.sanitize super(*args)
+          end
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    def terminate_html
+      self.html_terminator_fields.each do |field|
+        value = self[field]
+
+        unless value.nil?
+          self[field] = HtmlTerminator.sanitize(value)
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :include, InstanceMethods
+  end
+end
+
+ActiveRecord::Base.send :include, HtmlTerminator

data/lib/html_terminator/version.rb

@@ -0,0 +1,3 @@
+module HtmlTerminator
+  VERSION = "0.0.1"
+end

data/spec/html_terminator_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe HtmlTerminator do
+  it "should terminate name only fields specified" do
+    @user = User.new
+
+    @user.first_name = "Hello <img>"
+    @user.first_name.should == "Hello"
+
+    @user.last_name = "Hello <img>"
+    @user.last_name.should == "Hello <img>"
+
+    @user.age = 3
+    @user.age.should == 3
+  end
+
+  it "should terminate all except what is specified" do
+    @student = Student.new
+
+    @student.first_name = "Hello <img>"
+    @student.first_name.should == "Hello <img>"
+
+    @student.last_name = "Hello <img>"
+    @student.last_name.should == "Hello"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'support/active_record'

data/spec/support/active_record.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+require 'html_terminator'
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+})
+
+ActiveRecord::Schema.define do
+  create_table "users", :force => true do |t|
+    t.column "first_name",  :text
+    t.column "last_name",  :text
+    t.column "age", :integer
+  end
+
+  create_table "students", :force => true do |t|
+    t.column "first_name",  :text
+    t.column "last_name",  :text
+    t.column "age", :integer
+  end
+end
+
+class User < ActiveRecord::Base
+  include HtmlTerminator
+
+  terminate_html :first_name
+end
+
+class Student < ActiveRecord::Base
+  include HtmlTerminator
+
+  terminate_html :except => [:first_name]
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: html_terminator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steel Fu
+- Matt Diebolt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Terminate Active Records fields of html
+email:
+- steel@polleverywhere.com
+- matt@polleverywhere.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- html_terminator.gemspec
+- lib/html_terminator.rb
+- lib/html_terminator/version.rb
+- spec/html_terminator_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Terminate Active Records fields of html
+test_files:
+- spec/html_terminator_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb