Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nulldef/ciesta
Create form objects
https://github.com/nulldef/ciesta
form-objects forms patterns ruby
Last synced: about 1 month ago
JSON representation
Create form objects
- Host: GitHub
- URL: https://github.com/nulldef/ciesta
- Owner: nulldef
- License: mit
- Created: 2018-02-27T17:53:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-22T21:26:59.000Z (almost 6 years ago)
- Last Synced: 2023-12-27T04:32:27.706Z (12 months ago)
- Topics: form-objects, forms, patterns, ruby
- Language: Ruby
- Homepage:
- Size: 64.5 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ciesta
[](https://travis-ci.org/nulldef/ciesta)
[](https://coveralls.io/github/nulldef/ciesta?branch=master)
[](https://badge.fury.io/rb/ciesta)
Create simple form objects
Supported Ruby 2.3+
You should keep it in mind that here uses [dry-validation](https://github.com/dry-rb/dry-validation) and [dry-types](https://github.com/dry-rb/dry-types) for validation and typification respectively.
- [Ciesta](#ciesta)
- [Installation](#installation)
- [Usage](#usage)
- [Basic case](#basic-case)
- [Validation](#validation)
- [Advanced field declaration](#advanced-field-declaration)
- [Types](#types)
- [Default value](#default-value)
- [Values mass update](#values-mass-update)
- [Contributing](#contributing)
- [License](#license)
## Installation
Add this line to your application's Gemfile:
```ruby
gem "ciesta"
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ciesta
## Usage
### Basic case
For example will be used a hash with `name` and `age` attributes:
```ruby
user = Hash[name: nil, age: nil]
```
For setting and syncing new values let's create a form object:
```ruby
class Form
include Ciesta
field :name
field :age
def age
super.to_i
end
end
form = Form.new(user)
```
```ruby
form.name = "John"
form.age = "33"
...
form.name # => "John"
form.age # => 33
```
### Validation
For validating incoming values you can use `validate` method:
```ruby
class Form
include Ciesta
field :name
field :age
validate do
required(:name).filled
required(:age).filled(gt?: 18)
end
end
form = Form.new(user)
```
An attempt to sync with invalid form will raise `Ciesta::FormNotValid` error.
```ruby
form.age = 15
form.valid? # => false
form.errors # => { age: ["must be greater than 18"] }
...
form.age = 42
form.valid? # => true
```
### Advanced field declaration
#### Types
You can define the type of a field using `Ciesta::Types` namespace.
```ruby
field :age, type: Ciesta::Types::Coercible::Int
...
form.age = "42"
form.age # => 42
```
Default type is `Ciesta::Types::Any`.
#### Default value
If your attribute wasn’t set yet, but value is already in use, one can set a `default` option to avoid exceptions.
```ruby
field :age, default: 42
...
form.age # => 42
```
Default value can also be a `Proc`, wich will be called in the object context.
```ruby
class User
def default_age
42
end
end
```
```ruby
field :age, default: -> { default_age }
...
form.age # => 42
```
## Values mass update
There are two methods for form fields mass update: `assign` and `assign!`.
```ruby
form.assign!(name: "Neo", age: 30)
...
user.name # => "Neo"
user.age # => 30
```
`assign!` method will raise `Ciesta::FieldNotDefined` error if one of the passed attributes is not declared in the form.
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/nulldef/ciesta](https://github.com/nulldef/ciesta).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).