Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnando/normalize_attributes
Sometimes you want to normalize data before saving it to the database like down casing e-mails, removing spaces and so on. This Rails plugin allows you to do so in a simple way.
https://github.com/fnando/normalize_attributes
activerecord normalization rails
Last synced: 5 days ago
JSON representation
Sometimes you want to normalize data before saving it to the database like down casing e-mails, removing spaces and so on. This Rails plugin allows you to do so in a simple way.
- Host: GitHub
- URL: https://github.com/fnando/normalize_attributes
- Owner: fnando
- License: mit
- Created: 2010-01-22T11:51:44.000Z (almost 15 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T11:43:44.000Z (over 1 year ago)
- Last Synced: 2025-01-01T22:11:50.692Z (9 days ago)
- Topics: activerecord, normalization, rails
- Language: Ruby
- Homepage:
- Size: 61.5 KB
- Stars: 49
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Normalize Attributes
[](https://github.com/fnando/normalize_attributes)
[](https://codeclimate.com/github/fnando/normalize_attributes)
[](https://rubygems.org/gems/normalize_attributes)
[](https://rubygems.org/gems/normalize_attributes)
Sometimes you want to normalize data before saving it to the database like
downcasing e-mails, removing spaces and so on. This Rails plugin allows you to
do so in a simple way.
## Usage
To install:
gem install normalize_attributes
Then on your model:
```ruby
class User < ActiveRecord::Base
normalize :email, with: :downcase
end
```
The example above will normalize your `:email` attribute on the `before_save`
callback.
You can specify multiple attributes
```ruby
normalize :email, :username, with: :downcase
```
You can use a block
```ruby
normalize :name do |value|
value.squish
end
```
You can combine both
```ruby
normalize :name, with: :downcase do |value|
value.squish
end
```
The `squish` method is the default normalizer for strings. All you need to is
specify the attribute:
```ruby
normalize :content
```
The `compact` method is the default normalizer for arrays (when using
`serialize` method):
```ruby
class User < ActiveRecord::Base
serialize :preferences, Array
normalize :preferences
end
```
The `normalize` method is aliased as `normalize_attributes`,
`normalize_attribute`, `normalize_attr`, and `normalize_attrs`.
You can normalize the attribute before type casting; this is specially useful
for normalizing dates and numbers.
```ruby
class Product
normalize(:price, raw: true) {|v| Money.new(v).to_f }
end
```
You can also use it with `ActiveModel::Model` classes.
```ruby
class UserForm
include ActiveModel::Model
include ActiveModel::Attributes
include ActiveModel::Validations::Callbacks
include NormalizeAttributes::Callbacks
attribute :username
normalize :username
end
```
## Maintainer
- [Nando Vieira](https://github.com/fnando)
## Contributors
- https://github.com/fnando/normalize_attributes/contributors
## Contributing
For more details about how to contribute, please read
https://github.com/fnando/normalize_attributes/blob/main/CONTRIBUTING.md.
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
found at https://github.com/fnando/normalize_attributes/blob/main/LICENSE.md.
## Code of Conduct
Everyone interacting in the normalize_attributes project's codebases, issue
trackers, chat rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/fnando/normalize_attributes/blob/main/CODE_OF_CONDUCT.md).