html_terminator 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39b8f069bc265e35b278f46ef68fc414ef234ee5
-  data.tar.gz: 0a5fa89a7c15d585814ce420d14b51711b479ab7
+  metadata.gz: ed1a46465f0b8d627c1b92e47e232373f2dd71ec
+  data.tar.gz: 717809ee3bd7bd73895f2b2a558c6335e720679c
 SHA512:
-  metadata.gz: 4f4125c44661d12232e5200bc5a505cecb1a372457c62c6d94c1b0d37b3854ba6bf5460680a605b6baab66066a7dda81134aa5c0993ca523e250cad0066e08bc
-  data.tar.gz: cc2bfdb08ce2b0c7fa78f60e127cd0cacb931c2335e5ef9bc189bab5f2f6a963e6838647c272f48664c5edd02dd9c7bb03c506a9faba67b2682363022e7a21f0
+  metadata.gz: 66c00ffa3ac6b4a8f5667bbd0ebef76d84d92bfad7bb922c1f71173dfc321df40364836db52e2d0af360f9ca83d05a4761f30265719fdd02c7cc353d8d788a4c
+  data.tar.gz: 5e86b8127abfc48f721a25828f2684b61e3197b06a44383cf81d8f65c85fdc28e5e72b69698fe98d41fd8d6ade625eff1ba6e096b47d1c89b134f79be9580cc9

data/README.md

@@ -56,6 +56,14 @@ 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"]
+
+Learn more about configuration options [Here](https://github.com/rgrove/sanitize#custom-configuration)
+
 ## Contributing
 
 1. Fork it

data/lib/html_terminator/extract_options.rb

@@ -0,0 +1,29 @@
+class Hash
+  # By default, only instances of Hash itself are extractable.
+  # Subclasses of Hash may implement this method and return
+  # true to declare themselves as extractable. If a Hash
+  # is extractable, Array#extract_options! pops it from
+  # the Array when it is the last element of the Array.
+  def extractable_options?
+    instance_of?(Hash)
+  end
+end
+
+class Array
+  # Extracts options from a set of arguments. Removes and returns the last
+  # element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)        # => {}
+  #   options(1, 2, a: :b) # => {:a=>:b}
+  def extract_options!
+    if last.is_a?(Hash) && last.extractable_options?
+      pop
+    else
+      {}
+    end
+  end
+end

data/lib/html_terminator/version.rb

@@ -1,3 +1,3 @@
 module HtmlTerminator
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/html_terminator.rb

@@ -1,28 +1,26 @@
 require "html_terminator/version"
+require "html_terminator/extract_options"
 require 'sanitize'
 
 module HtmlTerminator
   SANITIZE_OPTIONS = {
-    :elements => ["b", "em", "i", "strong", "u", "br"]
+    :elements => []
   }
 
-  def self.sanitize(val)
-    if val.is_a?(String) && !skip_sanitize?(val)
-      Sanitize.fragment(val, SANITIZE_OPTIONS).strip.gsub(/&/, "&")
+  def self.sanitize(val, config)
+    if val.is_a?(String)
+      # Sanitize produces escaped content.
+      # Unescape it to get the raw html
+      CGI.unescapeHTML Sanitize.fragment(val, config).strip
     else
       val
     end
   end
 
-  # Don't sanitize if only one bracket is present.
-  # Without this, "1 < 2" gets incorrectly sanitized as "1".
-  def self.skip_sanitize?(val)
-    val.count("<") + val.count(">") == 1
-  end
-
   module ClassMethods
     def terminate_html(*args)
       class_attribute :html_terminator_fields
+      class_attribute :html_terminator_options
 
       # Table may not exist yet when schema is initially getting loaded
       if self.table_exists?
@@ -35,15 +33,12 @@ module HtmlTerminator
           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
+        self.html_terminator_options = SANITIZE_OPTIONS.merge(args.extract_options!)
+        self.html_terminator_fields = args if args.length > 0
+
+        # Handle exceptions
+        exceptions = self.html_terminator_options.delete(:except) || []
+        self.html_terminator_fields -= (exceptions)
 
         unless self.html_terminator_fields.empty?
           # sanitize writes
@@ -53,7 +48,7 @@ module HtmlTerminator
           self.html_terminator_fields.each do |attr|
             define_method(attr) do |*rargs|
               # sanitize it
-              HtmlTerminator.sanitize super(*rargs)
+              HtmlTerminator.sanitize super(*rargs), self.html_terminator_options
             end
           end
         end
@@ -67,7 +62,7 @@ module HtmlTerminator
         value = self[field]
 
         unless value.nil?
-          self[field] = HtmlTerminator.sanitize(value)
+          self[field] = HtmlTerminator.sanitize(value, self.html_terminator_options)
         end
       end
     end

data/spec/html_terminator_spec.rb

@@ -59,4 +59,10 @@ describe HtmlTerminator do
     @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>"
+  end
 end

data/spec/support/active_record.rb

@@ -18,6 +18,12 @@ ActiveRecord::Schema.define do
     t.column "last_name",  :text
     t.column "age", :integer
   end
+
+  create_table "first_name_with_options", :force => true do |t|
+    t.column "first_name",  :text
+    t.column "last_name",  :text
+    t.column "age", :integer
+  end
 end
 
 class OnlyFirstName < ActiveRecord::Base
@@ -30,4 +36,10 @@ class ExceptFirstName < ActiveRecord::Base
   include HtmlTerminator
 
   terminate_html :except => [:first_name]
-end
+end
+
+class FirstNameWithOptions < ActiveRecord::Base
+  include HtmlTerminator
+
+  terminate_html :first_name, :elements => ["flexbox"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_terminator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Steel Fu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - html_terminator.gemspec
 - lib/html_terminator.rb
+- lib/html_terminator/extract_options.rb
 - lib/html_terminator/version.rb
 - spec/html_terminator_spec.rb
 - spec/spec_helper.rb
@@ -102,4 +103,3 @@ test_files:
 - spec/html_terminator_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
-has_rdoc: