graphiti 2.0.0.beta.5 → 2.0.0.beta.7

data/lib/graphiti/resource/polymorphism.rb

@@ -8,6 +8,8 @@ module Graphiti
       end
 
       def serializer_for(model)
+        return super unless self.class.polymorphic?
+
         if polymorphic_child?
           serializer
         else
@@ -17,10 +19,14 @@ module Graphiti
       end
 
       def associate_all(*args)
+        return super unless self.class.polymorphic?
+
         _associate(:associate_all, *args)
       end
 
       def associate(*args)
+        return super unless self.class.polymorphic?
+
         _associate(:associate, *args)
       end
 
@@ -34,6 +40,8 @@ module Graphiti
 
       module ClassMethods
         def inherited(klass)
+          return super unless polymorphic?
+
           klass.type = nil
           klass.model = klass.infer_model
           klass.endpoint = klass.infer_endpoint
@@ -42,6 +50,8 @@ module Graphiti
         end
 
         def sideload(name)
+          return super unless polymorphic?
+
           if (split_on = name.to_s.split(/^on__/)).length > 1
             on_type, name = split_on[1].split("--").map(&:to_sym)
           end

data/lib/graphiti/runner.rb

@@ -3,8 +3,13 @@ module Graphiti
     attr_reader :params
     attr_reader :deserialized_payload
 
-    # TODO: make query and action keywords once the satellite gems are rolled in - they instantiate Runner positionally
-    def initialize(resource_class, params, query = nil, action = nil)
+    def initialize(resource_class, params, *positional, query: nil, action: nil)
+      if positional.any?
+        Graphiti::DEPRECATOR.warn("Passing query/action to Runner.new positionally is deprecated. Use query:/action: keywords.")
+        query ||= positional[0]
+        action ||= positional[1]
+      end
+
       @resource_class = resource_class
       @params = params
       @query = query
@@ -30,7 +35,7 @@ module Graphiti
     end
 
     def query
-      @query ||= Query.new(jsonapi_resource, params, nil, nil, [], @action)
+      @query ||= Query.new(jsonapi_resource, params, action: @action)
     end
 
     def query_hash

data/lib/graphiti/schema.rb

@@ -251,7 +251,7 @@ module Graphiti
             schema[:guard] = true
           end
 
-          if config.always_include_resource_ids?
+          if config.render_resource_ids?
             schema[:linkage] = true
           end
 

data/lib/graphiti/scope.rb

@@ -154,12 +154,25 @@ module Graphiti
         payload[:results]
       }
       resolved.compact!
+      deduplicate_entities!(resolved)
       assign_serializer(resolved)
       yield resolved if block_given?
       @opts[:after_resolve]&.call(resolved)
       resolved
     end
 
+    # Must run before sideloads assign, so every include path populates the
+    # canonical instance. The resource class in the key keeps two resources
+    # serving the same model from sharing an instance and a serializer.
+    def deduplicate_entities!(resolved)
+      resolved.map! do |record|
+        next record unless record.respond_to?(:id) && !record.id.nil?
+
+        key = [@resource.class, record.class, record.id]
+        @query.entity_map.compute_if_absent(key) { record }
+      end
+    end
+
     def each_applicable_sideload
       @query.sideloads.each_pair do |name, sideload_query|
         sideload = @resource.class.sideload(name)

data/lib/graphiti/sideload/belongs_to.rb

@@ -3,40 +3,33 @@ class Graphiti::Sideload::BelongsTo < Graphiti::Sideload
     :belongs_to
   end
 
-  def default_include_resource_ids?
-    linkage_from_foreign_key?
+  def default_render_resource_ids?
+    case parent_resource_class&.belongs_to_resource_ids_by_default
+    when :always then renderable_at_all?
+    when :never then false
+    else resource_ids_from_foreign_key?
+    end
+  end
+
+  def renderable_at_all?
+    readable_guarded? || readable?
   end
 
-  # The parent already carries the foreign key, and for a plain belongs_to
-  # that key *is* the related id, so linkage costs nothing. Anything that can
-  # change which record the relationship resolves to, or what type it carries,
-  # has to load the association instead:
-  #
-  #   - a scope/params block or a base_scope can filter out the record the
-  #     foreign key points at, so the key would claim a relationship the API
-  #     would not actually return
-  #   - a polymorphic target takes its type from the record, not from the
-  #     relationship, so the key alone cannot say what type the id has
-  #   - a remote resource has no local foreign key to read
-  #   - a custom primary_key points the relationship at some other column, so
-  #     the key holds that column's value rather than the related id
-  def linkage_from_foreign_key?
-    # Ask before resolving #resource: an unreadable relationship renders
-    # nothing, and its resource class may not even be inferrable.
-    return false unless readable?
-    return false unless foreign_key_is_related_id?
-    return false if polymorphic_child?
-    return false if self.class.scope_proc || self.class.params_proc
-    return false if @base_scope
-    return false if remote?
-    return false if resource.class.polymorphic.present?
+  def resource_ids_blocker
+    return :unreadable unless renderable_at_all?
+    return :custom_primary_key unless foreign_key_is_related_id?
+    return :polymorphic_child if polymorphic_child?
+    return :scope_block if self.class.scope_proc
+    return :params_block if self.class.params_proc
+    return :base_scope if @base_scope
+    return :remote if remote?
+    return :polymorphic_resource if resource.class.polymorphic.present?
 
-    true
+    nil
   end
 
-  # The foreign key can stand in for the related id only when the two hold the
-  # same value. base_filter matches the key against primary_key, so pointing
-  # that at another column means the key holds that column instead.
+  # base_filter matches the foreign key against primary_key, so a custom
+  # primary_key means the key holds that column's value, not the related id.
   def foreign_key_is_related_id?
     primary_key == :id
   end

data/lib/graphiti/sideload.rb

@@ -20,6 +20,7 @@ module Graphiti
     def initialize(name, opts)
       @name = name
       validate_options!(opts)
+      translate_deprecated_options!(opts)
       @parent_resource_class = opts[:parent_resource]
       @resource_class_name = opts[:resource]
       @primary_key = opts[:primary_key]
@@ -42,7 +43,7 @@ module Graphiti
       @group_name = opts[:group_name]
       @polymorphic_child = opts[:polymorphic_child]
       @parent = opts[:parent]
-      @always_include_resource_ids = opts[:always_include_resource_ids]
+      @render_resource_ids = opts[:resource_ids]
 
       if polymorphic_child?
         parent.resource.polymorphic << resource_class
@@ -110,6 +111,31 @@ module Graphiti
       dynamic_flag?(@readable) || dynamic_flag?(@writable)
     end
 
+    def readable_guarded?
+      dynamic_flag?(@readable)
+    end
+
+    def readable_guard_name
+      @readable.to_sym if @readable.is_a?(Symbol) || @readable.is_a?(String)
+    end
+
+    def non_default_options
+      options = {}
+      options[:as] = association_name if @as
+      options[:primary_key] = primary_key unless primary_key == :id
+      options[:single] = true if single?
+      options[:remote] = @remote if remote?
+      options[:link] = @link unless @link.nil?
+      options[:readable] = @readable unless @readable.nil? || @readable == true
+      options[:writable] = @writable unless @writable.nil? || @writable == true
+      options[:resource_ids] = @render_resource_ids unless @render_resource_ids.nil?
+      options
+    end
+
+    def customized_base_scope?
+      !!@base_scope
+    end
+
     def single?
       !!@single
     end
@@ -122,24 +148,21 @@ module Graphiti
       !!@polymorphic_as
     end
 
-    # False everywhere but a plain belongs_to - see
-    # Sideload::BelongsTo#linkage_from_foreign_key?.
-    def linkage_from_foreign_key?
-      false
+    def resource_ids_from_foreign_key?
+      resource_ids_blocker.nil?
     end
 
-    # nil at either of the first two levels means "not specified" rather
-    # than "false".
-    def always_include_resource_ids?
-      return !!@always_include_resource_ids unless @always_include_resource_ids.nil?
+    def resource_ids_blocker
+      :no_foreign_key_on_parent
+    end
 
-      configured = parent_resource_class&.always_include_resource_ids_by_default
-      return !!configured unless configured.nil?
+    def render_resource_ids?
+      return !!@render_resource_ids unless @render_resource_ids.nil?
 
-      default_include_resource_ids?
+      default_render_resource_ids?
     end
 
-    def default_include_resource_ids?
+    def default_render_resource_ids?
       false
     end
 
@@ -434,6 +457,18 @@ module Graphiti
       false
     end
 
+    def translate_deprecated_options!(opts)
+      return unless opts.key?(:always_include_resource_ids)
+
+      Graphiti::DEPRECATOR.deprecation_warning(
+        :always_include_resource_ids,
+        "Use :resource_ids instead (#{opts[:parent_resource]&.name}##{@name})"
+      )
+
+      value = opts.delete(:always_include_resource_ids)
+      opts[:resource_ids] = value unless opts.key?(:resource_ids)
+    end
+
     def validate_options!(opts)
       if opts[:remote]
         if opts[:resource]

data/lib/graphiti/spec_helpers.rb

@@ -26,6 +26,11 @@ module Graphiti
     end
 
     module Sugar
+      def self.included(base)
+        Graphiti::DEPRECATOR.warn("Graphiti::SpecHelpers::Sugar is deprecated. Call jsonapi_data, jsonapi_included, jsonapi_errors, json_date and json_datetime directly.")
+        super
+      end
+
       def d
         jsonapi_data
       end

data/lib/graphiti/util/serializer_relationships.rb

@@ -68,9 +68,9 @@ module Graphiti
           # sideload can resolve it to something the foreign key alone would
           # not predict, so the loaded records win. Only the un-included case
           # is worth short-circuiting.
-          if sideload_ref.linkage_from_foreign_key? &&
+          if sideload_ref.resource_ids_from_foreign_key? &&
               !self_ref.send(:included_anywhere?, @proxy.query.include_hash, sideload_ref.name)
-            linkage always: sideload_ref.always_include_resource_ids? do
+            linkage always: sideload_ref.render_resource_ids? do
               foreign_key = @object.public_send(sideload_ref.foreign_key)
 
               unless foreign_key.nil?
@@ -81,7 +81,7 @@ module Graphiti
               end
             end
           else
-            linkage always: sideload_ref.always_include_resource_ids?
+            linkage always: sideload_ref.render_resource_ids?
           end
 
           if link_ref
@@ -107,8 +107,31 @@ module Graphiti
 
       def data_proc
         sideload_ref = @sideload
+        resource_class_ref = @resource_class
         ->(_) {
-          if (records = @object.public_send(sideload_ref.association_name))
+          begin
+            records = @object.public_send(sideload_ref.association_name)
+          rescue NoMethodError => error
+            # #receiver raises ArgumentError when the error was built by hand
+            # rather than raised by a failed call, and a hand-built one can
+            # still carry a matching #name.
+            receiver = begin
+              error.receiver
+            rescue ArgumentError
+              nil
+            end
+
+            raise unless error.name == sideload_ref.association_name &&
+              receiver.equal?(@object)
+
+            # A private method exists, so "has no such method" would be a lie.
+            raise if @object.respond_to?(sideload_ref.association_name, true)
+
+            raise Errors::MissingRelationshipMethod
+              .new(resource_class_ref, sideload_ref, @object)
+          end
+
+          if records
             if records.respond_to?(:to_ary)
               records.each { |r| sideload_ref.resource.decorate_record(r) }
             else

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "2.0.0.beta.5"
+  VERSION = "2.0.0.beta.7"
 end

data/lib/graphiti.rb

@@ -166,6 +166,8 @@ require "graphiti/configuration"
 require "graphiti/context"
 require "graphiti/errors"
 require "graphiti/types"
+require "graphiti/audit"
+require "graphiti/audit/report"
 require "graphiti/schema"
 require "graphiti/schema_diff"
 require "graphiti/adapters/abstract"

data/lib/tasks/graphiti.rake

@@ -16,6 +16,15 @@ namespace :graphiti do
     Graphiti::Debugger.flush if debug
   end
 
+  desc "Audit every relationship: what will raise, what loads to render ids, which render no ids, and which checks passed."
+  task audit: [:environment] do
+    helpers.setup_rails!
+    rows = Graphiti::Audit.run
+    puts Graphiti::Audit::Report.new(rows).to_s
+
+    exit 1 if rows.any?(&:error?)
+  end
+
   desc "Execute benchmark without web server."
   task :benchmark, [:path, :requests] => [:environment] do |_, args|
     helpers.setup_rails!

data/package.json

@@ -22,6 +22,7 @@
   },
   "release": {
     "branches": [
+      "1.x",
       "main",
       {
         "name": "beta",

data/website/sidebars.js

@@ -21,18 +21,18 @@ module.exports = {
       type: 'category',
       label: 'Topics',
       items: [
-        'topics/authorization',
-        'topics/error-handling',
         'topics/testing',
+        'topics/error-handling',
+        'topics/authorization',
         'topics/debugging',
         'topics/caching',
         'topics/etags',
         'topics/json-attributes',
-        'topics/remote-resources',
+        'topics/customizing-sideloads',
         'concepts/backends-and-models',
         'topics/without-activerecord',
         'topics/openstruct-models',
-        'topics/customizing-sideloads',
+        'topics/remote-resources',
         'topics/hopping-relationships',
       ],
     },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.5
+  version: 2.0.0.beta.7
 platform: ruby
 authors:
 - Lee Richmond
@@ -335,6 +335,8 @@ files:
 - lib/graphiti/adapters/graphiti_api.rb
 - lib/graphiti/adapters/null.rb
 - lib/graphiti/adapters/persistence/associations.rb
+- lib/graphiti/audit.rb
+- lib/graphiti/audit/report.rb
 - lib/graphiti/cli.rb
 - lib/graphiti/configuration.rb
 - lib/graphiti/context.rb