strip_attributes 0.9.0

data/lib/strip_attributes/shoulda/macros.rb

@@ -0,0 +1,33 @@
+require "shoulda/active_record"
+
+module StripAttributes
+  module Shoulda
+    module Macros
+      def should_strip_attributes(*attributes)
+        klass = respond_to?(:described_type) ? described_type : model_class
+        attributes.each do |attribute|
+          attribute = attribute.to_sym
+          should "strip whitespace from #{attribute}" do
+            object = get_instance_of(klass)
+            object.send("#{attribute}=", " string ")
+            object.valid?
+            assert_equal "string", object.send(attribute)
+          end
+        end
+      end
+
+      def should_not_strip_attributes(*attributes)
+        klass = respond_to?(:described_type) ? described_type : model_class
+        attributes.each do |attribute|
+          attribute = attribute.to_sym
+          should "not strip whitespace from #{attribute}" do
+            object = get_instance_of(klass)
+            object.send("#{attribute}=", " string ")
+            object.valid?
+            assert_equal " string ", object.send(attribute)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strip_attributes/shoulda.rb

@@ -0,0 +1 @@
+require "strip_attributes/shoulda/macros"

data/lib/strip_attributes.rb

@@ -0,0 +1,33 @@
+module StripAttributes
+  VERSION = "0.9.0"
+
+  # Strips whitespace from model fields and converts blank values to nil.
+  def strip_attributes!(options = nil)
+    before_validation do |record|
+      attributes = StripAttributes.narrow(record.attributes, options)
+      attributes.each do |attr, value|
+        if value.respond_to?(:strip)
+          record[attr] = (value.blank?) ? nil : value.strip
+        end
+      end
+    end
+  end
+
+  # Necessary because Rails has removed the narrowing of attributes using :only
+  # and :except on Base#attributes
+  def self.narrow(attributes, options)
+    if options.nil?
+      attributes
+    else
+      if except = options[:except]
+        except = Array(except).collect { |attribute| attribute.to_s }
+        attributes.except(*except)
+      elsif only = options[:only]
+        only = Array(only).collect { |attribute| attribute.to_s }
+        attributes.slice(*only)
+      else
+        raise ArgumentError, "Options does not specify :except or :only (#{options.keys.inspect})"
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'strip_attributes'
+ActiveRecord::Base.extend(StripAttributes)

data/test/strip_attributes_test.rb

@@ -0,0 +1,96 @@
+require "test_helper"
+
+module MockAttributes
+  def self.included(base)
+    base.column :foo,  :string
+    base.column :bar,  :string
+    base.column :biz,  :string
+    base.column :baz,  :string
+    base.column :bang, :string
+  end
+end
+
+class StripAllMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_attributes!
+end
+
+class StripOnlyOneMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_attributes! :only => :foo
+end
+
+class StripOnlyThreeMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_attributes! :only => [:foo, :bar, :biz]
+end
+
+class StripExceptOneMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_attributes! :except => :foo
+end
+
+class StripExceptThreeMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_attributes! :except => [:foo, :bar, :biz]
+end
+
+class StripAttributesTest < Test::Unit::TestCase
+  def setup
+    @init_params = { :foo => "\tfoo", :bar => "bar \t ", :biz => "\tbiz ", :baz => "", :bang => " " }
+  end
+
+  def test_should_exist
+    assert Object.const_defined?(:StripAttributes)
+  end
+
+  def test_should_strip_all_fields
+    record = StripAllMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo", record.foo
+    assert_equal "bar", record.bar
+    assert_equal "biz", record.biz
+    assert_nil record.baz
+    assert_nil record.bang
+  end
+
+  def test_should_strip_only_one_field
+    record = StripOnlyOneMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo",     record.foo
+    assert_equal "bar \t ", record.bar
+    assert_equal "\tbiz ",  record.biz
+    assert_equal "",        record.baz
+    assert_equal " ",       record.bang
+  end
+
+  def test_should_strip_only_three_fields
+    record = StripOnlyThreeMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo", record.foo
+    assert_equal "bar", record.bar
+    assert_equal "biz", record.biz
+    assert_equal "",    record.baz
+    assert_equal " ",   record.bang
+  end
+
+  def test_should_strip_all_except_one_field
+    record = StripExceptOneMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "\tfoo", record.foo
+    assert_equal "bar",   record.bar
+    assert_equal "biz",   record.biz
+    assert_nil record.baz
+    assert_nil record.bang
+  end
+
+  def test_should_strip_all_except_three_fields
+    record = StripExceptThreeMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "\tfoo",   record.foo
+    assert_equal "bar \t ", record.bar
+    assert_equal "\tbiz ",  record.biz
+    assert_nil record.baz
+    assert_nil record.bang
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+begin require 'redgreen' if ENV['TM_FILENAME'].nil?; rescue LoadError; end
+
+PLUGIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+$LOAD_PATH.unshift "#{PLUGIN_ROOT}/lib"
+load "#{PLUGIN_ROOT}/rails/init.rb"
+
+class ActiveRecord::Base
+  alias_method :save, :valid?
+  def self.columns()
+    @columns ||= []
+  end
+
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    @columns ||= []
+    @columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type, null)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: strip_attributes
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan McGeary
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70312180321220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70312180321220
+description: StripAttributes automatically strips all ActiveRecord model attributes
+  of leading and trailing whitespace before validation. If the attribute is blank,
+  it strips the value to nil.
+email:
+- ryan@mcgeary.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/strip_attributes/shoulda/macros.rb
+- lib/strip_attributes/shoulda.rb
+- lib/strip_attributes.rb
+- rails/init.rb
+- test/strip_attributes_test.rb
+- test/test_helper.rb
+homepage: https://github.com/rmm5t/strip_attributes
+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'
+      segments:
+      - 0
+      hash: 1913689736864890134
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1913689736864890134
+requirements: []
+rubyforge_project: strip_attributes
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Whitespace cleanup for ActiveRecord attributes
+test_files:
+- test/strip_attributes_test.rb
+- test/test_helper.rb