auto_strip_attributes 1.0.0

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.loadpath
+.project
+.idea
+.redcar

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in auto_strip_attributes.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# AutoStripAttributes
+
+AutoStripAttributes helps to remove unnecessary whitespaces from ActiveRecord or ActiveModel attributes.
+It's good for removing accidental spaces from user inputs (e.g. when user copy/pastes some value to a form and the value has extra spaces at the end).
+
+It works by adding a before_validation hook to the record. No other methods are added. Gem is kept as simple as possible.
+
+Gem has option to set empty strings to nil or to remove extra spaces inside the string.
+
+## Howto / examples
+
+Include gem in your Gemfile:
+
+```ruby
+gem "auto_strip_attributes", "~> 1.0"
+```
+
+```ruby
+class User < ActiveRecord::Base
+
+  # Normal usage where " aaa   bbb\t " changes to "aaa bbb"
+  auto_strip_attributes :nick, :comment
+
+  # Squeezes spaces inside the string: "James   Bond  " => "James Bond"
+  auto_strip_attributes :name, :squish => true
+
+  # Won't set to null even if string is blank. "   " => ""
+  auto_strip_attributes :email, :nullify => false
+end
+```
+
+# Support
+
+Submit suggestions or feature requests as a GitHub Issue or Pull Request. Remember to update tests. Tests are quite extensive.
+
+## Similar gems
+
+There are many similar gems. Most of those don't have :squish or :nullify options. Those gems
+might have some extra methods whereas this gem is kept as simple as possible.
+
+- https://github.com/phatworx/acts_as_strip
+- https://github.com/rmm5t/strip_attributes
+- https://github.com/thomasfedb/attr_cleaner
+
+# Licence
+
+Released under the MIT license (http://www.opensource.org/licenses/mit-license.php)
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "rake/testtask"
+require "bundler/gem_tasks"
+require "bundler/setup"
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Run tests for gem."
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end

data/auto_strip_attributes.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "auto_strip_attributes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "auto_strip_attributes"
+  s.version     = AutoStripAttributes::VERSION
+  s.authors     = ["Olli Huotari"]
+  s.email       = ["olli.huotari@iki.fi"]
+  s.homepage    = "https://github.com/holli/auto_strip_attributes"
+  s.summary     = "Removes unnecessary whitespaces in attributes. Extension to ActiveRecord or ActiveModel."
+  s.description = "AutoStripAttributes helps to remove unnecessary whitespaces from ActiveRecord or ActiveModel attributes. It's good for removing accidental spaces from user inputs. It works by adding a before_validation hook to the record. It has option to set empty strings to nil or to remove extra spaces inside the string."
+
+  s.rubyforge_project = "auto_strip_attributes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_runtime_dependency "activemodel", "~> 3.0"
+
+  s.add_development_dependency "activerecord", "~> 3.0"
+  s.add_development_dependency "minitest",  "~> 2.5.0"
+  s.add_development_dependency 'ruby-debug'
+  s.add_development_dependency 'rake'
+end

data/lib/auto_strip_attributes.rb

@@ -0,0 +1,37 @@
+require "auto_strip_attributes/version"
+
+module AutoStripAttributes
+
+  def auto_strip_attributes(*attributes)
+    options = {:nullify => true, :squish => false}
+    if attributes.last.is_a?(Hash)
+      options = options.merge(attributes.pop)
+    end
+
+    attributes.each do |attribute|
+      before_validation do |record|
+        value = record.send(attribute)
+        #if value.respond_to?('strip')
+        if value.respond_to?(:strip)
+          value_stripped = (options[:nullify] && value.blank?) ? nil : value.strip
+
+          # gsub(/\s+/, ' ') is same as in Rails#String.squish http://api.rubyonrails.org/classes/String.html#method-i-squish-21
+          value_stripped = value_stripped.gsub(/\s+/, ' ') if options[:squish] && value_stripped.respond_to?(:gsub)
+
+          record[attribute] = value_stripped
+
+          # Alternate way would be to use send(attribute=)
+          # But that would end up calling =-method twice, once when setting, once in before_validate
+          # if (attr != attr_stripped)
+          #   record.send("#{attribute}=", value_stripped) # does add some overhead, attribute= will be called before each validation
+          # end
+        end
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.send(:extend, AutoStripAttributes) if defined? ActiveRecord
+#ActiveModel::Validations::HelperMethods.send(:include, AutoStripAttributes)
+

data/lib/auto_strip_attributes/version.rb

@@ -0,0 +1,4 @@
+module AutoStripAttributes
+  #VERSION = "0.0.1"
+  VERSION = "1.0.0"
+end

data/test/auto_strip_attributes_test.rb

@@ -0,0 +1,134 @@
+require "test/test_helper"
+# bundle exec ruby test/auto_strip_attributes_test.rb -v --name /test_name/
+
+#class AutoStripAttributesTest < Test::Unit::TestCase
+#class AutoStripAttributesTest < MiniTest::Unit::TestCase
+describe AutoStripAttributes do
+
+  def setup
+    @init_params = { :foo => "\tfoo  ", :bar => " bar  bar "}
+  end
+
+  it "should have defined AutoStripAttributes" do
+    assert Object.const_defined?(:AutoStripAttributes)
+  end
+
+  describe "Basic attribute with default options" do
+    class MockRecordBasic < ActiveRecord::Base
+      column :foo, :string
+      auto_strip_attributes :foo
+    end
+    before do
+      @record = MockRecordBasic.new()
+    end
+
+    it "should be ok for normal strings" do
+      @record.foo = " aaa \t"
+      @record.valid?
+      @record.foo.must_equal "aaa"
+    end
+
+    it "should set empty strings to nil" do
+      @record.foo = " "
+      @record.valid?
+      @record.foo.must_be_nil
+    end
+
+    it "should call strip method to attribute if possible" do
+      str_mock = MiniTest::Mock.new()
+      str_mock.expect :'nil?', false
+      str_mock.expect :strip, (@stripped_str="stripped_str_here")
+      @record.foo = str_mock
+      @record.valid?
+      str_mock.verify
+      @record.foo.must_be_same_as @stripped_str
+    end
+
+    it "should not call strip method for non strippable attributes" do
+      str_mock = MiniTest::Mock.new() # answers false to str_mock.respond_to?(:strip)
+      str_mock.expect :'nil?', false
+      @record.foo = str_mock
+      @record.valid?
+      str_mock.verify
+      assert @record.foo === str_mock
+    end
+  end
+
+  describe "Attribute with nullify option" do
+    class MockRecordWithNullify < ActiveRecord::Base
+      column :foo, :string
+      auto_strip_attributes :foo, :nullify => false
+    end
+
+    it "should not set blank strings to nil" do
+      @record = MockRecordWithNullify.new
+      @record.foo = "  "
+      @record.valid?
+      @record.foo.must_equal ""
+    end
+  end
+
+  describe "Attribute with squish option" do
+    class MockRecordWithSqueeze < ActiveRecord::Base
+      column :foo, :string
+      auto_strip_attributes :foo, :squish => true
+    end
+
+    it "should squish string also form inside" do
+      @record = MockRecordWithSqueeze.new
+      @record.foo = "  aaa\t\n     bbb"
+      @record.valid?
+      @record.foo.must_equal "aaa bbb"
+    end
+
+    it "should do normal nullify with empty string" do
+      @record = MockRecordWithSqueeze.new
+      @record.foo = "  "
+      @record.valid?
+      @record.foo.must_be_nil
+    end
+  end
+
+  describe "Multible attributes with multiple options" do
+    class MockRecordWithMultipleAttributes < ActiveRecord::Base
+      column :foo, :string
+      column :bar, :string
+      column :biz, :string
+      column :bang, :integer
+      auto_strip_attributes :foo, :bar
+      auto_strip_attributes :biz, {:nullify => false, :squish => true}
+    end
+
+    it "should handle everything ok" do
+      @record = MockRecordWithMultipleAttributes.new
+      @record.foo = "  foo\tfoo"
+      @record.bar = "  "
+      @record.biz = "  "
+      @record.valid?
+      @record.foo.must_equal "foo\tfoo"
+      @record.bar.must_be_nil
+      @record.biz.must_equal ""
+    end
+  end
+
+  describe "Attribute with custom setter" do
+    class MockRecordWithCustomSetter < ActiveRecord::Base
+      column :foo, :string
+      auto_strip_attributes :foo
+
+      def foo=(val)
+        self[:foo] = "#{val}-#{val}"
+      end
+    end
+
+    it "should not call setter again in before_validation" do
+      @record = MockRecordWithCustomSetter.new
+      @record.foo = " foo "
+      @record.foo.must_equal " foo - foo "
+      @record.valid?
+      @record.foo.must_equal "foo - foo"
+    end
+  end
+
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require "active_record"
+require "auto_strip_attributes"
+#require 'ruby-debug'
+
+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,147 @@
+--- !ruby/object:Gem::Specification 
+name: auto_strip_attributes
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Olli Huotari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  version_requirements: *id001
+  name: activemodel
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  version_requirements: *id002
+  name: activerecord
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  version_requirements: *id003
+  name: minitest
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: ruby-debug
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: rake
+description: AutoStripAttributes helps to remove unnecessary whitespaces from ActiveRecord or ActiveModel attributes. It's good for removing accidental spaces from user inputs. It works by adding a before_validation hook to the record. It has option to set empty strings to nil or to remove extra spaces inside the string.
+email: 
+- olli.huotari@iki.fi
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- auto_strip_attributes.gemspec
+- lib/auto_strip_attributes.rb
+- lib/auto_strip_attributes/version.rb
+- test/auto_strip_attributes_test.rb
+- test/test_helper.rb
+homepage: https://github.com/holli/auto_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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: auto_strip_attributes
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Removes unnecessary whitespaces in attributes. Extension to ActiveRecord or ActiveModel.
+test_files: []
+