https://github.com/kachick/striuct
Struct + validation + inheritable + default value + ...
https://github.com/kachick/striuct
ruby struct type validation
Last synced: about 1 year ago
JSON representation
Struct + validation + inheritable + default value + ...
- Host: GitHub
- URL: https://github.com/kachick/striuct
- Owner: kachick
- License: mit
- Archived: true
- Created: 2011-12-10T19:49:06.000Z (over 14 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T08:27:30.000Z (almost 2 years ago)
- Last Synced: 2025-03-25T02:51:31.206Z (about 1 year ago)
- Topics: ruby, struct, type, validation
- Language: Ruby
- Homepage:
- Size: 797 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# striuct
[](http://badge.fury.io/rb/striuct)
Struct++
- _**This repository is archived**_
- _**No longer maintained**_
- _**I didn't remove old versions on https://rubygems.org/gems/striuct, but I no longer plan to update them.**_
## Usage
Tested in Ruby 3.2 or 3.3
Add this line to your `Gemfile`
```ruby
gem 'striuct', '~> 0.10.1'
```
Then add below code into your Ruby code
```ruby
require 'striuct'
```
### Overview
#### Case 1
```ruby
require 'striuct'
class Person < Striuct
member :full_name, AND(String, /\A.+\z/) # Flexible Validation
alias_member :name, :full_name # Use other name
end
# Inheritable
class User < Person
member :id, Integer, # Looks typed validation
default_proc: ->{User.next_id} # With default value
@id = 0
def self.next_id
@id += 1
end
end
john = User.new 'john'
john[:name] #=> 'john'
john.name = '' #=> Exception # Validate with setter
john.id #=> 1
ken = User[name: 'ken'] # Construct from hash
ken.id #=> 2
```
#### Case 2
```ruby
class Foo < Striuct
member :foo
member :bar, Numeric
member :with_adjuster, Integer,
&->v{Integer v} # Use adjuster before a setter
end
foo = Foo.new
# nil <-> unassigned
foo.foo #=> nil
foo.assigned?(:foo) #=> false
foo.foo = nil
foo.assigned?(:foo) #=> true
# Lock to a member
foo.lock(:foo)
foo.foo = nil #=> error
foo.bar = 1.2 #=> pass # memorize 1.2's class is Float
foo.bar = 1 #=> error # 1 is not Float
# With adjuster
foo.with_adjuster = '5'
foo.with_adjuster #=> 5 # Casted via adjuster
```
#### Case 3
```ruby
class UseMustOption < Striuct
member :foo, Integer, must: true
end
UseMustOption.new #=> InvalidOperationError "`foo` require a value under `must` option "
```
## Features
### Strict
- Easy and Flexible Validations
- Basically use `#===` for the validation
- The pattern builder DSL is just using [eqq](https://github.com/kachick/eqq)
- When passed the Proc, it will be evaluated in the instance context
- Prevent to conflict member names
- Lock setters for each member
### Useful
- Hook just before setters
- Default value
- Member aliasing
- Inheritable
- Handling between nil <-> unassigned
- Similar API for Hash
### Finally
- Base API looks like Struct
- Pure Ruby :)