attribute_normalizer 0.1.2 → 0.2.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Michael Deering
+Copyright (c) 2010 Michael Deering
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -1,84 +1,128 @@
 h1. Attribute Normalizer
 
-p. I like to keep my Active Record models as strict as possible but I also like the further layer of protection/restriction setting database columns to not allow NULL adds.  Normalizing to nil helps enforce this better by not letting '' slip through the cracks and I can still prevent those who insist on direct DB access from entering in shitty data as much as possible.
+p. A little normalization goes a long way in helping maintain data integrity.
 
-h2. Install as a Ruby gem
+h2. Recent Changes
 
-p. The "attribute_normalizer gem":http://gemcutter.org/gems/attribute_normalizer is hosted over at "Gemcutter":http://gemcutter.org
+* 0.2.0
+** Removed the normalization on reads.
+** Added out of the box support for CassandraObjects
+** Included RSpec matcher _normalizer_attribute_
+** Added the ability to define global normalizers
+** *Strings are no longer get 'strip' called on them before getting passed on to your defined normalization blocks*
 
-h3. Setup Gemcutter as a gem source if you have not already.
+* 0.1.2
+** Changed post-normalization attribute assignment to call super to avoid preventing plugins/gems/hooks to work on the same attribute.
 
-p. It’s fairly simple to set up Gemcutter. Before we start, however, it’s worth making sure that we’ve upgraded to the latest version of RubyGems, which can be done by running
+h2. Supported ORMs
 
-<pre><code>sudo gem update --system</code></pre>
+* Active Record
+* CassandraObjects
 
-p. From the command line. Once RubyGems has updated itself we can then install the Gemcutter gem with
+p. _I will gladly take pull requests to automatically load Attribute Normalizer into your ORM of choice if requested.  To test it out on your ORM just include the AttributeNormalizer module after requiring it._
 
-<pre><code>sudo gem install gemcutter</code></pre>
+<pre><code># your_initializer.rb
+require 'attribute_normalizer'
+YourORM::Base.send :include, AttributeNormalizer</code></pre>
 
-p. After Gemcutter has installed we’ll need to update our gem sources to include gemcutter.org. To do this we run *gem tumble*.
-
-<pre><code>$ gem tumble
-Thanks for using Gemcutter!
-Your gem sources are now:
-- http://gemcutter.org
-- http://gems.rubyforge.org/
-- http://gems.github.com
-</code></pre>
-
-h3. Install the Attribute Normalizer gem
+h2. Install
 
 <pre><code>sudo gem install attribute_normalizer</code></pre>
 
-h2. Install as a Ruby on Rails Plugin
+p. Then just required it.  Rails usages is as follows.
 
-The traditional way.
+<pre><code># config/environment.rb
+  gem.config 'attribute_normalizer'</code></pre>
 
-  ./script/plugin install git://github.com/mdeering/attribute_normalizer.git
-
-or the old-school but still c00l way!
+p. It also still works as a traditional Rails plugin.
 
-  piston import git://github.com/mdeering/attribute_normalizer.git vendor/plugins/attribute_normalizer
+  ./script/plugin install git://github.com/mdeering/attribute_normalizer.git
 
-or for all you hip gitsters.
+h2. Usage
 
-  git submodule add git://github.com/mdeering/attribute_normalizer.git vendor/plugins/attribute_normalizer
-  git submodule init
+p. Lets create a quick test/spec for what we want to accomplish as far as normalization using the built in RSpec matcher.
 
-h2. Usage
+<pre><code># spec/models/book_spec.rb
+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')}
+end</code></pre>
 
-This is eager loaded into Active Record.  It is usable inside of other ruby classes outside of ActiveRecord by just including the module AttributeNormalizer.
+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>
-class Klass < ActiveRecord::Base
+<pre><code># config/initializers/attribute_normalizer.rb
+AttributeNormalizer.configure do |config|
 
-  # Can take an array of attributes if you want
-  normalize_attributes :first_name, :last_name
+  config.normalizers[:currency] = lambda do |value, options|
+    value.is_a?(String) ? value.gsub(/[^0-9\.]+/, '') : value
+  end
 
-  normalize_attributes :home_phone_number, :office_phone_number_ do |value|
-    value.is_a?(String) ? value.gsub(/\W/, '').gsub(/^1/, '') : nil
+  config.normalizers[:truncate] = lambda do |text, options|
+    if text.is_a?(String)
+      options.reverse_merge!(:length => 30, :omission => "...")
+      l = options[:length] - options[:omission].mb_chars.length
+      chars = text.mb_chars
+      (chars.length > options[:length] ? chars[0...l] + options[:omission] : text).to_s
+    else
+      text
+    end
   end
 
 end
+</code></pre>
+
+The _normalize_attributes_ method is eager loaded into your ORM.  _normalize_attribute_ is aliased to _normalized_attributes_ and both can take in a single attribute or an array of attributes.
 
-object = Klass.new
-# Blank normalizes to nil
-object.first_name = ''
-object.first_name # => nil
+<pre><code>class Book < ActiveRecord::Base
 
-# Whitespace is cleaned up
-object.last_name = "\tDeering\n"
-object.last_name # => 'Deering'
+  # By default it will strip leading and trailing whitespace
+  # and set to nil if blank.
+  normalize_attributes :author, :publisher
 
-# Your given block will be executed to normalize
-object.home_phone_number = '+1 (555) 123.4567'
-object.home_phone_number # => '5551234567'
+  # 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
+
+  # You can also define your normalization block inline.
+  normalize_attribute :title do |value|
+    value.is_a?(String) ? value.titleize.strip : value
+  end
+
+end</code></pre>
+
+p. All the specs will pass now.  Here is quick look at the behaviour from a console.
+
+<pre><code>summary = 'Here is my summary that is a little to long'
+title   = 'pick up chicks with magic tricks'
+book    = Book.create!(:author => '', :price => '$3,450.89', :summary => summary, :title => title)
+book.author  # => nil
+book.price   # => 3450.89
+book.summary # => 'Here is m...'
+book.title   # => 'Pick Up Chicks With Magic Tricks'
 </code></pre>
 
+h2. Test Helpers
+
+p. If you are running RSpec there is matcher available for use.  Usage can been seen above.  Include it as follows.
+
+<pre><code># spec/spec_helper.rb
+# ...
+
+Spec::Runner.configure do |config|
+  # ...
+  config.include AttributeNormalizer::RSpecMatcher, :type => :models
+end</code></pre>
+
+p. _I will gladly take a patch to add a macro to Test::Unit if someone submits it._
+
 h2. Credits
 
 Original module code and concept was taken from "Dan Kubb":http://github.com/dkubb during a project we worked on together.  I found that I was consistently using this across all my projects so I wanted to plugin-er-size and gem this up for easy reuse.
 
 h2. Copyright
 
-Copyright (c) 2009 "Michael Deering(Edmonton Ruby on Rails)":http://mdeering.com See MIT-LICENSE for details.
+Copyright (c) 2009-2010 "Michael Deering(Edmonton Ruby on Rails)":http://mdeering.com See MIT-LICENSE for details.

data/Rakefile

@@ -4,36 +4,36 @@ require 'spec/rake/spectask'
 
 begin
   AUTHOR   = "Michael Deering"
-  EMAIL    = "mdeering@mdeering.com"  
+  EMAIL    = "mdeering@mdeering.com"
   GEM      = "attribute_normalizer"
-  HOMEPAGE = "http://github.com/mdeering/attribute_normalizer"  
-  SUMMARY  = "Active Record attribute normalizer that excepts code blocks."
-  
+  HOMEPAGE = "http://github.com/mdeering/attribute_normalizer"
+  SUMMARY  = "Attribute normalizer that excepts code blocks."
+
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.author       = AUTHOR
     s.email        = EMAIL
-    s.files        = %w(install.rb install.txt MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,spec}/**/*")        
-    s.homepage     = HOMEPAGE 
-    s.name         = GEM    
-    s.require_path = 'lib'       
+    s.files        = %w(install.rb install.txt MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,spec}/**/*")
+    s.homepage     = HOMEPAGE
+    s.name         = GEM
+    s.require_path = 'lib'
     s.summary      = SUMMARY
     s.post_install_message = %q[
-      =============================
-      Attribute Normalizer News:
+-----------------------------------------------------------------------
+  Attribute Normalizer News:
 
-      I am looking for feedback on the roadmap for this gem.  Please visit
-      http://github.com/mdeering/attribute_normalizer/blob/master/ROADMAP.textile
-      and send your comments, suggestions, and pull requests.
+  There are lots of changes from the 0.1.2 release to the 0.2.0 release!
+  Change log is here http://github.com/mdeering/attribute_normalizer/blob/master/ROADMAP.textile
+  Docs have been updated here http://github.com/mdeering/attribute_normalizer
 
-      Cheers,
-      Michael Deering http://mdeering.com
-      =============================      
+  Cheers,
+  Michael Deering http://mdeering.com
+-----------------------------------------------------------------------
     ]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
 end
 
 desc 'Default: spec tests.'

data/install.txt

@@ -1,10 +1,10 @@
 -----------------------------------------------------------------------
   Attribute Normalizer News:
-  
-  I am looking for feedback on the roadmap for this gem.  Please visit
-  http://github.com/mdeering/attribute_normalizer/blob/master/ROADMAP.textile
-  and send your comments, suggestions, and pull requests.
-  
+
+  There are lots of changes from the 0.1.2 release to the 0.2.0 release!
+  Change log is here http://github.com/mdeering/attribute_normalizer/blob/master/ROADMAP.textile
+  Docs have been updated here http://github.com/mdeering/attribute_normalizer
+
   Cheers,
   Michael Deering http://mdeering.com
 -----------------------------------------------------------------------

data/lib/attribute_normalizer.rb

@@ -1,31 +1,54 @@
 module AttributeNormalizer
 
+  class MissingNormalizer < ArgumentError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
   def self.included(base)
     base.extend ClassMethods
   end
 
+  class Configuration
+
+    attr_accessor :normalizers
+
+    def initialize
+      @normalizers = {}
+    end
+
+  end
+
   module ClassMethods
 
     def normalize_attributes(*attributes, &block)
+      options = attributes.extract_options!
 
       attributes.each do |attribute|
 
         klass = class << self; self end
 
         klass.send :define_method, "normalize_#{attribute}" do |value|
-          value = value.strip if value.is_a?(String)
-          normalized = block_given? && !value.blank? ? yield(value) : value
+          normalized = if block_given? && !value.blank?
+            yield(value)
+          elsif !options[:with].nil? && !value.blank?
+            raise AttributeNormalizer::MissingNormalizer.new("No normalizer was found for #{options[:with]}") unless AttributeNormalizer.configuration.normalizers.has_key?(options[:with])
+            this = AttributeNormalizer.configuration.normalizers[options.delete(:with)].call(value, options)
+          else
+             value.is_a?(String) ? value.strip : value
+           end
           normalized.nil? || (normalized.is_a?(String) && normalized == '') ? nil : normalized
         end
 
         klass.send :private, "normalize_#{attribute}"
 
         src = <<-end_src
-          def #{attribute}
-            value = super
-            value.nil? ? value : self.class.send(:normalize_#{attribute}, value)
-          end
-
           def #{attribute}=(value)
             super(self.class.send(:normalize_#{attribute}, value))
           end
@@ -40,6 +63,50 @@ module AttributeNormalizer
     alias :normalize_attribute :normalize_attributes
 
   end
+
+  module RSpecMatcher
+
+    def normalize_attribute(attribute)
+      NormalizeAttribute.new(attribute)
+    end
+
+    class NormalizeAttribute
+
+      def description
+        "normalize #{@attribute} from #{@from.nil? ? 'nil' : "\"#{@from}\""} to #{@to.nil? ? 'nil' : "\"#{@to}\""}"
+      end
+
+      def failure_message
+        "#{@attribute} did not normalize as expected! \"#{@subject.send(@attribute)}\" != #{@to.nil? ? 'nil' : "\"#{@to}\""}"
+      end
+
+      def from(value)
+        @from = value
+        self
+      end
+
+      def initialize(attribute)
+        @attribute = attribute
+        @from = ''
+      end
+
+      def matches?(subject)
+        @subject = subject
+        @subject.send("#{@attribute}=", @from)
+        return false unless @subject.send(@attribute) == @to
+        true
+      end
+
+      def to(value)
+        @to = value
+        self
+      end
+
+    end
+
+  end
+
 end
 
-ActiveRecord::Base.send(:include, AttributeNormalizer)
+ActiveRecord::Base.send(:include, AttributeNormalizer)    if defined?(ActiveRecord::Base)
+CassandraObject::Base.send(:include, AttributeNormalizer) if defined?(CassandraObject::Base)

data/spec/attribute_normalizer_spec.rb

@@ -1,123 +1,15 @@
 require File.dirname(__FILE__) + '/test_helper'
-require 'attribute_normalizer'
 
 describe AttributeNormalizer do
 
-  it 'should add the class method Class#normalize_attributes when included' do
+  it 'should add the class method Class#normalize_attributes and Class#normalize_attribute when included' do
 
     klass = Class.new do
       include AttributeNormalizer
     end
 
     klass.respond_to?(:normalize_attributes).should be_true
-  end
-
-end
-
-describe '#normalize_attributes without a block' do
-
-  before do
-
-    class Klass
-      attr_accessor :attribute
-      include AttributeNormalizer
-      normalize_attributes :attribute
-    end
-
-  end
-
-  {
-    ' spaces in front and back ' => 'spaces in front and back',
-    "\twe hate tabs!\t"          => 'we hate tabs!'
-  }.each do |key, value|
-    it "should normalize '#{key}' to '#{value}'" do
-      Klass.send(:normalize_attribute, key).should == value
-    end
-  end
-
-end
-
-describe '#normalize_attributes with a block' do
-
-  before do
-
-    class Klass
-      attr_accessor :attribute
-      include AttributeNormalizer
-      normalize_attributes :attribute do |value|
-        value = value.strip.upcase if value.is_a?(String)
-        value = value * 2          if value.is_a?(Fixnum)
-        value = value * 0.5        if value.is_a?(Float)
-        value
-      end
-    end
-
-    @object = Klass.new
-
-  end
-
-  {
-    "\tMichael Deering" => 'MICHAEL DEERING',
-    2                   => 4,
-    2.0                 => 1.0
-  }.each do |key, value|
-    it "should normalize '#{key}' to '#{value}'" do
-      Klass.send(:normalize_attribute, key).should == value
-    end
-  end
-
-end
-
-describe 'with an instance' do
-
-  before do
-    User.class_eval do
-      normalize_attributes :name
-    end
-    @user = User.new
-  end
-
-  {
-    ' spaces in front and back ' => 'spaces in front and back',
-    "\twe hate tabs!\t"          => 'we hate tabs!'
-  }.each do |key, value|
-    it "should normalize '#{key}' to '#{value}'" do
-      @user.name = key
-      @user.name.should == value
-    end
-  end
-
-  context 'when another instance of the same saved record has been changed' do
-
-    before do
-      @user = User.create!(:name => 'Jimi Hendrix')
-      @user2 = User.find(@user.id)
-      @user2.update_attributes(:name => 'Thom Yorke')
-    end
-
-    it "should reflect the change when the record is reloaded" do
-      lambda { @user.reload }.should change(@user, :name).from('Jimi Hendrix').to('Thom Yorke')
-    end
-  end
-
-end
-
-describe 'normalize_attribute is aliased to normalize_attributes' do
-  before do
-    User.class_eval do
-      normalize_attribute :name
-    end
-    @user = User.new
-  end
-
-  {
-    ' spaces in front and back ' => 'spaces in front and back',
-    "\twe hate tabs!\t"          => 'we hate tabs!'
-  }.each do |key, value|
-    it "should normalize '#{key}' to '#{value}'" do
-      @user.name = key
-      @user.name.should == value
-    end
+    klass.respond_to?(:normalize_attribute).should  be_true
   end
 
 end

data/spec/book_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+describe Book do
+
+  it { should normalize_attribute(:author).from(' Michael Deering ').to('Michael Deering') }
+
+  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')}
+
+  context 'normalization should not interfear with other hooks and aliases on the attribute assignment' do
+
+    before do
+      @book = Book.create!(:title => 'Original Title')
+    end
+
+    it 'should still reflect that the attribute has been changed through the call to super' do
+      lambda { @book.title = 'New Title' }.should change(@book, :title_changed?).from(false).to(true)
+    end
+
+  end
+
+  context 'when another instance of the same saved record has been changed' do
+
+    before do
+      @book = Book.create!(:title => 'Original Title')
+      @book2 = Book.find(@book.id)
+      @book2.update_attributes(:title => 'New Title')
+    end
+
+    it "should reflect the change when the record is reloaded" do
+      lambda { @book.reload }.should change(@book, :title).from('Original Title').to('New Title')
+    end
+
+  end
+
+end

data/spec/test_helper.rb

@@ -3,17 +3,55 @@ require 'spec'
 require 'active_support'
 require 'active_record'
 
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'attribute_normalizer'
+
+AttributeNormalizer.configure do |config|
+
+  config.normalizers[:currency] = lambda do |value, options|
+    value.is_a?(String) ? value.gsub(/[^0-9\.]+/, '') : value
+  end
+
+  config.normalizers[:truncate] = lambda do |text, options|
+    if text.is_a?(String)
+      options.reverse_merge!(:length => 30, :omission => "...")
+      l = options[:length] - options[:omission].mb_chars.length
+      chars = text.mb_chars
+      (chars.length > options[:length] ? chars[0...l] + options[:omission] : text).to_s
+    else
+      text
+    end
+  end
+
+end
+
 ActiveRecord::Base.establish_connection({ :database => ":memory:", :adapter => 'sqlite3', :timeout => 500 })
 
 ActiveRecord::Schema.define do
-  create_table :users, :force => true do |t|
-    t.string :name
+  create_table :books, :force => true do |t|
+    t.string  :author
+    t.string  :isbn
+    t.decimal :price
+    t.string  :summary
+    t.string  :title
   end
 end
 
-class User < ActiveRecord::Base; end
+class Book < ActiveRecord::Base
+
+  normalize_attribute  :author
+
+  normalize_attribute  :price, :with => :currency
+
+  normalize_attributes :summary, :with => :truncate, :length => 12
+
+  normalize_attributes :title do |value|
+    value.is_a?(String) ? value.titleize.strip : value
+  end
+
+end
 
 Spec::Runner.configure do |config|
+  config.include AttributeNormalizer::RSpecMatcher, :type => :models
 end
 
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_normalizer
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Deering
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 -07:00
+date: 2010-05-14 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -30,12 +35,15 @@ files:
 - lib/attribute_normalizer.rb
 - rails/init.rb
 - spec/attribute_normalizer_spec.rb
+- spec/book_spec.rb
 - spec/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/mdeering/attribute_normalizer
 licenses: []
 
-post_install_message: "\n      =============================\n      Attribute Normalizer News:\n\n      I am looking for feedback on the roadmap for this gem.  Please visit\n      http://github.com/mdeering/attribute_normalizer/blob/master/ROADMAP.textile\n      and send your comments, suggestions, and pull requests.\n\n      Cheers,\n      Michael Deering http://mdeering.com\n      =============================      \n    "
+post_install_message: "\n\
+  -----------------------------------------------------------------------\n  Attribute Normalizer News:\n\n  There are lots of changes from the 0.1.2 release to the 0.2.0 release!\n  Change log is here http://github.com/mdeering/attribute_normalizer/blob/master/ROADMAP.textile\n  Docs have been updated here http://github.com/mdeering/attribute_normalizer\n\n  Cheers,\n  Michael Deering http://mdeering.com\n\
+  -----------------------------------------------------------------------\n    "
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -44,21 +52,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Active Record attribute normalizer that excepts code blocks.
+summary: Attribute normalizer that excepts code blocks.
 test_files: 
 - spec/attribute_normalizer_spec.rb
+- spec/book_spec.rb
 - spec/test_helper.rb