strip_attributes 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 287d7a12033039a5d2f06d55433a9f613ad584886a4add18b78ff6f432455073
-  data.tar.gz: d30d2f78245bfce1534c0509366fa12cbb0bdea7945f2dd97547bb257a926053
+  metadata.gz: e52f0da3132c0ac375581d84279e40f5a118efd62880a094a46cbb99fcf38b2c
+  data.tar.gz: 3ffd42e6130993495406c5b32d5ba93e7b538f85b9295ac9d83f0cae9d65d132
 SHA512:
-  metadata.gz: 1e6fbbb056f4ad22e8d4d13c767f3ae2124ede7a7d39e5cffcb9a406be4f590cfbb0f495cf2c6ea0fa8efc1e750e2e333b8eb4467d1ffee582c36deabb2b1417
-  data.tar.gz: ec6311504c2dd730e4810cce0cd72aaf9a2ce5cdbe383214c7e8e46c98cacc82732f8304c90128646c26cc7f99c91227f2cb2f51fcc844d8265e04040db5a688
+  metadata.gz: a76db1928d1327ca44d834384679e7a1150e773f414c344d2469b02d144f2f8f103da8cd19664810dbb0d93e7b4dd4fb3a2afed2a8558c8d61a9027d30d23d03
+  data.tar.gz: 4a2085e2618d2d0e661b9b2dffc8741cad0b965a8b4342cc57fedd5a48e13cb70e444feb94ee1688c67051c5d6b747e9ebad29a0486b4a01a4bba34c1f2c32fd

data/README.md

@@ -13,6 +13,8 @@ attributes are stripped of whitespace, but `:only` and `:except`
 options can be used to limit which attributes are stripped.  Both options accept
 a single attribute (`only: :field`) or arrays of attributes (`except: [:field1, :field2, :field3]`).
 
+It's also possible to skip stripping the attributes altogether per model using the `:if` and `:unless` options.
+
 ---
 
 **How You Can Help**
@@ -67,6 +69,32 @@ class ConservativePokerPlayer < ActiveRecord::Base
 end
 ```
 
+### Using `if`
+
+```ruby
+# Only records with odd ids will be stripped
+class OddPokerPlayer < ActiveRecord::Base
+  strip_attributes if: :strip_me?
+
+  def strip_me?
+    id.odd?
+  end
+end
+```
+
+### Using `unless`
+
+```ruby
+# strip_attributes will be applied randomly
+class RandomPokerPlayer < ActiveRecord::Base
+  strip_attributes unless: :strip_me?
+
+  def strip_me?
+    [true, false].sample
+  end
+end
+```
+
 ### Using `allow_empty`
 
 ```ruby

data/lib/strip_attributes/version.rb

@@ -1,3 +1,3 @@
 module StripAttributes
-  VERSION = "1.8.1"
+  VERSION = "1.9.0"
 end

data/lib/strip_attributes.rb

@@ -2,24 +2,24 @@ require "active_model"
 
 module ActiveModel::Validations::HelperMethods
   # Strips whitespace from model fields and converts blank values to nil.
-  def strip_attributes(options = nil)
+  def strip_attributes(options = {})
     StripAttributes.validate_options(options)
 
-    before_validation do |record|
+    before_validation(options.slice(:if, :unless)) do |record|
       StripAttributes.strip(record, options)
     end
   end
 
   # <b>DEPRECATED:</b> Please use <tt>strip_attributes</tt> (non-bang method)
   # instead.
-  def strip_attributes!(options = nil)
+  def strip_attributes!(options = {})
     warn "[DEPRECATION] `strip_attributes!` is deprecated.  Please use `strip_attributes` (non-bang method) instead."
     strip_attributes(options)
   end
 end
 
 module StripAttributes
-  VALID_OPTIONS = [:only, :except, :allow_empty, :collapse_spaces, :replace_newlines, :regex]
+  VALID_OPTIONS = [:only, :except, :allow_empty, :collapse_spaces, :replace_newlines, :regex, :if, :unless]
 
   # Unicode invisible and whitespace characters.  The POSIX character class
   # [:space:] corresponds to the Unicode class Z ("separator"). We also
@@ -37,7 +37,7 @@ module StripAttributes
   MULTIBYTE_BLANK = /[[:blank:]#{MULTIBYTE_WHITE}]/
   MULTIBYTE_SUPPORTED  = "\u0020" == " "
 
-  def self.strip(record_or_string, options = nil)
+  def self.strip(record_or_string, options = {})
     if record_or_string.respond_to?(:attributes)
       strip_record(record_or_string, options)
     else
@@ -45,7 +45,7 @@ module StripAttributes
     end
   end
 
-  def self.strip_record(record, options = nil)
+  def self.strip_record(record, options = {})
     attributes = narrow(record.attributes, options)
 
     attributes.each do |attr, value|
@@ -57,13 +57,11 @@ module StripAttributes
     record
   end
 
-  def self.strip_string(value, options = nil)
-    if options
-      allow_empty      = options[:allow_empty]
-      collapse_spaces  = options[:collapse_spaces]
-      replace_newlines = options[:replace_newlines]
-      regex            = options[:regex]
-    end
+  def self.strip_string(value, options = {})
+    allow_empty      = options[:allow_empty]
+    collapse_spaces  = options[:collapse_spaces]
+    replace_newlines = options[:replace_newlines]
+    regex            = options[:regex]
 
     if value.respond_to?(:strip)
       value = (value.blank? && !allow_empty) ? nil : value.strip
@@ -97,10 +95,10 @@ module StripAttributes
   # Necessary because Rails has removed the narrowing of attributes using :only
   # and :except on Base#attributes
   def self.narrow(attributes, options = {})
-    if except = options && options[:except]
+    if except = options[:except]
       except = Array(except).collect { |attribute| attribute.to_s }
       attributes.except(*except)
-    elsif only = options && options[:only]
+    elsif only = options[:only]
       only = Array(only).collect { |attribute| attribute.to_s }
       attributes.slice(*only)
     else
@@ -109,7 +107,7 @@ module StripAttributes
   end
 
   def self.validate_options(options)
-    if keys = options && options.keys
+    if keys = options.keys
       unless (keys - VALID_OPTIONS).empty?
         raise ArgumentError, "Options does not specify #{VALID_OPTIONS} (#{options.keys.inspect})"
       end

data/test/strip_attributes_test.rb

@@ -9,6 +9,8 @@ module MockAttributes
     base.attribute :bang
     base.attribute :foz
     base.attribute :fiz
+    base.attribute :strip_me
+    base.attribute :skip_me
   end
 end
 
@@ -72,6 +74,29 @@ class StripRegexMockRecord < Tableless
   strip_attributes regex: /[\^\%&\*]/
 end
 
+class IfSymMockRecord < Tableless
+  include MockAttributes
+  strip_attributes if: :strip_me?
+
+  def strip_me?
+    strip_me
+  end
+end
+
+class UnlessSymMockRecord < Tableless
+  include MockAttributes
+  strip_attributes unless: :skip_me?
+
+  def skip_me?
+    skip_me
+  end
+end
+
+class IfProcMockRecord < Tableless
+  include MockAttributes
+  strip_attributes if: Proc.new { |record| record.strip_me }
+end
+
 class StripAttributesTest < Minitest::Test
   def setup
     @init_params = {
@@ -242,6 +267,78 @@ class StripAttributesTest < Minitest::Test
     assert_equal "foo",      record.foo
   end
 
+  def test_should_strip_all_fields_if_true
+    record = IfSymMockRecord.new(@init_params.merge(strip_me: true))
+    record.valid?
+    assert_equal "foo",         record.foo
+    assert_equal "bar",         record.bar
+    assert_equal "biz",         record.biz
+    assert_equal "foz  foz",    record.foz
+    assert_equal "fiz \n  fiz", record.fiz
+    assert_nil record.baz
+    assert_nil record.bang
+  end
+
+  def test_should_strip_no_fields_if_false
+    record = IfSymMockRecord.new(@init_params.merge(strip_me: false))
+    record.valid?
+    assert_equal "\tfoo",       record.foo
+    assert_equal "bar \t ",     record.bar
+    assert_equal "\tbiz ",      record.biz
+    assert_equal " foz  foz",   record.foz
+    assert_equal "fiz \n  fiz", record.fiz
+    assert_equal "",            record.baz
+    assert_equal " ",           record.bang
+  end
+
+  def test_should_strip_all_fields_unless_false
+    record = UnlessSymMockRecord.new(@init_params.merge(skip_me: false))
+    record.valid?
+    assert_equal "foo",         record.foo
+    assert_equal "bar",         record.bar
+    assert_equal "biz",         record.biz
+    assert_equal "foz  foz",    record.foz
+    assert_equal "fiz \n  fiz", record.fiz
+    assert_nil record.baz
+    assert_nil record.bang
+  end
+
+  def test_should_strip_no_fields_unless_true
+    record = UnlessSymMockRecord.new(@init_params.merge(skip_me: true))
+    record.valid?
+    assert_equal "\tfoo",       record.foo
+    assert_equal "bar \t ",     record.bar
+    assert_equal "\tbiz ",      record.biz
+    assert_equal " foz  foz",   record.foz
+    assert_equal "fiz \n  fiz", record.fiz
+    assert_equal "",            record.baz
+    assert_equal " ",           record.bang
+  end
+
+  def test_should_strip_all_fields_if_true_proc
+    record = IfProcMockRecord.new(@init_params.merge(strip_me: true))
+    record.valid?
+    assert_equal "foo",         record.foo
+    assert_equal "bar",         record.bar
+    assert_equal "biz",         record.biz
+    assert_equal "foz  foz",    record.foz
+    assert_equal "fiz \n  fiz", record.fiz
+    assert_nil record.baz
+    assert_nil record.bang
+  end
+
+  def test_should_strip_no_fields_if_false_proc
+    record = IfProcMockRecord.new(@init_params.merge(strip_me: false))
+    record.valid?
+    assert_equal "\tfoo",       record.foo
+    assert_equal "bar \t ",     record.bar
+    assert_equal "\tbiz ",      record.biz
+    assert_equal " foz  foz",   record.foz
+    assert_equal "fiz \n  fiz", record.fiz
+    assert_equal "",            record.baz
+    assert_equal " ",           record.bang
+  end
+
   class ClassMethodsTest < Minitest::Test
     def test_should_strip_whitespace
       assert_nil StripAttributes.strip("")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strip_attributes
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Ryan McGeary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel