alba 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff1f7d9c2cf5b49ee88a9cf864e3a66251ccdb502515a1ea91c64837f84d22d
-  data.tar.gz: d26b6be0d948d848ba35f216392f9bafe3581925816cc9ee9eeaf651a3face3b
+  metadata.gz: 9f883beafbee55bdfc1bb9b55e821c6df5b167e5311cbeced743ae7c60de5657
+  data.tar.gz: e9c031cd63e51f160f1ec1f1b42ac8676b0ff172ff2438f549ab83d38d848817
 SHA512:
-  metadata.gz: b4b114df3e7e26bf2249f6f683efd1c856594cea376d6b8e33078f1cb9e3810132cf4cb120cfbc6682a556f84ca40115e157f09376c8a81af0160e20efcb2e23
-  data.tar.gz: 314f599a9564c053ed653178dd743291cb9125965e8bef7146bed5c049ec44568a40bb1b201df700fe0025e344ae4586af769a377db4f2a50527875aaf2c2c04
+  metadata.gz: 73b22da7dc5d360297838b326c3f130e18027b9fc203e3bdec48c13f80f4105a5fa019304a947dbc85aea40ee94e796cb20ba4c7c51f9a8c3cc02d29336f80f9
+  data.tar.gz: 2d82dfd6188126db9726982440465e9bc4cf6165e2eaf2c51f0d729eee1e8fa2d2c54b5d8aafce710979ba67be437f4bc152dc1e91352cea421925b32068c73f

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 3.9.0 2025-08-14
+
+### Added
+
+- Add source option to associations [#459](https://github.com/okuramasafumi/alba/pull/459)
+  - Thank you, @skryukov
+
+### Fixed
+
+- `params` isn't available in `attribute` with two-arity condition [#456](https://github.com/okuramasafumi/alba/issues/456)
+
 ## 3.8.0 2025-08-02
 
 ### Added

data/README.md

@@ -617,6 +617,34 @@ FooResource.new(foo, params: {expose_secret: true}).serialize # => '{"foo":{"bar
 FooResourceWithParamsOverride.new(foo, params: {expose_secret: true}).serialize # => '{"foo":{"bar":{"baz":{"data":1}}}}'
 ```
 
+#### Custom association source
+
+You can specify a custom source for associations using the `source` option with a proc. The `source` proc is executed in the context of the target object and can receive `params` for dynamic behavior. This allows you to retrieve association data from methods other than the association name or access instance variables.
+
+```ruby
+class User
+  attr_accessor :id, :name, :metadata
+
+  def custom_profile
+    {profile: {email: "#{name.downcase}@example.com"}}
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name
+
+  # Use a custom method as source
+  one :profile, source: proc { custom_profile[:profile] }
+
+  # Access instance variables
+  one :user_metadata, source: proc { @metadata }
+end
+```
+
+
+
 ### Nested Attribute
 
 Alba supports nested attributes that makes it easy to build complex data structure from single object.
@@ -778,15 +806,15 @@ Alba.serialize(
   [foo1, bar1, foo2, bar2],
   # `with` option takes a lambda to return resource class
   with: lambda do |obj|
-          case obj
-          when Foo
-            CustomFooResource
-          when Bar
-            BarResource
-          else
-            raise # Impossible in this case
-          end
-        end
+    case obj
+    when Foo
+      CustomFooResource
+    when Bar
+      BarResource
+    else
+      raise # Impossible in this case
+    end
+  end
 )
 # => '[{"id":1},{"id":1,"address":"bar1"},{"id":2},{"id":2,"address":"bar2"}]'
 # Note `CustomFooResource` is used here
@@ -1225,7 +1253,7 @@ There are four possible arguments `on_error` method accepts.
 * `:nullify` sets the attribute with the error to `nil`.
 * Block gives you more control over what to be returned.
 
-The block receives five arguments, `error`, `object`, `key`, `attribute` and `resource class` and must return a two-element array. Below is an example.
+The block receives five arguments, `error`, `object`, `key`, `attribute` and `resource class` and must return a two-element array. You can also ignore the given key with returning `Alba::REMOVE_KEY`, so that you can get even finer control over errors. Below is an example.
 
 ```ruby
 class ExampleResource
@@ -1235,12 +1263,14 @@ class ExampleResource
     if resource_class == MyResource
       ['error_fallback', object.error_fallback]
     else
-      [key, error.message]
+      Alba::REMOVE_KEY
     end
   end
 end
 ```
 
+For more information, consult to [test code](https://github.com/okuramasafumi/alba/blob/main/test/usecases/on_error_test.rb).
+
 ### Nil handling
 
 Sometimes we want to convert `nil` to different values such as empty string. Alba provides a flexible way to handle `nil`.
@@ -1520,8 +1550,8 @@ Alba supports serializing JSON in a layout. You need a file for layout and then
 
 ```erb
 {
-  "header": "my_header",
-  "body": <%= serialized_json %>
+"header": "my_header",
+"body": <%= serialized_json %>
 }
 ```
 
@@ -1909,7 +1939,7 @@ AuthorResource.new(
   author,
   params: {
     index: author.books.map.with_index { |book, index| [book.id, index] }
-    .to_h
+                 .to_h
   }
 ).serialize
 # => {"id":2,"books":[{"id":2,"name":"book2","index":0},{"id":3,"name":"book3","index":1},{"id":1,"name":"book1","index":2}]}

data/lib/alba/association.rb

@@ -16,16 +16,29 @@ module Alba
     # @param condition [Proc, nil] a proc filtering data
     # @param resource [Class<Alba::Resource>, Proc, String, Symbol, nil]
     #   a resource class for the association, a proc returning a resource class or a name of the resource
+    # @param source [Proc, nil] a proc to specify the source of the association
     # @param with_traits [Symbol, Array<Symbol>, nil] specified traits
     # @param params [Hash] params override for the association
     # @param nesting [String] a namespace where source class is inferred with
     # @param key_transformation [Symbol] key transformation type
     # @param helper [Module] helper module to include
     # @param block [Block] used to define resource when resource arg is absent
-    def initialize(name:, condition: nil, resource: nil, with_traits: nil, params: {}, nesting: nil, key_transformation: :none, helper: nil, &block)
+    def initialize(
+      name:,
+      condition: nil,
+      resource: nil,
+      source: nil,
+      with_traits: nil,
+      params: {},
+      nesting: nil,
+      key_transformation: :none,
+      helper: nil,
+      &block
+    )
       @name = name
       @condition = condition
       @resource = resource
+      @source = source
       @with_traits = with_traits
       @params = params
       return if @resource
@@ -64,7 +77,11 @@ module Alba
     private
 
     def object_from(target, params)
-      o = target.is_a?(Hash) ? target.fetch(@name) : target.__send__(@name)
+      o = if @source
+            target.instance_exec(params, &@source)
+          else
+            target.is_a?(Hash) ? target.fetch(@name) : target.__send__(@name)
+          end
       o = @condition.call(o, params, target) if @condition
       o
     end

data/lib/alba/conditional_attribute.rb

@@ -25,7 +25,7 @@ module Alba
       fetched_attribute = yield(@body)
       return fetched_attribute unless with_two_arity_proc_condition?
 
-      return Alba::REMOVE_KEY unless resource.instance_exec(object, second_object(object), &@condition)
+      return Alba::REMOVE_KEY unless resource.instance_exec(object, second_object(object, resource), &@condition)
 
       fetched_attribute
     end
@@ -50,14 +50,14 @@ module Alba
       @condition.is_a?(Proc) && @condition.arity >= 2
     end
 
-    def second_object(object)
+    def second_object(object, resource)
       case @body
       when Symbol, Alba::Association, Alba::TypedAttribute
         object.__send__(@body.name)
       when Alba::NestedAttribute
         nil
       when Proc
-        @body.call(object)
+        resource.instance_exec(object, &@body)
       else raise Alba::Error, "Unreachable code, @body is: #{@body.inspect}"
       end
     end

data/lib/alba/resource.rb

@@ -429,6 +429,7 @@ module Alba
       # @param condition [Proc, nil] a Proc to modify the association
       # @param resource [Class<Alba::Resource>, String, Proc, nil] representing resource for this association
       # @param serializer [Class<Alba::Resource>, String, Proc, nil] alias for `resource`
+      # @param source [Proc, nil] a Proc to customize the association source
       # @param key [String, Symbol, nil] used as key when given
       # @param with_traits [Symbol, Array<Symbol>, nil] specified traits
       # @param params [Hash] params override for the association
@@ -437,11 +438,11 @@ module Alba
       # @param block [Block]
       # @return [void]
       # @see Alba::Association#initialize
-      def association(name, condition = nil, resource: nil, serializer: nil, key: nil, with_traits: nil, params: {}, **options, &block)
+      def association(name, condition = nil, resource: nil, serializer: nil, source: nil, key: nil, with_traits: nil, params: {}, **options, &block)
         resource ||= serializer
         transformation = @_key_transformation_cascade ? @_transform_type : :none
         assoc = Association.new(
-          name: name, condition: condition, resource: resource, with_traits: with_traits,
+          name: name, condition: condition, resource: resource, source: source, with_traits: with_traits,
           params: params, nesting: nesting, key_transformation: transformation, helper: @_helper,
           &block
         )

data/lib/alba/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alba
-  VERSION = '3.8.0'
+  VERSION = '3.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - OKURA Masafumi