jsonapi_compliable 0.11.3 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f09a3b7abaad7968009175f50671ba51a32e42c0
-  data.tar.gz: d0a5de6083ae24be24380ff620fb10aa8ce0e3d6
+  metadata.gz: a808d8ba133336b8d4064dfd4e4419edf13f04b8
+  data.tar.gz: c445ae7db757752acc75d9f3116b9f4d0a53dc81
 SHA512:
-  metadata.gz: 0aa3c2b725818ef5ef30e328a98dc1595ffdace212cf7addf5c15db2b19e4f5ee48f17cde4b26358ee0a4ab42a94e29d5bda032c4e58ffbad367610135298268
-  data.tar.gz: 9f0469e4fb7ff9b697729e02a5d616a6551beb3d55374fa6eeb6ba645a7a22e431f9651cb708f63adae0c3a8d2f6a8fb20b80bda83549ca780c761a7e9de78b4
+  metadata.gz: 93690be0d49a991b134bd235c458c2fa381802d93b488f7e910cb481f0087b06752ef3141fdf446e989222bcc483703d21fd7cd1abe021ce5037bf71b3d3bbee
+  data.tar.gz: db0bac90c114efc88aa64347304a83adf035a76e461157cfa0a59eb83fc72d23da5bf43fabea7373b67c880aa0028dc7ae5a06e9033dd16a40467da5e5a34080

data/lib/jsonapi_compliable/configuration.rb

@@ -0,0 +1,14 @@
+# https://robots.thoughtbot.com/mygem-configure-block
+module JsonapiCompliable
+  class Configuration
+    # @return [Boolean] Should we raise when the client requests a relationship not defined on the server?
+    #   Defaults to true.
+    attr_accessor :raise_on_missing_sideload
+
+    # Set defaults
+    # @api private
+    def initialize
+      @raise_on_missing_sideload = true
+    end
+  end
+end

data/lib/jsonapi_compliable/scope.rb

@@ -82,12 +82,15 @@ module JsonapiCompliable
       includes.each_pair do |name, nested|
         sideload = @resource.sideload(name)
 
-        unless sideload
-          raise JsonapiCompliable::Errors::InvalidInclude.new(name, @resource.type)
+        if sideload.nil?
+          if JsonapiCompliable.config.raise_on_missing_sideload
+            raise JsonapiCompliable::Errors::InvalidInclude
+              .new(name, @resource.type)
+          end
+        else
+          namespace = Util::Sideload.namespace(@namespace, sideload.name)
+          sideload.resolve(results, @query, namespace)
         end
-
-        namespace = Util::Sideload.namespace(@namespace, sideload.name)
-        sideload.resolve(results, @query, namespace)
       end
     end
 

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.11.3"
+  VERSION = "0.11.4"
 end

data/lib/jsonapi_compliable.rb

@@ -1,4 +1,5 @@
 require "jsonapi_compliable/version"
+require "jsonapi_compliable/configuration"
 require "jsonapi_compliable/errors"
 require "jsonapi_compliable/resource"
 require "jsonapi_compliable/query"
@@ -64,4 +65,18 @@ module JsonapiCompliable
       self.context = prior
     end
   end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # @example
+  #   JsonapiCompliable.configure do |c|
+  #     c.raise_on_missing_sideload = false
+  #   end
+  #
+  # @see Configuration
+  def self.configure
+    yield config
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.11.4
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -220,6 +220,7 @@ files:
 - lib/jsonapi_compliable/adapters/active_record_sideloading.rb
 - lib/jsonapi_compliable/adapters/null.rb
 - lib/jsonapi_compliable/base.rb
+- lib/jsonapi_compliable/configuration.rb
 - lib/jsonapi_compliable/deserializer.rb
 - lib/jsonapi_compliable/errors.rb
 - lib/jsonapi_compliable/extensions/boolean_attribute.rb