normatron 0.0.7 → 0.1.0

data/README.textile

@@ -39,18 +39,21 @@ class Product < ActiveRecord::Base
 end
 </pre>
 
-And you want the 'name' attribute be uppercased before saving it into the database.
+And you want the _name_ attribute be uppercased before saving it into the database.
 The most usual approach to do this includes:
 
-* Override the 'name' setter and convert the value to an uppercased string.
-* Use the 'before_validation' callback to run a method or block doing the task.
+* Override the _name_ setter and convert the value to an uppercased string.
+* Use the _before_validation_ callback to run a method or block doing the task.
 
 Both ways are ilenegant, boring, error prone and very expensive.
 What led me to make this gem and offer a third way to solve the problem:
 
 h2. Usage
 
-h3. Single attribute with standard filters
+h3. The default filters
+
+Normatron uses *:squish* and *:blank* as default filters.
+These filters are applied to all attributes in *normalize* function, since no options was given.
 
 <pre>
 # ./app/models/products.rb
@@ -59,52 +62,87 @@ class Product < ActiveRecord::Base
   normalize :name
 end
 
-$ rails console
-> pa = Product.create :name => "  memory   card    "
-> pa.name
+ $ rails console
+ > p = Product.create name: "  memory   card    "
+ > p.name
 => "memory card"
-> pb = Product.create :name => "    "
-> pb.name
+ > p = Product.create name: "    "
+ > p.name
 => nil
 </pre>
 
-Normatron will use *:squish* and *:blank* filters if no option was given.
+You can also apply the default filters to multiple attributes as following:
 
-h3. Multiple filters to a single attribute
+<pre>normalize :login, :email, :address, :city</pre>
 
-<pre>normalize :name, :with => [:blank, :squish, :upcase]</pre>
+h3. The callback
 
-Just add the *:with* option and pass the filters as an array.
+All filters are automatically applyied in the *before_validation* callback.
+So, the changes occur when you call any method that validates de model.
 
-h3. Multiple attributes with same filters
+<pre>
+ $ rails console
+ > p = Product.create name: "mouse"
+ > p.name
+=> "MOUSE"
+ > p = Product.new name: "keyboard"
+ > p.valid?
+ > p.name
+=> "KEYBOARD"
+ > p = Product.new name: "dvd"
+ > p.save
+ > p.name
+=> "DVD"
+</pre>
 
-<pre>normalize :name, :brand, :with => [:capitalize, :blank]</pre>
+It's possible to call the *apply_normalizations* method. That perform the normalization without do the validations.
 
-All symbols outside the *:with* option are flagged as an attribute.
+<pre>
+ > p = Product.new name: "hd"
+ > p.apply_normalizations
+ > p.name
+=> "HD"
+</pre>
 
-h3. Multiple attributes with different filters
+h3. Specifying filters
+
+Just add the *:with* option and pass the filter you want.
+All Symbols outside the *:with* Hash are flagged as an attribute.
+
+<pre>normalize :login, :address, :city, :with => :upcase</pre>
+
+To apply multiple filters, pass it as an array:
+
+<pre>
+normalize :login, :address, :city, :with => [:upcase, :blank, :strip]
+normalize :email, :with => [:downcase, :blank, :strip]
+</pre>
+
+h3. Mixing all together
+
+You can stack filters to an attribute calling the *normalize* method multiple times.
 
 <pre>
 # ./app/models/user.rb
 class User < ActiveRecord::Base
   attr_accessible :name, :surname, :login, :password, :email
+
   normalize :name, :surname, :email, :login, :with => [:blank, :squish]
   normalize :name, :surname, :with => :upcase
   normalize :email, :with => :downcase
 end
 
-$ rails console
-> u = User.create :name => " c  h  u  c  k", :surname => "  norris   ", :email => "IKillYou@MostBadass.com", :login => "ALLineedislove"
-> u.name
-=> "C H U C K"
-> u.surname
-=> "NORRIS"
-> u.email
-=> "ikillyou@mostbadass.com"
+ $ rails console
+ > u = User.new
+ > u.name = "  \n \f \r \t  "
+ > u.surname = "  norris  "
+ > u.login = "          iKICKasses"
+ > u.email = "GMAIL@CHUCKNORRIS.COM"
+ > u.valid?
+ > u
+=> #<User id: nil, name: nil, surname: "NORRIS", login: "iKICKasses", email: "gmail@chucknorris.com">
 </pre>
 
-You can stack filters to an attribute calling the *normalize* method multiple times.
-
 h3. Using custom instance method as a filter
 
 <pre>
@@ -131,26 +169,25 @@ Create an instance method that returns the value as you want. The method must ha
 h2. Filters
 
 table{border:1px solid black}.
-|_. FILTER|_. INPUT|_.OUTPUT|
-|:blank|"text"|"text"|
-|:blank|" "|nil|
-|:blank|"\n"|nil|
-|:blank|""|nil|
-|:capitalize|"power overwhelming"|"Power overwhelming"|
-|:capitalize|"POWER overwhelming"|"Power overwhelming"|
-|:capitalize|" power overwhelming"|" power overwhelming"|
-|:downcase|"EDWARD"|"edward"|
-|:lstrip|" Chrono Trigger "|"Chrono Trigger "|
-|:rstrip|" Chrono Cross "|" Chrono Cross"|
-|:squish|" "|""|
-|:squish|" \n \r \t \f "|""|
-|:squish|" Master of Puppets "|"Master of Puppets"|
-|:strip|" Final Fantasy "|"Final Fantasy"|
-|:titlecase or :titleize|" system of a down "|" System Of A Down "|
-|:upcase|"text"|"TEXT"|
+|_. FILTER|_. DESCRIPTION|
+|:blank|Convert a blank String into a Nil object|
+|:capitalize|Downcase all characters in the sequence and upcase the first|
+|:dasherize|Replace all underscores with dashes|
+|:downcase|Downcase all characters in the sequence|
+|:lstrip|Remove trailing spaces|
+|:rstrip|Remove leading spaces|
+|:squeeze|Replace followed occurrences of the same character by a single one|
+|:squish|Remove trailing, leading, surplus spaces and scape characters|
+|:strip|Remove trailing and leading spaces|
+|:title|Downcase all characters in the sequence and upcase the first character of each word|
+|:upcase|Upcase all characters in the sequence|
 
 h1. Changelog
 
+- 0.1.0 :=
+* Two new filters: dasherize and squeeze
+* Native filters replaced by StringInflections
+=:
 - 0.0.7 :=
 * Ability to use an instance method as a filter
 =:
@@ -159,8 +196,9 @@ h1. Contributing
 
 * Fork it, add your new features or bug fixes, make your tests and commit.
 * Report any bug or unexpected behavior.
+* Share with your friends, forums, communities, job, etc...
 * Send me your feedback.
-* Pay me a beer. =]
+* Offer me a job or pay me a beer. =]
 
 h1. Special Thanks
 
@@ -169,6 +207,7 @@ He have a lot of interesting gems on his repo, please take a look.
 
 h1. Licence
 
+<pre>
 Copyright 2012 Fernando Rodrigues da Silva
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -188,4 +227,5 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+</pre>

data/lib/normatron.rb

@@ -2,7 +2,7 @@ require "normatron/configuration"
 require "normatron/extensions/active_record"
 
 module Normatron
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 
   class << self
     def configuration

data/lib/normatron/extensions/active_record.rb

@@ -1,4 +1,4 @@
-require "normatron/filters/native"
+require "normatron/filters/string_inflections"
 
 module Normatron
   module Extensions
@@ -34,7 +34,7 @@ module Normatron
             if self.respond_to? filter
               value = send(filter, value)
             else
-              value = Normatron::Filters::Native.apply(filter, value)
+              value = Normatron::Filters::StringInflections.send(filter, value)
             end
           end
 

data/lib/normatron/filters/string_inflections.rb

