model_driven_api 3.4.6 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 429b78e0b1d6d4a1fad0f20d4e5d614f1fbc0b1c7b55fe24481a23286a241685
-  data.tar.gz: 7fe2351ea6411a773d811ed5eecc7a2c3376bb975b0828866308c8444d5da85b
+  metadata.gz: 81f4bf59354a604bb9040be285c3e9ed38f4e847ed945254c6ef2969f72190af
+  data.tar.gz: 83fd3fd82615dc3a23e8a5bad639c2fb9bbacb9ac699df1544e46f6219ec960f
 SHA512:
-  metadata.gz: 0c646e1b5a7533f4513b2ce1466ef6f2907fcfa2a6385f603382b1ba19ede14da9b50d7d611d72108f8f47d018129dbac16d6a1d3192aff7b102a72be51a668d
-  data.tar.gz: f0bdacb0f2625083ab1453ccddce7dfca4c3ff469a7ee88d0c8035d826f72ca9f3609fb60bdcf2e5e136b99998ee4af49ab1bbfb1c10a5f032f7a0cb5fa62a13
+  metadata.gz: 9cd024384b0ee5ab85e40b30b0f986307f04c5ffd4a9d89b45742a02e7f629777c7da57f4af3d118b553cfc78803783baa376ccbb262f55764f513ab7d1d5958
+  data.tar.gz: 3f23e0f14efd400f79edfa762143f6ccbd6b6e5dab6e536b6f27631aa6260640737452a1971632cc729c2245e931ae5bf6ddc3ee74435f75c2016fff0bc5465b

data/config/initializers/auto_include_json.rb

@@ -0,0 +1,109 @@
+# config/initializers/auto_include_json.rb
+
+module AutoIncludeJson
+  # Recursively builds a hash suitable for ActiveRecord eager loading
+  def build_includes(include_option)
+    Rails.logger.debug "Building includes from: #{include_option.inspect} from #{caller_locations(1,1).first.label}"
+    case include_option
+    when Array
+      include_option
+    when Hash
+      include_option.each_with_object({}) do |(assoc, value), hash|
+        if value.is_a?(Hash) && value[:include]
+          hash[assoc] = build_includes(value[:include])
+        else
+          hash[assoc] = {}
+        end
+      end
+    else
+      []
+    end
+  end
+
+  # Recursively sanitize include options to ensure only, except, methods propagate
+  def sanitize_includes(include_option)
+    case include_option
+    when Array
+      include_option
+    when Hash
+      include_option.each_with_object({}) do |(assoc, value), hash|
+        hash[assoc] = {}
+
+        if value.is_a?(Hash)
+          hash[assoc][:only]    = value[:only] if value[:only]
+          hash[assoc][:except]  = value[:except] if value[:except]
+          hash[assoc][:methods] = value[:methods] if value[:methods]
+
+          if value[:include]
+            hash[assoc][:include] = sanitize_includes(value[:include])
+          end
+        end
+      end
+    else
+      []
+    end
+  end
+end
+
+# For ActiveRecord::Relation (collections)
+module AutoIncludeRelationJson
+  include AutoIncludeJson
+
+  def to_json(options = nil)
+    Rails.logger.debug "Relation JSON to_json from #{caller_locations(1,1).first.label}"
+    return super unless options.is_a?(Hash) && options[:include]
+
+    includes_hash = build_includes(options[:include])
+    sanitized_includes = sanitize_includes(options[:include])
+    options = options.merge(include: sanitized_includes)
+
+    self.includes(includes_hash).load.to_a.to_json(options)
+  end
+
+  def as_json(options = nil)
+    Rails.logger.debug "Relation JSON as_json from #{caller_locations(1,1).first.label}"
+    return super unless options.is_a?(Hash) && options[:include]
+
+    includes_hash = build_includes(options[:include])
+    sanitized_includes = sanitize_includes(options[:include])
+    options = options.merge(include: sanitized_includes)
+
+    self.includes(includes_hash).load.to_a.as_json(options)
+  end
+end
+
+# For ActiveRecord::Base (single records)
+module AutoIncludeInstanceJson
+  include AutoIncludeJson
+
+  def to_json(options = nil)
+    preload_and_sanitize!(options)
+    super
+  end
+
+  def as_json(options = nil)
+    preload_and_sanitize!(options)
+    super
+  end
+
+  private
+
+  def preload_and_sanitize!(options)
+    Rails.logger.debug "Instance JSON preload_and_sanitize! from #{caller_locations(1,1).first.label}"
+    return unless options.is_a?(Hash) && options[:include]
+
+    includes_hash = build_includes(options[:include])
+    sanitized_includes = sanitize_includes(options[:include])
+    options[:include] = sanitized_includes
+
+    ActiveRecord::Associations::Preloader.new(
+      records: [self],
+      associations: includes_hash
+    ).call
+  end
+
+end
+
+# Activate extensions
+ActiveRecord::Relation.prepend(AutoIncludeRelationJson)
+ActiveRecord::Base.prepend(AutoIncludeInstanceJson)

data/lib/model_driven_api/version.rb

@@ -1,3 +1,3 @@
 module ModelDrivenApi
-  VERSION = "3.4.6".freeze
+  VERSION = "3.5.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.4.6
+  version: 3.5.1
 platform: ruby
 authors:
 - Gabriele Tassoni
@@ -130,6 +130,7 @@ files:
 - app/models/test_api.rb
 - app/models/used_token.rb
 - config/initializers/after_initialize_for_model_driven_api.rb
+- config/initializers/auto_include_json.rb
 - config/initializers/cors_api_thecore.rb
 - config/initializers/knock.rb
 - config/initializers/time_with_zone.rb