graphiti 1.2.16 → 1.2.21

data/lib/graphiti/adapters/active_record/many_to_many_sideload.rb

@@ -36,7 +36,8 @@ class Graphiti::Adapters::ActiveRecord::ManyToManySideload < Graphiti::Sideload:
 
   def filter_for(scope, value, type = nil)
     scope
-      .includes(through_relationship_name)
+      .preload(through_relationship_name)
+      .joins(through_relationship_name)
       .where(belongs_to_many_clause(value, type))
   end
 

data/lib/graphiti/configuration.rb

@@ -43,7 +43,7 @@ module Graphiti
         end
 
         if (logger = ::Rails.logger)
-          self.debug = logger.level.zero? && self.debug
+          self.debug = logger.level.zero? && debug
           Graphiti.logger = logger
         end
       end

data/lib/graphiti/debugger.rb

@@ -10,6 +10,8 @@ module Graphiti
 
     class << self
       def on_data(name, start, stop, id, payload)
+        return [] unless enabled
+
         took = ((stop - start) * 1000.0).round(2)
         params = scrub_params(payload[:params])
 
@@ -24,7 +26,7 @@ module Graphiti
         end
       end
 
-      def on_data_exception(payload, params)
+      private def on_data_exception(payload, params)
         unless payload[:exception_object].instance_variable_get(:@__graphiti_debug)
           add_chunk do |logs, json|
             logs << ["\n=== Graphiti Debug ERROR", :red, true]
@@ -49,20 +51,20 @@ module Graphiti
         end
       end
 
-      def results(raw_results)
+      private def results(raw_results)
         raw_results.map { |r| "[#{r.class.name}, #{r.id.inspect}]" }.join(", ")
       end
 
-      def on_sideload_data(payload, params, took)
+      private def on_sideload_data(payload, params, took)
         sideload = payload[:sideload]
         results = results(payload[:results])
         add_chunk(payload[:resource], payload[:parent]) do |logs, json|
           logs << [" \\_ #{sideload.name}", :yellow, true]
           json[:name] = sideload.name
-          if sideload.class.scope_proc
-            query = "#{payload[:resource].class.name}: Manual sideload via .scope"
+          query = if sideload.class.scope_proc
+            "#{payload[:resource].class.name}: Manual sideload via .scope"
           else
-            query = "#{payload[:resource].class.name}.all(#{params.inspect})"
+            "#{payload[:resource].class.name}.all(#{params.inspect})"
           end
           logs << ["    #{query}", :cyan, true]
           json[:query] = query
@@ -72,7 +74,7 @@ module Graphiti
         end
       end
 
-      def on_primary_data(payload, params, took)
+      private def on_primary_data(payload, params, took)
         results = results(payload[:results])
         add_chunk(payload[:resource], payload[:parent]) do |logs, json|
           logs << [""]
@@ -90,6 +92,8 @@ module Graphiti
       end
 
       def on_render(name, start, stop, id, payload)
+        return [] unless enabled
+
         add_chunk do |logs|
           took = ((stop - start) * 1000.0).round(2)
           logs << [""]
@@ -148,7 +152,7 @@ module Graphiti
           parent: parent,
           logs: logs,
           json: json,
-          children: [],
+          children: []
         }
       end
 

data/lib/graphiti/delegates/pagination.rb

@@ -15,22 +15,26 @@ module Graphiti
           links[:last] = pagination_link(last_page)
           links[:prev] = pagination_link(current_page - 1) unless current_page == 1
           links[:next] = pagination_link(current_page + 1) unless current_page == last_page
-        end.select {|k, v| !v.nil? }
+        end.select { |k, v| !v.nil? }
       end
 
       private
 
+      def pagination_params
+        @pagination_params ||= @proxy.query.params.reject { |key, _| [:action, :controller, :format].include?(key) }
+      end
+
       def pagination_link(page)
         return nil unless @proxy.resource.endpoint
 
         uri = URI(@proxy.resource.endpoint[:url].to_s)
 
         # Overwrite the pagination query params with the desired page