@@ -0,0 +1,119 @@
+require "active_support/core_ext/string"
+
+module Normatron
+  module Filters
+    module StringInflections
+      class << self
+
+        ##
+        # Convert a blank string into a nil object.
+        # 
+        # @example
+        #   StringInflections.blank("")   #=> nil
+        #   StringInflections.blank("  ") #=> nil
+        #   StringInflections.blank("\n") #=> nil
+        #   StringInflections.blank("1")  #=> "1"
+        #   StringInflections.blank(0)    #=> 0
+        # @param [String] value Any character sequence
+        # @return [String, nil] The object itself or nil
+        # 
+        # @see http://api.rubyonrails.org/classes/String.html#method-i-blank-3F ActiveSupport::CoreExt::Object#blank?
+        def blank(value)
+          if is_a_string?(value)
+            value.to_s.blank? ? nil : value
+          else
+            value
+          end
+        end
+
+        ##
+        # Downcase all characters in the sequence, except the first.
+        # 
+        # @example
+        #   StringInflections.capitalize("mASTER OF PUPPETS")  #=> "Master of puppets"
+        #   StringInflections.capitalize(" mASTER OF PUPPETS") #=> " master of puppets"
+        #   StringInflections.capitalize(1)                    #=> 1
+        # @param [String] value Any character sequence
+        # @return [String] The object itself or a capitalized string
+        # 
+        # @see http://api.rubyonrails.org/classes/ActiveSupport/Multibyte/Chars.html#method-i-capitalize ActiveSupport::Multibyte::Chars#capitalize
+        def capitalize(value)
+          evaluate(:capitalize, value)
+        end
+
+        ##
+        # Replace all underscores with dashes.
+        # 
+        # @example
+        #   StringInflections.dasherize("__ shoot _ to _ thrill __") #=> "-- shoot - to - thrill --"
+        #   StringInflections.dasherize(1)                           #=> 1
+        # @param [String] value Any character sequence
+        # @return [String] The object itself or a capitalized string
+        # 
+        # @see http://api.rubyonrails.org/classes/String.html#method-i-dasherize ActiveSupport::CoreExt::Object#dasherize
+        def dasherize(value)
+          evaluate(:dasherize, value)
+        end
+
+        def downcase(value)
+          evaluate(:downcase, value)
+        end
+
+        def lstrip(value)
+          evaluate(:lstrip, value)
+        end
+
+        def rstrip(value)
+          evaluate(:rstrip, value)
+        end
+
+        def squeeze(value)
+          evaluate(:squeeze, value)
+        end
+
+        def squish(value)
+          evaluate(:squish, value)
+        end
+
+        def strip(value)
+          evaluate(:strip, value)
+        end
+
+        def title(value)
+          evaluate(:titlecase, value)
+        end
+
+        def upcase(value)
+          evaluate(:upcase, value)
+        end
+
+        private
+
+        def evaluate(method_name, value)
+          if need_type_cast?(method_name, value)
+            value.mb_chars.send(method_name)
+          elsif is_a_string?(value)
+            value.send(method_name)
+          else
+            value
+          end
+        end
+
+        def need_type_cast?(method_name, value)
+          if value.is_a?(String)
+            case method_name
+            when :capitalize, :downcase, :titlecase, :upcase
+              true
+            end
+          else
+            false
+          end
+        end
+
+        def is_a_string?(value)
+          value.is_a?(ActiveSupport::Multibyte::Chars) || value.is_a?(String)
+        end
+      end
+    end
+  end
+end

data/spec/lib/normatron/filters/string_inflections_spec.rb

@@ -0,0 +1,266 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+describe Normatron::Filters::StringInflections do
+
+  let(:mod) { Normatron::Filters::StringInflections }
+  let(:val) { @value }
+
+  describe :blank do
+    it "should return nil for empty strings" do
+      value     = ""
+      mod.blank(value).should be_nil
+      mod.blank(value.mb_chars).should be_nil
+    end
+
+    it "should return nil for blank spaces strings" do
+      value     = "   "
+      mod.blank(value).should be_nil
+      mod.blank(value.mb_chars).should be_nil
+    end
+
+    it 'should return nil for \n \t \r \f strings' do
+      value     = "\n \t \r \f"
+      mod.blank(value).should be_nil
+      mod.blank(value.mb_chars).should be_nil
+    end
+
+    it "should not affect filled string" do
+      value     = "baCon"
+      expected  = "baCon"
+      mod.blank(value).should eq expected
+      mod.blank(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should not affect non string objects" do
+      mod.blank(nil).should eq nil
+      mod.blank(1).should eq 1
+    end
+  end
+
+  describe :capitalize do
+    it "should upcase first char and downcase others" do
+      value     = "mASTER OF PUPPETS"
+      expected  = "Master of puppets"
+      mod.capitalize(value).should eq expected
+      mod.capitalize(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should downcase all chars in string starting with spaces" do
+      value     = " mASTER OF PUPPETS"
+      expected  = " master of puppets"
+      mod.capitalize(value).should eq expected
+    end
+
+    it "should affect accented chars" do
+      value     = "ILÍADA"
+      expected  = "Ilíada"
+      mod.capitalize(value).should eq expected
+    end
+
+    it "should not affect non string objects" do
+      mod.capitalize(nil).should eq nil
+      mod.capitalize(1).should eq 1
+    end
+  end
+
+  describe :dasherize do
+    it "should replaces underscores with dashes" do
+      value     = "__ shoot _ to _ thrill __"
+      expected  = "-- shoot - to - thrill --"
+      mod.dasherize(value).should eq expected
+      mod.dasherize(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should not affect non string objects" do
+      mod.dasherize(nil).should eq nil
+      mod.dasherize(1).should eq 1
+    end
+  end
+
+  describe :downcase do
+    it "should downcase all characters" do
+      value     = "KILL'EM ALL"
+      expected  = "kill'em all"
+      mod.downcase(value).should eq expected
+      mod.downcase(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should affect accented chars" do
+      value     = "ÊXITO"
+      expected  = "êxito"
+      mod.downcase(value).should eq expected
+    end
+
+    it "should not affect non string objects" do
+      mod.downcase(nil).should eq nil
+      mod.downcase(1).should eq 1
+    end
+  end
+
+  describe :lstrip do
+    it "should remove trailing spaces" do
+      value     = "     black     "
+      expected  = "black     "
+      mod.lstrip(value).should eq expected
+      mod.lstrip(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should not affect non string objects" do
+      mod.lstrip(nil).should eq nil
+      mod.lstrip(1).should eq 1
+    end
+  end
+
+  describe :rstrip do
+    it "should remove leading spaces" do
+      value     = "     load     "
+      expected  = "     load"
+      mod.rstrip(value).should eq expected
+      mod.rstrip(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should not affect non string objects" do
+      mod.rstrip(nil).should eq nil
+      mod.rstrip(1).should eq 1
+    end
+  end
+
+  describe :squeeze do
+    it "should replace multiple occurrences of a char for a single one" do
+      value     = "rock'n roll \n\n ain't noise   pollution"
+      expected  = "rock'n rol \n ain't noise polution"
+      mod.squeeze(value).should eq expected
+      mod.squeeze(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should not affect non string objects" do
+      mod.squeeze(nil).should eq nil
+      mod.squeeze(1).should eq 1
+    end
+  end
+
+  describe :squish do
+    it "should remove trailing and leading spaces" do
+      value     = "     and justice for all...     "
+      expected  = "and justice for all..."
+      mod.squish(value).should eq expected
+      mod.squish(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should remove multiple spaces" do
+      value     = "and    justice     for      all..."
+      expected  = "and justice for all..."
+      mod.squish(value).should eq expected
+    end
+
+    it 'should remove \n \r \f \t' do
+      value     = "\tand\njustice\rfor\fall..."
+      expected  = "and justice for all..."
+      mod.squish(value).should eq expected
+    end
+
+    it "should not affect non string objects" do
+      mod.squish(nil).should eq nil
+      mod.squish(1).should eq 1
+    end
+  end
+
+  describe :strip do
+    it "should remove trailing and leading spaces" do
+      value     = "     reload     "
+      expected  = "reload"
+      mod.strip(value).should eq expected
+      mod.strip(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should not affect non string objects" do
+      mod.strip(nil).should eq nil
+      mod.strip(1).should eq 1
+    end
+  end
+
+  describe :title do
+    it "should upcase first char of each word, others downcased" do
+      value     = "dirty DEEDS DONE dirt cheap"
+      expected  = "Dirty Deeds Done Dirt Cheap"
+      mod.title(value).should eq expected
+      mod.title(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should affect accented chars" do
+      value     = "isto NÃO é verdade"
+      expected  = "Isto Não É Verdade"
+      mod.title(value).should eq expected
+    end
+
+    it "should not affect non string objects" do
+      mod.title(nil).should eq nil
+      mod.title(1).should eq 1
+    end
+  end
+
+  describe :upcase do
+    it "should upcase all characters" do
+      value     = "Ride the lightning"
+      expected  = "RIDE THE LIGHTNING"
+      mod.upcase(value).should eq expected
+      mod.upcase(value.mb_chars).should eq expected.mb_chars
+    end
+
+    it "should affect accented chars" do
+      value     = "ébrio"
+      expected  = "ÉBRIO"
+      mod.upcase(value).should eq expected
+    end
+
+    it "should not affect non string objects" do
+      mod.upcase(nil).should eq nil
+      mod.upcase(1).should eq 1
+    end
+  end
+
+  pending "chomp with args"
+  pending "squeeze with args"
+  pending :camelize
+  pending :center
+  pending :chomp
+  pending :chop
+  pending :classify
+  pending :clear
+  pending :constantize
+  pending :deconstantize
+  pending :demodulize
+  pending :dump
+  pending :excerpt
+  pending :foreign_key
+  pending :highlight
+  pending :html
+  pending :humanize
+  pending :just
+  pending :ljust
+  pending :md
+  pending :ordinalize
+  pending :parameterize
+  pending :permalink
+  pending :pluralize
+  pending :pluralize
+  pending :reverse
+  pending :rjust
+  pending :safe_constantize
+  pending :simple_format
+  pending :singularize
+  pending "squeeze with args"
+  pending :succ
+  pending :swapcase
+  pending :tableize
+  pending :textile
+  pending :transliterate
+  pending :trim
+  pending :truncate
+  pending :underscore
+  pending :wrap
+  pending "remove accents"
+  pending "move :blank to another module"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: normatron
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,17 +69,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/normatron.rb
 - lib/normatron/configuration.rb
-- lib/normatron/filters/native.rb
+- lib/normatron/filters/string_inflections.rb
 - lib/normatron/extensions/active_record.rb
+- lib/normatron.rb
 - MIT-LICENSE
 - Rakefile
 - README.textile
+- spec/spec_helper.rb
+- spec/lib/normatron_spec.rb
+- spec/lib/normatron/filters/string_inflections_spec.rb
 - spec/lib/normatron/configuration_spec.rb
 - spec/lib/normatron/extensions/active_record_spec.rb
-- spec/lib/normatron_spec.rb
-- spec/spec_helper.rb
 - spec/support/client_model.rb
 - spec/support/schema.rb
 homepage: https://github.com/fernandors87/normatron
@@ -107,9 +108,11 @@ signing_key:
 specification_version: 3
 summary: Normalize attributes for ActiveRecord objects.
 test_files:
+- spec/spec_helper.rb
+- spec/lib/normatron_spec.rb
+- spec/lib/normatron/filters/string_inflections_spec.rb
 - spec/lib/normatron/configuration_spec.rb
 - spec/lib/normatron/extensions/active_record_spec.rb
-- spec/lib/normatron_spec.rb
-- spec/spec_helper.rb
 - spec/support/client_model.rb
 - spec/support/schema.rb
+has_rdoc: 

data/lib/normatron/filters/native.rb

@@ -1,32 +0,0 @@
-require "active_support/all"
-
-module Normatron
-  module Filters
-    module Native
-      class << self
-        def apply(filter, value)
-          return value unless value.is_a? String
-
-          case filter
-          when :upcase, :downcase, :capitalize, :titlecase, :titleize
-            value.mb_chars.send(filter).to_s
-          when :squish, :lstrip, :rstrip, :strip
-            value.send(filter)
-          when :blank
-            send("to_#{filter}", value)
-          end
-        end
-
-        def filter_names
-          [:upcase, :downcase, :capitalize, :titlecase, :titleize, :squish, :lstrip, :rstrip, :strip, :blank]
-        end
-
-        private
-
-        def to_blank(value)
-          value.blank? ? nil : value
-        end
-      end
-    end
-  end
-end