sanitize_html_fields 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bb035ebe582cfbf7cd155380a703c7c1b333bfe
+  data.tar.gz: 4538080fa7c9d2e99a42ba56375da6c98bdb9e33
+SHA512:
+  metadata.gz: a5cd41024ea93f971e57a904ca08dbff42fe91a8d9a5fa2bf1e975175c7c282d3fc0edbdf650706649354459c2a13e536fecd32932ab6e8c15193a2dfbfc007e
+  data.tar.gz: 2494aeaad09c1b4d1a7479cb2361e2adb3e3107002e3ea923af6efea86d19ce33d98fe4c0c454b2ed9e713eb5d5ee7987b5bf48c0c6783034555d8ce5b821aba

data/.gitignore

@@ -0,0 +1,11 @@
+/sanitize_html_fields-1.0.0.gem
+/.idea
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sanitize_html_fields.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kai Straßmann
+
+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,47 @@
+# SanitizeHtmlFields
+
+This is a tiny gem that sanitizes html when an instance of ActiveRecord is saved.
+
+The gem automatically picks up all String columns of a model that have a corresponding `$name_html` column and sanitizes them using the standard Rails `ActionView::Helpers::SanitizeHelper#sanitize` method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sanitize_html_fields'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanitize_html_fields
+
+## Usage
+Just add sanitize_html_fields to one of your ActiveRecord model classes and you're ready to go!
+
+```ruby
+class MyModel < ActiveRecord::Base
+  sanitize_html_fields
+end
+```
+
+From now on SanitizeHtmlFields will automatically sanitize all of the model's String columns that have a corresponding `$name_html` column.
+
+Let's say your model has a 'text' column whose contents you'd like to be sanitized. In this case you need another String column named text_html.
+
+### Options
+You can pass an options hash to sanitize_html_fields which is then used for the individual calls to `ActionView::Helpers::SanitizeHelper#sanitize`.
+
+With an option hash you can for example allow certain tags or attributes using the `tags` and `attributes` key. See the documentation of [ActionView::Helpers::SanitizeHelper#sanitize](http://api.rubyonrails.org/classes/ActionView/Helpers/SanitizeHelper.html#method-i-sanitize) for more details.
+
+You can also use the `convert_newlines` key in the options hash to configure whether or not to convert line breaks to `<br>` tags. The default value for this option is `false`.
+
+The `remove_excessive_whitespaces` key is used to control if excessive whitespace characters (multiple spaces, linebreaks, tabs or newlines) should be removed. The default value for this option is `true`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/sanitize_html_fields.rb

@@ -0,0 +1,7 @@
+require 'sanitize_html_fields/version'
+require 'sanitize_html_fields/sanitize_html_fields'
+
+module SanitizeHtmlFields
+end
+
+ActiveRecord::Base.send(:include, SanitizeHtmlFields)

data/lib/sanitize_html_fields/sanitize_html_fields.rb

@@ -0,0 +1,43 @@
+module SanitizeHtmlFields
+
+  def self.included(base)
+    base.extend ActionView::Helpers::SanitizeHelper::ClassMethods
+    base.send :include, ActionView::Helpers::SanitizeHelper
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def sanitize_html_fields(options = {})
+      send :include, InstanceMethods
+      send :before_save, :convert_html_fields
+
+      cattr_accessor :shf_convert_newlines
+      self.shf_convert_newlines = options.delete(:convert_newlines) || false
+
+      cattr_accessor :shf_remove_excessive_whitespaces
+      self.shf_remove_excessive_whitespaces = options.delete(:remove_excessive_whitespaces) || true
+
+      cattr_accessor :shf_options
+      self.shf_options = options
+    end
+  end
+
+  module InstanceMethods
+    include ActionView::Helpers::SanitizeHelper
+    include SanitizeHtmlFields::ClassMethods
+
+    def convert_html_fields
+      options = self.class.shf_options
+      self.class.content_columns.each do |c|
+        if self.respond_to?("#{c.name}_html") && !self.send("#{c.name}").nil?
+
+          sanitized_html = sanitize(self.send("#{c.name}"), options)
+          sanitized_html.gsub!(/[\s\n\r\t]+\Z/, '') if self.class.shf_remove_excessive_whitespaces
+          sanitized_html.gsub!("\n", '<br />') if self.class.shf_convert_newlines
+
+          self.send("#{c.name}_html=", sanitized_html)
+        end
+      end
+    end
+  end
+end

data/lib/sanitize_html_fields/version.rb

@@ -0,0 +1,3 @@
+module SanitizeHtmlFields
+  VERSION = "1.0.0"
+end

data/sanitize_html_fields.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sanitize_html_fields/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sanitize_html_fields"
+  spec.version       = SanitizeHtmlFields::VERSION
+  spec.authors       = ["Kai Straßmann"]
+  spec.email         = ["derkai@gmail.com"]
+
+  spec.summary       = "This is a tiny gem that sanitizes html when a record is saved."
+  spec.homepage      = "https://github.com/cbot/sanitize_html_fields"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("activerecord", [">= 4.0"])
+  spec.add_dependency("actionview", [">= 4.0"])
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: sanitize_html_fields
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kai Straßmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- derkai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sanitize_html_fields.rb
+- lib/sanitize_html_fields/sanitize_html_fields.rb
+- lib/sanitize_html_fields/version.rb
+- sanitize_html_fields.gemspec
+homepage: https://github.com/cbot/sanitize_html_fields
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This is a tiny gem that sanitizes html when a record is saved.
+test_files: []