-        uri.query = @proxy.query.hash.merge({
+        uri.query = pagination_params.merge({
           page: {
             number: page,
-            size: page_size,
-          },
+            size: page_size
+          }
         }).to_query
         uri.to_s
       end

data/lib/graphiti/deserializer.rb

@@ -87,7 +87,7 @@ class Graphiti::Deserializer
       type: data[:type],
       temp_id: data[:'temp-id'],
       method: action,
-      payload_path: ["data"],
+      payload_path: ["data"]
     }
   end
 
@@ -185,10 +185,10 @@ class Graphiti::Deserializer
         jsonapi_type: datum[:type],
         temp_id: temp_id,
         method: method,
-        payload_path: ["included", included_idx],
+        payload_path: ["included", included_idx]
       },
       attributes: attributes,
-      relationships: relationships,
+      relationships: relationships
     }
   end
 

data/lib/graphiti/errors.rb

@@ -143,8 +143,13 @@ module Graphiti
       def message
         allow = @filter.values[0][:allow]
         deny = @filter.values[0][:deny]
+        value_string = if @value == "(empty)"
+          "empty value"
+        else
+          "value #{@value.inspect}"
+        end
         msg = <<-MSG
-          #{@resource.class.name}: tried to filter on #{@filter.keys[0].inspect}, but passed invalid value #{@value.inspect}.
+          #{@resource.class.name}: tried to filter on #{@filter.keys[0].inspect}, but passed invalid #{value_string}.
         MSG
         msg << "\nAllowlist: #{allow.inspect}" if allow
         msg << "\nDenylist: #{deny.inspect}" if deny
@@ -189,7 +194,7 @@ module Graphiti
 
           Make sure the endpoint "#{@sideload.resource.endpoint[:full_path]}" exists with action #{@action.inspect}, or customize the endpoint for #{@sideload.resource.class.name}.
 
-          If you do not wish to generate a link, pass link: false or set self.relationship_links_by_default = false.
+          If you do not wish to generate a link, pass link: false or set self.autolink = false.
         MSG
       end
     end
@@ -316,14 +321,14 @@ module Graphiti
             sortable: "sort on",
             filterable: "filter on",
             readable: "read",
-            writable: "write",
+            writable: "write"
           }[@flag]
         else
           {
             sortable: "add sort",
             filterable: "add filter",
             readable: "read",
-            writable: "write",
+            writable: "write"
           }[@flag]
         end
       end
@@ -722,6 +727,21 @@ module Graphiti
     end
 
     class RecordNotFound < Base
+      def initialize(resource = nil, id = nil, path = nil)
+        @resource = resource
+        @id = id
+        @path = path
+      end
+
+      def message
+        if !@resource.nil? && !@id.nil?
+          "The referenced resource '#{@resource}' with id '#{@id}' could not be found.".tap do |msg|
+            msg << " Referenced at '#{@path}'" unless @path.nil?
+          end
+        else
+          "Specified Record Not Found"
+        end
+      end
     end
 
     class RequiredFilter < Base

data/lib/graphiti/extensions/extra_attribute.rb

@@ -43,7 +43,7 @@ module Graphiti
         def extra_attribute(name, options = {}, &blk)
           allow_field = proc {
             if options[:if]
-              next false unless instance_eval(&options[:if])
+              next false unless instance_exec(&options[:if])
             end
 
             @extra_fields &&

data/lib/graphiti/query.rb

@@ -1,8 +1,8 @@
 module Graphiti
   class Query
-    attr_reader :resource, :association_name, :params
+    attr_reader :resource, :association_name, :params, :action
 
-    def initialize(resource, params, association_name = nil, nested_include = nil, parents = [])
+    def initialize(resource, params, association_name = nil, nested_include = nil, parents = [], action = nil)
       @resource = resource
       @association_name = association_name
       @params = params
@@ -11,6 +11,7 @@ module Graphiti
       @params = @params.deep_symbolize_keys
       @include_param = nested_include || @params[:include]
       @parents = parents
+      @action = parse_action(action)
     end
 
     def association?
@@ -44,16 +45,19 @@ module Graphiti
 
     def hash
       @hash ||= {}.tap do |h|
-        h[:filter] = filters unless filters.empty?
-        h[:sort] = sorts unless sorts.empty?
-        h[:page] = pagination unless pagination.empty?
-        unless association?
-          h[:fields] = fields unless fields.empty?
-          h[:extra_fields] = extra_fields unless extra_fields.empty?
+        h[:filter] = filters
+        h[:sort] = sorts
+        h[:page] = pagination
+        if association?
+          resource_type = @resource.class.type
+          h[:extra_fields] = {resource_type => extra_fields[resource_type]} if extra_fields.key?(resource_type)
+        else
+          h[:fields] = fields
+          h[:extra_fields] = extra_fields
         end
-        h[:stats] = stats unless stats.empty?
-        h[:include] = sideload_hash unless sideload_hash.empty?
-      end
+        h[:stats] = stats
+        h[:include] = sideload_hash
+      end.reject { |_, value| value.empty? }
     end
 
     def zero_results?
@@ -92,7 +96,7 @@ module Graphiti
               sl_resource = resource_for_sideload(sideload)
               query_parents = parents + [self]
               sub_hash = sub_hash[:include] if sub_hash.key?(:include)
-              hash[key] = Query.new(sl_resource, @params, key, sub_hash, query_parents)
+              hash[key] = Query.new(sl_resource, @params, key, sub_hash, query_parents, :all)
             else
               handle_missing_sideload(key)
             end
@@ -232,7 +236,7 @@ module Graphiti
       return true if @resource.remote?
 
       if (att = @resource.get_attr(name, flag, request: true))
-        return att
+        att
       else
         not_associated_name = !@resource.class.association_names.include?(name)
         not_associated_type = !@resource.class.association_types.include?(name)
@@ -262,8 +266,8 @@ module Graphiti
     def parse_fieldset(fieldset)
       {}.tap do |hash|
         fieldset.each_pair do |type, fields|
-          type       = type.to_sym
-          fields     = fields.split(",") unless fields.is_a?(Array)
+          type = type.to_sym
+          fields = fields.split(",") unless fields.is_a?(Array)
           hash[type] = fields.map(&:to_sym)
         end
       end
@@ -282,7 +286,7 @@ module Graphiti
 
     def sort_hash(attr)
       value = attr[0] == "-" ? :desc : :asc
-      key   = attr.sub("-", "").to_sym
+      key = attr.sub("-", "").to_sym
 
       {key => value}
     end
@@ -312,5 +316,17 @@ module Graphiti
         end
       end
     end
+
+    def parse_action(action)
+      action ||= @params.fetch(:action, Graphiti.context[:namespace]).try(:to_sym)
+      case action
+      when :index
+        :all
+      when :show
+        :find
+      else
+        action
+      end
+    end
   end
 end

data/lib/graphiti/railtie.rb

@@ -6,7 +6,7 @@ module Graphiti
     end
 
     generators do
-      Dir[File.expand_path("../../deprecated_generators/**/*.rb", __dir__)].each do |f|
+      Dir[File.expand_path("../../deprecated_generators/**/*.rb", __dir__)].sort.each do |f|
         require f
       end
     end

data/lib/graphiti/request_validator.rb

@@ -1,10 +1,10 @@
 module Graphiti
   class RequestValidator
     delegate :validate,
-             :validate!,
-             :errors,
-             :deserialized_payload,
-             to: :@validator
+      :validate!,
+      :errors,
+      :deserialized_payload,
+      to: :@validator
 
     def initialize(root_resource, raw_params)
       @validator = ValidatorFactory.create(root_resource, raw_params)

data/lib/graphiti/request_validators/update_validator.rb

@@ -5,7 +5,7 @@ module Graphiti
         if required_payload? && payload_matches_endpoint?
           super
         else
-          return false
+          false
         end
       end
 
@@ -36,7 +36,6 @@ module Graphiti
           attribute_mismatch([:data, :id])
         end
 
-
         meta_type = @raw_params.dig(:data, :type)
 
         # NOTE: calling #to_s and comparing 2 strings is slower than

data/lib/graphiti/request_validators/validator.rb

@@ -25,7 +25,7 @@ module Graphiti
 
       def validate!
         unless validate
-          raise @error_class || Graphiti::Errors::InvalidRequest, self.errors
+          raise @error_class || Graphiti::Errors::InvalidRequest, errors
         end
 
         true
@@ -47,7 +47,7 @@ module Graphiti
       def process_relationships(resource, relationships, payload_path)
         opts = {
           resource: resource,
-          relationships: relationships,
+          relationships: relationships
         }
 
         Graphiti::Util::RelationshipPayload.iterate(opts) do |x|

data/lib/graphiti/resource.rb

@@ -148,5 +148,15 @@ module Graphiti
       end
       response
     end
+
+    def links?
+      self.class.links.any?
+    end
+
+    def links(model)
+      self.class.links.each_with_object({}) do |(name, blk), memo|
+        memo[name] = instance_exec(model, &blk)
+      end
+    end
   end
 end

data/lib/graphiti/resource/configuration.rb

@@ -22,7 +22,7 @@ module Graphiti
         end
 
         def type=(val)
-          val = val && val.to_sym
+          val = val&.to_sym
           if (val = super)
             serializer.type(val)
           end
@@ -42,7 +42,7 @@ module Graphiti
             path: val,
             full_path: val,
             url: val,
-            actions: [:index, :show],
+            actions: [:index, :show]
           }
         end
 
@@ -82,7 +82,8 @@ module Graphiti
           :attributes_schema_by_default,
           :relationships_readable_by_default,
           :relationships_writable_by_default,
-          :filters_accept_nil_by_default
+          :filters_accept_nil_by_default,
+          :filters_deny_empty_by_default
 
         class << self
           prepend Overrides
@@ -104,6 +105,7 @@ module Graphiti
           default(klass, :relationships_readable_by_default, true)
           default(klass, :relationships_writable_by_default, true)
           default(klass, :filters_accept_nil_by_default, false)
+          default(klass, :filters_deny_empty_by_default, false)
 
           unless klass.config[:attributes][:id]
             klass.attribute :id, :integer_id
@@ -198,6 +200,7 @@ module Graphiti
               extra_attributes: {},
               sideloads: {},
               callbacks: {},
+              links: {}
             }
         end
 
@@ -236,6 +239,10 @@ module Graphiti
         def default_filters
           config[:default_filters]
         end
+
+        def links
+          config[:links]
+        end
       end
 
       def get_attr!(name, flag, options = {})

data/lib/graphiti/resource/dsl.rb

@@ -32,7 +32,8 @@ module Graphiti
               dependencies: opts[:dependent],
               required: required,
               operators: operators.to_hash,
-              allow_nil: opts.fetch(:allow_nil, filters_accept_nil_by_default)
+              allow_nil: opts.fetch(:allow_nil, filters_accept_nil_by_default),
+              deny_empty: opts.fetch(:deny_empty, filters_deny_empty_by_default)
             }
           elsif (type = args[0])
             attribute name, type, only: [:filterable], allow: opts[:allow]
@@ -55,7 +56,7 @@ module Graphiti
 
           if get_attr(name, :sortable, raise_error: :only_unsupported)
             config[:sorts][name] = {
-              proc: blk,
+              proc: blk
             }.merge(opts.slice(:only))
           elsif (type = args[0])
             attribute name, type, only: [:sortable]
@@ -78,7 +79,7 @@ module Graphiti
         def default_filter(name = nil, &blk)
           name ||= :__default
           config[:default_filters][name.to_sym] = {
-            filter: blk,
+            filter: blk
           }
         end
 
@@ -131,9 +132,10 @@ module Graphiti
             readable: true,
             writable: false,
             sortable: false,
-            filterable: false,
+            filterable: false
           }
           options = defaults.merge(options)
+          attribute_option(options, :readable)
           config[:extra_attributes][name] = options
           apply_extra_attributes_to_serializer
         end
@@ -146,6 +148,10 @@ module Graphiti
           end
         end
 
+        def link(name, &blk)
+          config[:links][name.to_sym] = blk
+        end
+
         def all_attributes
           attributes.merge(extra_attributes)
         end