百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
A

auto_strip_attributes

> 编程语言
开源

Rails 的 AutoStripAttributes gem 可帮助从 ActiveRecord 或 ActiveModel 属性中删除不必要的空格。它非常适合删除意外的空格。

363 stars0 点赞3 次浏览
访问官网GitHub

工具介绍

Rails 的 AutoStripAttributes gem 可帮助从 ActiveRecord 或 ActiveModel 属性中删除不必要的空格。它非常适合删除意外的空格。

AutoStripAttributes

AutoStripAttributes helps to remove unnecessary whitespaces from ActiveRecord or ActiveModel attributes. It's good for removing accidental spaces from user inputs (e.g. when user copy/pastes some value to a form and the value has extra spaces at the end).

It works by adding a before_validation hook to the record. No other methods are added. Gem is kept as simple as possible.

Gem has option to set empty strings to nil or to remove extra spaces inside the string.

Howto / examples

Include gem in your Gemfile:

ruby
gem "auto_strip_attributes", "~> 2.6"

Example ActiveRecord usage:

ruby
class User  "James Bond"
  auto_strip_attributes :name, squish: true

  # Won't set to null even if string is blank. "   " => ""
  auto_strip_attributes :email, nullify: false

  # Won't set to null even if array is blank. ["   "] => []
  auto_strip_attributes :tags, nullify_array: false

  # Use with attributes that are not mapped to a column
  auto_strip_attributes :password, virtual: true
end

Example ActiveModel usage:

ruby
class VirtualUser
  include ActiveModel::Validations
  include ActiveModel::Validations::Callbacks

  extend AutoStripAttributes

  attr_accessor :email

  # Use the `virtual` option because attributes are not mapped to a column
  auto_strip_attributes :email, virtual: true
end

virtual_user = VirtualUser.new
virtual_user.email = " [email protected] "

virtual_user.validate
virtual_user.email #=> "alice@example.com"

Options

Default options

By default the following options are defined (listed in the order of processing):

  • :strip (enabled by default) - removes whitespaces from the beginning and the end of string. Works exactly same as String#strip, i.e., may not strip non-ASCII whitespaces.
  • :nullify (enabled by default) - replaces empty strings with nil.
  • :nullify_array (enabled by default) - replaces empty arrays with nil.
  • :squish (disabled by default) - replaces all consecutive Unicode whitespace characters (including tabs and new lines) with single space (U+0020). Works exactly same as Rails String#squish
  • :delete_whitespaces (disabled by default) - deletes all spaces (U+0020) and tabs (U+0009).
  • :convert_non_breaking_spaces (disabled by default) - converts non-breaking spaces (U+00A0) to normal spaces (U+0020).
  • :virtual (disabled by default) - By default auto_strip_attributes doesn't work with non-persistent attributes (e.g., attributes that are created with attr_accessor). This is to avoid calling their custom getter/setter methods. Use this option with non-persistent attributes.
  • For more filters use custom filters (more examples at https://github.com/holli/auto_strip_attributes/wiki)

Custom Filters

Gem supports custom filtering methods. Custom methods can be set by calling to set_filter method inside a block passed to AutoStripAttributes::Config.setup. set_filter method accepts either Symbol or Hash as a parameter. If parameter is a Hash, the key should be filter name and the value is boolean whether filter is enabled by default or not. Block should return processed value. See examples of custom filters at https://github.com/holli/auto_strip_attributes/wiki

This is an example on how to add html tags stripping in Rails

ruby

E.g. inside config/initializers/auto_strip_attributes.rb

AutoStripAttributes::Config.setup do
  set_filter(strip_html: false) do |value|
    ActionController::Base.helpers.strip_tags value
  end
end

And in the model:

class User  true, to clear all filters
- :defaults => true, to set three default filters mentioned above

# Versions

- see https://github.com/holli/auto_strip_attributes/blob/master/CHANGELOG.md

# Requirements

Gem has been tested with newest Ruby & Rails combination and it probably works also with older versions. See test matrix at https://github.com/holli/auto_strip_attributes/blob/master/.github/workflows/ci.yaml

# Support

Submit suggestions or feature requests as a GitHub Issue or Pull Request. Remember to update tests. Tests are quite extensive.

# Other approaches

This gem works by adding before_validation hook and setting attributes with self[attribute]=stripped_value. See: https://github.com/holli/auto_strip_attributes/blob/master/lib/auto_strip_attributes.rb

Other approaches could include calling attribute= from before_validation. This would end up calling possible custom setters twice. Might not be desired effect (e.g. if setter does some logging).

Method chaining attribute= can be also used. But then stripping would be omitted if there is some code that calls model[attribute]= directly. This could happen easily when using hashes in some places.

### Similar gems

There are many similar gems. Most of those don't have :squish or :nullify options. Those gems
might have some extra methods whereas this gem is kept as simple as possible. These gems have a bit
different approaches. See discussion in previous chapter.

- https://github.com/phatworx/acts_as_strip
- https://github.com/rmm5t/strip_attributes
- https://github.com/thomasfedb/attr_cleaner
- https://github.com/mdeering/attribute_normalizer (Bit hardcore approach, more features and more complex)

# Licence

Released under the MIT license (http://www.opensource.org/licenses/mit-license.php)

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Ruby

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言