No commit activity in last 3 years
No release in over 3 years
Treat your active_record includes as as_json include
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.11
~> 10.0
~> 3.0

Runtime

 Project Readme

AsJsonWithIncludes

Build Status

Problem:

  • We have complicated includes
includes = [:a, :b, :c, :d, {:e => {:f => [:g, :g]}}]
  • We can use it like this:
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:
[: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:

[:a, :b, :c, :d, {:e => {:f => [:g, :h]}}]

and returns:

[:a, :b, :c, :d, {:e => {:include => {:f => {:include => [:g, :h]}}}}]

Installation

Add this line to your application's Gemfile:

gem 'as_json_with_includes'

And then execute:

$ bundle

Or install it yourself as:

$ gem install as_json_with_includes

Usage

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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.