jsonapi-resources 0.10.4 → 0.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0373c84cc7d1e7fa2da86da83b30db06192824ecd5261718d167ddcbd7d3c3d
-  data.tar.gz: 4f2667a8a42ed1a4c91100979e047a0fafedc0467d84bd13e487fc7cb8baf60d
+  metadata.gz: d30a2ea26f6bb9f907e0710a7e9d95a9682bfa64ab0fd7ae1e5b350c07f52924
+  data.tar.gz: fd883de5a6506f4aaad03fcf3ec61ec311c0e57f0cf33ea8c3d8b082c47b2671
 SHA512:
-  metadata.gz: 6d080b0c4fcd192780be59c59158149081d7873301e36870335df9e362cc025d58b471d5677c7ba53c0d1b90c299cd41dea8975239fbd0510cdf0a9eb6a39cfb
-  data.tar.gz: 726d7c41751b41f79e1dfa6c6e6f4cd85d35c2a4e713d6836f8e1e8e8b275c74c62053fb1e95b278e6821732e81159cacdd6424482a182bc577ff56c0af767df
+  metadata.gz: cc53b7071fb93b2f2f5c8ff2f02b43572a56d5da8a58835cff73953100db55c0ea9dbc2a1d26b7b06ae854d8e588276619d7631a4dc509e7c6332b9ced5c6245
+  data.tar.gz: d9f77c39f058f3978b20ccba5d2beea4744bbda9cb1b19933ed9a3a235a5265a9fecb945a2fd3646f0135cb97059896be3ac2fa19023a94fd555480ac8483f95

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
 
@@ -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)
@@ -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]
@@ -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

@@ -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
@@ -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)
@@ -299,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/paginator.rb

@@ -13,9 +13,16 @@ module JSONAPI
       # :nocov:
     end
 
+    def requires_record_count
+      # :nocov:
+      self.class.requires_record_count
+      # :nocov:
+    end
+
     class << self
       def requires_record_count
         # :nocov:
+        # @deprecated
         false
         # :nocov:
       end
@@ -36,10 +43,15 @@ class OffsetPaginator < JSONAPI::Paginator
     verify_pagination_params
   end
 
+  # @deprecated
   def self.requires_record_count
     true
   end
 
+  def requires_record_count
+    true
+  end
+
   def apply(relation, _order_options)
     relation.offset(@offset).limit(@limit)
   end
@@ -127,10 +139,15 @@ class PagedPaginator < JSONAPI::Paginator
     verify_pagination_params
   end
 
+  # @deprecated
   def self.requires_record_count
     true
   end
 
+  def requires_record_count
+    true
+  end
+
   def calculate_page_count(record_count)
     (record_count / @size.to_f).ceil
   end

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

@@ -65,13 +65,13 @@ module JSONAPI
       resource_set.populate!(serializer, context, find_options)
 
       page_options = result_options
-      if (JSONAPI.configuration.top_level_meta_include_record_count || (paginator && paginator.class.requires_record_count))
+      if (top_level_meta_include_record_count || (paginator && paginator.requires_record_count))
         page_options[:record_count] = resource_klass.count(verified_filters,
                                                            context: context,
                                                            include_directives: include_directives)
       end
 
-      if (JSONAPI.configuration.top_level_meta_include_page_count && paginator && page_options[:record_count])
+      if (top_level_meta_include_page_count && paginator && page_options[:record_count])
         page_options[:page_count] = paginator ? paginator.calculate_page_count(page_options[:record_count]) : 1
       end
 
@@ -197,9 +197,9 @@ module JSONAPI
       resource_set.populate!(serializer, context, find_options)
 
       opts = result_options
-      if ((JSONAPI.configuration.top_level_meta_include_record_count) ||
-          (paginator && paginator.class.requires_record_count) ||
-          (JSONAPI.configuration.top_level_meta_include_page_count))
+      if ((top_level_meta_include_record_count) ||
+          (paginator && paginator.requires_record_count) ||
+          (top_level_meta_include_page_count))
 
         opts[:record_count] = source_resource.class.count_related(
             source_resource.identity,
@@ -207,13 +207,13 @@ module JSONAPI
             find_options)
       end
 
-      if (JSONAPI.configuration.top_level_meta_include_page_count && opts[:record_count])
+      if (top_level_meta_include_page_count && opts[:record_count])
         opts[:page_count] = paginator.calculate_page_count(opts[:record_count])
       end
 
       opts[:pagination_params] = if paginator && JSONAPI.configuration.top_level_links_include_pagination
                                    page_options = {}
-                                   page_options[:record_count] = opts[:record_count] if paginator.class.requires_record_count
+                                   page_options[:record_count] = opts[:record_count] if paginator.requires_record_count
                                    paginator.links_page_params(page_options.merge(fetched_resources: resource_set))
                                  else
                                    {}
@@ -382,6 +382,14 @@ module JSONAPI
       JSONAPI::ResourceSet.new(resource_id_tree)
     end
 
+    def top_level_meta_include_record_count
+      JSONAPI.configuration.top_level_meta_include_record_count
+    end
+
+    def top_level_meta_include_page_count
+      JSONAPI.configuration.top_level_meta_include_page_count
+    end
+
     private
     def find_related_resource_id_tree(resource_klass, source_id, relationship_name, find_options, include_related)
       options = find_options.except(:include_directives)

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/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.10.4'
+    VERSION = '0.10.7'
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.10.7
 platform: ruby
 authors:
 - Dan Gebhardt
 - Larry Gebhardt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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: []