auto_strip_attributes 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7f41d4c8204a70a3b6fc653418a3369d737fbdd
-  data.tar.gz: b20036dddc63af1f43273efec0328801bd116896
+  metadata.gz: d58364e7bfb8fa25863e584c90647d420866a120
+  data.tar.gz: 71e36458fb5db6d524bbd9190afdad815ea61b10
 SHA512:
-  metadata.gz: 2add7072f56073876aaedb9cfd2ebbb30323edcbb4a3693660c1193a37cc27c779ea1f771526b82a13299f4aeb637b3833630707ecfbdf00f96f27ff33c67d83
-  data.tar.gz: de8aa50ac43b6bec22a230dca3403311279d4ee57cb9c8e71a03c1b52e8037e24d664d5aafff47ead7b2f754917edc098a9e492498928eae81a4eecacc7e89c5
+  metadata.gz: 4ac067485bacc17e0bf9a445468a85563e135fa144f974a07416cbc80813542a16d2468094332d3b7fea1bd9b61b68131a07196e4d67092333dd7641e53216b0
+  data.tar.gz: c90837187b66e9e7c508ae74e4a70329d2a9a3fe1e38a34934b52db31003e3ced4291fd0f6d846d3a6cf16239364fdbc204381d0c6e550e7ee86e6bb091c3616

data/.travis.yml

@@ -10,4 +10,5 @@ env:
   - "RAILS_VERSION=4.2"
   - "RAILS_VERSION=5.0"
   - "RAILS_VERSION=5.1"
+  - "RAILS_VERSION=5.2.0.rc2"
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Master]
 
+## [2.4]
+
+  - Using `ActiveSupport.on_load(:active_record)` instead of direct `extend`. ([#26](https://github.com/holli/auto_strip_attributes/commit/02431f07fcd880baaa352fc3e5a47d07c6d3935d))
+  - Possibility to pass options to custom filters. ([@nasa42#27](https://github.com/holli/auto_strip_attributes/pull/27))
+  - Rewritten to use keyword arguments instead of hash, and other Ruby 2 stuff 
+
 ## [2.3] - 2018-02-06
 
   - Replacing all utf8 characters in squish (thnks to [@nasa42](https://github.com/holli/auto_strip_attributes/pull/24))

data/README.md

@@ -16,7 +16,7 @@ Gem has option to set empty strings to nil or to remove extra spaces inside the
 Include gem in your Gemfile:
 
 ```ruby
-gem "auto_strip_attributes", "~> 2.3"
+gem "auto_strip_attributes", "~> 2.4"
 ```
 
 ```ruby
@@ -47,13 +47,14 @@ By default the following options are defined (listed in the order of processing)
 - `:delete_whitespaces` (disabled by default) - deletes all spaces (U+0020) and tabs (U+0009).
 - `:convert_non_breaking_spaces` (disabled by default) - converts non-breaking spaces (U+00A0) to normal spaces (U+0020).
 - `:virtual` (disabled by default) - By default `auto_strip_attributes` doesn't work with non-persistent attributes (e.g., attributes that are created with `attr_accessor`). This is to avoid calling their custom getter/setter methods. Use this option with non-persistent attributes.
+- For more filters use custom filters (more examples at https://github.com/holli/auto_strip_attributes/wiki)
 
 ### Custom Filters
 
 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.
+default or not. Block should return processed value. See examples of custom filters at https://github.com/holli/auto_strip_attributes/wiki
 
 This is an example on how to add html tags stripping in Rails
 
@@ -62,7 +63,7 @@ This is an example on how to add html tags stripping in Rails
 E.g. inside config/initializers/auto_strip_attributes.rb
 
 AutoStripAttributes::Config.setup do
-  set_filter :strip_html => false do |value|
+  set_filter(strip_html: false) do |value|
     ActionController::Base.helpers.strip_tags value
   end
 end
@@ -71,7 +72,7 @@ end
 And in the model:
 
 class User < ActiveRecord::Base
-  auto_strip_attributes :extra_info, :strip_html => true
+  auto_strip_attributes :extra_info, strip_html: true
 end
 
 ```

data/auto_strip_attributes.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
 
-  s.add_runtime_dependency "activerecord", ">= 3.0"
+  s.add_runtime_dependency "activerecord", ">= 4.0"
 
   #s.add_development_dependency "activerecord", ">= 3.0"
   s.add_development_dependency "minitest", ">= 2.8.1"

data/lib/auto_strip_attributes.rb

@@ -13,15 +13,14 @@ module AutoStripAttributes
 
     attributes.each do |attribute|
       before_validation do |record|
-        #debugger
         if virtual
           value = record.public_send(attribute)
         else
           value = record[attribute]
         end
         AutoStripAttributes::Config.filters_order.each do |filter_name|
-          next unless options[filter_name]
-          value = AutoStripAttributes::Config.filters[filter_name].call value
+          next if !options[filter_name]
+          value = AutoStripAttributes::Config.filters[filter_name].call(value, options[filter_name])
           if virtual
             record.public_send("#{attribute}=", value)
           else
@@ -40,37 +39,31 @@ class AutoStripAttributes::Config
     attr_accessor :filters_order
   end
 
-  def self.setup(user_options=nil,&block)
-    options = {
-        :clear => false,
-        :defaults => true,
-    }
-    options = options.merge user_options if user_options.is_a?(Hash)
-
-    @filters, @filters_enabled, @filters_order = {}, {}, [] if options[:clear]
+  def self.setup(clear_previous: false, defaults: true, &block)
+    @filters, @filters_enabled, @filters_order = {}, {}, [] if clear_previous
 
     @filters ||= {}
     @filters_enabled ||= {}
     @filters_order ||= []
 
-    if options[:defaults]
-      set_filter :convert_non_breaking_spaces => false do |value|
+    if defaults
+      set_filter(convert_non_breaking_spaces: false) do |value|
         value.respond_to?(:gsub) ? value.gsub("\u00A0", " ") : value
       end
-      set_filter :strip => true do |value|
+      set_filter(strip: true) do |value|
         value.respond_to?(:strip) ? value.strip : value
       end
-      set_filter :nullify => true do |value|
+      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|
+      set_filter(squish: false) do |value|
         value = value.respond_to?(:gsub) ? value.gsub(/[[:space:]]+/, ' ') : value
         value.respond_to?(:strip) ? value.strip : value
       end
-      set_filter :delete_whitespaces => false do |value|
+      set_filter(delete_whitespaces: false) do |value|
         value.respond_to?(:delete) ? value.delete(" \t") : value
       end
     end
@@ -78,8 +71,8 @@ class AutoStripAttributes::Config
     instance_eval(&block) if block_given?
   end
 
-  def self.set_filter(filter,&block)
-    if filter.is_a?(Hash) then
+  def self.set_filter(filter, &block)
+    if filter.is_a?(Hash)
       filter_name = filter.keys.first
       filter_enabled = filter.values.first
     else
@@ -89,10 +82,13 @@ class AutoStripAttributes::Config
     @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
+    @filters_order << filter_name if !@filters_order.include?(filter_name)
   end
 end
 
-ActiveRecord::Base.send(:extend, AutoStripAttributes) if defined? ActiveRecord
+#ActiveRecord::Base.send(:extend, AutoStripAttributes) if defined? ActiveRecord
+ActiveSupport.on_load(:active_record) do
+  extend AutoStripAttributes
+end
+
 AutoStripAttributes::Config.setup
-#ActiveModel::Validations::HelperMethods.send(:include, AutoStripAttributes) if defined? ActiveRecord

data/lib/auto_strip_attributes/version.rb

@@ -1,3 +1,3 @@
 module AutoStripAttributes
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/test/auto_strip_attributes_test.rb

@@ -122,7 +122,7 @@ describe AutoStripAttributes do
     class MockRecordWithConvertNBSP < MockRecordParent
       #column :foo, :string
       attr_accessor :foo
-      auto_strip_attributes :foo, :convert_non_breaking_spaces => true
+      auto_strip_attributes :foo, convert_non_breaking_spaces: true
     end
 
     it "should delete non breaking spaces" do
@@ -139,7 +139,7 @@ describe AutoStripAttributes do
     class MockRecordWithNullify < MockRecordParent
       #column :foo, :string
       attr_accessor :foo
-      auto_strip_attributes :foo, :nullify => false
+      auto_strip_attributes :foo, nullify: false
     end
 
     it "should not set blank strings to nil" do
@@ -152,10 +152,9 @@ describe AutoStripAttributes do
 
   describe "Attribute with squish option" do
     class MockRecordWithSqueeze < MockRecordParent #< ActiveRecord::Base
-      #column :foo, :st
       attr_accessor :foo
-      # test that `:squish => true` implies `:strip => true`
-      auto_strip_attributes :foo, :squish => true, :strip => false
+      # testing also that `:squish => true` implies `:strip => true`
+      auto_strip_attributes :foo, squish: true, strip: false
     end
 
     it "should squish string also form inside" do
@@ -177,7 +176,7 @@ describe AutoStripAttributes do
     class MockRecordWithDelete < MockRecordParent
       #column :foo, :string
       attr_accessor :foo
-      auto_strip_attributes :foo, :delete_whitespaces => true
+      auto_strip_attributes :foo, delete_whitespaces: true
     end
 
     it "should delete all spaces and tabs" do
@@ -196,7 +195,7 @@ describe AutoStripAttributes do
       #column :bang, :integer
       attr_accessor :foo, :bar, :biz, :bang
       auto_strip_attributes :foo, :bar
-      auto_strip_attributes :biz, {:nullify => false, :squish => true}
+      auto_strip_attributes :biz, {nullify: false, squish: true}
     end
 
     it "should handle everything ok" do
@@ -262,34 +261,34 @@ describe AutoStripAttributes do
     end
 
     it "should have default filters set in right order" do
-      AutoStripAttributes::Config.setup :clear => true
+      AutoStripAttributes::Config.setup(clear_previous: true)
       filters_order = AutoStripAttributes::Config.filters_order
       filters_order.must_equal [:convert_non_breaking_spaces, :strip, :nullify, :squish, :delete_whitespaces]
     end
 
     it "should reset filters to defaults when :clear is true" do
       AutoStripAttributes::Config.setup do
-        set_filter :test do
+        set_filter(:test) do
           'test'
         end
       end
-      AutoStripAttributes::Config.setup :clear => true
+      AutoStripAttributes::Config.setup(clear_previous: true)
       filters_order = AutoStripAttributes::Config.filters_order
       filters_order.must_equal [:convert_non_breaking_spaces, :strip, :nullify, :squish, :delete_whitespaces]
     end
 
     it "should remove all filters when :clear is true and :defaults is false" do
       AutoStripAttributes::Config.setup do
-        set_filter :test do
+        set_filter(:test) do
           'test'
         end
       end
-      AutoStripAttributes::Config.setup :clear => true, :defaults => false
+      AutoStripAttributes::Config.setup(clear_previous: true, defaults: false)
       filter_order = AutoStripAttributes::Config.filters_order
       filter_order.must_equal []
 
       # returning to original state
-      AutoStripAttributes::Config.setup :clear => true
+      AutoStripAttributes::Config.setup(clear_previous: true)
     end
 
     it "should correctly define and process custom filters" do
@@ -299,7 +298,7 @@ describe AutoStripAttributes do
       end
 
       AutoStripAttributes::Config.setup do
-        set_filter :test => true do |value|
+        set_filter(test: true) do |value|
           value.downcase
         end
       end
@@ -318,17 +317,43 @@ describe AutoStripAttributes do
       @record.foo.must_equal "foo"
 
       # returning to original state
-      AutoStripAttributes::Config.setup :clear => true
+      AutoStripAttributes::Config.setup(clear_previous: true)
     end
 
   end
 
+  describe "Using options in custom filters" do
+    class CustomOptionsMockRecord < MockRecordParent
+      attr_accessor :foo, :bar_downcase
+      auto_strip_attributes :foo, truncate_test: {length: 5, separator: " ", omission: "…"}
+    end
+
+    def setup
+      AutoStripAttributes::Config.setup do
+        set_filter(:truncate_test) do |value, options|
+          !value.blank? && value.respond_to?(:truncate) ? value.truncate(options[:length], omission: options[:omission]) : value
+        end
+      end
+    end
+
+    def teardown
+      AutoStripAttributes::Config.setup(defaults: true, clear_previous: true)
+    end
+
+    it "should be able to truncate as asked" do
+      @record = CustomOptionsMockRecord.new
+      @record.foo = " abcdefghijklmnopqrstijklmn"
+      @record.valid?
+      @record.foo.must_equal "abcd…"
+    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
+      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
@@ -337,14 +362,14 @@ describe AutoStripAttributes do
 
     def setup
       AutoStripAttributes::Config.setup do
-        set_filter :downcase => false do |value|
+        set_filter(downcase: false) do |value|
           value.downcase if value.respond_to?(:downcase)
         end
       end
     end
 
     def teardown
-      AutoStripAttributes::Config.setup :defaults => true
+      AutoStripAttributes::Config.setup(defaults: true, clear_previous: true)
     end
 
     it "should not use extra filters when not in setup" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_strip_attributes
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Olli Huotari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement