scrubba 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba2ed8480e2ff0e7b1464159fc749eb67abca90b
-  data.tar.gz: 7b2357f30b4a4e36e10db6892e3109e174040b9a
+  metadata.gz: 6bfa17fbe6fb61cebda1c7823c9d599f4eafc3e0
+  data.tar.gz: 551b5c9c6b4b9333f4d7a9ddb975605bb5e2c9d9
 SHA512:
-  metadata.gz: 908262afc8c7d5fd63d1d7d1806e96609bb890ef30e00f0fdeb8fa5a35cf82e3c96cd3600c1b036bfd7888e1a9fe541c21f16bf612bdede2e314e3cfe13e558e
-  data.tar.gz: fb318e8d2142aed98075667e5f23f09901bc1db536155d7e510b8020e8b0fa9e603a3b93f6603c3cb984477558a1b8d260fe1e7c491caedae2ab91eaf5fdedbd
+  metadata.gz: 2123ec2402ffddeeb1e689e8da27db805764b805889d61f131e0e0feb62f20f9b7fc6368a889139163e9041f955cfe0035293788abddf2bb5bec9856fa806db6
+  data.tar.gz: 21e5300f8c77ef6761e023b62b13d54ed9ed01f723038d57d90c5c1f7256d8b76de123ea7f1d4037e81a1021d5ab4d1cfc34dc5f2c1359fe1c5ed8fb12810b8f

data/CHANGELOG.md

@@ -1,7 +1,17 @@
+# 0.3.0 (2015-09-01)
+
+- *BREAKING CHANGE*: `scrub` and `normalize` have been renamed to
+  `strip` and `collapse` based on usage and feedback
+  ([#1](https://github.com/jmdeldin/scrubba/pull/1)). The new way to
+  declare which attributes you want to strip/collapse whitespace from
+  is:
+
+      scrub :some_attr, strip: true, collapse: true
+
 # 0.2.0 (2015-08-29)
 
-- Switched from `extend` to `include` for consistency with gems and
-  DRY-er code
+- *BREAKING CHANGE*: Switched from `extend` to `include` for consistency
+  with gems and DRY-er code
 
 # 0.1.0 (2015-08-28)
 

data/README.md

@@ -28,8 +28,8 @@ Standalone:
 require "scrubba"
 
 some_str = " foo \t bar "
-Scrubba.scrub(some_str) #=> "foo \t bar"
-Scrubba.normalize(some_str) #=> " foo bar "
+Scrubba.strip(some_str) #=> "foo \t bar"
+Scrubba.collapse(some_str) #=> " foo bar "
 ```
 
 In an ActiveRecord model:
@@ -40,8 +40,8 @@ require "scrubba"
 class Post < ActiveRecord::Base
   include Scrubba::ActiveMethods
 
-  strip :title, :body
-  normalize :title
+  scrub :title, :slug, strip: true
+  scrub :body, collapse: true
 end
 ```
 
@@ -49,6 +49,8 @@ end
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jmdeldin/scrubba.
 
+Protip: If you use Emacs, insert a Unicode space in your test data with <kbd>M-x insert-char</kbd> and verify it with <kbd>M-x describe-char</kbd>.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/scrubba.rb

@@ -7,7 +7,7 @@ module Scrubba
   #
   # @param [String] str
   # @return [String]
-  def self.scrub(str)
+  def self.strip(str)
     str.gsub(/(\A[[:space:]]+|[[:space:]]+\z)/, "") if str
   end
 
@@ -15,7 +15,7 @@ module Scrubba
   #
   # @param [String] str
   # @return [String]
-  def self.normalize(str)
+  def self.collapse(str)
     str.gsub(/[[:space:]]+/, " ") if str
   end
 end

data/lib/scrubba/active_methods.rb

@@ -4,19 +4,19 @@ module Scrubba
       base.extend(ClassMethods)
     end
 
-    def scrubba_apply(keys, func)
-      keys.each do |k|
-        self[k] = Scrubba.public_send(func, self[k]) if self[k].present?
-      end
+    def scrubba_apply(key, func)
+      self[key] = Scrubba.public_send(func, self[key]) if self[key].present?
     end
 
     module ClassMethods
-      def scrub(*keys)
-        before_validation { scrubba_apply(keys, :scrub) }
-      end
-
-      def normalize(*keys)
-        before_validation { scrubba_apply(keys, :normalize) }
+      # Strip and/or collapse whitespace from given attributes.
+      def scrub(*keys, strip: false, collapse: false)
+        before_validation do
+          keys.each do |k|
+            scrubba_apply(k, :strip) if strip
+            scrubba_apply(k, :collapse) if collapse
+          end
+        end
       end
     end
   end

data/lib/scrubba/version.rb

@@ -1,3 +1,3 @@
 module Scrubba
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrubba
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jon-Michael Deldin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler