jsonapi_compliable 0.9.2 → 0.10.0

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  2 09:38:49 2017 by
+  Generated on Tue Oct  3 09:22:25 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.0).
 </div>

data/lib/jsonapi_compliable/base.rb

@@ -7,12 +7,13 @@ module JsonapiCompliable
 
     included do
       class << self
-        attr_accessor :_jsonapi_compliable
+        attr_accessor :_jsonapi_compliable, :_sideload_whitelist
       end
 
       def self.inherited(klass)
         super
         klass._jsonapi_compliable = Class.new(_jsonapi_compliable)
+        klass._sideload_whitelist = _sideload_whitelist.dup if _sideload_whitelist
       end
     end
 
@@ -52,6 +53,47 @@ module JsonapiCompliable
 
         self._jsonapi_compliable.class_eval(&blk) if blk
       end
+
+      # Set the sideload whitelist. You may want to omit sideloads for
+      # security or performance reasons.
+      #
+      # Uses JSONAPI::IncludeDirective from {{http://jsonapi-rb.org jsonapi-rb}}
+      #
+      # @example Whitelisting Relationships
+      #   # Given the following whitelist
+      #   class PostsController < ApplicationResource
+      #     jsonapi resource: MyResource
+      #
+      #     sideload_whitelist({
+      #       index: [:blog],
+      #       show: [:blog, { comments: :author }]
+      #     })
+      #
+      #     # ... code ...
+      #   end
+      #
+      #   # A request to sideload 'tags'
+      #   #
+      #   # GET /posts/1?include=tags
+      #   #
+      #   # ...will silently fail.
+      #   #
+      #   # A request for comments and tags:
+      #   #
+      #   # GET /posts/1?include=tags,comments
+      #   #
+      #   # ...will only sideload comments
+      #
+      # @param [Hash, Array, Symbol] whitelist
+      # @see Query#include_hash
+      def sideload_whitelist(hash)
+        self._sideload_whitelist = JSONAPI::IncludeDirective.new(hash).to_hash
+      end
+    end
+
+    # @api private
+    def sideload_whitelist
+      self.class._sideload_whitelist || {}
     end
 
     # Returns an instance of the associated Resource

data/lib/jsonapi_compliable/query.rb

@@ -49,12 +49,15 @@ module JsonapiCompliable
     # @return [Hash] the scrubbed include directive as a hash
     def include_hash
       @include_hash ||= begin
-        requested     = include_directive.to_hash
-        all_allowed   = resource.sideloading.to_hash[:base]
-        whitelist     = resource.sideload_whitelist.values.reduce(:merge)
-        allowed       = whitelist ? Util::IncludeParams.scrub(all_allowed, whitelist) : all_allowed
+        requested = include_directive.to_hash
 
-        Util::IncludeParams.scrub(requested, allowed)
+        whitelist = nil
+        if resource.context
+          whitelist = resource.context.sideload_whitelist
+          whitelist = whitelist[resource.context_namespace] if whitelist
+        end
+
+        whitelist ? Util::IncludeParams.scrub(requested, whitelist) : requested
       end
     end
 

data/lib/jsonapi_compliable/resource.rb

@@ -132,36 +132,6 @@ module JsonapiCompliable
       @sideloading ||= Sideload.new(:base, resource: self)
     end
 
-    # Set the sideload whitelist. You may want to omit sideloads for
-    # security or performance reasons.
-    #
-    # Uses JSONAPI::IncludeDirective from {{http://jsonapi-rb.org jsonapi-rb}}
-    #
-    # @example Whitelisting Relationships
-    #   # Given the following whitelist
-    #   class PostResource < ApplicationResource
-    #     # ... code ...
-    #     sideload_whitelist([:blog, { comments: :author }])
-    #   end
-    #
-    #   # A request to sideload 'tags'
-    #   #
-    #   # GET /posts?include=tags
-    #   #
-    #   # ...will silently fail.
-    #   #
-    #   # A request for comments and tags:
-    #   #
-    #   # GET /posts?include=tags,comments
-    #   #
-    #   # ...will only sideload comments
-    #
-    # @param [Hash, Array, Symbol] whitelist
-    # @see Query#include_hash
-    def self.sideload_whitelist(whitelist)
-      config[:sideload_whitelist] = JSONAPI::IncludeDirective.new(whitelist).to_hash
-    end
-
     # Whitelist a filter
     #
     # @example Basic Filtering
