Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pcriv/statics
Base class and modules for YAML backed static models.
https://github.com/pcriv/statics
dry-rb ruby yaml
Last synced: about 2 months ago
JSON representation
Base class and modules for YAML backed static models.
- Host: GitHub
- URL: https://github.com/pcriv/statics
- Owner: pcriv
- License: mit
- Created: 2018-08-30T09:21:39.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T22:29:23.000Z (3 months ago)
- Last Synced: 2024-07-21T13:43:35.097Z (2 months ago)
- Topics: dry-rb, ruby, yaml
- Language: Ruby
- Homepage:
- Size: 32.2 KB
- Stars: 43
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Statics
[](http://rubygems.org/gems/statics)
[](https://depfu.com/github/pcriv/statics?project=Bundler)
[](http://inch-ci.org/github/pcriv/statics)
[](https://codeclimate.com/github/pcriv/statics/maintainability)
[](https://codeclimate.com/github/pcriv/statics/test_coverage)
Base class and modules for static models.
Links:
- [API Docs](https://www.rubydoc.info/gems/statics)
- [Contributing](https://github.com/pcriv/statics/blob/master/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/pcriv/statics/blob/master/CODE_OF_CONDUCT.md)
## Requirements
1. [Ruby 3.0.0](https://www.ruby-lang.org)
## Installation
To install, run:
```sh
gem install statics
```
Or add the following to your Gemfile:
```sh
gem "statics"
```
## Usage
Setting the data path:
```ruby
Statics.configure do |config|
config.data_path = "data/"
end
```
Defining a static model:
```ruby
class Post < Statics::Model
filename "posts"
attribute :title, Types::Strict::String
end
```
```yml
# data/posts.yml
---
post1:
title: "Post 1"
post2:
title: "Post 2"
```
```ruby
Post.all
#=> #, #]>
Post.where(title: "Post 1")
#=> #]>
Post.where_not(title: "Post 1")
#=> #]>
Post.find_by(key: :post1)
#=> #
Post[:post1]
#=> #
Post.pluck(:title)
#=> ["Post 1", "Post 2"]
post = Post.first
#=> #
post.key
#=> :post1
post.title
#=> "Post 1"
post.attributes
#=> {:title=>"Post 1", :key=>:post1}
```
Defining translatable attributes:
```ruby
class Post < Statics::Model
include Statics::Translatable
filename "posts"
attribute :title, Types::Strict::String
translatable_attribute :body
end
```
```yml
# data/posts.yml
---
post1:
title: "Post 1"
body:
en: "Hello!"
nl: "Hallo!"
post2:
title: "Post 2"
body:
en: "Bye!"
nl: "Doei!"
```
```ruby
post = Post.first
# when I18n.locale is :en
post.body #=> "Hello!"
post.body(locale: :nl) #=> "Hallo!"
```
Defining omittable attributes with defaults:
```ruby
class Post < Statics::Model
include Statics::Translatable
filename "posts"
attribute :title, Types::Strict::String
# With default
attribute? :author, Types::Strict::String.default("Unknown")
# Without default
# attribute? :author, Types::Strict::String
end
```
```yml
# data/posts.yml
---
post1:
title: "Post 1"
author: "Rick Sanchez"
post2:
title: "Post 2"
```
```ruby
post1 = Post.first
post1.author #=> "Rick Sanchez"
post2 = Post.last
post2.author #=> "Unknown"
```
Check [dry-types](https://dry-rb.org/gems/dry-types) for documentation about the [built-in types](https://dry-rb.org/gems/dry-types/built-in-types/).
## Caveats
If you have dates in your yaml-files, use the following format for them to be handled properly: `YYYY-MM-DD`
## Tests
To test, run:
```
bundle exec rspec spec/
```
## Versioning
Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
## License
Copyright 2018 [Pablo Crivella](https://pcriv.com).
Read [LICENSE](LICENSE) for details.