attribute_normalizer 0.2.1 → 0.3.0

data/README.textile

@@ -4,6 +4,11 @@ p. A little normalization goes a long way in helping maintain data integrity.
 
 h2. Recent Changes
 
+* 0.3.0
+** Normalizer Chaining
+** Built-in common normalizers
+** Ability to change the default attribute normalization.
+
 * 0.2.1
 ** ActiveModel Support Built-in
 ** Fix for :with option getting dropped when normalizing several attributes
@@ -54,10 +59,16 @@ p. Lets create a quick test/spec for what we want to accomplish as far as normal
 describe Book do
   it { should normalize_attribute(:author) }
   it { should normalize_attribute(:price).from('$3,450.98').to(3450.98) }
-  it { should normalize_attribute(:summary).from('Here is my summary that is a little to long').to('Here is m...') }
-  it { should normalize_attribute(:title).from('pick up chicks with magic tricks').to('Pick Up Chicks With Magic Tricks')}
+  it { should normalize_attribute(:summary).from('   Here is my summary that is a little to long   ').to('Here is m...') }
+  it { should normalize_attribute(:title).from(' pick up chicks with magic tricks  ').to('Pick Up Chicks With Magic Tricks')}
 end</code></pre>
 
+p. The following normalizers are already included with the +0.3 version of the gem.
+
+* _:blank_ Will return _nil_ on empty strings
+* _:phone_ Will strip out all non-digit characters and return nil on empty strings
+* _:strip_ Will strip leading and trailing whitespace.
+
 p. And lets predefine some normalizers that we may use in other classes/models or that we don't want to clutter up our class/model's readability with.
 
 <pre><code># config/initializers/attribute_normalizer.rb
@@ -78,6 +89,10 @@ AttributeNormalizer.configure do |config|
     end
   end
 
+  # The default normalizers if no :with option or block is given is to apply the :strip and :blank normalizers (in that order).
+  # You can change this if you would like as follows:
+  # config.default_normalizers = :strip, :blank
+
 end
 </code></pre>
 
@@ -92,8 +107,8 @@ The _normalize_attributes_ method is eager loaded into your ORM.  _normalize_att
   # Using one of our predefined normalizers.
   normalize_attribute  :price, :with => :currency
 
-  # Using one of our predefined normalizers with options
-  normalize_attribute :summary, :with => :truncate, :length => 12
+  # Using more then one of our predefined normalizers including one with options
+  normalize_attribute :summary, :with => [ :strip, { :truncate => { :length => 12 } } ]
 
   # You can also define your normalization block inline.
   normalize_attribute :title do |value|

data/lib/attribute_normalizer/model_inclusions.rb

@@ -6,23 +6,37 @@ module AttributeNormalizer
 
   module ClassMethods
     def normalize_attributes(*attributes, &block)
-      options = attributes.extract_options!
-      with    = options.delete(:with)
+      options = attributes.last.is_a?(::Hash) ? attributes.pop : {}
+
+      normalizers    = [options.delete(:with)].flatten.compact
+      if normalizers.empty? && !block_given?
+        normalizers = AttributeNormalizer.configuration.default_normalizers # the default normalizers
+      end
 
       attributes.each do |attribute|
-        define_method "normalize_#{attribute}" do |value|
-          normalized = if block_given? && !value.blank?
+        if block_given?
+          define_method "normalize_#{attribute}" do |value|
             yield(value)
-          elsif !with.nil? && !value.blank?
-            unless AttributeNormalizer.configuration.normalizers.has_key?(with)
-              raise AttributeNormalizer::MissingNormalizer.new("No normalizer was found for #{with}")
+          end
+        else
+          define_method "normalize_#{attribute}" do |value|
+            normalized=value
+            normalizers.each do |normalizer_name|
+              unless normalizer_name.kind_of?(Symbol)
+                normalizer_name,options=normalizer_name.keys[0],normalizer_name[normalizer_name.keys[0]]
+              end
+
+              normalizer=AttributeNormalizer.configuration.normalizers[normalizer_name]
+              raise AttributeNormalizer::MissingNormalizer.new("No normalizer was found for #{normalizer_name}") unless normalizer
+
+              normalized= normalizer.respond_to?(:normalize) ? normalizer.normalize(normalized,options) :
+                normalizer.call(normalized, options)
+              #puts "#{normalizer_name} : ->'#{normalized}' (#{normalized.class})"
             end
-            AttributeNormalizer.configuration.normalizers[with].call(value, options)
-          else
-            value.is_a?(String) ? value.strip : value
+            normalized
           end
-          normalized.nil? || (normalized.is_a?(String) && normalized == '') ? nil : normalized
         end
+
         self.send :private, "normalize_#{attribute}"
 
         define_method "#{attribute}=" do |value|

data/lib/attribute_normalizer/normalizers/blank_normalizer.rb

@@ -0,0 +1,9 @@
+module AttributeNormalizer
+  module Normalizers
+    module BlankNormalizer
+      def self.normalize(value, options)
+        value.nil? || (value.is_a?(String) && value.empty?) ? nil : value
+      end
+    end
+  end
+end

data/lib/attribute_normalizer/normalizers/phone_normalizer.rb

@@ -0,0 +1,10 @@
+module AttributeNormalizer
+  module Normalizers
+    module PhoneNormalizer
+      def self.normalize(value, options)
+        value = value.is_a?(String) ? value.gsub(/[^0-9]+/, '') : value
+        value.is_a?(String) && value.empty? ? nil : value
+      end
+    end
+  end
+end

data/lib/attribute_normalizer/normalizers/strip_normalizer.rb

@@ -0,0 +1,9 @@
+module AttributeNormalizer
+  module Normalizers
+    module StripNormalizer
+      def self.normalize(value, options)
+        value.is_a?(String) ? value.strip : value
+      end
+    end
+  end
+end

data/lib/attribute_normalizer.rb

@@ -1,3 +1,7 @@
+require 'attribute_normalizer/normalizers/blank_normalizer'
+require 'attribute_normalizer/normalizers/phone_normalizer'
+require 'attribute_normalizer/normalizers/strip_normalizer'
+
 module AttributeNormalizer
 
   class MissingNormalizer < ArgumentError; end
@@ -11,11 +15,23 @@ module AttributeNormalizer
     yield(configuration)
   end
 
+
   class Configuration
-    attr_accessor :normalizers
+    attr_accessor :default_normalizers, :normalizers
+
+    def default_normalizers=(normalizers)
+      @default_normalizers = normalizers.is_a?(Array) ? normalizers : [ normalizers ]
+    end
+
     def initialize
       @normalizers = {}
+      @normalizers[ :blank ]   = AttributeNormalizer::Normalizers::BlankNormalizer
+      @normalizers[ :phone ]   = AttributeNormalizer::Normalizers::PhoneNormalizer
+      @normalizers[ :strip ]   = AttributeNormalizer::Normalizers::StripNormalizer
+      @default_normalizers = [ :strip, :blank ]
     end
+
+
   end
 
 end
@@ -24,7 +40,6 @@ end
 require 'attribute_normalizer/model_inclusions'
 require 'attribute_normalizer/rspec_matcher'
 
-
 def include_attribute_normalizer(class_or_module)
   return if class_or_module.include?(AttributeNormalizer)
   class_or_module.class_eval do

data/spec/author_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+describe Author do
+
+  context 'Testing the built in normalizers' do
+    # default normalization [ :strip, :blank ]
+    it { should normalize_attribute(:name) }
+    it { should normalize_attribute(:name).from(' this ').to('this') }
+    it { should normalize_attribute(:name).from('   ').to(nil) }
+
+    # :strip normalizer
+    it { should normalize_attribute(:first_name).from('  this  ').to('this') }
+    it { should normalize_attribute(:first_name).from('    ').to('') }
+
+    # :blank normalizer
+    it { should normalize_attribute(:last_name).from('').to(nil) }
+    it { should normalize_attribute(:last_name).from(' this ').to(' this ') }
+
+    # :phone normalizer
+    it { should normalize_attribute(:phone_number).from('no-numbers-here').to(nil) }
+    it { should normalize_attribute(:phone_number).from('1.877.987.9875').to('18779879875') }
+    it { should normalize_attribute(:phone_number).from('+ 1 (877) 987-9875').to('18779879875') }
+  end
+
+end

data/spec/book_spec.rb

@@ -7,7 +7,7 @@ describe Book do
   it { should normalize_attribute(:us_price).from('$3.50').to(3.50) }
   it { should normalize_attribute(:cnd_price).from('$3,450.98').to(3450.98) }
 
-  it { should normalize_attribute(:summary).from('Here is my summary that is a little to long').to('Here is m...') }
+  it { should normalize_attribute(:summary).from('    Here is my summary that is a little to long  ').to('Here is m...') }
 
   it { should normalize_attribute(:title).from('pick up chicks with magic tricks').to('Pick Up Chicks With Magic Tricks') }
 
@@ -44,4 +44,9 @@ describe Book do
     end
   end
 
+  context 'with the default normalizer changed' do
+    @book = Book.new :author => 'testing the default normalizer'
+    @book.author.should == 'testing the default normalizer'
+  end
+
 end

data/spec/connection_and_schema.rb

@@ -5,6 +5,13 @@ ActiveRecord::Base.establish_connection({
 })
 
 ActiveRecord::Schema.define do
+  create_table :authors, :force => true do |t|
+    t.string :name
+    t.string :first_name
+    t.string :last_name
+    t.string :phone_number
+  end
+
   create_table :books, :force => true do |t|
     t.string  :author
     t.string  :isbn

data/spec/models/author.rb

@@ -1,13 +1,8 @@
-class Author < ActiveModel::Base
+class Author < ActiveRecord::Base
 
-  normalize_attribute  :name
-
-  normalize_attribute  :hourly_cost, :with => :currency
-
-  normalize_attributes :biography,   :with => :truncate, :length => 12
-
-  normalize_attributes :email_address do |value|
-    value.is_a?(String) ? value.titleize.strip : value
-  end
+  normalize_attribute :name
+  normalize_attribute :first_name,   :with => :strip
+  normalize_attribute :last_name,    :with => :blank
+  normalize_attribute :phone_number, :with => :phone
 
 end

data/spec/models/book.rb

@@ -4,7 +4,11 @@ class Book < ActiveRecord::Base
 
   normalize_attribute  :us_price, :cnd_price, :with => :currency
 
-  normalize_attributes :summary, :with => :truncate, :length => 12
+  normalize_attributes :summary, :with => [ :strip,
+                                            { :truncate => { :length => 12 } },
+                                            :blank
+                                          ]
+
 
   normalize_attributes :title do |value|
     value.is_a?(String) ? value.titleize.strip : value

data/spec/test_helper.rb

@@ -3,6 +3,7 @@ require 'spec'
 require 'active_record'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'attribute_normalizer'
 
 
@@ -23,11 +24,18 @@ AttributeNormalizer.configure do |config|
     end
   end
 
+  config.normalizers[:special_normalizer] = lambda do |value, options|
+    (value.is_a?(String) && value.match(/testing the default normalizer/)) ? 'testing the default normalizer' : value
+  end
+
+  config.default_normalizers = :strip, :special_normalizer, :blank
+
 end
 
 
 require 'connection_and_schema'
 require 'models/book'
+require 'models/author'
 
 
 Spec::Runner.configure do |config|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_normalizer
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Michael Deering
@@ -35,9 +35,13 @@ files:
 - install.txt
 - lib/attribute_normalizer.rb
 - lib/attribute_normalizer/model_inclusions.rb
+- lib/attribute_normalizer/normalizers/blank_normalizer.rb
+- lib/attribute_normalizer/normalizers/phone_normalizer.rb
+- lib/attribute_normalizer/normalizers/strip_normalizer.rb
 - lib/attribute_normalizer/rspec_matcher.rb
 - rails/init.rb
 - spec/attribute_normalizer_spec.rb
+- spec/author_spec.rb
 - spec/book_spec.rb
 - spec/connection_and_schema.rb
 - spec/models/author.rb
@@ -81,6 +85,7 @@ specification_version: 3
 summary: Attribute normalizer that excepts code blocks.
 test_files: 
 - spec/attribute_normalizer_spec.rb
+- spec/author_spec.rb
 - spec/book_spec.rb
 - spec/connection_and_schema.rb
 - spec/models/author.rb