attributes_sanitizer 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98fa0192ea9522563237224ab465c986be336c2a68056bc41ba5f276feeb0fd1
-  data.tar.gz: 3176dd989b679ed4c9a54b0815cea118c62862ea2bd21dd55e0c945c4d5f6b2a
+  metadata.gz: 57e17ee2d4e35426d5648e6fe5eead7ebe103efafaf1400be039882245a335c6
+  data.tar.gz: 33979410ba0b283121cc31dadae6bb8fe353c890882ccef6a12320fefa093e17
 SHA512:
-  metadata.gz: 11ed0f80297d724c017f8df73b2d675f2a8d9f999764aaa51818e60fbd95889dd8d51fa327d44dc6fa18c535933dd5a3a15ef4f69efc18e971ce150d5d3e2e44
-  data.tar.gz: cf469c09997dd4356f7a14d47be3fb4c740408663e4c7f363d9de9179c7a6fd4b7086d7f7c5e37c53976ba4bc2251ecf2cfffa380344d602152b8143d2bc125a
+  metadata.gz: 7e52b0d8717f93d78be0fd3fd33c7ea7ecd03200bfc573f7cfe45dfdd65891cec59452b6491af2bc04ba01b172de9de500e20a309a34dad5b483421e9fea064a
+  data.tar.gz: b0eef6ee51606052915c3306215c24eb2249c743b9b521a677df99e4ba55c1789b82cb10dc245cb5cb424c28d305c32562f6300a143cdfd805acf8b67008c59e

data/README.md

@@ -1,4 +1,4 @@
-[![Maintainability](https://api.codeclimate.com/v1/badges/29a55c3bd2dd9e5ed117/maintainability)](https://codeclimate.com/github/andersondias/attributes_sanitizer/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/29a55c3bd2dd9e5ed117/test_coverage)](https://codeclimate.com/github/andersondias/attributes_sanitizer/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/29a55c3bd2dd9e5ed117/maintainability)](https://codeclimate.com/github/andersondias/attributes_sanitizer/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/29a55c3bd2dd9e5ed117/test_coverage)](https://codeclimate.com/github/andersondias/attributes_sanitizer/test_coverage) [![Build](https://travis-ci.org/andersondias/attributes_sanitizer.svg?branch=master)](https://travis-ci.org/andersondias/attributes_sanitizer.svg?branch=master)
 
 # AttributesSanitizer
 
@@ -35,6 +35,24 @@ AttributesSanitizer.define_sanitizer :reverse do |value|
 end
 ```
 
+It also comes with predefined bundles:
+```ruby
+class Product < ApplicationRecord
+  sanitize_attribute :title, with: -> (value) {
+    value.gsub(/[1-9]/, 'X')
+  }
+
+  sanitize_attributes :title, :description, with: :no_tags_emojis_or_extra_spaces
+  # same as: `with: %i(stringify strip_tags strip_emojis strip_spaces)
+end
+```
+
+And, finally, you are able to define your own bundles:
+```ruby
+# config/initializers/attribute_sanitizers.rb
+AttributesSanitizer.define_bundle(:my_bundle, %i(downcase strip_spaces))
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/attributes_sanitizer.rb

@@ -3,20 +3,12 @@ require "attributes_sanitizer/railtie"
 require "attributes_sanitizer/sanitizer_proc"
 require "attributes_sanitizer/concern"
 require "attributes_sanitizer/overrider"
+require "attributes_sanitizer/bundle"
+require "attributes_sanitizer/sanitizers"
 require "attributes_sanitizer/predefined"
 
 module AttributesSanitizer
-  def self.define_sanitizer(sanitizer_name, &block)
-    @sanitizers ||= {}
-    raise ArgumentError, 'sanitizer needs a block' unless block_given?
-    @sanitizers[sanitizer_name.to_sym] = block
-  end
-
-  def self.find(sanitizer_name)
-    sanitizer = @sanitizers && @sanitizers[sanitizer_name.to_sym]
-    raise ArgumentError, "No sanitizer defined for #{sanitizer}" if sanitizer.nil?
-    sanitizer
-  end
-
-  include Predefined
+  extend Sanitizers, Bundle
+  # must to be called here in order to ensure extension of upper modules
+  extend Predefined
 end

data/lib/attributes_sanitizer/bundle.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module AttributesSanitizer
+  module Bundle
+    def define_bundle(bundle_name, keys)
+      raise ArgumentError, 'empty bundle name' if bundle_name.blank?
+
+      keys = Array(keys)
+      raise ArgumentError, 'empty keys' if keys.blank?
+
+      @bundles ||= {}
+      @bundles[bundle_name.to_sym] = keys
+    end
+
+    def bundle(bundle_name)
+      bundle = @bundles[bundle_name.to_sym]
+      bundle&.map do |sanitizer_name|
+        find(sanitizer_name)
+      end
+    end
+  end
+end

data/lib/attributes_sanitizer/predefined.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 module AttributesSanitizer
   module Predefined
-    extend ActiveSupport::Concern
-
     EMOJI_REGEX = /[^\u0000-\u00FF]/
 
-    included do
+    def setup_predefined_bundles
+      define_bundle(:predefined, @sanitizers.keys)
+      define_bundle(:no_tags_emojis_or_extra_spaces, %i(stringify strip_tags strip_emojis strip_spaces))
+      @predefined_bundles = @bundles.keys
+    end
+
+    def self.extended(_)
       AttributesSanitizer.define_sanitizer :stringify do |value|
         value.to_s
       end
@@ -29,6 +33,8 @@ module AttributesSanitizer
       AttributesSanitizer.define_sanitizer :strip_spaces do |value|
         value.strip
       end
+
+      AttributesSanitizer.setup_predefined_bundles
     end
   end
 end

data/lib/attributes_sanitizer/sanitizer_proc.rb

@@ -9,11 +9,9 @@ module AttributesSanitizer
       raise ArgumentError, "No sanitizer given" if sanitizer.nil?
 
       if sanitizer.is_a?(Proc)
-        @proc = sanitizer
-        @id = sanitizer.object_id
+        setup_lambda_proc(sanitizer)
       else
-        @proc = AttributesSanitizer.find(sanitizer)
-        @id = sanitizer
+        setup_defined_proc(sanitizer)
       end
     end
 
@@ -22,7 +20,21 @@ module AttributesSanitizer
     end
 
     def call(value)
-      @proc.call(value)
+      @proc.inject(value) do |value, proc|
+        proc.call(value)
+      end
     end
+
+    private
+
+      def setup_lambda_proc(sanitizer)
+        @proc = Array(sanitizer)
+        @id = sanitizer.object_id
+      end
+
+      def setup_defined_proc(sanitizer)
+        @id = sanitizer
+        @proc = AttributesSanitizer.bundle(sanitizer) || Array(AttributesSanitizer.find(sanitizer))
+      end
   end
 end

data/lib/attributes_sanitizer/sanitizers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module AttributesSanitizer
+  module Sanitizers
+    def define_sanitizer(sanitizer_name, &block)
+      @sanitizers ||= {}
+      raise ArgumentError, 'sanitizer needs a block' unless block_given?
+      @sanitizers[sanitizer_name.to_sym] = block
+    end
+
+    def find(sanitizer_name)
+      sanitizer = @sanitizers && @sanitizers[sanitizer_name.to_sym]
+      raise ArgumentError, "No sanitizer defined for #{sanitizer_name}" if sanitizer.nil?
+      sanitizer
+    end
+  end
+end

data/lib/attributes_sanitizer/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module AttributesSanitizer
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributes_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Anderson Dias
@@ -49,11 +49,13 @@ files:
 - README.md
 - Rakefile
 - lib/attributes_sanitizer.rb
+- lib/attributes_sanitizer/bundle.rb
 - lib/attributes_sanitizer/concern.rb
 - lib/attributes_sanitizer/overrider.rb
 - lib/attributes_sanitizer/predefined.rb
 - lib/attributes_sanitizer/railtie.rb
 - lib/attributes_sanitizer/sanitizer_proc.rb
+- lib/attributes_sanitizer/sanitizers.rb
 - lib/attributes_sanitizer/version.rb
 - lib/tasks/attributes_sanitizer_tasks.rake
 homepage: https://github.com/andersondias/attributes_sanitizer