html_terminator 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd4d0609098d033eece8510d9bee3dbd0cb09966
-  data.tar.gz: 96b86b54353b1b72afe70eac1fbed82257cc2896
+  metadata.gz: 0bb5210795341af31d333be566cb6ff673a4dce3
+  data.tar.gz: 00589ce6418e7af7f0ef38670eaf3fce10abfbd2
 SHA512:
-  metadata.gz: 650230f42f73afa03d5bcf6c37dc76e3cd253a5704a6bef83196a49b49d9847b39141b6f47be404681df422272cbd024f379f0b42595e17bee79eedcf4d55115
-  data.tar.gz: 4e0fa09f6dbb339404b9fd2c95d167ede09980151ff8f82c0bd3eb78c1eccc2067a05c256b993efdff4a1bfd513516ea7e323254b5ca31409b9a31931b695ebc
+  metadata.gz: 9426fa5939c9b35d2bdc8b5c2944b02554fd005179db9b24c4312640aa6e8aa4cadd6c929a6a46eb813a514afae51074c3e58c2090020b79fc55710b75ac9d92
+  data.tar.gz: dd1f6ad48c8326aee8c3b22e5c2709ebba530e64e55200673ffecbd2212358e374f569eecffe49d8e6f2e4c47a0a932a13d2c09d53d795810c2f01a4d8d9fcfd

data/README.md

@@ -52,15 +52,13 @@ In your Rails models:
 
     terminate_html :field1, :field2, :field3
 
-or
-
-    terminate_html :except => [:field8, :field9]
-
 ## Options
 
 Out of the box, HTML Terminator will strip out ALL html. You can pass in specific elements you want to preserve like this:
 
     terminate_html :field1, :elements => ["b", "i", "em"]
+    terminate_html :field2, :elements => ["br"]
+    terminate_html :field3, :elements => ["em"]
 
 Learn more about configuration options [Here](https://github.com/rgrove/sanitize#custom-configuration)
 

data/lib/html_terminator/version.rb

@@ -1,3 +1,3 @@
 module HtmlTerminator
-  VERSION = "2.0.2"
-end
+  VERSION = "3.0.0"
+end

data/lib/html_terminator.rb

@@ -18,37 +18,42 @@ module HtmlTerminator
   end
 
   module ClassMethods
-    def terminate_html(*args)
-      class_attribute :html_terminator_fields
-      class_attribute :html_terminator_options
+    def fields
+      self.columns.inject([]) do |list, col|
+        if col.type == :string or col.type == :text
+          list << col.name.to_sym
+        end
+
+        list
+      end
+    end
 
+    def terminate_html(*args)
       # Table may not exist yet when schema is initially getting loaded
       if self.table_exists?
-        # 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
+        # object key/value of field => options
+        unless method_defined?(:html_terminator_fields)
+          class_attribute :html_terminator_fields
+          self.html_terminator_fields = {}
         end
 
-        self.html_terminator_options = SANITIZE_OPTIONS.merge(args.extract_options!)
-        self.html_terminator_fields = args if args.length > 0
+        options = args.extract_options!
+        options = SANITIZE_OPTIONS.clone.merge(options)
 
-        # Handle exceptions
-        exceptions = self.html_terminator_options.delete(:except) || []
-        self.html_terminator_fields -= (exceptions)
+        valid_fields = self.fields & args
+
+        valid_fields.each do |field|
+          self.html_terminator_fields[field] = options.deep_dup
+        end
 
         unless self.html_terminator_fields.empty?
-          # sanitize writes
           before_validation :terminate_html
 
           # sanitize reads
-          self.html_terminator_fields.each do |attr|
+          valid_fields.each do |attr|
             define_method(attr) do |*rargs|
               # sanitize it
-              HtmlTerminator.sanitize super(*rargs), self.html_terminator_options
+              HtmlTerminator.sanitize super(*rargs), options
             end
           end
         end
@@ -58,11 +63,11 @@ module HtmlTerminator
 
   module InstanceMethods
     def terminate_html
-      self.html_terminator_fields.each do |field|
+      self.html_terminator_fields.each do |field, options|
         value = self[field]
 
         unless value.nil?
-          self[field] = HtmlTerminator.sanitize(value, self.html_terminator_options)
+          self[field] = HtmlTerminator.sanitize(value, options)
         end
       end
     end

data/spec/html_terminator_spec.rb

@@ -1,69 +1,53 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe HtmlTerminator do
   it "sanitizes only fields specified" do
-    @user = OnlyFirstName.new
+    user = OnlyFirstName.new
 
-    @user.first_name = "Hello <img>"
-    @user.first_name.should == "Hello"
+    user.first_name = "Hello <img>"
+    user.first_name.should == "Hello"
 
-    @user.last_name = "Hello <img>"
-    @user.last_name.should == "Hello <img>"
+    user.last_name = "Hello <img>"
+    user.last_name.should == "Hello <img>"
 
-    @user.age = 3
-    @user.age.should == 3
+    user.age = 3
+    user.age.should == 3
   end
 
   it "doesn't escape ampersands" do
-    @user = OnlyFirstName.new
+    user = OnlyFirstName.new
 
-    @user.first_name = "A & B & C"
-    @user.first_name.should == "A & B & C"
+    user.first_name = "A & B & C"
+    user.first_name.should == "A & B & C"
   end
 
   it "skips sanitize when only one bracket" do
-    @user = OnlyFirstName.new
+    user = OnlyFirstName.new
 
-    @user.first_name = "1 < 2"
-    @user.first_name.should == "1 < 2"
+    user.first_name = "1 < 2"
+    user.first_name.should == "1 < 2"
 
-    @user.first_name = "2 > 1"
-    @user.first_name.should == "2 > 1"
+    user.first_name = "2 > 1"
+    user.first_name.should == "2 > 1"
   end
 
   it "handles ampersands" do
-    @user = OnlyFirstName.new
+    user = OnlyFirstName.new
 
-    @user.first_name = "Mr. & Mrs. Smith"
-    @user.first_name.should == "Mr. & Mrs. Smith"
-  end
-
-  it "sanitizes all except what is specified" do
-    @user = ExceptFirstName.new
-
-    @user.first_name = "Hello <img>"
-    @user.first_name.should == "Hello <img>"
-
-    @user.last_name = "Hello <img>"
-    @user.last_name.should == "Hello"
-  end
-
-  it "doesn't blow up if value is nil" do
-    @user = ExceptFirstName.new
-    @user.first_name = nil
-    @user.first_name.should == nil
+    user.first_name = "Mr. & Mrs. Smith"
+    user.first_name.should == "Mr. & Mrs. Smith"
   end
 
   it "doesn't blow up if value is not a string" do
-    @user = OnlyFirstName.new
-    @user.first_name = 1
-    @user.first_name.should == "1"
+    user = OnlyFirstName.new
+    user.first_name = 1
+    user.first_name.should == "1"
   end
 
   it "honors options that are passed in" do
-    @user = FirstNameWithOptions.new
-    @user.first_name = "Hello <flexbox></flexbox><hr><br><img>"
-    @user.first_name.should == "Hello <flexbox></flexbox>"
+    user = FirstNameWithOptions.new
+    user.first_name = "Hello <flexbox></flexbox><hr><br><img>"
+    user.first_name.should == "Hello <flexbox></flexbox>"
   end
 
   describe "#sanitize" do
@@ -77,4 +61,23 @@ describe HtmlTerminator do
       val.html_safe?.should == true
     end
   end
+
+  it "sanitizes different fields with different options" do
+    user = TwoFieldsWithOptions.new
+    user.first_name = "Hello <br><strong>strong</strong><em>em</em>"
+    user.last_name = "Hello <br><strong>strong</strong><em>em</em>"
+
+    user.first_name.should == "Hello  <strong>strong</strong>em"
+    user.last_name.should == "Hello  strong<em>em</em>"
+  end
+
+  it "sanitizes on validation" do
+    user = TwoFieldsWithOptions.new
+    user.first_name = "Hello <br><strong>strong</strong><em>em</em>"
+    user.last_name = "Hello <br><strong>strong</strong><em>em</em>"
+    user.valid?
+
+    user.read_attribute(:first_name).should == "Hello  <strong>strong</strong>em"
+    user.read_attribute(:last_name).should == "Hello  strong<em>em</em>"
+  end
 end

data/spec/support/active_record.rb

@@ -13,7 +13,7 @@ ActiveRecord::Schema.define do
     t.column "age", :integer
   end
 
-  create_table "except_first_names", :force => true do |t|
+  create_table "two_fields_with_options", :force => true do |t|
     t.column "first_name",  :text
     t.column "last_name",  :text
     t.column "age", :integer
@@ -32,10 +32,11 @@ class OnlyFirstName < ActiveRecord::Base
   terminate_html :first_name
 end
 
-class ExceptFirstName < ActiveRecord::Base
+class TwoFieldsWithOptions < ActiveRecord::Base
   include HtmlTerminator
 
-  terminate_html :except => [:first_name]
+  terminate_html :first_name, elements: ["strong"]
+  terminate_html :last_name, elements: ["em"]
 end
 
 class FirstNameWithOptions < ActiveRecord::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_terminator
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Steel Fu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler