attributes_sanitizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7293d638b6f0162ea95543f432fcae6150687b1a87aad503f3f57950c278b92e
+  data.tar.gz: 7c8046d3f6435c229607b336031164f63761c8b58ac7eaafa99f45bcabf3d18e
+SHA512:
+  metadata.gz: 81920cb935016e60767ae442105fe540451d700ba3567dd6c611d81b7ab319860ff89ca4f08dd7275bcf65985f164e162220d10214ca2d894205c41daff33779
+  data.tar.gz: 051514ccb49100577fcd88ea6bd53d83f1581e2c5c63fc99da1195d8afe8007f080d86915fc519c66b17365b28ac895fb3b35c84a287337164ba9a592ebddd04

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Anderson Dias
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+[![Maintainability](https://api.codeclimate.com/v1/badges/29a55c3bd2dd9e5ed117/maintainability)](https://codeclimate.com/github/andersondias/attributes_sanitizer/maintainability)
+
+# AttributesSanitizer
+
+A simple way to append sanitizers to attributes on Rails.
+
+
+## Usage
+
+```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
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attributes_sanitizer', git: 'https://github.com/andersondias/attributes_sanitizer.git'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install attributes_sanitizer
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AttributesSanitizer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/attributes_sanitizer/concern.rb

@@ -0,0 +1,50 @@
+module AttributesSanitizer::Concern
+  def self.extended(klass)
+    klass.cattr_accessor :attributes_sanitize_map
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def sanitize_attributes(*attributes)
+      self.attributes_sanitize_map ||= {}
+
+      fetch_sanitizers_from_options(attributes).each do |sanitizer|
+        sanitizer = AttributesSanitizer::SanitizerProc.new(sanitizer)
+
+        attributes.each do |attribute|
+          add_sanitizer_to_attribute(attribute, sanitizer)
+        end
+      end
+
+      AttributesSanitizer::Overrider.new(self).override_getters_and_setters
+    end
+    alias_method :sanitize_attribute, :sanitize_attributes
+
+    def execute_sanitizers_for(attribute, value)
+      return value if self.attributes_sanitize_map.blank? || value.nil?
+
+      self.attributes_sanitize_map[attribute].reduce(value) do |value, sanitizer|
+        sanitizer.call(value)
+      end
+    end
+
+    private
+
+      def fetch_sanitizers_from_options(attributes)
+        defaults = attributes.extract_options!.dup
+        sanitizers = Array(defaults[: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?
+
+        sanitizers
+      end
+
+      def add_sanitizer_to_attribute(attribute, sanitizer)
+        self.attributes_sanitize_map[attribute] ||= []
+        unless self.attributes_sanitize_map[attribute].include?(sanitizer)
+          self.attributes_sanitize_map[attribute] << sanitizer
+        end
+      end
+  end
+end

data/lib/attributes_sanitizer/overrider.rb

@@ -0,0 +1,49 @@
+module AttributesSanitizer
+  class Overrider
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def override_getters_and_setters
+      return if klass.attributes_sanitize_map.blank?
+
+      attributes_to_override.each do |attribute|
+        override_getter(attribute)
+        override_setter(attribute)
+      end
+    end
+
+    private
+
+      def attributes_to_override
+        klass.attributes_sanitize_map.keys
+      end
+
+      def override_method(method_name, &block)
+        return if klass.method_defined?(method_name)
+        klass.define_method(method_name, &block)
+      end
+
+      def override_getter(attribute)
+        getter = attribute.to_sym
+        override_method(getter) do
+          attribute_value = self[getter.to_s]
+          return if attribute_value.nil?
+
+          self.class.execute_sanitizers_for(attribute, attribute_value)
+        end
+      end
+
+      def override_setter(attribute)
+        override_method(:"#{attribute}=") do |new_value|
+          if new_value.present?
+            new_value = self.class.execute_sanitizers_for(attribute, new_value)
+          end
+
+          super(new_value)
+        end
+      end
+  end
+end

data/lib/attributes_sanitizer/predefined.rb

@@ -0,0 +1,28 @@
+module AttributesSanitizer
+  module Predefined
+    extend ActiveSupport::Concern
+
+    included do
+      AttributesSanitizer.define_sanitizer :downcase do |value|
+        value.downcase
+      end
+
+      AttributesSanitizer.define_sanitizer :upcase do |value|
+        value.upcase
+      end
+
+      AttributesSanitizer.define_sanitizer :strip_tags do |value|
+        ActionController::Base.helpers.sanitize(value, tags: [])
+      end
+
+      AttributesSanitizer.define_sanitizer :strip_emojis do |value|
+        value.gsub(AttributesSanitizer::EMOJI_REGEX, '')
+      end
+
+      AttributesSanitizer.define_sanitizer :strip_spaces do |value|
+        value.strip
+      end
+    end
+  end
+end
+

data/lib/attributes_sanitizer/railtie.rb

@@ -0,0 +1,4 @@
+module AttributesSanitizer
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/attributes_sanitizer/sanitizer_proc.rb

@@ -0,0 +1,29 @@
+module AttributesSanitizer
+  class SanitizerProc
+    include Comparable
+
+    attr_reader :id
+
+    def initialize(sanitizer)
+      raise ArgumentError, "No sanitizer given" if sanitizer.nil?
+
+      if sanitizer.is_a?(Proc)
+        @proc = sanitizer
+        @id = sanitizer.object_id
+      else
+        @proc = AttributesSanitizer.sanitizers[sanitizer]
+        raise ArgumentError, "No attribute sanitizer defined for #{sanitizer}" if @proc.nil?
+
+        @id = sanitizer
+      end
+    end
+
+    def <=>(another_proc)
+      self.id <=> another_proc.id
+    end
+
+    def call(value)
+      @proc.call(value)
+    end
+  end
+end

data/lib/attributes_sanitizer/version.rb

@@ -0,0 +1,3 @@
+module AttributesSanitizer
+  VERSION = '0.1.0'
+end

data/lib/attributes_sanitizer.rb

@@ -0,0 +1,51 @@
+require "attributes_sanitizer/railtie"
+require "attributes_sanitizer/sanitizer_proc"
+require "attributes_sanitizer/concern"
+require "attributes_sanitizer/overrider"
+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
+end

data/lib/tasks/attributes_sanitizer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :attributes_sanitizer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: attributes_sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anderson Dias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple way to append sanitizers to attributes on Rails.
+email:
+- andersondaraujo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/attributes_sanitizer.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/version.rb
+- lib/tasks/attributes_sanitizer_tasks.rake
+homepage: https://github.com/andersondias/attributes_sanitizer
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Attributes sanitizer for Rails 5+.
+test_files: []