openapi_blocks 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 955300fe20fc1f9dfe45283d0f4608886592feceb45db0cb7765e7eac1bda439
-  data.tar.gz: bcac14db5aae2164a71ec642cea311aeba135c3f7f43d3a173aea92579cedbcb
+  metadata.gz: 05d45b3316abff7109efe2f2438be8cb720300c67040c72a6c93245354b5129c
+  data.tar.gz: f51d879560afec23a90423ba83b162cb3c799748a4447e1b56e62a41a601dc9a
 SHA512:
-  metadata.gz: 6be97c3ea397aafdc76b6f51f9222cc6bf2cfd0b8ef76982ce7cc73a79687f095110f99902cb8be787c3b1603bc9bdc47eb7ae14a2fab7fbfe24fd4fb71db4ad
-  data.tar.gz: e2b44b0e135fefd0c1af80a86c76dd2cfbc7cc69d9c74de0821808cf75ce4945cdf5e18ca4c1a55e95a096ab404255a0e4c6213e0227b5aac2be0a9777e9745c
+  metadata.gz: c8c0ddcfde5053794e761fde4ecec89f5cbdcc021b37bd5dde751f76fdc6a0d05749802c9504bc05104c0c9fb242c533f3b94251f29961bf9c077fc4788850fd
+  data.tar.gz: 21a332227d4653fe2c233d666213087bc0e5ba91ef7210577f864d68a56987236d2023f2f7f9f5285dd5a9ea40b2eba97d1c1bf6d546ca7b0116fb897239f6c9

data/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2026-06-01
+
+### Changed
+- `association` DSL now uses `read_only: true` instead of `input: false` for consistency with `attribute` DSL
+
 ## [0.2.0] - 2026-06-01
 
 ### Added

data/README.md

@@ -120,7 +120,7 @@ class UserOpenapi < OpenapiBlocks::Base
 
   # opt-in associations
   association :company
-  association :posts, type: :array, input: false  # excluded from UserInput
+  association :posts, type: :array, read_only: true  # excluded from UserInput
 
   # virtual attributes (not in the database)
   # read_only: true  ->  exposed in response (User), excluded from request body (UserInput)
@@ -237,7 +237,7 @@ end
 ```ruby
 association :company                             # belongs_to — $ref to Company schema
 association :posts, type: :array                 # has_many — array of $ref to Post schema
-association :posts, type: :array, input: false   # excluded from UserInput (response only)
+association :posts, type: :array, read_only: true   # excluded from UserInput (response only)
 ```
 
 ---

data/README.pt-BR.md

@@ -310,7 +310,7 @@ class UserOpenapi < OpenapiBlocks::Base
 
       # associações opt-in
       association :company
-      association :posts, type: :array, input: false  # excluído do UserInput
+      association :posts, type: :array, read_only: true  # excluído do UserInput
 
       # atributos virtuais (não existem no banco de dados)
       # read_only: true  ->  exposto apenas na resposta (User)
@@ -427,7 +427,7 @@ class UserOpenapi < OpenapiBlocks::Base
     ```ruby
     association :company                             # belongs_to — $ref para Company schema
     association :posts, type: :array                 # has_many — array de $ref para Post schema
-    association :posts, type: :array, input: false   # excluído do UserInput (response only)
+    association :posts, type: :array, read_only: true   # excluído do UserInput (response only)
     ```
 
     ---

data/lib/openapi_blocks/base.rb

@@ -14,9 +14,9 @@ module OpenapiBlocks
         @_ignored.concat(attributes.map(&:to_s))
       end
 
-      def association(name, type: nil, input: true)
+      def association(name, type: nil, read_only: false)
         @_associations ||= []
-        @_associations << { name: name, type: type, input: input }
+        @_associations << { name: name, type: type, read_only: read_only }
       end
 
       def attribute(name, **)

data/lib/openapi_blocks/schema/extractor.rb

@@ -63,11 +63,11 @@ module OpenapiBlocks
         Array(@openapi_class._associations).each_with_object({}) do |assoc, hash|
           name      = assoc[:name]
           type      = assoc[:type]
-          input     = assoc.fetch(:input, true)
-          ref       = { "$ref" => "#/components/schemas/#{name.to_s.classify}" }
+          read_only = assoc.fetch(:read_only, false)
+          ref = { "$ref" => "#/components/schemas/#{name.to_s.classify}" }
 
           schema = type == :array ? { type: "array", items: ref } : ref
-          schema[:readOnly] = true unless input
+          schema[:readOnly] = true if read_only
 
           hash[name.to_s] = schema
         end

data/lib/openapi_blocks/spec/components.rb

@@ -30,14 +30,19 @@ module OpenapiBlocks
 
       private
 
-      def build_input(schema, openapi_class) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      def build_input(schema, openapi_class) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
         read_only_virtuals = Array(openapi_class._virtual_attributes)
                              .select { |attr| attr[:read_only] == true }
                              .map { |attr| attr[:name].to_s }
 
+        read_only_associations = Array(openapi_class._associations)
+                                 .select { |assoc| assoc[:read_only] == true }
+                                 .map { |assoc| assoc[:name].to_s }
+
         input_properties = schema[:properties].reject do |name, property|
           INPUT_IGNORED_PROPERTIES.include?(name.to_s) ||
-            read_only_virtuals.include?(name.to_s) ||
+            read_only_virtuals.include?(name.to_s)      ||
+            read_only_associations.include?(name.to_s)  ||
             property[:readOnly] == true
         end
 

data/lib/openapi_blocks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiBlocks
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_blocks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Caio Santos