https://github.com/revskill10/as_json_with_includes
Because we don't need ActiveModelSerializer!!!
https://github.com/revskill10/as_json_with_includes
json rails rubygems
Last synced: about 2 months ago
JSON representation
Because we don't need ActiveModelSerializer!!!
- Host: GitHub
- URL: https://github.com/revskill10/as_json_with_includes
- Owner: revskill10
- License: mit
- Created: 2016-07-09T10:08:06.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-09T12:37:38.000Z (almost 10 years ago)
- Last Synced: 2024-03-15T10:11:44.529Z (over 2 years ago)
- Topics: json, rails, rubygems
- Language: Ruby
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AsJsonWithIncludes
[](https://travis-ci.org/checkraiser/as_json_with_includes)
## Problem:
- We have complicated includes
```ruby
includes = [:a, :b, :c, :d, {:e => {:f => [:g, :g]}}]
```
- We can use it like this:
```ruby
model = model_1.submodels.includes(includes)
```
- The data is now in rails and we have to convert the data to json but we cannot do `render :json => submodels, :include => includes`
this is because the ":include =>" attribute expects a different format:
```ruby
[:a, :b, :c, :d, {:e => {:include => {:f => {:include => [:g, :h]}}}}]
```
which we have to manually write.
## Solution:
This gem takes active_record_includes of the form:
```ruby
[:a, :b, :c, :d, {:e => {:f => [:g, :h]}}]
```
and returns:
```ruby
[:a, :b, :c, :d, {:e => {:include => {:f => {:include => [:g, :h]}}}}]
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'as_json_with_includes'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install as_json_with_includes
## Usage
```ruby
includes = [:a, :b, {c: :d}]
model = Model.where(...).as_json_with_includes(includes: includes)
```
## Testing
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/as_json_with_includes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).