jsonapi-resources 0.10.2 → 0.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d101bf5764e1eb80096aeeed45eed01a532e183995908d9f66a2143cb78e24df
-  data.tar.gz: 38911d1428d934a71d06bfac0ad0661a2faa25af2b5de9ac695ec5b620b4c011
+  metadata.gz: '091836afd689ed975ab1ad2cee54a467a0771cb5ea5b0bfa2055e25531809f74'
+  data.tar.gz: 96d46c67f8c88fa3e6d298eac85dc3862bef6feacbe8eddde1515b80e7c8e5a8
 SHA512:
-  metadata.gz: 6ec8d28ba3b475796ba5947bec8f548c154acfbf73ae3af44c0c20516dd4b756a45d3cbd4797f0162bbdc288e0b055599ef5044f500babdcf19ced3509887021
-  data.tar.gz: 4698f7ddd9b9893e310c00fde96d8fef84d0e79ad3261ed574b08c7b60d1e415f5565eb8620752d11136e16df63675c7923006ea6344805a1fd102634bd27e2d
+  metadata.gz: f4dfc6fd61f4a7d27a291626b00c6e5c13cad32be0b73b66e239f254800d73557168470191923cd5bcf29869bfdb1e93a11c4a8b6e3eca25411b1ac8dbc4e24d
+  data.tar.gz: e6c699748872330b22ae151082595e48bed10665e9c61c3ba902f585747090e19ab9319776d189bc06fe9ca7797f00467fb08a3e863a4ce7e3b740fd85bc2fe8

data/lib/jsonapi/active_relation/join_manager.rb

@@ -147,9 +147,15 @@ module JSONAPI
             related_resource_klass = join_details[:related_resource_klass]
             join_type = relationship_details[:join_type]
 
+            join_options = {
+              relationship: relationship,
+              relationship_details: relationship_details,
+              related_resource_klass: related_resource_klass,
+            }
+
             if relationship == :root
               unless source_relationship
-                add_join_details('', {alias: resource_klass._table_name, join_type: :root})
+                add_join_details('', {alias: resource_klass._table_name, join_type: :root, join_options: join_options})
               end
               next
             end
@@ -163,7 +169,7 @@ module JSONAPI
                 options: options)
             }
 
-            details = {alias: self.class.alias_from_arel_node(join_node), join_type: join_type}
+            details = {alias: self.class.alias_from_arel_node(join_node), join_type: join_type, join_options: join_options}
 
             if relationship == source_relationship
               if relationship.polymorphic? && relationship.belongs_to?

data/lib/jsonapi/active_relation_resource.rb

@@ -114,11 +114,11 @@ module JSONAPI
         # This alias is going to be resolve down to the model's table name and will not actually be an alias
         resource_table_alias = resource_klass._table_name
 
-        pluck_fields = [Arel.sql("#{concat_table_field(resource_table_alias, resource_klass._primary_key)} AS #{resource_table_alias}_#{resource_klass._primary_key}")]
+        pluck_fields = [sql_field_with_alias(resource_table_alias, resource_klass._primary_key)]
 
         cache_field = attribute_to_model_field(:_cache_field) if options[:cache]
         if cache_field
-          pluck_fields << Arel.sql("#{concat_table_field(resource_table_alias, cache_field[:name])} AS #{resource_table_alias}_#{cache_field[:name]}")
+          pluck_fields << sql_field_with_alias(resource_table_alias, cache_field[:name])
         end
 
         linkage_fields = []
@@ -133,7 +133,7 @@ module JSONAPI
 
               linkage_table_alias = join_manager.join_details_by_polymorphic_relationship(linkage_relationship, resource_type)[:alias]
               primary_key = klass._primary_key
-              pluck_fields << Arel.sql("#{concat_table_field(linkage_table_alias, primary_key)} AS #{linkage_table_alias}_#{primary_key}")
+              pluck_fields << sql_field_with_alias(linkage_table_alias, primary_key)
             end
           else
             klass = linkage_relationship.resource_klass
@@ -141,7 +141,7 @@ module JSONAPI
 
             linkage_table_alias = join_manager.join_details_by_relationship(linkage_relationship)[:alias]
             primary_key = klass._primary_key
-            pluck_fields << Arel.sql("#{concat_table_field(linkage_table_alias, primary_key)} AS #{linkage_table_alias}_#{primary_key}")
+            pluck_fields << sql_field_with_alias(linkage_table_alias, primary_key)
           end
         end
 
@@ -150,7 +150,7 @@ module JSONAPI
         attributes.try(:each) do |attribute|
           model_field = resource_klass.attribute_to_model_field(attribute)
           model_fields[attribute] = model_field
-          pluck_fields << Arel.sql("#{concat_table_field(resource_table_alias, model_field[:name])} AS #{resource_table_alias}_#{model_field[:name]}")
+          pluck_fields << sql_field_with_alias(resource_table_alias, model_field[:name])
         end
 
         sort_fields = options.dig(:_relation_helper_options, :sort_fields)
@@ -324,6 +324,11 @@ module JSONAPI
             records = records.joins_left(relation_name)
           end
         end
+
+        if relationship.use_related_resource_records_for_joins
+          records = records.merge(self.records(options))
+        end
+
         records
       end
 
@@ -395,7 +400,7 @@ module JSONAPI
                                                        sort_criteria: sort_criteria,
                                                        filters: filters)
 
-        paginator = options[:paginator] if source_rids.count == 1
+        paginator = options[:paginator]
 
         records = apply_request_settings_to_records(records: records_for_source_to_related(options),
                                resource_klass: resource_klass,
@@ -409,13 +414,13 @@ module JSONAPI
         resource_table_alias = join_manager.join_details_by_relationship(relationship)[:alias]
 
         pluck_fields = [
-            Arel.sql("#{_table_name}.#{_primary_key} AS source_id"),
-            Arel.sql("#{concat_table_field(resource_table_alias, resource_klass._primary_key)} AS #{resource_table_alias}_#{resource_klass._primary_key}")
+          Arel.sql("#{_table_name}.#{_primary_key} AS \"source_id\""),
+          sql_field_with_alias(resource_table_alias, resource_klass._primary_key)
         ]
 
         cache_field = resource_klass.attribute_to_model_field(:_cache_field) if options[:cache]
         if cache_field
-          pluck_fields << Arel.sql("#{concat_table_field(resource_table_alias, cache_field[:name])} AS #{resource_table_alias}_#{cache_field[:name]}")
+          pluck_fields << sql_field_with_alias(resource_table_alias, cache_field[:name])
         end
 
         linkage_fields = []
@@ -430,7 +435,7 @@ module JSONAPI
 
               linkage_table_alias = join_manager.join_details_by_polymorphic_relationship(linkage_relationship, resource_type)[:alias]
               primary_key = klass._primary_key
-              pluck_fields << Arel.sql("#{concat_table_field(linkage_table_alias, primary_key)} AS #{linkage_table_alias}_#{primary_key}")
+              pluck_fields << sql_field_with_alias(linkage_table_alias, primary_key)
             end
           else
             klass = linkage_relationship.resource_klass
@@ -438,7 +443,7 @@ module JSONAPI
 
             linkage_table_alias = join_manager.join_details_by_relationship(linkage_relationship)[:alias]
             primary_key = klass._primary_key
-            pluck_fields << Arel.sql("#{concat_table_field(linkage_table_alias, primary_key)} AS #{linkage_table_alias}_#{primary_key}")
+            pluck_fields << sql_field_with_alias(linkage_table_alias, primary_key)
           end
         end
 
@@ -447,7 +452,7 @@ module JSONAPI
         attributes.try(:each) do |attribute|
           model_field = resource_klass.attribute_to_model_field(attribute)
           model_fields[attribute] = model_field
-          pluck_fields << Arel.sql("#{concat_table_field(resource_table_alias, model_field[:name])} AS #{resource_table_alias}_#{model_field[:name]}")
+          pluck_fields << sql_field_with_alias(resource_table_alias, model_field[:name])
         end
 
         sort_fields = options.dig(:_relation_helper_options, :sort_fields)
@@ -525,7 +530,7 @@ module JSONAPI
                                                        relationships: linkage_relationships,
                                                        filters: filters)
 
-        paginator = options[:paginator] if source_rids.count == 1
+        paginator = options[:paginator]
 
         # Note: We will sort by the source table. Without using unions we can't sort on a polymorphic relationship
         # in any manner that makes sense
@@ -543,9 +548,9 @@ module JSONAPI
         related_type = concat_table_field(_table_name, relationship.polymorphic_type)
 
         pluck_fields = [
-            Arel.sql("#{primary_key} AS #{_table_name}_#{_primary_key}"),
-            Arel.sql("#{related_key} AS #{_table_name}_#{relationship.foreign_key}"),
-            Arel.sql("#{related_type} AS #{_table_name}_#{relationship.polymorphic_type}")
+            Arel.sql("#{primary_key} AS #{alias_table_field(_table_name, _primary_key)}"),
+            Arel.sql("#{related_key} AS #{alias_table_field(_table_name, relationship.foreign_key)}"),
+            Arel.sql("#{related_type} AS #{alias_table_field(_table_name, relationship.polymorphic_type)}")
         ]
 
         # Get the additional fields from each relation. There's a limitation that the fields must exist in each relation
@@ -570,7 +575,7 @@ module JSONAPI
 
             cache_offset = relation_index
             if cache_field
-              pluck_fields << Arel.sql("#{concat_table_field(table_alias, cache_field[:name])} AS cache_#{type}_#{cache_field[:name]}")
+              pluck_fields << sql_field_with_alias(table_alias, cache_field[:name])
               relation_index+= 1
             end
 
@@ -579,7 +584,7 @@ module JSONAPI
             attributes.try(:each) do |attribute|
               model_field = related_klass.attribute_to_model_field(attribute)
               model_fields[attribute] = model_field
-              pluck_fields << Arel.sql("#{concat_table_field(table_alias, model_field[:name])} AS #{table_alias}_#{model_field[:name]}")
+              pluck_fields << sql_field_with_alias(table_alias, model_field[:name])
               relation_index+= 1
             end
 
@@ -616,7 +621,7 @@ module JSONAPI
 
               linkage_table_alias = join_manager.join_details_by_polymorphic_relationship(linkage_relationship, resource_type)[:alias]
               primary_key = klass._primary_key
-              pluck_fields << Arel.sql("#{concat_table_field(linkage_table_alias, primary_key)} AS #{linkage_table_alias}_#{primary_key}")
+              pluck_fields << sql_field_with_alias(linkage_table_alias, primary_key)
             end
           else
             klass = linkage_relationship.resource_klass
@@ -624,7 +629,7 @@ module JSONAPI
 
             linkage_table_alias = join_manager.join_details_by_relationship(linkage_relationship)[:alias]
             primary_key = klass._primary_key
-            pluck_fields << Arel.sql("#{concat_table_field(linkage_table_alias, primary_key)} AS #{linkage_table_alias}_#{primary_key}")
+            pluck_fields << sql_field_with_alias(linkage_table_alias, primary_key)
           end
         end
 
@@ -649,7 +654,7 @@ module JSONAPI
               end
             end
 
-            relation_position = relation_positions[row[2].downcase.pluralize]
+            relation_position = relation_positions[row[2].underscore.pluralize]
             model_fields = relation_position[:model_fields]
             cache_field = relation_position[:cache_field]
             cache_offset = relation_position[:cache_offset]
@@ -756,7 +761,7 @@ module JSONAPI
 
       # Assumes ActiveRecord's counting. Override if you need a different counting method
       def count_records(records)
-        if Rails::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1
+        if (Rails::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR >= 6
           records.count(:all)
         else
           records.count
@@ -790,7 +795,31 @@ module JSONAPI
         if table.blank? || field.to_s.include?('.')
           # :nocov:
           if quoted
-            "\"#{field.to_s}\""
+            quote(field)
+          else
+            field.to_s
+          end
+          # :nocov:
+        else
+          if quoted
+            "#{quote(table)}.#{quote(field)}"
+          else
+            # :nocov:
+            "#{table.to_s}.#{field.to_s}"
+            # :nocov:
+          end
+        end
+      end
+
+      def sql_field_with_alias(table, field, quoted = true)
+        Arel.sql("#{concat_table_field(table, field, quoted)} AS #{alias_table_field(table, field, quoted)}")
+      end
+
+      def alias_table_field(table, field, quoted = false)
+        if table.blank? || field.to_s.include?('.')
+          # :nocov:
+          if quoted
+            quote(field)
           else
             field.to_s
           end
@@ -798,14 +827,19 @@ module JSONAPI
         else
           if quoted
             # :nocov:
-            "\"#{table.to_s}\".\"#{field.to_s}\""
+            quote("#{table.to_s}_#{field.to_s}")
             # :nocov:
           else
-            "#{table.to_s}.#{field.to_s}"
+            "#{table.to_s}_#{field.to_s}"
           end
         end
       end
 
+      def quote(field)
+        "\"#{field.to_s}\""
+      end
+
+
       def apply_filters(records, filters, options = {})
         if filters
           filters.each do |filter, value|

data/lib/jsonapi/basic_resource.rb

@@ -873,7 +873,7 @@ module JSONAPI
         if !_polymorphic
           ''
         else
-          @_polymorphic_name ||= _model_name.to_s.downcase
+          @_polymorphic_name ||= _model_name.to_s.underscore
         end
       end
 
@@ -927,7 +927,7 @@ module JSONAPI
             next unless Module === klass
             if klass < ActiveRecord::Base
               klass.reflect_on_all_associations(:has_many).select{|r| r.options[:as] }.each do |reflection|
-                (hash[reflection.options[:as]] ||= []) << klass.name.downcase
+                (hash[reflection.options[:as]] ||= []) << klass.name.underscore
               end
             end
           end
@@ -1058,7 +1058,7 @@ module JSONAPI
       end
 
       def construct_order_options(sort_params)
-        sort_params ||= default_sort
+        sort_params = default_sort if sort_params.blank?
 
         return {} unless sort_params
 

data/lib/jsonapi/cached_response_fragment.rb

@@ -51,8 +51,8 @@ module JSONAPI
       @fetchable_fields = Set.new(fetchable_fields)
 
       # Relationships left uncompiled because we'll often want to insert included ids on retrieval
-      @relationships = relationships
-
+      # Remove the data since that should not be cached
+      @relationships = relationships&.transform_values {|v| v.delete_if {|k, _v| k == 'data'} }
       @links_json = CompiledJson.of(links_json)
       @attributes_json = CompiledJson.of(attributes_json)
       @meta_json = CompiledJson.of(meta_json)

data/lib/jsonapi/configuration.rb

@@ -18,7 +18,7 @@ module JSONAPI
                 :default_paginator,
                 :default_page_size,
                 :maximum_page_size,
-                :default_processor_klass,
+                :default_processor_klass_name,
                 :use_text_errors,
                 :top_level_links_include_pagination,
                 :top_level_meta_include_record_count,
@@ -39,7 +39,8 @@ module JSONAPI
                 :default_resource_cache_field,
                 :resource_cache_digest_function,
                 :resource_cache_usage_report_function,
-                :default_exclude_links
+                :default_exclude_links,
+                :use_related_resource_records_for_joins
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -110,7 +111,7 @@ module JSONAPI
 
       # The default Operation Processor to use if one is not defined specifically
       # for a Resource.
-      self.default_processor_klass = JSONAPI::Processor
+      self.default_processor_klass_name = 'JSONAPI::Processor'
 
       # Allows transactions for creating and updating records
       # Set this to false if your backend does not support transactions (e.g. Mongodb)
@@ -158,6 +159,11 @@ module JSONAPI
       # and relationships. Accepts either `:default`, `:none`, or array containing the
       # specific default links to exclude, which may be `:self` and `:related`.
       self.default_exclude_links = :none
+
+      # Use a related resource's `records` when performing joins. This setting allows included resources to account for
+      # permission scopes. It can be overridden explicitly per relationship. Furthermore, specifying a `relation_name`
+      # on a relationship will cause this setting to be ignored.
+      self.use_related_resource_records_for_joins = true
     end
 
     def cache_formatters=(bool)
@@ -225,9 +231,19 @@ module JSONAPI
     end
 
     def default_processor_klass=(default_processor_klass)
+      ActiveSupport::Deprecation.warn('`default_processor_klass` has been replaced by `default_processor_klass_name`.')
       @default_processor_klass = default_processor_klass
     end
 
+    def default_processor_klass
+      @default_processor_klass ||= default_processor_klass_name.safe_constantize
+    end
+
+    def default_processor_klass_name=(default_processor_klass_name)
+      @default_processor_klass = nil
+      @default_processor_klass_name = default_processor_klass_name
+    end
+
     def allow_include=(allow_include)
       ActiveSupport::Deprecation.warn('`allow_include` has been replaced by `default_allow_include_to_one` and `default_allow_include_to_many` options.')
       @default_allow_include_to_one = allow_include
@@ -289,6 +305,8 @@ module JSONAPI
     attr_writer :resource_cache_usage_report_function
 
     attr_writer :default_exclude_links
+
+    attr_writer :use_related_resource_records_for_joins
   end
 
   class << self

data/lib/jsonapi/path_segment.rb

@@ -30,7 +30,7 @@ module JSONAPI
       end
 
       def eql?(other)
-        relationship == other.relationship && resource_klass == other.resource_klass
+        other.is_a?(JSONAPI::PathSegment::Relationship) && relationship == other.relationship && resource_klass == other.resource_klass
       end
 
       def hash
@@ -59,7 +59,7 @@ module JSONAPI
       end
 
       def eql?(other)
-        field_name == other.field_name && resource_klass == other.resource_klass
+        other.is_a?(JSONAPI::PathSegment::Field) && field_name == other.field_name && resource_klass == other.resource_klass
       end
 
       def delegated_field_name

data/lib/jsonapi/processor.rb

@@ -392,7 +392,7 @@ module JSONAPI
       primary_resource_id_tree = PrimaryResourceIdTree.new
       primary_resource_id_tree.add_resource_fragments(fragments, include_related)
 
-      load_included(resource_klass, primary_resource_id_tree, include_related, options.except(:filters, :sort_criteria))
+      load_included(resource_klass, primary_resource_id_tree, include_related, options)
 
       primary_resource_id_tree
     end
@@ -406,7 +406,7 @@ module JSONAPI
       primary_resource_id_tree = PrimaryResourceIdTree.new
       primary_resource_id_tree.add_resource_fragments(fragments, include_related)
 
-      load_included(resource_klass, primary_resource_id_tree, include_related, options.except(:filters, :sort_criteria))
+      load_included(resource_klass, primary_resource_id_tree, include_related, options)
 
       primary_resource_id_tree
     end
@@ -422,7 +422,7 @@ module JSONAPI
       primary_resource_id_tree = PrimaryResourceIdTree.new
       primary_resource_id_tree.add_resource_fragments(fragments, include_related)
 
-      load_included(resource_klass, primary_resource_id_tree, include_related, options.except(:filters, :sort_criteria))
+      load_included(resource_klass, primary_resource_id_tree, include_related, options)
 
       primary_resource_id_tree
     end
@@ -434,7 +434,7 @@ module JSONAPI
         relationship = resource_klass._relationship(key)
         relationship_name = relationship.name.to_sym
 
-        find_related_resource_options = options.dup
+        find_related_resource_options = options.except(:filters, :sort_criteria, :paginator)
         find_related_resource_options[:sort_criteria] = relationship.resource_klass.default_sort
         find_related_resource_options[:cache] = resource_klass.caching?
 

data/lib/jsonapi/relationship.rb

@@ -3,7 +3,7 @@ module JSONAPI
     attr_reader :acts_as_set, :foreign_key, :options, :name,
                 :class_name, :polymorphic, :always_include_optional_linkage_data,
                 :parent_resource, :eager_load_on_include, :custom_methods,
-                :inverse_relationship, :allow_include
+                :inverse_relationship, :allow_include, :use_related_resource_records_for_joins
 
     attr_writer :allow_include
 
@@ -23,6 +23,15 @@ module JSONAPI
         @polymorphic_types ||= options[:polymorphic_relations]
       end
 
+      use_related_resource_records_for_joins_default = if options[:relation_name]
+                                                         false
+                                                       else
+                                                         JSONAPI.configuration.use_related_resource_records_for_joins
+                                                       end
+      
+      @use_related_resource_records_for_joins = options.fetch(:use_related_resource_records_for_joins,
+                                                              use_related_resource_records_for_joins_default) == true
+
       @always_include_optional_linkage_data = options.fetch(:always_include_optional_linkage_data, false) == true
       @eager_load_on_include = options.fetch(:eager_load_on_include, false) == true
       @allow_include = options[:allow_include]
@@ -63,7 +72,7 @@ module JSONAPI
           next unless Module === klass
           if ActiveRecord::Base > klass
             klass.reflect_on_all_associations(:has_many).select{|r| r.options[:as] }.each do |reflection|
-              (hash[reflection.options[:as]] ||= []) << klass.name.downcase
+              (hash[reflection.options[:as]] ||= []) << klass.name.underscore
             end
           end
         end

data/lib/jsonapi/request_parser.rb

@@ -418,7 +418,7 @@ module JSONAPI
         sorts = sort_criteria
       elsif sort_criteria.is_a?(String)
         begin
-          raw = URI.unescape(sort_criteria)
+          raw = URI.decode_www_form_component(sort_criteria)
           sorts = CSV.parse_line(raw)
         rescue CSV::MalformedCSVError
           fail JSONAPI::Exceptions::InvalidSortCriteria.new(format_key(resource_klass._type), raw)

data/lib/jsonapi/resource_controller_metal.rb

@@ -5,10 +5,10 @@ module JSONAPI
       ActionController::Rendering,
       ActionController::Renderers::All,
       ActionController::StrongParameters,
-      ActionController::ForceSSL,
+      Gem::Requirement.new('< 6.1').satisfied_by?(ActionPack.gem_version) ? ActionController::ForceSSL : nil,
       ActionController::Instrumentation,
       JSONAPI::ActsAsResourceController
-    ].freeze
+    ].compact.freeze
 
     # Note, the url_helpers are not loaded. This will prevent links from being generated for resources, and warnings
     # will be emitted. Link support can be added by including `Rails.application.routes.url_helpers`, and links

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.10.2'
+    VERSION = '0.10.6'
   end
 end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.6
 platform: ruby
 authors:
 - Dan Gebhardt
 - Larry Gebhardt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -232,7 +232,7 @@ homepage: https://github.com/cerebris/jsonapi-resources
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Easily support JSON API in Rails.
 test_files: []