sanitization 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c204e5917662144318c424b310a9ad6c8bdd64d59a421086fadd8bc94a48e239
-  data.tar.gz: 5cbe00e349e72aa1e12371cc8155b1e2c80288b3da6ff0286665cdddfd7a0c1e
+  metadata.gz: 7df5efc0b65948fd54d88ac7c8f90751d86fe451fe13e89708fac01acc0eead6
+  data.tar.gz: da8dbd58e672ea0919a8d2f5952801866c14edb054cc25d643af05b0c87cbfb9
 SHA512:
-  metadata.gz: eaafc40ec8fdddd782b913830f83a488974dafedab9c10004e61bc40209ee40e61112bff9d872c38deefede278f200f1e258dced084f720f4c730e7f99e2f4a8
-  data.tar.gz: 1f1e095ce608ac8da583760efb546364dfe707c0c884c91541ceb364015b632cfd6695117153519e42221673fc54db7852ab9c06a59f26234b1ef44393a39193
+  metadata.gz: ff7a7568225361dc64f8e18ea00adeefc6e6ba468ae9233a9518e6c8dc83f880c51b5b6c16c54a6d5f695493e3393f0fd54dd34a0a3ea666c91fdb84d4207c1f
+  data.tar.gz: d89eb17b76a4c2dbe2cfe90457728bc795a46fb56a47c07b2ce2bbfa5c2245f1f0f56ec9bb3b8050d468e4e2c598ee6335efdaa6d26eb6477b949c948c5be83b

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.1.0
+* **BREAKING CHANGE:** By default, Sanitization now does nothing. A configuration block should be used to set your desired defaults. Add `Sanitization.simple_defaults!` to `config/initializers/sanitization.rb` for version 1.0.x defaults.
+* Added support for configuration block.
+
+
+# 1.0.0
+* Initial Release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sanitization (1.0.2)
+    sanitization (1.1.0)
       activerecord
       activesupport
 

data/README.md

@@ -2,6 +2,7 @@
 
 Sanitization makes it easy to store slightly cleaner strings to your database.
 
+
 ### Features (all optional):
 
 - White space stripping
@@ -9,14 +10,37 @@ Sanitization makes it easy to store slightly cleaner strings to your database.
 - 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 empty strings are stored as `null` if the database column allows it (`nullify: true`)
+By default, Sanitization has all options disabled. It is recommended you use a configuration block to set
+sensitive defaults for your projects.
+
+For example, I use:
+
+```ruby
+# config/initializers/sanitization.rb
+
+Sanitization.configure do |config|
+  config.strip = true
+  config.collapse = true
+  config.nullify = true
+end
+
+# or you can use the following shortcut instead:
+
+Sanitization.simple_defaults!
+```
+
+
+### Configuration Options
+
+- Strip leading & training white spaces (`strip: true|false`)
+- Collapse consecutive spaces (`collapse: true|false`)
+- Store empty strings as `null` if the database column allows it (`nullify: true|false`)
 - 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`)
+- Also sanitize strings of type `text` (`include_text_type: true|false`)
+- Change casing: (`case: :none|:up|:down|:custom`)
 
 
 ## Installation
@@ -29,6 +53,14 @@ bundle add sanitization
 ## Usage
 
 ```ruby
+
+# Assuming the following configuration block:
+Sanitization.configure do |config|
+  config.strip = true
+  config.collapse = true
+  config.nullify = true
+end
+
 # Default settings for all strings
 class Person < ApplicationModel
   sanitization
@@ -70,10 +102,12 @@ 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/lib/sanitization.rb

@@ -1,4 +1,5 @@
 require "sanitization/version"
+require "sanitization/configuration"
 require "sanitization/active_record_extension"
 require "active_record" unless defined?(ActiveRecord)
 

data/lib/sanitization/active_record_extension.rb

@@ -15,11 +15,8 @@ module Sanitization
 
         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])
+        options[:only]   = Array.wrap(options[:only])
+        options[:except] = Array.wrap(options[:except])
 
         unless options[:case].nil?
           raise ArgumentError.new("Invalid type for `case`: #{options[:case].class}") \
@@ -41,8 +38,9 @@ module Sanitization
         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])
+          raise ArgumentError.new("Method not found: `:#{options[:case]}`. " +
+            "Valid methods are: :#{valid_case_methods.join(', :')}") \
+            unless valid_case_methods.include?(options[:case]) || options[:case] == :none
         end
 
         columns_to_format.each do |col|
@@ -95,9 +93,9 @@ module Sanitization
       def sanitization__format_column(col_name, col_formatting)
         return unless self[col_name].is_a?(String)
 
-        self[col_name].strip! if col_formatting[:strip]
+        self[col_name].strip! if value_or_default(col_formatting, :strip)
 
-        if col_formatting[:collapse]
+        if value_or_default(col_formatting, :collapse)
           if MULTIBYTE_SUPPORTED && Encoding.compatible?(self[col_name], MULTIBYTE_BLANK)
             self[col_name].gsub!(/#{MULTIBYTE_BLANK}+/, " ")
           else
@@ -105,15 +103,27 @@ module Sanitization
           end
         end
 
-        if col_formatting[:nullify] && !self[col_name].nil? && self[col_name].to_s.empty? && \
+        if value_or_default(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]
+        case_formatting_method = value_or_default(col_formatting, :case)
+        if !case_formatting_method.nil? && case_formatting_method != :none
+          self[col_name] = self[col_name].send(case_formatting_method)
+        end
+
         self[col_name]
       end
 
+      def value_or_default(col_formatting, transform)
+        if col_formatting[transform].nil?
+          Sanitization.configuration[transform]
+        else
+          col_formatting[transform]
+        end
+      end
+
 
     end # module InstanceMethods
   end # module ActiveRecordExt

data/lib/sanitization/configuration.rb

@@ -0,0 +1,64 @@
+module Sanitization
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configuration=(c)
+      @configuration = c
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.simple_defaults!
+    self.configuration.simple!
+  end
+
+  class Configuration
+    DEFAULTS = {
+      strip: false,
+      collapse: false,
+      case: :none,
+      nullify: false,
+      include_text_type: false
+    }
+
+    SIMPLE_DEFAULTS = {
+      strip: true,
+      collapse: true,
+      case: :none,
+      nullify: true,
+      include_text_type: false
+    }
+
+    attr_accessor *DEFAULTS.keys
+
+    def initialize(opts = {})
+      opts = DEFAULTS.merge((opts || {}).slice(DEFAULTS.keys))
+
+      opts.each_pair do |k,v|
+        self.instance_variable_set("@#{k}", v)
+      end
+    end
+
+    def [](k)
+      raise ArgumentError.new("Invalid parameter: #{k}") unless DEFAULTS.keys.include?(k)
+      self.instance_variable_get("@#{k}")
+    end
+
+    def clear!
+      DEFAULTS.each_pair do |k,v|
+        self.instance_variable_set("@#{k}", v)
+      end; self
+    end
+
+    def simple!
+      SIMPLE_DEFAULTS.each_pair do |k,v|
+        self.instance_variable_set("@#{k}", v)
+      end; self
+    end
+  end
+end

data/lib/sanitization/version.rb

@@ -1,3 +1,3 @@
 module Sanitization
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanitization
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Carl Mercier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -56,6 +57,7 @@ files:
 - bin/setup
 - lib/sanitization.rb
 - lib/sanitization/active_record_extension.rb
+- lib/sanitization/configuration.rb
 - lib/sanitization/version.rb
 - sanitization.gemspec
 homepage: https://github.com/cmer/sanitization
@@ -81,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: ''