jpie 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9afc70de5e508e561e451595fc67fdad82446fe7b79c4b565d53c8a26719c13
-  data.tar.gz: fca030ebc361a511587a1a3b152243629ec6fec26f65c929408325cedba2ca95
+  metadata.gz: 8c205d5463d3fffd9ccf158d1ef8df04e34e50fd6a7385f9b727a46676181c00
+  data.tar.gz: 1c8e628e95a5296baa459c89cbc7d2bd119f4bb5e0456f5d9d3e4c8322b08a92
 SHA512:
-  metadata.gz: 6136bb0f0829358a96d5fc1daace4794ad1f3e559701d5ed6b03c63189f8925fa3e6f645e6b447809f3cdbd44596e3defc6ffda2d0f87b62d36f2c3f17ba9cc8
-  data.tar.gz: 9af6902e625ab5fa282065849bdaa89977389a4c2c86db06805de6c05b3c6325bb2a8dd4253f93bcf8a27016e77ca9b3b3adc9a805058baac1c7b403439a104f
+  metadata.gz: 17bb979968aba9d606fdb537c5ebba08e8d29b39e9ffd2dbaefeaaeafc4a41b1ebb686429cd20ffd10db9276320d0e70e7cc94551a418863dbdd633542df67f6
+  data.tar.gz: 8fad54116b4eaa6c2e77f9e8034f477a3c9cb4911cc749ff00bf06cc30d801751ff0351771040dd94f6a639776aa0396775637e1d1fa4583a91a965e844ca8e8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jpie (1.1.1)
+    jpie (1.1.2)
       actionpack (~> 8.0, >= 8.0.0)
       rails (~> 8.0, >= 8.0.0)
 

data/lib/json_api/testing/rspec.rb

@@ -9,14 +9,22 @@
 # This will:
 # 1. Load all shared example module definitions
 # 2. Load all shared examples for resources and responses
-# 3. Make the modules available at the top level for convenient usage
+# 3. Load STI testing helpers for request specs
+# 4. Make the modules available at the top level for convenient usage
 #
 # After requiring, you can use shared examples like:
 #
 #   it_behaves_like [ Jpie, Resource, :has_attributes ].to_s, :name, :email
 #   it_behaves_like [ Jpie, Response, :data ].to_s, type: "users"
+#   it_behaves_like [ Jpie, Response, :sti_types ].to_s, expected_subtypes: ["user_messages"]
+#
+# And STI helpers in request specs:
+#
+#   expect_sti_types_in_included(expected_subtypes: ["user_messages"])
+#   expect_sti_resources_included(sti_type: "user_messages", expected_ids: [msg.id])
 
 require_relative "shared_examples/modules"
+require_relative "sti_helpers"
 
 # Load shared examples
 Dir[File.join(__dir__, "shared_examples", "*.rb")].each do |file|
@@ -30,4 +38,7 @@ RSpec.configure do |config|
       define_method(const) { Object.const_get(const) }
     end
   end)
+
+  # Include STI helpers for request specs
+  config.include JSONAPI::Testing::StiHelpers, type: :request
 end

data/lib/json_api/testing/shared_examples/responses.rb

@@ -60,7 +60,8 @@ RSpec.shared_examples [Jpie, Response, :relationships].to_s do |*relationships|
   end
 end
 
-RSpec.shared_examples [Jpie, Response, :included].to_s do |type: nil, count: nil|
+RSpec.shared_examples [Jpie, Response,
+                       :included,].to_s do |type: nil, count: nil, sti_subtypes: nil, exclude_base_type: nil|
   it "includes compound document data" do
     included = response.parsed_body["included"]
     expect(included).to be_an(Array)
@@ -71,6 +72,20 @@ RSpec.shared_examples [Jpie, Response, :included].to_s do |type: nil, count: nil
       expect(matching).not_to be_empty, "Expected included to contain type '#{type}'"
       expect(matching.size).to eq(count) if count
     end
+
+    if sti_subtypes
+      included_types = included.pluck("type").uniq
+      sti_subtypes.each do |subtype|
+        expect(included_types).to include(subtype.to_s),
+                                  "Expected included to contain STI subtype '#{subtype}', got: #{included_types}"
+      end
+    end
+
+    if exclude_base_type
+      included_types ||= included.pluck("type").uniq
+      expect(included_types).not_to include(exclude_base_type.to_s),
+                                    "Expected included NOT to contain base type '#{exclude_base_type}', but it did"
+    end
   end
 end
 
@@ -111,3 +126,40 @@ RSpec.shared_examples [Jpie, Response, :errors].to_s do |count: nil|
     end
   end
 end
+
+RSpec.shared_examples [Jpie, Response, :sti_types].to_s do |expected_subtypes:, exclude_base_type: nil|
+  it "returns STI subtypes correctly" do
+    data = response.parsed_body["data"]
+    data = [data] unless data.is_a?(Array)
+    types = data.pluck("type").uniq
+
+    expected_subtypes.each do |subtype|
+      expect(types).to include(subtype.to_s),
+                       "Expected data to contain STI subtype '#{subtype}', got: #{types}"
+    end
+
+    if exclude_base_type
+      expect(types).not_to include(exclude_base_type.to_s),
+                           "Expected data NOT to contain base type '#{exclude_base_type}', but it did"
+    end
+  end
+end
+
+RSpec.shared_examples [Jpie, Response, :sti_included].to_s do |expected_subtypes:, exclude_base_type: nil|
+  it "includes STI subtypes correctly" do
+    included = response.parsed_body["included"] || []
+    expect(included).not_to be_empty, "Expected included to be present"
+
+    included_types = included.pluck("type").uniq
+
+    expected_subtypes.each do |subtype|
+      expect(included_types).to include(subtype.to_s),
+                                "Expected included to contain STI subtype '#{subtype}', got: #{included_types}"
+    end
+
+    if exclude_base_type
+      expect(included_types).not_to include(exclude_base_type.to_s),
+                                    "Expected included NOT to contain base type '#{exclude_base_type}', but it did"
+    end
+  end
+end

data/lib/json_api/testing/sti_helpers.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Testing
+    # Helper methods for testing STI (Single Table Inheritance) resources in JSON:API responses.
+    #
+    # These helpers simplify testing that STI subtypes are correctly serialized
+    # and included in JSON:API responses.
+    #
+    # Usage in request specs:
+    #
+    #   it "includes user messages", :aggregate_failures do
+    #     get conversation_path(conversation), params: { include: "messages" }, as: :jsonapi
+    #     expect_sti_types_in_included(expected_subtypes: ["user_messages"])
+    #     expect_sti_resources_included(sti_type: "user_messages", expected_ids: [message.id])
+    #   end
+    module StiHelpers
+      # Verify that included resources contain expected STI subtypes.
+      #
+      # @param expected_subtypes [Array<String, Symbol>] Expected STI subtype names
+      # @param exclude_base_type [String, Symbol, nil] Base type that should NOT be present (optional)
+      # @return [void]
+      #
+      # @example Verify subtypes are present
+      #   expect_sti_types_in_included(expected_subtypes: ["user_messages", "ai_messages"])
+      #
+      # @example Verify subtypes and exclude base type
+      #   expect_sti_types_in_included(
+      #     expected_subtypes: ["user_messages"],
+      #     exclude_base_type: "messages"
+      #   )
+      def expect_sti_types_in_included(expected_subtypes:, exclude_base_type: nil)
+        included = response.parsed_body["included"] || []
+        included_types = included.pluck("type").uniq
+
+        expected_subtypes.each do |subtype|
+          expect(included_types).to include(subtype.to_s),
+                                    "Expected included to contain STI type '#{subtype}', got: #{included_types}"
+        end
+
+        return if exclude_base_type.blank?
+
+        expect(included_types).not_to include(exclude_base_type.to_s),
+                                      "Expected included NOT to contain base type '#{exclude_base_type}', but it did"
+      end
+
+      # Find all resources of a specific STI type in the included array.
+      #
+      # @param sti_type [String, Symbol] The STI subtype to find
+      # @return [Array<Hash>] Array of resource objects matching the STI type
+      #
+      # @example Find all user messages in included
+      #   messages = find_sti_resources_in_included("user_messages")
+      #   expect(messages.first["attributes"]["content"]).to eq("Hello")
+      def find_sti_resources_in_included(sti_type)
+        included = response.parsed_body["included"] || []
+        included.select { |item| item["type"] == sti_type.to_s }
+      end
+
+      # Verify that specific STI resources are included by ID.
+      #
+      # @param sti_type [String, Symbol] The STI subtype
+      # @param expected_ids [Array<Integer, String>] Expected resource IDs
+      # @return [void]
+      #
+      # @example Verify specific messages are included
+      #   expect_sti_resources_included(
+      #     sti_type: "user_messages",
+      #     expected_ids: [message1.id, message2.id]
+      #   )
+      def expect_sti_resources_included(sti_type:, expected_ids:)
+        resources = find_sti_resources_in_included(sti_type)
+        actual_ids = resources.map { |r| r["id"] }
+        expected_ids_str = expected_ids.map(&:to_s)
+
+        expect(actual_ids).to match_array(expected_ids_str),
+                              "Expected #{sti_type} resources with IDs #{expected_ids_str}, got: #{actual_ids}"
+      end
+
+      # Verify STI types in data array (not included).
+      #
+      # @param expected_subtypes [Array<String, Symbol>] Expected STI subtype names
+      # @param exclude_base_type [String, Symbol, nil] Base type that should NOT be present (optional)
+      # @return [void]
+      #
+      # @example Verify data contains correct STI types
+      #   expect_sti_types_in_data(
+      #     expected_subtypes: ["user_messages", "ai_messages"],
+      #     exclude_base_type: "messages"
+      #   )
+      def expect_sti_types_in_data(expected_subtypes:, exclude_base_type: nil)
+        data = response.parsed_body["data"]
+        data = [data] unless data.is_a?(Array)
+        types = data.pluck("type").uniq
+
+        expected_subtypes.each do |subtype|
+          expect(types).to include(subtype.to_s),
+                           "Expected data to contain STI subtype '#{subtype}', got: #{types}"
+        end
+
+        return if exclude_base_type.blank?
+
+        expect(types).not_to include(exclude_base_type.to_s),
+                             "Expected data NOT to contain base type '#{exclude_base_type}', but it did"
+      end
+
+      # Find all resources of a specific STI type in the data array.
+      #
+      # @param sti_type [String, Symbol] The STI subtype to find
+      # @return [Array<Hash>] Array of resource objects matching the STI type
+      #
+      # @example Find all user messages in data
+      #   messages = find_sti_resources_in_data("user_messages")
+      def find_sti_resources_in_data(sti_type)
+        data = response.parsed_body["data"]
+        data = [data] unless data.is_a?(Array)
+        data.select { |item| item["type"] == sti_type.to_s }
+      end
+
+      # Verify that specific STI resources are present in data by ID.
+      #
+      # @param sti_type [String, Symbol] The STI subtype
+      # @param expected_ids [Array<Integer, String>] Expected resource IDs
+      # @return [void]
+      #
+      # @example Verify specific messages are in data
+      #   expect_sti_resources_in_data(
+      #     sti_type: "user_messages",
+      #     expected_ids: [message1.id, message2.id]
+      #   )
+      def expect_sti_resources_in_data(sti_type:, expected_ids:)
+        resources = find_sti_resources_in_data(sti_type)
+        actual_ids = resources.map { |r| r["id"] }
+        expected_ids_str = expected_ids.map(&:to_s)
+
+        expect(actual_ids).to match_array(expected_ids_str),
+                              "Expected #{sti_type} resources with IDs #{expected_ids_str}, got: #{actual_ids}"
+      end
+    end
+  end
+end

data/lib/json_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSONAPI
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jpie
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Emil Kampp
@@ -148,6 +148,7 @@ files:
 - lib/json_api/testing/shared_examples/modules.rb
 - lib/json_api/testing/shared_examples/resources.rb
 - lib/json_api/testing/shared_examples/responses.rb
+- lib/json_api/testing/sti_helpers.rb
 - lib/json_api/testing/test_helper.rb
 - lib/json_api/version.rb
 - lib/rubocop/cop/custom/hash_value_omission.rb