auto_strip_attributes 1.1 → 2.0

data/README.md

@@ -7,6 +7,8 @@ It works by adding a before_validation hook to the record. No other methods are
 
 Gem has option to set empty strings to nil or to remove extra spaces inside the string.
 
+[<img src="https://secure.travis-ci.org/holli/auto_strip_attributes.png" />](http://travis-ci.org/holli/auto_strip_attributes)
+
 ## Howto / examples
 
 Include gem in your Gemfile:
@@ -29,10 +31,74 @@ class User < ActiveRecord::Base
 end
 ```
 
+# Filters
+### Default filters
+
+By default the following filters are defined (listed in the order of processing):
+
+- :strip (enabled by default) - removes whitespaces from the beginning and the end of string
+- :nullify (enabled by default) - replaces empty strings with nil
+- :squish (disabled by default) - replaces extra whitespaces (including tabs) with one space
+
+### Custom Filters
+
+New version of this gem supports custom filtering methods. Custom methods can be set by calling to set_filter method
+inside a block passed to AutoStripAttributes::Config.setup. set_filter method accepts either Symbol or Hash as a
+parameter. If parameter is a Hash, the key should be filter name and the value is boolean whether filter is enabled by
+default or not. Block should return processed value.
+
+This is an example on how to add html tags stripping in Rails
+
+```ruby
+
+E.g. inside config/initializers/auto_strip_attributes.rb
+
+AutoStripAttributes::Config.setup do
+  set_filter :strip_html => false do |value|
+    ActionController::Base.helpers.strip_tags value
+  end
+end
+
+
+And in the model:
+
+class User < ActiveRecord::Base
+  auto_strip_attributes :extra_info, :strip_html => true
+end
+
+```
+
+Change the order of filters is done by manipulating filters_order array. You may also enable or disable filter by
+default by changing filters_enabled hash.
+
+Example of making :strip_html filter first and enabling :squish by default
+
+```ruby
+AutoStripAttributes::Config.setup do
+  filters_order.delete(:strip_html)
+  filters_order.insert(0, :strip_html)
+  filters_enabled[:squish] = true
+end
+```
+
+AutoStripAttributes::Config.setup accepts following options
+
+- :clear => true, to clear all filters
+- :defaults => true, to set three default filters mentioned above
+
+
+# Versions
+
+- 1.x : Had only basic filters
+- 2.x : Includes config for extra filters (thnks to [@dadittoz](https://github.com/holli/auto_strip_attributes/issues/1))
+
+
 # Requirements
 
 Gem has been tested with ruby 1.8.7, 1.9.2 and Rails 3.x. Although it should also work with previous versions of rails.
 
+[<img src="https://secure.travis-ci.org/holli/auto_strip_attributes.png" />](http://travis-ci.org/holli/auto_strip_attributes)
+
 http://travis-ci.org/#!/holli/auto_strip_attributes
 
 # Support
@@ -41,13 +107,13 @@ Submit suggestions or feature requests as a GitHub Issue or Pull Request. Rememb
 
 # Other approaches
 
-This gem works by addin before_validation hook and setting attributes with self[attribute]=stripped_value. See: https://github.com/holli/auto_strip_attributes/blob/master/lib/auto_strip_attributes.rb
+This gem works by adding before_validation hook and setting attributes with self[attribute]=stripped_value. See: https://github.com/holli/auto_strip_attributes/blob/master/lib/auto_strip_attributes.rb
 
 Other approaches could include calling attribute= from before_validation. This would end up calling possible custom setters twice. Might not be desired effect (e.g. if setter does some logging).
 
 Method chaining attribute= can be also used. But then stripping would be omitted if there is some code that calls model[attribute]= directly. This could happen easily when using hashes in some places.
 
-## Similar gems
+### 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. These gems have a bit

data/auto_strip_attributes.gemspec

@@ -22,8 +22,11 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "activerecord", ">= 3.0"
 
   s.add_development_dependency "activerecord", ">= 3.0"
-  s.add_development_dependency "minitest",  "2.6.0"
+  s.add_development_dependency "minitest",  "2.8.1"
   s.add_development_dependency "mocha", "~> 0.9.12"
-  #s.add_development_dependency 'ruby-debug'
   s.add_development_dependency 'rake'
+
+  #s.add_development_dependency 'ruby-debug'
+  #s.add_development_dependency 'ruby-debug19'
+
 end

data/lib/auto_strip_attributes.rb

@@ -1,37 +1,80 @@
 require "auto_strip_attributes/version"
 
 module AutoStripAttributes
-
   def auto_strip_attributes(*attributes)
-    options = {:nullify => true, :squish => false}
+    options = AutoStripAttributes::Config.filters_enabled
     if attributes.last.is_a?(Hash)
       options = options.merge(attributes.pop)
     end
 
     attributes.each do |attribute|
       before_validation do |record|
-        #value = record.send(attribute)
+        #debugger
         value = record[attribute]
-        if value.respond_to?(:strip)
-          value_stripped = (options[:nullify] && value.blank?) ? nil : value.strip
+        AutoStripAttributes::Config.filters_order.each do |filter_name|
+          next unless options[filter_name]
+          value = AutoStripAttributes::Config.filters[filter_name].call value
+          record[attribute] = value
+        end
+      end
+    end
+  end
+end
 
-          # 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)
+class AutoStripAttributes::Config
+  class << self
+    attr_accessor :filters
+    attr_accessor :filters_enabled
+    attr_accessor :filters_order
+  end
 
-          record[attribute] = value_stripped
+  def self.setup(user_options=nil,&block)
+    options = {
+        :clear => false,
+        :defaults => true,
+    }
+    options = options.merge user_options if user_options.is_a?(Hash)
 
-          # 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
+    @filters, @filters_enabled, @filters_order = {}, {}, [] if options[:clear]
+
+    @filters ||= {}
+    @filters_enabled ||= {}
+    @filters_order ||= []
+
+    if options[:defaults]
+      set_filter :strip => true do |value|
+        value.respond_to?(:strip) ? value.strip : value
+      end
+      set_filter :nullify => true do |value|
+        # We check for blank? and empty? because rails uses empty? inside blank?
+        # e.g. MiniTest::Mock.new() only responds to .blank? but not empty?, check tests for more info
+        # Basically same as value.blank? ? nil : value
+        (value.respond_to?(:'blank?') and value.respond_to?(:'empty?') and value.blank?) ? nil : value
+      end
+      set_filter :squish => false do |value|
+        value.respond_to?(:gsub) ? value.gsub(/\s+/, ' ') : value
       end
     end
+
+    instance_eval &block if block_given?
   end
 
+  def self.set_filter(filter,&block)
+    if filter.is_a?(Hash) then
+      filter_name = filter.keys.first
+      filter_enabled = filter.values.first
+    else
+      filter_name = filter
+      filter_enabled = false
+    end
+    @filters[filter_name] = block
+    @filters_enabled[filter_name] = filter_enabled
+    # in case filter is redefined, we probably don't want to change the order
+    @filters_order << filter_name unless @filters_order.include? filter_name
+  end
 end
 
 ActiveRecord::Base.send(:extend, AutoStripAttributes) if defined? ActiveRecord
+AutoStripAttributes::Config.setup
 #ActiveModel::Validations::HelperMethods.send(:include, AutoStripAttributes) if defined? ActiveRecord
 

data/lib/auto_strip_attributes/version.rb

@@ -1,4 +1,3 @@
 module AutoStripAttributes
-  #VERSION = "0.0.1"
-  VERSION = "1.1"
+  VERSION = "2.0"
 end

data/test/auto_strip_attributes_test.rb

@@ -1,16 +1,15 @@
+#to use:
+#require "test/test_helper"
+#bundle exec ruby test/auto_strip_attributes_test.rb -v --name /test_name/
+
 require 'minitest/autorun'
+require 'minitest/spec'
 require "active_record"
 require "auto_strip_attributes"
-#require 'ruby-debug'
 require 'mocha'
+#require 'ruby-debug'
 
 
-#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
-
 class MockRecordParent
   include ActiveModel::Validations
   include ActiveModel::Validations::Callbacks
@@ -75,9 +74,15 @@ describe AutoStripAttributes do
       #@record.foo.must_be_same_as @stripped_str
     end
 
-    it "should not call strip method for non strippable attributes" do
+    it "should not call strip or nullify method for non strippable attributes" do
       @record = MockRecordBasic.new()
-      str_mock = MiniTest::Mock.new() # answers false to str_mock.respond_to?(:strip)
+
+      str_mock = MiniTest::Mock.new() # answers false to str_mock.respond_to?(:strip) and respond_to?(:blank)
+      # Mock.new is problematic in ruby 1.9 because it responds to blank? but doesn't respond to !
+      # rails blank? method returns !self if an object doesn't respond to :empty?
+      # Now we check in the validator also for :empty? so !self is never called.
+      # Other way could be to mock !self in here
+
       @record.foo = str_mock
       @record.valid?
       assert @record.foo === str_mock
@@ -103,7 +108,7 @@ describe AutoStripAttributes do
 
   describe "Attribute with squish option" do
     class MockRecordWithSqueeze < MockRecordParent #< ActiveRecord::Base
-      #column :foo, :string
+      #column :foo, :st
       attr_accessor :foo
       auto_strip_attributes :foo, :squish => true
     end
@@ -166,5 +171,118 @@ describe AutoStripAttributes do
     end
   end
 
+  describe "Configuration tests" do
+    it "should have defined AutoStripAttributes::Config" do
+      assert AutoStripAttributes.const_defined?(:Config)
+    end
+
+    it "should have default filters set in right order" do
+      AutoStripAttributes::Config.setup :clear => true
+      filters_order = AutoStripAttributes::Config.filters_order
+      filters_order.must_equal [:strip, :nullify, :squish]
+    end
+
+    it "should reset filters to defaults when :clear is true" do
+      AutoStripAttributes::Config.setup do
+        set_filter :test do
+          'test'
+        end
+      end
+      AutoStripAttributes::Config.setup :clear => true
+      filters_order = AutoStripAttributes::Config.filters_order
+      filters_order.must_equal [:strip, :nullify, :squish]
+    end
+
+    it "should remove all filters when :clear is true and :defaults is false" do
+      AutoStripAttributes::Config.setup do
+        set_filter :test do
+          'test'
+        end
+      end
+      AutoStripAttributes::Config.setup :clear => true, :defaults => false
+      filter_order = AutoStripAttributes::Config.filters_order
+      filter_order.must_equal []
+
+      # returning to original state
+      AutoStripAttributes::Config.setup :clear => true
+    end
+
+    it "should correctly define and process custom filters" do
+      class MockRecordWithCustomFilter < MockRecordParent #< ActiveRecord::Base
+        attr_accessor :foo
+        auto_strip_attributes :foo
+      end
+
+      AutoStripAttributes::Config.setup do
+        set_filter :test => true do |value|
+          value.downcase
+        end
+      end
+
+      filters_block = AutoStripAttributes::Config.filters
+      filters_order = AutoStripAttributes::Config.filters_order
+      filters_enabled = AutoStripAttributes::Config.filters_enabled
+
+      filters_order.must_equal [:strip, :nullify, :squish, :test]
+      assert Proc === filters_block[:test]
+      filters_enabled[:test].must_equal true
+
+      @record = MockRecordWithCustomFilter.new
+      @record.foo = " FOO "
+      @record.valid?
+      @record.foo.must_equal "foo"
+
+      # returning to original state
+      AutoStripAttributes::Config.setup :clear => true
+    end
+
+  end
+
+  describe "complex usecase with custom config" do
+    class ComplexFirstMockRecord < MockRecordParent
+      #column :foo, :string
+      attr_accessor :foo, :bar_downcase
+      auto_strip_attributes :foo
+      auto_strip_attributes :bar_downcase, :downcase => true, :nullify => false
+    end
+
+    # before will not work currently: https://github.com/seattlerb/minitest/issues/50 using def setup
+    #before do
+    #end
+
+    def setup
+      AutoStripAttributes::Config.setup do
+        set_filter :downcase => false do |value|
+          value.downcase if value.respond_to?(:downcase)
+        end
+      end
+    end
+
+    def teardown
+      AutoStripAttributes::Config.setup :defaults => true
+    end
+
+    it "should not use extra filters when not in setup" do
+      @record = ComplexFirstMockRecord.new
+      @record.foo = " FOO "
+      @record.valid?
+      @record.foo.must_equal "FOO"
+    end
+    
+    it "should use extra filters when given" do
+      @record = ComplexFirstMockRecord.new
+      @record.bar_downcase = " BAR "
+      @record.valid?
+      @record.bar_downcase.must_equal "bar"
+    end
+
+    it "should use extra filters when given and also respect given other configs" do
+      @record = ComplexFirstMockRecord.new
+      @record.bar_downcase = "    "
+      @record.valid?
+      @record.bar_downcase.must_equal ""
+    end
+  end
+
 
 end

metadata

@@ -1,107 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: auto_strip_attributes
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: '2.0'
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  version: "1.1"
 platform: ruby
-authors: 
+authors:
 - Olli Huotari
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &22367580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *22367580
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &22367080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *22367080
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &22416220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.8.1
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *22416220
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &22415760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 9
-        - 12
+      - !ruby/object:Gem::Version
         version: 0.9.12
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *22415760
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &22415380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-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: 
+  prerelease: false
+  version_requirements: *22415380
+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: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -115,36 +89,27 @@ files:
 - test/auto_strip_attributes_test.rb
 homepage: https://github.com/holli/auto_strip_attributes
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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.
+summary: Removes unnecessary whitespaces in attributes. Extension to ActiveRecord
+  or ActiveModel.
 test_files: []
-