Giter Club home page Giter Club logo

immutability_validator's Introduction

ImmutabilityValidator

This gem brings immutability validation to your Rails project. Let's say you want to describe your model from business perspective when you really don't want to allow to change the persisted state of some field during mutation methods like (save, update, update! etc). This is kind of different from readony: true option which silently ignore the updating process, the main goal of this gem is to let end user know about such a stuff with provided error message.

Installation

Add this line to your application's Gemfile:

gem 'immutability_validator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install immutability_validator

Usage

Just add the next line in your model:

validates :my_field, immutability: true

Or use a shorthand:

validates_immutability_of :my_field

Also you need to add .activerecord.errors.base.immutability translation to your local I18n storage. Alternatively you can use:

validates :my_field, immutability: { message: 'My awesome message' }

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dsounded/immutability_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

immutability_validator's People

Contributors

dsounded avatar sergeykish avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.