attributes_sanitizer 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b4709383dbae4f0d6a6f345719ecffa47fe27e750d39cf00b14e788cf35536
-  data.tar.gz: 56fdfa609e76e3870cda762b237e234d9bbafc1904875114970a56f41de0325d
+  metadata.gz: 4030ede086e2e58277894650caddfcadaee14aea87f2ac5d81f14e2badc7d7e6
+  data.tar.gz: 4045b02167ee99755fdd30e08c15a5dbc6ace94f86b184a6c1d31497afa96749
 SHA512:
-  metadata.gz: a05d6ea506b2c4d77f5d9022ebde30514d5e1de50d6ac94a974ea378efc77c52a2a08463e665b5981f6df727d5b6d179e74d42ceda14c0c07a9ba583490efbf5
-  data.tar.gz: 9ae866687f015fae0041fd60aee83ee96834b7033ab10c75d55366afe6a72172df9687cce35336bf9629744d3e280f91a5121110a4df6bf5c543b43d2a56bf57
+  metadata.gz: 8ca28038ddd63bafdd57664b322b04954acddbb2b74836d595e1073cdaeda9136eb9996ebb2ab19cd0d82d469595a0cadc97e1a285797617038190c067c8459d
+  data.tar.gz: c774f2613d8e935cda21af84db8983b1d5d95a8bd6af8a20ff0c76a697630085eae8e64b9620724d35fb9c635e2cfe94c8b73eded8bcee52c4ff957e517d743c

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
 
@@ -9,8 +9,6 @@ A simple way to append sanitizers to attributes on Rails.
 
 ```ruby
 class Product < ApplicationRecord
-  extend AttributesSanitizer::Concern
-
   sanitize_attribute :title, with: -> (value) {
     value.gsub(/[1-9]/, 'X')
   }
@@ -37,11 +35,29 @@ 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:
 
 ```ruby
-gem 'attributes_sanitizer', git: 'https://github.com/andersondias/attributes_sanitizer.git'
+gem 'attributes_sanitizer'
 ```
 
 And then execute:

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 begin
   require 'bundler/setup'
 rescue LoadError

data/lib/attributes_sanitizer.rb

@@ -1,51 +1,14 @@
+# frozen_string_literal: true
 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"
 
-#
-# Attributes sanitizer for Rails
-#
-# A simple way to append sanitizers to attributes on Rails.
-#
-# ```ruby
-# class Product < ApplicationRecord
-#   extend AttributesSanitizer::Concern
-#
-#   sanitize_attribute :title, with: -> (value) {
-#     value.gsub(/[1-9]/, 'X')
-#   }
-#
-#   sanitize_attributes :title, :description, with: [:downcase, :strip_tags]
-# end
-# ```
-#
-# It comes with pre-defined sanitizers:
-# - `:downcase` which downcases a given attribute string
-# - `:upcase` which upcases a given attribute string
-# - `:strip_tags` which removes any tags from the given string based on Rails sanitize helper.
-# - `:strip_emojis` which removes any emoji from the given string
-# - `:strip_spaces` which removes any white spaces from the beginning and end of given attribute
-#
-# You might define your own sanitizers:
-#
-# ```ruby
-# # config/initializers/attribute_sanitizers.rb
-#
-# AttributesSanitizer.define_sanitizer :reverse do |value|
-#   value.to_s.reverse
-# end
-# ```
 module AttributesSanitizer
-  EMOJI_REGEX = /[^\u0000-\u00FF]/
-
-  cattr_accessor :sanitizers
-  self.sanitizers = {}
-
-  def self.define_sanitizer(sanitizer_name, &block)
-    self.sanitizers[sanitizer_name.to_sym] = block
-  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/concern.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
 module AttributesSanitizer::Concern
-  def self.extended(klass)
-    klass.cattr_accessor :attributes_sanitize_map
-    klass.extend ClassMethods
-  end
+  extend ActiveSupport::Concern
 
-  module ClassMethods
-    def sanitize_attributes(*attributes)
-      self.attributes_sanitize_map ||= {}
+  class_methods do
+    def attributes_sanitize_map
+      @attributes_sanitize_map ||= {}
+    end
 
+    def sanitize_attributes(*attributes)
       fetch_sanitizers_from_options(attributes).each do |sanitizer|
         sanitizer = AttributesSanitizer::SanitizerProc.new(sanitizer)
 
@@ -21,7 +21,7 @@ module AttributesSanitizer::Concern
     alias_method :sanitize_attribute, :sanitize_attributes
 
     def execute_sanitizers_for(attribute, value)
-      return value if self.attributes_sanitize_map.blank? || value.nil?
+      return value if self.attributes_sanitize_map[attribute].blank? || value.nil?
 
       self.attributes_sanitize_map[attribute].reduce(value) do |value, sanitizer|
         sanitizer.call(value)
@@ -31,8 +31,8 @@ module AttributesSanitizer::Concern
     private
 
       def fetch_sanitizers_from_options(attributes)
-        defaults = attributes.extract_options!.dup
-        sanitizers = Array(defaults[:with])
+        options = attributes.extract_options!.dup
+        sanitizers = Array(options[:with])
 
         raise ArgumentError, "You need to supply at least one attribute" if attributes.empty?
         raise ArgumentError, "You need to supply at least one sanitize method" if sanitizers.empty?

data/lib/attributes_sanitizer/overrider.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module AttributesSanitizer
   class Overrider
     attr_reader :klass

data/lib/attributes_sanitizer/predefined.rb

@@ -1,8 +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
@@ -20,12 +27,14 @@ module AttributesSanitizer
       end
 
       AttributesSanitizer.define_sanitizer :strip_emojis do |value|
-        value.gsub(AttributesSanitizer::EMOJI_REGEX, '')
+        value.gsub(AttributesSanitizer::Predefined::EMOJI_REGEX, '')
       end
 
       AttributesSanitizer.define_sanitizer :strip_spaces do |value|
         value.strip
       end
+
+      AttributesSanitizer.setup_predefined_bundles
     end
   end
 end

data/lib/attributes_sanitizer/railtie.rb

@@ -1,4 +1,10 @@
+# frozen_string_literal: true
 module AttributesSanitizer
   class Railtie < ::Rails::Railtie
+    initializer 'attributes_sanitizer.insert_into_active_record' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, AttributesSanitizer::Concern)
+      end
+    end
   end
 end

data/lib/attributes_sanitizer/sanitizer_proc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module AttributesSanitizer
   class SanitizerProc
     include Comparable
@@ -8,13 +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.sanitizers[sanitizer]
-        raise ArgumentError, "No attribute sanitizer defined for #{sanitizer}" if @proc.nil?
-
-        @id = sanitizer
+        setup_defined_proc(sanitizer)
       end
     end
 
@@ -23,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,3 +1,4 @@
+# frozen_string_literal: true
 module AttributesSanitizer
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,43 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: attributes_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Anderson Dias
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: bootsnap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: A simple way to append sanitizers to attributes on Rails.
 email:
 - andersondaraujo@gmail.com
@@ -49,11 +69,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
@@ -63,7 +85,7 @@ metadata:
   changelog_uri: https://github.com/andersondias/attributes_sanitizer/blob/master/CHANGELOG.md
   homepage_uri: https://github.com/andersondias/attributes_sanitizer
   source_code_uri: https://github.com/andersondias/attributes_sanitizer
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,9 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Attributes sanitizer for Rails 5+.
 test_files: []