alba-inertia 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df5684ee0729c9f364ed20123d54801b86444a5e9744faad8440a72e6c687954
-  data.tar.gz: 9b5e4cacf37baec365aeb8b3ab4a1f34414e8ac2cec9ef44c73d9602b314431f
+  metadata.gz: 36892b105c78f91a4874dca3d397e42be762acf30fcd56f379e1f2672683def0
+  data.tar.gz: 8dfc87dca73d0594fcc7233e48bdf73d2cc62f6f082bfe0e820685cfa827603c
 SHA512:
-  metadata.gz: 32a3a5cf0efa9191ec64930aa9ec6911667a49effa8a22fc3f824ad6385dfadf4a31a6be6c836498b5f27fa6828b1f2e8d484517ef80c3917728c0376676eefe
-  data.tar.gz: e36f3677490020bdce6e55e0616ea5fa45aa3e1ba10f377b7db8732eaf62312e49117b18bf9fe21bf08949d1a605934e3019e928d15f6355bb1230c14175e4a3
+  metadata.gz: 74b25910459121487726f3a3d1be5c235dacd494cc25d9bc0dfb337e0900e962be3c5283e8a2667476cf1dcff1314a984781c04ab037f7eddcf2b09379296b48
+  data.tar.gz: d36a4bde371ad4322c595f251ce7a83c4cd0e83e6459695603044d8987e6d029b6556783337135a668ac76410cec19a57634492e805c252c86744d6d95efeddd

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.1.2] - 2025-12-08
+
+### Added
+
+- Support for `InertiaRails.scroll` attributes. ([@skryukov])
+- Add `serializer_params` option to `render_inertia` and `inertia_serializer_params` controller method for passing params to serializers. ([@skryukov])
+
 ## [0.1.1] - 2025-11-05
 
 ### Added
@@ -26,7 +33,8 @@ and this project adheres to [Semantic Versioning].
 
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/alba-inertia/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/skryukov/alba-inertia/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/skryukov/alba-inertia/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/skryukov/alba-inertia/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/skryukov/alba-inertia/commits/v0.1.0
 

data/README.md

@@ -27,7 +27,10 @@ Include `Alba::Inertia::Resource` in your resource classes:
 ```ruby
 class ApplicationResource
   include Alba::Resource
-  include Alba::Inertia::Resource
+  
+  # ...
+
+  helper Alba::Inertia::Resource
 end
 ```
 
@@ -61,6 +64,15 @@ class CoursesIndexResource < ApplicationResource
 
   # Merge prop (for partial reloads)
   has_many :comments, serializer: CommentResource, inertia: { merge: { match_on: :id } }
+
+  # Scroll prop with auto-detection.
+  # Checks object for `scroll_meta` and `pagy` attributes, or object being a Kaminari collection.
+  has_many :items, inertia: :scroll
+
+  # Scroll prop with explicit metadata
+  has_many :items, inertia: { scroll: :meta }
+  has_many :items, inertia: { scroll: -> { |obj| obj.meta } }
+  has_many :items, inertia: { scroll: -> { |obj| obj.meta }, wrapper: 'data' }
 end
 ```
 
@@ -177,6 +189,49 @@ render_inertia(serializer: CustomResource)
 render_inertia(locals: { custom: 'props'})
 ```
 
+### Serializer Params
+
+You can pass params to the serializer using the `serializer_params` option. This is useful for passing context like the current user, permissions, or feature flags:
+
+```ruby
+class CoursesController < InertiaController
+  def index
+    @courses = Course.all
+    render_inertia(serializer_params: { current_user: current_user })
+  end
+end
+```
+
+In your resource, access params via the `params` method:
+
+```ruby
+class CoursesIndexResource < ApplicationResource
+  attributes :id, :title
+
+  attribute :can_edit do |course|
+    params[:current_user]&.can_edit?(course)
+  end
+end
+```
+
+### Default Serializer Params
+
+Override `inertia_serializer_params` in your controller to provide default params for all Inertia renders:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Alba::Inertia::Controller
+
+  private
+
+  def inertia_serializer_params
+    { current_user: current_user, locale: I18n.locale }
+  end
+end
+```
+
+The `serializer_params` option in `render_inertia` will be merged with these defaults (with `serializer_params` taking precedence).
+
 ## Naming Convention
 
 The controller integration follows Rails conventions:

data/lib/alba/inertia/controller.rb

@@ -9,13 +9,17 @@ module Alba
         Alba::Inertia.config.default_render ? render_inertia : super
       end
 
-      def render_inertia(component = nil, serializer: inertia_serializer_class, locals: view_assigns, **props)
-        resource = serializer&.new(locals.symbolize_keys!)
+      def render_inertia(component = nil, serializer: inertia_serializer_class, locals: view_assigns, serializer_params: {}, **props)
+        resource = serializer&.new(locals.symbolize_keys!, params: inertia_serializer_params.merge(serializer_params))
         data = resource.respond_to?(:to_inertia) ? resource.to_inertia : resource.as_json
 
         render inertia: component || true, props: data || {}, **props
       end
 
+      def inertia_serializer_params
+        {}
+      end
+
       def inertia_serializer_class
         namespace = self.class.name.deconstantize
         base_name = "#{controller_name}_#{action_name}_resource".classify

data/lib/alba/inertia/prop_builder.rb

@@ -4,15 +4,17 @@ module Alba
   module Inertia
     class PropBuilder
       class << self
-        def build(evaluation_block, options)
+        def build(evaluation_block, options, object = nil)
           if options[:optional]
-            wrap_optional(evaluation_block, options[:optional])
+            wrap_optional(evaluation_block, options[:optional], object)
           elsif options[:defer]
-            wrap_defer(evaluation_block, options[:defer])
+            wrap_defer(evaluation_block, options[:defer], object)
           elsif options[:merge]
-            wrap_merge(evaluation_block, options[:merge])
+            wrap_merge(evaluation_block, options[:merge], object)
+          elsif options[:scroll]
+            wrap_scroll(evaluation_block, options[:scroll], object)
           elsif options[:always]
-            wrap_always(evaluation_block, options[:always])
+            wrap_always(evaluation_block, options[:always], object)
           else
             Alba::Inertia.config.lazy_by_default ? evaluation_block : evaluation_block.call
           end
@@ -20,15 +22,15 @@ module Alba
 
         private
 
-        def wrap_always(value_block, _opts)
+        def wrap_always(value_block, _opts, _object)
           ::InertiaRails.always(&value_block)
         end
 
-        def wrap_optional(value_block, _opts)
+        def wrap_optional(value_block, _opts, _object)
           ::InertiaRails.optional(&value_block)
         end
 
-        def wrap_defer(value_block, opts)
+        def wrap_defer(value_block, opts, _object)
           if opts.is_a?(Hash)
             options = {
               group: opts[:group],
@@ -43,7 +45,7 @@ module Alba
           end
         end
 
-        def wrap_merge(value_block, opts)
+        def wrap_merge(value_block, opts, _object)
           if opts.is_a?(Hash)
             options = {match_on: opts[:match_on]}.compact
             ::InertiaRails.merge(**options, &value_block)
@@ -51,6 +53,65 @@ module Alba
             ::InertiaRails.merge(&value_block)
           end
         end
+
+        def wrap_scroll(value_block, opts, object)
+          case opts
+          when Symbol
+            # scroll: :meta => extract metadata from object[:meta] or object.meta
+            metadata = extract_from_object(object, opts)
+            ::InertiaRails.scroll(metadata: metadata, &value_block)
+          when Proc
+            # scroll: -> { |obj| obj.meta } => call proc with object
+            metadata = opts.call(object)
+            ::InertiaRails.scroll(metadata: metadata, &value_block)
+          when Hash
+            options = build_scroll_options(opts, object)
+            ::InertiaRails.scroll(**options, &value_block)
+          when TrueClass
+            # scroll: true => auto-detect metadata
+            metadata = auto_detect_pagination_metadata(object)
+            ::InertiaRails.scroll(metadata: metadata, &value_block)
+          else
+            raise ArgumentError, "Invalid scroll option. Expected Symbol, Proc, Hash, or true."
+          end
+        end
+
+        def build_scroll_options(opts, object)
+          metadata = case opts[:scroll]
+          when Symbol
+            extract_from_object(object, opts[:scroll])
+          when Proc
+            opts[:scroll].call(object)
+          else
+            opts[:scroll]
+          end
+
+          {metadata: metadata}.merge(opts.slice(:wrapper, :page_name, :previous_page, :next_page, :current_page))
+        end
+
+        def extract_from_object(object, key)
+          if object.respond_to?(:[])
+            object[key]
+          elsif object.respond_to?(key)
+            object.send(key)
+          end
+        rescue
+          nil
+        end
+
+        def auto_detect_pagination_metadata(object)
+          metadata = extract_from_object(object, :scroll_meta)
+          return metadata if metadata
+
+          metadata = extract_from_object(object, :pagy)
+          return metadata if metadata
+
+          # Check if object is a Kaminari collection
+          return object if defined?(Kaminari) && object.is_a?(Kaminari::PageScopeMethods)
+
+          # If nothing found, raise an error
+          raise ArgumentError, "Unable to auto-detect pagination metadata. Please provide metadata explicitly or ensure object has 'scroll_meta', 'pagy' attributes, or is a Kaminari collection."
+        end
       end
     end
   end

data/lib/alba/inertia/resource.rb

@@ -61,6 +61,7 @@ module Alba
             optional: kwargs.delete(:optional) || false,
             defer: kwargs.delete(:defer) || false,
             merge: kwargs.delete(:merge) || false,
+            scroll: kwargs.delete(:scroll) || false,
             always: kwargs.delete(:always) || false
           }.select { |_k, v| v.present? }
 
@@ -107,9 +108,7 @@ module Alba
         def auto_typelize_from_inertia(name, inertia_opts)
           return unless respond_to?(:typelize)
 
-          should_be_optional = inertia_opts[:optional].present? ||
-            inertia_opts[:defer].present? ||
-            inertia_opts[:merge].present?
+          should_be_optional = inertia_opts[:optional].present? || inertia_opts[:defer].present?
 
           typelize(name.to_sym => [optional: true]) if should_be_optional
         end
@@ -127,7 +126,7 @@ module Alba
           evaluation_block = build_evaluation_block(attr_name, attr_body)
 
           result[attr_name_str] = if metadata.key?(attr_name)
-            PropBuilder.build(evaluation_block, metadata[attr_name])
+            PropBuilder.build(evaluation_block, metadata[attr_name], object)
           else
             Alba::Inertia.config.lazy_by_default ? evaluation_block : evaluation_block.call
           end

data/lib/alba/inertia/version.rb

@@ -2,6 +2,6 @@
 
 module Alba
   module Inertia
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alba-inertia
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Svyatoslav Kryukov
@@ -67,15 +67,15 @@ files:
 - lib/alba/inertia/prop_builder.rb
 - lib/alba/inertia/resource.rb
 - lib/alba/inertia/version.rb
-homepage: https://github.com/skryukov/typelizer
+homepage: https://github.com/skryukov/alba-inertia
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/skryukov/typelizer/issues
-  changelog_uri: https://github.com/skryukov/typelizer/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/skryukov/typelizer/blob/main/README.md
-  homepage_uri: https://github.com/skryukov/typelizer
-  source_code_uri: https://github.com/skryukov/typelizer
+  bug_tracker_uri: https://github.com/skryukov/alba-inertia/issues
+  changelog_uri: https://github.com/skryukov/alba-inertia/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/skryukov/alba-inertia/blob/main/README.md
+  homepage_uri: https://github.com/skryukov/alba-inertia
+  source_code_uri: https://github.com/skryukov/alba-inertia
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.0
 specification_version: 4
 summary: Seamless integration between Alba and Inertia Rails.
 test_files: []