sanitized 0.7.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd102b8894c675e59654a16ad09200bcee7ca8e9a410877c8799bf08902d727b
+  data.tar.gz: 3c651c4bac7befac379afc9df19485bbd6acb3b66394a2cfbf8d6c23e49866dc
+SHA512:
+  metadata.gz: 2e4ab716cf16e94b41a88826bb3eeca23797cd847622021704a63d98ab595c50e1118ae28ad38d12062b3714af19ae89862914d3bbce93b47462401ce6414288
+  data.tar.gz: b69aa464d63b0ee835f2cf8a9bd3f8722bbbccb3e5673fc1573c418c090544c1dd0326a6352f9c3c5f67f1d3135a73c8c522c6cd3486e0236e12e9119014b763

data/lib/sanitized/base.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # Base methods for all Sanitized classes
+  #
+  module Base # :nodoc:
+
+    ##
+    # sanitize the value according to the options provided on initialization.
+    #
+    def cast(value) # :nodoc:
+      val = super
+      val = sanitize(val)
+      val = @block.call(val) if @block.present?
+      return val
+    rescue
+      nil
+    end
+
+
+
+    # public reader for set options
+    def options
+      @options ||= []
+    end
+
+
+
+
+
+    # ======================================================================
+    # = Private
+    # ======================================================================
+    private
+
+    # Set the options, record the block and verfiy that every given option is valid
+    #
+    # [:opts]
+    #   An Array of Symbol options to be run with every :cast
+    #
+    # [:block]
+    #   An optional block to be run with every :cast
+    #
+    #   attribute :title, Sanitized::String.new(:squish, :titleize) do |value|
+    #     value += '.' unless value.ends_with?('.')
+    #   end
+    # 
+    def initialize(*opts, &block) 
+      @options = []
+      @block   = block if block_given?
+
+      assert_valid_options(opts)
+      super()
+    end
+
+
+
+    # raise an exception if any given option is invalid
+    def assert_valid_options(opts)
+      opts.each do |opt|
+        fail_invalid_option(opt) unless valid_options.keys.include?(opt)
+
+        # check for exclusive options
+        if valid_options[opt].present? and options.present?
+          valid_options[opt].each do |exclusive_opt|
+            if options.include?(exclusive_opt)
+              msg = ":#{opt.to_s} and :#{exclusive_opt} are mutually exclusive."\
+                    " You may only use one or the other."
+              fail ArgumentError, msg
+            end
+          end
+        end
+
+        options << opt
+      end # each |opt|
+    end
+
+
+
+    # raise an error based on the invalid option
+    def fail_invalid_option(opt)
+      if opt.is_a?(Symbol)
+        fail ArgumentError, ":#{opt.to_s} is not a valid option."
+      else
+        fail ArgumentError, "Options must be a Symbol, not #{opt.class.name}."
+      end
+    end
+
+
+
+    # return a Hash of valid options with the other options they are exclusive with
+    def valid_options
+      self.class.valid_options
+    end
+
+
+
+    # apply the required sanitization to the vlaue.
+    def sanitize(value) # :nodoc
+      result = value
+      options.each { |opt| result = result.send(opt) }
+      return result
+    end
+
+  end # base
+end # sanitized

data/lib/sanitized/big_integer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # = Description
+  #
+  # ActiveModel::Type to cast and sanitize a model's BigInt attribute according to the 
+  # options specified on initialisation.
+  #
+  # attribute :attr_name, Sanitized::BigInt.new(:abs), default: 123
+  #
+  # Can optionally include a custom block:
+  #   type_cast = Sanitized::BigInt.new(:abs) do |value|
+  #       ... custome code ...
+  #   end
+  #   attribute :attr_name, type_cast, default: 123
+  #
+  class BigInteger < ::ActiveModel::Type::BigInteger
+
+    # ======================================================================
+    #  Macros
+    # ======================================================================
+    
+    include Sanitized::Base
+
+
+
+    # ======================================================================
+    #  Class Methods
+    # ======================================================================
+    
+    ##
+    # Returns a Hash of valid options with the other options they are exclusive with
+    #
+    def self.valid_options
+      {
+        abs: []
+      }
+    end
+  end # class Type
+end # module

