normatron 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Fernando Rodrigues da Silva
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Normatron
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Normatron'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/normatron.rb

@@ -0,0 +1,4 @@
+require "normatron/conversors"
+require "normatron/active_record"
+
+ActiveRecord::Base.send :include, Normatron::ActiveRecord

data/lib/normatron/active_record.rb

@@ -0,0 +1,64 @@
+require "active_record"
+
+module Normatron
+  module ActiveRecord
+    include Conversors
+
+    def self.included(base)
+      base.instance_eval do
+        extend ClassMethods
+
+        before_validation :normalize_attributes
+
+        class << self
+          attr_accessor :standardize_options
+        end
+      end
+    end
+
+    module ClassMethods
+      def normalize(*args)
+        # Extract options
+        self.standardize_options ||= {}
+        options = args.extract_options!
+
+        methods = []
+        if options.empty? # Default standardization
+          methods << [:trim, :strip, :nillify]
+        elsif options.has_key? :with
+          methods << options[:with]
+        else
+          raise "Wrong normalization option for #{attribute}, use :with instead."
+        end
+
+        # Make a prettier array
+        methods = methods.flatten.compact
+        methods.map! { |v| v = v.to_sym }
+
+        # Add normalization methods to call
+        args.each do |attribute|
+          standardize_options[attribute] = methods
+        end
+      end
+    end
+
+    def normalize_attributes
+      options = self.class.standardize_options
+
+      options.each do |attribute, methods|
+        value = send("#{attribute}_before_type_cast")  || send(attribute)
+
+        methods.each do |method|
+          # Skip if value is nil originally or the method 'nullify' was called before
+          value = convert(method, value) unless value.nil?
+          if value == :no_method
+            raise ArgumentError, "Method :#{method} cannot be resolved.
+             Check options for #{attribute} in #{klass}", caller
+          end
+        end
+
+        write_attribute attribute, value
+      end
+    end
+  end
+end

data/lib/normatron/conversors.rb

@@ -0,0 +1,91 @@
+require "i18n"
+require "active_support/all"
+
+module Normatron
+  module Conversors
+
+    @@MB_CHARS_METHODS = [:upcase, :downcase, :capitalize, :lstrip, :rstrip, :strip, :titlecase, :titleize]
+    @@SELF_METHODS = [:nillify, :nullify, :nil, :trim, :currency, :integer, :float, :postal_code, :phone, :digits, :phrase]
+
+    def convert(method, value)
+      if @@MB_CHARS_METHODS.include? method
+        value.mb_chars.send(method).to_s
+      elsif @@SELF_METHODS.include? method
+        send("convert_#{method}", value)
+      else
+        :no_method
+      end
+    end
+
+    private
+
+    # Return nil if value is blank or else value itself.
+    def convert_nillify(value)
+      value.blank? ? nil : value
+    end
+    alias :convert_nil      :convert_nillify
+    alias :convert_nullify  :convert_nillify
+
+    # Remove repeated spaces from the string.
+    def convert_trim(value)
+      value.mb_chars.to_s.gsub(/\p{Zs}+/u, ' ')
+    end
+
+    def convert_currency(value)
+      convert_number value, :currency
+    end
+
+    def convert_float(value)
+      convert_number value, :float
+    end
+
+    def convert_integer(value)
+      convert_number value
+    end
+
+    def convert_number(value, type = :integer)
+      return value unless value.is_a?(String) && value.present?
+
+      # Find the first number in the sequence
+      first_number_position = value.index(/\d/)
+      return unless first_number_position # Do nothing if it's don't have any number
+
+      # Is a negative number?
+      negative = value[0..first_number_position].include?("-")
+
+      # Decimal separator on the current locale
+      separator = I18n.t "number#{ '.currency' if type == :currency }.format.separator"
+
+      # Amount of decimal places
+      separator_position = value.rindex(separator)
+      chars_until_separator = separator_position + 1 rescue value.size
+      decimal_places = value.size - chars_until_separator
+
+      # Build number
+      res = convert_digits(value).to_f
+      res *= -1 if negative
+      res /= 10 ** decimal_places
+      res = res.to_i if type == :integer
+
+      res
+    end
+
+    def convert_postal_code(value)
+      res = convert_digits value
+      res.size == 8 ? "%s-%s" % [res[0..4], res[5..7]] : value
+    end
+
+    def convert_phone(value)
+      res = convert_digits value
+      res.size == 10 ? "(%s) %s-%s" % [res[0..1], res[2..5], res[6..9]] : value
+    end
+
+    def convert_digits(value)
+      value.to_s.gsub(/[^\d]/, '')
+    end
+
+    def convert_phrase(value)
+      convert(:trim, convert(:strip, value))
+    end
+  end
+end

data/lib/normatron/version.rb

@@ -0,0 +1,3 @@
+module Normatron
+  VERSION = "0.0.2"
+end

data/lib/tasks/normatron_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :normatron do
+#   # Task goes here
+# end

data/spec/normatron_spec.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Normatron do
+  before :each do
+    TestModel.standardize_options = {}
+  end
+
+  describe "Conversors" do
+    it :capitalize do
+      TestModel.normalize :string_field, :with => :capitalize
+
+      m = TestModel.create :string_field => "áb c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "Áb c, 1 2 3 def ghi i oz    "
+    end
+
+    it :digits do
+      TestModel.normalize :string_field, :with => :digits
+
+      m = TestModel.create :string_field => " 1a 2b 3c 4d 5e 6f "
+      m.string_field.should == "123456"
+    end
+
+    it :downcase do
+      TestModel.normalize :string_field, :with => :downcase
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "   a   b c, 1 2 3 def ghi i oz    "
+    end
+
+    it :phone do
+      TestModel.normalize :string_field, :with => :phone
+
+      m = TestModel.create :string_field => "(99) 9999-9999"
+      m.string_field.should == "(99) 9999-9999"
+
+      m = TestModel.create :string_field => "9999999999"
+      m.string_field.should == "(99) 9999-9999"
+
+      m = TestModel.create :string_field => "999999999"
+      m.string_field.should == "999999999"
+    end
+
+    it :phrase do
+      TestModel.normalize :string_field, :with => :phrase
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "a b c, 1 2 3 DEF GHI i oz"
+    end
+
+    it :postal_code do
+      TestModel.normalize :string_field, :with => :postal_code
+
+      m = TestModel.create :string_field => "88888-888"
+      m.string_field.should == "88888-888"
+
+      m = TestModel.create :string_field => "88888888"
+      m.string_field.should == "88888-888"
+
+      m = TestModel.create :string_field => "8888888"
+      m.string_field.should == "8888888"
+    end
+
+    it :strip do
+      TestModel.normalize :string_field, :with => :strip
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "a   b c, 1 2 3 DEF GHI i oz"
+    end
+
+    it :titlecase do
+      TestModel.normalize :string_field, :with => :titlecase
+
+      m = TestModel.create :string_field => "   aé   áb c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "   Aé   Áb C, 1 2 3 Def Ghi I Oz    "
+    end
+
+    it :upcase do
+      TestModel.normalize :string_field, :with => :upcase
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "   A   B C, 1 2 3 DEF GHI I OZ    "
+    end
+
+
+
+    it :nillify do
+      TestModel.normalize :string_field, :with => :nillify
+
+      m = TestModel.create :string_field => "       "
+      m.string_field.should == nil
+    end
+
+    it :trim do
+      TestModel.normalize :string_field, :with => :trim
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == " a b c, 1 2 3 DEF GHI i oz "
+    end
+
+    it :lstrip do
+      TestModel.normalize :string_field, :with => :lstrip
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "a   b c, 1 2 3 DEF GHI i oz    "
+    end
+
+    it :rstrip do
+      TestModel.normalize :string_field, :with => :rstrip
+
+      m = TestModel.create :string_field => "   a   b c, 1 2 3 DEF GHI i oz    "
+      m.string_field.should == "   a   b c, 1 2 3 DEF GHI i oz"
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :test_models do |t|
+    t.string :string_field
+    t.integer :integer_field
+  end
+end

data/spec/spec_helper.rb

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

data/spec/support/test_model.rb

@@ -0,0 +1,3 @@
+class TestModel < ActiveRecord::Base
+  attr_accessible :string_field, :integer_field
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: normatron
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Rodrigues da Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: ! "    Normatron is a Rails plugin that helps normalize ActiveRecord
+  attributes.\n    Operations such as lowercase an e-mail address or format a phone
+  number before model validations,\n    can be made easily using this plugin.\n"
+email:
+- fernandors87@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/normatron/active_record.rb
+- lib/normatron/conversors.rb
+- lib/normatron/version.rb
+- lib/tasks/normatron_tasks.rake
+- lib/normatron.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- spec/support/test_model.rb
+- spec/normatron_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fernandors87/normatron
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Handle normalization for ActiveRecord attributes
+test_files:
+- spec/support/test_model.rb
+- spec/normatron_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb