graphiti 2.0.0.beta.7 → 2.0.0.beta.9

data/lib/generators/graphiti/resource_generator.rb

@@ -8,7 +8,7 @@ module Graphiti
 
     argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
 
-    class_option :'omit-comments',
+    class_option :"omit-comments",
       type: :boolean,
       default: false,
       aliases: ["--omit-comments", "-c"],
@@ -26,7 +26,7 @@ module Graphiti
       aliases: ["--actions", "-a"],
       desc: 'Array of controller actions to support, e.g. "index show destroy"'
 
-    class_option :'attributes-from',
+    class_option :"attributes-from",
       banner: "Model",
       type: :string,
       aliases: ["--model", "-m"],
@@ -127,8 +127,11 @@ module Graphiti
       end
     end
 
+    # Generated controllers only use respond_with when it will actually work:
+    # the responders gem being installed is not enough, the controller chain
+    # must include Graphiti::Rails::Responders.
     def responders?
-      defined?(::Responders)
+      "ApplicationController".safe_constantize&.include?(Graphiti::Rails::Responders)
     end
 
     # Api::V1::Posts, Api::V1::PostsController and api/v1/posts all name the

data/lib/generators/graphiti/templates/application_resource.rb.erb

@@ -12,4 +12,23 @@ class ApplicationResource < Graphiti::Resource
   self.adapter = Graphiti::Adapters::ActiveRecord
   self.base_url = Rails.application.routes.default_url_options[:host]
   self.endpoint_namespace = '<%= api_namespace %>'
+  <%- unless omit_comments? -%>
+
+  # Defaults every Resource inherits. These are already the values shown;
+  # uncomment to change them API-wide, or set them on individual Resources.
+  # See https://graphiti.dev/concepts/resources
+  #
+  # self.attributes_readable_by_default     = true
+  # self.attributes_writable_by_default     = true
+  # self.attributes_sortable_by_default     = true
+  # self.attributes_filterable_by_default   = true
+  # self.attributes_schema_by_default       = true
+  # self.relationships_readable_by_default  = true
+  # self.relationships_writable_by_default  = true
+  # self.belongs_to_resource_ids_by_default = :foreign_key
+  # self.filters_accept_nil_by_default      = false
+  # self.filters_deny_empty_by_default      = false
+  # self.default_page_size                  = 20
+  # self.max_page_size                      = 1_000
+  <%- end -%>
 end

data/lib/generators/graphiti/templates/controller.rb.erb

@@ -1,25 +1,43 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %> < ApplicationController
   <%- if actions?('index') -%>
+  <%- if responders? -%>
   def index
     <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
-    <%- if responders? -%>
     respond_with(<%= file_name.pluralize %>)
-    <%- else -%>
-    render jsonapi: <%= file_name.pluralize %>
-    <%- end -%>
   end
+  <%- else -%>
+  <%- unless omit_comments? -%>
+  # With Graphiti::Rails::Responders included, these blocks collapse to
+  # respond_with(<%= file_name.pluralize %>). See https://graphiti.dev/getting-started/installation#responders
+  <%- end -%>
+  def index
+    <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
+
+    respond_to do |format|
+      format.jsonapi { render jsonapi: <%= file_name.pluralize %> }
+      format.json { render json: <%= file_name.pluralize %> }
+    end
+  end
+  <%- end -%>
   <%- end -%>
   <%- if actions?('show') -%>
 
+  <%- if responders? -%>
   def show
     <%= file_name %> = <%= resource_klass %>.find(params)
-    <%- if responders? -%>
     respond_with(<%= file_name %>)
-    <%- else -%>
-    render jsonapi: <%= file_name %>
-    <%- end -%>
   end
+  <%- else -%>
+  def show
+    <%= file_name %> = <%= resource_klass %>.find(params)
+
+    respond_to do |format|
+      format.jsonapi { render jsonapi: <%= file_name %> }
+      format.json { render json: <%= file_name %> }
+    end
+  end
+  <%- end -%>
   <%- end -%>
   <%- if actions?('create') -%>
 

data/lib/graphiti/audit/report.rb

@@ -60,7 +60,7 @@ module Graphiti
 
         section_heading(label, color, ISSUE_HEADINGS.fetch(check, check.to_s.tr("_", " "))) +
           lines_grouped_by_resource(group.map { |row, finding| [row, finding.message] }) +
-          (fixes.size == 1 ? [fix_line(fixes.first), ""] : [])
+          ((fixes.size == 1) ? [fix_line(fixes.first), ""] : [])
       end
 
       def loading_section
@@ -71,7 +71,7 @@ module Graphiti
           lines_grouped_by_resource(rows.map { |row| [row, nil] }) +
           ["  #{paint("That is a query per record rendered.", :dim)}",
             fix_line("preload the association in base_scope, or drop `resource_ids`"),
-            "  #{paint("See www.graphiti.dev/concepts/relationships#customizing-relationships", :dim)}",
+            "  #{paint("See graphiti.dev/concepts/relationships#customizing-relationships", :dim)}",
             ""]
       end
 
@@ -83,7 +83,7 @@ module Graphiti
         rows = @rows.select(&:would_start_loading?)
         return [] if rows.empty?
 
-        verb = rows.size == 1 ? "renders" : "render"
+        verb = (rows.size == 1) ? "renders" : "render"
 
         section_heading("FYI", :blue, "#{count(rows.size, "belongs_to relationship")} #{verb} no resource ids") +
           lines_grouped_by_resource(rows.map { |row| [row, nil] }) +
@@ -95,7 +95,7 @@ module Graphiti
           ["",
             "  #{paint("Either would load the association on every render. That potential performance cost is why ids are opt-in.", :dim)}",
             "  #{paint("Preloading the association in base_scope keeps that load cheap.", :dim)}",
-            "  #{paint("See www.graphiti.dev/concepts/relationships#belongs-to-resource-ids", :dim)}",
+            "  #{paint("See graphiti.dev/concepts/relationships#belongs-to-resource-ids", :dim)}",
             ""]
       end
 
@@ -189,7 +189,7 @@ module Graphiti
 
         rows.map do |cells|
           line = cells.each_with_index.map { |cell, index|
-            index == cells.size - 1 ? cell.painted : cell.pad_to(widths[index])
+            (index == cells.size - 1) ? cell.painted : cell.pad_to(widths[index])
           }.join("  ")
           indent + line
         end
@@ -203,7 +203,7 @@ module Graphiti
         counts = [
           count(@rows.group_by(&:resource).size, "resource"),
           count(@rows.size, "relationship"),
-          paint(count(errors, "error"), errors > 0 ? :red : nil)
+          paint(count(errors, "error"), (errors > 0) ? :red : nil)
         ]
         counts << paint("#{loading} loading ids without preloading", :yellow) if loading > 0
         counts << "#{no_ids} without resource ids" if no_ids > 0

data/lib/graphiti/audit.rb

@@ -1,7 +1,7 @@
 module Graphiti
   # Resources register themselves as they load, so eager load before auditing.
   class Audit
-    Finding = Struct.new(:severity, :check, :message, :remedy, keyword_init: true) do
+    Finding = Struct.new(:severity, :check, :message, :remedy) do
       def error?
         severity == :error
       end
@@ -18,8 +18,7 @@ module Graphiti
       :resource_ids_blocker,
       :preloaded,
       :options,
-      :findings,
-      keyword_init: true
+      :findings
     ) do
       def would_start_loading?
         return false if resource_ids_default == :never
@@ -75,7 +74,7 @@ module Graphiti
         resource_ids_source_if_always: resource_ids_source_if_always(resource_class, sideload),
         resource_ids_default: resource_class.belongs_to_resource_ids_by_default,
         resource_ids_blocker: sideload.resource_ids_blocker,
-        preloaded: source == :load ? association_preloaded?(resource_class, sideload) : nil,
+        preloaded: (source == :load) ? association_preloaded?(resource_class, sideload) : nil,
         options: declaration_options(sideload),
         findings: [
           missing_association_method(sideload, model),

data/lib/graphiti/configuration.rb

@@ -87,13 +87,20 @@ module Graphiti
     end
 
     def debug=(val)
-      @debug = val
-      Debugger.enabled = val
+      @debug = coerce_flag(val)
+      Debugger.enabled = @debug
     end
 
     def debug_models=(val)
-      @debug_models = val
-      Debugger.debug_models = val
+      @debug_models = coerce_flag(val)
+      Debugger.debug_models = @debug_models
+    end
+
+    # every value comes back from ENV as a string and "false" is truthy
+    def coerce_flag(val)
+      return false if ["false", "0", ""].include?(val.to_s.strip.downcase)
+
+      !!val
     end
 
     def with_option(key, value)

data/lib/graphiti/debugger.rb

@@ -4,11 +4,22 @@
 module Graphiti
   class Debugger
     class << self
-      attr_accessor :enabled, :chunks, :debug_models, :preserve, :pry
+      attr_accessor :enabled, :debug_models, :preserve, :pry
     end
-    self.chunks = []
+
+    CHUNKS = :__graphiti_debugger_chunks
+    private_constant :CHUNKS
 
     class << self
+      # Pool threads inherit this through the thread-local copy Scope#future_with_context makes, so their chunks reach the right request.
+      def chunks
+        Thread.current[CHUNKS] ||= Concurrent::Array.new
+      end
+
+      def chunks=(value)
+        Thread.current[CHUNKS] = value
+      end
+
       def on_data(name, start, stop, id, payload)
         return [] unless enabled
 
@@ -179,14 +190,15 @@ module Graphiti
       end
 
       def graph_statements
-        @chunks.each do |chunk|
+        statements = chunks
+        statements.each do |chunk|
           if (parent = chunk[:parent])
-            relevant = chunks.find { |c| c[:resource] == parent }
+            relevant = statements.find { |c| c[:resource] == parent }
             relevant[:children].unshift(chunk) if relevant
           end
         end
-        @chunks.reject! { |c| !!c[:parent] }
-        @chunks
+        statements.reject! { |c| !!c[:parent] }
+        statements
       end
 
       def chunk_to_hash(chunk)

data/lib/graphiti/delegates/pagination.rb

@@ -32,7 +32,7 @@ module Graphiti
       private
 
       def pagination_params
-        @pagination_params ||= @proxy.query.params.reject { |key, _| [:action, :controller, :format].include?(key) }
+        @pagination_params ||= @proxy.query.params.except(:action, :controller, :format)
       end
 
       def pagination_link(page)
@@ -109,7 +109,7 @@ module Graphiti
       end
 
       def page_param
-        @page_param ||= (@proxy.query.hash[:page] || {})
+        @page_param ||= @proxy.query.hash[:page] || {}
       end
     end
   end

data/lib/graphiti/deserializer.rb

@@ -85,7 +85,7 @@ class Graphiti::Deserializer
   def meta(action: :update)
     {
       type: data[:type],
-      temp_id: data[:'temp-id'],
+      temp_id: data[:"temp-id"],
       method: action,
       payload_path: ["data"]
     }
@@ -162,12 +162,12 @@ class Graphiti::Deserializer
   end
 
   def process_relationship_datum(datum)
-    temp_id = datum[:'temp-id']
+    temp_id = datum[:"temp-id"]
     included_object = included.find { |i|
       next unless i[:type] == datum[:type]
 
       (i[:id] && i[:id] == datum[:id]) ||
-        (i[:'temp-id'] && i[:'temp-id'] == temp_id)
+        (i[:"temp-id"] && i[:"temp-id"] == temp_id)
     }
     included_idx = included.index(included_object)
 

data/lib/graphiti/error_serializers/deprecated_constants.rb

@@ -23,6 +23,29 @@ module GraphitiErrors
     MSG
   end
 
+  # The old global rendering toggle, most often flipped in specs.
+  class << self
+    def enable!
+      Graphiti::DEPRECATOR.deprecation_warning("GraphitiErrors.enable!", "wrap the request in Graphiti::Rails::TestHelpers#handle_request_exceptions instead")
+      test_helpers.handle_request_exceptions(true)
+    end
+
+    def disable!
+      Graphiti::DEPRECATOR.deprecation_warning("GraphitiErrors.disable!", "wrap the request in Graphiti::Rails::TestHelpers#handle_request_exceptions instead")
+      test_helpers.handle_request_exceptions(false)
+    end
+
+    def disabled?
+      !test_helpers.handle_request_exceptions?
+    end
+
+    private
+
+    def test_helpers
+      @test_helpers ||= Object.new.extend(Graphiti::Rails::TestHelpers)
+    end
+  end
+
   module Validation; end
 
   module InvalidRequest; end

data/lib/graphiti/error_serializers/invalid_request.rb

@@ -36,6 +36,12 @@ module Graphiti
         end
       end
 
+      # graphiti_errors named the payload this. Remove in 3.0.
+      def rendered_errors
+        Graphiti::DEPRECATOR.deprecation_warning("#rendered_errors", "use #errors")
+        errors
+      end
+
       private
 
       def code

data/lib/graphiti/errors.rb

@@ -270,7 +270,7 @@ module Graphiti
           #{@resource_class.name}: error occurred while sideloading "#{@sideload_name}"!
 
           The error was raised while attempting to build query parameters for the associated Resource.
-          Read more about sideload scoping here: www.graphiti.dev/concepts/relationships#customizing-scope
+          Read more about sideload scoping here: graphiti.dev/concepts/relationships#customizing-scope
 
           A good way to debug is to put a debugger within the 'params' block.
 
@@ -294,7 +294,7 @@ module Graphiti
 
           The error was raised while attempting to build the scope for the associated Resource.
 
-          Read more about sideload scoping here: www.graphiti.dev/concepts/relationships#customizing-scope
+          Read more about sideload scoping here: graphiti.dev/concepts/relationships#customizing-scope
 
           Here's the original, underlying error:
 
@@ -315,7 +315,7 @@ module Graphiti
           #{@resource_class.name}: error occurred while sideloading "#{@sideload_name}"!
 
           The error was raised while attempting to assign relevant model instances. Read
-          more about sideload assignment here: www.graphiti.dev/concepts/relationships#customizing-assignment
+          more about sideload assignment here: graphiti.dev/concepts/relationships#customizing-assignment
 
           A good way to debug is to put a debugger within the 'assign' block.
 
@@ -449,7 +449,7 @@ module Graphiti
 
           self.validate_endpoints = false
 
-          See https://www.graphiti.dev/concepts/links for more information.
+          See https://graphiti.dev/concepts/links for more information.
 
           The current endpoints allowed for this resource are: #{@resource_class.endpoints.inspect}
         MSG
@@ -708,6 +708,22 @@ module Graphiti
       end
     end
 
+    class UnselectedForeignKey < Base
+      def initialize(resource_class, sideload, model)
+        @resource_class = resource_class
+        @sideload = sideload
+        @model = model
+      end
+
+      def message
+        <<~MSG
+          #{@resource_class.name}: rendering resource linkage for relationship #{@sideload.name.inspect} reads ##{@sideload.foreign_key} off #{@model.class.name}, but that attribute is not loaded.
+
+          Keep #{@sideload.foreign_key} in the selected columns, or turn linkage off with `resource_ids: false` on the relationship or `self.belongs_to_resource_ids_by_default = :never` on the resource.
+        MSG
+      end
+    end
+
     class MissingRelationshipMethod < Base
       def initialize(resource_class, sideload, model)
         @resource_class = resource_class
@@ -731,7 +747,7 @@ module Graphiti
 
         <<~MSG
 
-          resource_ids is set on this relationship, so every render reads the association, not just requests that include it. See www.graphiti.dev/concepts/relationships#customizing-relationships.
+          resource_ids is set on this relationship, so every render reads the association, not just requests that include it. See graphiti.dev/concepts/relationships#customizing-relationships.
         MSG
       end
     end
@@ -909,7 +925,7 @@ module Graphiti
       def initialize(resource, filter_names, required)
         @resource = resource
         @filter_names = filter_names
-        @required_label = required == :all ? "All" : "One"
+        @required_label = (required == :all) ? "All" : "One"
       end
 
       def message

data/lib/graphiti/extensions/temp_id.rb

@@ -14,7 +14,7 @@ module Graphiti
     def as_jsonapi(*)
       super.tap do |hash|
         if (temp_id = @object.instance_variable_get(:@_jsonapi_temp_id))
-          hash[:'temp-id'] = temp_id
+          hash[:"temp-id"] = temp_id
         end
       end
     end

data/lib/graphiti/query.rb

@@ -22,6 +22,7 @@ module Graphiti
       @include_param = nested_include || @params[:include]
       @parents = parents
       @action = parse_action(action)
+      @entity_map = Concurrent::Map.new if parents.empty?
     end
 
     def association?
@@ -32,7 +33,7 @@ module Graphiti
     def entity_map
       return root.entity_map unless root == self
 
-      @entity_map ||= Concurrent::Map.new
+      @entity_map
     end
 
     def top_level?
@@ -235,7 +236,7 @@ module Graphiti
 
         scrubbed.filter do |key, value|
           sideload = @resource.class.sideload(key)
-          sideload.nil? ? true : sideload.readable?
+          sideload.nil? || sideload.readable?
         end
       end
     end
@@ -311,7 +312,7 @@ module Graphiti
       return false unless association?
 
       split = name.to_s.split(".")
-      query_names = split[0..split.length - 2].map(&:to_sym)
+      query_names = split[0..-2].map(&:to_sym)
       my_names = parents.map(&:association_name).compact + [association_name].compact
       query_names == my_names
     end
@@ -343,7 +344,7 @@ module Graphiti
     end
 
     def sort_hash(attr)
-      value = attr[0] == "-" ? :desc : :asc
+      value = (attr[0] == "-") ? :desc : :asc
       key = attr.sub("-", "").to_sym
 
       {key => value}

data/lib/graphiti/rails/context.rb

@@ -1,11 +1,12 @@
 module Graphiti
   module Rails
-    # Wraps controller actions in a [Graphiti Context](https://www.graphiti.dev/concepts/resources#context) which points to the
+    # Wraps controller actions in a [Graphiti Context](https://graphiti.dev/concepts/resources#context) which points to the
     # controller instance by default.
     module Context
       def self.included(klass)
         klass.class_eval do
           include Graphiti::Context
+
           around_action :wrap_graphiti_context
         end
       end

data/lib/graphiti/rails/controller.rb

@@ -17,6 +17,9 @@ module Graphiti
       included do
         include Graphiti::Rails::Context
         include Graphiti::Rails::Debugging
+        # ActionController::API strips this out, but Graphiti serves multiple
+        # formats (jsonapi/json/xml), so respond_to has to work everywhere.
+        include ActionController::MimeResponds
 
         # Broad, but the handler only renders formats listed in
         # config.graphiti.handled_exception_formats and hands everything else

data/lib/graphiti/rails/debugging.rb

@@ -1,6 +1,6 @@
 module Graphiti
   module Rails
-    # Wraps controller actions in a [Graphiti Debugger](https://www.graphiti.dev/topics/debugging#debugger).
+    # Wraps controller actions in a [Graphiti Debugger](https://graphiti.dev/topics/debugging#debugger).
     module Debugging
       def self.included(klass)
         klass.around_action :debug_graphiti

data/lib/graphiti/rails/responders.rb

@@ -6,6 +6,7 @@ module Graphiti
 
       included do
         include ActionController::MimeResponds
+
         respond_to(*Graphiti::Rails.respond_to_formats)
       end
 
@@ -14,7 +15,7 @@ module Graphiti
         opts = args.extract_options!
         opts[:location] = nil
         args << opts
-        super(*args, &blk)
+        super
       end
     end
   end

data/lib/graphiti/rails.rb

@@ -31,6 +31,13 @@ module Graphiti
     autoload :Responders, "graphiti/rails/responders"
     autoload :TestHelpers, "graphiti/rails/test_helpers"
 
+    # Deprecated. Backed graphiti-rails' enable!/disable! spec toggles. Remove in 3.0.
+    GraphitiErrorsTesting = ActiveSupport::Deprecation::DeprecatedConstantProxy.new(
+      "Graphiti::Rails::GraphitiErrorsTesting",
+      "Graphiti::Rails::TestHelpers",
+      DEPRECATOR
+    )
+
     # @!attribute self.handled_exception_formats
     # A list of formats as symbols whose exceptions will be handled by Graphiti. See {Railtie}.
     cattr_accessor :handled_exception_formats, default: []
@@ -47,6 +54,13 @@ module Graphiti
     "Graphiti::Rails::Responders",
     DEPRECATOR
   )
+
+  # Deprecated. Core's railtie merged into graphiti-rails'. Remove in 3.0.
+  Railtie = ActiveSupport::Deprecation::DeprecatedConstantProxy.new(
+    "Graphiti::Railtie",
+    "Graphiti::Rails::Railtie",
+    DEPRECATOR
+  )
 end
 
 ActiveSupport.on_load(:active_record) do

data/lib/graphiti/railtie.rb

@@ -0,0 +1,8 @@
+# Deprecated require path, kept so a leftover 1.x require does not raise.
+# The railtie lives in Graphiti::Rails as of 2.0. Remove in 3.0.
+require "graphiti"
+
+Graphiti::DEPRECATOR.warn(
+  'require "graphiti/railtie" is no longer needed. The railtie is part of the Rails ' \
+  "integration as of 2.0, and loads with graphiti when Rails is present."
+)

data/lib/graphiti/resource/configuration.rb

@@ -60,6 +60,7 @@ module Graphiti
         def remote=(val)
           super
           include ::Graphiti::Resource::Remote
+
           self.endpoint = {
             path: val,
             full_path: val,

data/lib/graphiti/resource/dsl.rb

@@ -9,7 +9,7 @@ module Graphiti
           opts = args.extract_options!
           type_override = args[0]
 
-          if (att = (attributes[name] || extra_attributes[name]))
+          if (att = attributes[name] || extra_attributes[name])
             # We're opting in to filtering, so force this
             # UNLESS the filter is guarded at the attribute level
             att[:filterable] = true if att[:filterable] == false
@@ -27,7 +27,7 @@ module Graphiti
             end
 
             required = att[:filterable] == :required || !!opts[:required]
-            schema = !!opts[:via_attribute_dsl] ? att[:schema] : opts[:schema] != false
+            schema = (!!opts[:via_attribute_dsl]) ? att[:schema] : opts[:schema] != false
 
             config[:filters][name.to_sym] = {
               aliases: aliases,

data/lib/graphiti/resource/links.rb

@@ -41,7 +41,7 @@ module Graphiti
       def infer_endpoint
         return unless name
 
-        path = "/#{name.gsub("Resource", "").pluralize.underscore}".to_sym
+        path = :"/#{name.gsub("Resource", "").pluralize.underscore}"
         {
           path: path,
           full_path: full_path_for(path),

data/lib/graphiti/resource/persistence.rb

@@ -65,7 +65,7 @@ module Graphiti
         def add_callback(kind, lifecycle, method, only, &blk)
           config[:callbacks][kind] ||= {}
           config[:callbacks][kind][lifecycle] ||= []
-          config[:callbacks][kind][lifecycle] << {callback: (method || blk), only: Array(only)}
+          config[:callbacks][kind][lifecycle] << {callback: method || blk, only: Array(only)}
         end
       end
 

data/lib/graphiti/resource/polymorphism.rb

@@ -56,7 +56,7 @@ module Graphiti
             on_type, name = split_on[1].split("--").map(&:to_sym)
           end
 
-          sl = super(name)
+          sl = super
           if !polymorphic_child? && sl.nil?
             children.each do |c|
               next if on_type && c.type != on_type

data/lib/graphiti/resource.rb

@@ -137,14 +137,14 @@ module Graphiti
 
     # TODO: make foreign_key a keyword once the satellite gems are rolled in - they call these positionally
     def assign_with_relationships(meta, attributes, relationships, caller_model = nil, foreign_key = nil, model_instance: nil)
-      persistence = Graphiti::Util::Persistence \
+      persistence = Graphiti::Util::Persistence
         .new(self, meta, attributes, relationships, caller_model, foreign_key,
           assigned_model: model_instance)
       persistence.assign
     end
 
     def persist_with_relationships(meta, attributes, relationships, caller_model = nil, foreign_key = nil, assigned_model: nil)
-      persistence = Graphiti::Util::Persistence \
+      persistence = Graphiti::Util::Persistence
         .new(self, meta, attributes, relationships, caller_model, foreign_key,
           assigned_model: assigned_model)
       persistence.run

data/lib/graphiti/resource_proxy.rb

@@ -16,7 +16,6 @@ module Graphiti
       cache_expires_in: nil,
       cache_tag: nil
     )
-
       @resource = resource
       @scope = scope
       @query = query