openapi_parameters 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d1127ef2e34d916ca293835143d6267d1baf9cfb6f51ca12384e712f57eef0
-  data.tar.gz: ced0820dba10352ab2a460b4c621c5fcbd2f79400008aef3081d442027189113
+  metadata.gz: 778cfe7ccd40119158a3c158b5cf1dcf8000436a4c747a1ecfa349782ffa99d1
+  data.tar.gz: ebdb7a20b68b881e526e11fd30e05458ed8dd5dea34b16f94115e522dfa1801f
 SHA512:
-  metadata.gz: 1d3bbef2747984f498d259cd838ff5e9acbfd8f5417ad8718f7ac9d8ea078a72af94b3835f6307c967803c447ff3e7be0eb6b4b1cae9bb3d2afd1138226e8091
-  data.tar.gz: 6d17518118d5df6dc5376e8bed4b131f65077c5ed71293fe41425f788c0ecddc7fbbd476a1e93cf28e022d522fb8973b1afe0090be9ab71b3b2b08b036aa70a3
+  metadata.gz: 61c5e95989223be85f4965355aede74739ac71a3f07ebeba9b6486ef56acf45a64093ffa23b680d1ccad28f7abbbcc4d94a6135acf4575f87f7e67773ccdd97c
+  data.tar.gz: 82fe0b18f8a79e758b5b3a3a496a8de373cc7a47079a3944cd5a6843130c03c1ca6b5173d479a8c2c0a14697e106f2d1aa407d6181e1feac8e5b2cdd074bb4bd

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 ## [Unreleased]
 
-## [0.3.4] - 2024-12-17
+## [0.5.0] - 2025-04-01
+
+- Add option to remove "[]" from unpacked query openapi_parameters
+  ```ruby
+  OpenapiParameters::Query.new(
+    [parameter],
+    rack_array_compat: true
+  ).unpack('ids[]=2')
+  # => { 'ids' => ['2'] }
+  ```
+
+## [0.4.0] - 2024-12-17
 
 - Add Parameter#convert(value)
 - Slight performance optimization

data/lib/openapi_parameters/error.rb

@@ -3,4 +3,7 @@
 module OpenapiParameters
   class Error < StandardError
   end
+
+  class NotSupportetError < Error
+  end
 end

data/lib/openapi_parameters/parameter.rb

@@ -52,6 +52,13 @@ module OpenapiParameters
       type == 'array'
     end
 
+    EMPTY_BRACKETS = '[]'
+    private_constant :EMPTY_BRACKETS
+
+    def bracket_array?
+      @bracket_array ||= array? && name.end_with?(EMPTY_BRACKETS)
+    end
+
     def object?
       type == 'object' || style == 'deepObject' || schema&.key?('properties')
     end

data/lib/openapi_parameters/query.rb

@@ -7,9 +7,10 @@ module OpenapiParameters
   class Query
     # @param parameters [Array<Hash>] The OpenAPI query parameter definitions.
     # @param convert [Boolean] Whether to convert the values to the correct type.
-    def initialize(parameters, convert: true)
+    def initialize(parameters, convert: true, rack_array_compat: false)
       @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
+      @remove_array_brackets = rack_array_compat
     end
 
     def unpack(query_string) # rubocop:disable Metrics/AbcSize
@@ -25,11 +26,17 @@ module OpenapiParameters
 
           value = Unpacker.unpack_value(parameter, parsed_query[parameter.name])
         end
-        result[parameter.name] = @convert ? parameter.convert(value) : value
+        key = if remove_array_brackets && parameter.bracket_array?
+                parameter.name.delete_suffix('[]')
+              else
+                parameter.name
+              end
+        result[key] = @convert ? parameter.convert(value) : value
       end
     end
 
     attr_reader :parameters
+    private attr_reader :remove_array_brackets
 
     private
 

data/lib/openapi_parameters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack