strip_attributes 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e4b323cd614f1fe461e795f9639291ac5eda4db
-  data.tar.gz: 41546e168fb2fdf9220c1048b86cf2ddeca972b5
+  metadata.gz: ed934987322fa0c7a338d28649edd88a8520bf38
+  data.tar.gz: 2e1d75c6c7c5cb6b22e902cf3a80ebd22c5cf1aa
 SHA512:
-  metadata.gz: a632fd515e427df871254d544f625facdc50aedb24919499f261bea2d39a82401fce27410062186da237586e6962461197babb7988c0206917cb3a3c020423d8
-  data.tar.gz: 127b3edc8af1a095691071279ba760522b5e64dcff6d3793d575e77b7fb7508392e15e1421fecc1c780700d17d8bfba0785194763c286d34bf1e97072d44246e
+  metadata.gz: 061fb3c3a5325750dc31a3e3c501a04c8d8da8dcb9516a2f76660ce5af1d920b0113ccf873f65065fa1be4242ab54f43432d3065b4d1b06482090ab8ea8b3764
+  data.tar.gz: 48a502af83d76d0e48b0e81e00aad261e50c46b31c265cc04d6d00d31a62da8a4a15371e423ef7b52eaa22497a126afad11bebab42c389851a163df12b52d744

data/README.md

@@ -1,4 +1,4 @@
-# StripAttributes [![Gem Version](https://badge.fury.io/rb/strip_attributes.png)](http://badge.fury.io/rb/strip_attributes) [![Build Status](https://secure.travis-ci.org/rmm5t/strip_attributes.png)](http://travis-ci.org/rmm5t/strip_attributes) [![Code Climate](https://codeclimate.com/github/rmm5t/strip_attributes.png)](https://codeclimate.com/github/rmm5t/strip_attributes)
+# StripAttributes [![Gem Version](http://img.shields.io/gem/v/strip_attributes.svg)](https://rubygems.org/gems/strip_attributes) [![Build Status](https://secure.travis-ci.org/rmm5t/strip_attributes.svg)](http://travis-ci.org/rmm5t/strip_attributes) [![Code Climate](http://img.shields.io/codeclimate/github/rmm5t/strip_attributes.svg)](https://codeclimate.com/github/rmm5t/strip_attributes)
 
 StripAttributes is an ActiveModel extension that automatically strips all
 attributes of leading and trailing whitespace before validation. If the
@@ -10,10 +10,26 @@ 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]`).
 
-**If you like this project, please help by donating.**
+## How You Can Help
 
-* Gittip: https://www.gittip.com/rmm5t/
-* Bitcoin: `1wzBnMjWVZfpiFMc5i2nzKT7sCBaZNfLK`
+**If you like this project, please help. [Donate via Gittip][gittip] or [buy me a coffee with Bitcoin][bitcoin].**<br>
+[![Gratipay](http://img.shields.io/gratipay/rmm5t.svg)][gratipay]
+[![Bitcoin](http://img.shields.io/badge/bitcoin-buy%20me%20a%20coffee-brightgreen.svg)][bitcoin]
+
+**[Bitcoin][bitcoin]**: `1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m`<br>
+[![Bitcoin Donation][bitcoin-qr-small]][bitcoin-qr-big]
+
+## Need Help?
+
+**You can [book a session with me on Codementor][codementor].**<br>
+[![Book a Codementor session](http://img.shields.io/badge/codementor-book%20a%20session-orange.svg)][codementor]
+
+[gratipay]: https://gratipay.com/rmm5t/ "Donate to rmm5t for open source!"
+[bitcoin]: https://blockchain.info/address/1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m "Buy rmm5t a coffee for open source!"
+[bitcoin-scheme]: bitcoin:1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m?amount=0.01&label=Coffee%20to%20rmm5t%20for%20Open%20Source "Buy rmm5t a coffee for open source!"
+[bitcoin-qr-small]: http://chart.apis.google.com/chart?cht=qr&chs=150x150&chl=bitcoin%3A1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m%3Famount%3D0.01%26label%3DCoffee%2520to%2520rmm5t%2520for%2520Open%2520Source
+[bitcoin-qr-big]: http://chart.apis.google.com/chart?cht=qr&chs=500x500&chl=bitcoin%3A1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m%3Famount%3D0.01%26label%3DCoffee%2520to%2520rmm5t%2520for%2520Open%2520Source
+[codementor]: https://www.codementor.io/rmm5t?utm_campaign=profile&utm_source=button-rmm5t&utm_medium=shields "Book a session with rmm5t on Codementor!"
 
 ## Installation
 
@@ -77,6 +93,8 @@ class User < ActiveRecord::Base
   strip_attributes :only => [:first_name, :last_name], :regex => /[^[:alpha:]\s]/
   # Strip off non-integers
   strip_attributes :only => [:phone], :regex => /[^0-9]/
+  # Strip off all spaces and keep only alphabetic and numeric characters
+  strip_attributes :only => [:nick_name], :regex => /[^[:alnum:]\S]/
 end
 ```
 
@@ -108,6 +126,17 @@ end
 
 ```
 
+### Using it directly
+
+```ruby
+# where record is an ActiveModel isntance
+StripAttributes.strip(record, :collapse_spaces => true)
+
+# works directly on Strings too
+StripAttributes.strip(" foo \t") #=> "foo"
+StripAttributes.strip(" foo   bar", :collapse_spaces => true) #=> "foo bar"
+```
+
 ## Testing
 
 StripAttributes provides an RSpec/Shoulda-compatible matcher for easier
@@ -146,13 +175,13 @@ end
 
 ### Writing Tests
 
-**Rspec**:
+**RSpec**:
 
 ```ruby
 describe User do
-  it { should strip_attribute(:name).collapse_spaces }
-  it { should strip_attribute :email }
-  it { should_not strip_attribute :password }
+  it { is_expected.to strip_attribute(:name).collapse_spaces }
+  it { is_expected.to strip_attribute :email }
+  it { is_expected.not_to strip_attribute :password }
 end
 ```
 

data/lib/strip_attributes.rb

@@ -22,6 +22,67 @@ module StripAttributes
   VALID_OPTIONS = [:only, :except, :allow_empty, :collapse_spaces, :regex]
   MULTIBYTE_SUPPORTED = "\u0020" == " "
 
+  def self.strip(record_or_string, options = nil)
+    if record_or_string.respond_to?(:attributes)
+      strip_record(record_or_string, options)
+    else
+      strip_string(record_or_string, options)
+    end
+  end
+
+  def self.strip_record(record, options = nil)
+    attributes = narrow(record.attributes, options)
+
+    attributes.each do |attr, value|
+      original_value = value
+      value = strip_string(value, options)
+      record[attr] = value if original_value != value
+    end
+
+    record
+  end
+
+  def self.strip_string(value, options = nil)
+    if options
+      allow_empty     = options[:allow_empty]
+      collapse_spaces = options[:collapse_spaces]
+      regex           = options[:regex]
+    end
+
+    if value.respond_to?(:strip)
+      value = (value.blank? && !allow_empty) ? nil : value.strip
+    end
+
+    if regex && value.respond_to?(:gsub!)
+      value.gsub!(regex, '')
+    end
+
+    if MULTIBYTE_SUPPORTED
+      # Remove leading and trailing Unicode invisible and whitespace characters.
+      # The POSIX character class [:space:] corresponds to the Unicode class Z
+      # ("separator"). We also include the following characters from Unicode class
+      # C ("control"), which are spaces or invisible characters that make no
+      # sense at the start or end of a string:
+      #   U+180E MONGOLIAN VOWEL SEPARATOR
+      #   U+200B ZERO WIDTH SPACE
+      #   U+200C ZERO WIDTH NON-JOINER
+      #   U+200D ZERO WIDTH JOINER
+      #   U+2060 WORD JOINER
+      #   U+FEFF ZERO WIDTH NO-BREAK SPACE
+      if value.respond_to?(:gsub!)
+        value.gsub!(/\A[[:space:]\u180E\u200B\u200C\u200D\u2060\uFEFF]+|[[:space:]\u180E\u200B\u200C\u200D\u2060\uFEFF]+\z/, '')
+      end
+    elsif value.respond_to?(:strip!)
+      value.strip!
+    end
+
+    if collapse_spaces && value.respond_to?(:squeeze!)
+      value.squeeze!(' ')
+    end
+
+    value
+  end
+
   # Necessary because Rails has removed the narrowing of attributes using :only
   # and :except on Base#attributes
   def self.narrow(attributes, options = {})
@@ -36,51 +97,6 @@ module StripAttributes
     end
   end
 
-  def self.strip(record, options)
-      attributes = self.narrow(record.attributes, options)
-
-      if options
-        allow_empty     = options[:allow_empty]
-        collapse_spaces = options[:collapse_spaces]
-        regex           = options[:regex]
-      end
-
-      attributes.each do |attr, value|
-        original_value = value
-
-        if value.respond_to?(:strip)
-          value = (value.blank? && !allow_empty) ? nil : value.strip
-        end
-
-        if regex && value.respond_to?(:gsub!)
-          value.gsub!(regex, '')
-        end
-
-        if MULTIBYTE_SUPPORTED
-          # Remove leading and trailing Unicode invisible and whitespace characters.
-          # The POSIX character class [:space:] corresponds to the Unicode class Z
-          # ("separator"). We also include the following characters from Unicode class
-          # C ("control"), which are spaces or invisible characters that make no
-          # sense at the start or end of a string:
-          #   U+180E MONGOLIAN VOWEL SEPARATOR
-          #   U+200B ZERO WIDTH SPACE
-          #   U+200C ZERO WIDTH NON-JOINER
-          #   U+200D ZERO WIDTH JOINER
-          #   U+2060 WORD JOINER
-          #   U+FEFF ZERO WIDTH NO-BREAK SPACE
-          if value.respond_to?(:gsub!)
-            value.gsub!(/\A[[:space:]\u180E\u200B\u200C\u200D\u2060\uFEFF]+|[[:space:]\u180E\u200B\u200C\u200D\u2060\uFEFF]+\z/, '')
-          end
-        end
-
-        if collapse_spaces && value.respond_to?(:squeeze!)
-          value.squeeze!(' ')
-        end
-
-        record[attr] = value if original_value != value
-      end
-  end
-
   def self.validate_options(options)
     if keys = options && options.keys
       unless (keys - VALID_OPTIONS).empty?

data/lib/strip_attributes/matchers.rb

@@ -5,8 +5,8 @@ module StripAttributes
     #
     # RSpec Examples:
     #
-    #   it { should strip_attribute(:first_name) }
-    #   it { should_not strip_attribute(:password) }
+    #   it { is_expected.to strip_attribute(:first_name) }
+    #   it { is_expected.not_to strip_attribute(:password) }
     #
     # Minitest Matchers Examples:
     #

data/lib/strip_attributes/version.rb

@@ -1,3 +1,3 @@
 module StripAttributes
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/test/strip_attributes_test.rb

@@ -61,7 +61,7 @@ class StripRegexMockRecord < Tableless
   strip_attributes :regex => /[\^\%&\*]/
 end
 
-class StripAttributesTest < MiniTest::Unit::TestCase
+class StripAttributesTest < Minitest::Test
   def setup
     @init_params = { :foo => "\tfoo", :bar => "bar \t ", :biz => "\tbiz ", :baz => "", :bang => " ", :foz => " foz  foz" }
   end
@@ -181,9 +181,9 @@ class StripAttributesTest < MiniTest::Unit::TestCase
     record.valid?
     assert_equal "abc",        record.foo
     assert_equal "bar",        record.bar
-  end  
+  end
 
-  def test_strip_unicode
+  def test_should_strip_unicode
     # This feature only works if multi-byte characters are supported by Ruby
     return if "\u0020" != " "
     # U200A - HAIR SPACE
@@ -192,4 +192,33 @@ class StripAttributesTest < MiniTest::Unit::TestCase
     record.valid?
     assert_equal "foo",      record.foo
   end
+
+  class ClassMethodsTest < Minitest::Test
+    def test_should_strip_whitespace
+      assert_equal nil, StripAttributes.strip("")
+      assert_equal nil, StripAttributes.strip(" \t ")
+      assert_equal "thirty six", StripAttributes.strip(" thirty six \t \n")
+    end
+
+    def test_should_allow_empty
+      assert_equal "", StripAttributes.strip("", :allow_empty => true)
+      assert_equal "", StripAttributes.strip(" \t ", :allow_empty => true)
+    end
+
+    def test_should_collapse_spaces
+      assert_equal "1 2 3", StripAttributes.strip(" 1   2   3\t ", :collapse_spaces => true)
+    end
+
+    def test_should_strip_regex
+      assert_equal "abc", StripAttributes.strip("^%&*abc  ^  ", :regex => /[\^\%&\*]/)
+    end
+
+    def test_should_strip_unicode
+      # This feature only works if multi-byte characters are supported by Ruby
+      return if "\u0020" != " "
+      # U200A - HAIR SPACE
+      # U200B - ZERO WIDTH SPACE
+      assert_equal "foo", StripAttributes.strip("\u200A\u200B foo\u200A\u200B ")
+    end
+  end
 end

data/test/test_helper.rb

@@ -13,3 +13,6 @@ end
 
 # Avoid annoying deprecation warning
 I18n.enforce_available_locales = true
+
+# Remove this after we drop support for Rails 3.2 and Minitest 4.x
+Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strip_attributes
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Ryan McGeary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -62,30 +62,36 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.1.1
 description: StripAttributes automatically strips all ActiveRecord model attributes
   of leading and trailing whitespace before validation. If the attribute is blank,
   it strips the value to nil.
@@ -124,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Whitespace cleanup for ActiveModel attributes