attribute_normalizer 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Deering
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.textile

@@ -0,0 +1,61 @@
+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.
+
+h2. Install as a Ruby gem
+
+  TODO: gem-er-a-size this!
+  
+h2. Install as a Ruby on Rails Plugin
+
+The traditional way.
+
+  ./script/plugin install git://github.com/mdeering/attribute_normalizer.git
+  
+or the old-school but still c00l way!
+
+  piston import git://github.com/mdeering/attribute_normalizer.git vendor/plugins/attribute_normalizer
+  
+or for all you hip gitsters.
+
+  git submodule add git://github.com/mdeering/attribute_normalizer.git vendor/plugins/attribute_normalizer
+  git submodule init
+  
+h2. Usage
+
+This is eager loaded into Active Record.  It is usable inside of other ruby classes outside of ActiveRecord by just including the module AttributeNormalizer.
+
+<pre><code>
+class Klass < ActiveRecord::Base
+  
+  # Can take an array of attributes if you want
+  normalize_attributes :first_name, :last_name
+  
+  normalize_attributes :home_phone_number, :office_phone_number_ do |value|
+    return nil unless value.is_a?(String)
+    value.gsub(/\W/, '').gsub(/^1/, '')
+  end
+  
+end
+
+object = Klass.new
+# Blank normalizes to nil
+object.first_name = ''
+object.first_name # => nil
+
+# Whitespace is cleaned up 
+object.last_name = "\tDeering\n"
+object.last_name # => 'Deering'
+
+# Your given block will be executed to normalize
+object.home_phone_number = '+1 (555) 123.4567'
+object.home_phone_number # => '5551234567'
+</code></pre>
+
+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.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  AUTHOR   = "Michael Deering"
+  EMAIL    = "mdeering@mdeering.com"  
+  GEM      = "attribute_normalizer"
+  HOMEPAGE = "http://github.com/mdeering/attribute_normalizer"  
+  SUMMARY  = "Active Record attribute normalizer that excepts code blocks."
+  
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.author       = AUTHOR
+    s.email        = EMAIL
+    s.files        = %w(MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,spec}/**/*")        
+    s.homepage     = HOMEPAGE 
+    s.name         = GEM    
+    s.require_path = 'lib'       
+    s.summary      = SUMMARY
+  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"
+end
+
+desc 'Default: spec tests.'
+task :default => :spec
+
+desc 'Test the attribute_normalizer plugin.'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c"]
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', '/opt,spec,Library']
+end
+
+desc 'Generate documentation for the attribute_normalizer plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AttributeNormalizer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/attribute_normalizer.rb

@@ -0,0 +1,39 @@
+module AttributeNormalizer
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def normalize_attributes(*attributes, &block)
+
+      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.nil? || (normalized.is_a?(String) && normalized == '') ? nil : normalized
+        end
+
+        klass.send :private, "normalize_#{attribute}"
+
+        src = <<-end_src
+          def #{attribute}
+            @#{attribute} ||= self.class.send(:normalize_#{attribute}, self[:#{attribute}]) unless self[:#{attribute}].nil?
+          end
+
+          def #{attribute}=(#{attribute})
+            @#{attribute} = self[:#{attribute}] = self.class.send(:normalize_#{attribute}, #{attribute})
+          end
+        end_src
+
+        module_eval src, __FILE__, __LINE__
+        
+      end
+      
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib attribute_normalizer])
+ActiveRecord::Base.send(:include, AttributeNormalizer)

data/spec/attribute_normalizer_spec.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'attribute_normalizer'
+
+describe AttributeNormalizer do
+  
+  it 'should add the class method Class#normalize_attributes 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
+    class Klass
+      attr_accessor :attribute
+      include AttributeNormalizer
+      normalize_attributes :attribute
+    end
+    
+    @object = Klass.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
+      @object.send('attribute=', key)
+      @object.send(:attribute).should == value
+    end
+  end
+  
+  
+end

data/spec/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+require 'activesupport'
+require 'activerecord'
+
+Spec::Runner.configure do |config|
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_normalizer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Deering
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mdeering@mdeering.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/attribute_normalizer.rb
+- rails/init.rb
+- spec/attribute_normalizer_spec.rb
+- spec/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mdeering/attribute_normalizer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Active Record attribute normalizer that excepts code blocks.
+test_files: 
+- spec/attribute_normalizer_spec.rb
+- spec/test_helper.rb