Sha256: b4bc47bcfbbc31a31a54e3cf7f4c60f9ab3e4f26267cff46c7e143792184e35e

Contents?: true

Size: 1.86 KB

Versions: 77

Compression:

Stored size: 1.86 KB

Contents

# frozen-string-literal: true

module Sequel
  module Plugins
    # StringStripper is a plugin that strips all input strings
    # when assigning to the model's values. Example:
    #
    #   album = Album.new(name: ' A ')
    #   album.name # => 'A'
    #
    # SQL::Blob instances and all non-strings are not modified by
    # this plugin.  Additionally, strings passed to a blob column
    # setter are also not modified.  You can explicitly set
    # other columns to skip the stripping:
    #
    #   Album.skip_string_stripping :foo
    #   Album.new(foo: ' A ').foo # => ' A '
    # 
    # Usage:
    #
    #   # Make all model subclass instances strip strings (called before loading subclasses)
    #   Sequel::Model.plugin :string_stripper
    #
    #   # Make the Album class strip strings
    #   Album.plugin :string_stripper
    module StringStripper
      def self.apply(model)
        model.plugin(:input_transformer, :string_stripper){|v| (v.is_a?(String) && !v.is_a?(SQL::Blob)) ? v.strip : v}
      end
      def self.configure(model)
        model.send(:set_skipped_string_stripping_columns)
      end

      module ClassMethods
        Plugins.after_set_dataset(self, :set_skipped_string_stripping_columns)

        # Skip stripping for the given columns.
        def skip_string_stripping(*columns)
          skip_input_transformer(:string_stripper, *columns)
        end

        # Return true if the column should not have values stripped.
        def skip_string_stripping?(column)
          skip_input_transformer?(:string_stripper, column)
        end

        private

        # Automatically skip stripping of blob columns
        def set_skipped_string_stripping_columns
          if @db_schema
            blob_columns = @db_schema.map{|k,v| k if v[:type] == :blob}.compact
            skip_string_stripping(*blob_columns)
          end
        end
      end
    end
  end
end

Version data entries

77 entries across 66 versions & 2 rubygems

Version Path
sequel-5.88.0 lib/sequel/plugins/string_stripper.rb
sequel-5.87.0 lib/sequel/plugins/string_stripper.rb
sequel-5.86.0 lib/sequel/plugins/string_stripper.rb
sequel-5.85.0 lib/sequel/plugins/string_stripper.rb
sequel-5.84.0 lib/sequel/plugins/string_stripper.rb
sequel-5.83.1 lib/sequel/plugins/string_stripper.rb
sequel-5.83.0 lib/sequel/plugins/string_stripper.rb
sequel-5.82.0 lib/sequel/plugins/string_stripper.rb
sequel-5.81.0 lib/sequel/plugins/string_stripper.rb
sequel-5.80.0 lib/sequel/plugins/string_stripper.rb
sequel-5.79.0 lib/sequel/plugins/string_stripper.rb
sequel-5.78.0 lib/sequel/plugins/string_stripper.rb
sequel-5.77.0 lib/sequel/plugins/string_stripper.rb
sequel-5.76.0 lib/sequel/plugins/string_stripper.rb
sequel-5.75.0 lib/sequel/plugins/string_stripper.rb
sequel-5.74.0 lib/sequel/plugins/string_stripper.rb
sequel-5.73.0 lib/sequel/plugins/string_stripper.rb
sequel-5.72.0 lib/sequel/plugins/string_stripper.rb
sequel-5.71.0 lib/sequel/plugins/string_stripper.rb
sequel-5.70.0 lib/sequel/plugins/string_stripper.rb