@@ -413,7 +383,6 @@ module JsonapiCompliable
     def self.config
       @config ||= begin
         {
-          sideload_whitelist: {},
           filters: {},
           default_filters: {},
           extra_fields: {},
@@ -568,60 +537,9 @@ module JsonapiCompliable
       persistence.run
     end
 
-    # All possible sideload names, including nested names
-    #
-    #   { comments: { author: {} } }
-    #
-    # Becomes
-    #
-    #   [:comments, :author]
-    #
-    # @see Sideload#to_hash
-    # @return [Array<Symbol>] the list of association names
+    # @see Sideload#association_names
     def association_names
-      @association_names ||= begin
-        if sideloading
-          Util::Hash.keys(sideloading.to_hash[:base])
-        else
-          []
-        end
-      end
-    end
-
-    # An Include Directive Hash of all possible sideloads for the current
-    # context namespace, taking into account the sideload whitelist.
-    #
-    # In other words, say we have this resource:
-    #
-    #   class PostResource < ApplicationResource
-    #     sideload_whitelist({
-    #       index: :comments,
-    #       show: { comments: :author }
-    #     })
-    #   end
-    #
-    # Expected behavior:
-    #
-    #   allowed_sideloads(:index) # => { comments: {} }
-    #   allowed_sideloads(:show) # => { comments: { author: {} }
-    #
-    #   instance.with_context({}, :index) do
-    #     instance.allowed_sideloads # => { comments: {} }
-    #   end
-    #
-    # @see Util::IncludeParams.scrub
-    # @see #with_context
-    # @param [Symbol] namespace Can be :index/:show/etc - The current context namespace will be used by default.
-    # @return [Hash] the scrubbed include directive
-    def allowed_sideloads(namespace = nil)
-      return {} unless sideloading
-
-      namespace ||= context_namespace
-      sideloads = sideloading.to_hash[:base]
-      if !sideload_whitelist.empty? && namespace
-        sideloads = Util::IncludeParams.scrub(sideloads, sideload_whitelist[namespace])
-      end
-      sideloads
+      sideloading.association_names
     end
 
     # The relevant proc for the given attribute and calculation.
@@ -710,12 +628,6 @@ module JsonapiCompliable
       self.class.config[:extra_fields]
     end
 
-    # @see .sideload_whitelist
-    # @api private
-    def sideload_whitelist
-      self.class.config[:sideload_whitelist]
-    end
-
     # @see .default_filter
     # @api private
     def default_filters

data/lib/jsonapi_compliable/scope.rb

@@ -80,10 +80,8 @@ module JsonapiCompliable
       return if results == []
 
       includes.each_pair do |name, nested|
-        if @resource.allowed_sideloads.has_key?(name)
-          sideload = @resource.sideload(name)
-          sideload.resolve(results, @query)
-        end
+        sideload = @resource.sideload(name)
+        sideload.resolve(results, @query)
       end
     end
 

data/lib/jsonapi_compliable/sideload.rb

@@ -43,21 +43,6 @@ module JsonapiCompliable
       extend @resource_class.config[:adapter].sideloading_module
     end
 
-    # @api private
-    def self.max_recursion
-      @max_recursion || 2
-    end
-
-    # Set maximum levels of sideload recursion
-    # /authors?comments.authors would be one level
-    # /authors?comments.authors.comments.authors would be two levels
-    # etc
-    #
-    # Default max recursion is 2
-    def self.max_recursion=(val)
-      @max_recursion = val
-    end
-
     # @see #resource_class
     # @return [Resource] an instance of +#resource_class+
     def resource
@@ -359,44 +344,15 @@ module JsonapiCompliable
       end
     end
 
-    # Looks at all nested sideload, and all nested sideloads for the
-    # corresponding Resources, and returns an Include Directive hash
-    #
-    # For instance, this configuration:
-    #
-    #   class BarResource < ApplicationResource
-    #     allow_sideload :baz do
-    #     end
-    #   end
-    #
-    #   class PostResource < ApplicationResource
-    #     allow_sideload :foo do
-    #       allow_sideload :bar, resource: BarResource do
-    #       end
-    #     end
-    #   end
-    #
-    # +post_resource.sideloading.to_hash+ would return
-    #
-    #   { base: { foo: { bar: { baz: {} } } } }
-    #
-    # @return [Hash] The nested include hash
-    # @api private
-    def to_hash(recursion_chain = [], parent = nil)
-      recursing = ->(arr) { arr == [parent.object_id, self.object_id] }
-      recursions = recursion_chain.select(&recursing).length
-      return {} if recursions >= self.class.max_recursion
-
-      unless (parent && parent.name == :base) || name == :base
-        recursion_chain += [[parent.object_id, self.object_id]]
-      end
-
-      { name => {} }.tap do |hash|
-        all_sideloads.each_pair do |key, sl|
-          sideload_hash = sl.to_hash(recursion_chain, self)
-          hash[name].merge!(sideload_hash)
+    def association_names(memo = [])
+      all_sideloads.each_pair do |name, sl|
+        unless memo.include?(sl.name)
+          memo << sl.name
+          memo |= sl.association_names(memo)
         end
       end
+
+      memo
     end
 
     # @api private
@@ -417,14 +373,6 @@ module JsonapiCompliable
 
     private
 
-    def nested_sideload_hash(sideload, processed)
-      {}.tap do |hash|
-        if sideloading = sideload.resource_class.sideloading
-          hash.merge!(sideloading.to_hash(processed)[:base])
-        end
-      end
-    end
-
     def polymorphic_grouper(grouping_field)
       lambda do |record|
         if record.is_a?(Hash)

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable