Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorkasyanchuk/with_record
Returns relations/association for soft deleted records in DB
https://github.com/igorkasyanchuk/with_record
Last synced: about 2 months ago
JSON representation
Returns relations/association for soft deleted records in DB
- Host: GitHub
- URL: https://github.com/igorkasyanchuk/with_record
- Owner: igorkasyanchuk
- License: mit
- Created: 2019-03-07T13:36:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-21T18:03:10.000Z (over 2 years ago)
- Last Synced: 2024-04-14T07:00:42.672Z (6 months ago)
- Language: Ruby
- Homepage: https://www.railsjazz.com/
- Size: 42 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
Awesome Lists containing this project
README
# with_record
[](https://www.railsjazz.com)
[](https://www.patreon.com/igorkasyanchuk)
This gem could DRY your code and return association/relation with additioanl records. Could be used in case you have form with soft-deleted value.
**The example of problem:**
You have 2 models: User and Project. User has many projects. Project belongs to "assignee" (or author).
Let's say you have "soft-delete" (for example using paranoia" gem) and deleted user. Same time, all projects are still available (you just have such logic).
Now you want to edit the project. And in the form you have a dropdown with all active users. In this case list will be blank (because user was deleted).
So usually you need to do something like:
```slim
# just an example with problem (!!!)
= f.input :assignee_id, as: :select, collection: User.all + [User.unscoped.find_by(id: f.object.assineed_id)]
```
But now you can do the following:
```slim
# just an example with solution
= f.input :assignee_id, as: :select, collection: User.all.with_record(f.object.assineed_id)
```
And as a bonus you can also call scopes for example:
```ruby
User.all.with_record(f.object.assineed_id).ordered` # to return by first_name
```
Or
```ruby
@project.users.with_record(42).ordered # to include user by ID
@project.users.with_records(42, 43, 44).ordered # to include user by ID's
```
## Usage
This gem is adding two methods to ActiveRecord Relations and Associations - `with_record(...)` and `with_records(...)`.
You can do the following:
```ruby
u1 = User.create(name: 'John')
u2 = User.create(name: 'Bob')
p1 = u1.projects.create(name: 'apple')
p2 = u2.projects.create(name: 'google')
p3 = u2.projects.create(name: 'amazon')
assert_equal u1.projects.with_record(p2), [p1, p2]
assert_equal u1.projects.with_records(p2, p3), [p1, p2, p3]
assert_equal u1.projects.with_records([p2, p3]), [p1, p2, p3]
assert_equal Project.where(id: p1.id).with_record(p2), [p1, p2]
assert_equal Project.where(id: p1.id).with_records(p2, p3), [p1, p2, p3]
assert_equal Project.where(id: p1.id).with_records([p2, p3]), [p1, p2, p3]
assert_equal Project.where(id: p1.id).with_record(nil), [p1]
assert_equal Project.where(id: p1.id).with_records(nil), [p1]
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'with_record'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install with_record
```
## How it works and limitations
- it's adding 2 methods to AR Relations and Associations.
- it's executing original scope, returning and ID's (or other PK values), then adding a new ID into it and returning a new releation
- joins, includes, ... before call `.with_record` won't be returned in final scope
## Contributing
You are welcome to contribute.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
[
](https://www.railsjazz.com/)
[](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=with_record)