alba 3.9.1 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce994ee53f2a5f9291096f897469bd131c5f925560a0cd13690247d1278b9310
-  data.tar.gz: cbcc9e5e031fc52c20560fa0d8f06465728e5825a08a36d50d6d26f5f1ca4a3a
+  metadata.gz: 12a2e005c86ae86d746947d98732a5931340e378e0557a34de97d0eee533dff1
+  data.tar.gz: 409d8d97cd7313a17d869a7504aa596b5e8e8bb594136cb24ab658408c609ab9
 SHA512:
-  metadata.gz: 1ac432a009738c6e6d69e3d9db07895ca67653a33f7c226194a1851978076dbde05de1da6c767e5b582f5e6e0cded2347fb2bcda858a147d4911cc7b55b06617
-  data.tar.gz: f317a32584cc90e2b49043e4e0c5610351ba710866cd29336a43e151fb0b42061d82e8e39837ed900c6994f7c8d65214cc31845e315a84cb0fd10904c8b09b89
+  metadata.gz: 68e629879e301c3a92dc7c903094739a28dd019d4b1ddcd5fe8606b9c0419e3409e921483bc8b81b4c399bb375a3658a08ef1608d3da010e55f23f0d5b665a00
+  data.tar.gz: 8fba53a8294646354e47afd9a20afc9c48d9d3878df43e653ee09c7de98ab04604168edb19fb30d14430e641069c485d1151b371dc48ac96277ed1795f88d0c5

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 3.10.0 2025-11-11
+
+### Added
+
+- Support type validation and coercion for a single attribute method [#470](https://github.com/okuramasafumi/alba/pull/470)
+  - Thank you [@denblackstache](https://github.com/denblackstache) for requesting the feature
+- Fix hash object resource methods [#475](https://github.com/okuramasafumi/alba/pull/475)
+  - Thank you, [@jkmcrg](https://github.com/jkmcrg)
+
 ## 3.9.1 2025-09-27
 
 ### Added
@@ -189,7 +198,7 @@ This change is supposed to be released as 3.8.0 with the change in 3.7.4, but I
 
 ## [2.4.1] 2023-08-02
 
-#### Fixed
+### Fixed
 
 - Fix the bug of resource name inference for classes whose name end with "Serializer" [No PR](https://github.com/okuramasafumi/alba/commit/1695af4351981725231fd071aaef5b2e4174fb26)
 

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/alba.svg)](https://badge.fury.io/rb/alba)
 [![CI](https://github.com/okuramasafumi/alba/actions/workflows/main.yml/badge.svg)](https://github.com/okuramasafumi/alba/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/okuramasafumi/alba/branch/main/graph/badge.svg?token=3D3HEZ5OXT)](https://codecov.io/gh/okuramasafumi/alba)
-[![Maintainability](https://qlty.sh/gh/okuramasafumi/projects/alba/maintainability.svg)](https://qlty.sh/gh/okuramasafumi/projects/alba)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/acf6a96689c349ecbb806db07fa6948a)](https://app.codacy.com/gh/okuramasafumi/alba/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/okuramasafumi/alba)
 ![GitHub](https://img.shields.io/github/license/okuramasafumi/alba)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

data/lib/alba/resource.rb

@@ -20,6 +20,9 @@ module Alba
     WITHIN_DEFAULT = Object.new.freeze
     private_constant :WITHIN_DEFAULT
 
+    EMPTY_HASH = {}.freeze
+    private_constant :EMPTY_HASH
+
     # `setup` method is meta-programmatically defined here for performance.
     # @api private
     def self.included(base) # rubocop:disable Metrics/MethodLength
@@ -49,7 +52,7 @@ module Alba
       #   determines what associations to be serialized. If not set, it serializes all associations.
       # @param with_traits [Symbol, Array<Symbol>, nil] specified traits
       # @param select [Method] select method object used with `nested_attribute` and `trait`
-      def initialize(object, params: {}, within: WITHIN_DEFAULT, with_traits: nil, select: nil)
+      def initialize(object, params: EMPTY_HASH, within: WITHIN_DEFAULT, with_traits: nil, select: nil)
         @object = object
         @params = params
         @within = within
@@ -65,7 +68,7 @@ module Alba
       # @param root_key [Symbol, nil]
       # @param meta [Hash] metadata for this serialization
       # @return [String] serialized JSON string
-      def serialize(root_key: nil, meta: {})
+      def serialize(root_key: nil, meta: EMPTY_HASH)
         serialize_with(as_json(root_key: root_key, meta: meta))
       end
 
@@ -74,7 +77,7 @@ module Alba
       #
       # @see #serialize
       # @see https://github.com/rails/rails/blob/7-0-stable/actionpack/lib/action_controller/metal/renderers.rb#L156
-      def to_json(options = {}, root_key: nil, meta: {})
+      def to_json(options = EMPTY_HASH, root_key: nil, meta: EMPTY_HASH)
         confusing_keys = [:only, :except]
         confusing_options = options.keys.select { |k| confusing_keys.include?(k.to_sym) }
         unless confusing_options.empty?
@@ -92,7 +95,7 @@ module Alba
       # @param root_key [Symbol, nil]
       # @param meta [Hash] metadata for this serialization
       # @return [Hash]
-      def as_json(_options = {}, root_key: nil, meta: {})
+      def as_json(_options = EMPTY_HASH, root_key: nil, meta: EMPTY_HASH)
         key = root_key.nil? ? fetch_key : root_key
         key = Alba.regularize_key(key)
         if key && !key.empty?
@@ -290,7 +293,7 @@ module Alba
                 when Symbol then fetch_attribute_from_object_and_resource(obj, attribute)
                 when Proc then instance_exec(obj, &attribute)
                 when Alba::Association then yield_if_within(attribute.name.to_sym) { |within| attribute.to_h(obj, params: params, within: within) }
-                when TypedAttribute then attribute.value { |attr| fetch_attribute(obj, key, attr) }
+                when TypedAttribute then attribute.value(object: obj) { |attr| fetch_attribute(obj, key, attr) }
                 when NestedAttribute then attribute.value(object: obj, params: params, within: @within, select: method(:select))
                 when ConditionalAttribute then attribute.with_passing_condition(resource: self, object: obj) { |attr| fetch_attribute(obj, key, attr) }
                   # :nocov:
@@ -308,7 +311,7 @@ module Alba
         return obj.fetch(attribute) if obj.is_a?(Hash)
 
         obj.__send__(attribute)
-      rescue NoMethodError
+      rescue NoMethodError, KeyError
         __send__(attribute, obj)
       end
 
@@ -320,6 +323,8 @@ module Alba
         else
           obj.__send__(attribute)
         end
+      rescue KeyError
+        __send__(attribute, obj)
       end
 
       def nil_handler
@@ -399,11 +404,11 @@ module Alba
       end
       private :assign_attributes
 
-      def assign_attributes_with_types(attrs_with_types, if_value)
+      def assign_attributes_with_types(attrs_with_types, if_value, &block)
         attrs_with_types.each do |attr_name, type_and_converter|
           attr_name = attr_name.to_sym
           type, type_converter = type_and_converter
-          typed_attr = TypedAttribute.new(name: attr_name, type: type, converter: type_converter)
+          typed_attr = TypedAttribute.new(name: attr_name, type: type, converter: type_converter, &block)
           attr = if_value ? ConditionalAttribute.new(body: typed_attr, condition: if_value) : typed_attr
           @_attributes[attr_name] = attr
         end
@@ -413,15 +418,21 @@ module Alba
       # Set an attribute with the given block
       #
       # @param name [String, Symbol] key name
-      # @param options [Hash<Symbol, Proc>]
-      # @option options [Proc] if a condition to decide if this attribute should be serialized
+      # @param if [Proc] condition to decide if it should serialize these attributes
       # @param block [Block] the block called during serialization
       # @raise [ArgumentError] if block is absent
       # @return [void]
-      def attribute(name, **options, &block)
+      def attribute(name = nil, if: nil, **name_with_type, &block)
+        if_value = binding.local_variable_get(:if)
         raise ArgumentError, 'No block given in attribute method' unless block
+        raise ArgumentError, 'You must specify either name or name with type' if name.nil? && name_with_type.empty?
 
-        @_attributes[name.to_sym] = options[:if] ? ConditionalAttribute.new(body: block, condition: options[:if]) : block
+        if name.nil?
+          assign_attributes_with_types(name_with_type, if_value, &block)
+        else # Symbol
+          attr = if_value ? ConditionalAttribute.new(body: block, condition: if_value) : block
+          @_attributes[name.to_sym] = attr
+        end
       end
 
       # Set association
@@ -441,7 +452,7 @@ module Alba
       # @param block [Block]
       # @return [void]
       # @see Alba::Association#initialize
-      def association(name, condition = nil, resource: nil, serializer: nil, source: 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: EMPTY_HASH, **options, &block)
         resource ||= serializer
         transformation = @_key_transformation_cascade ? @_transform_type : :none
         assoc = Association.new(

data/lib/alba/typed_attribute.rb

@@ -9,7 +9,7 @@ module Alba
     # @param name [Symbol, String]
     # @param type [Symbol, Class]
     # @param converter [Proc, true, false, nil]
-    def initialize(name:, type:, converter:)
+    def initialize(name:, type:, converter:, &block)
       @name = name
       t = Alba.find_type(type)
       @type = case converter
@@ -18,11 +18,12 @@ module Alba
               else
                 t.dup.tap { _1.auto_convert_with(converter) }
               end
+      @block = block
     end
 
     # @return [String, Integer, Boolean] type-checked or type-converted object
-    def value
-      v = yield(@name)
+    def value(object: nil)
+      v = @block ? @block.call(object) : yield(@name)
       result = @type.check(v)
       result ? v : @type.convert(v)
     rescue TypeError

data/lib/alba/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.9.1
+  version: 3.10.0
 platform: ruby
 authors:
 - OKURA Masafumi
@@ -9,8 +9,8 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
-  flexibility and usability.
+description: Alba is a JSON serializer for Ruby, JRuby and TruffleRuby. It focuses
+  on performance, flexibility and usability.
 email:
 - masafumi.o1988@gmail.com
 executables: []
@@ -59,5 +59,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Alba is the fastest JSON serializer for Ruby.
+summary: Alba is a JSON serializer for Ruby, JRuby and TruffleRuby.
 test_files: []