normalize_attributes 0.1.3

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem "rspec", "2.0.0.rc"
+gem "activerecord", "3.0.0"
+gem "sqlite3-ruby"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.1)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.0)
+  rspec (= 2.0.0.rc)
+  sqlite3-ruby

data/README.rdoc

@@ -0,0 +1,73 @@
+= Normalize Attributes
+
+Sometimes you want to normalize data before saving it to the database like down casing e-mails, removing spaces and so on. This Rails plugin allows you to do so in a simple way.
+
+== Usage
+
+To install:
+
+  gem install normalize_attributes
+
+Then on your model:
+
+  class User < ActiveRecord::Base
+    normalize_attribute :email, :with => :downcase
+  end
+
+The example above will normalize your <tt>:email</tt> attribute on the <tt>before_save</tt> callback.
+
+You can specify multiple attributes
+
+  normalize_attributes :email, :username, :with => :downcase
+
+You can use a block
+
+  normalize_attribute :name do |value|
+    value.squish
+  end
+
+You can combine both
+
+  normalize_attribute :name, :with => :downcase do |value|
+    value.squish
+  end
+
+The <tt>squish</tt> method is the default normalizer for strings. All you need to is specify the attribute:
+
+  normalize_attribute :content
+
+The <tt>compact</tt> method is the default normalizer for arrays (when using <tt>serialize</tt> method):
+
+  class User < ActiveRecord::Base
+    serialize :preferences, Array
+    normalize_attribute :preferences
+  end
+
+The <tt>normalize_attributes</tt> method is aliased as <tt>normalize</tt>, <tt>normalize_attribute</tt>, <tt>normalize_attr</tt>, and <tt>normalize_attrs</tt>.
+
+== Maintainer
+
+* Nando Vieira (http://nandovieira.com.br)
+
+== License:
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,32 @@
+require "rake"
+require "rspec/core/rake_task"
+require "./lib/normalize_attributes/version"
+
+desc "Default: run specs."
+task :default => :spec
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = %w[-Ilib -Ispec]
+end
+
+begin
+  require "jeweler"
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "normalize_attributes"
+    gem.version = NormalizeAttributes::Version::STRING
+    gem.summary = "Normalize ActiveRecord attributes"
+    gem.description = "Normalize ActiveRecord attributes"
+    gem.authors = ["Nando Vieira"]
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/normalize_attributes"
+    gem.has_rdoc = false
+    gem.add_dependency "activerecord"
+    gem.files = FileList["{Gemfile,Gemfile.lock,Rakefile,MIT-LICENSE,normalize_attributes.gemspec,README.rdoc}", "{lib,spec,templates}/**/*"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "You don't Jeweler installed, so you won't be able to build gems."
+end

data/lib/normalize_attributes.rb

@@ -0,0 +1,4 @@
+require "active_record"
+require "active_support/core_ext/string/filters"
+require "normalize_attributes/version"
+require "normalize_attributes/active_record"

data/lib/normalize_attributes/active_record.rb

@@ -0,0 +1,69 @@
+module NormalizeAttributes
+  module ActiveRecord
+    def self.included(base)
+      base.instance_eval do
+        extend ClassMethods
+        include InstanceMethods
+        before_save :normalize_attributes
+
+        class << self
+          attr_accessor :normalize_attributes_options
+        end
+      end
+    end
+
+    module ClassMethods
+      def normalize_attributes(*args, &block)
+        self.normalize_attributes_options ||= {}
+        options = args.extract_options!
+
+        args.each do |attr_name|
+          attr_name = attr_name.to_sym
+
+          normalize_attributes_options.tap do |o|
+            o[attr_name] ||= []
+            o[attr_name] << options[:with] if options[:with]
+            o[attr_name] << block if block_given?
+          end
+        end
+      end
+
+      alias_method :normalize, :normalize_attributes
+      alias_method :normalize_attribute, :normalize_attributes
+      alias_method :normalize_attr, :normalize_attributes
+      alias_method :normalize_attrs, :normalize_attributes
+    end
+
+    module InstanceMethods
+      private
+      def normalize_attributes
+        options = self.class.normalize_attributes_options || {}
+
+        options.each do |attr_name, normalizers|
+          value = self.send(attr_name)
+
+          if normalizers.empty?
+            case value
+            when String
+              normalizers << :squish
+            when Array
+              normalizers << :compact
+            end
+          end
+
+          [normalizers].flatten.each do |normalizer|
+            if normalizer.respond_to?(:call)
+              value = normalizer.call(value)
+            elsif value.respond_to?(normalizer)
+              value = value.send(normalizer)
+            end
+          end
+
+          write_attribute attr_name, value
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, NormalizeAttributes::ActiveRecord

data/lib/normalize_attributes/version.rb

@@ -0,0 +1,8 @@
+module NormalizeAttributes
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 3
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/normalize_attributes.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{normalize_attributes}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nando Vieira"]
+  s.date = %q{2010-10-07}
+  s.description = %q{Normalize ActiveRecord attributes}
+  s.email = %q{fnando.vieira@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+     "Gemfile.lock",
+     "README.rdoc",
+     "Rakefile",
+     "lib/normalize_attributes.rb",
+     "lib/normalize_attributes/active_record.rb",
+     "lib/normalize_attributes/version.rb",
+     "normalize_attributes.gemspec",
+     "spec/normalize_attributes_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb",
+     "spec/support/token.rb",
+     "spec/support/user.rb"
+  ]
+  s.homepage = %q{http://github.com/fnando/normalize_attributes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Normalize ActiveRecord attributes}
+  s.test_files = [
+    "spec/normalize_attributes_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb",
+     "spec/support/token.rb",
+     "spec/support/user.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/spec/normalize_attributes_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+describe "Normalize Attributes" do
+  before do
+    User.normalize_attributes_options = {}
+  end
+
+  it "should respond to aliases" do
+    User.should respond_to(:normalize)
+    User.should respond_to(:normalize_attrs)
+    User.should respond_to(:normalize_attr)
+    User.should respond_to(:normalize_attribute)
+  end
+
+  it "should apply single normalization method" do
+    User.normalize_attribute :email, :with => :downcase
+    user = User.create(:email => "JOHN@DOE.COM")
+
+    user.email.should == "john@doe.com"
+  end
+
+  it "should apply multiple normalization methods" do
+    User.normalize_attribute :email, :with => [:downcase, :reverse]
+    user = User.create(:email => "JOHN@DOE.COM")
+
+    user.email.should == "moc.eod@nhoj"
+  end
+
+  it "should apply proc" do
+    User.normalize_attribute(:email) {|v| v.downcase }
+    user = User.create(:email => "JOHN@DOE.COM")
+
+    user.email.should == "john@doe.com"
+  end
+
+  it "should combine both method names and procs as normalization methods" do
+    User.normalize_attribute(:email, :with => :downcase) {|v| v.reverse }
+    user = User.create(:email => "JOHN@DOE.COM")
+
+    user.email.should == "moc.eod@nhoj"
+  end
+
+  it "should normalize multiple attributes" do
+    User.normalize_attributes :email, :username, :with => :downcase
+    user = User.create(:email => "JOHN@DOE.COM", :username => "JOHN")
+
+    user.email.should == "john@doe.com"
+    user.username.should == "john"
+  end
+
+  it "should not apply on associations" do
+    User.normalize_attributes :email, :with => :downcase
+    user = User.create(:email => "JOHN@DOE.COM", :username => "JOHN")
+
+    expect {
+      user.tokens.create!
+    }.to_not raise_error
+  end
+
+  it "should apply default filter on strings" do
+    User.normalize_attributes :email
+    user = User.create(:email => "    \n\t    john@doe.com    \t\t\n\r\n", :username => "john")
+
+    user.email.should == "john@doe.com"
+  end
+
+  it "should apply default filter on arrays" do
+    User.normalize_attributes :preferences
+    user = User.create(:preferences => [nil, :games, :music])
+    user.preferences.should == [:games, :music]
+  end
+
+  it "should not apply default filter on unknown objects" do
+    User.normalize_attributes :username
+
+    expect {
+      user = User.create(:username => 100)
+      user.username.should == 100
+    }.to_not raise_error
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :email, :username
+    t.text :preferences
+  end
+
+  create_table :tokens do |t|
+    t.string :name
+    t.references :user
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "rspec"
+require "normalize_attributes"
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+
+# Load database schema
+load "schema.rb"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}

data/spec/support/token.rb

@@ -0,0 +1,3 @@
+class Token < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/support/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  has_many :tokens
+  serialize :preferences
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: normalize_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-07 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Normalize ActiveRecord attributes
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/normalize_attributes.rb
+- lib/normalize_attributes/active_record.rb
+- lib/normalize_attributes/version.rb
+- normalize_attributes.gemspec
+- spec/normalize_attributes_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/token.rb
+- spec/support/user.rb
+has_rdoc: true
+homepage: http://github.com/fnando/normalize_attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Normalize ActiveRecord attributes
+test_files: 
+- spec/normalize_attributes_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/token.rb
+- spec/support/user.rb