Merge branch 'master' into sj/fix-multi-word-custom-endpoint

gaorlov · web-flow · commit f7a4cef644b6 · 2023-11-22T14:58:51.000-08:00
diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
@@ -18,7 +18,7 @@ permissions:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -44,12 +44,9 @@ jobs:
           - ruby: "2.7"
             rails: "4.2"
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,13 @@
 
 ## Unreleased
 
-## 1.22.0
+
 - [#400](https://github.com/JsonApiClient/json_api_client/pull/400) - Fix for multi-word custom endpoint and route format
 
+## 1.22.0
+- [#403](https://github.com/JsonApiClient/json_api_client/pull/403) - Feature: Use the association options to lookup relationship class
+- [#406](https://github.com/JsonApiClient/json_api_client/pull/406) - Deep-merge nested `additional_params`
+
 ## 1.21.1
 - [#404](https://github.com/JsonApiClient/json_api_client/pull/404) - Expose NotFound json errors
 - [#378](https://github.com/JsonApiClient/json_api_client/pull/378) - Add the ability to create a subclass of JsonApiClient::Resource to have a modified id method
diff --git a/lib/json_api_client/query/builder.rb b/lib/json_api_client/query/builder.rb
@@ -136,7 +136,7 @@ def _new_scope( opts = {} )
              primary_key:       opts.fetch( :primary_key, @primary_key ),
              pagination_params: @pagination_params.merge( opts.fetch( :pagination_params, {} ) ),
              path_params:       @path_params.merge( opts.fetch( :path_params, {} ) ),
-             additional_params: @additional_params.merge( opts.fetch( :additional_params, {} ) ),
+             additional_params: @additional_params.deep_merge( opts.fetch( :additional_params, {} ) ),
              filters:           @filters.merge( opts.fetch( :filters, {} ) ),
              includes:          @includes + opts.fetch( :includes, [] ),
              orders:            @orders + opts.fetch( :orders, [] ),
diff --git a/lib/json_api_client/utils.rb b/lib/json_api_client/utils.rb
@@ -7,6 +7,11 @@ def self.compute_type(klass, type_name)
       # the type_name is an absolute reference.
       return type_name.constantize if type_name.match(/^::/)
 
+      # Check the klass association definitions
+      association_klass_match = klass.associations.find { |a| a.attr_name.to_s.singularize == type_name.underscore }
+      association_klass = association_klass_match.options[:class] if association_klass_match
+      return association_klass if association_klass
+
       # Build a list of candidates to search for
       candidates = []
       klass.name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
diff --git a/lib/json_api_client/version.rb b/lib/json_api_client/version.rb
@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.21.1"
+  VERSION = "1.22.0"
 end
diff --git a/test/unit/association_test.rb b/test/unit/association_test.rb
@@ -89,8 +89,21 @@ class Employee < TestResource
   has_one :chief, klass: 'Employee'
 end
 
-class AssociationTest < MiniTest::Test
+module CrossNamespaceTwo
+  class Nail < TestResource
+    property :size
+  end
+end
+
+module CrossNamespaceOne
+  class Hammer < TestResource
+    property :brand
+
+    has_many :nails, class: CrossNamespaceTwo::Nail
+  end
+end
 
+class AssociationTest < Minitest::Test
   def test_default_properties_no_changes
     stub_request(:post, 'http://example.com/accounts').
         with(headers: { content_type: 'application/vnd.api+json', accept: 'application/vnd.api+json' }, body: {
@@ -1070,4 +1083,62 @@ def test_does_not_load_include_from_dataset
     assert_nil(records.first.chief)
   end
 
+  def test_cross_namespace_resource_references
+    stub_request(:get, 'http://example.com/hammers?include=nails')
+        .to_return(
+            headers: {
+                content_type: 'application/vnd.api+json'
+            }, body: {
+            data: [
+                {
+                  id: '1',
+                  type: 'hammers',
+                  attributes: {
+                      brand: 'Hardware Store'
+                  },
+                  relationships: {
+                    nails: { data: [{id: '2', type: 'nails'}] }
+                  }
+                },
+                {
+                  id: '2',
+                  type: 'hammers',
+                  attributes: {
+                      brand: 'Hardware Store'
+                  },
+                  relationships: {
+                    nails: { data: [{id: '3', type: 'nails'}] }
+                  }
+                }
+            ],
+            included: [
+                {
+                  id: '2',
+                  type: 'nails',
+                  attributes: {
+                      size: 10
+                  }
+                },
+                {
+                  id: '3',
+                  type: 'nails',
+                  attributes: {
+                      size: 8
+                  }
+              }
+            ]
+        }.to_json)
+    
+    records = CrossNamespaceOne::Hammer.includes(:nails).to_a
+
+    assert_equal(2, records.size)
+    assert_equal('1', records.first.id)
+    assert_equal('2', records.second.id)
+    assert_equal('2', records.first.nails.first.id)
+    assert_equal('3', records.second.nails.first.id)
+
+    assert_equal(1, records.first.nails.size)
+    assert_equal(1, records.second.nails.size)
+  end
+
 end
diff --git a/test/unit/benchmark_dynamic_attributes_test.rb b/test/unit/benchmark_dynamic_attributes_test.rb
@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'benchmark'
 
-class BenchmarkDynamicAttributesTest < MiniTest::Test
+class BenchmarkDynamicAttributesTest < Minitest::Test
   def test_can_parse_global_meta_data
     stub_request(:get, "http://example.com/articles/1")
       .to_return(headers: {content_type: "application/vnd.api+json"}, body: {
diff --git a/test/unit/coercion_test.rb b/test/unit/coercion_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CoercionTest < MiniTest::Test
+class CoercionTest < Minitest::Test
   TIME_STRING = '2015-04-28 10:45:35 -0700'
 
   class CoercionTypes < TestResource
diff --git a/test/unit/compound_document_test.rb b/test/unit/compound_document_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CompoundDocumentTest < MiniTest::Test
+class CompoundDocumentTest < Minitest::Test
 
   TEST_DATA = %{
     {
diff --git a/test/unit/compound_non_included_document_test.rb b/test/unit/compound_non_included_document_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CompoundNonIncludedDocumentTest < MiniTest::Test
+class CompoundNonIncludedDocumentTest < Minitest::Test
 
   TEST_DATA = %{
     {
diff --git a/test/unit/connection_test.rb b/test/unit/connection_test.rb
@@ -36,7 +36,7 @@ class CustomAdapterResource < TestResource
   }
 end
 
-class ConnectionTest < MiniTest::Test
+class ConnectionTest < Minitest::Test
 
   def test_basic
     assert_equal(NullConnection, CustomConnectionResource.connection_class)
diff --git a/test/unit/creation_test.rb b/test/unit/creation_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CreationTest < MiniTest::Test
+class CreationTest < Minitest::Test
 
   class CallbackTest < TestResource
     include JsonApiClient::Helpers::Callbacks
diff --git a/test/unit/custom_endpoint_test.rb b/test/unit/custom_endpoint_test.rb
@@ -25,7 +25,7 @@ class MythicBeasts < TestResource
 
 end
 
-class CustomEndpointTest < MiniTest::Test
+class CustomEndpointTest < Minitest::Test
 
   def test_collection_get
     stub_request(:get, "http://example.com/countries/autocomplete?starts_with=bel")
diff --git a/test/unit/custom_header_test.rb b/test/unit/custom_header_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CustomHeaderTest < MiniTest::Test
+class CustomHeaderTest < Minitest::Test
 
   class CustomHeaderResource < TestResource
   end
diff --git a/test/unit/custom_paginator_params_test.rb b/test/unit/custom_paginator_params_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CustomPaginatorTest < MiniTest::Test
+class CustomPaginatorTest < Minitest::Test
 
   class CustomPaginator < JsonApiClient::Paginating::Paginator
     self.page_param = 'pagina'
diff --git a/test/unit/custom_paginator_test.rb b/test/unit/custom_paginator_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CustomPaginatorTest < MiniTest::Test
+class CustomPaginatorTest < Minitest::Test
 
   class CustomPaginator < JsonApiClient::Paginating::Paginator
     def total_entries
diff --git a/test/unit/destroying_test.rb b/test/unit/destroying_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class DestroyingTest < MiniTest::Test
+class DestroyingTest < Minitest::Test
 
   class CallbackTest < TestResource
     include JsonApiClient::Helpers::Callbacks
diff --git a/test/unit/editing_test.rb b/test/unit/editing_test.rb
@@ -3,7 +3,7 @@
 class Author < TestResource
 end
 
-class EditingTest < MiniTest::Test
+class EditingTest < Minitest::Test
 
   def test_attribute_changed
     stub_request(:get, "http://example.com/authors/1")
diff --git a/test/unit/error_collector_test.rb b/test/unit/error_collector_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ErrorCollectorTest < MiniTest::Test
+class ErrorCollectorTest < Minitest::Test
 
   def test_can_handle_no_errors
     stub_request(:post, "http://example.com/articles")
diff --git a/test/unit/errors_test.rb b/test/unit/errors_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ErrorsTest < MiniTest::Test
+class ErrorsTest < Minitest::Test
 
   def test_connection_errors
     stub_request(:get, "http://example.com/users")
diff --git a/test/unit/finding_test.rb b/test/unit/finding_test.rb
@@ -1,7 +1,7 @@
 require 'test_helper'
 
 # This tests this Resource.find method
-class FindingTest < MiniTest::Test
+class FindingTest < Minitest::Test
 
   def test_find_by_id
     stub_request(:get, "http://example.com/articles/1")
diff --git a/test/unit/implementation_test.rb b/test/unit/implementation_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ImplementationTest < MiniTest::Test
+class ImplementationTest < Minitest::Test
 
   def test_defaults_on_missing_fields
     stub_request(:get, "http://example.com/articles")
diff --git a/test/unit/integer_id_test.rb b/test/unit/integer_id_test.rb
@@ -24,7 +24,7 @@ class Director < BaseResource
 
 NUMERIC_ASSERTION = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4') ? Fixnum : Integer
 
-class IntegerIdTestAssociationTest < MiniTest::Test
+class IntegerIdTestAssociationTest < Minitest::Test
 
   def test_included_document_test_id_from_method_as_integer
     stub_request(:get, 'http://example.com/movies/1?include=actor')
diff --git a/test/unit/meta_test.rb b/test/unit/meta_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class MetaTest < MiniTest::Test
+class MetaTest < Minitest::Test
 
   def test_can_parse_global_meta_data
     stub_request(:get, "http://example.com/articles/1")
diff --git a/test/unit/nested_param_paginator_test.rb b/test/unit/nested_param_paginator_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class NestedParamPaginatorTest < MiniTest::Test
+class NestedParamPaginatorTest < Minitest::Test
 
   class Book < JsonApiClient::Resource
     self.site = "http://example.com/"
diff --git a/test/unit/nested_param_paginator_top_level_links_test.rb b/test/unit/nested_param_paginator_top_level_links_test.rb
@@ -2,7 +2,7 @@
 
 # Copied from TopLevelLinksTest and modified to have consistent
 # pagination params using the new NestedParamPaginator
-class NestedParamPaginatorTopLevelLinksTest < MiniTest::Test
+class NestedParamPaginatorTopLevelLinksTest < Minitest::Test
 
   def setup
     @nested_param_paginator = JsonApiClient::Paginating::NestedParamPaginator
diff --git a/test/unit/parser_test.rb b/test/unit/parser_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ParserTest < MiniTest::Test
+class ParserTest < Minitest::Test
 
   def test_can_parse_single_record
     stub_request(:get, "http://example.com/articles/1")
diff --git a/test/unit/persistence_test.rb b/test/unit/persistence_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class PersistenceTest < MiniTest::Test
+class PersistenceTest < Minitest::Test
 
   def test_standard_primary_key
     user = User.new
diff --git a/test/unit/query_builder_test.rb b/test/unit/query_builder_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class QueryBuilderTest < MiniTest::Test
+class QueryBuilderTest < Minitest::Test
 
   def test_can_filter
     stub_request(:get, "http://example.com/articles")
@@ -122,6 +122,16 @@ def test_can_specify_additional_params
     Article.with_params(sort: "foo").to_a
   end
 
+  def test_can_merge_nested_additional_params
+    stub_request(:get, "http://example.com/articles")
+      .with(query: {top: {foos: 1, bars: 2}})
+      .to_return(headers: {content_type: "application/vnd.api+json"}, body: {
+        data: []
+      }.to_json)
+
+    Article.with_params(top: {foos: 1}).with_params(top: {bars: 2}).to_a
+  end
+
   def test_can_select_fields
     stub_request(:get, "http://example.com/articles")
       .with(query: {fields: {articles: 'title,body'}})
diff --git a/test/unit/resource_test.rb b/test/unit/resource_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ResourceTest < MiniTest::Test
+class ResourceTest < Minitest::Test
 
   def test_basic
     assert_equal :id, Article.primary_key
diff --git a/test/unit/schemable_test.rb b/test/unit/schemable_test.rb
@@ -27,7 +27,7 @@ class MultipleSchema < TestResource
   properties :name, :short_name, :long_name, type: :string
 end
 
-class SchemableTest < MiniTest::Test
+class SchemableTest < Minitest::Test
 
   def test_default_attributes
     resource = SchemaResource.new
diff --git a/test/unit/serializing_test.rb b/test/unit/serializing_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class SerializingTest < MiniTest::Test
+class SerializingTest < Minitest::Test
 
   class LimitedField < TestResource
     self.read_only_attributes += ['foo']
diff --git a/test/unit/server_side_error_test.rb b/test/unit/server_side_error_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ServerSideErrorTest < MiniTest::Test
+class ServerSideErrorTest < Minitest::Test
 
   def test_can_handle_validations
     stub_request(:post, "http://example.com/users")
diff --git a/test/unit/status_test.rb b/test/unit/status_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class StatusTest < MiniTest::Test
+class StatusTest < Minitest::Test
 
   def test_server_responding_with_status_meta
     stub_request(:get, "http://example.com/users/1")
diff --git a/test/unit/top_level_links_test.rb b/test/unit/top_level_links_test.rb
diff --git a/test/unit/updating_test.rb b/test/unit/updating_test.rb

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`require 'test_helper'`
`2`	`2`
`3`		`-class CompoundDocumentTest < MiniTest::Test`
	`3`	`+class CompoundDocumentTest < Minitest::Test`
`4`	`4`
`5`	`5`	`TEST_DATA = %{`
`6`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`require 'test_helper'`
`2`	`2`
`3`		`-class CompoundNonIncludedDocumentTest < MiniTest::Test`
	`3`	`+class CompoundNonIncludedDocumentTest < Minitest::Test`
`4`	`4`
`5`	`5`	`TEST_DATA = %{`
`6`	`6`	`{`