as_json_with_includes 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cbacee74d3afeea518276751f6ce7832d7da1dc
-  data.tar.gz: d9a1dcfbfb805a69d85d0a4d21830f19cfe9ce3e
+  metadata.gz: b89654eb74fabd0c5546624012e78c38a9239ffb
+  data.tar.gz: df3b18361523ac7eb66e29463b5b34e7f526f43c
 SHA512:
-  metadata.gz: 295ff06f4d773660e200becbe885ab7298c04ecd66c40ed4dfef4ca5f32919818986438bf2ca7e0397219b67965a4d46800c65630d41887642fd2cebec0cb024
-  data.tar.gz: 89a38260fceeb60404190394e43041a94666611882570ea08d357f7d6e4705293dd9fd7ad237027e148313c5065deeb155132292a0d00c6ba7471dbe6c890a91
+  metadata.gz: be2de28e44c351a9d10cda236d6ec25e67b49102eea8537dd8c32278cbcf882c0e2ecd392ceab4334d4fef22abfd0b93abc214e76a21394c8cd61eae85e3b42c
+  data.tar.gz: c6fe595c262dc5aef9af8ee2bdfe5dcae85355c44223a42fdbb6ec75d28ec8bcdaa4d4707782720bcf8f2ff6794cfc150e0d77afb3c41fc6611ae81f80c7c512

data/README.md

@@ -1,8 +1,41 @@
 # AsJsonWithIncludes
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/as_json_with_includes`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Problem:
 
-TODO: Delete this and the text above, and describe your gem
+- 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
 
@@ -22,7 +55,10 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+includes = [:a, :b, {c: :d}]
+model = Model.where(...).as_json_with_includes(includes: includes)
+```
 
 ## Development
 

data/lib/as_json_with_includes.rb

@@ -1,4 +1,5 @@
 require "as_json_with_includes/version"
+require 'active_record'
 
 module AsJsonWithIncludes
   module BasePatch

data/lib/as_json_with_includes/version.rb

@@ -1,3 +1,3 @@
 module AsJsonWithIncludes
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: as_json_with_includes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Truong Hoang Dung