sanitization 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 380311ca85432700d4426ddb1a6a6e42daa861206d22954a686b4453ef385bff
+  data.tar.gz: 8cf63d1d494492d6859a3d97b1e61cfa6921941f4527d0acb7a0ef3b364d5060
+SHA512:
+  metadata.gz: f30635f856767f472f4761ffa213043fdcaed98b80129c27862f2bd5295fa7402a87e178b2dfbaffae5848d8ebf27ea5fd2211dd044cc269ceb66b40c2342ac5
+  data.tar.gz: 331210228d4cca1c382b7ffd0719735d3e65d42b50480ea51448de466bc9c9d2498bdbb42a980648d0b15abbfef36b2d9c3db4c3502b80c1c6c04e0f19adb6be

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sanitization.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "temping", "~> 3.0"
+gem "sqlite3"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    sanitization (1.0.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sqlite3 (1.4.2)
+    temping (3.10.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  sanitization!
+  sqlite3
+  temping (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Carl Mercier
+
+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,76 @@
+# Sanitization
+
+Sanitization makes it easy to store slightly cleaner strings to your database.
+
+### Features (all optional):
+
+- White space stripping
+- White space collapsing (multiple consecutive spaces combined into one)
+- Empty string to nil (if database column supports it)
+- Change casing (ie. upcase, downcase, titlecase, etc)
+
+### Defaults
+
+- Leading & training white spaces are stripped (`strip: true`)
+- All spaces are collapsed (`collapse: true`)
+- All String columns are sanitized (`only: nil, except: nil`)
+- Columns of type `text` are not sanitized (`include_text_type: false`)
+- Casing remains unchanged (`case: nil`)
+
+
+## Installation
+
+```sh
+bundle add sanitization
+```
+
+## Usage
+
+```ruby
+# Default settings for all strings
+class Person < ApplicationModel
+  sanitization
+  # is equivalent to:
+  sanitization strip: true, collapse: true, include_text_type: false
+end
+
+# Default settings for all strings, except a specific column
+class Person < ApplicationModel
+  sanitization except: :alias
+end
+
+# Default settings + titlecase for specific columns
+class Person < ApplicationModel
+  sanitization only: [:first_name, :last_name], case: :title
+end
+
+# Complex example. All these lines could be used in combination.
+class Person
+  # Apply default settings and `titlecase` to all string columns, except `description`.
+  sanitization case: :title, except: :description
+
+  # Keep previous settings, but specify `upcase` for 2 columns.
+  sanitization only: [:first_name, :last_name], case: :up
+
+  # Keep previous settings, but specify `downcase` for a single column.
+  sanitization only: :email, case: :downcase
+
+  # Apply default settings to column `description`, of type `text`. By default, `text` type is NOT sanitized.
+  sanitization only: :description, include_text_type: true
+
+  # Disable collapsing for `do_not_collapse`.
+  sanitization only: :do_not_collapse, collapse: false
+
+  # Sanitize with a custom casing method named `leetcase` for the `133t` column.
+  sanitization only: '1337', case: :leet
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sanitization"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/sanitization.rb

@@ -0,0 +1,120 @@
+require 'active_record'
+
+module ActiveRecord
+  module Sanitization
+    def self.append_features(base)
+      super
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :sanitization__store
+
+      private
+      def sanitization(options = {})
+        self.sanitization__store ||= {}
+
+        options[:only]     = Array.wrap(options[:only])
+        options[:except]   = Array.wrap(options[:except])
+        options[:strip]    = !!(options[:strip].nil? ? true : options[:strip])
+        options[:collapse] = !!(options[:collapse].nil? ? true : options[:collapse])
+        options[:nullify]  = !!(options[:nullify].nil? ? true : options[:nullify])
+
+        unless options[:case].nil?
+          raise ArgumentError.new("Invalid type for `case`: #{options[:case].class}") \
+            unless [String, Symbol].include?(options[:case].class)
+          options[:case] = options[:case].downcase.to_s
+          options[:case] = options[:case] + "case" unless options[:case] =~ /case$/
+        end
+
+        columns_to_format  = self.columns.select { |c| c.type == :string }
+        columns_to_format  = columns_to_format.concat(self.columns.select { |c| c.type == :text }) \
+          if options[:include_text_type]
+
+        columns_to_format = options[:only].map do |col|
+          columns_to_format.detect { |c| c.name == col.to_s }
+        end.compact if options[:only].present?
+
+        options[:except].each do |col|
+          columns_to_format.delete_if { |c| c.name == col.to_s }
+        end
+
+        if options[:case]
+          raise ArgumentError.new("Method not found: `:#{options[:case]}`. Valid methods are: :#{valid_case_methods.join(', :')}") \
+            unless valid_case_methods.include?(options[:case])
+        end
+
+        columns_to_format.each do |col|
+          self.sanitization__store[col.name] ||= {}
+          self.sanitization__store[col.name].merge!(options.slice(:case, :strip, :collapse, :nullify))
+        end
+
+        class_eval <<-EOV
+          include ActiveRecord::Sanitization::InstanceMethods
+          before_save :sanitization__format_strings
+        EOV
+      end
+
+      def valid_case_methods
+        String.new.methods.map { |m|
+          m.to_s if m.to_s =~ /case$/
+        }.compact
+      end
+    end # module ClassMethods
+
+    module InstanceMethods
+        # Taken from `strip_attributes`: https://github.com/rmm5t/strip_attributes/blob/master/lib/strip_attributes.rb
+        # Unicode invisible and whitespace characters. The POSIX character class
+        # [:space:] corresponds to the Unicode class Z ("separator"). We also
+        # include the following characters from Unicode class C ("control"), which
+        # are spaces or invisible characters that make no sense at the start or end
+        # of a string:
+        #   U+180E MONGOLIAN VOWEL SEPARATOR
+        #   U+200B ZERO WIDTH SPACE
+        #   U+200C ZERO WIDTH NON-JOINER
+        #   U+200D ZERO WIDTH JOINER
+        #   U+2060 WORD JOINER
+        #   U+FEFF ZERO WIDTH NO-BREAK SPACE
+        MULTIBYTE_WHITE = "\u180E\u200B\u200C\u200D\u2060\uFEFF".freeze
+        MULTIBYTE_SPACE = /[[:space:]#{MULTIBYTE_WHITE}]/.freeze
+        MULTIBYTE_BLANK = /[[:blank:]#{MULTIBYTE_WHITE}]/.freeze
+        MULTIBYTE_SUPPORTED = "\u0020" == " "
+
+      private
+
+      def sanitization__format_strings
+        return unless self.class.sanitization__store
+
+        class_formatting = self.class.sanitization__store
+        class_formatting.each_pair do |col_name, col_formatting|
+          sanitization__format_column(col_name, col_formatting)
+        end
+      end
+
+      def sanitization__format_column(col_name, col_formatting)
+        return unless self[col_name].is_a?(String)
+
+        self[col_name].strip! if col_formatting[:strip]
+
+        if col_formatting[:collapse]
+          if MULTIBYTE_SUPPORTED && Encoding.compatible?(self[col_name], MULTIBYTE_BLANK)
+            self[col_name].gsub!(/#{MULTIBYTE_BLANK}+/, " ")
+          else
+            self[col_name].squeeze!(" ")
+          end
+        end
+
+        if col_formatting[:nullify] && !self[col_name].nil? && self[col_name].to_s.empty? && \
+          self.class.columns.select { |c| c.name == col_name }.first.null
+          return self[col_name] = nil
+        end
+
+        self[col_name] = self[col_name].send(col_formatting[:case]) if col_formatting[:case]
+        self[col_name]
+      end
+
+
+    end # module InstanceMethods
+  end # module Sanitization
+end # module ActiveRecord
+

data/lib/sanitization.rb

@@ -0,0 +1,11 @@
+require "sanitization/version"
+require "active_record/sanitization"
+
+module Sanitization
+  class Error < StandardError; end
+end
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Sanitization
+end
+

data/lib/sanitization/version.rb

@@ -0,0 +1,3 @@
+module Sanitization
+  VERSION = "1.0.0"
+end

data/sanitization.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/sanitization/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sanitization"
+  spec.version       = Sanitization::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  spec.summary       = %q{}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/cmer/sanitization"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cmer/sanitization"
+  spec.metadata["changelog_uri"] = "https://github.com/cmer/sanitization"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "activesupport"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sanitization
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/active_record/sanitization.rb
+- lib/sanitization.rb
+- lib/sanitization/version.rb
+- sanitization.gemspec
+homepage: https://github.com/cmer/sanitization
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cmer/sanitization
+  source_code_uri: https://github.com/cmer/sanitization
+  changelog_uri: https://github.com/cmer/sanitization
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []