infinum_json_api_setup 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd0a0f31918bb2f7f2c2fd1c89c7ef8704292bba7590c980c54ac8daa809c321
-  data.tar.gz: afb709b1deeb7891a4f7a65a248ffaebcbd4f0ad874e48d1c7c21dae623d3cb1
+  metadata.gz: 02c01a6edfee1465e478a630629fd38b0cd35f08a84a32a2eac73c353440bebc
+  data.tar.gz: f94a539f053417cfc9e0a4c938eaa594a02e422930fee2f46b80aebffeaa17e0
 SHA512:
-  metadata.gz: d4c5c8b5f7564d095d43efa4a292263dc8c5cc65c4066f5ee3078b7b7afefcbb4879570ec6474ae6aa690a775afbd97f319ce6d6d3c55585314bbf455a0a5ce8
-  data.tar.gz: 60da19ebe9c6ebc6edf1fba046621cd966ecb5c4a0436fcc251ac5a18a946e6323a7f5359fc11632a434abfc886cf61eea7c256b364eccb2319a29eac0bfd0c8
+  metadata.gz: eadacbfe9298f7345e3f8a639b5dee0d39515b030a9519fa9c020667d2dfe65f52a7326971853dbb52a5a25b5aea407e049da466ea6e7bcf86fe49765568fc0d
+  data.tar.gz: 6d811bc78b9f2e999a40c5e08d250277cf5f70bc0307b6f61fba1f336907a36b6f813dd57fb6bcdeebb5d26fc789711521bbae0c17f103bee5ac27449a5973b0

data/CHANGELOG.md

@@ -8,6 +8,11 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a
 
 ### Changes
 
+## [0.1.1] - 2026-08-13
+
+### Fixed
+- Merge controller-provided `meta` into pagination meta instead of replacing it when rendering paginated JSON:API collections
+
 ## [0.1.0] - 2025-11-03
 
 ### Added

data/README.md

@@ -66,6 +66,17 @@ def destroy
 end
 ```
 
+For paginated collections, pass `pagination_details` from your query object. You can add extra collection-level fields to `meta`; they are merged with pagination meta instead of replacing it.
+```ruby
+def index
+  q = Users::Query.new(User.all, params.to_unsafe_hash)
+
+  respond_with q.results,
+               pagination_details: q.pagination_details,
+               meta: { total_unread: current_user.unread_notifications_count }
+end
+```
+
 ## Internals
 This section explains the under-the-hood behavior of the library.
 

data/lib/infinum_json_api_setup/json_api/serializer_options.rb

@@ -4,9 +4,11 @@ module InfinumJsonApiSetup
       # @param [Hash] opts
       # @option opts [Hash] :params
       # @option opts [Object] :pagination_details
-      def initialize(params:, pagination_details:)
+      # @option opts [Hash] :extra_meta additional collection meta merged into pagination meta
+      def initialize(params:, pagination_details:, extra_meta: nil)
         @params = params
         @pagination_details = pagination_details
+        @extra_meta = extra_meta || {}
       end
 
       # @return [Hash]
@@ -23,8 +25,13 @@ module InfinumJsonApiSetup
 
       attr_reader :params
       attr_reader :pagination_details
+      attr_reader :extra_meta
 
       def meta
+        pagination_meta.merge(extra_meta)
+      end
+
+      def pagination_meta
         return {} unless pagination_details
 
         {

data/lib/infinum_json_api_setup/rails.rb

@@ -19,10 +19,12 @@ ActiveSupport.on_load(:action_controller) do
         "#{controller_path.classify.pluralize}::Serializer".constantize
       end
       options = InfinumJsonApiSetup::JsonApi::SerializerOptions.new(
-        params: params.to_unsafe_h, pagination_details: opts[:pagination_details]
+        params: params.to_unsafe_h,
+        pagination_details: opts[:pagination_details],
+        extra_meta: opts[:meta]
       ).build
 
-      serializer.new(resources, options.merge(opts)).serializable_hash.to_json
+      serializer.new(resources, options.merge(opts.except(:meta))).serializable_hash.to_json
     end
   end
 end

data/lib/infinum_json_api_setup/version.rb

@@ -1,3 +1,3 @@
 module InfinumJsonApiSetup
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/rails.7.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    infinum_json_api_setup (0.1.0)
+    infinum_json_api_setup (0.1.1)
       accept_language (~> 2.0)
       json_schemer (>= 0.2, < 3)
       jsonapi-query_builder

data/rails.8.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    infinum_json_api_setup (0.1.0)
+    infinum_json_api_setup (0.1.1)
       accept_language (~> 2.0)
       json_schemer (>= 0.2, < 3)
       jsonapi-query_builder

data/spec/infinum_json_api_setup/json_api/serializer_options_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+describe InfinumJsonApiSetup::JsonApi::SerializerOptions do
+  subject(:built_options) do
+    described_class.new(
+      params: params,
+      pagination_details: pagination_details,
+      extra_meta: extra_meta
+    ).build
+  end
+
+  let(:params) { {} }
+  let(:extra_meta) { nil }
+  let(:pagination_details) do
+    instance_double(
+      Pagy,
+      page: 1,
+      pages: 2,
+      count: 10,
+      last: 2,
+      prev: nil,
+      next: 2,
+      vars: { outset: 0, items: 20 }
+    )
+  end
+
+  before do
+    allow(Rails.application.routes.url_helpers).to receive(:url_for).and_return('http://example.com')
+  end
+
+  it 'includes pagination meta' do
+    expect(built_options[:meta]).to include(
+      current_page: 1,
+      total_pages: 2,
+      total_count: 10,
+      padding: 0,
+      page_size: 20,
+      max_page_size: Pagy::DEFAULT[:max_items]
+    )
+  end
+
+  context 'when extra meta is present' do
+    let(:extra_meta) { { total_unread: 5 } }
+
+    it 'merges extra meta into pagination meta' do
+      expect(built_options[:meta]).to include(
+        current_page: 1,
+        total_unread: 5
+      )
+    end
+  end
+
+  context 'when extra meta is an empty hash' do
+    let(:extra_meta) { {} }
+
+    it 'keeps pagination meta' do
+      expect(built_options[:meta]).to include(current_page: 1, total_pages: 2)
+    end
+  end
+
+  context 'when pagination details are absent' do
+    let(:pagination_details) { nil }
+    let(:extra_meta) { { custom_count: 3 } }
+
+    it 'returns only extra meta' do
+      expect(built_options[:meta]).to eq(custom_count: 3)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: infinum_json_api_setup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Team Backend @ Infinum
@@ -252,6 +252,7 @@ files:
 - spec/dummy/storage/.keep
 - spec/factories/location.rb
 - spec/factories/location_label.rb
+- spec/infinum_json_api_setup/json_api/serializer_options_spec.rb
 - spec/infinum_json_api_setup/rspec/helpers/response_helper_spec.rb
 - spec/infinum_json_api_setup/rspec/matchers/have_empty_data_spec.rb
 - spec/infinum_json_api_setup/rspec/matchers/have_error_pointer_spec.rb