data/lib/sanitized/date_time.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # = Description
+  #
+  # ActiveModel::Type to cast and sanitize a model's DateTime attribute according to the 
+  # options specified on initialisation.
+  #
+  # attribute :attr_name, Sanitized::DateTime.new(:end_of_week, :at_noon), default: Time.now
+  #
+  # Can optionally include a custom block:
+  #   type_cast = Sanitized::DateTime.new(:beginning_of_week, :at_noon) do |value|
+  #       ... custome code ...
+  #   end
+  #   attribute :attr_name, type_cast, default: Date.today
+  #
+  class DateTime < ::ActiveModel::Type::DateTime
+
+    # ======================================================================
+    #  Macros
+    # ======================================================================
+    
+    include Sanitized::Base
+
+
+
+    # ======================================================================
+    #  Class Methods
+    # ======================================================================
+    
+    # return a Hash of valid options with the other options they are exclusive with
+    def self.valid_options
+      {
+        at_beginning_of_day:      self.exclusive_options,
+        at_beginning_of_hour:     self.exclusive_options,
+        at_beginning_of_minute:   self.exclusive_options,
+        at_beginning_of_month:    self.exclusive_options,
+        at_beginning_of_quarter:  self.exclusive_options,
+        at_beginning_of_week:     self.exclusive_options,
+        at_beginning_of_year:     self.exclusive_options,
+        at_end_of_day:            self.exclusive_options,
+        at_end_of_hour:           self.exclusive_options,
+        at_end_of_minute:         self.exclusive_options,
+        at_end_of_month:          self.exclusive_options,
+        at_end_of_quarter:        self.exclusive_options,
+        at_end_of_week:           self.exclusive_options,
+        at_end_of_year:           self.exclusive_options,
+        at_midday:                self.exclusive_options,
+        at_middle_of_day:         self.exclusive_options,
+        at_midnight:              self.exclusive_options,
+        at_noon:                  self.exclusive_options,
+        beginning_of_day:         self.exclusive_options,
+        beginning_of_hour:        self.exclusive_options,
+        beginning_of_minute:      self.exclusive_options,
+        beginning_of_month:       self.exclusive_options,
+        beginning_of_quarter:     self.exclusive_options,
+        beginning_of_week:        self.exclusive_options,
+        beginning_of_year:        self.exclusive_options,
+        end_of_month:             self.exclusive_options,
+        end_of_quarter:           self.exclusive_options,
+        end_of_week:              self.exclusive_options,
+        end_of_year:              self.exclusive_options,
+        end_of_day:               self.exclusive_options,
+        end_of_hour:              self.exclusive_options,
+        end_of_minute:            self.exclusive_options,
+        midday:                   self.exclusive_options,
+        middle_of_day:            self.exclusive_options,
+        midnight:                 self.exclusive_options,
+        noon:                     self.exclusive_options
+      }
+    end
+
+
+
+    # Return an Array of the options that modify both the date and the time
+    def self.exclusive_options
+      [
+        :at_beginning_of_day,
+        :at_beginning_of_hour,
+        :at_beginning_of_minute,
+        :at_beginning_of_month,
+        :at_beginning_of_quarter,
+        :at_beginning_of_week,
+        :at_beginning_of_year,
+        :at_end_of_day,
+        :at_end_of_hour,
+        :at_end_of_minute,
+        :at_end_of_month,
+        :at_end_of_quarter,
+        :at_end_of_week,
+        :at_end_of_year,
+        :at_midday,
+        :at_middle_of_day,
+        :at_midnight,
+        :at_noon,
+        :beginning_of_day,
+        :beginning_of_hour,
+        :beginning_of_minute,
+        :beginning_of_month,
+        :beginning_of_quarter,
+        :beginning_of_week,
+        :beginning_of_year,
+        :end_of_month,
+        :end_of_quarter,
+        :end_of_week,
+        :end_of_year,
+        :end_of_day,
+        :end_of_hour,
+        :end_of_minute,
+        :midday,
+        :middle_of_day,
+        :midnight,
+        :noon
+      ]
+    end
+  end # class Type
+end # module

data/lib/sanitized/decimal.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # = Description
+  #
+  # ActiveModel::Type to cast and sanitize a model's Decimal attribute according to the 
+  # options specified on initialisation.
+  #
+  # attribute :attr_name, Sanitized::Decimal.new(:abs, :ceil), default: 123.45
+  #
+  # Can optionally include a custom block:
+  #   type_cast = Sanitized::Decimal.new(:abs, :ceil) do |value|
+  #       ... custome code ...
+  #   end
+  #   attribute :attr_name, type_cast, default: 123.45
+  #
+  class Decimal < ::ActiveModel::Type::Decimal
+
+    # ======================================================================
+    #  Macros
+    # ======================================================================
+    
+    include Sanitized::Base
+
+
+
+    # ======================================================================
+    #  Class Methods
+    # ======================================================================
+    
+    ##
+    # Returns a Hash of valid options with the other options they are exclusive with
+    #
+    def self.valid_options
+      {
+        abs:      [],
+        ceil:     [:floor],
+        floor:    [:ceil],
+        truncate: []
+      }
+    end
+  end # class Type
+end # module

data/lib/sanitized/float.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # = Description
+  #
+  # ActiveModel::Type to cast and sanitize a model's Float attribute according to the 
+  # options specified on initialisation.
+  #
+  # attribute :attr_name, Sanitized::Float.new(:abs, :ceil), default: 123.45
+  #
+  # Can optionally include a custom block:
+  #   type_cast = Sanitized::Float.new(:abs, :ceil) do |value|
+  #       ... custome code ...
+  #   end
+  #   attribute :attr_name, type_cast, default: 123.45
+  #
+  class Float < ::ActiveModel::Type::Float
+
+    # ======================================================================
+    #  Macros
+    # ======================================================================
+    
+    include Sanitized::Base
+
+
+
+    # ======================================================================
+    #  Class Methods
+    # ======================================================================
+    
+    ##
+    # Returns a Hash of valid options with the other options they are exclusive with
+    #
+    def self.valid_options
+      {
+        abs:       [:magnitude],
+        ceil:      [:floor],
+        floor:     [:ceil],
+        magnitude: [:abs],
+        truncate:  [],
+      }
+    end
+
+  end # class Type
+end # module

data/lib/sanitized/integer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # = Description
+  #
+  # ActiveModel::Type to cast and sanitize a model's Integer attribute according to the 
+  # options specified on initialisation.
+  #
+  # attribute :attr_name, Sanitized::Integer.new(:abs), default: 123
+  #
+  # Can optionally include a custom block:
+  #   type_cast = Sanitized::Integer.new(:abs) do |value|
+  #       ... custome code ...
+  #   end
+  #   attribute :attr_name, type_cast, default: 123
+  #
+  class Integer < ::ActiveModel::Type::Integer
+
+    # ======================================================================
+    #  Macros
+    # ======================================================================
+    
+    include Sanitized::Base
+
+
+
+    # ======================================================================
+    #  Class Methods
+    # ======================================================================
+    
+    ##
+    # Returns a Hash of valid options with the other options they are exclusive with
+    #
+    def self.valid_options
+      {
+        abs: []
+      }
+    end
+
+  end # class Type
+end # module

data/lib/sanitized/string.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Sanitized
+
+  ##
+  # = Description
+  #
+  # ActiveModel::Type to cast and sanitize a model's String attribute according to the 
+  # options specified on initialisation.
+  #
+  # attribute :attr_name, Sanitized::String.new(:squish, :upcase), default: 'CodeMeister'
+  #
+  # Can optionally include a custom block:
+  #   type_cast = Sanitized::String.new(:squish, :upcase) do |value|
+  #       ... custome code ...
+  #   end
+  #   attribute :attr_name, type_cast, default: 'CodeMeister'
+  #
+  class String < ::ActiveModel::Type::String
+
+    # ======================================================================
+    #  Macros
+    # ======================================================================
+    
+    include Sanitized::Base
+
+
+
+    # ======================================================================
+    #  Class Methods
+    # ======================================================================
+    
+    ##
+    # Returns a Hash of valid options with the other options they are exclusive with
+    #
+    def self.valid_options
+      case_opts = [:capitalize, :camelcase, :camelize, :dasherize, :downcase, :humanize,
+                   :parameterize, :swapcase, :titlecase, :titleize, :underscore, :upcase,
+                   :upcase_first]
+      {
+        capitalize:   case_opts,
+        camelcase:    case_opts,
+        camelize:     case_opts,
+        chomp:        [],
+        dasherize:    case_opts,
+        downcase:     case_opts,
+        humanize:     case_opts,
+        lstrip:       [],
+        parameterize: case_opts,
+        rstrip:       [],
+        singularize:  [],
+        squish:       [],
+        strip:        [],
+        swapcase:     case_opts,
+        titlecase:    case_opts,
+        titleize:     case_opts,
+        underscore:   case_opts,
+        upcase:       case_opts,
+        upcase_first: case_opts
+      }
+    end
+  end # class Type
+end # module

data/lib/sanitized.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative  'sanitized/base'
+require_relative  'sanitized/big_integer'
+require_relative  'sanitized/date_time'
+require_relative  'sanitized/decimal'
+require_relative  'sanitized/float'
+require_relative  'sanitized/integer'
+require_relative  'sanitized/string'

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sanitized
+version: !ruby/object:Gem::Version
+  version: 0.7.4
+platform: ruby
+authors:
+- CodeMeister
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+description: "     An elegant solution for sanitizing user input. Cleaning & reformatting
+  user data      is a necessary chore for all developers; but it no longer needs to
+  be time-consuming!     The Sanitized suite of helpers allow you to quickly sanitize
+  any ActiveRecord     attribute, and easily add your own custom code to catch those
+  edge cases.      It will save you a surprisingly large amount of time!   "
+email: sanitized@codemeister.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sanitized.rb
+- lib/sanitized/base.rb
+- lib/sanitized/big_integer.rb
+- lib/sanitized/date_time.rb
+- lib/sanitized/decimal.rb
+- lib/sanitized/float.rb
+- lib/sanitized/integer.rb
+- lib/sanitized/string.rb
+homepage: https://github.com/Rubology/sanitized
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Rubology/sanitized
+  source_code_uri: https://github.com/Rubology/sanitized
+  changelog_uri: https://github.com/Rubology/sanitized/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.27
+signing_key:
+specification_version: 4
+summary: An elegant solution for sanitizing user input, with a number of  built-in
+  options or your own custom code.
+test_files: []