attr_filters 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce9636df26018c66d0d278ec96421d9a28988d187ae59ce65c412930d86dca4
-  data.tar.gz: acf1f11c718874e07c95a5d5dfe4332110fabe90936c8a38b2781afaec10d79d
+  metadata.gz: cf6cbce34f0df0925b70fc57becf4f3a723abf1d568749a3dcf2d8574cdc8d74
+  data.tar.gz: 5acecff50edcffad8a2198116cfea54f6e5bf57b333a3b9bef7d644f1ca46380
 SHA512:
-  metadata.gz: f219ec091b56acff2c9b5b69e06f6a0c5d04eb448373ff08607f853091f21be4d861a5348dbd74a5f90efd7299452eba1ae2ce448c26d72f56b968a46617b574
-  data.tar.gz: 773f5d322b9de0dc55a8289ab695424b11833bf4b6e4d6f8431adbbf939ebe448652da8f3131ad06e5887c9aa7f7ac4498ea0c10acfd581d054a6626a834f724
+  metadata.gz: 9e7e3c219382d5c5686a43f75c784414e42d3181806ab3450be30e0a38b4758c13923f3bf57df53c1b0bc1b5e97c3eb4555284b448db206bce9b40a81dfbe915
+  data.tar.gz: 778bafab6a4dae472a05fff08321db18bd1cca4dbe88398333ba59cccfe08516cae3f097f0bad2ec065cb61acaac064ba8fef1fa4b3a7b372e9d06128575941c

data/.travis.yml

@@ -2,8 +2,17 @@
 sudo: false
 language: ruby
 cache: bundler
+gemfile:
+  - Gemfile
+  - gemfiles/rails_4.2.10.gemfile
+  - gemfiles/rails_5.2.1.gemfile
+  - gemfiles/rails_6.0.0.gemfile
 rvm:
   - 2.4
   - 2.5
   - 2.6
+jobs:
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/rails_6.0.0.gemfile
 before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -2,5 +2,9 @@
 
 source "https://rubygems.org"
 
+# gem "activemodel", "4.2.10"
+# gem "activemodel", "5.2.1"
+# gem "activemodel", "6.0.0"
+
 # Specify your gem's dependencies in attr_filters.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attr_filters (0.2.0)
+    attr_filters (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,12 +1,17 @@
 # AttrFilters
 
 [![Build Status](https://travis-ci.com/Syndicode/attr-filters.svg?branch=master)](https://travis-ci.com/Syndicode/attr-filters)
+[![Gem Version](https://badge.fury.io/rb/attr_filters.svg)](https://badge.fury.io/rb/attr_filters)
 
-Light weight gem for filtering PORO attributes with zero dependencies.
+Light weight gem for filtering PORO (Plain Old Ruby Objects) attributes with zero dependencies.
 
 ## Description
 
-AttrFilters brings simple DSL for adding filters to your PORO attributes.
+AttrFilters brings simple DSL for adding filters to your PORO attributes.<br>
+Simple way to integration with Rails validation.
+
+## Requirements
+  - Ruby >= 2.4
 
 ## Installation
 
@@ -59,6 +64,48 @@ form.last_name    # => "Dou"
 form.zip          # => "12345"
 ```
 
+## Integration with Rails
+### Requirements
+  - ActiveModel >= 4.2.0
+
+For Rails integration you should include `AttrFilters::ActiveModel`.<br>
+After that you can add filters using `validates` method.
+
+```ruby
+class SingupForm
+  include ActiveModel::Model
+  include AttrFilters::ActiveModel
+
+  attr_accessor :user_name
+
+  validates :user_name, presence: true, filters: { trim: true, squeeze: true }
+end
+
+form = SingupForm.new(user_name: "  Mike   Dou  ")
+form.filter!
+form.user_name  # => "Mike Dou"
+```
+
+Also filters can be run automatically before validation. Require `ActiveModel::Validations::Callbacks`
+
+```ruby
+class SingupForm
+  include ActiveModel::Model
+  include ActiveModel::Validations::Callbacks
+  include AttrFilters::ActiveModel
+
+  attr_accessor :user_name, :zip
+
+  validates :user_name, presence: true, filters: { trim: true, squeeze: true }
+  filters :zip, trim: true, numbers_only: true
+end
+
+form = SingupForm.new(user_name: "  Mike   Dou  ", zip: "12345abc")
+form.valid?
+form.user_name  # => "Mike Dou"
+form.zip        # => "12345"
+```
+
 ## Available Filters
 
  - `trim` - removes leading and trailing whitespaces

data/attr_filters.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Anton Holovko", "Syndicode LLC"]
   spec.email         = ["anton.holovko.b@gmail.com", "info@syndicode.com"]
 
-  spec.summary       = "Light weight gem for filtering PORO attributes with zero dependencies."
-  spec.description   = "Light weight gem for filtering PORO attributes with zero dependencies."
+  spec.summary       = "Light weight gem for filtering PORO (Plain Old Ruby Objects) attributes with zero dependencies."
+  spec.description   = "Light weight gem for filtering PORO (Plain Old Ruby Objects) attributes with zero dependencies."
   spec.homepage      = "https://github.com/Syndicode/attr-filters"
   spec.license       = "MIT"
 

data/gemfiles/rails_4.2.10.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "activemodel", "4.2.10"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.1.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "activemodel", "5.2.1"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.0.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "activemodel", "6.0.0"
+
+gemspec path: "../"

data/lib/active_model/validations/filters_validator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class FiltersValidator < ActiveModel::EachValidator
+      def initialize(options)
+        filters = options.slice(*AttrFilters::Filters::LIST.keys)
+        model_class = options[:class]
+        model_class.filters(*options[:attributes], filters)
+        super(options)
+      end
+
+      def validate_each(_record, _attribute, _value); end
+    end
+  end
+end

data/lib/attr_filters.rb

@@ -10,6 +10,7 @@ module AttrFilters
   autoload :FiltersMacro, "attr_filters/filters_macro"
   autoload :InstanceMethods, "attr_filters/instance_methods"
   autoload :Filters, "attr_filters/filters"
+  autoload :ActiveModel, "attr_filters/active_model"
 
   def self.included(base)
     base.extend(FiltersMacro)

data/lib/attr_filters/active_model.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AttrFilters
+  module ActiveModel
+    if AttrFilters::Utils.satisfied_spec?("activemodel")
+      require "active_model"
+      require "active_model/validations/filters_validator"
+    end
+
+    def self.included(base)
+      base.include AttrFilters
+      base.extend Macro
+      base.init
+    end
+
+    module Macro
+      def init
+        before_validation :filter! if respond_to?(:before_validation)
+      end
+    end
+  end
+end

data/lib/attr_filters/filters_macro.rb

@@ -14,7 +14,7 @@ module AttrFilters
     end
 
     def _registered_filters
-      @_registered_filters
+      @_registered_filters || {}
     end
 
     private

data/lib/attr_filters/utils.rb

@@ -7,5 +7,9 @@ module AttrFilters
       options = last.is_a?(::Hash) ? last : {}
       [attrs[0..-2], options]
     end
+
+    def self.satisfied_spec?(spec_name)
+      Gem.loaded_specs.key?(spec_name)
+    end
   end
 end

data/lib/attr_filters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AttrFilters
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_filters
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Anton Holovko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.75.0
-description: Light weight gem for filtering PORO attributes with zero dependencies.
+description: Light weight gem for filtering PORO (Plain Old Ruby Objects) attributes
+  with zero dependencies.
 email:
 - anton.holovko.b@gmail.com
 - info@syndicode.com
@@ -89,7 +90,12 @@ files:
 - bin/console
 - bin/rubocop
 - bin/setup
+- gemfiles/rails_4.2.10.gemfile
+- gemfiles/rails_5.2.1.gemfile
+- gemfiles/rails_6.0.0.gemfile
+- lib/active_model/validations/filters_validator.rb
 - lib/attr_filters.rb
+- lib/attr_filters/active_model.rb
 - lib/attr_filters/filters.rb
 - lib/attr_filters/filters/base.rb
 - lib/attr_filters/filters/capitalize.rb
@@ -129,5 +135,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Light weight gem for filtering PORO attributes with zero dependencies.
+summary: Light weight gem for filtering PORO (Plain Old Ruby Objects) attributes with
+  zero dependencies.
 test_files: []