alba 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3168959e9726c35e28faf0f027dd78010b4b0cf5ead0564b8fa8a7f32e5bf84
-  data.tar.gz: b9cab46abe11f69ef40ef15d3cc673a279a6f1ab12ab8a8b908250a8462f65e8
+  metadata.gz: d1a7b2fac43a1ae40bc0598d6f989fb7b81108d00ca929d31327113590880b2f
+  data.tar.gz: d6bc3c22c9178eeaf8b3b7f3d3d92bc526edd18904fa736c0c25488250f89d02
 SHA512:
-  metadata.gz: 8d5b3c0513e7f706d484fdc19c8423fc6261bd7b670eee46009b0cf15b9b47f8bdfc14041937a57f15e75c679ad3073fa84ecaf1bcc782ab0615fdebd141a6cc
-  data.tar.gz: 017b40ee4d711a50bcd2c74719a0a4a27b4965058cfb8f37382765a84b7400fc78af754fb98b0d4aeb7ba5c935656b3d61687e9c0784a09a047269fbd2e7356f
+  metadata.gz: da62c8a7d30ab7c4c39032950c9e02cef238b8662f403843351116fb86e3a3010e2780a3b5efe958697fd698e7e703a130a292129f3efad4da253cc9e84570bd
+  data.tar.gz: 94a580ab65397d4f61a8534bfd22999d86bdd9e6cca0ec83b15d03bd2fdbdedc220bbbaf091b20c34e58c7dfe5c7b21c9f046a78b25639dcecf59b71b95199c0

data/.github/workflows/main.yml

@@ -33,7 +33,7 @@ jobs:
       run: |
         bundle exec rake
     - name: CodeCov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       with:
         files: ./coverage/coverage.xml
         token: ${{ secrets.CODECOV_TOKEN }}

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.4.0] 2024-12-01
+
+### Added
+
+- `Alba.serialize` now works with heterogeneous collection [#396](https://github.com/okuramasafumi/alba/pull/396)
+
 ## [3.3.3] 2024-11-09
 
 ### Fixed

data/Gemfile

@@ -11,11 +11,11 @@ gem 'ffaker', require: false # For testing
 gem 'minitest', '~> 5.14' # For test
 gem 'railties', require: false # For Rails integration testing
 gem 'rake', '~> 13.0' # For test and automation
-gem 'rubocop', '~> 1.68.0', require: false # For lint
+gem 'rubocop', '~> 1.69.0', require: false # For lint
 gem 'rubocop-gem_dev', '>= 0.3.0', require: false # For lint
 gem 'rubocop-md', '~> 1.0', require: false # For lint
 gem 'rubocop-minitest', '~> 0.36.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.22.1', require: false # For lint
+gem 'rubocop-performance', '~> 1.23.0', require: false # For lint
 gem 'rubocop-rake', '~> 0.6.0', require: false # For lint
 gem 'simplecov', '~> 0.22.0', require: false # For test coverage
 gem 'simplecov-cobertura', require: false # For test coverage

data/README.md

@@ -730,6 +730,60 @@ end
 # => JSON containing "foo" and "bar" as root keys
 ```
 
+#### Inline definition with heterogeneous collection
+
+Alba allows to serialize a heterogeneous collection with `Alba.serialize`.
+
+```ruby
+Foo = Data.define(:id, :name)
+Bar = Data.define(:id, :address)
+
+class FooResource
+  include Alba::Resource
+
+  attributes :id, :name
+end
+
+class BarResource
+  include Alba::Resource
+
+  attributes :id, :address
+end
+
+class CustomFooResource
+  include Alba::Resource
+
+  attributes :id
+end
+
+foo1 = Foo.new(1, 'foo1')
+foo2 = Foo.new(2, 'foo2')
+bar1 = Bar.new(1, 'bar1')
+bar2 = Bar.new(2, 'bar2')
+
+# This works only when inflector is set
+Alba.serialize([foo1, bar1, foo2, bar2], with: :inference)
+# => '[{"id":1,"name":"foo1"},{"id":1,"address":"bar1"},{"id":2,"name":"foo2"},{"id":2,"address":"bar2"}]'
+
+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
+)
+# => '[{"id":1},{"id":1,"address":"bar1"},{"id":2},{"id":2,"address":"bar2"}]'
+# Note `CustomFooResource` is used here
+
+```
+
 ### Serializable Hash
 
 Instead of serializing to JSON, you can also output a Hash by calling `serializable_hash` or the `to_h` alias. Note also that the `serialize` method is aliased as `to_json`.

data/lib/alba/resource.rb

@@ -56,7 +56,7 @@ module Alba
       # Serialize object into JSON string
       #
       # @param root_key [Symbol, nil, true]
-      # @param meta [Hash] metadata for this seialization
+      # @param meta [Hash] metadata for this serialization
       # @return [String] serialized JSON string
       def serialize(root_key: nil, meta: {})
         serialize_with(as_json(root_key: root_key, meta: meta))
@@ -78,11 +78,11 @@ module Alba
         serialize(root_key: root_key, meta: meta)
       end
 
-      # Returns a Hash correspondng {#serialize}
+      # Returns a Hash corresponding {#serialize}
       #
       # @param _options [Hash] dummy parameter for Rails compatibility
       # @param root_key [Symbol, nil, true]
-      # @param meta [Hash] metadata for this seialization
+      # @param meta [Hash] metadata for this serialization
       # @return [Hash]
       def as_json(_options = {}, root_key: nil, meta: {})
         key = root_key.nil? ? fetch_key : root_key
@@ -99,7 +99,7 @@ module Alba
       #
       # @return [Hash]
       def serializable_hash
-        collection? ? serializable_hash_for_collection : converter.call(@object)
+        Alba.collection?(@object) ? serializable_hash_for_collection : converter.call(@object)
       end
       alias to_h serializable_hash
 
@@ -143,7 +143,7 @@ module Alba
 
       # @return [String]
       def fetch_key
-        k = collection? ? _key_for_collection : _key
+        k = Alba.collection?(@object) ? _key_for_collection : _key
         transforming_root_key? ? transform_key(k) : k
       end
 
@@ -292,12 +292,6 @@ module Alba
           raise Alba::Error, "Unknown type for within option: #{@within.class}"
         end
       end
-
-      # Detect if object is a collection or not.
-      # When object is a Struct, it's Enumerable but not a collection
-      def collection?
-        @object.is_a?(Enumerable) && !@object.is_a?(Struct)
-      end
     end
 
     # Class methods

data/lib/alba/version.rb

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

data/lib/alba.rb

@@ -42,25 +42,44 @@ module Alba
     # Serialize the object with inline definitions
     #
     # @param object [Object] the object to be serialized
+    # @param with [:inference, Proc, Class<Alba::Resource>] determines how to get resource class for each object
     # @param root_key [Symbol, nil, true]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
     # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
-    def serialize(object = nil, root_key: nil, &block)
-      resource = resource_with(object, &block)
-      resource.serialize(root_key: root_key)
+    def serialize(object = nil, with: :inference, root_key: nil, &block)
+      if collection?(object)
+        h = hashify_collection(object, with, &block)
+        Alba.encoder.call(h)
+      else
+        resource = resource_with(object, &block)
+        resource.serialize(root_key: root_key)
+      end
     end
 
     # Hashify the object with inline definitions
     #
     # @param object [Object] the object to be serialized
+    # @param with [:inference, Proc, Class<Alba::Resource>] determines how to get resource class for each object
     # @param root_key [Symbol, nil, true]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
     # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
-    def hashify(object = nil, root_key: nil, &block)
-      resource = resource_with(object, &block)
-      resource.as_json(root_key: root_key)
+    def hashify(object = nil, with: :inference, root_key: nil, &block)
+      if collection?(object)
+        hashify_collection(object, with, &block)
+      else
+        resource = resource_with(object, &block)
+        resource.as_json(root_key: root_key)
+      end
+    end
+
+    # Detect if object is a collection or not.
+    # When object is a Struct, it's Enumerable but not a collection
+    #
+    # @api private
+    def collection?(object)
+      object.is_a?(Enumerable) && !object.is_a?(Struct)
     end
 
     # Enable inference for key and resource name
@@ -192,7 +211,11 @@ module Alba
       register_default_types
     end
 
-    # This method could be part of public API, but for now it's private
+    # Get a resource object from arguments
+    # If block is given, it creates a resource class with the block
+    # Otherwise, it infers resource class from the object's class name
+    #
+    # @ param object [Object] the object whose class name is used for inferring resource class
     def resource_with(object, &block)
       klass = block ? resource_class(&block) : infer_resource_class(object.class.name)
 
@@ -253,6 +276,24 @@ module Alba
       end
     end
 
+    def hashify_collection(collection, with, &block) # rubocop:disable Metrics/MethodLength
+      collection.map do |obj|
+        resource = if block
+                     resource_class(&block)
+                   else
+                     case with
+                     when Class then with
+                     when :inference then infer_resource_class(obj.class.name)
+                     when Proc then with.call(obj)
+                     else raise ArgumentError, '`with` argument must be either :inference, Proc or Class'
+                     end
+                   end
+        raise Alba::Error if resource.nil?
+
+        resource.new(obj).to_h
+      end
+    end
+
     def validate_inflector(inflector)
       unless %i[camelize camelize_lower dasherize classify].all? { |m| inflector.respond_to?(m) }
         raise Alba::Error, "Given inflector, #{inflector.inspect} is not valid. It must implement `camelize`, `camelize_lower`, `dasherize` and `classify`."

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.0
 platform: ruby
 authors:
 - OKURA Masafumi
 bindir: exe
 cert_chain: []
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2024-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct